public inbox for gentoo-dev@lists.gentoo.org
 help / color / mirror / Atom feed
* [gentoo-dev] [git migration] The problem of ChangeLog generation
@ 2010-04-06  2:13 Nirbheek Chauhan
  2010-04-06  6:41 ` Fabian Groffen
                   ` (5 more replies)
  0 siblings, 6 replies; 38+ messages in thread
From: Nirbheek Chauhan @ 2010-04-06  2:13 UTC (permalink / raw
  To: Gentoo Dev

One of the few remaining problems to be solved for the migration to
git for our gentoo-x86/ and gentoo/ trees (besides other
projects/overlays) is the problem of how to handle ChangeLogs.

====
Gist:
====
* It makes zero sense to manually manage ChangeLogs in git[1]
  - Irritating conflicts while merging branches or remote master
    + Similar argument for having only distfile manifests; but I digress...
  - Duplication of effort and information
  - Saves space for local checkouts
* Proposed is to generate ChangeLogs from git commits on the rsync
server side when metadata generation is done
  - Scripts to do this already exist[1]


Now, there are obviously problems with this. Some of them are
documented below alongwith their proposed solutions. If people foresee
other problems with this; they are requested to comment. They are also
welcome to comment if they have a better solution to the problems
listed below.

Also, please try to keep this thread on-topic.


========
Problems:
========
* Messages in ChangeLog are not always the same as the commit messages
(~1% are different)
* Some people place additional information in the commit message which
is intended only for developer use
  - Most of the difference in ChangeLog/commit messages comes from this
* Trivial changes are often not documented in ChangeLogs
  - This is upto the developer's personal preference
  - Some folks do this because of the extra time it takes
    + This use-case becomes irrelevant due to automatic generation of ChangeLog

========
Solutions:
========
* Do not re-generate the existing ChangeLog; rather make the ChangeLog
generation script smart enough to only append
  - Solves the "messages not same" problem for existing commits
* Use a separator in the commit message like "== \n" to denote that
everything after this is dev-only information and should be skipped
from the user ChangeLog
  - Solves the problem for people who like to add extra dev-only info
in the CVS commit message
* Ignore commits with "[$tag][trivial]" in the tag[2] from being added
to ChangeLog
  - Keeps the wishes of the developer and does not pollute ChangeLog
with such info


1. http://live.gnome.org/Git/ChangeLog
2. http://live.gnome.org/Git/CommitMessages
-- 
~Nirbheek Chauhan

Gentoo GNOME+Mozilla Team



^ permalink raw reply	[flat|nested] 38+ messages in thread

end of thread, other threads:[~2010-06-26  5:56 UTC | newest]

Thread overview: 38+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2010-04-06  2:13 [gentoo-dev] [git migration] The problem of ChangeLog generation Nirbheek Chauhan
2010-04-06  6:41 ` Fabian Groffen
2010-04-06  7:01   ` Nirbheek Chauhan
2010-04-06 11:40     ` Fabian Groffen
2010-04-07  9:58   ` Angelo Arrifano
2010-04-07 10:03     ` Ciaran McCreesh
2010-04-07 14:36     ` Richard Freeman
2010-06-21 19:34       ` [gentoo-dev] " Christian Faulhammer
2010-04-06  7:28 ` [gentoo-dev] [git migration] Proposition for tags supported by git hooks Maciej Mrozowski
2010-04-06  8:00   ` Nirbheek Chauhan
2010-04-06 13:06 ` [gentoo-dev] [git migration] The problem of ChangeLog generation Richard Freeman
2010-04-06 22:21   ` Robin H. Johnson
2010-04-07 10:05     ` Angelo Arrifano
2010-04-07  6:25   ` Hans de Graaff
2010-04-07  7:55 ` Dirkjan Ochtman
2010-04-07 16:54 ` Markos Chandras
2010-04-07 18:41   ` Nirbheek Chauhan
2010-04-07 21:54     ` Markos Chandras
2010-04-13 11:25 ` Peter Volkov
2010-04-13 11:44   ` Angelo Arrifano
2010-04-13 11:48   ` Nirbheek Chauhan
2010-04-13 13:19     ` Ulrich Mueller
2010-04-13 13:35       ` Nirbheek Chauhan
2010-04-13 16:12         ` Matti Bickel
2010-04-13 16:22           ` Angelo Arrifano
2010-04-13 16:23           ` Alec Warner
2010-04-13 16:33             ` Matti Bickel
2010-04-14  1:47               ` Richard Freeman
2010-04-14  6:39               ` Nirbheek Chauhan
2010-04-14  9:08                 ` Matti Bickel
2010-04-13 16:47     ` Peter Volkov
2010-05-02 15:13       ` Jim Ramsay
2010-06-24 18:59   ` Luca Barbato
2010-06-24 20:43     ` Olivier Crête
2010-06-25  8:45       ` Peter Volkov
2010-06-25  8:49         ` Arun Raghavan
2010-06-25  9:00           ` Peter Volkov
2010-06-26  5:55             ` Olivier Crête

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox