Re: [Detnet] Comments on detnet-yang-15 Re: [Last-Call] Yangdoctors last call review of draft-ietf-detnet-yang-14

[tom petch <[e-mail]>]

On 18/02/2022 15:57, Don Fedyk wrote:
> Hi Tom
>
> Looked into this and found RFC 7224 iana-if-type.yang uses this:
>
> module iana-if-type {
>    namespace "urn:ietf:params:xml:ns:yang:iana-if-type";
>    prefix ianaift;
>
> In the examples the string "iana-if-type" comes from the XML namespace not the prefix declared. Detnet YANG does not import iana-if-type.yang but it imports ietf-interface.yang module that imports iana-if-type.yang. When validating with Yanglint I have no control of the display "iana-if-yang" in examples - I use short form prefixes for those on input that do not show up in the Yanglint output. Yanglint expands the prefix used in the XML test files to the namespace.
> While we can add a reference RFC 7224, it is a namespace not a prefix that shows up in the output. Every object in the examples has its specified namespace. You pointed to a part of an example using ietf-interfaces namespace which prepends the iana-if-type namespace just for the typedef object.

Two thoughts.  First, the IETF advice is strongly that when an IETF 
module is referenced, then the prefix used should be that that module 
itself declares.  Since this is the common practice, then using any 
other is likely to cause confusion.  Yes, tools have to cope with 
deviations such as 'xmlns:ia=...' but that does not make them right.

Second, iana-if-type is an IANA maintained module so RFC7224 is no 
longer relevant.  Any reference should be to 
www.iana.org/assignments/iana-if-type/ .... (where the prefix is 'ianaift').

Since I see 'xmlns: ...' in the text of the RFC-to-be, in the examples, 
then my take is that understanding the RFC will to some extent depend on 
being familiar with iana-if-type.  I think you need a statement at the 
start of the examples that the examples include references to YANG 
module 'iana-if-type ' [Informative reference to IANA website]


Tom Petch
>
> Cheers,
>
> Don
>
>
> -----Original Message-----
> From: tom petch <[e-mail]>
> Sent: Wednesday, February 16, 2022 8:07 AM
> To: Don Fedyk <[e-mail]>
> Cc: [e-mail]; [e-mail]
> Subject: Re: Comments on detnet-yang-15 Re: [Last-Call] Yangdoctors last call review of draft-ietf-detnet-yang-14
>
> On 12/01/2022 14:07, Don Fedyk wrote:
>
> Don
>
> I am not sure where this is in processing terms - I see no Telechat date yet.
>
> I have (finally) looked at the examples having been put off by the size previously.
>
> I see that they reference iana-if-type but
> - there is no I-D reference for this IANA-maintained YANG module and I think that there should be
> - the wrong prefix is used - the module declares a prefix of ianaft so that is what an IETF document should use.
>
> I am still looking at the examples.
>
> Tom Petch
>
>> FYI
>>
>> After Tom pointed this out, I did find the new site under author tools that generates all formats correctly including SVG from the latest version 3 xml.
>> https://author-tools.ietf.org/
>>
>>
>> Cheers
>> Don
>>
>> -----Original Message-----
>> From: Don Fedyk <[e-mail]>
>> Sent: Thursday, January 6, 2022 2:01 PM
<snip>