diff options
| author | Roger Dingledine <arma@torproject.org> | 2011-03-08 14:59:30 -0500 |
|---|---|---|
| committer | Roger Dingledine <arma@torproject.org> | 2011-03-08 14:59:30 -0500 |
| commit | 95edd51116c17327f314bc132a0a5f86499e410a (patch) | |
| tree | 0cfe8195c955dda9e08dccc0eae3ad5defe36c96 | |
| parent | 3bd83b8fb64c070210c589f65ed8cc023dd47077 (diff) | |
| download | tor-95edd51116c17327f314bc132a0a5f86499e410a.tar tor-95edd51116c17327f314bc132a0a5f86499e410a.tar.gz | |
make nickm's proposed convention from 2003 be gospel
| -rw-r--r-- | doc/HACKING | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/HACKING b/doc/HACKING index 486fe6d10..bdb86c06c 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 ~~~~~~~~ |