[tor-commits] [torspec/master] control-spec: Document logs that are not included in the Log event

[nickm at torproject.org]

commit e5ec0281872c38ba450801d4524f70cb3ab8291c
Author: teor <teor at torproject.org>
Date:   Fri Aug 2 12:59:36 2019 +1000

    control-spec: Document logs that are not included in the Log event
    
    Spec for 30901.
---
 control-spec.txt | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/control-spec.txt b/control-spec.txt
index ac6578a..97bee17 100644
--- a/control-spec.txt
+++ b/control-spec.txt
@@ -2267,6 +2267,14 @@
 
      Severity = "DEBUG" / "INFO" / "NOTICE" / "WARN"/ "ERR"
 
+  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 never sent as control port log events.
+
+  Control port message trace debug logs are never sent as control port log
+  events, to avoid modifying control output when debugging.
+
 4.1.6. New descriptors available
 
   This event is generated when new router descriptors (not microdescs or