unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Andy Moreton <andrewjmoreton@gmail.com>
To: emacs-devel@gnu.org
Subject: Re: Use of "Action stamps" in commit messages
Date: Fri, 13 Jul 2018 13:59:32 +0100	[thread overview]
Message-ID: <vz1sh4n2swb.fsf@gmail.com> (raw)
In-Reply-To: CAM-tV--EUTEWKybp+poKd482aCCViW0rDPc7XG3TUwiwqxnE6g@mail.gmail.com

On Fri 13 Jul 2018, Noam Postavsky wrote:

> .On 12 July 2018 at 11:34, Basil L. Contovounesios <contovob@tcd.ie> wrote:
>
>> from CONTRIBUTE:
>>
>>   One way to identify revisions is by quoting their summary line.
>>   Another is with an action stamp - an RFC3339 date followed by !
>>   followed by the committer's email - for example,
>>   "2014-01-16T05:43:35Z!esr@thyrsus.com".
>
> This reminds that I'd like to remove this "Action stamp" thing as
> commit message convention. Action stamps are fine for what they were
> designed for: acting as a unique commit id for the repository
> conversion software "reposurgeon", but they are not very friendly to
> human readers.
>
> A date followed by the summary line is sufficient to identify a commit
> in a vc system agnostic way, reads nicer, and gives more info up front
> to a human.
>
> See also Bug#20609.
>
> https://debbugs.gnu.org/cgi/bugreport.cgi?bug=20609

The Linux kernel convention is nicer: the (shortened) commit id,
followed by a space and the commit summary line, e.g.

Fixes: 1222ff5275 ("Don't skip epg-tests even with gpg 2.0 (Bug#23561)")

This ensures that the format is human readable, is easy to parse for
scripting, and identifies the right commit even if the shortened commit
id is not unique.

     AndyM





  parent reply	other threads:[~2018-07-13 12:59 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-07-13  9:13 Use of "Action stamps" in commit messages (WAS: [Emacs-diffs] master babe0d4: Rearrange definition of zerop in subr.el) Noam Postavsky
2018-07-13 12:01 ` Eli Zaretskii
2018-07-13 12:59 ` Andy Moreton [this message]
2018-07-13 13:45   ` Use of "Action stamps" in commit messages Eli Zaretskii
2018-07-13 15:01     ` Andy Moreton
2018-07-13 15:05       ` Eli Zaretskii
2018-07-13 17:07     ` Radon Rosborough
2018-07-13 17:24       ` Yuri Khan
2018-07-13 17:30         ` Radon Rosborough
2018-07-13 17:38           ` Eli Zaretskii
2018-07-13 17:34       ` Eli Zaretskii
2018-07-13 18:17     ` John Yates
2018-07-13 18:48       ` Eli Zaretskii
2018-07-13 15:25 ` Paul Eggert
2018-07-13 18:15   ` Eric S. Raymond
2018-07-13 18:59     ` Eli Zaretskii
2018-07-13 19:06       ` Eric S. Raymond
2018-07-13 19:30         ` Eli Zaretskii
2018-07-13 20:10           ` Paul Eggert
2018-07-13 20:47             ` Eric S. Raymond
2018-07-14  7:08             ` Eli Zaretskii
2018-07-14 14:38               ` Paul Eggert
2018-07-14 15:48                 ` Eli Zaretskii
2018-07-14  9:49         ` Andy Moreton
2018-07-14  2:45     ` Noam Postavsky
2018-07-14  2:51       ` Brett Gilio

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

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=vz1sh4n2swb.fsf@gmail.com \
    --to=andrewjmoreton@gmail.com \
    --cc=emacs-devel@gnu.org \
    /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.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

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).