[1794] in Kerberos_V5_Development
Conventions for gnats PR tracking
daemon@ATHENA.MIT.EDU (Barry Jaspan)
Thu Sep 26 12:45:38 1996
Date: Thu, 26 Sep 1996 12:45:25 -0400
From: "Barry Jaspan" <bjaspan@MIT.EDU>
To: krbdev@MIT.EDU
I propose the following conventions for working with gnats prs:
o When you put an entry in any ChangeLog file, include the PR
number(s) that relate to the changes, if any. The syntax "[cat/#]"
works well. For example:
--- snip snip ---
Fri Sep 20 16:52:07 1996 Barry Jaspan <bjaspan@mit.edu>
* [krb5-admin/1234] configure.in: add unit-test directory
--- snip snip ---
o When you change a PR to state "closed," and the reason is that you
fixed the bug or otherwise made the appropriate changes, list all of
the files affected in the PR. If you listed all the files in the
appropriate ChangeLog file(s), then you can just list the ChangeLogs.
For example:
--- snip snip ---
State-Changed-From-To: open-closed
State-Changed-By: bjaspan
State-Changed-When: Thu Sep 26 12:39:54 1996
State-Changed-Why:
Fixed. Files:
lib/kadm5/ChangeLog:1.16
lib/kadm5/unit-test/ChangeLog:1.3
--- snip snip ---
Including the CVS revision number of the file is just some redundancy
in case you forget to include the PR in the ChangeLog or CVS log
entry; it improves the chances that cross-referencing will be
possible. At OV we found this kind of cross-referencing extremely
helpful on a number of occasions, usually in the form of "Gee, didn't
we fix this bug 6 months ago? What, exactly, did we do to fix it?"
This, of course, is just one more step in the process of how krb5
sources are supposed to be handled. It wouldn't be a bad idea for
someone to write a short document defining the complete source
maintainance procedures (ie: always list files in the ChangeLog, then
use the ChangeLog as the CVS log entry) so that we can be sure
everyone is doing the same thing.
Barry
