all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Noam Postavsky <npostavs@gmail.com>
To: esr@thyrsus.com
Cc: Paul Eggert <eggert@cs.ucla.edu>, Emacs developers <emacs-devel@gnu.org>
Subject: Re: Use of "Action stamps" in commit messages
Date: Fri, 13 Jul 2018 22:45:47 -0400	[thread overview]
Message-ID: <CAM-tV-_PwKHsW=TNRucZ7E7utECY42nqfbFXWLhBOzKEkLZ09Q@mail.gmail.com> (raw)
In-Reply-To: <20180713181520.GD28072@thyrsus.com>

On 13 July 2018 at 14:15, Eric S. Raymond <esr@thyrsus.com> wrote:

> If you're going to do this, please at least have mercy on future translators
> and use a strict RFC3339 date format the way action stamps do.
>
> I'm against this change because I think in the long term.  Someday Emacs
> will change VCSes again.  On the day, whoever is charged with the move is
> going to curse the perpetrators if he has to deal with a semi-infinite number
> of variant ways of pasting together the data and commit parts of your
> proposed IDs.

I think this thread has somewhat wondered away from what I was
proposing. Currently CONTRIBUTE recommends two ways to refer to
another commit in a commit message:

1. Quoting the summary line.
2. Action stamp

I want to change to just the first:

1. Quoting the summary line

And possibly suggest adding the date before the summary line, as
having a vague idea of how long ago a change was can be helpful. This
is VCS agnostic, so there should be no need for any manipulation when
we move VCS.

> I know of two efforts underway to make cgit and git itself aware of the
> action-stamp format. Have patience.  Soon enough you'll be able to treat
> action stampts as hotlinks that your software will chase for you.

I guess that might be nice, but really, usually having the summary
line gives enough info that I don't even need to chase anything down.
So I consider this better than both hash ids and action stamps. And if
I really do need to look at the referenced commit, then git log --grep
already works. And I think we can safely assume that any other VCS
will support searching for a string in the commit logs, unlike
action-stamp support, which may or may not be supported for any given
VCS.

The action-stamp format is great for the reposurgeon software, but
commit messages are for humans.



  parent reply	other threads:[~2018-07-14  2:45 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 ` Use of "Action stamps" in commit messages Andy Moreton
2018-07-13 13:45   ` 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 [this message]
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

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

  git send-email \
    --in-reply-to='CAM-tV-_PwKHsW=TNRucZ7E7utECY42nqfbFXWLhBOzKEkLZ09Q@mail.gmail.com' \
    --to=npostavs@gmail.com \
    --cc=eggert@cs.ucla.edu \
    --cc=emacs-devel@gnu.org \
    --cc=esr@thyrsus.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.
Code repositories for project(s) associated with this external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.