diff options
| author |  Jeff King <peff@peff.net> | 2021-12-15 11:23:48 -0500 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2021-12-15 11:55:20 -0800 |
| commit | acd78728bbb95052406015acf7d0807e777631dd (patch) | |
| tree | 0957d29074a993c9ef1619ea84aaf9321df55e4b | |
| parent | The second batch (diff) | |
| download | tgif-acd78728bbb95052406015acf7d0807e777631dd.tar.xz | |
doc/config: mark ssh allowedSigners example as literal
The discussion for gpg.ssh.allowedSignersFile shows an example string
that contains "user1@example.com,user2@example.com". Asciidoc thinks
these are real email addresses and generates "mailto" footnotes for
them. This makes the rendered content more confusing, as it has extra
"[1]" markers:
The file consists of one or more lines of principals followed by an
ssh public key. e.g.: user1@example.com[1],user2@example.com[2]
ssh-rsa AAAAX1... See ssh-keygen(1) "ALLOWED SIGNERS" for details.
and also generates pointless notes at the end of the page:
NOTES
1. user1@example.com
mailto:user1@example.com
2. user2@example.com
mailto:user2@example.com
We can fix this by putting the example into a backtick literal block.
That inhibits the mailto generation, and as a bonus typesets the example
text in a way that sets it off from the regular prose (a tt font for
html, or bold in the roff manpage).
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/config/gpg.txt | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt index 4f30c7dbdd..7875f4fccc 100644 --- a/Documentation/config/gpg.txt +++ b/Documentation/config/gpg.txt @@ -44,7 +44,7 @@ gpg.ssh.allowedSignersFile:: A file containing ssh public keys which you are willing to trust. The file consists of one or more lines of principals followed by an ssh public key. - e.g.: user1@example.com,user2@example.com ssh-rsa AAAAX1... + e.g.: `user1@example.com,user2@example.com ssh-rsa AAAAX1...` See ssh-keygen(1) "ALLOWED SIGNERS" for details. The principal is only used to identify the key and is available when verifying a signature. |