Re: [netmod] WG adoption poll draft-kwatsen-netmod-artwork-folding-08

Ladislav Lhotka <lhotka@nic.cz> Tue, 23 October 2018 15:51 UTC

Return-Path: <lhotka@nic.cz>
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 09D091286E7 for <netmod@ietfa.amsl.com>; Tue, 23 Oct 2018 08:51:20 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -6.999
X-Spam-Level:
X-Spam-Status: No, score=-6.999 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_HI=-5, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=nic.cz
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 o2lpIemzgxfC for <netmod@ietfa.amsl.com>; Tue, 23 Oct 2018 08:51:17 -0700 (PDT)
Received: from mail.nic.cz (mail.nic.cz [217.31.204.67]) (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 08B05124408 for <netmod@ietf.org>; Tue, 23 Oct 2018 08:51:17 -0700 (PDT)
Received: from birdie (unknown [IPv6:2a01:5e0:29:ffff:ffc6:c393:cdb9:8db1]) by mail.nic.cz (Postfix) with ESMTPSA id 4EF6362AC4; Tue, 23 Oct 2018 17:51:15 +0200 (CEST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=nic.cz; s=default; t=1540309875; bh=jmrL0X8G4VbNWm2Z1gur99DL8ILhZVRCRmNJZb3MB6A=; h=From:To:Date; b=qnLw7jJfFZedJ4ljCySLErlbo0jfArdh/U3AReyw47XcwktXjZGT35tYv070A7G26 ZZWQU7pK9MBPBU21W9+vtNJLEoVLYE3F5fLzkOjv00zRWELScePIklRUL8rJiaiG3L FO7cgSV4NgiCQI3E3N1lqlihR4O6ItJMin+TLFcY=
Message-ID: <27cbd2fe3dd114e981fce2abb1723c5115550142.camel@nic.cz>
From: Ladislav Lhotka <lhotka@nic.cz>
To: Martin Bjorklund <mbj@tail-f.com>
Cc: adrian@olddog.co.uk, netmod@ietf.org
Date: Tue, 23 Oct 2018 17:51:15 +0200
In-Reply-To: <20181023.162748.209178731500337122.mbj@tail-f.com>
References: <3a3714170c5cf1828203f5109d8791f6fed4478e.camel@nic.cz> <075901d46ad6$b5e89050$21b9b0f0$@olddog.co.uk> <326034f9a137b0489137bc39616d166f221e02a2.camel@nic.cz> <20181023.162748.209178731500337122.mbj@tail-f.com>
Organization: CZ.NIC
Content-Type: text/plain; charset="UTF-8"
User-Agent: Evolution 3.30.2
Mime-Version: 1.0
Content-Transfer-Encoding: 7bit
X-Virus-Scanned: clamav-milter 0.99.2 at mail
X-Virus-Status: Clean
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/yJrIoVCHFNznFj9GYDvTzij2Qqo>
Subject: Re: [netmod] WG adoption poll draft-kwatsen-netmod-artwork-folding-08
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: Tue, 23 Oct 2018 15:51:20 -0000

On Tue, 2018-10-23 at 16:27 +0200, Martin Bjorklund wrote:
> Ladislav Lhotka <lhotka@nic.cz> wrote:
> > On Tue, 2018-10-23 at 14:45 +0100, Adrian Farrel wrote:
> > > Hi,
> > > 
> > > 1. I think you miss the point. While example XML/JSON YANG is included in
> > > drafts, and while the authors are allowed to produce those drafts as txt
> > > files,
> > > or while the authors want to achieve pretty-to-read formatting, this work
> > > falls
> > > into the scope of those authors.
> > 
> > The folding of long lines should be done as the very last (automatic) step
> > before the document gets published. Doing it earlier means that the source
> code
> > in this folded form can be (accidentally) further edited, which can lead to
> > inconsistencies.
> 
> I will use folding e.g. for instance document examples in XML and
> JSON.
> 
> My plan is to keep the example files with manually added breaks in my
> repo, and as part of validation run a script that unfolds the
> examples, and then validate the result.  The reason for this is that I
> think readbility of the examples is important.

This seems backwards to me. If you need to edit such an example, you may have to
remove the backslashes, reformat and insert them again.

If it's not possible to fold lines according to the syntax of a given language,
I'd prefer to keep the original lines as long as possible and rely on an
automatic procedure just before the final document is rolled out. 

Lada  

> 
> 
> /martin
> 
> 
> 
> > 
> > As long as the document is being moved around and edited, it would be better
> to
> > keep the source code untouched.
> > 
> > Lada
> > 
> > > 
> > > 2. Yes, the authors discussed the <sourcecode> element and agreed that it
> will
> > > be in scope.
> > > 
> > > However, we are all sort of waiting for xml2rfc v3 and pending completion,
> we
> > > want to move this forward for v2 that is in use today.
> > > 
> > > (More than) Happy to come back and revisit this issue when v3 is deployed.
> > > 
> > > Thanks,
> > > Adrian
> > > 
> > > > -----Original Message-----
> > > > From: netmod [mailto:netmod-bounces@ietf.org] On Behalf Of Ladislav
> Lhotka
> > > > Sent: 23 October 2018 14:24
> > > > To: netmod@ietf.org
> > > > Subject: Re: [netmod] WG adoption poll draft-kwatsen-netmod-artwork-
> folding-
> > > > 08
> > > > 
> > > > On Tue, 2018-10-23 at 14:40 +0200, Ladislav Lhotka wrote:
> > > > > Hi,
> > > > > 
> > > > > I support the adoption.
> > > > > 
> > > > > Comments:
> > > > > 
> > > > > 1. My general feeling is that such technicalities should be handled by
> > > > >    the RFC editor and/or tools rather than YANG module and RFC
> authors.
> > > > > 
> > > > > 2. xml2rfc v3 introduced a new element, <sourcecode>, that is intended
> > > > >    for source code inclusion. This document should therefore cover
> this
> > > > >    element as well (primarily?). One problem with it is that the
> xml2rfc
> > > > >    tool automatically adds the <CODE BEGINS> and <CODE ENDS> markers,
> > > > >    which interferes with YANG convention specified in RFC 8407,
> > > > >    sec. 3.2. I have already raised a question about this in the
> > > > >    xml2rfc-dev mailing list.
> > > > 
> > > > Update: using the "name" attribute with <sourcecode> does the right
> thing.
> > > > 
> > > >     <sourcecode name="ietf-foo@2016-03-20.yang">
> > > >     ...
> > > >     </sourcecode>
> > > > 
> > > > results in
> > > > 
> > > >     <CODE BEGINS> file "ietf-foo@2016-03-20.yang"
> > > >     ...
> > > >     <CODE ENDS>
> > > > 
> > > > Lada
> > > > 
> > > > > Lada
> > > > > 
> > > > > Lou Berger <lberger@labn.net> writes:
> > > > > 
> > > > > > All,
> > > > > > 
> > > > > > This is start of a two week poll on making
> > > > > > draft-kwatsen-netmod-artwork-folding-08 a working group
> > > > > > document. Please send email to the list indicating "yes/support" or
> > > > > > "no/do not support".  If indicating no, please state your
> reservations
> > > > > > with the document.  If yes, please also feel free to provide
> comments
> > > > > > you'd like to see addressed once the document is a WG document.
> > > > > > 
> > > > > > The poll ends Oct 1.
> > > > > > 
> > > > > > Thanks,
> > > > > > 
> > > > > > Lou (and co-chairs)
> > > > > > 
> > > > > > _______________________________________________
> > > > > > netmod mailing list
> > > > > > netmod@ietf.org
> > > > > > https://www.ietf.org/mailman/listinfo/netmod
> > > > --
> > > > Ladislav Lhotka
> > > > Head, CZ.NIC Labs
> > > > PGP Key ID: 0xB8F92B08A9F76C67
> > > > 
> > > > _______________________________________________
> > > > netmod mailing list
> > > > netmod@ietf.org
> > > > https://www.ietf.org/mailman/listinfo/netmod
> > -- 
> > Ladislav Lhotka
> > Head, CZ.NIC Labs
> > PGP Key ID: 0xB8F92B08A9F76C67
> > 
> > _______________________________________________
> > netmod mailing list
> > netmod@ietf.org
> > https://www.ietf.org/mailman/listinfo/netmod
> > 
-- 
Ladislav Lhotka
Head, CZ.NIC Labs
PGP Key ID: 0xB8F92B08A9F76C67