git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v4 1/5] doc: move author and committer information to git-commit(1)

From
Junio C Hamano <gitster@pobox.com>
Date
Jan 21, 2020, 22:23 UTC
Message-ID
<xmqqd0bc8n4k.fsf@gitster-ct.c.googlers.com>
In-Reply-To
<20200120173343.4102954-2-sandals@crustytoothpaste.net>
"brian m. carlson" <sandals@crustytoothpaste.net> writes:
Show 10 quoted lines
> diff --git a/Documentation/config/user.txt b/Documentation/config/user.txt
> index 0557cbbceb..a1f80e823c 100644
> --- a/Documentation/config/user.txt
> +++ b/Documentation/config/user.txt
> @@ -13,7 +13,7 @@ committer.email::
>  	Also, all of these can be overridden by the `GIT_AUTHOR_NAME`,
>  	`GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_NAME`,
>  	`GIT_COMMITTER_EMAIL` and `EMAIL` environment variables.
> -	See linkgit:git-commit-tree[1] for more information.
> +	See linkgit:git-commit[1] for more information.

Makes sense---it is consistent with the goal of making the documentation of "git commit" Porcelain the central place for authorship and committer information.

Show 11 quoted lines
> diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt
> index 4b90b9c12a..adc2e0d4b7 100644
> --- a/Documentation/git-commit-tree.txt
> +++ b/Documentation/git-commit-tree.txt
> @@ -42,6 +42,10 @@ tend to just write the result to the file that is pointed at by
>  `.git/HEAD`, so that we can always see what the last committed
>  state was.
>  
> +A commit comment is read from stdin. If a changelog
> +entry is not provided via "<" redirection, 'git commit-tree' will just wait
> +for one to be entered and terminated with ^D.

This is copied from the end of the "commit information" section, without the original getting removed (see the post-context of the hunk that begins at l.79/l.82). Intended?

I haven't seen anybody use the phrase "commit comment" in the reviews on this list for long time; the phrase somehow feels outdated. The pretty formats section in "git log --help" calls this "commit message". "log message" may also be more common.

Show 20 quoted lines
> @@ -69,7 +73,6 @@ OPTIONS
>  	Do not GPG-sign commit, to countermand a `--gpg-sign` option
>  	given earlier on the command line.
>  
> -
>  Commit Information
>  ------------------
>  
> @@ -79,26 +82,6 @@ A commit encapsulates:
>  - author name, email and date
>  - committer name and email and the commit time.
>  
> -While parent object ids are provided on the command line, author and
> -...
> -that file does not exist).
> -
>  A commit comment is read from stdin. If a changelog
>  entry is not provided via "<" redirection, 'git commit-tree' will just wait
>  for one to be entered and terminated with ^D.
> @@ -117,6 +100,7 @@ FILES
Previous: Junio C HamanoNext: brian m. carlson
Message 9 of 13 in “Documentation for common user misconceptions”
  1. 0/6 Documentation for common user misconceptionsbrian m. carlson, Jan 20, 2020
  2. 2/5 docs: expand on possible and recommended user config optionsbrian m. carlson, Jan 20, 2020
  3. 4/5 doc: dissuade users from trying to ignore tracked filesbrian m. carlson, Jan 20, 2020
  4. Jeff KingJan 20, 2020
  5. 1/5 doc: move author and committer information to git-commit(1)brian m. carlson, Jan 20, 2020
  6. Jeff KingJan 20, 2020
  7. brian m. carlsonJan 20, 2020
  8. Junio C HamanoJan 21, 2020
  9. Junio C HamanoJan 21, 2020
  10. 5/5 docs: mention when increasing http.postBuffer is valuablebrian m. carlson, Jan 20, 2020
  11. 3/5 doc: provide guidance on user.name formatbrian m. carlson, Jan 20, 2020
  12. Junio C HamanoJan 21, 2020
  13. Jeff KingJan 20, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.