summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorajs <ajs>2004-12-03 19:03:33 +0000
committerajs <ajs>2004-12-03 19:03:33 +0000
commit5e76477456ce8bc4a1eeaccb5c5e1d3d99ab1300 (patch)
tree6a05e47a55e4afce73b653e00f9abfd34f860511 /lib
parent2cac10935b6e2aabeb480d6769be01d9eec7101f (diff)
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.
Diffstat (limited to 'lib')
-rw-r--r--lib/ChangeLog5
-rw-r--r--lib/log.h16
2 files changed, 21 insertions, 0 deletions
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
diff --git a/lib/log.h b/lib/log.h
index e596cdd0..26ff902b 100644
--- a/lib/log.h
+++ b/lib/log.h
@@ -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