Re: [Tools-discuss] Why post text and not XML? (was: I-D statistics)

Eric Rescorla <ekr@rtfm.com> Sat, 16 March 2024 20:51 UTC

Return-Path: <ekr@rtfm.com>
X-Original-To: tools-discuss@ietfa.amsl.com
Delivered-To: tools-discuss@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 16A24C14F6F0 for <tools-discuss@ietfa.amsl.com>; Sat, 16 Mar 2024 13:51:28 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -6.906
X-Spam-Level:
X-Spam-Status: No, score=-6.906 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_HI=-5, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_NONE=0.001, T_SCC_BODY_TEXT_LINE=-0.01] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=rtfm-com.20230601.gappssmtp.com
Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id hPc8dI7y50xd for <tools-discuss@ietfa.amsl.com>; Sat, 16 Mar 2024 13:51:27 -0700 (PDT)
Received: from mail-yb1-xb2b.google.com (mail-yb1-xb2b.google.com [IPv6:2607:f8b0:4864:20::b2b]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 82AB8C14F603 for <tools-discuss@ietf.org>; Sat, 16 Mar 2024 13:51:27 -0700 (PDT)
Received: by mail-yb1-xb2b.google.com with SMTP id 3f1490d57ef6-dbed0710c74so2533290276.1 for <tools-discuss@ietf.org>; Sat, 16 Mar 2024 13:51:27 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rtfm-com.20230601.gappssmtp.com; s=20230601; t=1710622286; x=1711227086; darn=ietf.org; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc:subject:date:message-id:reply-to; bh=jLyEDUojdBWBSazqHy9vLzyKxFE8Jv6VXfHkyz1nvBw=; b=mDi0jxaAEaND1rHiZ2RBfnsFBOdjjw4mVnLGL1DR2nhQHd28gtWPDIpF3GFUwjnCgo oz5bLXbRmst4Nwr1slbsWOWLxY8AsutR8Ry8VLbRePwvY4Brlcpy7eyq1eHEn2DT+ki6 bKgQEBMbgZEuU2UDExMvrZA7z3nmEmqkysLxr5JQOglIXBykH03hfYCa6LD8ORK1MNCQ 5RduCJPMAinmgQ3zXMJ1P9m147OYwtUaBRr1oYTKj+JW1TChl18UvElJRI6laBOecHCh KqzvfHOQeHRAUo1rIhr96F73ofcQMP7MxdtosWGlx6Appnxd+ybkFaIsnyH3L47X0PM1 Prjg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1710622286; x=1711227086; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=jLyEDUojdBWBSazqHy9vLzyKxFE8Jv6VXfHkyz1nvBw=; b=j7nphGbzDsY3JzRh8WPQMm+6wuY3tmwEKgsnHReAmH+czo2/XWyNgGivRSJE+LbT88 fItItGfSzGbtP6w+fweu8MTeimh/ZU+QgZeBbHyh2ef+fpNVDvwr1JqGKGzX3z2mHVcT ukbnqvhMYoDt2MNvYMFaApFNwN/LdqnsC/E21jhQjXC6on7KegOQWBAfNBhgoLppnVyu dzySyDyF2WVlfxUyP8iGipTNS1IIOS9VvLkSAbmTPLZKp6sRbQmMjE9SNp0nPwXWcbK2 ksyGzGVYPlCG6/tsMiAWAl20/dEeNmOjWzuSn5RZJ9DNhOC+xdf2uza0J2QXWPF+Kl1C SgQA==
X-Forwarded-Encrypted: i=1; AJvYcCXPHJs7dFKJ5rjbnjGp787SLLbkBwUbShcpLa1Z+pUck3PWrtJGK0H6Kn1XGujHWulLwAX9Ua642kAPD0+LoX8aWebZJcj/
X-Gm-Message-State: AOJu0YzlsMHab0qSynw5wNULYVTqzTR/FRUTEDt9QWz+TKYSwunUYOYu NdrZOtH8ZD2xef0J8xUpLePMgviw+b8Gvm5gWtPBgO5u1fAPmBA/xY3LiOm8DaWZTpb9Sr6z4c7 2ugTgrJYQyvrfmvEY8nnh3CkCRbrKOGaQYYy4cApvkbM8U/Fp
X-Google-Smtp-Source: AGHT+IHmo7yix1x7rRfyIhl14w9M3T5Gehn5/A4ENH2eG5YDUIpf4IXhCxysubgqTOEUJ5C1ApgpzOB/hvavfSuT9SQ=
X-Received: by 2002:a25:9289:0:b0:dcc:f0a:e495 with SMTP id y9-20020a259289000000b00dcc0f0ae495mr4637069ybl.3.1710622286541; Sat, 16 Mar 2024 13:51:26 -0700 (PDT)
MIME-Version: 1.0
References: <1952067F-6467-4BEC-9CA5-BB8B16FA662B@tzi.org> <14807.1709682543@obiwan.sandelman.ca> <effb521c-1e20-cff8-acd3-17212a6b3fb9@gmail.com> <447A96F55A3D36851570B3B6@PSB> <60f18950-a2e0-16be-3a05-33f9a637062d@gmail.com>
In-Reply-To: <60f18950-a2e0-16be-3a05-33f9a637062d@gmail.com>
From: Eric Rescorla <ekr@rtfm.com>
Date: Sat, 16 Mar 2024 13:50:50 -0700
Message-ID: <CABcZeBPzYvscB3yeaRYQg6waR1BvqQMhJ+GpoKAZThoDvREs+w@mail.gmail.com>
To: Brian E Carpenter <brian.e.carpenter@gmail.com>
Cc: John C Klensin <john-ietf@jck.com>, Michael Richardson <mcr+ietf@sandelman.ca>, Carsten Bormann <cabo@tzi.org>, tools-discuss <tools-discuss@ietf.org>
Content-Type: multipart/alternative; boundary="000000000000bc148b0613cd4907"
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-discuss/idXQbx2xgS_J1JwNBz-7pwBvfTQ>
Subject: Re: [Tools-discuss] Why post text and not XML? (was: I-D statistics)
X-BeenThere: tools-discuss@ietf.org
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: IETF Tools Discussion <tools-discuss.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/tools-discuss/>
List-Post: <mailto:tools-discuss@ietf.org>
List-Help: <mailto:tools-discuss-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=subscribe>
X-List-Received-Date: Sat, 16 Mar 2024 20:51:28 -0000

On Sat, Mar 16, 2024 at 1:36 PM Brian E Carpenter <
brian.e.carpenter@gmail.com> wrote:

> John,
>
> Thanks for explaining.
>
> In line...
>
>
> On 17-Mar-24 07:51, John C Klensin wrote:
> >
> >
> > --On Saturday, March 16, 2024 17:13 +1300 Brian E Carpenter
> > <brian.e.carpenter@gmail.com> wrote:
>
> >     =================
> >
> > For anyone interested and in the hope of not having to repeat
> > this again...
> >
> > Especially for long, complex, and long-lived documents,
> > especially those that are replacements, significant updates for
> > earlier documents, or merges of others, I use extensive comments
> > in the XML to track changes and decisions.   Other comments are
> > used to provide information to, or prepare for discussions with,
> > the RPC about why particular text phrasing and constructions or
> > document organizations were chosen, etc.  With one current
> > document, those comments add up to more that 30% of the size of
> > the XML file.  Some of those comments are over 20 years old and
> > have been carried forward from xml2rfc v1 files associated with
> > previous documents.
>
> Understood. The "modern" approach is of course to embed such
> comments in GitHub issues, which tends to lead to self-censorship
> of any "unkind" comments, and then the nit-picking takes place
> on GitHub too.
>

I don't much care about the comments, but I would observe that a
consequence of having the XML kept private like this is to make it
more difficult for others to work on the documents, either by submitting
diffs to the text or by forking them and making their own documents.

So in that respect, I think the "modern" approach truly is superior,
though of course it's not the only way to obtain those benefits.

-Ekr