diff options
| -rw-r--r-- | ChangeLog | 5 | ||||
| -rw-r--r-- | HACKING | 11 | ||||
| -rw-r--r-- | lib/ChangeLog | 5 | ||||
| -rw-r--r-- | lib/log.h | 16 |
4 files changed, 36 insertions, 1 deletions
@@ -1,3 +1,8 @@ +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. + 2004-11-24 Paul Jakma <paul@dishone.st> * TODO: Add source routing, zebra filtering and lib/ documenting. @@ -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 @@ the top, commented out appropriately for the file type. Just add <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 diff --git a/lib/ChangeLog b/lib/ChangeLog index d334b04e..79062cae 100644 --- a/lib/ChangeLog +++ b/lib/ChangeLog @@ -1,5 +1,10 @@ 2004-12-03 Andrew J. Schorr <ajschorr@alumni.princeton.edu> + * log.h: Document appropriate use of syslog logging priorities + inside quagga. + +2004-12-03 Andrew J. Schorr <ajschorr@alumni.princeton.edu> + * command.h: Remove fields log_stdout and log_syslog from struct host, since they are just trying to duplicate information in the zlog_default structure. Note that this fixes a bug since those @@ -24,6 +24,22 @@ #include <syslog.h> +/* Here is some guidance on logging levels to use: + * + * LOG_DEBUG - For all messages that are enabled by optional debugging + * features, typically preceded by "if (IS...DEBUG...)" + * LOG_INFO - Information that may be of interest, but everything seems + * to be working properly. + * LOG_NOTICE - Only for message pertaining to daemon startup or shutdown. + * LOG_WARNING - Warning conditions: unexpected events, but the daemon believes + * it can continue to operate correctly. + * LOG_ERR - Error situations indicating malfunctions. Probably require + * attention. + * + * Note: LOG_CRIT, LOG_ALERT, and LOG_EMERG are currently not used anywhere, + * please use LOG_ERR instead. + */ + #define ZLOG_NOLOG 0x00 #define ZLOG_FILE 0x01 #define ZLOG_SYSLOG 0x02 |