git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
* Bug report: Parameters for the `prepare-commit-msg` hook could use better documentation.
@ 2020-05-26 23:43 Dan Rose
  0 siblings, 0 replies; only message in thread
From: Dan Rose @ 2020-05-26 23:43 UTC (permalink / raw)
  To: git

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.

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2020-05-26 23:43 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-05-26 23:43 Bug report: Parameters for the `prepare-commit-msg` hook could use better documentation Dan Rose

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).