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

Balázs Lengyel <balazs.lengyel@ericsson.com> Wed, 18 December 2019 14:08 UTC

Return-Path: <balazs.lengyel@ericsson.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 D1134120052 for <netmod@ietfa.amsl.com>; Wed, 18 Dec 2019 06:08:10 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.001
X-Spam-Level:
X-Spam-Status: No, score=-2.001 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=ericsson.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 IXUNAWS_OVxO for <netmod@ietfa.amsl.com>; Wed, 18 Dec 2019 06:08:08 -0800 (PST)
Received: from EUR03-VE1-obe.outbound.protection.outlook.com (mail-eopbgr50077.outbound.protection.outlook.com [40.107.5.77]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 3792812004C for <netmod@ietf.org>; Wed, 18 Dec 2019 06:08:08 -0800 (PST)
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=nafbZAN8hsjE9vkX1DXzwzL/MPhv8ReVmvNDdvbe1Ot5sVxql0wfG/M/7ObQS3JKCFtvq4V7R5UkXhzptY+PDa900qSPIPkqWoUZuHhDApYYPc+XGEXp3cTTxNKwD9V4E0cCJ0fLoq17sLMEMefkX6+SVXVlXYe6xVTApafQhGOIpiZH+orQ/zgkO+GTveOczxTD3Pm8b/7v63/+E2cI1cuXuD2k7wUzLo5DqM9nNgu6l5JTyjVUSYqES9VcaR1V3SY/TIhAnyAVd+XuTRfCW6qlwY9Nv+RDly80SMR0vEun7BLRoV5VXhXxtLoWyD4xb37mqIzqwJvTJEsGnOA4aw==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=mLk1ogjv0s7hv435TRGhcF7NH6ns/byDxOS0YttrS34=; b=P8sE0p/b6ZJ8heW5KuY1UzoNHcABLjjDQkaq7Ul6g+CnHatiyA2Rg3KeZHXadaOA/uohmf6ViSYnO5URyh5MljWYUlYeV/kWuPpPR8/mM75IxXBmISwLm6nmOqxP0P2K0xL8kVu4i/vlh12YqD8d1EKKB1kWOMCueNafJKKWxJ4Ro73D45REJi/GUtuVxqEGXa9zmjr9SqlLRh0CihYTaTZuXvIElKN6uwh7dmccl8Z6K0hWiq06T++1FGJUGpCNmSgdwo7F/BeS/Q9TFHgEK+G+6XQQ5jUQT/2ytdhDfjdEFSqExWdCzfq2eYCxPPHDdh60FnAkkSoxjO11Xuz2ww==
ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=ericsson.com; dmarc=pass action=none header.from=ericsson.com; dkim=pass header.d=ericsson.com; arc=none
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ericsson.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=mLk1ogjv0s7hv435TRGhcF7NH6ns/byDxOS0YttrS34=; b=Jwb/8f1+h+5/VBkbA1Yme8AX0GQ3tkq5ALaJedN+U5eRhR0Aq1PAbzW9mm5FX5FGH50LiLt6DnUegFh+XsVlKU4oh9zZae9F/52Ajiy2pUf4v6wb1uE6Hk1+c0tRYg4GC4JSPutXzUrTsHzh8lCVuXOHE+Pni1gfejZzOmpvLCM=
Received: from AM0PR0702MB3665.eurprd07.prod.outlook.com (52.133.47.21) by AM0PR0702MB3650.eurprd07.prod.outlook.com (52.133.50.154) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2581.4; Wed, 18 Dec 2019 14:08:05 +0000
Received: from AM0PR0702MB3665.eurprd07.prod.outlook.com ([fe80::2469:3d61:7557:b60c]) by AM0PR0702MB3665.eurprd07.prod.outlook.com ([fe80::2469:3d61:7557:b60c%7]) with mapi id 15.20.2559.012; Wed, 18 Dec 2019 14:08:05 +0000
From: =?utf-8?B?QmFsw6F6cyBMZW5neWVs?= <balazs.lengyel@ericsson.com>
To: Mahesh Jethanandani <mjethanandani@gmail.com>, Kent Watsen <kent+ietf@watsen.net>, "'netmod@ietf.org'" <netmod@ietf.org>
Thread-Topic: Text in import to indicate whether a module is needed as import-only or as implemented
Thread-Index: AdW1rIivNNF/ygLlRsqN7vYQ6ujj8w==
Date: Wed, 18 Dec 2019 14:08:04 +0000
Message-ID: <AM0PR0702MB36654D2907FBCC620AD179F7F0530@AM0PR0702MB3665.eurprd07.prod.outlook.com>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach: yes
X-MS-TNEF-Correlator:
authentication-results: spf=none (sender IP is ) smtp.mailfrom=balazs.lengyel@ericsson.com;
x-originating-ip: [89.135.192.225]
x-ms-publictraffictype: Email
x-ms-office365-filtering-correlation-id: 5f85747c-91cc-4124-b7ad-08d783c3b3c0
x-ms-traffictypediagnostic: AM0PR0702MB3650:
x-microsoft-antispam-prvs: <AM0PR0702MB3650B21150A07D89B1F68AB4F0530@AM0PR0702MB3650.eurprd07.prod.outlook.com>
x-ms-oob-tlc-oobclassifiers: OLM:2201;
x-forefront-prvs: 0255DF69B9
x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(4636009)(396003)(376002)(39860400002)(136003)(366004)(346002)(189003)(199004)(316002)(186003)(8936002)(71200400001)(7696005)(76116006)(53546011)(6506007)(110136005)(478600001)(66946007)(66574012)(64756008)(85182001)(66616009)(66476007)(66446008)(9326002)(66556008)(55016002)(2906002)(26005)(86362001)(52536014)(33656002)(9686003)(81156014)(81166006)(85202003)(8676002)(5660300002)(491001); DIR:OUT; SFP:1101; SCL:1; SRVR:AM0PR0702MB3650; H:AM0PR0702MB3665.eurprd07.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; MX:1; A:1;
received-spf: None (protection.outlook.com: ericsson.com does not designate permitted sender hosts)
x-ms-exchange-senderadcheck: 1
x-microsoft-antispam: BCL:0;
x-microsoft-antispam-message-info: 5DL1rmPXGci4MvFXWhzG3M65sf4p/357l0Jtx7c816wAUdRi87xrUX3p3TZ+qeOaK0xqslq7oxJeXlhvXSWktdADkE74HWjzO6MV77e28rwZZbWz0f727r/w+MiLm+flQ5AEVzKk8jGk15tR8GTlOp5LeyterH8VbOmB3w8TTIQp7rvOgnZTdeytUVtyw1oFIrqhWyetPTSRPSmWc3qA+48p7Yh6ZRJrjo2Y++bHls+SEBNN9tmwmy9ru+W34ugaAwJ03Po1lbA3aR1l8xZ+MEcHIXjuZI6Um46zk5WE8UgqjyN42x4SJpiCOmhDtxlKWvCY27GabU+RgfPsbFRbsocAhebojFkGu5nFiSVk4xhfAFCdENboZeasrDn0SZw5x5MfhO2Ms//CqIYZCzc6y7roXqHEo6kAnNUvRtaCq1iFgTHZPKDtlHI5ezC+/Vf1OdI0cxicnxHKsxDETkNltq955nhuQz4BhwDHr3CrhoY=
x-ms-exchange-transport-forked: True
Content-Type: multipart/signed; protocol="application/x-pkcs7-signature"; micalg=SHA1; boundary="----=_NextPart_000_001D_01D5B5B4.F1FA4870"
MIME-Version: 1.0
X-OriginatorOrg: ericsson.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 5f85747c-91cc-4124-b7ad-08d783c3b3c0
X-MS-Exchange-CrossTenant-originalarrivaltime: 18 Dec 2019 14:08:05.0379 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 92e84ceb-fbfd-47ab-be52-080c6b87953f
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: UusAwPcAb1OzQ54Aiplj+Kivi2ty0oRdnIZKaHfnP+2CglIsyfD7iKVpY6Qn2gpTfN/vyMl4GKVAWWt4RpGSsa5PBiqhDIJaKntbK1Ju9ns=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM0PR0702MB3650
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/is9Zrj7moWb9BbRwSlEUxqCYqWA>
Subject: [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 14:08:11 -0000

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.

 

 

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 <mailto:mjethanandani@gmail.com>