My reading is that it is recommended.  Not required.
But what I do for readability and to avoid lint issues is use rfcfold on trees 
or examples that have long lines.  For the examples that are xml or json based, 
the consumer of the RFC needs to reverse the fold so that the example works in 
yanglint or other tools.

I could editorialize about how in 2023 we are still hindered by a limit imposed 
by a VT100 from 1978, but I have said enough.

Regards,
-scott.

From: CCAMP <ccamp-boun...@ietf.org> On Behalf Of Italo Busi
Sent: Wednesday, July 5, 2023 5:59 PM
To: netmod@ietf.org
Cc: cc...@ietf.org; TEAS WG <t...@ietf.org>
Subject: [CCAMP] Lines too long in YANG tree diagrams

RFC8340 suggests to use the "--tree-line-length 69" option to produce YANG tree 
diagrams to be included into an Internet-Draft or RFC.

Although this option works well in many cases, there are few cases where pyang 
produces YANG tree diagram with lines too long even with the 
"--tree-line-length 69" option and in this case it is not fully clear what 
could be done when including those YANG tree diagram into Internet-Drafts or 
RFCs

Section 5.2 of RFC8792 says:

It is RECOMMENDED that authors do as much as possible within the selected 
format to avoid long lines.

My interpretation of the RECOMMENDED key word and of "as much as possible" is 
that we MUST always use the "--tree-line-length 69" option to generate the YANG 
tree diagrams to be included into Internet-Drafts or RFCs and that we MAY use 
RFC8792 tool to fold the YANG tree diagrams when they contain lines too long

Is my interpretation correct?

Thanks, Italo


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

Reply via email to