Re: [CCAMP] [netmod] What to reference when importing an IANA module?

Randy Presuhn <randy_presuhn@alumni.stanford.edu> Mon, 16 January 2023 18:56 UTC

Return-Path: <randy_presuhn@alumni.stanford.edu>
X-Original-To: ccamp@ietfa.amsl.com
Delivered-To: ccamp@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 65305C1516E3 for <ccamp@ietfa.amsl.com>; Mon, 16 Jan 2023 10:56:13 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.896
X-Spam-Level:
X-Spam-Status: No, score=-1.896 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, NICE_REPLY_A=-0.001, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=unavailable autolearn_force=no
Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id KZBwI3bMlGOg for <ccamp@ietfa.amsl.com>; Mon, 16 Jan 2023 10:56:09 -0800 (PST)
Received: from mail-pf1-f174.google.com (mail-pf1-f174.google.com [209.85.210.174]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 70792C14CE29 for <ccamp@ietf.org>; Mon, 16 Jan 2023 10:56:09 -0800 (PST)
Received: by mail-pf1-f174.google.com with SMTP id g205so4554083pfb.6 for <ccamp@ietf.org>; Mon, 16 Jan 2023 10:56:09 -0800 (PST)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:in-reply-to:from:references:to :content-language:subject:user-agent:mime-version:date:message-id :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=JVtM42b4+/MH9EPcgkTSAUQv+Ep/8FZsudIpTA1Ax4U=; b=PUbqQ2EnWgBzj4YkBaq4FJuzv1H20o5vcsdU/VkX70bhb/fwvHJbpa3ZtfwQvOmujC iNbEEResaY2kKiCXlqCu2iHRCA/EvnfcmlvftON3L28mb6PUQn4Ud0k9TDKd/B8unddR O1j3LYCtgWPJIGvO95gA0pYQe1M9vZtD+V6Wjuwo9aZsQrjrGkBozQE7uHy8yV4NSfA3 PETF/ifEwzVJis6J2MhVjD/EiReGGSMETncGOypGpjaMSEQLRR/uQruUjRI/kMG9puVU 48dv66UZWPEy41erFItXLpjICYcBpt6LGQ9Y7QJOkgtSJKjY8G9NtfT4Y+CaE1YQnym+ HriQ==
X-Gm-Message-State: AFqh2krEx1fJyP1/WnNKpRYszn4RXTx1+o2B746PO1IBZXmVJIRMLQaF 7N+pkrHP65OnHJPdwzd3/mVjeg==
X-Google-Smtp-Source: AMrXdXu1IhSlKK+IjITPX2JzRJ4zC10Fwb5iGaTN4iWofd0Smq4KpP+d1uB+L7/ma1T6V4KkbgteRA==
X-Received: by 2002:a62:1b52:0:b0:58b:3168:4d53 with SMTP id b79-20020a621b52000000b0058b31684d53mr552107pfb.24.1673895368894; Mon, 16 Jan 2023 10:56:08 -0800 (PST)
Received: from ?IPV6:2601:646:9300:b1e:5072:c7b7:6b9:d5a2? ([2601:646:9300:b1e:5072:c7b7:6b9:d5a2]) by smtp.gmail.com with ESMTPSA id i13-20020a056a00004d00b0058d9b68042fsm2894261pfk.14.2023.01.16.10.56.08 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 16 Jan 2023 10:56:08 -0800 (PST)
Message-ID: <3a278cad-973c-7966-33ce-806cc776a67e@alumni.stanford.edu>
Date: Mon, 16 Jan 2023 10:56:06 -0800
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101 Thunderbird/102.6.1
Content-Language: en-US
To: Benoit Claise <benoit.claise@huawei.com>, "ccamp@ietf.org" <ccamp@ietf.org>, "netmod@ietf.org" <netmod@ietf.org>
References: <900fcde63e90473b8424658bc7095818@huawei.com> <ede7a11a-bc66-26a5-f33a-83b15fc61fde@huawei.com> <AM7PR07MB624874275BBD327AEB38C004A0FD9@AM7PR07MB6248.eurprd07.prod.outlook.com> <ab763386-7668-39a7-a080-1bc202eb992e@huawei.com> <AM7PR07MB6248DE5396AC76C0101B233BA0C29@AM7PR07MB6248.eurprd07.prod.outlook.com> <b4dd6eae-7cab-5c87-5e1e-d90a0859b466@huawei.com> <01000185ac5c8328-452eee8e-b8d8-4ef0-955a-e2ead0c557b2-000000@email.amazonses.com> <072be8fa-3801-1236-752a-e44df9347d18@alumni.stanford.edu> <953da02a-b364-cdda-0c6d-89d4ea1ec2fa@huawei.com>
From: Randy Presuhn <randy_presuhn@alumni.stanford.edu>
In-Reply-To: <953da02a-b364-cdda-0c6d-89d4ea1ec2fa@huawei.com>
Content-Type: text/plain; charset="UTF-8"; format="flowed"
Content-Transfer-Encoding: 8bit
Archived-At: <https://mailarchive.ietf.org/arch/msg/ccamp/DhJJUg7MhgbnmHQWZxLhwe0rYxE>
Subject: Re: [CCAMP] [netmod] What to reference when importing an IANA module?
X-BeenThere: ccamp@ietf.org
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: Discussion list for the CCAMP working group <ccamp.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/ccamp>, <mailto:ccamp-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/ccamp/>
List-Post: <mailto:ccamp@ietf.org>
List-Help: <mailto:ccamp-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/ccamp>, <mailto:ccamp-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 16 Jan 2023 18:56:13 -0000

Hi -

Serves me right for responding before reading all the messages in
my inbox.  I concur with Benoit's comments.

Randy

On 2023-01-16 2:49 AM, Benoit Claise wrote:
> Dear all,
> 
> On 1/13/2023 9:22 PM, Randy Presuhn wrote:
>> Hi -
>>
>> On 2023-01-13 10:20 AM, Kent Watsen wrote:
>>>
>>>
>>>> On Jan 13, 2023, at 11:25 AM, Benoit Claise 
>>>> <benoit.claise=40huawei.com@dmarc.ietf.org> wrote:
>>>>
>>>> Hi Tom,
>>>>> Yes I do think that people outside the IETF may be ignorant of the 
>>>>> nuances of the way the IETF works and  may not realise that a URL 
>>>>> to the IANA website must be used in preference to an RFC.  There is 
>>>>> more to YANG modules than extracting the code from somewhere in 
>>>>> order to incorporate it into something.  I have even seen RFC 
>>>>> reference the obsolete list of possibilities  in the RFC that set 
>>>>> up an IANA registry
>>>> If this is the case (And Randy supports this), then we should update 
>>>> RFC 8047.
>>
>> Benoit's reference to RFC 8047 had me puzzled until I saw Kent's
>> response regarding RFC 8407.  :-)
>>
>>> Agreed - as a hold for document update?
>>>
>>> Currently RFC 8407, Section 3.9 says:
>>>
>>>     For every import or include statement that appears in a module
>>>     contained in the specification that identifies a module in a 
>>> separate
>>>     document, a corresponding normative reference to that document MUST
>>>     appear in the Normative References section.  The reference MUST
>>>     correspond to the specific module version actually used within the
>>>     specification.
>>
>> I agree with Kent's "hold for document update" assessment.  The
>> difficultly with the existing text is that it correctly reflects
>> the concerns that were at the forefront when it was written -
>> e.g. making it as easy as possible for developers to get the
>> necessary context for implementing a module, but, as far as
>> I can recall, the group hadn't thought as deeply about
>> registries spun off from an initial document.
>>
>>> Want to take a swing at it?
>>
>> Not me.  :-)  There are competing requirements, and the "best" answer
>> will very much depend on each situation.  I think the *spirit* of
>> the RFC 8407 Section 3.9 is  "point to whatever resource will be most
>> enlightening to the developer / user."  But the letter of the law is
>> "point to whatever is needed to generate a tree of normative
>> reference dependencies" - that is, use what will be most helpful
>> to the people writing the standards.  There's a point to both kinds of
>> pointers.
>>
>> When in doubt, my preference is to go whichever way will make it
>> harder for implementations to get it wrong.
> Agree on the principles, but there is no quick fix.
> Look at Med's proposal:
> 
>         If an IANA-maintained module is imported by another module, a
>         normative reference with the IANA URL from where to retrieve the
>         IANA-maintained module SHOULD be included.  Although not encouraged,
>         referencing the RFC that defines the initial version of the IANA
>         module is acceptable in specific cases (e.g., the imported version is
>         specifically the initial version, the RFC includes useful description
>         about the usage of the module).
> 
> If we want to add an IANA link to update RFC 8407, Section 3.9, a couple 
> of remarks:
> - It's not clear what "a normative reference with the IANA URL" is.
>      Is it 
> https://www.iana.org/assignments/yang-parameters/yang-parameters.xhtml?
>      Or is it 
> https://www.iana.org/assignments/yang-parameters/iana-if-type@2022-08-24.yang?
>      The more precise the later, right?
>      However, the latter, which is a typical example of IANA maintained 
> YANG module does NOT work, as the revision in the URL changes with any 
> IAN update
> - So this leads to have both RFC and IANA, so 
> https://www.iana.org/assignments/yang-parameters/yang-parameters.xhtml + 
> RFC7224 (in the above example)
> - Also, we should make more generic for some other SDOs, as IANA is for 
> IETF only.
>    And the guidelines are followed by others: BBF, IEEE, etc.
> 
> Regards, Benoit
>>
>> Randy
>>
>> _______________________________________________
>> netmod mailing list
>> netmod@ietf.org
>> https://www.ietf.org/mailman/listinfo/netmod
>