Re: [netmod] Alissa Cooper's Abstain on draft-ietf-netmod-artwork-folding-09: (with COMMENT)

Erik Auerswald <auerswal@unix-ag.uni-kl.de> Thu, 05 September 2019 16:32 UTC

Return-Path: <auerswal@unix-ag.uni-kl.de>
X-Original-To: netmod@ietfa.amsl.com
Delivered-To: netmod@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 7D46D120BEB for <netmod@ietfa.amsl.com>; Thu, 5 Sep 2019 09:32:22 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.197
X-Spam-Level:
X-Spam-Status: No, score=-4.197 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_MED=-2.3, SPF_HELO_NONE=0.001, SPF_NONE=0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id Jl3NM--w8-g1 for <netmod@ietfa.amsl.com>; Thu, 5 Sep 2019 09:32:20 -0700 (PDT)
Received: from mailgw1.uni-kl.de (mailgw1.uni-kl.de [IPv6:2001:638:208:120::220]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id EB5241209B7 for <netmod@ietf.org>; Thu, 5 Sep 2019 09:32:19 -0700 (PDT)
Received: from sushi.unix-ag.uni-kl.de (sushi.unix-ag.uni-kl.de [IPv6:2001:638:208:ef34:0:ff:fe00:65]) by mailgw1.uni-kl.de (8.14.4/8.14.4/Debian-8+deb8u2) with ESMTP id x85GWHQ9142208 (version=TLSv1/SSLv3 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Thu, 5 Sep 2019 18:32:17 +0200
Received: from sushi.unix-ag.uni-kl.de (ip6-localhost [IPv6:::1]) by sushi.unix-ag.uni-kl.de (8.14.4/8.14.4/Debian-4+deb7u1) with ESMTP id x85GWHQr006477 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=NO); Thu, 5 Sep 2019 18:32:17 +0200
Received: (from auerswal@localhost) by sushi.unix-ag.uni-kl.de (8.14.4/8.14.4/Submit) id x85GWGte006476; Thu, 5 Sep 2019 18:32:16 +0200
Date: Thu, 5 Sep 2019 18:32:16 +0200
From: Erik Auerswald <auerswal@unix-ag.uni-kl.de>
To: Martin Bjorklund <mbj@tail-f.com>
Cc: kent+ietf@watsen.net, netmod@ietf.org
Message-ID: <20190905163216.GA3497@unix-ag.uni-kl.de>
References: <156762337738.22782.18440951708689230098.idtracker@ietfa.amsl.com> <ceb3f6865a14b79bc9cab81e77ce34043ca1d760.camel@nic.cz> <0100016d01f89905-2d99967e-a660-4ae2-a0a3-1fd270ad4a07-000000@email.amazonses.com> <20190905.171730.1203130976409295649.mbj@tail-f.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20190905.171730.1203130976409295649.mbj@tail-f.com>
User-Agent: Mutt/1.5.21 (2010-09-15)
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/H6yKKyH_Rsea8qzVGU5RtmZuFtA>
Subject: Re: [netmod] Alissa Cooper's Abstain on draft-ietf-netmod-artwork-folding-09: (with COMMENT)
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: NETMOD WG list <netmod.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/netmod>, <mailto:netmod-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/netmod/>
List-Post: <mailto:netmod@ietf.org>
List-Help: <mailto:netmod-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/netmod>, <mailto:netmod-request@ietf.org?subject=subscribe>
X-List-Received-Date: Thu, 05 Sep 2019 16:32:30 -0000

Hi Martin,

On Thu, Sep 05, 2019 at 05:17:30PM +0200, Martin Bjorklund wrote:
> Kent Watsen <kent+ietf@watsen.net> wrote:
> > 
> > >> There has been discussion about how embedding YANG models in RFCs seems like a
> > >> poor fit for a number of reasons. By standardizing line-folding mechanisms and
> > >> claiming them as a best practice, this document reinforces the root of that
> > >> problem rather than trying to fix it.
> > > 
> > > Well said, I agree with Alissa's conclusion.
> 
> But the algorithm in the document isn't supposed to be used for YANG
> modules.  It is supposed to be used primarily for XML and JSON
> snippets (etc).

Technically, XML and JSON are whitespace-agnostic and often can be
"folded" manually without any folding indicators.  That seems to be
true for YANG as well.  Even Python code usually can be kept under any
reasonable line length.

Very long names or values could require algorithmic folding, i.e.,
a generic line-folding mechanism.

I personally would try to keep the line length of any code inside an
RFC short enough to not need additional algorithmic folding.  But if
this does not work, e.g., because some name or value is just too long,
having a recommended algorithm seems to be better than every author
making up another ad-hoc folding scheme.

The I-D.ietf-netmod-artwork-folding seems to try to provide a recommended
algorithm for the case where a generic line-folding mechanism is needed.

Overly long lines sometimes result in lost information in HTML or PDF
documents, if a complex layout is used, but no mechanism for dealing with
unexpectedly long lines is included.  I have seen too many examples of
this to believe that this cannot happen with RFCs.

Thanks,
Erik