summaryrefslogtreecommitdiff
path: root/wt-status.h
diff options
context:
space:
mode:
authorLibravatar Jeff King <peff@peff.net>2021-12-15 11:23:48 -0500
committerLibravatar Junio C Hamano <gitster@pobox.com>2021-12-15 11:55:20 -0800
commitacd78728bbb95052406015acf7d0807e777631dd (patch)
tree0957d29074a993c9ef1619ea84aaf9321df55e4b /wt-status.h
parentThe second batch (diff)
downloadtgif-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>
Diffstat (limited to 'wt-status.h')
0 files changed, 0 insertions, 0 deletions