unofficial mirror of guix-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: John Darrington <john@darrington.wattle.id.au>
To: Mark H Weaver <mhw@netris.org>
Cc: guix-devel@gnu.org, John Darrington <jmd@gnu.org>
Subject: Re: none
Date: Wed, 5 Feb 2014 18:38:12 +0100	[thread overview]
Message-ID: <20140205173812.GA32229@jocasta.intra> (raw)
In-Reply-To: <87fvnxy1nu.fsf@netris.org>

[-- Attachment #1: Type: text/plain, Size: 2159 bytes --]

On Wed, Feb 05, 2014 at 11:17:25AM -0500, Mark H Weaver wrote:
     ludo@gnu.org (Ludovic Court??s) writes:
     
     > John Darrington <jmd@gnu.org> skribis:
     >
     >> In my opinion the changelog conventions are achronistic, unintuitive,
     >> and bring benefit neither to developers nor users.
     >
     > Well, opinions may vary.
     >
     > It benefits me when I review other people???s patches, because it helps me
     > understand the structure of the change.  And it benefits me before I
     > commit something, because it forces me to review all of my patch, make
     > sure it???s consistent, make sure there???s no leftover, and giving me an
     > opportunity to add comments to code that appears non-obvious in
     > hindsight.
     
     I also find them very useful when digging through (possibly ancient)
     commit history.  Although all the information is in the actual patch,
     when looking through many commits it is much more convenient to read a
     summary of the changes.  One summary line is not enough detail.
     
     Of course, it's extra work to write these summaries, but IMO it's
     worthwhile.

I don't object to the spending time of writing changelogs.  I just think the 
information that the GCS suggests is not helpful.  It is not usefull to say 
changed file foo.scm, because using git show that is obvious.  There is even a 
perl script out in the wild somewhere to generate exactly that.  Typing it 
in is redundant. 

What would be  useful (but in general) we don't put in the changelogs is WHY a
developer changed foo.scm  Put yourself in the shoes of a person investigating a
problem in 3 years' time.  He can see that developer fred did X.  He doesn't
need fred to tell him that.  What he needs is fred to explain his reasoning for 
doing X not a statement that he has done it.  That way he can make an informed
decision about which way to take the code now.
     
J'
     

-- 
PGP Public key ID: 1024D/2DE827B3 
fingerprint = 8797 A26D 0854 2EAB 0285  A290 8A67 719C 2DE8 27B3
See http://sks-keyservers.net or any PGP keyserver for public key.


[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 198 bytes --]

  reply	other threads:[~2014-02-05 17:38 UTC|newest]

Thread overview: 44+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-02-04 15:12 (unknown), John Darrington
2014-02-04 15:12 ` [PATCH 1/3] gnu: boost: New module John Darrington
2014-02-04 20:51   ` Ludovic Courtès
2014-02-04 15:12 ` [PATCH 2/3] gnu: inkscape: " John Darrington
2014-02-04 23:09   ` Ludovic Courtès
2014-02-05  7:26     ` John Darrington
2014-02-05 13:49       ` Ludovic Courtès
2014-02-05 14:19         ` John Darrington
2014-02-04 20:47 ` none Ludovic Courtès
2014-02-05 16:17   ` none Mark H Weaver
2014-02-05 17:38     ` John Darrington [this message]
2014-02-05 18:35       ` none Ludovic Courtès
  -- strict thread matches above, loose matches on Subject: below --
2014-02-11 22:17 Gnunet-0.10.0 recipe Sree Harsha Totakura
2014-02-12 15:15 ` (unknown), Sree Harsha Totakura
2014-02-12 17:36   ` none Ludovic Courtès
2014-02-12 17:38     ` none Sree Harsha Totakura
2014-02-12 19:25     ` none Andreas Enge
2014-02-12 20:30       ` none Ludovic Courtès
2014-02-12 20:53         ` none Andreas Enge
2014-12-03 18:02 (unknown) Tomas Cech
2014-12-04 23:04 ` none Ludovic Courtès
2014-12-05  8:35   ` none Tomas Cech
2014-12-06 14:06     ` none Ludovic Courtès
2015-03-25 22:49 (unknown), Tomáš Čech
2015-03-26 21:22 ` none Ludovic Courtès
2015-03-26 21:52   ` none Tomáš Čech
2016-07-21  1:39 (unknown) Unknown, Pjotr Prins
2016-07-21 12:51 ` none Ludovic Courtès
2016-07-22  0:41   ` none Pjotr Prins
2016-07-22  2:06     ` none Pjotr Prins
2016-07-22  3:25       ` none Jookia
2016-07-22  3:48       ` none Leo Famulari
2016-07-22  4:48       ` none Tobias Geerinckx-Rice
2016-07-22 11:07         ` none Pjotr Prins
2016-07-22 12:23           ` none Ricardo Wurmus
2016-07-22 12:50             ` none Jookia
2016-07-22 21:19               ` none Leo Famulari
2016-07-24  4:17                 ` none Jookia
2016-07-24  6:35                   ` none Leo Famulari
2016-07-24  7:47                     ` none Jookia
2016-07-24 16:52               ` none Christopher Allan Webber
2016-07-24 17:03                 ` none Andreas Enge
2016-07-22  8:15     ` none Roel Janssen
2016-07-22 14:07       ` none Leo Famulari
2016-07-22 14:15         ` none Vincent Legoll
2016-07-22 16:13       ` none Ludovic Courtès
2016-07-22 16:38         ` none myglc2
2016-07-23  7:03           ` none Tomáš Čech
2016-07-23  9:15 none David Craven

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://guix.gnu.org/

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

  git send-email \
    --in-reply-to=20140205173812.GA32229@jocasta.intra \
    --to=john@darrington.wattle.id.au \
    --cc=guix-devel@gnu.org \
    --cc=jmd@gnu.org \
    --cc=mhw@netris.org \
    /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/guix.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).