Hello,
A reply from the rfc-editor on <CODE BEGINS>. It seems it is OK.
Regards Balazs

-----Original Message-----
From: Alice Russo <aru...@amsl.com> 
Sent: 2020. március 24., kedd 16:00
To: Balázs Lengyel <balazs.leng...@ericsson.com>
Cc: RFC Editor <rfc-edi...@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.leng...@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-d...@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-d...@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-ru...@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://www.rfc-editor.org/materials/FAQ-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.leng...@ericsson.com
> 
> <draft-ietf-netmod-yang-instance-file-format-11.txt>

Attachment: smime.p7s
Description: S/MIME cryptographic signature

_______________________________________________
netmod mailing list
netmod@ietf.org
https://www.ietf.org/mailman/listinfo/netmod

Reply via email to