[tor-commits] [tor/master] doc: Document the signal-safe log behaviour in the tor man page

[asn at torproject.org]

commit 102546f99f2efbc21f9e0860c66f2c3ae714352f
Author: teor <teor at torproject.org>
Date:   Tue Sep 24 15:03:17 2019 +1000

    doc: Document the signal-safe log behaviour in the tor man page
    
    Part of 31389.
---
 doc/tor.1.txt | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 835962362..6ba23ac62 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -663,7 +663,16 @@ GENERAL OPTIONS
     debug, info, notice, warn, and err. We advise using "notice" in most cases,
     since anything more verbose may provide sensitive information to an
     attacker who obtains the logs. If only one severity level is given, all
-    messages of that level or higher will be sent to the listed destination.
+    messages of that level or higher will be sent to the listed destination. +
+ +
+    Some low-level logs may be sent from signal handlers, so their destination
+    logs must be signal-safe. These low-level logs include backtraces,
+    logging function errors, and errors in code called by logging functions.
+    Signal-safe logs are always sent to stderr or stdout. They are also sent to
+    a limited number of log files that are configured to log messages at error
+    severity from the bug or general domains. They are never sent as syslogs,
+    android logs, control port log events, or to any API-based log
+    destinations.
 
 [[Log2]] **Log** __minSeverity__[-__maxSeverity__] **file** __FILENAME__::
     As above, but send log messages to the listed filename. The