From 5e76477456ce8bc4a1eeaccb5c5e1d3d99ab1300 Mon Sep 17 00:00:00 2001 From: ajs Date: Fri, 3 Dec 2004 19:03:33 +0000 Subject: 2004-12-03 Andrew J. Schorr * 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. --- HACKING | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) (limited to 'HACKING') diff --git a/HACKING b/HACKING index fa5ac1ac..1335b082 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 @@ the top, commented out appropriately for the file type. Just add Id:, replacing 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 -- cgit v1.2.1