nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-14 07:03:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

make nickm's proposed convention from 2003 be gospel

Browse Source
This commit is contained in:
Roger Dingledine 2011-03-08 14:59:30 -05:00
parent 3bd83b8fb6
commit 95edd51116
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/HACKING
View File

@ -312,11 +312,11 @@ operation.
If a library function is currently called such that failure always means ERR, 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. then the library function should log WARN and let the caller log ERR.
[XXX Proposed convention: every message of severity INFO or higher should Every message of severity INFO or higher should either (A) be intelligible
either (A) be intelligible to end-users who don't know the Tor source; or (B) to end-users who don't know the Tor source; or (B) somehow inform the
somehow inform the end-users that they aren't expected to understand the end-users that they aren't expected to understand the message (perhaps
message (perhaps with a string like "internal error"). Option (A) is to be with a string like "internal error"). Option (A) is to be preferred to
preferred to option (B). -NM] option (B).
Doxygen Doxygen
~~~~~~~~ ~~~~~~~~