From cb1a3674ebb3826d9e1e56146210bd79cb4a42f0 Mon Sep 17 00:00:00 2001
From: Nick Mathewson <nickm@torproject.org>
Date: Sun, 1 Jul 2018 20:22:55 -0400
Subject: File-level documentation for some of src/lib.

---
 src/lib/err/backtrace.c | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src/lib/err/backtrace.c')

diff --git a/src/lib/err/backtrace.c b/src/lib/err/backtrace.c
index cded6459f7..5f5ecd3c37 100644
--- a/src/lib/err/backtrace.c
+++ b/src/lib/err/backtrace.c
@@ -11,6 +11,10 @@
  * family of functions, which are sometimes provided by libc and sometimes
  * provided by libexecinfo.  We tie into the sigaction() backend in order to
  * detect crashes.
+ *
+ * This is one of the lowest-level modules, since nearly everything needs to
+ * be able to log an error.  As such, it doesn't call the log module or any
+ * other higher-level modules directly.
  */
 
 #include "orconfig.h"
-- 
cgit v1.2.3-54-g00ecf