Re: [netmod] example prefix

[tom petch <[e-mail]>]

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://datatracker.ietf.org/doc/html/rfc8407#section-3.2
/ https://datatracker.ietf.org/doc/html/rfc8407#section-3.2.1

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://www.ietf.org/mailman/listinfo/netmod
>
> --
> Jürgen Schönwälder              Constructor University Bremen gGmbH
> Phone: [phone]         Campus Ring 1 | 28759 Bremen | Germany
> Fax:   [phone]         <https://constructor.university/>

--
Jürgen Schönwälder              Constructor University Bremen gGmbH
Phone: [phone]         Campus Ring 1 | 28759 Bremen | Germany
Fax:   [phone]         <https://constructor.university/>