[PATCH 0/2] docs: apply minor fixes to Documentation/config/pgp.txt

[PATCH 0/2] docs: apply minor fixes to Documentation/config/pgp.txt

[Greg Hurrell]

Two little fixes to the docs, adding a missing apostrophe and fixing a
mid-sentence tab to a space, respectively.

 Documentation/config/gpg.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

[PATCH 1/2] docs: Fix bad whitespace in Documentation/config/pgp.txt

[Greg Hurrell]

Signed-off-by: Greg Hurrell <greg@hurrell.net>
---
 Documentation/config/gpg.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt
index 0cb189a077..abfabd6d62 100644
--- a/Documentation/config/gpg.txt
+++ b/Documentation/config/gpg.txt
@@ -37,7 +37,7 @@ gpg.minTrustLevel::
 gpg.ssh.defaultKeyCommand::
 	This command that will be run when user.signingkey is not set and a ssh
 	signature is requested. On successful exit a valid ssh public key is
-	expected in the	first line of its output. To automatically use the first
+	expected in the first line of its output. To automatically use the first
 	available key from your ssh-agent set this to "ssh-add -L".
 
 gpg.ssh.allowedSignersFile::
-- 
2.35.0

Re: [PATCH 1/2] docs: Fix bad whitespace in Documentation/config/pgp.txt

[Ævar Arnfjörð Bjarmason]

On Tue, Jan 25 2022, Greg Hurrell wrote:

nit @ subject: I'd suggest:

	Documentation/config/pgp.txt: replace stray <TAB> character with <SPC>

Or something, i.e. the "docs" can just be replaced by the filename, so
we don't need to put it at the end.

As general style, we tend to not have the <msg> part of "<subsystem>:
<msg>" start with a capital letter, i.e. "fix" not "Fix".

> Signed-off-by: Greg Hurrell <greg@hurrell.net>
> ---
>  Documentation/config/gpg.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt
> index 0cb189a077..abfabd6d62 100644
> --- a/Documentation/config/gpg.txt
> +++ b/Documentation/config/gpg.txt
> @@ -37,7 +37,7 @@ gpg.minTrustLevel::
>  gpg.ssh.defaultKeyCommand::
>  	This command that will be run when user.signingkey is not set and a ssh
>  	signature is requested. On successful exit a valid ssh public key is
> -	expected in the	first line of its output. To automatically use the first
> +	expected in the first line of its output. To automatically use the first

Since I had to look it's a s/\t/ / of a tab between "the" and "first" in
the pre-image>

[PATCH v2 0/2] Apply minor fixes to Documentation/config/pgp.txt

[Greg Hurrell]

Just applying changes to commit messages as suggested by Ævar Arnfjörð
Bjarmason:

> nit @ subject: I'd suggest:
>
>	Documentation/config/pgp.txt: replace stray <TAB> character with <SPC>
>
> Or something, i.e. the "docs" can just be replaced by the filename, so
> we don't need to put it at the end.
>
> As general style, we tend to not have the <msg> part of "<subsystem>:
> <msg>" start with a capital letter, i.e. "fix" not "Fix".

[PATCH v2 1/2] Documentation/config/pgp.txt: replace stray <TAB> character with <SPC>

[Greg Hurrell]

Specifically, replace the tab between "the" and "first" with a space.

Signed-off-by: Greg Hurrell <greg@hurrell.net>
---
 Documentation/config/gpg.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt
index 0cb189a077..abfabd6d62 100644
--- a/Documentation/config/gpg.txt
+++ b/Documentation/config/gpg.txt
@@ -37,7 +37,7 @@ gpg.minTrustLevel::
 gpg.ssh.defaultKeyCommand::
 	This command that will be run when user.signingkey is not set and a ssh
 	signature is requested. On successful exit a valid ssh public key is
-	expected in the	first line of its output. To automatically use the first
+	expected in the first line of its output. To automatically use the first
 	available key from your ssh-agent set this to "ssh-add -L".
 
 gpg.ssh.allowedSignersFile::
-- 
2.35.0

Re: [PATCH v2 1/2] Documentation/config/pgp.txt: replace stray <TAB> character with <SPC>

[Junio C Hamano]

Greg Hurrell <greg@hurrell.net> writes:

> Specifically, replace the tab between "the" and "first" with a space.

Good eyes.  Does it have ANY practical downside to leave it unfixed?

