mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Junio C Hamano <junkio@cox.net>
To: Paul Jackson <pj@sgi.com>
Cc: linux-kernel@vger.kernel.org
Subject: Re: [PATCHv4] Document from line in patch format
Date: Mon, 03 Oct 2005 01:08:20 -0700	[thread overview]
Message-ID: <7vfyrjt43v.fsf@assigned-by-dhcp.cox.net> (raw)
In-Reply-To: <20051002225734.73dba354.pj@sgi.com> (Paul Jackson's message of "Sun, 2 Oct 2005 22:57:34 -0700")

> +    Subject: [PATCH 001/123] [<area>:] <explanation>

What's funny is that the first pair is literal and the second
one is syntactic.  Perhaps you may want to do an EBNF ;-)?

SUBJECT ::= "Subject: [PATCH" NUMBER "/" NUMBER "]" [ AREA ":" ] EXPLANATION

Although the current explanation tells careful readers that
"From: " in the body is optional, by mentioning what happens if
it is not found, I think it is clearer if you said it upfront.

Maybe something along the lines of:

    The body of the message should be structured as follows.

    - an optional in-body "From: " line (plus an empty line for
      readability), if the author is different from the e-mail
      patch forwarder/sender; followed by

    - the explanation to be recorded as the commit log message;
      followed by

    - an empty line, and signed-off-by lines; followed by

    - mandatory three-dash '---' line; followed by

    - optional non-diff metainformation -- justification message
      to the maintainer, diffstat etc.

    - actual patch material.

I do not know if Linus wants to advertise this, but in addition
to the in-body "From: ", the e-mail patch application tool from
GIT also understands in-body "Date: ", if the patch forwarder
wants to preserve original authorship datestamp in the commit
the maintainer eventually makes out of your e-mail.  Without it,
the "Date: " of the forwarder's e-mail is used as the authorship
datestamp.


  reply	other threads:[~2005-10-03  8:08 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <mailman.1128301576.22577.linux-kernel2news@redhat.com>
2005-10-03  5:30 ` Pete Zaitcev
2005-10-03  5:57   ` Paul Jackson
2005-10-03  8:08     ` Junio C Hamano [this message]
2005-10-03  8:32       ` Paul Jackson
2005-10-03  1:01 Paul Jackson

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=7vfyrjt43v.fsf@assigned-by-dhcp.cox.net \
    --to=junkio@cox.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pj@sgi.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

all inboxes | Powered by JetHome®