[netmod] IETF 108: Summary of insignificant whitespace changes and versioning

"Joe Clarke (jclarke)" <jclarke@cisco.com> Tue, 11 August 2020 13:41 UTC

Return-Path: <jclarke@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 BFBDF3A1082 for <netmod@ietfa.amsl.com>; Tue, 11 Aug 2020 06:41:27 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -9.598
X-Spam-Level:
X-Spam-Status: No, score=-9.598 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_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, 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=HRTlSovH; dkim=pass (1024-bit key) header.d=cisco.onmicrosoft.com header.b=GxqahyI6
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 4ly_ClGJymcZ for <netmod@ietfa.amsl.com>; Tue, 11 Aug 2020 06:41:26 -0700 (PDT)
Received: from rcdn-iport-1.cisco.com (rcdn-iport-1.cisco.com [173.37.86.72]) (using TLSv1.2 with cipher DHE-RSA-SEED-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 770593A1081 for <netmod@ietf.org>; Tue, 11 Aug 2020 06:41:26 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=cisco.com; i=@cisco.com; l=2086; q=dns/txt; s=iport; t=1597153286; x=1598362886; h=from:to:subject:date:message-id:content-id: content-transfer-encoding:mime-version; bh=Uejn2aKNBsSnba+5JDgYVlun2cxiXF2xx+aIiE++fU8=; b=HRTlSovHy9M5qWkv++VqyhC63ovB6vnIKvWSOU/pXfIjhN1DShDpYhtj x9wTQOhUPkpHwbQpkX/vbetSuD556wGudUuk76gq/CSNZ6AoHVsKzrb4L c3kcsT0JRVyz1VtnKhBdE67nzpEEQ0bl5c6XTnuiMcV0z8SzNrcUk11ao k=;
IronPort-PHdr: =?us-ascii?q?9a23=3Ad7UTch3e6WL6JZqSsmDT+zVfbzU7u7jyIg8e44?= =?us-ascii?q?YmjLQLaKm44pD+JxWGv6dsgUPHG4LB5KEMh+nXtvXmXmoNqdaEvWsZeZNBHx?= =?us-ascii?q?kClY0NngMmDcLEbC+zLPPjYyEgWsgXUlhj8iK6PFRbXsHkaA6arni79zVHHB?= =?us-ascii?q?L5OEJ8Lfj0HYiHicOx2qiy9pTfbh8OiiC6ZOZ5LQ69qkPascxFjA=3D=3D?=
X-IronPort-Anti-Spam-Filtered: true
X-IronPort-Anti-Spam-Result: =?us-ascii?q?A0DNCwBTnzJf/5FdJa1ggQmDHFEHgUc?= =?us-ascii?q?vLIQ2g0YDjS6ZC4JTA1ULAQEBDAEBLQIEAQGETBmCHgIkOBMCAwEBCwEBBQE?= =?us-ascii?q?BAQIBBgRthVwMhgoREQwBATgRASICFQEBDwIEMBUSBDIDgwSCTAMuAac6AoE?= =?us-ascii?q?5iGF2gTKDAQEBBYJKgkQYgg4JgQ4qgnGDX4ZAGoFBP4ERJwwQgh9sgQSDOFw?= =?us-ascii?q?Egjgzgi2Sf6MtCoJimhkDHqAVrg2DVgIEAgQFAg4BAQWBaiOBV3AVZQGCPj4?= =?us-ascii?q?SFwINjisMC4NOilZ0NwIGAQcBAQMJfJAKAQE?=
X-IronPort-AV: E=Sophos;i="5.75,461,1589241600"; d="scan'208";a="801118737"
Received: from rcdn-core-9.cisco.com ([173.37.93.145]) by rcdn-iport-1.cisco.com with ESMTP/TLS/DHE-RSA-SEED-SHA; 11 Aug 2020 13:41:25 +0000
Received: from XCH-RCD-003.cisco.com (xch-rcd-003.cisco.com [173.37.102.13]) by rcdn-core-9.cisco.com (8.15.2/8.15.2) with ESMTPS id 07BDfPbX014507 (version=TLSv1.2 cipher=AES256-SHA bits=256 verify=FAIL) for <netmod@ietf.org>; Tue, 11 Aug 2020 13:41:25 GMT
Received: from xhs-rcd-001.cisco.com (173.37.227.246) by XCH-RCD-003.cisco.com (173.37.102.13) with Microsoft SMTP Server (TLS) id 15.0.1497.2; Tue, 11 Aug 2020 08:41:25 -0500
Received: from xhs-aln-003.cisco.com (173.37.135.120) by xhs-rcd-001.cisco.com (173.37.227.246) with Microsoft SMTP Server (TLS) id 15.0.1497.2; Tue, 11 Aug 2020 08:41:24 -0500
Received: from NAM10-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; Tue, 11 Aug 2020 08:41:24 -0500
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=EgJPUG7769EtEZGQY9nqFLfy5KI7dko6eOmiEWTGTZHpLEWOFtK+29E3s3w6VcUqxx4LIAwXUJaXSoRspL74Fwwi9B6r3YZX3I0aPFSkDE/bwb3KNRGtcES2JHgfvmefc4dT9lnSJFr6PWc8WhDMaOmicF/hXJoSfofkGbxf68lG40AN6di2ppE7IWMf89gVa8H6DpZlDQd7qymBmXmYBSilGhbxPumhRN9Hlb3fgVG6SX257FW24gY8hli5BuWLCgMvXnDGFhv8CheOiclidKJVk2v2EurYNvuiaRre+yKzfYBhCahXTaZ8FqkhY1Uk3dTlbwSjYl1irTxNOB94Uw==
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=Uejn2aKNBsSnba+5JDgYVlun2cxiXF2xx+aIiE++fU8=; b=FmKVrf80yiqy2mzdoAW7ybYeyEB/4PnKb1urvDHWbydrZNBlUns7WVtYDx5nPqSo7h0tfaaXT74YNTg4XvsWWpok1y6EfehlcqqL/Odfl81G/sxBSCJUqQaKjA3wUKKcW2cqULswLq+ljPUTtIZOBMVlGgUWOFCnBYImJvXd6G+zazxmIFemAVo7OK1AtmKMusrgGv+MFd6HJGkCBR2QGvLuLWcOjCJIeQmFN5MRp4984fQHYcvRiYOmS72dWRVW8un3gz85LqrjFrw6njNJxQLtjaHaf/9nP7engwbZgz9UHlcaWTju8b1WE70Lxq+JO7jW8RfBh03iDQc0m1qOkw==
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=Uejn2aKNBsSnba+5JDgYVlun2cxiXF2xx+aIiE++fU8=; b=GxqahyI6xQLFkJw+yXYfzrJvPzIQygTH4TEyqbJZr2z3FDkJ/6u7Z5xerOHPIly9OexhxB0heXAPrsFXYaSe3cWn6k/JUTsZFU0JIG8K0W0RvMTBZcm5vUyFV4iiynmLo2IHFRlweN7XAMg80yPGJLCABo/dSzBp//grW3ls1ls=
Received: from BN6PR11MB1667.namprd11.prod.outlook.com (2603:10b6:405:e::12) by BN7PR11MB2819.namprd11.prod.outlook.com (2603:10b6:406:b4::19) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3283.15; Tue, 11 Aug 2020 13:41:23 +0000
Received: from BN6PR11MB1667.namprd11.prod.outlook.com ([fe80::c75:66f5:d072:746a]) by BN6PR11MB1667.namprd11.prod.outlook.com ([fe80::c75:66f5:d072:746a%12]) with mapi id 15.20.3261.025; Tue, 11 Aug 2020 13:41:23 +0000
From: "Joe Clarke (jclarke)" <jclarke@cisco.com>
To: NetMod WG <netmod@ietf.org>
Thread-Topic: IETF 108: Summary of insignificant whitespace changes and versioning
Thread-Index: AQHWb+UaDK+JsHSAhkmXSGM8cHEKIw==
Date: Tue, 11 Aug 2020 13:41:22 +0000
Message-ID: <5CF24083-4126-4BE0-93F1-9A36F6DE9296@cisco.com>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
x-mailer: Apple Mail (2.3608.120.23.2.1)
authentication-results: ietf.org; dkim=none (message not signed) header.d=none;ietf.org; dmarc=none action=none header.from=cisco.com;
x-originating-ip: [2001:7d0:8474:c380:745a:7834:4d7c:aaad]
x-ms-publictraffictype: Email
x-ms-office365-filtering-correlation-id: bf34473c-5696-4be7-d0d8-08d83dfc3ca8
x-ms-traffictypediagnostic: BN7PR11MB2819:
x-microsoft-antispam-prvs: <BN7PR11MB2819DBD348458C56C93F513BB8450@BN7PR11MB2819.namprd11.prod.outlook.com>
x-ms-oob-tlc-oobclassifiers: OLM:9508;
x-ms-exchange-senderadcheck: 1
x-microsoft-antispam: BCL:0;
x-microsoft-antispam-message-info: RFAltwL6LtxqgJWERMvAGl9HctGZmqrrZM8VBw3ltmi0bGaOMR1ZqJNskZFBW1qft1624wkCbRI7725et/9zioTQiuKUQVggjBQyVV/ovMbnamJo/zfgkakLDM1vgfPZOE4inz7I6YipjFuu65DPbiXuh68p8qC1YLhqA9BfkAC09GThYDFyi0gMnPDPs39zG+z2Q8kd8uFUOhoGl5B83qK5TmpHQ9m7VAyBhgFrlJiplsvMMogwgyhs8tKHLDHmherYfl0Uh2gzwSGltJOO/5IdaUnLr7/8l8zamBlJIf82BfDjlZmaq5eu8HfxjTW+/jLiuD13j7u+5tfjnlmjsg==
x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:BN6PR11MB1667.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(4636009)(136003)(366004)(376002)(346002)(39860400002)(396003)(91956017)(76116006)(2906002)(478600001)(66476007)(66946007)(66446008)(86362001)(5660300002)(66556008)(64756008)(6486002)(33656002)(71200400001)(6512007)(8676002)(8936002)(2616005)(36756003)(186003)(6916009)(316002)(6506007); DIR:OUT; SFP:1101;
x-ms-exchange-antispam-messagedata: 98DJVzZjpOasqrEFZyHcpgEjhxm7WEGzdFzFMQwrgPjT1OvTCd1A3dlZuDvbZHeJ3lXWngD0kY9kYdj2sBUykB66MDgEZ4Dn8vVPCJD2cMbs/CZf6/4KoXwleIZGAjP/mLCkJz570L2eVsVPf0BjZTzhibTXS59UUNNalZDoXCgMB6pxrx9fxSQXXKr3VC3jI+861uSL+GamWGnZmE5kCQ6bCvuV+RVjpLYjs25i1+kofwkj+INZHHNs8i+1qBxBg0xjz6YKakY8uN0GkLXiGLiBRGtzb0ZMwiHcEGPlexQtzNHRImF/tviIo3UhXT2LhyKws+sefCP3m2HpSgx70zCxjvoGFXkcb0pxQea7cIWqrLBIy6OhMqKP+Gag6lJxlh0+skl88v7I3uaDdziNX5kzB5XUzn5dQh5+sY58vJZ9Yxr8kU/0kdo0gIeSvA/sE+HNEkoBXt0cDbDlo1C+4iZoWHHdLYBcBwtpbLt0AJVPNmNOT0Q1zMFgxD6Q3ERZtIaxECT12AXVFwLalIu/WVjSvCJUyc4Jf+BEJ9EIL8l2kBBUYQkImr6S7t/VH2fa2aKvgG8DxXep8BXkWjEnblNhZAaKi2BWQEYViMeBIMiz8xldzIr9nFq2YOO73tTV5q9qDV2PmVy6LUb+GKACjNZhMlYzsqNiZDZRhUmbXQ1HHnrWXedtVjpSMYn6yFsHy0Tlq1T+KXMsEM9+WAC+sg==
x-ms-exchange-transport-forked: True
Content-Type: text/plain; charset="utf-8"
Content-ID: <E9068D78864B7F449DB5C15CAEDACA42@namprd11.prod.outlook.com>
Content-Transfer-Encoding: base64
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-AuthSource: BN6PR11MB1667.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: bf34473c-5696-4be7-d0d8-08d83dfc3ca8
X-MS-Exchange-CrossTenant-originalarrivaltime: 11 Aug 2020 13:41:23.0035 (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: 55D1CSJ6LV3gBZeG4qfWJYRy77RSlHCzkvp0zIcDpRQSYUr2jJXla243J/08bVkmQl7gpwcMgO28d/UNRe8fQA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN7PR11MB2819
X-OriginatorOrg: cisco.com
X-Outbound-SMTP-Client: 173.37.102.13, xch-rcd-003.cisco.com
X-Outbound-Node: rcdn-core-9.cisco.com
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/1OWNbTb1riSzRupBei-T9FQprzI>
Subject: [netmod] IETF 108: Summary of insignificant whitespace changes and versioning
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: Tue, 11 Aug 2020 13:41:28 -0000

At the IETF 108 virtual meeting, Lada asked about what would happen if he converted a YANG module to YIN syntax (or vice versa, or to some other format).  This was during the discussion of the issue of what should happen if a module changes and the only changes are insignificant whitespaces (e.g., strip trailing spaces, change line length of descriptions, etc.).

The authors/contributors discussed on this on our weekly calls, and we propose:

If a module changes and those changes are only insignificant whitespace changes and the syntax of the module remains the same (i.e., YANG to YANG, YIN, YIN, etc.), a new revision of the module MUST be created.  If you are using YANG semver as your revision scheme, you MUST apply a PATCH version bump to that new module revision to indicate an editorial change.

The reasoning behind this decision is that it makes it very clear and unambiguous to consumers that this module has been consciously changed, and those changes are only editorial.  This way one won’t be concerned if they note that a module of a given syntax with the same version but different checksums and diffs wasn’t otherwise manipulated.

That said, if a module changes format from one syntax to another but maintains semantic equivalency, then the revision and YANG semver MUST be the same.  In that case, one will use the extension to realize that this module file cannot be directly compared to one of another syntax without looking at compiled or semantic representation.

Thoughts?

Joe