Re: Lines too long in YANG tree diagrams

Tree diagrams are a means to explain the structure of a module. It is
often useful to larger diagrams into small pieces and then the line
length problem resolves itself. See also Section 3.3 of RFC 8340.

/js

On Wed, Jul 05, 2023 at 09:58:46PM +0000, Italo Busi wrote:
> 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
> [email protected]
> https://www.ietf.org/mailman/listinfo/netmod


-- 
Jürgen Schönwälder              Constructor University Bremen gGmbH
Phone: +49 421 200 3587         Campus Ring 1 | 28759 Bremen | Germany
Fax:   +49 421 200 3103         <https://constructor.university/>

_______________________________________________
netmod mailing list
[email protected]
https://www.ietf.org/mailman/listinfo/netmod