Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: "Doug Evans via gdb-patches" <gdb-patches@sourceware.org>
To: tromey@tromey.com, gdb-patches <gdb-patches@sourceware.org>
Subject: PSA: contribution checklist: format of git log entries
Date: Fri, 10 Feb 2017 00:16:00 -0000	[thread overview]
Message-ID: <CADPb22SqRJ27mhx6KrgLrbWQ3PjB5UcsMiPGcwNJTC+kORU3zw@mail.gmail.com> (raw)

Hi.

I was going to send this earlier but just never got around to it.
I think it was last year, or maybe even longer ago, someone (Gary?)
suggested adding paths to the ChangeLog files in the commit message.
It's fine by me, and it's in the contribution checklist:

https://sourceware.org/gdb/wiki/ContributionChecklist#Properly_Formatted_GNU_ChangeLog

I think things may have changed a bit as the format that's there now
is slightly different than I remember it. Anyways, it's in the
contribution checklist which I think we're all supposed to follow.

So heads up.

Instead of this:

    2017-02-03  Im Dave  <im@dave.com>

            * foo.c (bar): Fix baz.

    2017-02-03  Im Dave  <im@dave.com>

            * gdb.base/foo.exp: Add new tests.

This:

    gdb/ChangeLog:
    2017-02-03  Im Dave  <im@dave.com>

            * foo.c (bar): Fix baz.

    gdb/testsuite/ChangeLog:
    2017-02-03  Im Dave  <im@dave.com>

            * gdb.base/foo.exp: Add new tests.

Though lots of people do this in the commit message, which is fine too UUIC.

    gdb/ChangeLog:

            * foo.c (bar): Fix baz.

    gdb/testsuite/ChangeLog:

            * gdb.base/foo.exp: Add new tests.


             reply	other threads:[~2017-02-10  0:16 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-02-10  0:16 Doug Evans via gdb-patches [this message]
2017-02-10  0:30 ` Doug Evans via gdb-patches

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=CADPb22SqRJ27mhx6KrgLrbWQ3PjB5UcsMiPGcwNJTC+kORU3zw@mail.gmail.com \
    --to=gdb-patches@sourceware.org \
    --cc=dje@google.com \
    --cc=tromey@tromey.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