Re: [rfc-i] line wrapping in XML

Mark Nottingham <mnot@mnot.net> Fri, 30 October 2020 01:00 UTC

Return-Path: <rfc-interest-bounces@rfc-editor.org>
X-Original-To: ietfarch-rfc-interest-archive@ietfa.amsl.com
Delivered-To: ietfarch-rfc-interest-archive@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id EF6843A0917; Thu, 29 Oct 2020 18:00:46 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.45
X-Spam-Level:
X-Spam-Status: No, score=-2.45 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_INVALID=0.1, DKIM_SIGNED=0.1, HEADER_FROM_DIFFERENT_DOMAINS=0.25, MAILING_LIST_MULTI=-1, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=fail (2048-bit key) reason="fail (message has been altered)" header.d=mnot.net header.b=KaUtH046; dkim=fail (2048-bit key) reason="fail (message has been altered)" header.d=messagingengine.com header.b=XrRMPcnC
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 5OEdj-baEJni; Thu, 29 Oct 2020 18:00:45 -0700 (PDT)
Received: from rfc-editor.org (rfc-editor.org [4.31.198.49]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 0DE503A0AC3; Thu, 29 Oct 2020 18:00:45 -0700 (PDT)
Received: from rfcpa.amsl.com (localhost [IPv6:::1]) by rfc-editor.org (Postfix) with ESMTP id CDBD9F40723; Thu, 29 Oct 2020 18:00:30 -0700 (PDT)
X-Original-To: rfc-interest@rfc-editor.org
Delivered-To: rfc-interest@rfc-editor.org
Received: from localhost (localhost [127.0.0.1]) by rfc-editor.org (Postfix) with ESMTP id 22FD7F40723 for <rfc-interest@rfc-editor.org>; Thu, 29 Oct 2020 18:00:30 -0700 (PDT)
X-Virus-Scanned: amavisd-new at rfc-editor.org
Authentication-Results: rfcpa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=mnot.net header.b=KaUtH046; dkim=pass (2048-bit key) header.d=messagingengine.com header.b=XrRMPcnC
Received: from rfc-editor.org ([127.0.0.1]) by localhost (rfcpa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id AGe2N-vcKU9B for <rfc-interest@rfc-editor.org>; Thu, 29 Oct 2020 18:00:25 -0700 (PDT)
Received: from out2-smtp.messagingengine.com (out2-smtp.messagingengine.com [66.111.4.26]) by rfc-editor.org (Postfix) with ESMTPS id 8EC19F40721 for <rfc-interest@rfc-editor.org>; Thu, 29 Oct 2020 18:00:25 -0700 (PDT)
Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailout.nyi.internal (Postfix) with ESMTP id C7CD55C00E1; Thu, 29 Oct 2020 21:00:38 -0400 (EDT)
Received: from mailfrontend2 ([10.202.2.163]) by compute2.internal (MEProxy); Thu, 29 Oct 2020 21:00:38 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=mnot.net; h= content-type:mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; s=fm1; bh=u 6jZI55VA0GSMr8FYBNIeXyo/9Di5y6kfup5R9FnSnE=; b=KaUtH046fHOXLZJqK DTcGS5WQTRIrVTSCRkzYE8fyA+aFUFdgOvR9VFReBh1m8Ky16KJUuZ2NpNI/cJK0 +8c5Jg8pQoJu3+4Si72QGotH7/EZkN5iVhsxcIX1nxqxCOdM5NCqSPKeFfGe4C2R k2MKX2EHQSQ34CSOVW017eVVU6fD1BFIKAUE9zA1Orz+6bQq/W0ZLpEf6zuHZBgZ 1CoOX//rSfoja04rXXIaaD37cIPUM7oz79Y2psgxjqnGZ4HrhqpFiAl1mVaYQ/Aa kKkwntkS0GOHggtIheLIkW9MMhGgHEYOBXSsBKWoRTCPrr92Qtz3XmbWfu5OEyM+ ZOdcg==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm1; bh=u6jZI55VA0GSMr8FYBNIeXyo/9Di5y6kfup5R9FnS nE=; b=XrRMPcnC5G3SV4XCz+lc7wFKa0ZJUYBt4FUQRlog4Vkd7nT64+pT/Y1ru wrC0dBKTe2YadMXoNIwZNu7nYcU1xuuvQGi+n1dKs3KtGSrhVWY8yRkORleQ3C8H v3MgihmGVBiwMR6deSf+VAW3/jqCvTpvFac+XZ4JM+ywQxzfFmsoDHzNpejKM2SL M9B0sfDQUACWlnuZET8i2JyxYYJEhaRuD4ym1rq7qI787R0xsVC9LRE2YhTYiRUa 2f61B0ViO3viopLm++e+0/s0xjEZewzPo0pck/+LrVpu/q6l2f6viHTQzNNLHqJS FbkvFPPCJ1xKKtYgI+1g7w15wnQhQ==
X-ME-Sender: <xms:tWWbX9SNE9MBHIvnY2BhoAL9kQIzfn2ZmvdU8MIG2by6u1XsOuYurA> <xme:tWWbX2z3JVCRdf18y-aM5qppfdYt02K-7cRc-JPyyZskSKBT0IsDUIh0jUhdJ_Puv YLRSs4ezH6Ovl-asw>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedujedrleeggddvkecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecunecujfgurheptggguffhjgffgffkfhfvofesthhqmh dthhdtvdenucfhrhhomhepofgrrhhkucfpohhtthhinhhghhgrmhcuoehmnhhothesmhhn ohhtrdhnvghtqeenucggtffrrghtthgvrhhnpeeuueetfeeggfethfekfeelvefggffhgf dtueekffduhfdugeekhffgfedvkefhjeenucffohhmrghinhephhhtthhpfhhivghluggr uhhthhhorhdrthhtpdhmnhhothdrnhgvthenucfkphepudduledrudejrdduheekrddvhe dunecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrhhomhepmhhn ohhtsehmnhhothdrnhgvth
X-ME-Proxy: <xmx:tWWbXy25ZfPidSMtWKlVfK5BiY6XCjrJwBWJC5MJWzUfotuWOz6uQQ> <xmx:tWWbX1CyDQd7Rne-j_PHjd0m5iHXh4-k_XNJ_VEYNgqbb0ica1Gv-w> <xmx:tWWbX2iQDE1fmkeus2nM0oljGgC5w56iWf7MmREQNtEGFsN91QIWHQ> <xmx:tmWbX5tCIvD0NbSFq9bHFt6mmBvVtSpFkWueYmi-L8US37tD1qAweQ>
Received: from [192.168.7.30] (119-17-158-251.77119e.mel.static.aussiebb.net [119.17.158.251]) by mail.messagingengine.com (Postfix) with ESMTPA id A4BBB3064684; Thu, 29 Oct 2020 21:00:35 -0400 (EDT)
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.4\))
From: Mark Nottingham <mnot@mnot.net>
In-Reply-To: <13255.1604019169@localhost>
Date: Fri, 30 Oct 2020 12:00:31 +1100
Message-Id: <12EC83C0-6965-44DB-842B-C42CB5C80A2A@mnot.net>
References: <30D23CA0-2A80-4BA3-AC18-285CF45FB5FF@mnot.net> <13255.1604019169@localhost>
To: Michael Richardson <mcr+ietf@sandelman.ca>
X-Mailer: Apple Mail (2.3608.120.23.2.4)
Subject: Re: [rfc-i] line wrapping in XML
X-BeenThere: rfc-interest@rfc-editor.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "A list for discussion of the RFC series and RFC Editor functions." <rfc-interest.rfc-editor.org>
List-Unsubscribe: <https://www.rfc-editor.org/mailman/options/rfc-interest>, <mailto:rfc-interest-request@rfc-editor.org?subject=unsubscribe>
List-Archive: <http://www.rfc-editor.org/pipermail/rfc-interest/>
List-Post: <mailto:rfc-interest@rfc-editor.org>
List-Help: <mailto:rfc-interest-request@rfc-editor.org?subject=help>
List-Subscribe: <https://www.rfc-editor.org/mailman/listinfo/rfc-interest>, <mailto:rfc-interest-request@rfc-editor.org?subject=subscribe>
Cc: rfc-interest@rfc-editor.org
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: rfc-interest-bounces@rfc-editor.org
Sender: rfc-interest <rfc-interest-bounces@rfc-editor.org>


