unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Romain Francoise <romain@orebokech.com>
Cc: emacs-devel@gnu.org
Subject: Header lines of commit messages
Date: Sat, 26 Jun 2010 13:43:37 +0300	[thread overview]
Message-ID: <83r5jucbvq.fsf@gnu.org> (raw)
In-Reply-To: "emacs-diffs-request@gnu.org"'s message of Sat, 26 Jun 2010	06:17:31 -0400

Commit messages such as the one below are not helpful:

    revno: 100645
    author: Carsten Dominik <carsten.dominik@gmail.com>
    committer: Romain Francoise <romain@orebokech.com>
    branch nick: trunk
    timestamp: Sat 2010-06-26 11:53:06 +0200
    message:
      Cherry-pick commit 8bd9308 from the org-mode Git repository.

      2010-06-26  Carsten Dominik  <carsten.dominik@gmail.com>

	    * org-agenda.el (org-agenda-goto-calendar): Do not bind obsolete
	    variables.

	    * org.el (calendar): Require calendar now on top level in org.el
	    and define aliases to new variables when needed.
	    (org-read-date, org-goto-calendar): Do not bind obsolete
	    variables.

The header line that summarizes the commit conveys useless
information.  It should state the essence of the change instead, so
that people who use "bzr log --line" will be able to grasp the purpose
of the change without looking at the full text.  The info about the
commit number, if it's deemed to be important, should be in the body
of the commit message, not in the header line.

TIA



             reply	other threads:[~2010-06-26 10:43 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-06-26 10:43 Eli Zaretskii [this message]
2010-06-26 13:33 ` Header lines of commit messages Romain Francoise
2010-06-26 15:01   ` Eli Zaretskii
2010-06-26 15:04   ` Stephen J. Turnbull
2010-06-26 15:27     ` Eli Zaretskii
2010-06-26 17:08       ` Stephen J. Turnbull
2010-06-26 18:16         ` Eli Zaretskii
2010-06-27 12:36           ` Stephen J. Turnbull
2010-06-30 18:36           ` Ted Zlatanov
2010-06-30 21:08             ` Eli Zaretskii
2010-07-01 13:02               ` Ted Zlatanov

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=83r5jucbvq.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=romain@orebokech.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 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).