From: Junio C Hamano <gitster@pobox.com>
To: Jeff King <peff@peff.net>
Cc: Rob Browning <rlb@defaultvalue.org>, git@vger.kernel.org
Subject: Re: [PATCH 1/1] signature-format.txt: add space to fix gpgsig continuation line
Date: Mon, 11 Oct 2021 13:04:48 -0700 [thread overview]
Message-ID: <xmqq4k9ncopr.fsf@gitster.g> (raw)
In-Reply-To: <YWRpPw4eTwTmgVvC@coredump.intra.peff.net> (Jeff King's message of "Mon, 11 Oct 2021 12:41:35 -0400")
Jeff King <peff@peff.net> writes:
> On Sat, Oct 09, 2021 at 11:33:38AM -0500, Rob Browning wrote:
>
>> Add a space to the blank line after the version header in the example
>> gpgsig commit header.
>
> Thanks, this is a good catch. The space is important for the header
> continuation.
>
>> diff --git a/Documentation/technical/signature-format.txt b/Documentation/technical/signature-format.txt
>> index 2c9406a56a..6acc0b1247 100644
>> --- a/Documentation/technical/signature-format.txt
>> +++ b/Documentation/technical/signature-format.txt
>> @@ -78,7 +78,7 @@ author A U Thor <author@example.com> 1465981137 +0000
>> committer C O Mitter <committer@example.com> 1465981137 +0000
>> gpgsig -----BEGIN PGP SIGNATURE-----
>> Version: GnuPG v1
>> -
>> +
>> iQEcBAABAgAGBQJXYRjRAAoJEGEJLoW3InGJ3IwIAIY4SA6GxY3BjL60YyvsJPh/
>> HRCJwH+w7wt3Yc/9/bW2F+gF72kdHOOs2jfv+OZhq0q4OAN6fvVSczISY/82LpS7
>> DVdMQj2/YcHDT4xrDNBnXnviDO9G7am/9OE77kEbXrp7QPxvhjkicHNwy2rEflAA
>
> The patch is quite subtle to read, of course. :) But more importantly,
> it is subtle for somebody reading the documentation to notice. Perhaps
> it's worth calling it out explicitly? E.g., squashing in something like:
> ...
> - (content is preceded by a space)
> + (content is preceded by a space; note that this includes the
> + "empty" line between the GnuPG header and signature, which
> + consists of a single space).
> - example: commit with subject `signed commit`
To those who are reading on paper or on terminal, the difference
will not be even seen. It only can be _found_ if you are in an
editor or a pager and explicitly look for a trailing whitespace (or
told your tool to highlight such for you).
I wonder if we can have some typesetting convention for this part of
the documentation. Perhaps something like
In the following example, the end of line that ends with a
whitespace letter is highlighted with a "$" sign; if you are
trying to recreate these example by hand, do not cut and paste
them---they are there primarily to highlight extra whitespace at
the end of some lines.
before a displayed material like this:
committer C O Mitter <committer@example.com> 1465981137 +0000
gpgsig -----BEGIN PGP SIGNATURE-----
Version: GnuPG v1
$
iQEcBAABAgAGBQJXYRjRAAoJEGEJLoW3InGJ3IwIAIY4SA6GxY3BjL60YyvsJPh/
HRCJwH+w7wt3Yc/9/bW2F+gF72kdHOOs2jfv+OZhq0q4OAN6fvVSczISY/82LpS7
DVdMQj2/YcHDT4xrDNBnXnviDO9G7am/9OE77kEbXrp7QPxvhjkicHNwy2rEflAA
perhaps?
I am reasonably sure that running "git am" on Rob's patch will by
default end up as a no-op patch, because auto-correcting whitespace
breakage is the default setting I use, and a change like the one
suggested above would help avoid such a problem, too.
Thanks.
next prev parent reply other threads:[~2021-10-11 20:05 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-09 16:33 [PATCH 1/1] signature-format.txt: add space to fix gpgsig continuation line Rob Browning
2021-10-11 16:41 ` Jeff King
2021-10-11 20:04 ` Junio C Hamano [this message]
2021-10-12 2:08 ` Jeff King
2021-10-12 16:54 ` Junio C Hamano
2021-10-13 2:06 ` [PATCH] signature-format.txt: explain and illustrate multi-line headers Junio C Hamano
2021-10-14 5:12 ` Rob Browning
2021-10-14 17:17 ` Junio C Hamano
2021-10-15 1:27 ` Rob Browning
2021-10-15 15:58 ` Junio C Hamano
2021-10-15 23:29 ` Rob Browning
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqq4k9ncopr.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=peff@peff.net \
--cc=rlb@defaultvalue.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).