From: Junio C Hamano <gitster@pobox.com>
To: Paul Menzel <pmenzel@molgen.mpg.de>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] Documentation: Mention `Date: ` in git-am
Date: Fri, 03 Jan 2020 19:33:55 -0800 [thread overview]
Message-ID: <xmqqblrjdhek.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <6ffcb6c0-d09e-45c4-d264-8a9024b67f3c@molgen.mpg.de> (Paul Menzel's message of "Fri, 3 Jan 2020 16:05:46 +0100")
Paul Menzel <pmenzel@molgen.mpg.de> writes:
> Subject: Re: [PATCH] Documentation: Mention `Date: ` in git-am
The technical term to refer to these From/Subject/Date override is
"in-body header", and using it would make it easier to tell what the
commit is about when this appears in "git shortlog" output. Perhaps
am: document that Date: can appear as an in-body header
> Date: Fri, 3 Jan 2020 12:48:46 +0100
When the general public sees the patch for the first time is when
the patch is authored as far as the participants of this list are
concerned.
Please don't lie about the author date on this list.
> Tested, that a line `Date: ` in the message body will be preferred by
> `git am` over the one in the message header. So, update the
> documentation.
>
> Signed-off-by: Paul Menzel <pmenzel@molgen.mpg.de>
> ---
> Documentation/git-am.txt | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
> index fc5750b3b8..11ca61b00b 100644
> --- a/Documentation/git-am.txt
> +++ b/Documentation/git-am.txt
> @@ -190,8 +190,8 @@ the commit, after stripping common prefix "[PATCH <anything>]".
> The "Subject: " line is supposed to concisely describe what the
> commit is about in one line of text.
>
> -"From: " and "Subject: " lines starting the body override the respective
> -commit author name and title values taken from the headers.
> +"From: ", "Date: ", and "Subject: " lines starting the body override the
> +respective commit author name and title values taken from the headers.
Correct. It would be a good idea to fix "will be preferred" in the
proposed log message to match this by reusing the verb "override".
Perhaps like
Similar to "From:" and "Subject:" already mentioned in the
documentation, "Date:" can also appear as an in-body header
to override the value in the e-mail headers. Document it.
> The commit message is formed by the title taken from the
> "Subject: ", a blank line and the body of the message up to
prev parent reply other threads:[~2020-01-04 3:34 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-03 15:05 [PATCH] Documentation: Mention `Date: ` in git-am Paul Menzel
2020-01-04 3:33 ` Junio C Hamano [this message]
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=xmqqblrjdhek.fsf@gitster-ct.c.googlers.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=pmenzel@molgen.mpg.de \
/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).