Files
git/Documentation
Jeff King acd78728bb 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>
2021-12-15 11:55:20 -08:00
..
2021-12-10 14:35:16 -08:00
2021-12-10 14:35:13 -08:00
2020-08-04 18:34:02 -07:00
2021-10-25 09:12:56 -07:00
2021-09-28 10:31:02 -07:00
2021-12-10 14:35:03 -08:00
2021-12-10 14:35:03 -08:00
2021-09-28 10:31:02 -07:00
2021-12-10 14:35:03 -08:00
2021-12-10 14:35:04 -08:00
2019-05-07 13:04:48 +09:00
2021-10-29 15:43:13 -07:00
2019-10-21 12:02:39 +09:00