All of lore.kernel.org
 help / color / mirror / Atom feed
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: Tue, 12 Oct 2021 09:54:24 -0700	[thread overview]
Message-ID: <xmqqzgre5glb.fsf@gitster.g> (raw)
In-Reply-To: <YWTuAOjqK6fy9ZRT@coredump.intra.peff.net> (Jeff King's message of "Mon, 11 Oct 2021 22:08:00 -0400")

Jeff King <peff@peff.net> writes:

>>     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?
>
> ...coupled with the explanation you gave is not too bad. I had thought
> to maybe do something like:
>
>    gpgsig -----BEGIN PGP SIGNATURE-----
>    _Version: GnuPG v1
>    _
>    _iQEcBAABAgAGBQJXYRjRAAoJEGEJLoW3InGJ3IwIAIY4SA6GxY3BjL60YyvsJPh/
>    _HRCJwH+w7wt3Yc/9/bW2F+gF72kdHOOs2jfv+OZhq0q4OAN6fvVSczISY/82LpS7
>    _DVdMQj2/YcHDT4xrDNBnXnviDO9G7am/9OE77kEbXrp7QPxvhjkicHNwy2rEflAA
>
> but that is pretty ugly. I like yours much better.

Yes, I did consider a replacement for SP and rejected for the same
reason as you did.  We could use the same "we only show the 'here is
a SP' sign when the presence of the SP cannot be seen" convention to
make it less distracting, but I think '$' taken from "cat -e"
probably is easier to see and understand for those who are the
target audience of anything in Documentation/technical/ hierarchy.

Thanks.




  reply	other threads:[~2021-10-12 16:54 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
2021-10-12  2:08     ` Jeff King
2021-10-12 16:54       ` Junio C Hamano [this message]
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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqzgre5glb.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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.