Re: [Rfc-markdown] [netmod] too long lines from IANA module inclusion

Carsten Bormann <cabo@tzi.org> Fri, 17 December 2021 15:38 UTC

Return-Path: <cabo@tzi.org>
X-Original-To: rfc-markdown@ietfa.amsl.com
Delivered-To: rfc-markdown@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id CEAF53A11D7; Fri, 17 Dec 2021 07:38:17 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Level:
X-Spam-Status: No, score=-1.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=unavailable autolearn_force=no
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 emVJplNw8vVl; Fri, 17 Dec 2021 07:38:12 -0800 (PST)
Received: from gabriel-smtp.zfn.uni-bremen.de (gabriel-smtp.zfn.uni-bremen.de [IPv6:2001:638:708:32::15]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id ABF693A11C8; Fri, 17 Dec 2021 07:38:12 -0800 (PST)
Received: from [192.168.217.118] (p5089a436.dip0.t-ipconnect.de [80.137.164.54]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by gabriel-smtp.zfn.uni-bremen.de (Postfix) with ESMTPSA id 4JFtRN1R40zDCcK; Fri, 17 Dec 2021 16:38:08 +0100 (CET)
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.7\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <0100017dc8e0fcbd-8899bb50-f0bf-4537-a87b-64eb82d9664a-000000@email.amazonses.com>
Date: Fri, 17 Dec 2021 16:38:07 +0100
Cc: Benoit Claise <benoit.claise=40huawei.com@dmarc.ietf.org>, "netmod@ietf.org" <netmod@ietf.org>, Michael Richardson <mcr+ietf@sandelman.ca>, Slavomír Mazúr <Slavomir.Mazur@pantheon.tech>, Miroslav Kováč <miroslav.kovac@pantheon.tech>, "Eric Vyncke (evyncke)" <evyncke@cisco.com>, rfc-markdown@ietf.org
X-Mao-Original-Outgoing-Id: 661448287.335117-3f16815271243274d5fbedd9031bd32a
Content-Transfer-Encoding: quoted-printable
Message-Id: <FB6407ED-BA9D-415A-AFCB-0D4D327679ED@tzi.org>
References: <43BBAD20-D816-4D01-8326-1D67185CCC19@tzi.org> <24856.1639347093@localhost> <0100017db6a106f8-a9773885-6347-4fd6-a2d6-69ec6941bc7b-000000@email.amazonses.com> <20211214.083324.1824911592330241723.id@4668.se> <3782772c-b5b4-4285-f65e-67b1113e1b07@huawei.com> <0100017dc8e0fcbd-8899bb50-f0bf-4537-a87b-64eb82d9664a-000000@email.amazonses.com>
To: Kent Watsen <kent@watsen.net>
X-Mailer: Apple Mail (2.3608.120.23.2.7)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/sOiQAUxjQFEud-Qy6JVv6QKiIws>
Subject: Re: [Rfc-markdown] [netmod] too long lines from IANA module inclusion
X-BeenThere: rfc-markdown@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "rfc-markdown is a discussion list for people writing I-Ds and RFCs in Markdown and the authors of the tools used for that." <rfc-markdown.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/rfc-markdown>, <mailto:rfc-markdown-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/rfc-markdown/>
List-Post: <mailto:rfc-markdown@ietf.org>
List-Help: <mailto:rfc-markdown-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/rfc-markdown>, <mailto:rfc-markdown-request@ietf.org?subject=subscribe>
X-List-Received-Date: Fri, 17 Dec 2021 15:38:18 -0000

Now you made me curious.
No RFCs use RFC 8792 encoding yet (except for RFC 8792 itself), as you said.

I-Ds:

  "Grant Negotiation and Authorization Protocol", Justin Richer, Aaron
  Parecki, Fabien Imbault, 2021-10-25, <draft-ietf-gnap-core-protocol-08.txt>

(Using this for JSON text.)

  "Problem Details for HTTP APIs", Mark Nottingham, Erik Wilde, Sanjay Dalal,
  2021-10-13, <draft-ietf-httpapi-rfc7807bis-01.txt>

(Using this for JSON text containing a json-schema.org description.)

  "HTTP Message Signatures", Annabelle Backman, Justin Richer, Manu Sporny,
  2021-08-13, <draft-ietf-httpbis-message-signatures-06.txt>

(Using this for examples of Signature-Input, Signature.)

  draft-ietf-netconf-crypto-types-21.txt, draft-ietf-netconf-http-client-server-08.txt, draft-ietf-netconf-https-notif-09.txt, draft-ietf-netconf-keystore-23.txt, draft-ietf-netconf-netconf-client-server-24.txt, draft-ietf-netconf-notification-capabilities-21.txt, draft-ietf-netconf-restconf-client-server-24.txt, draft-ietf-netconf-ssh-client-server-26.txt, draft-ietf-netconf-tls-client-server-26.txt, draft-ietf-netconf-trust-anchors-16.txt, draft-ietf-netmod-yang-instance-file-format-21.txt)

(Tons of netconf drafts, apparently using this mainly for XML examples — I didn’t check all of those.)

  "Conveying a Certificate Signing Request (CSR) in a Secure Zero Touch
  Provisioning (SZTP) Bootstrapping Request", Kent Watsen, Russ Housley, Sean
  Turner, 2021-12-03, <draft-ietf-netconf-sztp-csr-12.txt>

(As mentioned, for a YANG tree, HTTP requests, JSON text.)

  "A Layer 2 VPN Network YANG Model", samier barguil, Oscar de Dios, Mohamed
  Boucadair, Luis Munoz, 2021-11-22, <draft-ietf-opsawg-l2nm-12.txt>

(YANG JSON instances, again.)

  "A Layer 3 VPN Network YANG Model", samier barguil, Oscar de Dios, Mohamed
  Boucadair, Luis Munoz, Alejandro Aguado, 2021-10-08,
  <draft-ietf-opsawg-l3sm-l3nm-18.txt>

(Overly long HTTP requests.)

  "Structured Data for Filtered DNS", Dan Wing, Tirumaleswar Reddy.K, Neil
  Cook, Mohamed Boucadair, 2021-10-13,
  <draft-wing-dnsop-structured-dns-error-page-01.txt>

(JSON.)

  "List Pagination for YANG-driven Protocols", Kent Watsen, Qin WU, Olof
  Hagsand, Hongwei Li, Per Andersson, 2021-10-25,
  <draft-wwlh-netconf-list-pagination-00.txt>

  "NETCONF Extensions to Support List Pagination", Kent Watsen, Qin WU, Olof
  Hagsand, Hongwei Li, Per Andersson, 2021-10-25,
  <draft-wwlh-netconf-list-pagination-nc-02.txt>

  "RESTCONF Extensions to Support List Pagination", Kent Watsen, Qin WU, Olof
  Hagsand, Hongwei Li, Per Andersson, 2021-10-25,
  <draft-wwlh-netconf-list-pagination-rc-02.txt>

(HTTP requests, some XML.)

And, crucially for an implementer, no ‘\\’ wrapping, except (unnecessarily!) in draft-ietf-netconf-ssh-client-server-21.txt (apparently fixed in later versions.)

The form

   =============== NOTE: '\' line wrapping per RFC 8792 ================

(15 equals signs left, 16 equals signs right) seems to be the favorite lead-in; however, draft-wing-dnsop-structured-dns-error-page-01.txt had a version indented by 2 characters that has 14+15 accordingly.  About 5 % 10+11, apparently before RFC 8792 was published so there was less space.)

Examples from the HTTP ecosystem (GNAP, HTTPAPI, HTTPBIS) didn’t have any “===“ decoration, though.  (Why the heck was this left open as a choice for the author?  I like “%%%” decoration instead, should I use that as a personal fashion statement?)

Grüße, Carsten