all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Alan Mackenzie <acm@muc.de>
To: Karl Fogel <kfogel@red-bean.com>
Cc: emacs-devel@gnu.org
Subject: Re: Summarizing the purpose of a change.
Date: Sat, 21 Nov 2009 12:19:50 +0000	[thread overview]
Message-ID: <20091121121950.GB2021@muc.de> (raw)
In-Reply-To: <87iqd4tkv4.fsf@red-bean.com>

Hi, Karl,

On Sat, Nov 21, 2009 at 01:09:19AM -0600, Karl Fogel wrote:
> I'm using the change below as an example for a more general question:

> In many projects, there is a convention of summarizing the purpose of a
> change in one or two sentences at the start of the log entry.  This
> makes the rest of the log entry (and the change itself) easier to
> understand.

> Could we try that in Emacs?  Or is there some reason we don't do it?

I do this every time.  So far, nobody's complained.

> For example, for the change below, even after reading the entire log
> entry it's hard to figure out what the committer's overall intention
> was.  Is it just a bunch of random improvements that happen to be sent
> in one commit?  Or is it a unified change group all made toward one
> overall purpose?  I'm not sure.  I guess I could figure it out if I
> looked at the diff, but the committer already knows the answer...

> (Nothing about this change looks wrong, I hasten to add, and it's great
> that Stefan is cleaning stuff up.  It would just a lot easier to
> evaluate the change, and follow what's going on in general, if one knew
> the intentions.  In this case, even just saying "Random code cleanups
> and minor bug fixes" would help set the right mood for the reviewer.)

Agreed.

> -Karl

-- 
Alan Mackenzie (Nuremberg, Germany).




  parent reply	other threads:[~2009-11-21 12:19 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <E1NBhoZ-0007oj-Uv@cvs.savannah.gnu.org>
2009-11-21  7:09 ` Summarizing the purpose of a change Karl Fogel
2009-11-21  8:07   ` Miles Bader
2009-11-21  9:11     ` Eli Zaretskii
2009-11-21 11:29       ` Giorgos Keramidas
2009-11-21 12:19   ` Alan Mackenzie [this message]
2009-11-21 12:43     ` Eli Zaretskii
2009-11-22 17:02       ` Karl Fogel
2009-11-23  1:53         ` Stefan Monnier
2009-11-23  2:20           ` Karl Fogel
2009-11-24 15:12             ` Thien-Thi Nguyen
2009-11-24 15:41               ` Alfred M. Szmidt
2009-11-25 21:02                 ` Richard Stallman
2009-11-26 20:20                   ` Thien-Thi Nguyen
2009-11-27  6:35                     ` Richard Stallman

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=20091121121950.GB2021@muc.de \
    --to=acm@muc.de \
    --cc=emacs-devel@gnu.org \
    --cc=kfogel@red-bean.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.