git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Stephen Smith <ishchis2@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 0/1] Add entry to mailmap file
Date: Fri, 06 Sep 2024 09:10:39 -0700	[thread overview]
Message-ID: <xmqq34mcyd8g.fsf@gitster.g> (raw)
In-Reply-To: <5909617.DvuYhMxLoT@thunderbird> (Stephen Smith's message of "Fri, 06 Sep 2024 08:49:53 -0700")

Stephen Smith <ishchis2@gmail.com> writes:

>> From: "Stephen P. Smith" <ishchis2@gmail.com>
>> 
>
> I don't know why git send-email added this extra From line to the body of the 
> email.  This line is not part of the file that format-patch created.

Most likely that the author name recorded in the commit object is
with "P.", but the name your MUA knows you as is without.

In such a case, the command adds what we call "in-body header" to
override the headers MUA uses (in this case, "From:" that the
recipient takes the authorship identity from).

As the name with "P." is what you signed-off your commit on the
"Signed-off-by:" trailer line, it is absolutely the right thing to
do to override the name MUA knows you as with the in-body header so
that the author name matches exactly the name used for signing it
off.  IOW, what you sent is perfectly fine.

For future reference, another header commonly overridden with an
in-body header is the "Subject:".  In a general discussion that is
not a review thread of any specific patch, somebody may come up with
a patch to improve the situtation.  In such a case, your message may
look like:

    From: A Project Participant <par@tici.pa.nt>
    Subject: Re: why does git do this?
    To: git@vger.kernel.org
    Cc: ...other particpants...

    Hmph, it does sound like a documentation bug.  How about
    clarifying it this way?

    ---- >8 ----
    Subject: doc: document the condition under which gostak distims the doshes

    The document does not exactly say when gostak distims the
    doshes.  Make sure it is clear by updating foo and bar
    documents.

    Signed-off-by: A Project Particpant <par@tici.pa.nt>
    ---

The "scissors" mark (horizontal line drawn with "-" with scissors ">8")
tells the recipient to ignore everything in the body before that line,
and then we have in-body Subject: header to override the "why does
git do this?" e-mail subject on the discussion thread with the title
of the commit.


      reply	other threads:[~2024-09-06 16:10 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-09-06 15:30 [PATCH 0/1] Add entry to mailmap file Stephen P. Smith
2024-09-06 15:30 ` [PATCH 1/1] .mailmap document current address Stephen P. Smith
2024-09-06 15:49 ` [PATCH 0/1] Add entry to mailmap file Stephen Smith
2024-09-06 16:10   ` 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=xmqq34mcyd8g.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=ishchis2@gmail.com \
    /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).