Hi all, 

Indeed.

FWIW, we used to have a similar guideline for the modules themselves in 
draft-boucadair-netmod-rfc8407bis:

CURRENT: 
   Native YANG features (e.g., breaking line, "+") SHOULD be used to fit
   a module into the line limits.  Exceptionally, RFC8792-folding of
   YANG modules MAY be used if and only if native YANG features are not
   sufficient.  

I updated it to also cover Italo's initial comment:

NEW:
   Native YANG features (e.g., breaking line, "+") SHOULD be used to fit
   a module into the line limits.  Exceptionally, RFC8792-folding of
   YANG modules MAY be used if and only if native YANG features are not
   sufficient.  A similar approach (e.g., use "--yang-line-length 69" or
   split a tree into subtrees) SHOULD be followed for tree diagrams.

Cheers,
Med

> -----Message d'origine-----
> De : Teas <teas-boun...@ietf.org> De la part de Jürgen Schönwälder
> Envoyé : jeudi 6 juillet 2023 00:31
> À : Italo Busi <Italo.Busi=40huawei....@dmarc.ietf.org>
> Cc : netmod@ietf.org; cc...@ietf.org; TEAS WG <t...@ietf.org>
> Objet : Re: [Teas] [netmod] 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
> > netmod@ietf.org
> >
> https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> www.
> >
> ietf.org%2Fmailman%2Flistinfo%2Fnetmod&data=05%7C01%7Cmohamed.bouc
> adai
> >
> r%40orange.com%7Cf3ffe07d44fd4ed0e96708db7da78c46%7C90c7a20af34b40
> bfbc
> >
> 48b9253b6f5d20%7C0%7C0%7C638241930786968316%7CUnknown%7CTWFpbGZsb3
> d8ey
> >
> JWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7
> C300
> >
> 0%7C%7C%7C&sdata=FghTSoqFDCSnCdBAOva8o2GTk18sEEzRwkq9S8Pu%2Bv8%3D&
> rese
> > rved=0
> 
> 
> --
> 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://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2
> Fconstructor.university%2F&data=05%7C01%7Cmohamed.boucadair%40oran
> ge.com%7Cf3ffe07d44fd4ed0e96708db7da78c46%7C90c7a20af34b40bfbc48b9
> 253b6f5d20%7C0%7C0%7C638241930786968316%7CUnknown%7CTWFpbGZsb3d8ey
> JWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7
> C3000%7C%7C%7C&sdata=bmL2OgL0P%2Fr4AsIJFS4I1yPlPJD5UBkF1Ix483u6TQo
> %3D&reserved=0>
> 
> _______________________________________________
> Teas mailing list
> t...@ietf.org
> https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2F
> www.ietf.org%2Fmailman%2Flistinfo%2Fteas&data=05%7C01%7Cmohamed.bo
> ucadair%40orange.com%7Cf3ffe07d44fd4ed0e96708db7da78c46%7C90c7a20a
> f34b40bfbc48b9253b6f5d20%7C0%7C0%7C638241930786968316%7CUnknown%7C
> TWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLC
> JXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=5ooNg7LBnEucI%2B%2BNxgOhAgNnCa3
> 4KJVqKsRpfGpAfN8%3D&reserved=0
____________________________________________________________________________________________________________
Ce message et ses pieces jointes peuvent contenir des informations 
confidentielles ou privilegiees et ne doivent donc
pas etre diffuses, exploites ou copies sans autorisation. Si vous avez recu ce 
message par erreur, veuillez le signaler
a l'expediteur et le detruire ainsi que les pieces jointes. Les messages 
electroniques etant susceptibles d'alteration,
Orange decline toute responsabilite si ce message a ete altere, deforme ou 
falsifie. Merci.

This message and its attachments may contain confidential or privileged 
information that may be protected by law;
they should not be distributed, used or copied without authorisation.
If you have received this email in error, please notify the sender and delete 
this message and its attachments.
As emails may be altered, Orange is not liable for messages that have been 
modified, changed or falsified.
Thank you.

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

Reply via email to