[netmod] FW: Where can I use <CODE BEGINS> <CODE ENDS> ?

Balázs Lengyel <balazs.lengyel@ericsson.com> Tue, 24 March 2020 15:33 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 1AB0C3A0C16 for <netmod@ietfa.amsl.com>; Tue, 24 Mar 2020 08:33:51 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.101
X-Spam-Level:
X-Spam-Status: No, score=-2.101 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, DKIM_VALID_EF=-0.1, SPF_PASS=-0.001, URIBL_BLOCKED=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 j_MyoCLQtlMA for <netmod@ietfa.amsl.com>; Tue, 24 Mar 2020 08:33:48 -0700 (PDT)
Received: from EUR05-DB8-obe.outbound.protection.outlook.com (mail-db8eur05on2050.outbound.protection.outlook.com [40.107.20.50]) (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 D65843A0BF7 for <netmod@ietf.org>; Tue, 24 Mar 2020 08:33:47 -0700 (PDT)
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=T0Mq/PHkZOt1q0BUkm+8L59a7XVjSto89pcv+YFwsBQxt8pjGxLDbt6HX9HboCgDkXrW1Ups4Ws4pwiv/9+3iwtWvXrdbXriKD/VZIadwUf9eUa79ySPMFWbEuuObgU+s/y/C8SKuJCpHcjNJqZRdNO7KzbC9CYQNQBeWbxt3WxNKhtpglfs8GiEviCmk1hTytnS9UUalK4r+G4KeqO7NYGgvEC4C85zLvsfDQ7jjpZ+peiaT1O+xJlhkIcYMgw5nhVEeKTLj85ZzHK/jiw4yE4AWtm/HkmFbUH8DBaRoKTBSLjwYz5xaCt5ezORqPrHPbt5LBnBhxO7tsKR3Fcghg==
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=Zhyi3zp4mTgciyjra4KsyssFqzIOWPyRUEEng1REbhs=; b=IOyZVO7VDMj9/mXwS5MHZuLUSx5i6V/ryz2pv+gFHuPJQs2DZACuH639HCEVZnWRpqWNW3UlXXwntUN5XRJGacp1izzYylKewQjeNUcEZ2RynUj8WE2cwv98swjvmkARjTaSFt1GM7PhOuVGd4kQnkjhKpKyCuqGe1Nwmmgujg4hZn+406rwd2AiDAyUq532iDy8m1amwFLQ+i4xzzirsIeFT89UhbX+uxUCEIIjI7QVNRefSHQP6hVgk+HlIdtAIv6w+4cdSsJLXEUmN9LBCh30QYwbab1qWHzUaOL7uQik3Hyt7x4YyXz+sVRHurhaUjstyhc8c8dDZfVZJEs2lg==
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=Zhyi3zp4mTgciyjra4KsyssFqzIOWPyRUEEng1REbhs=; b=TE78ZmdMuh2Twm/wwK5MRt26jiBQoNKDVMLAqBOM+qPGGHSse5mgPniTb2bal/OZjUCXiu3Cqtgd7eN5+vdbPgX8vSi/lInzoWjD2ymhYAIHsuG9l4sdD/F/YkOXnl4iGyMNCDpoUbma+STIzHXMvOtdlbpU9gyou4b6RyUY9mo=
Received: from DB7PR07MB4011.eurprd07.prod.outlook.com (52.134.97.155) by DB7PR07MB5497.eurprd07.prod.outlook.com (20.178.46.156) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2856.8; Tue, 24 Mar 2020 15:33:45 +0000
Received: from DB7PR07MB4011.eurprd07.prod.outlook.com ([fe80::15cf:dc81:c6f4:aa0c]) by DB7PR07MB4011.eurprd07.prod.outlook.com ([fe80::15cf:dc81:c6f4:aa0c%7]) with mapi id 15.20.2856.015; Tue, 24 Mar 2020 15:33:45 +0000
From: =?utf-8?B?QmFsw6F6cyBMZW5neWVs?= <balazs.lengyel@ericsson.com>
To: "'netmod@ietf.org'" <netmod@ietf.org>
Thread-Topic: Where can I use <CODE BEGINS> <CODE ENDS> ?
Thread-Index: AdX/lKIsLy+ziTKqRA+fZO9j7aQG7ACWDxGAAAAySNA=
Date: Tue, 24 Mar 2020 15:33:45 +0000
Message-ID: <DB7PR07MB40115DC070AD529CB9CFB69FF0F10@DB7PR07MB4011.eurprd07.prod.outlook.com>
References: <DB7PR07MB4011310A5327543D14FD9C19F0F20@DB7PR07MB4011.eurprd07.prod.outlook.com> <DA8180AD-7DDC-45DE-9733-A7AAFB6A2781@amsl.com>
In-Reply-To: <DA8180AD-7DDC-45DE-9733-A7AAFB6A2781@amsl.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: [80.98.254.17]
x-ms-publictraffictype: Email
x-ms-office365-filtering-correlation-id: 3a1e5fda-a713-4cfd-93d2-08d7d008bd62
x-ms-traffictypediagnostic: DB7PR07MB5497:
x-microsoft-antispam-prvs: <DB7PR07MB549727FF837A81212B244FD0F0F10@DB7PR07MB5497.eurprd07.prod.outlook.com>
x-ms-oob-tlc-oobclassifiers: OLM:9508;
x-forefront-prvs: 03524FBD26
x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(4636009)(136003)(396003)(346002)(366004)(39860400002)(376002)(86362001)(966005)(2906002)(5660300002)(71200400001)(85182001)(478600001)(6916009)(33656002)(66946007)(26005)(186003)(66616009)(66476007)(8676002)(76116006)(8936002)(7696005)(316002)(9686003)(66446008)(66556008)(64756008)(81166006)(55016002)(52536014)(6506007)(53546011)(85202003)(81156014)(491001); DIR:OUT; SFP:1101; SCL:1; SRVR:DB7PR07MB5497; H:DB7PR07MB4011.eurprd07.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords;
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: k6WYSd7AsEJCbLuZecYePurNrXRExelZ0kl5wR4Fzf7NnS5dUdkm/D2y47fYVFUugMKPZjpFehxzARf+8S/hIbXTG6SNmFEzwEbJXkjXWQGqladEl9D3o2hXnW6sL3rRY8k4BB6n6GO2H+EfUVIWIlaGFQK0xv1N+HW1LdvcYlN3IgOG43+UJCUS11u+0Fd1nsw+d1TGfuBUBMjxH8pDOEMW+XOI6/ST8zH9unAK6KrOQSLmOFKvDCn7nua1tJDSDqNiAbquPHMWYChyu5pnXbvHkhyvzEnXSV7S06sst0QqFgxhcrVphmB0GJCvUwlSiFzaAbNU19vklRxOjpjwe0fAZvTdzAHe7R9fzSOeuz1V3XZe3dmxjtV1hdL1COPmxvPmqrzkxkDhIvxpvMdM6c4aTRqjb3mXdOqgPgLqrqpGApTrQZ09Tf/14ofjlrL9Kz2PwbzbxiGT4+8LWLcPPePZjNVVMk4AJ1ZBjXFuiNdFnW8L5a9CLa6fiLKx1AZYS5olEqSBHjtJ6SK26VYDZwNh1xVy/VcVqhNJSXA74xptFzi+d9VTcBc6vfOzYI36
x-ms-exchange-antispam-messagedata: vIDQ/L3unw6YiFs2QGtmuxBg6B797QanDdmWc81+yWVIaOQWLDbfyqf82uXcbMceLS9qnEBSREkZw6/jAAlONw92/lUk52o11263emwMArb6rIlud4I70vNCDNAonSb/RmgP7ojKNp6iQvW8XpKPaQ==
x-ms-exchange-transport-forked: True
Content-Type: multipart/signed; protocol="application/x-pkcs7-signature"; micalg=SHA1; boundary="----=_NextPart_000_02F4_01D601F9.FB5BCBF0"
MIME-Version: 1.0
X-OriginatorOrg: ericsson.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 3a1e5fda-a713-4cfd-93d2-08d7d008bd62
X-MS-Exchange-CrossTenant-originalarrivaltime: 24 Mar 2020 15:33:45.1094 (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: eJKpLhSrUDGsJ5jukZe7Klfu5tg16o3nqKoY3vHYNpSFe8PXRp21iktH6EkiyqDhkvHnWeC8L87OsK0Ap7VYu26fdNKk2p5xqnd/cRYweqU=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB7PR07MB5497
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/Gdrg5w_oiVBcBJkuLucLyE0CNi4>
Subject: [netmod] FW: Where can I use <CODE BEGINS> <CODE ENDS> ?
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, 24 Mar 2020 15:33:52 -0000

Hello,
A reply from the rfc-editor on <CODE BEGINS>. It seems it is OK.
Regards Balazs

-----Original Message-----
From: Alice Russo <arusso@amsl.com> 
Sent: 2020. március 24., kedd 16:00
To: Balázs Lengyel <balazs.lengyel@ericsson.com>
Cc: RFC Editor <rfc-editor@rfc-editor.org>
Subject: Re: Where can I use <CODE BEGINS> <CODE ENDS> ?

Greetings,

Please see below.

> On Mar 21, 2020, at 8:30 AM, Balázs Lengyel <balazs.lengyel@ericsson.com> wrote:
> 
> Hello,
> Sorry if I am sending this question to the wrong person. 
> We have a discussion in the NETMOD workgroup about when is it appropriate/allowed to use the <CODE BEGINS> <CODE ENDS> markings in drafts and RFCs.
> We regularly use it to bracket the YANG modules defined. 
> e.g.    <CODE BEGINS> file "ietf-yang-instance-data@2020-03-19.yang" 
> 

Just FYI, if you are using the new XML vocabulary [1], the markers can be created automatically by using markers="true"
-- for example --
<sourcecode name="ietf-yang-instance-data@2020-03-19.yang" type="yang" markers="true">

> However is it allowed to use it to bracket XML or json examples in drafts/rfcs? 
> e.g.    <CODE BEGINS> file read-only-acm-rules@2020-03-19.xml

Yes, it is allowed. The markers <CODE BEGINS> and <CODE ENDS> are mentioned in the Trust Legal Provisions [2].

[1] https://www.rfc-editor.org/materials/FAQ-xml2rfcv3.html
[2] https://trustee.ietf.org/license-info/IETF-TLP-5.htm (item 4d)

Thank you.
RFC Editor/ar

> 
> It is very handy that the rfcstrip tool can extract the CODE sections from a draft which facilitates checking these by external tools like yanglint. The checking is needed both for the YANG modules and the examples.
> If you as an rfc-editor could give guidance on the issue it would be appreciated. I attached a planned draft.
> Best regards Balazs Lengyel 
> 
> -- 
> Balazs Lengyel                    Senior Specialist                       Ericsson Hungary Ltd. 
> Mobile: +36-70-330-7909              email: Balazs.Lengyel@ericsson.com
> 
> <draft-ietf-netmod-yang-instance-file-format-11.txt>