]> git.ipfire.org Git - thirdparty/tor.git/commitdiff
make nickm's proposed convention from 2003 be gospel
authorRoger Dingledine <arma@torproject.org>
Tue, 8 Mar 2011 19:59:30 +0000 (14:59 -0500)
committerRoger Dingledine <arma@torproject.org>
Tue, 8 Mar 2011 19:59:30 +0000 (14:59 -0500)
doc/HACKING

index 486fe6d10aa548f8551974ce1f48dec43d4ffa1f..bdb86c06c670820c2c596b40f159270eaf7c13ed 100644 (file)
@@ -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
 ~~~~~~~~