From: Uday S Reddy <u.s.reddy@cs.bham.ac.uk>
To: "Óscar Fuentes" <ofv@wanadoo.es>
Cc: emacs-devel@gnu.org
Subject: Re: Please don't use revision numbers on commit messages (and elsewhere).
Date: Mon, 4 Apr 2011 10:29:19 +0100 [thread overview]
Message-ID: <19865.36719.736000.336002@gargle.gargle.HOWL> (raw)
In-Reply-To: <871v1js48d.fsf@wanadoo.es>
Óscar Fuentes writes:
> I see that as a tradeoff writer vs readers. As explained elsewhere, you
> write things once but they are read lots of times. It is the same case
> as naming functions and writing comments.
That is of course a very good point. Revision notes should be easy
enough to read, but *analyzing* them might involve some work. In
practice, it involves a lot of work, and one addition/subtraction
isn't going to make much of a difference.
Going back to your original example, which is presumably fictitious:
> If I'm reading the VC log on a random branch and see "Fix breakage
> introduced by rXXXX" and want to look at the referenced revision,
> ...
the problem with such a note is that it says precious little unless
you go and find the revision XXXX. Those of us that write technical
articles have been taught to use the convention that the text should
stand on its own without having to follow the cross-references to
understand what it is saying. (I have been told that it is what is
recommended by the Chicago Manual of Style, though I haven't read the
manual myself.) Your example fails that test. If there is enough
information in the note for the reader to decide whether it is
necessary to follow the cross-reference, then readability would be
preserved.
The various real examples cited by Juanma seem to be mostly fine.
Cheers,
Uday
next prev parent reply other threads:[~2011-04-04 9:29 UTC|newest]
Thread overview: 86+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-03-31 20:47 Please don't use revision numbers on commit messages (and elsewhere) Óscar Fuentes
2011-03-31 21:36 ` Lennart Borgman
2011-03-31 21:53 ` Óscar Fuentes
2011-03-31 21:59 ` Lennart Borgman
2011-03-31 22:06 ` Óscar Fuentes
2011-03-31 22:18 ` Lennart Borgman
2011-03-31 22:58 ` Juanma Barranquero
2011-04-01 7:42 ` Eli Zaretskii
2011-04-01 7:58 ` Andreas Schwab
2011-04-01 8:02 ` Eli Zaretskii
2011-04-01 8:17 ` Andreas Schwab
2011-04-01 8:42 ` Eli Zaretskii
2011-04-01 8:54 ` Andreas Schwab
2011-04-01 10:11 ` Eli Zaretskii
2011-04-01 10:21 ` Andreas Schwab
2011-04-01 10:48 ` Eli Zaretskii
2011-04-01 11:18 ` Andreas Schwab
2011-04-01 13:15 ` Eli Zaretskii
2011-04-01 13:32 ` Andreas Schwab
2011-04-01 13:47 ` Eli Zaretskii
2011-04-01 13:51 ` Deniz Dogan
2011-04-01 15:26 ` Óscar Fuentes
2011-04-01 19:13 ` Eli Zaretskii
2011-04-01 20:17 ` Óscar Fuentes
2011-03-31 23:14 ` Juanma Barranquero
2011-04-01 0:11 ` Óscar Fuentes
2011-04-01 0:28 ` Juanma Barranquero
2011-04-01 1:20 ` Óscar Fuentes
2011-04-01 8:18 ` Eli Zaretskii
2011-04-01 12:08 ` David Kastrup
2011-04-01 13:15 ` Eli Zaretskii
2011-04-01 15:35 ` Óscar Fuentes
2011-04-01 19:52 ` Eli Zaretskii
2011-04-01 20:04 ` David Kastrup
2011-04-01 20:36 ` Eli Zaretskii
2011-04-01 20:43 ` Óscar Fuentes
2011-04-01 10:34 ` Juanma Barranquero
2011-04-01 15:55 ` Óscar Fuentes
2011-04-01 21:53 ` Juanma Barranquero
2011-04-04 16:32 ` Nils Ackermann
2011-04-04 21:27 ` Juanma Barranquero
2011-04-04 21:36 ` Lennart Borgman
2011-04-04 21:49 ` Juanma Barranquero
2011-04-04 22:03 ` Lennart Borgman
2011-04-04 22:09 ` Juanma Barranquero
2011-04-04 22:27 ` Stefan Monnier
2011-04-04 22:35 ` Juanma Barranquero
2011-04-05 21:00 ` Thien-Thi Nguyen
2011-04-05 21:00 ` Thien-Thi Nguyen
2011-04-06 1:30 ` Stefan Monnier
2011-04-06 2:55 ` Stephen J. Turnbull
2011-04-06 12:47 ` Thien-Thi Nguyen
2011-04-01 1:59 ` Stephen J. Turnbull
2011-04-01 10:00 ` Uday S Reddy
2011-04-01 15:00 ` Stephen J. Turnbull
2011-04-01 16:38 ` Uday S Reddy
2011-04-01 18:08 ` Stephen J. Turnbull
2011-04-01 18:56 ` Uday S Reddy
2011-04-01 20:49 ` Stephen J. Turnbull
2011-04-01 10:45 ` Juanma Barranquero
2011-04-01 14:51 ` Stefan Monnier
2011-04-01 15:14 ` Ted Zlatanov
2011-04-01 19:58 ` Juanma Barranquero
2011-04-02 2:12 ` Chong Yidong
2011-04-01 1:35 ` Stephen J. Turnbull
2011-04-01 10:39 ` Juanma Barranquero
2011-03-31 23:16 ` Thien-Thi Nguyen
2011-04-01 0:20 ` Óscar Fuentes
2011-04-01 8:38 ` Thien-Thi Nguyen
2011-04-01 9:36 ` Eli Zaretskii
2011-04-01 10:14 ` Eli Zaretskii
2011-04-01 17:38 ` Thien-Thi Nguyen
2011-04-01 15:38 ` Óscar Fuentes
2011-04-01 19:12 ` Eli Zaretskii
2011-04-01 20:21 ` Óscar Fuentes
2011-04-01 20:38 ` Eli Zaretskii
2011-04-01 21:40 ` Uday S Reddy
2011-04-02 0:03 ` Óscar Fuentes
2011-04-02 6:20 ` Uday S Reddy
2011-04-02 13:47 ` Óscar Fuentes
2011-04-03 8:00 ` Uday S Reddy
2011-04-03 16:13 ` Óscar Fuentes
2011-04-04 9:29 ` Uday S Reddy [this message]
2011-04-05 2:20 ` Stephen J. Turnbull
2011-04-02 2:57 ` Stephen J. Turnbull
2011-04-01 0:55 ` Stefan Monnier
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=19865.36719.736000.336002@gargle.gargle.HOWL \
--to=u.s.reddy@cs.bham.ac.uk \
--cc=emacs-devel@gnu.org \
--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 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).