summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorpaul <paul>2004-11-05 23:38:20 +0000
committerpaul <paul>2004-11-05 23:38:20 +0000
commit1f8f61a7d51c59f392f897d6654cac28ae08ea70 (patch)
treef72deb54a95db8b1eb0d939880d8b74ee5b84229 /HACKING
parent6639a04da2c5ac6bfa0d5eff006637fb6f1372ee (diff)
2004-11-05 Paul Jakma <paul@dishone.st>
* HACKING: Expand on ChangeLogs, eg current practice for certain directories and certain other meta-data is not to maintain a ChangeLog. Expand on the commit message, IMHO, commit message should always be ChangeLog for files where ChangeLog is kept. Solaris is supported on any platform (with, at moment, an additional patch).
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING16
1 files changed, 13 insertions, 3 deletions
diff --git a/HACKING b/HACKING
index c60f31ca..984152d3 100644
--- a/HACKING
+++ b/HACKING
@@ -1,6 +1,6 @@
-*- mode: text; -*-
-$Id: HACKING,v 1.9 2004/11/05 13:17:20 gdt Exp $
+$Id: HACKING,v 1.10 2004/11/05 23:38:20 paul Exp $
GUIDELINES FOR HACKING ON QUAGGA
@@ -42,6 +42,13 @@ directory should go in the per-directory ChangeLog. Global or
structural changes should also be mentioned in the top-level
ChangeLog.
+Certain directories do not contain project code, but contain project
+meta-data, eg packaging information, changes to files in these directory may
+not require the global ChangeLog to be updated (at the discretion of the
+maintainer who usually maintains that meta-data). Also, CVS meta-data such
+as cvsignore files do not require ChangeLog updates, just a sane commit
+message.
+
SHARED LIBRARY VERSIONING
[this section is at the moment just gdt's opinion]
@@ -99,7 +106,10 @@ PATCH APPLICATION TO CVS
mailinglist.
* Give an appropriate commit message, eg the ChangeLog entry should suffice,
- if it does not, then the ChangeLog entry itself needs to be corrected.
+ if it does not, then the ChangeLog entry itself needs to be corrected. The
+ commit message text should be identical to that added to the ChangeLog
+ message. (One suggestion: when commiting, use your editor to read in the
+ ChangeLog and delete all previous ChangeLogs.)
* By committing a patch, you are responsible for fixing problems
resulting from it (or backing it out).
@@ -113,7 +123,7 @@ and willing to verify that -current does or does not work correctly.
BSD (Free, Net or Open, any platform) # without capabilities
GNU/Linux (any distribution, i386)
- Solaris with 64-bit processor (strict alignment, not ILP32)
+ Solaris (strict alignment, any platform)
[future: NetBSD/sparc64]
The list of daemons that are thought to be stable and that should be