Re: [yang-doctors] Yangdoctors early review of draft-ietf-babel-yang-model-03

Martin Bjorklund <mbj@tail-f.com> Tue, 15 October 2019 06:38 UTC

Return-Path: <mbj@tail-f.com>
X-Original-To: yang-doctors@ietfa.amsl.com
Delivered-To: yang-doctors@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 055C212006D; Mon, 14 Oct 2019 23:38:48 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.9
X-Spam-Level:
X-Spam-Status: No, score=-1.9 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id X34EU3HFl_cb; Mon, 14 Oct 2019 23:38:45 -0700 (PDT)
Received: from mail.tail-f.com (mail.tail-f.com [46.21.102.45]) by ietfa.amsl.com (Postfix) with ESMTP id 8D9C912004E; Mon, 14 Oct 2019 23:38:45 -0700 (PDT)
Received: from localhost (unknown [173.38.220.41]) by mail.tail-f.com (Postfix) with ESMTPSA id 578121AE02BD; Tue, 15 Oct 2019 08:38:43 +0200 (CEST)
Date: Tue, 15 Oct 2019 08:38:16 +0200 (CEST)
Message-Id: <20191015.083816.593214766346959138.mbj@tail-f.com>
To: mjethanandani@gmail.com
Cc: rkrejci@cesnet.cz, noreply@ietf.org, yang-doctors@ietf.org, draft-ietf-babel-yang-model.all@ietf.org, babel@ietf.org
From: Martin Bjorklund <mbj@tail-f.com>
In-Reply-To: <7C7FF9F2-1B87-46EB-A55D-FCA0C4E3CFD4@gmail.com>
References: <157106166738.24700.11185508261809138396@ietfa.amsl.com> <20191014.160642.807920684918683059.mbj@tail-f.com> <7C7FF9F2-1B87-46EB-A55D-FCA0C4E3CFD4@gmail.com>
X-Mailer: Mew version 6.8 on Emacs 25.2
Mime-Version: 1.0
Content-Type: Text/Plain; charset=utf-8
Content-Transfer-Encoding: base64
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/NLDNvqhty_NNRUtx0CTq409fkY8>
Subject: Re: [yang-doctors] Yangdoctors early review of draft-ietf-babel-yang-model-03
X-BeenThere: yang-doctors@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Email list of the yang-doctors directorate <yang-doctors.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/yang-doctors>, <mailto:yang-doctors-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/yang-doctors/>
List-Post: <mailto:yang-doctors@ietf.org>
List-Help: <mailto:yang-doctors-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/yang-doctors>, <mailto:yang-doctors-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 15 Oct 2019 06:38:48 -0000

Mahesh Jethanandani <mjethanandani@gmail.com>; wrote:
> 
> 
> > On Oct 14, 2019, at 7:06 AM, Martin Bjorklund <mbj@tail-f.com>; wrote:
> > 
> > Radek Krejčí via Datatracker <noreply@ietf.org>; wrote:
> >> Reviewer: Radek Krejčí
> >> Review result: Ready with Nits
> >> 
> >> There is a single module in the draft: ietf-babel@2019-08-22.yang.
> >> 
> >> There are 2 warnings reported by pyang 2.0.2, but both warnings seem
> >> to be
> >> false.
> > 
> > Actually, I think they are correct.
> > 
> > 
> >> ietf-babel@2019-08-22.yang:53: warning: RFC 8407: 3.1: The IETF Trust
> >> Copyright
> >> statement seems to be missing (see pyang --ietf-help for details).
> > 
> > Ok it isn't missing, but it doesn't use the eaxct words it should
> > use.
> 
> Yes, the words are not exact. I see two versions of the copyright
> statement. Do not know which one is the correct one.
> 
> In the model and output of ‘pyang —ietf-help’
> 
>      Copyright (c) 2019 IETF Trust and the persons identified as
>      the document authors.  All rights reserved.
> 
>      Redistribution and use in source and binary forms, with or
>      without modification, is permitted pursuant to, and subject
>      to the license terms contained in, the Simplified BSD
>      License set forth in Section 4.c of the IETF Trust's Legal
>      Provisions Relating to IETF Documents
>      (http://trustee.ietf.org/license-info).

pyang only checks the text in the YANG model.

But the text in the the model and the pyang --ietf-help are not the
same (they are similar but not the same).

The text that pyang enforces is the text found in the template in
Appendix B in RFC 8407 (it allows (and recommends) a link to the RFC
which is not present in the 8407 template).

The template text in 8407 is taken from paragraph 6.d in
https://trustee.ietf.org/license-info/IETF-TLP-5.htm.


> In the draft:
> 
>    Copyright (c) 2019 IETF Trust and the persons identified as the
>    document authors.  All rights reserved.
> 
>    This document is subject to BCP 78 <https://tools.ietf.org/html/bcp78>
>    and the IETF Trust's Legal
>    Provisions Relating to IETF Documents
>    (https://trustee.ietf.org/license-info
>    <https://trustee.ietf.org/license-info>) in effect on the date of
>    publication of this document.  Please review these documents
>    carefully, as they describe your rights and restrictions with respect
>    to this document.  Code Components extracted from this document must
>    include Simplified BSD License text as described in Section 4.e of
>    the Trust Legal Provisions and are provided without warranty as
>    described in the Simplified BSD License.
> 
> > 
> >> ietf-babel@2019-08-22.yang:208: warning: the module seems to use RFC
> >> 2119
> >> keywords, but the required text from RFC 8174 is not found (see pyang
> >> --ietf-help for details).
> > 
> > This one seems legit as well.
> 
> Yes, it is missing the word “NOT RECOMMENDED”. I will add it.

Note that pyang just checks the module, not the draft.  It asks you to
include the 8174 text in the module's description.  It is included in
all "recently" published modules (that use 8174 language).  See
e.g. RFC 8366.

This recommendation is not included in RFC 8407, and I don't remember
the exact origin (perhaps Kent?), but it came out of the discussions
with the RFC editor.



/martin