Skip to content

Commit acd7872

Browse files
peffgitster
authored andcommitted
doc/config: mark ssh allowedSigners example as literal
The discussion for gpg.ssh.allowedSignersFile shows an example string that contains "[email protected],[email protected]". 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.: [email protected][1],[email protected][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. [email protected] mailto:[email protected] 2. [email protected] mailto:[email protected] 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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent e773545 commit acd7872

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Documentation/config/gpg.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ gpg.ssh.allowedSignersFile::
4444
A file containing ssh public keys which you are willing to trust.
4545
The file consists of one or more lines of principals followed by an ssh
4646
public key.
47-
e.g.: [email protected],[email protected] ssh-rsa AAAAX1...
47+
e.g.: `[email protected],[email protected] ssh-rsa AAAAX1...`
4848
See ssh-keygen(1) "ALLOWED SIGNERS" for details.
4949
The principal is only used to identify the key and is available when
5050
verifying a signature.

0 commit comments

Comments
 (0)