2004-12-03 Andrew J. Schorr <ajschorr@alumni.princeton.edu>
* HACKING: Indicate that header files should be consulted for
documentation, particularly logging levels in lib/log.h.
* log.h: Document appropriate use of syslog logging priorities
inside quagga.
diff --git a/HACKING b/HACKING
index fa5ac1a..1335b08 100644
--- a/HACKING
+++ b/HACKING
@@ -1,5 +1,5 @@
-*- mode: text; -*-
-$Id: HACKING,v 1.12 2004/11/15 19:23:47 gdt Exp $
+$Id: HACKING,v 1.13 2004/12/03 19:03:33 ajs Exp $
GUIDELINES FOR HACKING ON QUAGGA
@@ -36,6 +36,15 @@
<dollar>Id:<dollar>, replacing <dollar> with $. See line 2 of HACKING
for an example; on checkout :$ is expanded to include the value.
+Please document fully the proper use of a new function in the header file
+in which it is declared. And please consult existing headers for
+documentation on how to use existing functions. In particular, please consult
+these header files:
+
+ lib/log.h logging levels and usage guidance
+ [more to be added]
+
+
CHANGELOG
Add a ChangeLog entry whenever changing code, except for minor fixes