> On 30 Oct 2020, at 11:52 am, Michael Richardson <mcr+ietf@sandelman.ca> wrote:
> 
> 
> Mark Nottingham <mnot@mnot.net> wrote:
>> When editing a source document (especially Markdown), many people seem
>> to find it best to NOT line-wrap paragraphs, so that diffs (e.g., on
>> GitHub) are minimal; otherwise re-wrapping causes a lot of noise in
>> diffs during the WG process.
> 
> Yup.
> I like once line per sentence though.
> I used to make my XML and my markdown all pretty, but I stopped once I taught
> my editor to make it pretty as I type.

Exactly.

>> When an XML document goes to the RFC Editor, it will be line-wrapped
>> (apparently manually). This causes difficulties in creating an XML diff
>> from the source document to the one that's being offered for approval
>> -- something that I feel is necessary, given that XML is now the
>> canonical format.
> 
> When you say that they get wrapped, does it just the wrap long lines to
> multiple lines, or does it put lines together which are in different
> sentences? To take the above paragraph, do we get:
> 
>> When an XML document goes to the RFC Editor, it will be line-wrapped
>> (apparently manually). This causes difficulties in creating an XML diff
>> from the source document to the one that's being offered for approval
>> -- something that I feel is necessary, given that XML is now the
>> canonical format.
> 
> or:
> 
>> When an XML document goes to the RFC Editor, it will be line-wrapped
>> (apparently manually).
>> This causes difficulties in creating an XML diff from the source
>> document to the one that's being offered for approval -- something that
>> I feel is necessary, given that XML is now the canonical format.

E.g., 

      <t>Specifying the syntax of new HTTP header (and trailer) fields is an onerous task; even with the guidance in <xref target="RFC7231" section="8.3.1" format="default"/>, there are many decisions -- and pitfalls -- for a prospective HTTP field author.</t>
      <t>Once a field is defined, bespoke parsers and serializers often need to be written, because each field value has a slightly different handling of what looks like common syntax.</t>


becomes

      <t>Specifying the syntax of new HTTP header (and trailer) fields is an
      onerous task; even with the guidance in <xref target="RFC7231" section="8.3.1"/>, there are many decisions -- and
      pitfalls -- for a prospective HTTP field author.</t>
      <t>Once a field is defined, bespoke parsers and serializers often need
      to be written, because each field value has a slightly different handling
      of what looks like common syntax.</t>

Cheers,

--
Mark Nottingham   https://www.mnot.net/

_______________________________________________
rfc-interest mailing list
rfc-interest@rfc-editor.org
https://www.rfc-editor.org/mailman/listinfo/rfc-interest