mirror of
https://gitlab.torproject.org/tpo/core/tor.git
synced 2024-11-27 22:03:31 +01:00
make nickm's proposed convention from 2003 be gospel
This commit is contained in:
parent
3bd83b8fb6
commit
95edd51116
10
doc/HACKING
10
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
|
||||
~~~~~~~~
|
||||
|
Loading…
Reference in New Issue
Block a user