From: Jeff King <peff@peff.net>
To: "brian m. carlson" <sandals@crustytoothpaste.net>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>,
Emily Shaffer <emilyshaffer@google.com>
Subject: Re: [PATCH v4 1/5] doc: move author and committer information to git-commit(1)
Date: Mon, 20 Jan 2020 12:52:10 -0500 [thread overview]
Message-ID: <20200120175210.GA3989@coredump.intra.peff.net> (raw)
In-Reply-To: <20200120173343.4102954-2-sandals@crustytoothpaste.net>
On Mon, Jan 20, 2020 at 05:33:39PM +0000, brian m. carlson wrote:
> 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...
> @@ -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
next prev parent reply other threads:[~2020-01-20 17:52 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-20 17:33 [PATCH v4 0/6] Documentation for common user misconceptions brian m. carlson
2020-01-20 17:33 ` [PATCH v4 1/5] doc: move author and committer information to git-commit(1) brian m. carlson
2020-01-20 17:52 ` Jeff King [this message]
2020-01-20 19:22 ` brian m. carlson
2020-01-21 22:24 ` Junio C Hamano
2020-01-21 22:23 ` Junio C Hamano
2020-01-20 17:33 ` [PATCH v4 2/5] docs: expand on possible and recommended user config options brian m. carlson
2020-01-20 17:33 ` [PATCH v4 3/5] doc: provide guidance on user.name format brian m. carlson
2020-01-21 22:35 ` Junio C Hamano
2020-01-20 17:33 ` [PATCH v4 4/5] doc: dissuade users from trying to ignore tracked files brian m. carlson
2020-01-20 17:54 ` Jeff King
2020-01-20 17:33 ` [PATCH v4 5/5] docs: mention when increasing http.postBuffer is valuable brian m. carlson
2020-01-20 17:55 ` [PATCH v4 0/6] Documentation for common user misconceptions Jeff King
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=20200120175210.GA3989@coredump.intra.peff.net \
--to=peff@peff.net \
--cc=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=sandals@crustytoothpaste.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).