From: Miles Bader <miles@gnu.org>
To: Eli Zaretskii <eliz@gnu.org>
Cc: ofv@wanadoo.es, lekktu@gmail.com, ams@gnu.org, emacs-devel@gnu.org
Subject: Re: Commit netiquette.
Date: Mon, 22 Feb 2010 11:17:23 +0900 [thread overview]
Message-ID: <87pr3y6mks.fsf@catnip.gol.com> (raw)
In-Reply-To: <83ljeovvd0.fsf@gnu.org> (Eli Zaretskii's message of "Sat, 20 Feb 2010 16:23:55 +0200")
Eli Zaretskii <eliz@gnu.org> writes:
>> Of course, people could also provide summary lines in a ChangeLog --
>> e.g., prefix a classic ChangeLog entry with a "SUMMARY:" line. Indeed,
>> I'd recommend that people do this, even though it's not a part of the
>> classic ChangeLog format (I do this sometimes when adding a single
>> cohesive change that touches many files); it makes ChangeLogs easier to
>> read and more useful.
>
> However, the "SUMMARY:" part just wastes precious real estate of the
> single line produced by "bzr log --line".
Eh? I'm confused... I don't mean they should literally write the string
"SUMMARY:", and I was talking about ChangeLog files, not commit-logs.
What I was advocating was, _in ChangeLog files_, a style like:
2010-02-22 Miles Bader <Miles Bader <miles@gnu.org>>
Frobbed the grot system:
* grot-blah.el (fun1, fun2): Blurged frebly.
* grot-zung.el (fun3): Nug n ug.
* some-grup.el (zoon): Wabawaba.
This isn't always necessary for small/trivial changes, but for longer
ones, i think it's a useful addition.
Indeed, one can imagine a ChangeLog style where the commit-log text
(following typical commit-log conventions) is used a prefix for
traditional ChangeLog-type per-file entries. For instance:
2010-02-22 Miles Bader <Miles Bader <miles@gnu.org>>
Frobbed the grot system
The Grot system was blorked, so rewrite all the zoong-nurbs
using an explicit snood cache.
* grot-blah.el (fun1, fun2): Blurged frebly.
* grot-zung.el (fun3): Nug n ug.
* some-grup.el (zoon): Wabawaba.
Again, all the comments above pertain to ChangeLog files, not
commit-logs [for commit-logs, of course I recommend the standard 1-line
(without period) summary followed if necessary by a more verbose
description in additional paragraphs].
-Miles
--
"... The revolution will be no re-run brothers; The revolution will be live."
next prev parent reply other threads:[~2010-02-22 2:17 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-02-17 23:44 Commit netiquette Óscar Fuentes
2010-02-18 0:27 ` Glenn Morris
2010-02-18 0:51 ` Óscar Fuentes
2010-02-18 5:35 ` Glenn Morris
2010-02-18 7:13 ` Chong Yidong
2010-02-18 15:11 ` Mark A. Hershberger
2010-02-18 14:45 ` Alfred M. Szmidt
2010-02-18 15:12 ` Juanma Barranquero
2010-02-18 16:14 ` Stefan Monnier
2010-02-19 3:42 ` David Reitter
2010-02-19 5:32 ` Stefan Monnier
2010-02-19 8:17 ` Alfred M. Szmidt
2010-02-19 18:19 ` Stefan Monnier
2010-02-20 11:02 ` Chong Yidong
2010-02-20 11:06 ` Chong Yidong
2010-02-23 19:25 ` Alfred M. Szmidt
2010-02-19 8:17 ` Alfred M. Szmidt
2010-02-19 8:39 ` Juanma Barranquero
2010-02-20 12:37 ` Alfred M. Szmidt
2010-02-20 14:13 ` Miles Bader
2010-02-20 14:23 ` Eli Zaretskii
2010-02-22 2:17 ` Miles Bader [this message]
2010-02-22 4:14 ` Eli Zaretskii
2010-02-23 16:37 ` Stefan Monnier
2010-02-23 19:25 ` Alfred M. Szmidt
2010-02-20 18:55 ` Juanma Barranquero
2010-02-23 19:25 ` Alfred M. Szmidt
2010-02-23 20:28 ` Juanma Barranquero
2010-02-23 22:09 ` David Kastrup
2010-02-23 22:57 ` Juanma Barranquero
2010-02-18 15:40 ` Óscar Fuentes
2010-02-19 0:22 ` Stephen J. Turnbull
2010-02-19 7:53 ` Miles Bader
2010-02-18 15:15 ` Mark A. Hershberger
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=87pr3y6mks.fsf@catnip.gol.com \
--to=miles@gnu.org \
--cc=ams@gnu.org \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=lekktu@gmail.com \
--cc=ofv@wanadoo.es \
/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.