In other words, how did you spot it (e.g. "asciidoctor passes tab as-is
and screwed up an alignment of the text, which was how I noticed it")?

Thanks.

>
> Signed-off-by: Greg Hurrell <greg@hurrell.net>
> ---
>  Documentation/config/gpg.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt
> index 0cb189a077..abfabd6d62 100644
> --- a/Documentation/config/gpg.txt
> +++ b/Documentation/config/gpg.txt
> @@ -37,7 +37,7 @@ gpg.minTrustLevel::
>  gpg.ssh.defaultKeyCommand::
>  	This command that will be run when user.signingkey is not set and a ssh
>  	signature is requested. On successful exit a valid ssh public key is
> -	expected in the	first line of its output. To automatically use the first
> +	expected in the first line of its output. To automatically use the first
>  	available key from your ssh-agent set this to "ssh-add -L".
>  
>  gpg.ssh.allowedSignersFile::

Re: [PATCH v2 1/2] Documentation/config/pgp.txt: replace stray <TAB> character with <SPC>

[Greg Hurrell]

On Thu, Jan 27, 2022, at 3:30 AM, Junio C Hamano wrote:
> Greg Hurrell <greg@hurrell.net> writes:
> 
> > Specifically, replace the tab between "the" and "first" with a space.
> 
> Good eyes.  Does it have ANY practical downside to leave it unfixed?
> 
> In other words, how did you spot it (e.g. "asciidoctor passes tab as-is
> and screwed up an alignment of the text, which was how I noticed it")?

The nearby fix (the apostrophe) in the other commit was what had me
looking at this file in the first place. But my editor (Neovim)
made the mid-line tab visually obvious, so I figured may as well clean
it up along the way; on my screen it looked something like this:

    ▷┅┅┅signature is requested. On successful exit a valid ssh public key is
    ▷┅┅┅expected in the▷┅┅┅first line of its output. To automatically use the first
    ▷┅┅┅available key from your ssh-agent set this to "ssh-add -L".

Vim's "listchars" setting is responsible for making tabs visible like that:

    :set listchars=extends:»,nbsp:⦸,precedes:«,tab:▷⋯,trail:•

Greg

Re: [PATCH v2 1/2] Documentation/config/pgp.txt: replace stray <TAB> character with <SPC>

[Junio C Hamano]

"Greg Hurrell" <greg@hurrell.net> writes:

> On Thu, Jan 27, 2022, at 3:30 AM, Junio C Hamano wrote:
>> Greg Hurrell <greg@hurrell.net> writes:
>> 
>> > Specifically, replace the tab between "the" and "first" with a space.
>> 
>> Good eyes.  Does it have ANY practical downside to leave it unfixed?
>> 
>> In other words, how did you spot it (e.g. "asciidoctor passes tab as-is
>> and screwed up an alignment of the text, which was how I noticed it")?
>
> The nearby fix (the apostrophe) in the other commit was what had me
> looking at this file in the first place. But my editor (Neovim)
> made the mid-line tab visually obvious, so I figured may as well clean

Ah, yes, highlighting editors and pagers.  I forgot about them.

In any case, thanks for the fixes.  Queued.

[PATCH 2/2] Documentation/config/pgp.txt: add missing apostrophe

[Greg Hurrell]

Add an apostrophe to "signatures" to indicate the possessive
relationship in "the signature's creation".

Signed-off-by: Greg Hurrell <greg@hurrell.net>
---
 Documentation/config/gpg.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt
index abfabd6d62..86892ada77 100644
--- a/Documentation/config/gpg.txt
+++ b/Documentation/config/gpg.txt
@@ -66,7 +66,7 @@ This way only committers with an already valid key can add or change keys in the
 +
 Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after &
 valid-before options. Git will mark signatures as valid if the signing key was
-valid at the time of the signatures creation. This allows users to change a
+valid at the time of the signature's creation. This allows users to change a
 signing key without invalidating all previously made signatures.
 +
 Using a SSH CA key with the cert-authority option
-- 
2.35.0

Re: [PATCH 2/2] Documentation/config/pgp.txt: add missing apostrophe

[Junio C Hamano]

Greg Hurrell <greg@hurrell.net> writes:

> Add an apostrophe to "signatures" to indicate the possessive
> relationship in "the signature's creation".
>
> Signed-off-by: Greg Hurrell <greg@hurrell.net>
> ---
>  Documentation/config/gpg.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Thanks.  Will queue.

> diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt
> index abfabd6d62..86892ada77 100644
> --- a/Documentation/config/gpg.txt
> +++ b/Documentation/config/gpg.txt
> @@ -66,7 +66,7 @@ This way only committers with an already valid key can add or change keys in the
>  +
>  Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after &
>  valid-before options. Git will mark signatures as valid if the signing key was
> -valid at the time of the signatures creation. This allows users to change a
> +valid at the time of the signature's creation. This allows users to change a
>  signing key without invalidating all previously made signatures.
>  +
>  Using a SSH CA key with the cert-authority option

[PATCH 2/2] docs: add missing apostrophe to Documentation/config/gpg.txt

[Greg Hurrell]

Add an apostrophe to "signatures" to indicate the possessive
relationship in "the signature's creation".

Signed-off-by: Greg Hurrell <greg@hurrell.net>
---
 Documentation/config/gpg.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt
index abfabd6d62..86892ada77 100644
--- a/Documentation/config/gpg.txt
+++ b/Documentation/config/gpg.txt
@@ -66,7 +66,7 @@ This way only committers with an already valid key can add or change keys in the
 +
 Since OpensSSH 8.8 this file allows specifying a key lifetime using valid-after &
 valid-before options. Git will mark signatures as valid if the signing key was
-valid at the time of the signatures creation. This allows users to change a
+valid at the time of the signature's creation. This allows users to change a
 signing key without invalidating all previously made signatures.
 +
 Using a SSH CA key with the cert-authority option
-- 
2.35.0