[netmod] Typos and smaller issues (WAS Re: mbj review of draft-verdt-netmod-yang-module-versioning-01)
"Reshad Rahman (rrahman)" <rrahman@cisco.com> Fri, 27 March 2020 21:43 UTC
Return-Path: <rrahman@cisco.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 227893A0CE8 for <netmod@ietfa.amsl.com>; Fri, 27 Mar 2020 14:43:34 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -14.6
X-Spam-Level:
X-Spam-Status: No, score=-14.6 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_HI=-5, SPF_PASS=-0.001, URIBL_BLOCKED=0.001, USER_IN_DEF_DKIM_WL=-7.5] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=cisco.com header.b=iin15uz+; dkim=pass (1024-bit key) header.d=cisco.onmicrosoft.com header.b=K9G+ZTng
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 iQLvnssR_zSe for <netmod@ietfa.amsl.com>; Fri, 27 Mar 2020 14:43:32 -0700 (PDT)
Received: from alln-iport-2.cisco.com (alln-iport-2.cisco.com [173.37.142.89]) (using TLSv1.2 with cipher DHE-RSA-SEED-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id BAD483A0D45 for <netmod@ietf.org>; Fri, 27 Mar 2020 14:43:31 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=cisco.com; i=@cisco.com; l=10934; q=dns/txt; s=iport; t=1585345411; x=1586555011; h=from:to:subject:date:message-id:content-id: content-transfer-encoding:mime-version; bh=N7NOsq/yH0aL1hTIjVIGMZSpD670FkZoKu8xHqqRK68=; b=iin15uz+XJHn1fBdKU/ONId2+GJDB3DUHdFNfA1pdptKxR5GfT1CdDco ne5NlT5N0NkF2cUi3/u3fzLP5AwKBMeP+ok8qxdDJ0QZA/8AjdcUFVcc7 1FOwQfMZeOQFhnrEPqSTPe4P3IMNtj26N1fcN7bHBl2Q5a4xiVYWc6/J2 I=;
IronPort-PHdr: 9a23:12nzGRcEQGLXc8ogcusmQ3/klGMj4e+mNxMJ6pchl7NFe7ii+JKnJkHE+PFxlwGRD57D5adCjOzb++D7VGoM7IzJkUhKcYcEFnpnwd4TgxRmBceEDUPhK/u/dTYzHMFLUndu/mqwNg5eH8OtL1A=
X-IronPort-Anti-Spam-Filtered: true
X-IronPort-Anti-Spam-Result: A0AtCgAXc35e/40NJK1mHQEBAQkBEQUFAYF7gVRQBWxYIAQLKgqEEINFA4ppTpowgUKBEANUCgEBAQwBARgNCAIEAQGDf0UZghokOBMCAwEBCwEBBQEBAQIBBQRthVYMhXMFARAREQwBASwMEQEiAiYCBCULFRIEARIigwQBgksDLgEOohsCgTmIYnWBMoJ/AQEFhSYYggwDBoEOKowxGoFBP4ERJyCDC4JnAQECGoEvMSECglgygiyNfQEDgneGHZlMCoI8BIdbjy0dgkyURoRXjxSBUIdCkmgCBAIEBQIOAQEFgWkiKoEucBU7KgGCQVAYDY4dOIM7hRSFQXQCEIEXjGEBgQ8BAQ
X-IronPort-AV: E=Sophos;i="5.72,313,1580774400"; d="scan'208";a="469112648"
Received: from alln-core-8.cisco.com ([173.36.13.141]) by alln-iport-2.cisco.com with ESMTP/TLS/DHE-RSA-SEED-SHA; 27 Mar 2020 21:43:30 +0000
Received: from XCH-RCD-002.cisco.com (xch-rcd-002.cisco.com [173.37.102.12]) by alln-core-8.cisco.com (8.15.2/8.15.2) with ESMTPS id 02RLhUVT007677 (version=TLSv1.2 cipher=AES256-SHA bits=256 verify=FAIL); Fri, 27 Mar 2020 21:43:30 GMT
Received: from xhs-rtp-003.cisco.com (64.101.210.230) by XCH-RCD-002.cisco.com (173.37.102.12) with Microsoft SMTP Server (TLS) id 15.0.1497.2; Fri, 27 Mar 2020 16:43:30 -0500
Received: from xhs-aln-003.cisco.com (173.37.135.120) by xhs-rtp-003.cisco.com (64.101.210.230) with Microsoft SMTP Server (TLS) id 15.0.1497.2; Fri, 27 Mar 2020 17:43:29 -0400
Received: from NAM12-DM6-obe.outbound.protection.outlook.com (173.37.151.57) by xhs-aln-003.cisco.com (173.37.135.120) with Microsoft SMTP Server (TLS) id 15.0.1497.2 via Frontend Transport; Fri, 27 Mar 2020 16:43:29 -0500
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=WrRvlM8OKgWXLeXpYEIYcNH7LLdgJFJqByHRGMEqAx3Jv4jK9Z5aQXx8+uAIkSD/VMJyeMIubgydPnkfRMyFoWyck3Nerm31c/b2Zb59IWcyAC9O6Q2uc8LRGeHLvLbYuDUrbGvEYQP4Rh53qnfOfdUI5veN4CqjRJ/qHbJ9a+QAIJyn7LxB3JGzZtQ0heuc/AtNpkSIL/hcdluOY3OKFRdFjwHti0TVjU0UAAEhyUcY13qnIod1RbGZn9gw66Jx4+LuoiC8fBpScY4l2Z5F+vN8gGi+PTz/GfZrD9cz5OafFi/HQax6Waj1Vylgj3uH14YQK2wxIPI9henBwa0MVw==
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=N7NOsq/yH0aL1hTIjVIGMZSpD670FkZoKu8xHqqRK68=; b=lAal3M7xKzeUIEymShGbvN36CEDn+LFhjltBNEljG85Ccz/Skus+pPO020liY5pAUqPKgx3ptpqCUn6qqiGX0lURrkkXvVYCED8diV+q/DvlbwUNbXvJ/FvucLPx3hikpPwJIst6QKZtvf1iK+JipAcmcLiwgO+vTlM9A1npveEZifCj1rMtRoqZ/9xOTGz+rLA0yzHnP66X0+0apfR/3o4hpMI1k5Qd8Ooae1ic84beEqswPslxVo1FBIa/REZCIhkaFQqyBjA8zesgMaBbd2oHExJRQbpwXftwdDzEsuBGUFQslD0Y9y+Oqi9nWj9vgfTILz5haA//SBNEumAwGA==
ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=cisco.com; dmarc=pass action=none header.from=cisco.com; dkim=pass header.d=cisco.com; arc=none
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=cisco.onmicrosoft.com; s=selector2-cisco-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=N7NOsq/yH0aL1hTIjVIGMZSpD670FkZoKu8xHqqRK68=; b=K9G+ZTngqF7JL82UYXvzzcF5XHiCKImQ4gZ5EnhdEDDwiuAdUNgyNkO1YYUANEuORzYIIRWC4stbH3Z8BYjz7RJ/uE9eIlSGNd9ksfNUNKnGvk5XAp2d+MC6YBmQZhSB5Ogk7EvlGR3paxMXue5X4ko0GhUX08cQp+FMRi/Lx4I=
Received: from DM6PR11MB3420.namprd11.prod.outlook.com (2603:10b6:5:69::31) by DM6PR11MB3418.namprd11.prod.outlook.com (2603:10b6:5:6e::24) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2856.19; Fri, 27 Mar 2020 21:43:28 +0000
Received: from DM6PR11MB3420.namprd11.prod.outlook.com ([fe80::91cb:6555:db9b:53fa]) by DM6PR11MB3420.namprd11.prod.outlook.com ([fe80::91cb:6555:db9b:53fa%7]) with mapi id 15.20.2856.019; Fri, 27 Mar 2020 21:43:28 +0000
From: "Reshad Rahman (rrahman)" <rrahman@cisco.com>
To: Martin Björklund <mbj+ietf@4668.se>, "netmod@ietf.org" <netmod@ietf.org>
Thread-Topic: Typos and smaller issues (WAS Re: mbj review of draft-verdt-netmod-yang-module-versioning-01)
Thread-Index: AQHWBIDAiGUsiIO8iE2j9v3i5bRbXQ==
Date: Fri, 27 Mar 2020 21:43:28 +0000
Message-ID: <CB24C7AE-5F02-4B76-BA7C-B86096C15C35@cisco.com>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
user-agent: Microsoft-MacOutlook/10.21.0.200113
authentication-results: spf=none (sender IP is ) smtp.mailfrom=rrahman@cisco.com;
x-originating-ip: [70.31.50.95]
x-ms-publictraffictype: Email
x-ms-office365-filtering-correlation-id: 366c7a88-ca75-4275-0fa6-08d7d297e2d2
x-ms-traffictypediagnostic: DM6PR11MB3418:
x-microsoft-antispam-prvs: <DM6PR11MB34180738598F14A20F264406ABCC0@DM6PR11MB3418.namprd11.prod.outlook.com>
x-ms-oob-tlc-oobclassifiers: OLM:8273;
x-forefront-prvs: 0355F3A3AE
x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(4636009)(366004)(39860400002)(136003)(396003)(376002)(346002)(26005)(5660300002)(6486002)(110136005)(966005)(71200400001)(2616005)(66574012)(53546011)(33656002)(6512007)(2906002)(6506007)(86362001)(81156014)(66946007)(91956017)(8676002)(81166006)(76116006)(66476007)(64756008)(66556008)(8936002)(316002)(478600001)(186003)(36756003)(66446008); DIR:OUT; SFP:1101; SCL:1; SRVR:DM6PR11MB3418; H:DM6PR11MB3420.namprd11.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords;
received-spf: None (protection.outlook.com: cisco.com does not designate permitted sender hosts)
x-ms-exchange-senderadcheck: 1
x-microsoft-antispam: BCL:0;
x-microsoft-antispam-message-info: QwpjwEJPeVsOjlnmBfInNEcKLjZh76JUAR1xXUNX0wb5Ac4ga9GdqZu5vFWk8tGa2tcTuZeuAcSf6AcPbGys+KLrJ7oSbrWUy3lN4p59rm6vGMtQQGKBoOcjlqBTXQ8DPLMI6F0cwkGnjmV7CKeqSM4jXWTpqE2uQfPd1XFYBXo/kiQ46Hf0PAS9juT53rD8pdx0HZ58QwE87O26aHsCmePeWQfS78X/quqm2HmZhB8oJ9DxWfPKeVKR0wBYjA3G4ZLxngPDdswtdEVWV3nRvVkBu09so69/qoHX5SO4IH+AQ3SA7rptnKGbKmdsYOMdZ+w0X3/j7vS7LzmFnny1H/zTKL9fIT+Ze0N1hbkJ3OV8YL4euOYxaq12x0MlH2ovn9NQxCr4gIMTOnc+5V204xUi6px7m39y8BcktvXbgoUQ9FBoYwb0bak69oevLuj1vdQib6ay8KXvKd3XLbi0cu9yF4308+qcbSb/Dv6v13wBrCFrwpnKXPAO1ZfQ4wmQmhpza468C2VOZ+ykAakADQ==
x-ms-exchange-antispam-messagedata: B7e4kRPvWMJ3qy38pIIINypZEbgy041klkKbMmXSDzkVspiXWtkGxNRwLuJkeLuzB1U3Fpzo6KUp1mi8uhhGKxtEUAZID0WhjVy2uU//VitA6EKUM9H3P3eodN7JkZUVpBxAAiTiYFVXIWlybk9IXg==
x-ms-exchange-transport-forked: True
Content-Type: text/plain; charset="utf-8"
Content-ID: <7F0CB121685BDD429999732855F16D49@namprd11.prod.outlook.com>
Content-Transfer-Encoding: base64
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-Network-Message-Id: 366c7a88-ca75-4275-0fa6-08d7d297e2d2
X-MS-Exchange-CrossTenant-originalarrivaltime: 27 Mar 2020 21:43:28.2267 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 5ae1af62-9505-4097-a69a-c1553ef7840e
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: RXvySkQMrJ6LrVwARRjqS6D/s5mrK549Q6YHzlG0QE0cWWY+u7kGzvny6W0WKsa8pu+dF9JiOgFk3PToHAyonA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM6PR11MB3418
X-OriginatorOrg: cisco.com
X-Outbound-SMTP-Client: 173.37.102.12, xch-rcd-002.cisco.com
X-Outbound-Node: alln-core-8.cisco.com
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/ckiZ3ZOCGvO1tkXGzgz7mfnwvUc>
Subject: [netmod] Typos and smaller issues (WAS Re: mbj review of draft-verdt-netmod-yang-module-versioning-01)
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: Fri, 27 Mar 2020 21:43:43 -0000
Hi, https://github.com/netmod-wg/yang-ver-dt/issues/53 We'll make changes/fixes as per the comments below. All good. o 3.5 The example modules should be legal YANG modules. Use e.g. "urn:example:module" as namespace. Also, the modules are missing the last "}", which confuses the "rfcstrip" tool. o 4.1.1 Alternatively, the first example could have used the revision label "1.0.0" instead, which selects the same set of revisions/versions. import example-module { rev:revision-or-derived 1.0.0; } Shouldn't this be s/1.0.0/2.0.0/g ? o 5 I think the module name "ietf-yl-revisions" should be changed to "ietf-yang-library-revisions". "yl" is not a well-known acronym. o 7.1.1 There is a missing " in: 4. For status "obsolete", it is RECOMMENDED to keep the "status- description" information, from when the node had status "deprecated, which is still relevant. HERE -----------^ o 8 s/CODE ENDS>/<CODE ENDS>/ Regards, Reshad. On 2020-03-20, 5:08 PM, "netmod on behalf of Reshad Rahman (rrahman)" <netmod-bounces@ietf.org on behalf of rrahman=40cisco.com@dmarc.ietf.org> wrote: Hi Martin, We've opened issues to track your review comments (see below). Will kick off separate therads for each issue. https://github.com/netmod-wg/yang-ver-dt/issues?q=is%3Aissue+is%3Aopen+label%3Aupdated-mod-rev-handling Regards, Reshad. On 2020-03-10, 3:31 PM, "netmod on behalf of Martin Björklund" <netmod-bounces@ietf.org on behalf of mbj+ietf@4668.se> wrote: Hi, Here are my review comments of draft-verdt-netmod-yang-module-versioning-01. o 3.1.1 o In statements that have any data definition statements as substatements, those data definition substatements MAY be reordered, as long as they do not change the ordering or any "rpc" "input" substatements. I think this needs to capture that no descendant statements to "input" can be reordered. Same for "output" (note, "input" and "output" in both "rpc" and "action"). o 3.3 All revision labels that match the pattern for the "version" typedef in the ietf-yang-semver YANG module MUST be interpreted as YANG semantic version numbers. I don't think this is a good idea. Seems like a layer violation. What if my project use another dialect of semver, that wouldn't be possible with this rule. I think this needs to be removed. o 3.3 Submodules MUST NOT use revision label schemes that could be confused with the including module's revision label scheme. Hmm, how do I ensure that this MUST NOT is handled correctly? What exactly does "could be confused with" mean? o 3.3 In the filename of a YANG module, where it takes the form: module- or-submodule-name ['@' revision-label] ( '.yang' / '.yin' ) Should this section update 5.2 of RFC 7950? I know that 5.2 just says "SHOULD". But existing tools implement this SHOULD, and they need to be updated to handle this new convention. But I wonder if this a good idea. It means that a tool that looks for a module with a certain revision date cannot simply check the filenames, but need to parse all available modules (wijust to find the o 3.4 leaf imperial-temperature { type int64; units "degrees Fahrenheit"; status deprecated { rev:status-description "Imperial measurements are being phased out in favor of their metric equivalents. Use metric-temperature instead."; } description "Temperature in degrees Fahrenheit."; } I don't think rev:status-description is necessary / worth it. This can easily be written with the normal description statement instead: leaf imperial-temperature { type int64; units "degrees Fahrenheit"; status deprecated; description "Imperial measurements are being phased out in favor of their metric equivalents. Use metric-temperature instead. Temperature in degrees Fahrenheit."; } o 3.5 The example modules should be legal YANG modules. Use e.g. "urn:example:module" as namespace. Also, the modules are missing the last "}", which confuses the "rfcstrip" tool. o 4.1.1 Alternatively, the first example could have used the revision label "1.0.0" instead, which selects the same set of revisions/versions. import example-module { rev:revision-or-derived 1.0.0; } Shouldn't this be s/1.0.0/2.0.0/g ? o 5 I think the module name "ietf-yl-revisions" should be changed to "ietf-yang-library-revisions". "yl" is not a well-known acronym. o 5.2.2 Wouldn't it be better if the leaf "deprecated-nodes-implemented" and "obsolete-nodes-absent" were of type "boolean" rather than type "empty"? o 7.1 The text says: All IETF YANG modules MUST include revision-label statements for all newly published YANG modules, and all newly published revisions of existing YANG modules. The revision-label MUST take the form of a YANG semantic version number [I-D.verdt-netmod-yang-semver]. I strongly disagree with this new rule. IETF modules use a linear history, so there are no reasons to use "modified semver". It is ok to use rev:nbc-changes if needed, though. o 7.1.1 There is a missing " in: 4. For status "obsolete", it is RECOMMENDED to keep the "status- description" information, from when the node had status "deprecated, which is still relevant. HERE -----------^ o 8 s/CODE ENDS>/<CODE ENDS>/ o Both YANG modules All extensions should specify the grammar; i.e., in which statements they can be present and which substatements they can have. /martin _______________________________________________ netmod mailing list netmod@ietf.org https://www.ietf.org/mailman/listinfo/netmod _______________________________________________ netmod mailing list netmod@ietf.org https://www.ietf.org/mailman/listinfo/netmod
- [netmod] Typos and smaller issues (WAS Re: mbj re… Reshad Rahman (rrahman)