git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Dan Rose <dan@digilabs.io>
To: git@vger.kernel.org
Subject: Bug report: Parameters for the `prepare-commit-msg` hook could use better documentation.
Date: Tue, 26 May 2020 18:43:00 -0500	[thread overview]
Message-ID: <CAJGDnb1eXBQtoAtGu6u7atmrHTbmtcBzuZpOixr2EWsLjD1SiA@mail.gmail.com> (raw)

Bug report: Parameters for the `prepare-commit-msg` hook could use
better documentation.

1. It's not clear under which circumstances the number of parameters
varies (e.g. "When there is no initial commit message text, the hook
gets one parameter. When the commit message is derived from another
commit, the hook gets three parameters. In all other cases, the hook
gets two parameters)
2. It is hard to tell what third parameter's relation to the preceding
list of commit message sources. Replacing the list with just the third
item shows that, grammatically, the documentation says the SHA-1 is
part of the second parameter: "The second is the source of the commit
message, and can be ... commit, followed by a commit SHA-1 (if a -c,
-C or --amend option was given)."
3. The types of values the third parameter can take include "HEAD", an
unambiguous sha-1 prefix, or seemingly any type of commit reference.
This is not documented.

                 reply	other threads:[~2020-05-26 23:43 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAJGDnb1eXBQtoAtGu6u7atmrHTbmtcBzuZpOixr2EWsLjD1SiA@mail.gmail.com \
    --to=dan@digilabs.io \
    --cc=git@vger.kernel.org \
    /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.
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 NNTP newsgroup(s).