Re: [tcpm] 793bis: references to 2119 keywords

Theodore V Faber <theodore.v.faber@aero.org> Fri, 27 July 2018 18:27 UTC

Return-Path: <prvs=739348bb1=theodore.v.faber@aero.org>
X-Original-To: tcpm@ietfa.amsl.com
Delivered-To: tcpm@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id BC5CE130EAB for <tcpm@ietfa.amsl.com>; Fri, 27 Jul 2018 11:27:07 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.91
X-Spam-Level:
X-Spam-Status: No, score=-1.91 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, T_DKIMWL_WL_MED=-0.01] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=neutral reason="invalid (public key: not available)" header.d=aero.org header.b=j80oHoGC; dkim=pass (1024-bit key) header.d=aerospacecloud.onmicrosoft.com header.b=KAIbfH9N
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 1MAbCk0rVsP9 for <tcpm@ietfa.amsl.com>; Fri, 27 Jul 2018 11:27:05 -0700 (PDT)
Received: from email3-east.aero.org (email3-east.aero.org [130.221.184.167]) (using TLSv1.2 with cipher RC4-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 78B38130E89 for <tcpm@ietf.org>; Fri, 27 Jul 2018 11:27:05 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=aero.org; i=@aero.org; q=dns/txt; s=mailhub; t=1532716025; x=1564252025; h=from:to:subject:date:message-id:references:in-reply-to: content-transfer-encoding:mime-version; bh=sh0AoPn93f1p4l29QEWYXP8vltEsEmkqshV8JGvUjxQ=; b=j80oHoGC1wnJ2ptVL9SwcR70wusTiohtKzaPNYGHszGLT/FXRXgL66/n 7tStwnxhsYb4tIJh5pBpfno4KlyjnhAhHJwNtVdL0o9jqZmuu0aadkbPc F0rfKHYVs8HYiQdWUhO41GDj4fprMfplj+38A26aHpwV+HCDw9xo1YUII U=;
x-SBRS: 3.5
x-SenderGroup: Inbound_Office365
X-IronPort-AV: E=McAfee;i="5900,7806,8967"; a="7224699"
X-IronPort-AV: E=Sophos;i="5.51,410,1526367600"; d="scan'208";a="7224699"
X-IPAS-Result: =?us-ascii?q?A2FhAwAbY1tbhzPGZxdYAxwBAQEEAQEKAQGCelGBUwMECyg?= =?us-ascii?q?KjFmLFHGBY5Z1Axg7CywCgSgBgxUCgx03FQECAQEBAQEBAgICEAEBAQgNCQgpI?= =?us-ascii?q?wELgzM4MgEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQUCODg?= =?us-ascii?q?BAQEBA0ABATgPAgEIEQQBAS8yHQgCBBMIgxiBaAMVAaMKAooFghyCdAEBBYQcG?= =?us-ascii?q?IMXCIl9gRyBEUaCTIR9Ah8mgmuCJIdVIYUDLYxnBwKQfocKhTSSDQIEAgQFAg0?= =?us-ascii?q?BAQWBV4F1TTCDLIIZGoNOilJvAYEVjSEBgRoBAQ?=
Received: from mail-dm2gcc01lp0051.outbound.protection.outlook.com (HELO GCC01-DM2-obe.outbound.protection.outlook.com) ([23.103.198.51]) by email3-east.aero.org with ESMTP/TLS/AES256-GCM-SHA384; 27 Jul 2018 11:27:03 -0700
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=aerospacecloud.onmicrosoft.com; s=selector1-aero-org; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=mvC4drxS7PH8UsAfuGJ+4C7Plg2WiGI6Kp7pOMam9+g=; b=KAIbfH9NLXqLTVtkkaqP7l0ZOl3XCyyUR8UKVcXuYYOLTEgjR8ti2y0ksQBURGufyDDakkgSFD1fKchYBoV3OmnFmTvlfieWVSSxIl/7DDv+EoyOCuK0eV3aKEdGMYKL0ejSlC5b+MgwnxfjX97dyhjBOH4zwYZ38InNTx9y4HQ=
Received: from DM5PR09MB1306.namprd09.prod.outlook.com (10.172.34.140) by DM5PR09MB1306.namprd09.prod.outlook.com (10.172.34.140) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.995.16; Fri, 27 Jul 2018 18:27:02 +0000
Received: from DM5PR09MB1306.namprd09.prod.outlook.com ([fe80::71e8:93fa:3890:ee1b]) by DM5PR09MB1306.namprd09.prod.outlook.com ([fe80::71e8:93fa:3890:ee1b%10]) with mapi id 15.20.0995.014; Fri, 27 Jul 2018 18:27:02 +0000
From: Theodore V Faber <theodore.v.faber@aero.org>
To: "tcpm@ietf.org" <tcpm@ietf.org>
Thread-Topic: [tcpm] 793bis: references to 2119 keywords
Thread-Index: AQHUJb3AZcvqtcaKeEKeVXTxXlQ6xqSjYuhI
Date: Fri, 27 Jul 2018 18:27:02 +0000
Message-ID: <DM5PR09MB130668C830C8A72856F47D5AB92A0@DM5PR09MB1306.namprd09.prod.outlook.com>
References: <fe6e2c39-fec1-30a8-7b25-1520e1cbd774@mti-systems.com>
In-Reply-To: <fe6e2c39-fec1-30a8-7b25-1520e1cbd774@mti-systems.com>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
authentication-results: spf=none (sender IP is ) smtp.mailfrom=theodore.v.faber@aero.org;
x-originating-ip: [130.221.224.7]
x-ms-publictraffictype: Email
x-microsoft-exchange-diagnostics: 1; DM5PR09MB1306; 6:0C0JSZeU6887JuA4hqQqCRkuePd2bZSg71UrCeGJy0CaVjqgjYmP78hu/2tgysNV/GDbyMhWJVC3WwfYGgJPxcgvhzBJdzWCOYP+AnaVZX7gN1o1VIQ/gu3ayBqoued968HSaq9fLu3oZoIowvReBzkM71FG1vZW0oOKAbIyNKMMQLmV2fsGCYNz5V/sQA6gDavlsKHRhXZfwVBh0MkyR0GSVysWkIu5WqteNzjwhiNC1n9AJJgqWJuOGXas9JwY97sFvnzA4hwLZJDMjrbTB0jordjLP/WHIX2H1upgS/MoqYDxIsQhdd9upZ6lR62yA/DrFUGzkHRiHhbtA+BryugN7K/Q+1IqbdFV+7hjaaexppANK+1/0/A+QP6nHk7nY/jIP14Nhpdlund4JDp645t6c5bFJObzY0soWqot+cmRVDh3ZLueNUv+UZQt8wzM8dLM6eIk+MdVC3xgkHwyLQ==; 5:ldsaUMUBDJmh82bvpi2k9xuH2un4Kl6GLotrrEG2yMJTZ7L2CJS2jOs9suSnauiBgKtu6tiSyiWDVIbZeQRHLHoptX7TvJqIYY071DtBYEh7g465YDnm0/+hni9u7B1wInYIhz46NyiyLCyORNgG55jO0QT2ckh+J8p+6lM3f9c=; 7:JeVcoHrIIG1Jh2GZgGSo1YiBZ0vrv5sMURU81z11/Xt0uFDa96BQk78dZubBE+Aoq7REU/s1obbvgBvTtQxF6oimJkyKuhJ/PA1nUUPiK+GnHtI8Cyihf+67WQeefCcFlyJYHrUA/rmWgepiCHPCF5HqQmpTrU95au9ObL9vyDjEiad61TJihOIt3nr2hKJOw8fGtJ/AOQrYnhLEpzFLFiBleKXxe9uLhsL/gcrLfGKtZ84A3e2zRNlyliFGwNCT
x-ms-exchange-antispam-srfa-diagnostics: SOS;
x-ms-office365-filtering-correlation-id: f17dcc51-aaa7-4d89-3d8d-08d5f3ee8c77
x-ms-office365-filtering-ht: Tenant
x-microsoft-antispam: BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989117)(5600074)(711020)(4618075)(4534165)(4627221)(201703031133081)(201702281549075)(8990107)(2017052603328)(7153060)(7193020); SRVR:DM5PR09MB1306;
x-ms-traffictypediagnostic: DM5PR09MB1306:
x-microsoft-antispam-prvs: <DM5PR09MB1306F3A419254EA64C4AAAE7B92A0@DM5PR09MB1306.namprd09.prod.outlook.com>
x-exchange-antispam-report-test: UriScan:(788757137089);
x-ms-exchange-senderadcheck: 1
x-exchange-antispam-report-cfa-test: BCL:0; PCL:0; RULEID:(6040522)(2401047)(8121501046)(5005006)(10201501046)(3002001)(93006095)(93001095)(3231311)(944501410)(52105095)(6055026)(149027)(150027)(6041310)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123558120)(20161123564045)(20161123560045)(20161123562045)(6072148)(201708071742011)(7699016); SRVR:DM5PR09MB1306; BCL:0; PCL:0; RULEID:; SRVR:DM5PR09MB1306;
x-forefront-prvs: 07467C4D33
x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(136003)(376002)(346002)(366004)(396003)(39860400002)(199004)(189003)(1730700003)(2906002)(97736004)(8676002)(68736007)(2900100001)(81156014)(5250100002)(2501003)(6116002)(74316002)(7736002)(3846002)(81166006)(305945005)(256004)(6246003)(14444005)(25786009)(5660300001)(561944003)(9686003)(86362001)(55016002)(102836004)(53546011)(33656002)(6506007)(53936002)(229853002)(14454004)(446003)(486006)(26005)(186003)(6436002)(11346002)(66066001)(476003)(5640700003)(478600001)(8936002)(105586002)(76176011)(7696005)(99286004)(106356001)(6916009)(316002)(2351001); DIR:OUT; SFP:1101; SCL:1; SRVR:DM5PR09MB1306; H:DM5PR09MB1306.namprd09.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1;
x-microsoft-antispam-message-info: WpT0paE7AYGU/wOeCJUxORy7jxUa5aQC0kTpdDKSiVi5elAQIWtVqX/vz/J+CZBEY/3RnrjiE7KuMksVPKRoI98bIbn38VQrYm7Yi2UWOm4Y4hJU0ODAgdPazlQ4eSUTGxSLt8CKxRkrerV5mrtR1MdduDk6btFopfe600bBSh0xyKJDduCCjGPzaGFP+wvMEDO9/3umxD+2LBEgswtgyke7uv98FMw2eujmHN0tmxgqAndLbS9HAElnVFOQEJkuzMPBDbeNsxfsA4XLh0Js5rQ6pyW98iocS0FqZT/dJ+5eveDfkUk4XE3+h9BDp8niaMIzIxRIPNkHO6ryOWrRKkIph/IAnGhBQ8e7tUMdSx8=
spamdiagnosticoutput: 1:99
spamdiagnosticmetadata: NSPM
Content-Type: text/plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-OriginatorOrg: aero.org
X-MS-Exchange-CrossTenant-Network-Message-Id: f17dcc51-aaa7-4d89-3d8d-08d5f3ee8c77
X-MS-Exchange-CrossTenant-originalarrivaltime: 27 Jul 2018 18:27:02.5465 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: c8294700-c5a4-4ca1-a876-1457d39899fd
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR09MB1306
Archived-At: <https://mailarchive.ietf.org/arch/msg/tcpm/jdbhYqqJLqL_BBaQJWAEZJX-gis>
Subject: Re: [tcpm] 793bis: references to 2119 keywords
X-BeenThere: tcpm@ietf.org
X-Mailman-Version: 2.1.27
Precedence: list
List-Id: TCP Maintenance and Minor Extensions Working Group <tcpm.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/tcpm>, <mailto:tcpm-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/tcpm/>
List-Post: <mailto:tcpm@ietf.org>
List-Help: <mailto:tcpm-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/tcpm>, <mailto:tcpm-request@ietf.org?subject=subscribe>
X-List-Received-Date: Fri, 27 Jul 2018 18:27:08 -0000

