Re: [Rfc-markdown] Carsten: Re: [rfc-i] summary of Removing postal information from RFCs

Carsten Bormann <cabo@tzi.org> Tue, 20 July 2021 21:37 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 7D2833A334A; Tue, 20 Jul 2021 14:37:06 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.9
X-Spam-Level:
X-Spam-Status: No, score=-1.9 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham 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 ldl_drJomEsL; Tue, 20 Jul 2021 14:37:03 -0700 (PDT)
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 EB66E3A3349; Tue, 20 Jul 2021 14:37:02 -0700 (PDT)
Received: from smtpclient.apple (p548dcc89.dip0.t-ipconnect.de [84.141.204.137]) (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 4GTsVg0DnCz2xML; Tue, 20 Jul 2021 23:36:59 +0200 (CEST)
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 14.0 \(3654.100.0.2.22\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <BA4E84AD-22C2-470F-A41D-09942DF33B00@ietf.org>
Date: Tue, 20 Jul 2021 23:36:58 +0200
Cc: rfc-markdown@ietf.org, Michael Richardson <mcr+ietf@sandelman.ca>, Toerless Eckert <tte@cs.fau.de>
Content-Transfer-Encoding: quoted-printable
Message-Id: <E22C5330-FDD0-406A-865D-5D393CC78D26@tzi.org>
References: <20210712034838.B461E209AFFB@ary.qy> <6c781dab-7a40-7031-be1c-d77a182f4cf4@gmail.com> <DE0CD982-D4BE-44A6-9234-B53A756E9717@mnot.net> <bbb8302a-4041-35db-ce61-d2a18b8ebeee@taugh.com> <AB6E5013-C14E-4962-8907-17F241971F9D@tzi.org> <20210719171839.GB24216@faui48e.informatik.uni-erlangen.de> <DBCC4252-8A2D-473C-82CD-B1B2688586D3@tzi.org> <15571.1626787687@localhost> <65E34C78-8090-4534-8046-7E271B0ED07A@tzi.org> <BA4E84AD-22C2-470F-A41D-09942DF33B00@ietf.org>
To: Jay Daley <jay@ietf.org>
X-Mailer: Apple Mail (2.3654.100.0.2.22)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/B0Ns1FOnA7tBbtJJoFQ99clX14k>
Subject: Re: [Rfc-markdown] Carsten: Re: [rfc-i] summary of Removing postal information from RFCs
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: Tue, 20 Jul 2021 21:37:07 -0000

Hi Jay,


>> Any mistake I make there in kramdown-rfc leads to a show-stopper for an author, and that is exactly what kramdown-rfc is trying never to create.
> 
> I’m confused.  How is this different from the pre-v3 situation where kramdown-rfc was producing v2 and that could be rejected by xml2rfc if there was a mistake in it?

Beautiful question.

If this were steady-state situation, I could only point out that xml2rfcv1 was extremely permissive and xml2rfcv2 tried to accommodate as many of these idiosyncrasies as possible.  So writing for xml2rfcv2 was much easier to get right than for xml2rfcv3.

But that is the less interesting part of the answer.  The more interesting one is that kramdown-rfc was written at a time when RFCXML was pretty much stable.  Kramdown-rfc had a few years with a small number of users to get the bugs sorted out, including the bugs that only matter to the users.  Documents that can be processed with the 2012 version still process with the 2021 version.  That is an important characteristic that I think should be (and is!) maintained across the v2v3 transition.
Much of that transition is busywork — rewriting stuff to get the same functionality we already had.  Just with new risks.
Since xml2rfc already has a conversion mechanism that works incredibly well, it would have been less than bright not to use that mechanism instead of redoing all that work in kramdown-rfc.

Couple that with weird stuff like ascii attributes (23 of them) popping up on all kinds of elements with text content, or the rather broken content model of <li>, the <dl> regression etc. — this increases the busywork and also makes it more likely that v3 will again and again change in subtle ways to fix these rough patches.
It’s not that I didn’t start attempts to do wholesale conversions, but each time I did, I ran into one of these subtle things.  These have (mostly) been solved in --v2v3, so why not use that?

Much of the parts of v3 that aren’t just gratuitously different (or, “cleaned up”, depending on perspective) but provide new functions were easy to integrate.
Who ever uses these knows they will be get shot full of arrows (think “referencegroup”, or “svg”), so we can do some experimentation.

My objective with writing kramdown-rfc was to free myself from XML.
My objective with publishing it was to allow others to free themselves from XML.
But in both cases, we need to take co-authors with us that may not all be in “now I hate it every time I need to use XML again” territory yet.
Actually, many long-time RFC writers have serious Stockholm syndrome, and more than one collaboration that I tried to start didn’t work because of that.
So it is even more important not to create show-stoppers, because a single one of those can cause hostages to pack up and go back into the bank.

Grüße, Carsten