From: Segher Boessenkool <segher@kernel.crashing.org>
To: Jonathan Wakely <jwakely@redhat.com>
Cc: Martin Sebor <msebor@gmail.com>, Martin Sebor <msebor@redhat.com>,
gcc Patches <gcc-patches@gcc.gnu.org>
Subject: Re: [RFC] [wwwdocs] Rewrite docs on commit message and patch format
Date: Tue, 15 Jun 2021 07:21:12 -0500 [thread overview]
Message-ID: <20210615122112.GE5077@gate.crashing.org> (raw)
In-Reply-To: <CACb0b4nzMFWv0xtT43d5K_L5vvWLm=yrk=1XDchKaJ05b2-bLQ@mail.gmail.com>
On Tue, Jun 15, 2021 at 10:39:58AM +0100, Jonathan Wakely via Gcc-patches wrote:
> I think suggesting a single format (but allowing variations on it) is
> **much** better than not saying anything at all. For new contributors
> it's helpful to say "this is what we want" so they have a guideline to
> follow.
Most people are smart enough to look at what others do and think about
why they do things that way, I hope. And then think what is best for
themselves. Maybe I am too optimistic :-)
> <p>A major benefit of a good, descriptive subject line is that it makes
> the output of <code>git log --oneline</code> more useful. Including the
> component tag and bug number(s) helps with that, but isn't compulsory
> if the subject is already clear and has enough context.</p>
The tags and the PR # are the least important things in the patch
subject. If you can fit them in (without blowing the 50 char limit)
then sure; and as I said before, well-chosen headings can be shorter
than free-form text expressing the same.
Segher
next prev parent reply other threads:[~2021-06-15 12:22 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-14 16:25 Jonathan Wakely
2021-06-15 0:12 ` Martin Sebor
2021-06-15 9:39 ` Jonathan Wakely
2021-06-15 12:21 ` Segher Boessenkool [this message]
2021-06-15 17:37 ` Martin Sebor
2021-06-15 12:10 ` Segher Boessenkool
2021-06-15 9:30 ` Jonathan Wakely
2021-06-15 12:02 ` Segher Boessenkool
2021-06-15 12:00 ` Segher Boessenkool
2021-06-15 13:12 ` Jonathan Wakely
2021-06-15 14:24 ` Segher Boessenkool
2021-06-15 15:01 ` Jonathan Wakely
2021-06-15 15:04 ` Jakub Jelinek
2021-06-15 15:20 ` Segher Boessenkool
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=20210615122112.GE5077@gate.crashing.org \
--to=segher@kernel.crashing.org \
--cc=gcc-patches@gcc.gnu.org \
--cc=jwakely@redhat.com \
--cc=msebor@gmail.com \
--cc=msebor@redhat.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 read-only IMAP folder(s) and NNTP newsgroup(s).