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
Jeff King <peff@peff.net>
Date
Jan 20, 2020, 17:52 UTC
Message-ID
<20200120175210.GA3989@coredump.intra.peff.net>
In-Reply-To
<20200120173343.4102954-2-sandals@crustytoothpaste.net>
On Mon, Jan 20, 2020 at 05:33:39PM +0000, brian m. carlson wrote:
Show 15 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.
> +
>  OPTIONS
>  -------
>  <tree>::
This text got moved up, which kind of make sense to me, but...
Show 27 quoted lines
> @@ -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
> -committer information is taken from the following environment variables,
> -if set:
> -
> -	GIT_AUTHOR_NAME
> -	GIT_AUTHOR_EMAIL
> -	GIT_AUTHOR_DATE
> -	GIT_COMMITTER_NAME
> -	GIT_COMMITTER_EMAIL
> -	GIT_COMMITTER_DATE
> -
> -(nb "<", ">" and "\n"s are stripped)
> -
> -In case (some of) these environment variables are not set, the information
> -is taken from the configuration items user.name and user.email, or, if not
> -present, the environment variable EMAIL, or, if that is not set,
> -system user name and the hostname used for outgoing mail (taken
> -from `/etc/mailname` and falling back to the fully qualified hostname when
> -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.

it stayed here, so now it's duplicated. Should the old one be dropped? Or is moving the new text a leftover mistake from rebasing (IIRC, in your original you dropped this whole "here's how commits work" section).

Other than that, the patch looks good to me.
-Peff
Previous: brian m. carlsonNext: brian m. carlson
Message 6 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.