| Message ID | 1e5dba11-fa01-44e1-b341-9d69bbdbbd39@www.fastmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | docs: add missing colon to Documentation/config/gpg.txt | expand |
On Fri, Dec 17, 2021 at 7:13 AM Greg Hurrell <greg@hurrell.net> wrote: > The missing colon here caused the docs to misrender in places such as: > > https://git-scm.com/docs/git-config > > where, the `gpg.ssh.defaultKeyCommand` option lacked bold styling and > didn't get an anchor link like its neighbors have; eg: > > https://git-scm.com/docs/git-config#Documentation/git-config.txt-gpgsshallowedSignersFile > --- Thanks, this fix is "obviously correct". Please add your Signed-off-by: at the end of the commit message. Minor: The commit message could work just as well without mentioning a particular site hosting documentation, so something like this would also be fine: Add missing colon to ensure correct rendering of definition list item. Without the proper number of colons, it renders as just another top-level paragraph rather than a list item. > diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt > @@ -34,7 +34,7 @@ gpg.minTrustLevel:: > -gpg.ssh.defaultKeyCommand: > +gpg.ssh.defaultKeyCommand:: > This command that will be run when user.signingkey is not set and a ssh > signature is requested. On successful exit a valid ssh public key is > expected in the first line of its output. To automatically use the first If you want to tackle them, some other fixes would be: * "This _is the_ command that..." or "This command will be..." * in user-facing documentation, we use camelCase for configuration names, so "user.signingkey" should be "user.signingKey" * s/ssh/SSH/ * s/exit/exit,/
On Fri, Dec 17, 2021 at 10:44 AM Eric Sunshine <sunshine@sunshineco.com> wrote: > > +gpg.ssh.defaultKeyCommand:: > > This command that will be run when user.signingkey is not set and a ssh > > signature is requested. On successful exit a valid ssh public key is > > expected in the first line of its output. To automatically use the first > > If you want to tackle them, some other fixes would be: > > * "This _is the_ command that..." or "This command will be..." > > * in user-facing documentation, we use camelCase for configuration > names, so "user.signingkey" should be "user.signingKey" > > * s/ssh/SSH/ > > * s/exit/exit,/ Oh, I forgot to mention that we typically want to use backticks to typeset text with fixed-width font for elements such as: `user.signingKey` `ssh-agent` `ssh-add -L`
Just added a Signed-off-by and reworded the commit message as suggested by Eric Sunshine. There are other fixes that could be applied to other places in this documentation (eg. backticks, capitalization fixes etc) but my intent here was just to fix the most jarring problem.
Just added a Signed-off-by and reworded the commit message as suggested by Eric Sunshine. There are other fixes that could be applied to other places in this documentation (eg. backticks, capitalization fixes etc) but my intent here was just to fix the most jarring problem.
Just added a Signed-off-by and reworded the commit message as suggested by Eric Sunshine. There are other fixes that could be applied to other places in this documentation (eg. backticks, capitalization fixes etc) but my intent here was just to fix the most jarring problem.
Just added a Signed-off-by and reworded the commit message as suggested by Eric Sunshine. There are other fixes that could be applied to other places in this documentation (eg. backticks, capitalization fixes etc) but my intent here was just to fix the most jarring problem.
diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt index 4f30c7dbdd..94eba373cc 100644 --- a/Documentation/config/gpg.txt +++ b/Documentation/config/gpg.txt @@ -34,7 +34,7 @@ gpg.minTrustLevel:: * `fully` * `ultimate` -gpg.ssh.defaultKeyCommand: +gpg.ssh.defaultKeyCommand:: This command that will be run when user.signingkey is not set and a ssh signature is requested. On successful exit a valid ssh public key is expected in the first line of its output. To automatically use the first
The missing colon here caused the docs to misrender in places such as: https://git-scm.com/docs/git-config where, the `gpg.ssh.defaultKeyCommand` option lacked bold styling and didn't get an anchor link like its neighbors have; eg: https://git-scm.com/docs/git-config#Documentation/git-config.txt-gpgsshallowedSignersFile --- Documentation/config/gpg.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)