Re: [netmod] Where can I use <CODE BEGINS> <CODE ENDS> ?

Kent Watsen <kent+ietf@watsen.net> Sat, 28 March 2020 23:18 UTC

Return-Path: <0100017123703ba5-09d4de23-b5de-46be-91b6-a36dd65509df-000000@amazonses.watsen.net>
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 5DEEA3A08DD for <netmod@ietfa.amsl.com>; Sat, 28 Mar 2020 16:18:15 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: 0.004
X-Spam-Level:
X-Spam-Status: No, score=0.004 tagged_above=-999 required=5 tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, HTML_MESSAGE=0.001, SPF_HELO_NONE=0.001, SPF_NONE=0.001, URIBL_BLOCKED=0.001] autolearn=unavailable autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=amazonses.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 gT7aA5-qFIbe for <netmod@ietfa.amsl.com>; Sat, 28 Mar 2020 16:18:11 -0700 (PDT)
Received: from a8-83.smtp-out.amazonses.com (a8-83.smtp-out.amazonses.com [54.240.8.83]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 747063A08BE for <netmod@ietf.org>; Sat, 28 Mar 2020 16:18:11 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/simple; s=224i4yxa5dv7c2xz3womw6peuasteono; d=amazonses.com; t=1585437490; h=From:Message-Id:Content-Type:Mime-Version:Subject:Date:In-Reply-To:Cc:To:References:Feedback-ID; bh=/sdqDSWwIqZz9z1sFUGCNawkB5UddjJm9ybvProT3WU=; b=QGOR3jlVk0AZlKdRAd9iDVoVgxY8PS1EW+ZPaGJUFdawdTgGX3VK1zwwXv9vzoXo lTlxNkCXB1Pv/LflhcjSTD172sWkZdH/QXkGwhDf5dNqYpKx4KZQRqMz3P8GN/4aZFX WA4J9m+IJ21BPLPGjhaZOaI9dwcu80Tw2jhJNFUE=
From: Kent Watsen <kent+ietf@watsen.net>
Message-ID: <0100017123703ba5-09d4de23-b5de-46be-91b6-a36dd65509df-000000@email.amazonses.com>
Content-Type: multipart/alternative; boundary="Apple-Mail=_02B74324-C9B1-4B8E-993D-09793192FD51"
Mime-Version: 1.0 (Mac OS X Mail 12.4 \(3445.104.11\))
Date: Sat, 28 Mar 2020 23:18:10 +0000
In-Reply-To: <DB7PR07MB4011CD1D9F84D2E675B11583F0CF0@DB7PR07MB4011.eurprd07.prod.outlook.com>
Cc: "netmod@ietf.org" <netmod@ietf.org>
To: =?utf-8?Q?Bal=C3=A1zs_Lengyel?= <balazs.lengyel=40ericsson.com@dmarc.ietf.org>
References: <DB7PR07MB4011310A5327543D14FD9C19F0F20@DB7PR07MB4011.eurprd07.prod.outlook.com> <DA8180AD-7DDC-45DE-9733-A7AAFB6A2781@amsl.com> <DB7PR07MB40115DC070AD529CB9CFB69FF0F10@DB7PR07MB4011.eurprd07.prod.outlook.com> <0100017112b9fbb5-e808f29f-e38a-4ff4-bd61-ac93b02057a3-000000@email.amazonses.com> <DB7PR07MB4011C7CA9D64CDBAAF90A511F0CF0@DB7PR07MB4011.eurprd07.prod.outlook.com> <DB7PR07MB4011CD1D9F84D2E675B11583F0CF0@DB7PR07MB4011.eurprd07.prod.outlook.com>
X-Mailer: Apple Mail (2.3445.104.11)
X-SES-Outgoing: 2020.03.28-54.240.8.83
Feedback-ID: 1.us-east-1.DKmIRZFhhsBhtmFMNikgwZUWVrODEw9qVcPhqJEI2DA=:AmazonSES
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/_vLw2CnKZRzbgFBA0_XgcxHAA1g>
Subject: Re: [netmod] Where can I use <CODE BEGINS> <CODE ENDS> ?
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: Sat, 28 Mar 2020 23:18:16 -0000

Firstly, thank you for trying to improve our tooling!

It took me some time to find, for others: https://github.com/BalazsLengyel/rfcstrip <https://github.com/BalazsLengyel/rfcstrip>

Running `rfcstrip -a` throws errors on MacOS.  My workaround fix was to ` brew install grep` and 's/grep/ggrep/' on line 483.

All The extracted files (including the two that are NOT folded) contain a ‘^@‘ character at the EOF.   This must be something introduced by `rfcstrip` because `rfcfold` does a simple file-level copy when unfolding isn't needed.

Kent // contributor


> On Mar 26, 2020, at 5:45 PM, Balázs Lengyel <balazs.lengyel=40ericsson.com@dmarc.ietf.org> wrote:
> 
> Hello,
> I created an update to rfcstrip in Github.
> 
> Revision 1.1balazs - 2020-03-26
> added -a option. If it is specified, the file must be an XML2RFC
> XML file.
> All artworks will be extracted from it if they carry a name attribute.
> Artwork unfolding will also be executed.
> If the artwork contains the , <CODE BEGIN/END> markers
> they are removed.
> 
> Regards Balazs
> 
> -----Original Message-----
> From: Balázs Lengyel <balazs.lengyel=40ericsson.com@dmarc.ietf.org> 
> Sent: 2020. március 26., csütörtök 11:55
> To: Kent Watsen <kent@watsen.net>et>; Balázs Lengyel <balazs.lengyel@ericsson.com>
> Cc: netmod@ietf.org
> Subject: RE: [netmod] Where can I use <CODE BEGINS> <CODE ENDS> ?
> 
> Hello Kent,
> OK, as you are strongly opposed to it, I will remove <CODE BEGINS> <CODE ENDS> in the next version.
> That said, I do not really agree with you. If interested see, below.
> Regards Balazs
> 
> -----Original Message-----
> From: netmod <netmod-bounces@ietf.org> On Behalf Of Kent Watsen
> Sent: 2020. március 25., szerda 18:25
> To: Balázs Lengyel <balazs.lengyel=40ericsson.com@dmarc.ietf.org>
> Cc: netmod@ietf.org
> Subject: Re: [netmod] Where can I use <CODE BEGINS> <CODE ENDS> ?
> 
> Balazs,
> 
> While possible to use the markers for instance examples...
> 
>  - they’ve never been used before, AFIAK  (historical context)
> BALAZS: S0 I am a revolutionary :-)  
> As I understand validation of examples have always been an issue, so making that more simple by automating extraction would be a step in the good direction.
>  - they're unneeded, as examples don’t contain copyright (per Lada’s comment)
> BALAZS: I agree that copyright is a non-issue for these examples. However <CODE BEGINS> is needed for another reason: easy extraction, which would make checking the data simpler.
>  - they're disallowed by RFC 8407 for example modules (per Benoit comment)
> BALAZS: strictly speaking that is about YANG examples not instance data examples. I also don't know/understand the reasoning behind it. A separate example tag would be nice, but we don't have one.
>  - as a contributor, I don’t wish to birth a new convention of using the markers for examples.  
> 
> In order to support programmatic extraction of examples from drafts, please just set the “name” attribute on the <sourcecode> or <artwork> element in the XML draft. 
> BALAZS: As far as I understand sourcecode is only available in XML2RFC v3.  Name is not handled by rfcstrip or xym. (I don't have time to update the tools right now.) It would be nice to have an update to rfcstrip that checks every <artwork> and if it has a name attribute, it extracts the content into a file called "name".
> 
> 
> 2.48.2.  "name" Attribute
> 
>   A filename suitable for the contents (such as for extraction to a
>   local file).  This attribute can be helpful for other kinds of tools
>   (such as automated syntax checkers, which work by extracting the
>   source code).  Note that the "name" attribute does not need to be
>   unique for <artwork> elements in a document.  If multiple
>   <sourcecode> elements have the same "name" attribute, a formatter
>   might assume that the elements are all fragments of a single file,
>   and such a formatter can collect those fragments for later
>   processing.
> 
> 
> Kent
> 
> 
> 
> 
>> On Mar 24, 2020, at 11:33 AM, Balázs Lengyel <balazs.lengyel=40ericsson.com@dmarc.ietf.org> wrote:
>> 
>> Hello,
>> A reply from the rfc-editor on <CODE BEGINS>. It seems it is OK.
>> Regards Balazs
>> 
>> -----Original Message-----
>> From: Alice Russo <arusso@amsl.com> 
>> Sent: 2020. március 24., kedd 16:00
>> To: Balázs Lengyel <balazs.lengyel@ericsson.com>
>> Cc: RFC Editor <rfc-editor@rfc-editor.org>
>> Subject: Re: Where can I use <CODE BEGINS> <CODE ENDS> ?
>> 
>> Greetings,
>> 
>> Please see below.
>> 
>>> On Mar 21, 2020, at 8:30 AM, Balázs Lengyel <balazs.lengyel@ericsson.com> wrote:
>>> 
>>> Hello,
>>> Sorry if I am sending this question to the wrong person. 
>>> We have a discussion in the NETMOD workgroup about when is it appropriate/allowed to use the <CODE BEGINS> <CODE ENDS> markings in drafts and RFCs.
>>> We regularly use it to bracket the YANG modules defined. 
>>> e.g.    <CODE BEGINS> file "ietf-yang-instance-data@2020-03-19.yang" 
>>> 
>> 
>> Just FYI, if you are using the new XML vocabulary [1], the markers can be created automatically by using markers="true"
>> -- for example --
>> <sourcecode name="ietf-yang-instance-data@2020-03-19.yang" type="yang" markers="true">
>> 
>>> However is it allowed to use it to bracket XML or json examples in drafts/rfcs? 
>>> e.g.    <CODE BEGINS> file read-only-acm-rules@2020-03-19.xml
>> 
>> Yes, it is allowed. The markers <CODE BEGINS> and <CODE ENDS> are mentioned in the Trust Legal Provisions [2].
>> 
>> [1] https://protect2.fireeye.com/v1/url?k=50261255-0cacc750-502652ce-861010bc36ff-8b3716f9fa495535&q=1&e=11f6fa43-0168-4d1f-8f5d-bffd46fff0d3&u=https%3A%2F%2Fwww.rfc-editor.org%2Fmaterials%2FFAQ-xml2rfcv3.html
>> [2] https://trustee.ietf.org/license-info/IETF-TLP-5.htm (item 4d)
>> 
>> Thank you.
>> RFC Editor/ar
>> 
>>> 
>>> It is very handy that the rfcstrip tool can extract the CODE sections from a draft which facilitates checking these by external tools like yanglint. The checking is needed both for the YANG modules and the examples.
>>> If you as an rfc-editor could give guidance on the issue it would be appreciated. I attached a planned draft.
>>> Best regards Balazs Lengyel 
>>> 
>>> -- 
>>> Balazs Lengyel                    Senior Specialist                       Ericsson Hungary Ltd. 
>>> Mobile: +36-70-330-7909              email: Balazs.Lengyel@ericsson.com
>>> 
>>> <draft-ietf-netmod-yang-instance-file-format-11.txt>
>> _______________________________________________
>> netmod mailing list
>> netmod@ietf.org
>> https://www.ietf.org/mailman/listinfo/netmod
> 
> _______________________________________________
> netmod mailing list
> netmod@ietf.org
> https://www.ietf.org/mailman/listinfo/netmod
> _______________________________________________
> netmod mailing list
> netmod@ietf.org
> https://www.ietf.org/mailman/listinfo/netmod