Skip to contentSkip to conversation

docs: apply minor fixes to Documentation/config/pgp.txt

PATCH Superseded Greg Hurrell 3 participants 11 messages Jan 25, 2022 – Jan 27, 2022 Documentation

lore
Share & tools
lore
#0 lore raw

cover docs: apply minor fixes to Documentation/config/pgp.txt

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(-)
#1 lore raw

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

---
 Documentation/config/gpg.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/config/gpg.txt +1 -1
index 0cb189a077..abfabd6d62 100644
@@ -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::
Signature · 1 line
2.35.0
#2 lore raw

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

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".

Quoted 10 lines
---
 Documentation/config/gpg.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/config/gpg.txt +0 -0
index 0cb189a077..abfabd6d62 100644

Documentation/config/gpg.txt gpg.minTrustLevel:: · line 40

Quoted 5 lines
Documentation/config/gpg.txt +1 -1
@@ -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>

#3 lore raw

v2 cover Apply minor fixes to Documentation/config/pgp.txt

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

Quoted 9 lines

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".

#4 lore raw

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

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

---
 Documentation/config/gpg.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/config/gpg.txt +1 -1
index 0cb189a077..abfabd6d62 100644
@@ -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::
Signature · 1 line
2.35.0
#5 lore raw

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

Quoted 1 line · Greg Hurrell

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.

Quoted 19 lines
---
 Documentation/config/gpg.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/config/gpg.txt +1 -1
index 0cb189a077..abfabd6d62 100644
@@ -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::
#6 lore raw

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

Quoted 8 lines · Junio C Hamano
Quoted 1 line · Greg Hurrell

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

#7 lore raw

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

Quoted 5 lines · Greg Hurrell
Quoted 4 lines · Junio C Hamano
Quoted 1 line · Greg Hurrell

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

Quoted 8 lines
Quoted 4 lines

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.

#8 lore raw

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

In reply to Greg Hurrell

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

---
 Documentation/config/gpg.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/config/gpg.txt +1 -1
index abfabd6d62..86892ada77 100644
@@ -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
Signature · 1 line
2.35.0
#9 lore raw

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

Quoted 7 lines · Greg Hurrell

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

---
 Documentation/config/gpg.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Thanks. Will queue.

Quoted 13 lines
Documentation/config/gpg.txt +1 -1
index abfabd6d62..86892ada77 100644
@@ -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
#10 lore raw

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

In reply to Greg Hurrell

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

---
 Documentation/config/gpg.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/config/gpg.txt +1 -1
index abfabd6d62..86892ada77 100644
@@ -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
Signature · 1 line
2.35.0