Re: [netmod] Text in import to indicate whether a module is needed as import-only or as implemented

Andy Bierman <andy@yumaworks.com> Wed, 18 December 2019 17:35 UTC

Return-Path: <andy@yumaworks.com>
X-Original-To: netmod@ietfa.amsl.com
Delivered-To: netmod@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id A13FF120A83 for <netmod@ietfa.amsl.com>; Wed, 18 Dec 2019 09:35:50 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Level:
X-Spam-Status: No, score=-1.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=yumaworks-com.20150623.gappssmtp.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 nsAF0xIniDxF for <netmod@ietfa.amsl.com>; Wed, 18 Dec 2019 09:35:48 -0800 (PST)
Received: from mail-lf1-x12d.google.com (mail-lf1-x12d.google.com [IPv6:2a00:1450:4864:20::12d]) (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 900C0120812 for <netmod@ietf.org>; Wed, 18 Dec 2019 09:35:47 -0800 (PST)
Received: by mail-lf1-x12d.google.com with SMTP id b15so2306345lfc.4 for <netmod@ietf.org>; Wed, 18 Dec 2019 09:35:47 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=yumaworks-com.20150623.gappssmtp.com; s=20150623; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=lBKerfIOWX57xeh+SwadqanAhHJ2Py0YFCbdQwYbHUE=; b=uZ/RRxZdLmsBGZDkr9hWim3zw48YQz3MXT7056+vtV0zRIsP4rx4J7uMp/FaqDo7iE cefBL8Zy8C3JKEibfez5LtJWXNV+DgAMmmJIugf1y4HYmqAbR2lcVDEyppkaSc+eTlWf UN3sB2/ERCeoow/F9VHFPDljV82jsNe4v3vp/F1HAMm6te31YhpB3pGMVFrmTyCdQSGK NhCB2q182nr+YAdc4pBhw1hoKmgHysQ5ce7+WSEz2+r+u4W1NcQJuXvaWhVw7FIJ9Z9n i7LF/SdZEZM/PdPnEHgIoHaKIfToZ9p2s2zGqMOYH/5fOo6yjSh8uJRw18op5mcmCAj+ 0kkw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=lBKerfIOWX57xeh+SwadqanAhHJ2Py0YFCbdQwYbHUE=; b=ROY0F08uxvCElP6ulVs0T04DrprFwTXtxKhghtxge813VKIZgRvzXM+APhV8ItNkgi t6OZUErVCrj2WDAaepbTbcoNf1YL4A/E7r00bBRkDFSLlab97d0curXtBytl5CYYfdBm wDsTLfvIplMxHQVA+2++TGPUsKEufIfYgTTskK3VojebF17hVfEvaYsFUEas2tnxayQE Z8+9y6A3z/bQ5KDBSRC5ZVnSlRx4GVDiODOfGWD7qwl9PEfFAxVcUdAWz8oXiJ47nb2Z piWuet6cYXlgWVZScZOEiDt3Fk88l/HviFOI3eluxRx9T6v8ZXEsFan410ZMxRcMXfyV j1Ig==
X-Gm-Message-State: APjAAAXnRM/eV8ceCiYZJY1XccCvEt8zkE+uvJTSOEpLsr27BEj66T/I ubMukdOwi6KFnSy5uOrN2MNc7omC3eoemsWsXZHLmQ==
X-Google-Smtp-Source: APXvYqyiaVTBNArTzS22RgXpjWezHP24xF961p8FE+kSRTqTfcp1Rx1uOFVUFLu9nLqDJlPqUI2bvff+ek7FiJdTGVc=
X-Received: by 2002:a19:4b55:: with SMTP id y82mr2490121lfa.171.1576690545787; Wed, 18 Dec 2019 09:35:45 -0800 (PST)
MIME-Version: 1.0
References: <AM0PR0702MB36654D2907FBCC620AD179F7F0530@AM0PR0702MB3665.eurprd07.prod.outlook.com>
In-Reply-To: <AM0PR0702MB36654D2907FBCC620AD179F7F0530@AM0PR0702MB3665.eurprd07.prod.outlook.com>
From: Andy Bierman <andy@yumaworks.com>
Date: Wed, 18 Dec 2019 09:35:34 -0800
Message-ID: <CABCOCHR_jEGDjSA_BhUWyLFB=4JJSFKqyT_3AHi91pfGFik-LQ@mail.gmail.com>
To: =?UTF-8?Q?Bal=C3=A1zs_Lengyel?= <balazs.lengyel=40ericsson.com@dmarc.ietf.org>
Cc: Mahesh Jethanandani <mjethanandani@gmail.com>, Kent Watsen <kent+ietf@watsen.net>, "netmod@ietf.org" <netmod@ietf.org>
Content-Type: multipart/alternative; boundary="000000000000e74b3d0599fddfdf"
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/qF2fYAZ-eD07Eninj43zfhu6GsU>
Subject: Re: [netmod] Text in import to indicate whether a module is needed as import-only or as implemented
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: NETMOD WG list <netmod.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/netmod>, <mailto:netmod-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/netmod/>
List-Post: <mailto:netmod@ietf.org>
List-Help: <mailto:netmod-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/netmod>, <mailto:netmod-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 18 Dec 2019 17:35:51 -0000

On Wed, Dec 18, 2019 at 6:08 AM Balázs Lengyel <balazs.lengyel=
40ericsson.com@dmarc.ietf.org> wrote:

> Hello Mahesh,
>
> I was asked by the group to include in each import statement whether the
> imported module is needed as import-only or as implemented. IMHO
> netmod/netconf group should agree on some standard text for model designers
> to use. Maybe the text proposed below can be used everywhere. The sentence
> starting with Revision yyyy-mm-dd  may not always be needed.
>
>
>
>
>
> I propose the text
>
>
>
>   import ietf-netconf-acm  {
>
>     prefix nacm;
>
>     description
>
> *       "The module ietf-netconf-acm is OPTIONAL to implement.";*
>
>   }
>
>
>
>   import ietf-yang-library {
>
>     prefix yanglib;
>
>     description *"The module ietf-yang-library is REQUIRED to*
>
> *      be implemented. Revision 2019-01-04 or a*
>
> *      revision derived from it is REQUIRED.";*
>
>   }
>
>
>
> Regards Balazs
>
>
>
> P.S. In Yang-Next this could be a candidate for a formal substatement
> instead of a description text.
>
>
>


IMO this is a bad idea.
The IETF keeps adding CLRs to YANG that make it harder to use over time.
The YANG syntax defines what must be implemented from the imported module,
so extra description-stmts just add more busy work for writers and
reviewers.
The text specifying the revision overrides (and breaks) YANG rules.
YANG 1.1 has specific import-by-revision that cannot be changed with a
description-stmt.

Andy



>
>
> *From:* Mahesh Jethanandani <mjethanandani@gmail.com>
> *Sent:* 2019. december 18., szerda 3:20
> *To:* Kent Watsen <kent+ietf@watsen.net>
> *Cc:* Balázs Lengyel <balazs.lengyel@ericsson.com>
> *Subject:* Re: [netconf] New Version Notification for
> draft-ietf-netconf-notification-capabilities-08.txt
>
>
>
> Hi Balazs,
>
>
>
> Additionally, it would be important to address some of the normative text
> in the module. Specifically, we were looking at the following description
> statements:
>
>
>
>   import ietf-yang-push    {
>
>     prefix yp;
>
>     description
>
>       "This module requires ietf-yang-push to be implemented for the
>
>         two subscription-capabilities containers.";
>
>   }
>
>   import ietf-yang-library {
>
>     prefix yanglib;
>
>     description "This module requires ietf-yang-library to
>
>       be implemented. Revision 2019-01-04 or a
>
>       revision derived from it is required.";
>
>   }
>
>
>
> The requirement in the description statement feels and smells like words
> one would use to signify requirements in a specification. However, you are
> not using any of the words like REQUIRED etc. to describe it. Why is it?
>
>
>
> Mahesh Jethanandani
>
> mjethanandani@gmail.com
>
>
>
>
>
>
> _______________________________________________
> netmod mailing list
> netmod@ietf.org
> https://www.ietf.org/mailman/listinfo/netmod
>