[or-cvs] r8689: simplify a section of the HACKING file (tor/trunk/doc)
arma at seul.org
arma at seul.org
Wed Oct 11 20:45:03 UTC 2006
Date: 2006-10-11 16:45:01 -0400 (Wed, 11 Oct 2006)
New Revision: 8689
simplify a section of the HACKING file
--- tor/trunk/doc/HACKING 2006-10-11 20:05:06 UTC (rev 8688)
+++ tor/trunk/doc/HACKING 2006-10-11 20:45:01 UTC (rev 8689)
@@ -37,23 +37,15 @@
1.4. Log conventions
- Log convention: use only these four log severities.
- ERR is if something fatal just happened.
- WARN if something bad happened, but we're still running. The
- bad thing is either a bug in the code, an attack or buggy
- protocol/implementation of the remote peer, etc. The operator should
- examine the bad thing and try to correct it.
- NOTICE if it's something the operator will want to know about.
- (No error or warning messages should be expected during normal OR or OP
- operation. I expect most people to run on -l notice eventually. If a
- library function is currently called such that failure always means
- ERR, then the library function should log WARN and let the caller
- log ERR.)
- INFO means something happened (maybe bad, maybe ok), but there's nothing
- you need to (or can) do about it.
- DEBUG is for everything louder than INFO.
+ No error or warning messages should be expected during normal OR or OP
+ If a library function is currently called such that failure always
+ means ERR, then the library function should log WARN and let the caller
+ log ERR.
[XXX Proposed convention: every message of severity INFO or higher should
either (A) be intelligible to end-users who don't know the Tor source; or
(B) somehow inform the end-users that they aren't expected to understand
More information about the tor-commits