That seems like a sound idea to me.

I suggest using some abbreviation other than "ID" to avoid confusion with "I-D" (Internet-Draft).  "Marker", maybe?

--
Ted Faber <theodore.v.faber@aero.org>
Senior Engineering Specialist
Computer Systems Research Department
The Aerospace Corporation
310-336-7373


________________________________________
From: tcpm <tcpm-bounces@ietf.org> on behalf of Wesley Eddy <wes@mti-systems.com>
Sent: Friday, July 27, 2018 08:22
To: tcpm@ietf.org
Subject: [tcpm] 793bis: references to 2119 keywords

In the 793bis draft, some time ago we had included the appendix from 1122 that has a table of all the places where 2119 keywords are used (MUST/SHOULD/MAY/etc).

I'm now updating that so that it:
(1) points to the right section numbers or places within the current document rather than 1122
(2) contains references for requirements that came from other documents than 1122

There are a few challenges, and I have a proposal.

Instead of carrying forth exactly the prior format where the table looked like:

                                                  |        | | | |S| |
                                                  |        | | | |H| |F
                                                  |        | | | |O|M|o
                                                  |        | |S| |U|U|o
                                                  |        | |H| |L|S|t
                                                  |        |M|O| |D|T|n
                                                  |        |U|U|M| | |o
                                                  |        |S|L|A|N|N|t
                                                  |RFC1122 |T|D|Y|O|O|t
 FEATURE                                          |SECTION | | | |T|T|e
 -------------------------------------------------|--------|-|-|-|-|-|--
 Closing Connections                              |        | | | | | |
   Half-duplex close connections                  |4.2.2.13| | |x| | |



