Subject: Re: [Lsr] I-D Action: draft-dontula-lsr-yang-dynamic-flooding-03.txt

From: tom petch <[email-masked]>
Date: Tue, 13 Oct 2020 11:34:49 +0000

From: Tony Li <[email-masked]> on behalf of [email-masked] <[email-masked]>
Sent: 15 September 2020 22:17

Our apologies.  We’re on it.

<tp>
Thank you, -04 is much easier to digest although perhaps not easy:-(

I think that the I-D needs to decide what to do with OpenConfig which appears a lot in one module and makes it hard to read.  If this is going to be an IETF module, then I think that it all has to go, perhaps via an appendix while the I-D is under development.

The lack of text makes it hard to know what is intended.  I reverse engineer the YANG to find out what it is meant to do and lo and behold the YANG does just that.  I think that the base OSPF YANG module gets it just right with its mix of text and tree diagram, so I can see what it is trying to do, see at a high level and then go to the detail of the YANG.  Several other routing area I-D are similar although by no means all.

Also the lack of references, or the minimal descriptions, or both make it hard to follow. so algorithm is uint8, connection type is uint8, what is an ID in number of IDs?, index is uint16, priority is uint8 but what is high what low? and so on.  I should not need to know lsr-dynamic-flooding off by heart in order to make sense of this.

And
- Security Considerations is plain wrong; go read YANG Guidelines:-)
- IANA Considerations ditto
- XXXX is used as a placeholder for two different I-D
-  ietf-ospf-dynflood would be consistent and less error prone IMHO
- RFC6991, RFC8349 need to be Normative references
- Introduction should reference OSPFv3
- objects and identities relating to TLV need references - they are ever harder to find in the IETF literature
- ospf should be capitalised, LEEF probably not
- several abbreviations need expanding on first use perhaps in a terminology section; usually there is one such for YANG terminology
- I wonder if ospf-dynamic-flooding would be a better feature name given there are the two of them side-by-side

Tom Petch

Tony

> On Sep 15, 2020, at 9:04 AM, Acee Lindem (acee) <acee=[email-masked]> wrote:
>
> It looks like some unfortunate tab settings at least for the OSPF model...  Note that pyang can be used for formatting.
>
> pyang -f yang <model-file> --yang-line-length 68
>
> On 9/15/20, 11:47 AM, "Lsr on behalf of tom petch" <[email-masked] on behalf of [email-masked]> wrote:
>
>    The formatting of this I-D seems to have gone wrong making it hard to read and review.  The indentation of successive lines of the YANG module is more than it usually is.  This was a problem with -01 that was not present in -02 but has now returned in -03
>
>    Tom Petch
>
>    From: I-D-Announce <[email-masked]> on behalf of [email-masked] <[email-masked]>
>    Sent: 14 September 2020 22:15
>    To: [email-masked]
>    Subject: I-D Action: draft-dontula-lsr-yang-dynamic-flooding-03.txt
>
>
>    A New Internet-Draft is available from the on-line Internet-Drafts directories.
>
>
>            Title           : YANG Data Model for Dynamic Flooding
>            Authors         : Srinath Dontula
>                              Tony Li
>            Filename        : draft-dontula-lsr-yang-dynamic-flooding-03.txt
>            Pages           : 26
>            Date            : 2020-09-14
>
>    Abstract:
>       This document defins YANG data models that can be used to configure
>       and manage Dynamic Flooding for IS-IS and OSPF.
>
>
>    The IETF datatracker status page for this draft is:
>    https://datatracker.ietf.org/doc/draft-dontula-lsr-yang-dynamic-flooding/
>
>    There are also htmlized versions available at:
>    https://tools.ietf.org/html/draft-dontula-lsr-yang-dynamic-flooding-03
>    https://datatracker.ietf.org/doc/html/draft-dontula-lsr-yang-dynamic-flooding-03
>
>    A diff from the previous version is available at:
>    https://www.ietf.org/rfcdiff?url2=draft-dontula-lsr-yang-dynamic-flooding-03
>
>
>    Please note that it may take a couple of minutes from the time of submission
>    until the htmlized version and diff are available at tools.ietf.org.
>
>    Internet-Drafts are also available by anonymous FTP at:
>    ftp://ftp.ietf.org/internet-drafts/
>
>
>    _______________________________________________
>    I-D-Announce mailing list
>    [email-masked]
>    https://www.ietf.org/mailman/listinfo/i-d-announce
>    Internet-Draft directories: http://www.ietf.org/shadow.html
>    or ftp://ftp.ietf.org/ietf/1shadow-sites.txt
>
>    _______________________________________________
>    Lsr mailing list
>    [email-masked]
>    https://www.ietf.org/mailman/listinfo/lsr
>
> _______________________________________________
> Lsr mailing list
> [email-masked]
> https://www.ietf.org/mailman/listinfo/lsr