Re: [yang-doctors] reference in import statement

Mahesh Jethanandani <mjethanandani@gmail.com> Thu, 22 February 2018 17:20 UTC

Return-Path: <mjethanandani@gmail.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 6AC9512D874 for <yang-doctors@ietfa.amsl.com>; Thu, 22 Feb 2018 09:20:11 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.999
X-Spam-Level:
X-Spam-Status: No, score=-1.999 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=gmail.com
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 TCR209pG_Uu3 for <yang-doctors@ietfa.amsl.com>; Thu, 22 Feb 2018 09:20:09 -0800 (PST)
Received: from mail-pl0-x22c.google.com (mail-pl0-x22c.google.com [IPv6:2607:f8b0:400e:c01::22c]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 1C8D012D871 for <yang-doctors@ietf.org>; Thu, 22 Feb 2018 09:20:09 -0800 (PST)
Received: by mail-pl0-x22c.google.com with SMTP id bb3so3239941plb.2 for <yang-doctors@ietf.org>; Thu, 22 Feb 2018 09:20:09 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; bh=keIsnFeuzTD3Z3NkboDLBy4GU7AsIOIusKnwfiGaiWc=; b=WTLxTu8lo4DohOC31gQbprAehfx6H1+j/J7+XNbAJ/1b6fpkQ2/hx+c4MzYALmU/8g AM5Xlw00DF+3FknDZAe22/dFRihs42zkBQXX1B62Aofy2tsAKK35rWORR8UuPSIGr1st VvFigaAQIezIAarpYPbVT3f3fWrNND4/QUjQ3LsHJAZNgbf/IVXdoZUKK0aheOt2N2TN Oh8u1MQXBZgHrkZyqej7KM5mRTiArW9ysrpUOF+xNTak1NHxv9f/U4r4GljT9oPFb4AM rMriQWhbzOabX9MwULuNJtAJslerCDdgjmGLhqa4u75jKKBigBf+Cey9Vf5VaRhnupaW TFdw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; bh=keIsnFeuzTD3Z3NkboDLBy4GU7AsIOIusKnwfiGaiWc=; b=M1stpu5sGRj3h0jr7tBk+ZEpk1ZOebPvlifUKMZIsEcXwCO0s6WJ06Uy1ZTom1n8IN iIx9vzR8uF/z8JEdaTHFfolHP2/ntQ09gUvLgJDAp1uEncRmHo3ScSkVlhZKl3R6fBBv XxDvvqvY+/GY9Y/hWnyV1NuoD9Yv6cIy8sCVTsxqHbSkoMpzmwia5EVBRwgMBsrs8rcU 9SXUhuKpjkQLuN0dwGrvStYSnWjGdtP2/48a5xYztqKXH7ri59pRYg+m8qZXtc2p4kgl WYTpZ3hiZgiKGnBZ08BEV1mRsFq2NO58+5DgWuaRtTHb/7nET/jEzkzUtC3dUUguXrDo fNRg==
X-Gm-Message-State: APf1xPBojnXsSi/7EwMwb5c9HgXqN8nLKZNIukMumRfo4flnXAhOxsB+ 1I4gRNleL+pPrs57D7gheVc=
X-Google-Smtp-Source: AH8x226ohEJOC6uKfKsyjjgVN1AtuUe5X6Xwl67a5g0OZgSKOCz0YdX1IXOKqCq9+bGB4p4ZPS5EsA==
X-Received: by 2002:a17:902:b901:: with SMTP id bf1-v6mr787150plb.175.1519320008332; Thu, 22 Feb 2018 09:20:08 -0800 (PST)
Received: from ?IPv6:2601:647:4700:1280:9d2d:1cd4:b8b7:50ab? ([2601:647:4700:1280:9d2d:1cd4:b8b7:50ab]) by smtp.gmail.com with ESMTPSA id a87sm986003pfj.13.2018.02.22.09.20.07 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 22 Feb 2018 09:20:07 -0800 (PST)
Content-Type: text/plain; charset=utf-8
Mime-Version: 1.0 (Mac OS X Mail 11.2 \(3445.5.20\))
From: Mahesh Jethanandani <mjethanandani@gmail.com>
In-Reply-To: <20180222.085323.144940543114040096.mbj@tail-f.com>
Date: Thu, 22 Feb 2018 09:25:44 -0800
Cc: Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de>, yang-doctors@ietf.org
Content-Transfer-Encoding: quoted-printable
Message-Id: <A37B4457-245F-4ACA-957E-94206F08C491@gmail.com>
References: <20180215083130.uagwwr5huxgs5qst@elstar.local> <9783C687-6D5B-4FF4-BFB6-3D9FA62DB249@gmail.com> <20180222.085323.144940543114040096.mbj@tail-f.com>
To: Martin Bjorklund <mbj@tail-f.com>
X-Mailer: Apple Mail (2.3445.5.20)
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/fIanpY5fIyXULrM3WIKpPXrvdX8>
Subject: Re: [yang-doctors] reference in import statement
X-BeenThere: yang-doctors@ietf.org
X-Mailman-Version: 2.1.22
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: Thu, 22 Feb 2018 17:20:11 -0000

Hi Martin,


> On Feb 21, 2018, at 11:53 PM, Martin Bjorklund <mbj@tail-f.com> wrote:
> 
> Hi,
> 
> Mahesh Jethanandani <mjethanandani@gmail.com> wrote:
>> I agree that this is grounds for confusion. 
>> 
>> My preference would be that we NOT have a reference statement for
>> import, or a comment for that matter, unless the module is doing
>> import by revision. The text of the document is already required to
>> have normative references to whatever the module imports.
> 
> I think this would be quite unfortunate, even though I agree that it
> might be confusing to have the reference.  The problem with having
> the reference only in the main body is that modules are typically
> extracted from the RFCs and live their own life.  So all you have is a
> list of various imported modules, and it is not obvious where to find
> them.

Wasn’t the idea to not have the relationship between RFC number and a YANG model because of some of these very reasons, and move to IANA maintaining a copy of all version of the YANG models? If so, would it not make sense to refer to the IANA registry, rather than point to the RFC?

> 
> We added the "reference" statement to "import" for this very reason in
> YANG 1.1.
> 
> So maybe the best solution is the one suggested by Juergen initially:
> 
>    reference "RFC 6991: Common YANG Data Types
>                 (at the time of this writing)";
> 
> 
> Or maybe we declare that in fact this is not confusing (or at least it
> is not a major issue) - people are aware of the fact that documents
> evolve, and that there might be a more recent version available.
> 
> 
> /martin
> 
>> 
>> Cheers.
>> 
>>> On Feb 15, 2018, at 12:31 AM, Juergen Schoenwaelder
>>> <j.schoenwaelder@jacobs-university.de> wrote:
>>> 
>>> Hi,
>>> 
>>> I have just seen this pattern
>>> 
>>>  import ietf-inet-types {
>>>    prefix "inet";
>>>    reference "RFC 6991";
>>>  }
>>> 
>>> and I wonder how people understand this. From the way this import
>>> works, any (newer) version of ietf-inet-types is OK to use to resolve
>>> the import but I could see that this statement makes people believe
>>> they have to use the version of ietf-inet-types contained in RFC 6991
>>> (but then this should have been import by revision). I know that we
>>> had a common practice to have comments before this was possible, like
>>> 
>>>  import ietf-inet-types {             // RFC 6991
>>>    prefix "inet";
>>>  }
>>> 
>>> but then this was a comment, now the RFC numbers becomes part of the
>>> definition. Should we be concerned about this? Or should we suggest
>>> to be more clear about this, e.g.:
>>> 
>>>  import ietf-inet-types {
>>>    prefix "inet";
>>>    reference "RFC 6991 (at the time of this writing)";
>>>  }
>>> 
>>> /js
>>> 
>>> -- 
>>> Juergen Schoenwaelder           Jacobs University Bremen gGmbH
>>> Phone: +49 421 200 3587         Campus Ring 1 | 28759 Bremen | Germany
>>> Fax:   +49 421 200 3103         <https://www.jacobs-university.de/>
>>> 
>>> _______________________________________________
>>> yang-doctors mailing list
>>> yang-doctors@ietf.org
>>> https://www.ietf.org/mailman/listinfo/yang-doctors
>> 
>> Mahesh Jethanandani
>> mjethanandani@gmail.com
>> 
>> _______________________________________________
>> yang-doctors mailing list
>> yang-doctors@ietf.org
>> https://www.ietf.org/mailman/listinfo/yang-doctors
>> 

Mahesh Jethanandani
mjethanandani@gmail.com