Re: [netmod] Call for adoption request of draft-kwatsen-netmod-artwork-folding-04

Robert Wilton <rwilton@cisco.com> Wed, 27 June 2018 10:41 UTC

Return-Path: <rwilton@cisco.com>
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 890FA130F7C for <netmod@ietfa.amsl.com>; Wed, 27 Jun 2018 03:41:18 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -14.511
X-Spam-Level:
X-Spam-Status: No, score=-14.511 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, SPF_PASS=-0.001, T_DKIMWL_WL_MED=-0.01, USER_IN_DEF_DKIM_WL=-7.5] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=cisco.com
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 y7qA8ie8sI7k for <netmod@ietfa.amsl.com>; Wed, 27 Jun 2018 03:41:14 -0700 (PDT)
Received: from aer-iport-4.cisco.com (aer-iport-4.cisco.com [173.38.203.54]) (using TLSv1.2 with cipher DHE-RSA-SEED-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 44E90130EC0 for <netmod@ietf.org>; Wed, 27 Jun 2018 03:41:14 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=cisco.com; i=@cisco.com; l=6034; q=dns/txt; s=iport; t=1530096074; x=1531305674; h=subject:to:references:from:message-id:date:mime-version: in-reply-to:content-transfer-encoding; bh=KVhLm7gkFaEzkFj61sNBVf8SYQpJSDOQ/sodajCU4Qk=; b=NxMCbbQhTLBNbnh+TxC6nSMuW5b+S++yd6x8tLS5ZwYtd/ALjHkEvPY3 wATDkihC9Oq4zko7wPuK9bJTNrNAh87v470GQxa2xEFaLtqZ1whL2lTvU ZwTxybzN+SSFsrusqwSD2e1aBBoKIbluj0nXX4iUYSxsZvbEGf0BTLd31 A=;
X-IronPort-Anti-Spam-Filtered: true
X-IronPort-Anti-Spam-Result: =?us-ascii?q?A0B8AQC+aDNb/xbLJq1cGQEBAQEBAQE?= =?us-ascii?q?BAQEBAQcBAQEBAYMqAQEBAYEDbRIog3mIY41CKpUqgWYLGA2EAUYCgzc3FQE?= =?us-ascii?q?CAQECAQECbRwMhTcBAQQBARsGDwEFNhsJAg4KAgIjAwICJx8RBgEMBgIBARe?= =?us-ascii?q?DCgGBfw+QW5tHghyEW4NygRyBC4k4P4E2gmiBKIFwAQECAQEWgQ4VgySCVQK?= =?us-ascii?q?HO4UMjGoJhgCJDQaBQEKDRYJGJIUZiieBf4VNgVcigVIzGggbFRohgmkJgkK?= =?us-ascii?q?ISIU/PjABkREBAQ?=
X-IronPort-AV: E=Sophos;i="5.51,278,1526342400"; d="scan'208";a="4750947"
Received: from aer-iport-nat.cisco.com (HELO aer-core-4.cisco.com) ([173.38.203.22]) by aer-iport-4.cisco.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 27 Jun 2018 10:41:12 +0000
Received: from [10.63.23.83] (dhcp-ensft1-uk-vla370-10-63-23-83.cisco.com [10.63.23.83]) by aer-core-4.cisco.com (8.14.5/8.14.5) with ESMTP id w5RAfBfP028400; Wed, 27 Jun 2018 10:41:12 GMT
To: Qin Wu <bill.wu@huawei.com>, "netmod@ietf.org" <netmod@ietf.org>
References: <B8F9A780D330094D99AF023C5877DABA9AEB4274@nkgeml513-mbx.china.huawei.com>
From: Robert Wilton <rwilton@cisco.com>
Message-ID: <194df0e3-038d-d0cc-ea45-f5448fc10562@cisco.com>
Date: Wed, 27 Jun 2018 11:41:11 +0100
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.8.0
MIME-Version: 1.0
In-Reply-To: <B8F9A780D330094D99AF023C5877DABA9AEB4274@nkgeml513-mbx.china.huawei.com>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding: 8bit
Content-Language: en-US
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/9swowLq5hFUXD2X3QjvrCA1gSFM>
Subject: Re: [netmod] Call for adoption request of draft-kwatsen-netmod-artwork-folding-04
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.26
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: Wed, 27 Jun 2018 10:41:19 -0000

Support/adopt.

A couple of comments:

1) Section 4.2 suggests using groupings to presumably avoid folding.  I 
don't really support this as a strategy, since I think that groupings 
are overused and I think that they obfuscate the true structure of a 
YANG module, that can only be recovered by recompiling the module with 
the groupings expanded, or looking at the tree output.  Really, I think 
that an ideal solution would be to somehow have RFCs support longer 
lines for files like YANG - e.g. if I could choose any value without 
regard for backwards compatibility I would probably choose 120 
characters instead.

