git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Eric Sunshine <sunshine@sunshineco.com>
To: Greg Hurrell <greg@hurrell.net>
Cc: Git List <git@vger.kernel.org>
Subject: Re: [PATCH] docs: add missing colon to Documentation/config/gpg.txt
Date: Fri, 17 Dec 2021 10:48:03 -0500	[thread overview]
Message-ID: <CAPig+cSd8wpFM4CgHr-BUn0cWSTPJr_C2ahUaSJ=XMbMjDv_0Q@mail.gmail.com> (raw)
In-Reply-To: <CAPig+cTfL3e28geHMG6aga-1zSSYSgXknQKO-62msn3LO=+iZA@mail.gmail.com>

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`

  reply	other threads:[~2021-12-17 15:48 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-17  9:05 [PATCH] docs: add missing colon to Documentation/config/gpg.txt Greg Hurrell
2021-12-17 15:44 ` Eric Sunshine
2021-12-17 15:48   ` Eric Sunshine [this message]
2021-12-17 16:11   ` [PATCH v2] " Greg Hurrell
2021-12-17 16:13   ` Greg Hurrell
2021-12-17 16:13   ` Greg Hurrell
2021-12-17 16:17   ` Greg Hurrell
2021-12-17 16:17     ` Greg Hurrell
2021-12-17 16:19       ` Greg Hurrell

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='CAPig+cSd8wpFM4CgHr-BUn0cWSTPJr_C2ahUaSJ=XMbMjDv_0Q@mail.gmail.com' \
    --to=sunshine@sunshineco.com \
    --cc=git@vger.kernel.org \
    --cc=greg@hurrell.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).