From: Fabian Stelzer <fs@gigacodes.de>
To: Jeff King <peff@peff.net>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] doc/config: mark ssh allowedSigners example as literal
Date: Thu, 16 Dec 2021 10:04:21 +0100 [thread overview]
Message-ID: <20211216090421.ckkuurql5dn2myux@fs> (raw)
In-Reply-To: <YboWlOG3vZD/7Osx@coredump.intra.peff.net>
On 15.12.2021 11:23, Jeff King wrote:
>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>
>---
>Possibly this could actually be done in a separate example block, but I
>think this looks OK and fixes the most obvious problem.
>
> Documentation/config/gpg.txt | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
>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.
>--
Thanks, this is obviously good. I don't think for this simple example an
extra block is not needed unless we want to document the other options the
allowedSigners file has in the git docs as well. I think it's better to
reference the ssh-keygen manpage though.
prev parent reply other threads:[~2021-12-16 9:04 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-15 16:23 [PATCH] doc/config: mark ssh allowedSigners example as literal Jeff King
2021-12-16 9:04 ` Fabian Stelzer [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20211216090421.ckkuurql5dn2myux@fs \
--to=fs@gigacodes.de \
--cc=git@vger.kernel.org \
--cc=peff@peff.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).