From: Roger Dingledine Date: Tue, 8 Mar 2011 19:59:30 +0000 (-0500) Subject: make nickm's proposed convention from 2003 be gospel X-Git-Tag: tor-0.2.2.23-alpha~5^2~4 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=95edd51116c17327f314bc132a0a5f86499e410a;p=thirdparty%2Ftor.git make nickm's proposed convention from 2003 be gospel --- diff --git a/doc/HACKING b/doc/HACKING index 486fe6d10a..bdb86c06c6 100644 --- a/doc/HACKING +++ b/doc/HACKING @@ -312,11 +312,11 @@ operation. 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 the -message (perhaps with a string like "internal error"). Option (A) is to be -preferred to option (B). -NM] +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 the message (perhaps +with a string like "internal error"). Option (A) is to be preferred to +option (B). Doxygen ~~~~~~~~