Re: [netmod] example prefix

[[e-mail]]

Hi Tom,

FYI, here is what I included in 01 of 8407bis:

   For convenience, prefix values of example modules MAY be prefixed
   with "ex" or similar patterns.  In doing so, readers of example
   modules or tree diagrams that mix both example and standard modules
   can easily identify example parts.

Cheers,
Med

> -----Message d'origine-----
> De : netmod <[e-mail]> De la part de tom petch
> Envoyé : jeudi 28 septembre 2023 13:17
> À : Jürgen Schönwälder <[e-mail]>
> Cc : [e-mail]
> Objet : Re: [netmod] example prefix
> 
> From: Jürgen Schönwälder <[e-mail]>
> Sent: 25 September 2023 14:16
> 
> RFC 8407 says:
> 
>    o  The local module prefix MAY be used for references to typedefs,
>       groupings, extensions, features, and identities defined in the
>       module.
> 
> Do you propose to change this and if so to what?
> 
> <tp>
> 
> No.
> 
> https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdata
> tracker.ietf.org%2Fdoc%2Fhtml%2Frfc8407%23section-
> 3.2&data=05%7C01%7Cmohamed.boucadair%40orange.com%7C9b0faac885494ec6a1
> 9208dbc014889b%7C90c7a20af34b40bfbc48b9253b6f5d20%7C0%7C0%7C6383149666
> 46295763%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiL
> CJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=hT5HipOyTNLQzxLXh%
> 2BrFtoziAaYZ%2BtC6lfl%2B8F%2BZAck%3D&reserved=0
> /
> https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdata
> tracker.ietf.org%2Fdoc%2Fhtml%2Frfc8407%23section-
> 3.2.1&data=05%7C01%7Cmohamed.boucadair%40orange.com%7C9b0faac885494ec6
> a19208dbc014889b%7C90c7a20af34b40bfbc48b9253b6f5d20%7C0%7C0%7C63831496
> 6646295763%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzI
> iLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=K6J7C2Uw3Lx8h5ky
> YLsw8YEJ3eVT67a%2BH0zeb0OYk8E%3D&reserved=0
> 
> I would like to recommend there the use of 'eg' as the beginning of a
> prefix in a module where the name starts with example giving prefix
> eg.foo
> 
> I think that beginning with 'example' is a bad choice,  I often
> comment on YANG modules that prefixes are too long, (3-)4(-5)
> characters being good, going longer where there is a group of related
> modules. such as stats, types, common and the like so that a prefix of
> 'ipni' might be augmented to 'ipni-s' and 'ipni-t'. Using 'example' at
> the beginning of  a prefix just endorses the bad practice of making
> them too long..
> 
> Two characters is a bit short but I cannot think of anything remotely
> suitable in three characters.
> 
> The left field advantage of using 'eg' is that I see a number of I-D
> where the author seems to be confusing 'ie' with 'eg' and so using
> 'eg' in this context might help authors remember the difference
> 
> Tom Petch
> 
> 
> /js
> 
> On Mon, Sep 25, 2023 at 12:14:54PM +0000, tom petch wrote:
> > From: Jürgen Schönwälder <[e-mail]>
> > Sent: 25 September 2023 13:10
> >
> > We are not discussing any examples here.
> >
> > <tp>
> >
> > Good
> >
> > I am suggesting an addition to RFC8407 s.4.2 to prevent future
> > confusion
> >
> > Tom Petch
> >
> > /js
> >
> > On Mon, Sep 25, 2023 at 12:09:07PM +0000, tom petch wrote:
> > >
> > > I wonder if we should have a prefix to show that the prefix is an
> example.
> > >
> > > Thus some vendors might think that
> > > prefix vendor-alto-ds
> > > is the prefix that must be used in vendor modules that support
> > > discovery  based on the examples in draft-ietf-alto-oam-yang
> > >
> > > Perhaps a prefix such as
> > > eg-...
> > > would be better although I would rather it were three or four
> characters.
> > >
> > > Tom Petch
> > > _______________________________________________
> > > netmod mailing list
> > > [e-mail]
> > >
> https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fww
> > >
> w.ietf.org%2Fmailman%2Flistinfo%2Fnetmod&data=05%7C01%7Cmohamed.bouc
> > >
> adair%40orange.com%7C9b0faac885494ec6a19208dbc014889b%7C90c7a20af34b
> > >
> 40bfbc48b9253b6f5d20%7C0%7C0%7C638314966646295763%7CUnknown%7CTWFpbG
> > >
> Zsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn
> > >
> 0%3D%7C3000%7C%7C%7C&sdata=6DAq6xK3VJ299U1FTyJjiiaWLwOdXG%2BHeLPT1ia
> > > fpgw%3D&reserved=0
> >
> > --
> > Jürgen Schönwälder              Constructor University Bremen gGmbH
> > Phone: [phone]         Campus Ring 1 | 28759 Bremen |
> Germany
> > Fax:   [phone]
> <https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fcon
> structor.university%2F&data=05%7C01%7Cmohamed.boucadair%40orange.com%7
> C9b0faac885494ec6a19208dbc014889b%7C90c7a20af34b40bfbc48b9253b6f5d20%7
> C0%7C0%7C638314966646295763%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMD
> AiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata
> =N%2BBWDLZy9%2Fd52bOvHibRLNIXZP6elB4dBtM5PhwTytQ%3D&reserved=0>
> 
> --
> Jürgen Schönwälder              Constructor University Bremen gGmbH
> Phone: [phone]         Campus Ring 1 | 28759 Bremen | Germany
> Fax:   [phone]
> <https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fcon
> structor.university%2F&data=05%7C01%7Cmohamed.boucadair%40orange.com%7
> C9b0faac885494ec6a19208dbc014889b%7C90c7a20af34b40bfbc48b9253b6f5d20%7
> C0%7C0%7C638314966646295763%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMD
> AiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata
> =N%2BBWDLZy9%2Fd52bOvHibRLNIXZP6elB4dBtM5PhwTytQ%3D&reserved=0>
> 
> _______________________________________________
> netmod mailing list
> [e-mail]
> https://eur03.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.
> ietf.org%2Fmailman%2Flistinfo%2Fnetmod&data=05%7C01%7Cmohamed.boucadai
> r%40orange.com%7C9b0faac885494ec6a19208dbc014889b%7C90c7a20af34b40bfbc
> 48b9253b6f5d20%7C0%7C0%7C638314966646295763%7CUnknown%7CTWFpbGZsb3d8ey
> JWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C300
> 0%7C%7C%7C&sdata=6DAq6xK3VJ299U1FTyJjiiaWLwOdXG%2BHeLPT1iafpgw%3D&rese
> rved=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.