{"thread":{"id":"57104","subject":"[PATCH] docs: add missing colon to Documentation/config/gpg.txt","startedAt":"2021-12-17T09:06:05Z","lastAt":"2021-12-17T16:19:49Z","messageCount":9,"participants":["Greg Hurrell","Eric Sunshine"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"444337","messageId":"1e5dba11-fa01-44e1-b341-9d69bbdbbd39@www.fastmail.com","threadId":"57104","inReplyTo":null,"subject":"[PATCH] docs: add missing colon to Documentation/config/gpg.txt","fromName":"Greg Hurrell","fromEmail":"greg@hurrell.net","sentAt":"2021-12-17T09:05:41Z","receivedAt":"2021-12-17T09:06:05Z","isPatch":true,"sender":{"key":"greg@hurrell.net","avatar":"https://avatars.githubusercontent.com/u/7074?v=4"},"body":"The missing colon here caused the docs to misrender in places such as:\n\n https://git-scm.com/docs/git-config\n\nwhere, the `gpg.ssh.defaultKeyCommand` option lacked bold styling and\ndidn't get an anchor link like its neighbors have; eg:\n\n https://git-scm.com/docs/git-config#Documentation/git-config.txt-gpgsshallowedSignersFile\n---\n Documentation/config/gpg.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt\nindex 4f30c7dbdd..94eba373cc 100644\n--- a/Documentation/config/gpg.txt\n+++ b/Documentation/config/gpg.txt\n@@ -34,7 +34,7 @@ gpg.minTrustLevel::\n * `fully`\n * `ultimate`\n \n-gpg.ssh.defaultKeyCommand:\n+gpg.ssh.defaultKeyCommand::\n \tThis command that will be run when user.signingkey is not set and a ssh\n \tsignature is requested. On successful exit a valid ssh public key is\n \texpected in the\tfirst line of its output. To automatically use the first\n-- \n2.33.0\n\n"},{"id":"444367","messageId":"CAPig+cTfL3e28geHMG6aga-1zSSYSgXknQKO-62msn3LO=+iZA@mail.gmail.com","threadId":"57104","inReplyTo":"1e5dba11-fa01-44e1-b341-9d69bbdbbd39@www.fastmail.com","subject":"Re: [PATCH] docs: add missing colon to Documentation/config/gpg.txt","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2021-12-17T15:44:08Z","receivedAt":"2021-12-17T15:44:21Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Fri, Dec 17, 2021 at 7:13 AM Greg Hurrell wrote:\n> The missing colon here caused the docs to misrender in places such as:\n>\n> https://git-scm.com/docs/git-config\n>\n> where, the `gpg.ssh.defaultKeyCommand` option lacked bold styling and\n> didn't get an anchor link like its neighbors have; eg:\n>\n> https://git-scm.com/docs/git-config#Documentation/git-config.txt-gpgsshallowedSignersFile\n> ---\n\nThanks, this fix is \"obviously correct\".\n\nPlease add your Signed-off-by: at the end of the commit message.\n\nMinor: The commit message could work just as well without mentioning a\nparticular site hosting documentation, so something like this would\nalso be fine:\n\n Add missing colon to ensure correct rendering of definition list\n item. Without the proper number of colons, it renders as just\n another top-level paragraph rather than a list item.\n\n> diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt\n> @@ -34,7 +34,7 @@ gpg.minTrustLevel::\n> -gpg.ssh.defaultKeyCommand:\n> +gpg.ssh.defaultKeyCommand::\n> This command that will be run when user.signingkey is not set and a ssh\n> signature is requested. On successful exit a valid ssh public key is\n> expected in the first line of its output. To automatically use the first\n\nIf you want to tackle them, some other fixes would be:\n\n* \"This _is the_ command that...\" or \"This command will be...\"\n\n* in user-facing documentation, we use camelCase for configuration\nnames, so \"user.signingkey\" should be \"user.signingKey\"\n\n* s/ssh/SSH/\n\n* s/exit/exit,/\n"},{"id":"444368","messageId":"CAPig+cSd8wpFM4CgHr-BUn0cWSTPJr_C2ahUaSJ=XMbMjDv_0Q@mail.gmail.com","threadId":"57104","inReplyTo":"CAPig+cTfL3e28geHMG6aga-1zSSYSgXknQKO-62msn3LO=+iZA@mail.gmail.com","subject":"Re: [PATCH] docs: add missing colon to Documentation/config/gpg.txt","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2021-12-17T15:48:03Z","receivedAt":"2021-12-17T15:48:15Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Fri, Dec 17, 2021 at 10:44 AM Eric Sunshine wrote:\n> > +gpg.ssh.defaultKeyCommand::\n> > This command that will be run when user.signingkey is not set and a ssh\n> > signature is requested. On successful exit a valid ssh public key is\n> > expected in the first line of its output. To automatically use the first\n>\n> If you want to tackle them, some other fixes would be:\n>\n> * \"This _is the_ command that...\" or \"This command will be...\"\n>\n> * in user-facing documentation, we use camelCase for configuration\n> names, so \"user.signingkey\" should be \"user.signingKey\"\n>\n> * s/ssh/SSH/\n>\n> * s/exit/exit,/\n\nOh, I forgot to mention that we typically want to use backticks to\ntypeset text with fixed-width font for elements such as:\n\n `user.signingKey`\n `ssh-agent`\n `ssh-add -L`\n"},{"id":"444369","messageId":"20211217161138.14771-1-greg@hurrell.net","threadId":"57104","inReplyTo":"CAPig+cTfL3e28geHMG6aga-1zSSYSgXknQKO-62msn3LO=+iZA@mail.gmail.com","subject":"[PATCH v2] docs: add missing colon to Documentation/config/gpg.txt","fromName":"Greg Hurrell","fromEmail":"greg@hurrell.net","sentAt":"2021-12-17T16:11:37Z","receivedAt":"2021-12-17T16:11:48Z","isPatch":true,"sender":{"key":"greg@hurrell.net","avatar":"https://avatars.githubusercontent.com/u/7074?v=4"},"body":"Just added a Signed-off-by and reworded the commit message\nas suggested by Eric Sunshine. There are other fixes that could\nbe applied to other places in this documentation (eg. backticks,\ncapitalization fixes etc) but my intent here was just to fix the\nmost jarring problem.\n\n"},{"id":"444370","messageId":"20211217161320.15311-1-greg@hurrell.net","threadId":"57104","inReplyTo":"CAPig+cTfL3e28geHMG6aga-1zSSYSgXknQKO-62msn3LO=+iZA@mail.gmail.com","subject":"[PATCH v2] docs: add missing colon to Documentation/config/gpg.txt","fromName":"Greg Hurrell","fromEmail":"greg@hurrell.net","sentAt":"2021-12-17T16:13:19Z","receivedAt":"2021-12-17T16:13:30Z","isPatch":true,"sender":{"key":"greg@hurrell.net","avatar":"https://avatars.githubusercontent.com/u/7074?v=4"},"body":"Just added a Signed-off-by and reworded the commit message\nas suggested by Eric Sunshine. There are other fixes that could\nbe applied to other places in this documentation (eg. backticks,\ncapitalization fixes etc) but my intent here was just to fix the\nmost jarring problem.\n\n"},{"id":"444371","messageId":"20211217161359.15360-1-greg@hurrell.net","threadId":"57104","inReplyTo":"CAPig+cTfL3e28geHMG6aga-1zSSYSgXknQKO-62msn3LO=+iZA@mail.gmail.com","subject":"[PATCH v2] docs: add missing colon to Documentation/config/gpg.txt","fromName":"Greg Hurrell","fromEmail":"greg@hurrell.net","sentAt":"2021-12-17T16:13:58Z","receivedAt":"2021-12-17T16:14:12Z","isPatch":true,"sender":{"key":"greg@hurrell.net","avatar":"https://avatars.githubusercontent.com/u/7074?v=4"},"body":"Just added a Signed-off-by and reworded the commit message\nas suggested by Eric Sunshine. There are other fixes that could\nbe applied to other places in this documentation (eg. backticks,\ncapitalization fixes etc) but my intent here was just to fix the\nmost jarring problem.\n\n"},{"id":"444372","messageId":"20211217161718.15767-1-greg@hurrell.net","threadId":"57104","inReplyTo":"CAPig+cTfL3e28geHMG6aga-1zSSYSgXknQKO-62msn3LO=+iZA@mail.gmail.com","subject":"[PATCH v2] docs: add missing colon to Documentation/config/gpg.txt","fromName":"Greg Hurrell","fromEmail":"greg@hurrell.net","sentAt":"2021-12-17T16:17:17Z","receivedAt":"2021-12-17T16:17:31Z","isPatch":true,"sender":{"key":"greg@hurrell.net","avatar":"https://avatars.githubusercontent.com/u/7074?v=4"},"body":"Just added a Signed-off-by and reworded the commit message\nas suggested by Eric Sunshine. There are other fixes that could\nbe applied to other places in this documentation (eg. backticks,\ncapitalization fixes etc) but my intent here was just to fix the\nmost jarring problem.\n\n"},{"id":"444373","messageId":"20211217161718.15767-2-greg@hurrell.net","threadId":"57104","inReplyTo":"20211217161718.15767-1-greg@hurrell.net","subject":"[PATCH v2] docs: add missing colon to Documentation/config/gpg.txt","fromName":"Greg Hurrell","fromEmail":"greg@hurrell.net","sentAt":"2021-12-17T16:17:18Z","receivedAt":"2021-12-17T16:17:39Z","isPatch":true,"sender":{"key":"greg@hurrell.net","avatar":"https://avatars.githubusercontent.com/u/7074?v=4"},"body":"Add missing colon to ensure correct rendering of definition list\nitem. Without the proper number of colons, it renders as just another\ntop-level paragraph rather than a list item.\n\nSigned-off-by: Greg Hurrell \n---\n Documentation/config/gpg.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt\nindex 4f30c7dbdd..94eba373cc 100644\n--- a/Documentation/config/gpg.txt\n+++ b/Documentation/config/gpg.txt\n@@ -34,7 +34,7 @@ gpg.minTrustLevel::\n * `fully`\n * `ultimate`\n \n-gpg.ssh.defaultKeyCommand:\n+gpg.ssh.defaultKeyCommand::\n \tThis command that will be run when user.signingkey is not set and a ssh\n \tsignature is requested. On successful exit a valid ssh public key is\n \texpected in the\tfirst line of its output. To automatically use the first\n-- \n2.33.0\n\n"},{"id":"444374","messageId":"c1f8f248-5e27-4b99-b186-9c0830dd22b6@www.fastmail.com","threadId":"57104","inReplyTo":"20211217161718.15767-2-greg@hurrell.net","subject":"Re: [PATCH v2] docs: add missing colon to Documentation/config/gpg.txt","fromName":"Greg Hurrell","fromEmail":"greg@hurrell.net","sentAt":"2021-12-17T16:19:25Z","receivedAt":"2021-12-17T16:19:49Z","isPatch":true,"sender":{"key":"greg@hurrell.net","avatar":"https://avatars.githubusercontent.com/u/7074?v=4"},"body":"Sorry about all the duplicate messages sent previously — I\nwas dusting off `git send-email` for the first time in a long time\nand thought they were dry runs, but evidently they were not.\n\n🤦\n\nOn Fri, Dec 17, 2021, at 5:17 PM, Greg Hurrell wrote:\n> Add missing colon to ensure correct rendering of definition list\n> item. Without the proper number of colons, it renders as just another\n> top-level paragraph rather than a list item.\n> \n> Signed-off-by: Greg Hurrell \n> ---\n> Documentation/config/gpg.txt | 2 +-\n> 1 file changed, 1 insertion(+), 1 deletion(-)\n> \n> diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.txt\n> index 4f30c7dbdd..94eba373cc 100644\n> --- a/Documentation/config/gpg.txt\n> +++ b/Documentation/config/gpg.txt\n> @@ -34,7 +34,7 @@ gpg.minTrustLevel::\n> * `fully`\n> * `ultimate`\n> \n> -gpg.ssh.defaultKeyCommand:\n> +gpg.ssh.defaultKeyCommand::\n> This command that will be run when user.signingkey is not set and a ssh\n> signature is requested. On successful exit a valid ssh public key is\n> expected in the first line of its output. To automatically use the first\n> -- \n> 2.33.0\n> \n> \n"}]}