2) The proposed solution always left indents the wrapped line. Often for 
artwork (e.g. a YANG tree diagram), where whitespace is not significant, 
and the wrapping is relatively minor, then right indenting the wrapped 
line can make the results look more visually readable.

E.g.  I think that this is slightly easier to read:

module: ietf-flexible-encapsulation
   augment /if:interfaces/if:interface/if-cmn:encapsulation\
                                         /if-cmn:encaps-type:
     +--:(flexible)
        +--rw flexible
           +--rw match
           |  +--rw (match-type)
           |     +--:(default)
           |     |  +--rw default?                 empty
           |     +--:(untagged)
           |     |  +--rw untagged?                empty
           |     +--:(dot1q-priority-tagged)
           |     |  +--rw dot1q-priority-tagged
           |     |     +--rw tag-type?   dot1q-types:dot1q-\
                                                    tag-type
           |     +--:(dot1q-vlan-tagged)
           |        +--rw dot1q-vlan-tagged

rather than:

module: ietf-flexible-encapsulation
   augment /if:interfaces/if:interface/if-cmn:encapsulation\
/if-cmn:encaps-type:
     +--:(flexible)
        +--rw flexible
           +--rw match
           |  +--rw (match-type)
           |     +--:(default)
           |     |  +--rw default?                 empty
           |     +--:(untagged)
           |     |  +--rw untagged?                empty
           |     +--:(dot1q-priority-tagged)
           |     |  +--rw dot1q-priority-tagged
           |     |     +--rw tag-type?   dot1q-types:dot1q-\
tag-type
           |     +--:(dot1q-vlan-tagged)
           |        +--rw dot1q-vlan-tagged

Thanks,
Rob


On 23/06/2018 02:37, Qin Wu wrote:
> Dear WG,
>
> As you may recall I presented yang-xml-doc-conventions in London.  There was strong support for trying to solve the problem and mixed views on the solution, other than that we should do it fast.  In the meanwhile, Kent submitted artwork-folding as an alternative solution.
>
> The authors of the two drafts decided to combine efforts.  After several internal iterations on both drafts, the drafts were becoming more alike than different(both support auto wrapping or auto folding).  The artwork-folding draft was selected as a preferred offering basis (i.e., draft-kwatsen-netmod-artwork-folding-04) to the working group to consider for adoption.
>
> The primary feature differences remained are:
>    - all folded lines continue of column 0 without two character indentation, i.e., whether auto indentation should be supported.
>    - handle two special case on backslash and space at the end of broken line in yang-xml-doc-conventions.
>    - propose to use <WRAPPED TEXT BEGIN><WRAPPED TEXT END> to extract artwork from I-Ds.
>
> Thanks,
> Qin, Kent, Benoit and Adrian
> -----邮件原件-----
> 发件人: internet-drafts@ietf.org [mailto:internet-drafts@ietf.org]
> 发送时间: 2018年6月23日 9:33
> 收件人: Benoit Claise; Qin Wu; Kent Watsen; Adrian Farrel; Benoît Claise
> 主题: New Version Notification for draft-kwatsen-netmod-artwork-folding-04.txt
>
>
> A new version of I-D, draft-kwatsen-netmod-artwork-folding-04.txt
> has been successfully submitted by Qin Wu and posted to the IETF repository.
>
> Name:		draft-kwatsen-netmod-artwork-folding
> Revision:	04
> Title:		Handling Long Lines in Artwork in Drafts
> Document date:	2018-06-22
> Group:		Individual Submission
> Pages:		9
> URL:            https://www.ietf.org/internet-drafts/draft-kwatsen-netmod-artwork-folding-04.txt
> Status:         https://datatracker.ietf.org/doc/draft-kwatsen-netmod-artwork-folding/
> Htmlized:       https://tools.ietf.org/html/draft-kwatsen-netmod-artwork-folding-04
> Htmlized:       https://datatracker.ietf.org/doc/html/draft-kwatsen-netmod-artwork-folding
> Diff:           https://www.ietf.org/rfcdiff?url2=draft-kwatsen-netmod-artwork-folding-04
>
> Abstract:
>     This document introduces a simple and yet time-proven strategy for
>     handling long lines in artwork in drafts using a backslash ('\')
>     character where line-folding has occurred.  The strategy works on any
>     text based artwork, producing consistent results regardless the
>     artwork content.  Using a per-artwork header, the strategy is both
>     self-documenting and enables automated reconstitution of the original
>     artwork.
>
>                                                                                    
>
>
> Please note that it may take a couple of minutes from the time of submission until the htmlized version and diff are available at tools.ietf.org.
>
> The IETF Secretariat
>
> _______________________________________________
> netmod mailing list
> netmod@ietf.org
> https://www.ietf.org/mailman/listinfo/netmod