Bug 6426 - switch to "why this changed", not what changed
Summary: switch to "why this changed", not what changed
Status: NEW
Alias: None
Product: frysk
Classification: Unclassified
Component: general (show other bugs)
Version: unspecified
: P2 normal
Target Milestone: ---
Assignee: Unassigned
URL:
Keywords:
Depends on:
Blocks: 6423 6424
  Show dependency treegraph
 
Reported: 2008-04-17 14:03 UTC by Andrew Cagney
Modified: 2008-04-25 19:18 UTC (History)
0 users

See Also:
Host:
Target:
Build:
Last reconfirmed:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Andrew Cagney 2008-04-17 14:03:53 UTC
GNU coding standard dogma dictates that:
- there shall be ChangeLog files
- ChangeLogs contain "what changed"
- source code contains "why it changed" or "why it is so" or "why it was"
the idea motivating this is that developers read the source, and hence it is the
source that should contain the detailed coding history; an the ChangeLog just
lets you identify who changed what when.

This all goes back to the days before revision control where often the only way
to know who did what as through the ChangeLog file.  With the introduction of
distributed revision control that's less of a problem - change history can be
identified by looking through your local copy of the entire repo.

This of course begs the question, of should we drop ChangeLog files and rely
more on GIT for recording what changed and by whom.  The only stickler I know of
 is being able to properly record changes submitted by A but committed by B.
Comment 1 Petr Machata 2008-04-25 18:04:42 UTC
Re the changes submitted by A but committed by B; if A uses git-format-patch,
sends the patch for commit to B, and B git-am's that patch, A will be recorded
at that commit.
Comment 2 Mark Wielaard 2008-04-25 19:18:40 UTC
The ChangeLog file is also included in the release source tar balls.