[tor-commits] [tor/master] Reseolve DOCDOC and XXXXs in backtrace.c

[nickm at torproject.org]

commit c3ea946839704c4f1f0369a1e91bdb749991e346
Author: Nick Mathewson <nickm at torproject.org>
Date:   Thu Aug 15 12:45:46 2013 -0400

    Reseolve DOCDOC and XXXXs in backtrace.c
---
 src/common/backtrace.c |   11 ++++-------
 1 file changed, 4 insertions(+), 7 deletions(-)

diff --git a/src/common/backtrace.c b/src/common/backtrace.c
index 9c69e4f..78bc66e 100644
--- a/src/common/backtrace.c
+++ b/src/common/backtrace.c
@@ -132,7 +132,6 @@ crash_handler(int sig, siginfo_t *si, void *ctx_)
 static int
 install_bt_handler(void)
 {
-  /*XXXX make this idempotent */
   int trap_signals[] = { SIGSEGV, SIGILL, SIGFPE, SIGBUS, SIGSYS,
                          SIGIO, -1 };
   int i, rv=0;
@@ -156,33 +155,30 @@ install_bt_handler(void)
 static void
 remove_bt_handler(void)
 {
-  /*XXXX writeme*/
+  /* We don't need to actually free anything at exit here. */
 }
 #endif
 
 #ifdef NO_BACKTRACE_IMPL
-/**DOCDOC */
 void
 log_backtrace(int severity, int domain, const char *msg)
 {
   tor_log(severity, domain, "%s. (Stack trace not available)", msg);
 }
 
-/**DOCDOC*/
 static int
 install_bt_handler(void)
 {
   return 0;
 }
 
-/**DOCDOC*/
 static void
 remove_bt_handler(void)
 {
 }
 #endif
 
-/**DOCDOC*/
+/** Set up code to handle generating error messages on crashes. */
 int
 configure_backtrace_handler(const char *tor_version)
 {
@@ -194,7 +190,8 @@ configure_backtrace_handler(const char *tor_version)
   return install_bt_handler();
 }
 
-/**DOCDOC*/
+/** Perform end-of-process cleanup for code that generates error messages on
+ * crashes.  */
 void
 clean_up_backtrace_handler(void)
 {