Просмотр исходного кода

make nickm's proposed convention from 2003 be gospel

Roger Dingledine 15 лет назад
Родитель
Сommit
95edd51116
1 измененных файлов с 5 добавлено и 5 удалено
  1. 5 5
      doc/HACKING

+ 5 - 5
doc/HACKING

@@ -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
-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
 Doxygen
 ~~~~~~~~
 ~~~~~~~~