I'm suggesting to replace the "RFC1122 SECTION" column with one called something like "ID", and then adding an ID tag into the sentence where the requirement occurs, which winds up looking like:

                                                  |        | | | |S| |
                                                  |        | | | |H| |F
                                                  |        | | | |O|M|o
                                                  |        | |S| |U|U|o
                                                  |        | |H| |L|S|t
                                                  |        |M|O| |D|T|n
                                                  |        |U|U|M| | |o
                                                  |        |S|L|A|N|N|t
                                                  |        |T|D|Y|O|O|t
 FEATURE                                          |   ID   | | | |T|T|e
 -------------------------------------------------|--------|-|-|-|-|-|--
 Closing Connections                              |        | | | | | |
   Half-duplex close connections                  | MAY-1  | | |x| | |




And then searching the document for "MAY-1", you would find the sentence in section 3.5.1:

   A host MAY implement a "half-duplex" TCP close sequence, so that an
   application that has called CLOSE cannot continue to read data from
   the connection (MAY-1).

Subsequent statements would be labelled "MAY-2", "MAY-3", etc.

Before I do this for a large number of these, I thought it would be good to solicit feedback from the group. Does this seem like a good idea? Is it valuable? Given that XML2RFC "artwork" can't contain "xref" tags, it seems easier and less error prone than maintaining section number references in that table.