IETF Logo Mail Archive

[xml2rfc-dev] xml2rfc: use of <boilerplate> in preotool step

Julian Reschke <julian.reschke@gmx.de> Tue, 08 October 2019 04:37 UTC

Return-Path: <julian.reschke@gmx.de>
X-Original-To: xml2rfc-dev@ietfa.amsl.com
Delivered-To: xml2rfc-dev@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 4B901120143 for <xml2rfc-dev@ietfa.amsl.com>; Mon, 7 Oct 2019 21:37:57 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.598
X-Spam-Level:
X-Spam-Status: No, score=-2.598 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7, SPF_HELO_NONE=0.001, 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=gmx.net
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 Wv2CrhwGziuS for <xml2rfc-dev@ietfa.amsl.com>; Mon, 7 Oct 2019 21:37:54 -0700 (PDT)
Received: from mout.gmx.net (mout.gmx.net [212.227.17.21]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 06ADF12000F for <xml2rfc-dev@ietf.org>; Mon, 7 Oct 2019 21:37:53 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1570509470; bh=gJ+nXZpo3dYcqQEOudDt15TXNC1cDepCtX7OJwhKjec=; h=X-UI-Sender-Class:To:From:Subject:Date; b=h5kG4szXIP+RoaCEHSGbJJulaWAmT/uRVSocHsfdc7BWl6LaP8ZOTVOi8tP3bsGl6 70BHiC4Vi9kCOX5ZUwjyoWKL0X2T77Y+nuw2Nf+hGP9gDOjJicGCuKrRFRpBSzYnx4 6uF3SEWA3GwoCp8MnQV2ZEDXfGxkgdWjdk3sEv6o=
X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c
Received: from [192.168.178.124] ([84.171.144.80]) by mail.gmx.com (mrgmx104 [212.227.17.168]) with ESMTPSA (Nemesis) id 1M9Wuq-1iCBTO1Af6-005ZH4 for <xml2rfc-dev@ietf.org>; Tue, 08 Oct 2019 06:37:50 +0200
To: XML Developer List <xml2rfc-dev@ietf.org>
From: Julian Reschke <julian.reschke@gmx.de>
Message-ID: <bd47caef-fe97-f078-3c23-0744fa9154ce@gmx.de>
Date: Tue, 08 Oct 2019 06:37:47 +0200
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:60.0) Gecko/20100101 Thunderbird/60.9.0
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"; format="flowed"
Content-Language: en-US
Content-Transfer-Encoding: quoted-printable
X-Provags-ID: V03:K1:ygtCux+M7a4r+X7hUoccbLYYV+D5hNwUt8xigfGt1SH9J+2hK16 XnUga0jEjdzC40f6wLnexVtZqSodJgecPPXiGiQQ7ILCcw1o37uSHrS1tnLwnYI0iN8oQTD cH144bhBwQPFr0iJG2lZU+DTizFTT3ZLr1XiG36bqQNxe2wF8es3hE+qL5oQIVqfQyzQuXh p0b7zdLrGshM75yjtkjww==
X-UI-Out-Filterresults: notjunk:1;V03:K0:NTJ/LLpS85g=:iD3pfKLVV+riSRJmLStb+z wHOqALXCtRUDKSDFcS2D3ojQrfFgBxMO/FsFbi4X16kdF5MkBAtmEjDjH/9iiY4SQ/2JiErwL bDdpsEs4FJpLaJk67F8JoA0ODpaE9vqgDjvgfAgoUCPjD3JXxyIAi8/7VJsiWfsUDnsdBHezT QbV8mjJRsXqyasBrZLCznNDgOsxXaIgHl4n/1PfcSZRzcndCWgRwaxYA94IQA1Nwfb5SwxPHZ GYnntt0FHwZeCBaZVx8uaIeuvqrbEdPLbBmXIAd846JMqpWJtgkdE45h0dqS/F7tqGGmphhGK Hpd6qq4J9IR8GFyoJj4lmnioTmr6yK9Kv+0cosKuUK3isf3nx++oncNVAVNba06SQfZDcO1aL pyUz3RidwW646cBaDp5BPaWLX+zucVvKJMoBqo0P/4/tf2oT7/KSb2zmNjGZBEYwztXjbXf6X qJNOuI03yZ2Ty3ytL5iOinHOK0l1RgfGNUxs5z4zr8XwAGG58y72fsYptTSTObteF4z7843/M E49haCzL9uCv1J63MbyRheUNzPSnOFk8qjFLzQrA1P+W/EvaKYat/R9p8faazO7FD5whsMn7k zb+y2NbclA5BrZyrvsn8ruOQ6jj0UamnqXxQIa4vIGLcUJQlVErEEuZHgVAFBoqJqSR+lGNGR pDkSwKiFWhsCLy4vU9ZpusJwlCFA9Qt6vZbBA9lDcLWm+LHsXURfCm3ml0R2mlgZEyZyP185c eB0M4pCiidyu09eHZtHnelz0cvgpH36WL+uOy66H94af2A68SGHCNqaMo2+IBF16ITIteqjGK 9j+gf+UNhVPmV5U+vqYyDnHRIg00jn1d8W5r5RvdIZTGM5HwTswY/emSkgMw1yha8pW4ANUCO e4z9uTb1Pj56La93oO5pSQIGjKl6pjhMvZrptujJaKkEq0sw75xB2zDhaIJ2WJ+acKAgcUXZa Z/FaDR2NnVfkWvricnm4+Ea8tQ5dJFovLHKshKLw4ZNkvb3I3Y/n97N33b3gStCKrBs5bcQv/ xT8NWMwOQ/yCmoL2iI1cE2G5OvEpkjaN7ntDV023KY/havCD8hw5916+Neq/BofiO5TjQvNKT sIiXYX+aMs7nVSbsTQF2gg0sAneAGVTNV5qmNVeDykw2VqcSPHijk9rzgVPAmSBBj4+I44Ihw nudPJcfwboLWeN/4AwnsDHR3duf/cwAjCg6FeFvnvGLM/HxucrE1qWXGeVeD0VMrs+TouE7p2 6tMqVfoztGBmZXS4e6o6IdNFlA9gerHwoof7XTB0QLsPn0hayJrkfGpPUdMc=
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc-dev/AE-xnRHi092oBh0zqwL1rFpCWKc>
Subject: [xml2rfc-dev] xml2rfc: use of <boilerplate> in preotool step
X-BeenThere: xml2rfc-dev@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "Discussion about particulars of xml2rfc V3 design, development and code." <xml2rfc-dev.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/xml2rfc-dev>, <mailto:xml2rfc-dev-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/xml2rfc-dev/>
List-Post: <mailto:xml2rfc-dev@ietf.org>
List-Help: <mailto:xml2rfc-dev-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/xml2rfc-dev>, <mailto:xml2rfc-dev-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 08 Oct 2019 04:37:57 -0000

So xml2rfc, when running the preptool step, apparently puts the TOC
inside the <boilerplate> element.

This is problematic for a variety of reasons:

- it uses <boilerplate> for something it was designed for (which would
require changes to RFC 7991 and RFC 7998)
- it makes automatic checking of <boilerplate> harder
- it requires the @pn attribute to become a full-blown link target

As far as I can tell, none of this is currently documented.

Now, as far as I can tell, the reason for this change is entirely an
implementation detail now leaking into the grammar and the canonical
XML. Namely, that xml2rfc internally used the prepped output to embed
information for the rendering backends. This is of course absolutely ok,
but it shouldn't affect the canonical format, nor the semantics of
<boilerplate>.

Best regards, Julian

PS: raised as <https://trac.tools.ietf.org/tools/xml2rfc/trac/ticket/440>

v2.23.0 | Report a Bug | By Email