Re: [netmod] artwork folding: dual support modes?

"Rob Wilton (rwilton)" <rwilton@cisco.com> Wed, 27 February 2019 10:09 UTC

Return-Path: <rwilton@cisco.com>
X-Original-To: netmod@ietfa.amsl.com
Delivered-To: netmod@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 87692131027 for <netmod@ietfa.amsl.com>; Wed, 27 Feb 2019 02:09:56 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -14.5
X-Spam-Level:
X-Spam-Status: No, score=-14.5 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_HI=-5, SPF_PASS=-0.001, URIBL_BLOCKED=0.001, USER_IN_DEF_DKIM_WL=-7.5] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=cisco.com
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 mdA8TwGISaz0 for <netmod@ietfa.amsl.com>; Wed, 27 Feb 2019 02:09:53 -0800 (PST)
Received: from rcdn-iport-8.cisco.com (rcdn-iport-8.cisco.com [173.37.86.79]) (using TLSv1.2 with cipher DHE-RSA-SEED-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 37CDE130FE4 for <netmod@ietf.org>; Wed, 27 Feb 2019 02:09:53 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=cisco.com; i=@cisco.com; l=36120; q=dns/txt; s=iport; t=1551262193; x=1552471793; h=from:to:cc:subject:date:message-id:references: in-reply-to:mime-version; bh=JwErlmtXwFVvbZ1r2btPZ1EhPCdFJXPqL1jv8Uknj0A=; b=CRUQh+43NH7ZpGfgKJpVKc0aOEoO4ZUXtgx3WDZzvLuTnjvo6m9n4VbT G69uDep33OKiCG0qnWyvUMoLXw6vRcdtvOhXr+r6O9nNCgtSoOCKViZV9 t1kRzZxa6wk6wjJ1odQJrQM3iuykmpVFqfdYYajmXgW9zYFETTDyq1eKP k=;
X-IronPort-Anti-Spam-Filtered: true
X-IronPort-Anti-Spam-Result: =?us-ascii?q?A0AHAAAPYXZc/5BdJa1kGQEBAQEBAQE?= =?us-ascii?q?BAQEBAQcBAQEBAQGBUwIBAQEBAQsBgQ1MKmeBAycKg36WA5gggXcECwEBGAE?= =?us-ascii?q?KhANGAheDcSI2Bw0BAwEBAgEBAm0cDIVKAQEBAQMBASEKQQsQAgEGAhEEAQE?= =?us-ascii?q?hAQYDAgICJQsUCQgCBAENBQiDGYEOZA+PU5thgS+KKwWMSBeBQD+BEYMSgx4?= =?us-ascii?q?BAYF4H4JUglcCigoPIIICg3+TKwkCkl4hkxqKXZIWAhEUgSgmAi+BVnAVO4J?= =?us-ascii?q?sgz8BCIdWhT9BMZEsgR8BAQ?=
X-IronPort-AV: E=Sophos;i="5.58,419,1544486400"; d="scan'208,217";a="523191495"
Received: from rcdn-core-8.cisco.com ([173.37.93.144]) by rcdn-iport-8.cisco.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 27 Feb 2019 10:09:51 +0000
Received: from XCH-RCD-008.cisco.com (xch-rcd-008.cisco.com [173.37.102.18]) by rcdn-core-8.cisco.com (8.15.2/8.15.2) with ESMTPS id x1RA9pns012839 (version=TLSv1.2 cipher=AES256-SHA bits=256 verify=FAIL); Wed, 27 Feb 2019 10:09:51 GMT
Received: from xch-rcd-007.cisco.com (173.37.102.17) by XCH-RCD-008.cisco.com (173.37.102.18) with Microsoft SMTP Server (TLS) id 15.0.1395.4; Wed, 27 Feb 2019 04:09:51 -0600
Received: from xch-rcd-007.cisco.com ([173.37.102.17]) by XCH-RCD-007.cisco.com ([173.37.102.17]) with mapi id 15.00.1395.000; Wed, 27 Feb 2019 04:09:51 -0600
From: "Rob Wilton (rwilton)" <rwilton@cisco.com>
To: "adrian@olddog.co.uk" <adrian@olddog.co.uk>, "'Joel Jaeggli'" <joelja@bogus.com>
CC: "netmod@ietf.org" <netmod@ietf.org>
Thread-Topic: [netmod] artwork folding: dual support modes?
Thread-Index: AQHUzViIs88uqV1md0esD7eI1tBXvaXzDpmAgACHaICAADTYgP//oJLA
Date: Wed, 27 Feb 2019 10:09:51 +0000
Message-ID: <3af58c925ad74fbfaaea299877bf992d@XCH-RCD-007.cisco.com>
References: <0100016926bfd7ac-333fc4ef-98a8-4dc4-98a2-1b3414b35e24-000000@email.amazonses.com> <04b001d4ce22$5bd78d50$1386a7f0$@olddog.co.uk> <6E24D34F-9943-4A71-9F28-4E4548FF30B0@bogus.com> <057f01d4ce80$7bc4fc70$734ef550$@olddog.co.uk>
In-Reply-To: <057f01d4ce80$7bc4fc70$734ef550$@olddog.co.uk>
Accept-Language: en-GB, en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
x-ms-exchange-transport-fromentityheader: Hosted
x-originating-ip: [10.63.23.61]
Content-Type: multipart/alternative; boundary="_000_3af58c925ad74fbfaaea299877bf992dXCHRCD007ciscocom_"
MIME-Version: 1.0
X-Outbound-SMTP-Client: 173.37.102.18, xch-rcd-008.cisco.com
X-Outbound-Node: rcdn-core-8.cisco.com
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/AOSJGJ7A5y76kxvBiqu9k5iOU0g>
Subject: Re: [netmod] artwork folding: dual support modes?
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: NETMOD WG list <netmod.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/netmod>, <mailto:netmod-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/netmod/>
List-Post: <mailto:netmod@ietf.org>
List-Help: <mailto:netmod-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/netmod>, <mailto:netmod-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 27 Feb 2019 10:10:00 -0000

Hi Adrian,

I mostly agree with your last sentence.

I think that if you always preserve whitespace then a single slash is fine.  I.e. the single slash just breaks the line, and I think that this matches how editors, programming languages, etc normally behave.

What I’m not keen on is using a single slash, and then automatically stripping leading whitespace on the line following a slash.

If we want to have control of layout and be able to strip extra whitespace then my argument is that it is better to be explicit, and using two slashes is one way of achieving this.

Thanks,
Rob



From: netmod <netmod-bounces@ietf.org> On Behalf Of Adrian Farrel
Sent: 27 February 2019 09:41
To: 'Joel Jaeggli' <joelja@bogus.com>
Cc: netmod@ietf.org
Subject: Re: [netmod] artwork folding: dual support modes?

Complete agreement, Joel.

What follows may look better in proportional fonts.

With a single slash we can wrap as follows

1234567        9012345

Goes to…

1234567    \
    9012345

…and unwrapping is easy.

However, if I want to manually wrap the line with indentation

The quick brown fox jumps over the lazy dog

..going to…

The quick brown fox\
      jumps over the lazy dog

…I am going to unfold as…

The quick brown fox      jumps over the lazy dog


Conversely, if I resolve this second case by stripping leading spaces I get…

The quick brown foxjumps over the lazy dog

So I have to fold as…

The quick brown fox \
      jumps over the lazy dog

But this causes the first case to unfold as

1234567    9012345

…i.e., with missing spaces.

This is what caused the use of the second slash so…

1234567    \
\    9012345

…and…

The quick brown fox\
     \ jumps over the lazy dog


So, my point is, if and only if we do not care about these “spaces on the fold” cases, we can operate with a single slash.

Cheers,
Adrian

From: Joel Jaeggli <joelja@bogus.com<mailto:joelja@bogus.com>>
Sent: 27 February 2019 06:31
To: Adrian Farrel <adrian@olddog.co.uk<mailto:adrian@olddog.co.uk>>
Cc: Kent Watsen <kent+ietf@watsen.net<mailto:kent+ietf@watsen.net>>; netmod@ietf.org<mailto:netmod@ietf.org>
Subject: Re: [netmod] artwork folding: dual support modes?



On Feb 26, 2019, at 14:26, Adrian Farrel <adrian@olddog.co.uk<mailto:adrian@olddog.co.uk>> wrote:

Hey.

I’ve been having this discussion with Kent off-line, but thought it should come to the list.

I don’t think it is a good idea to have two approaches. While it would be relatively easy to code for both approaches, it seems to add a degree of confusion if both have to be handled by the same code (consider deciding whether leading space characters are to be retained or not, something that can only be decided when the first non-space character is found), or by having different code for the two different cases.

It doesn’t seem to me that both cases are needed. We can pick one or the other.

A single slash has been used to wrap long lines in editors and shells for decades at this point.

and yeah whatever it is one method seems better than two.


And *if* we want to allow manual folding so that indents can be made to make the document more human-readable then we have to use a leading ‘\’ on continuation lines to show which spaces should be stripped and which retained.

Cheers,
Adrian

From: netmod <netmod-bounces@ietf.org<mailto:netmod-bounces@ietf.org>> On Behalf Of Kent Watsen
Sent: 25 February 2019 22:22
To: netmod@ietf.org<mailto:netmod@ietf.org>
Subject: [netmod] artwork folding: dual support modes?


I had a chat with the tools team recently and, in the course of things, it was implied
that the double backslash approach we have now was both surprising and non-intuitive.

This got me thinking that we may have thrown the proverbial baby out with the bathwater.
That is, currently we have a header that reads:


  NOTE: '\\' line wrapping per BCP XX (RFC XXXX)

So why not *also* support a header that reads (note the singe slash):


  NOTE: '\' line wrapping per BCP XX (RFC XXXX)

Whereby this second form only supports the folded line continuing on column 1 (no indents).

Thoughts?

Kent // contributor


_______________________________________________
netmod mailing list
netmod@ietf.org<mailto:netmod@ietf.org>
https://www.ietf.org/mailman/listinfo/netmod