From: Nick Mathewson <nickm@torproject.org>
Date: Sat, 14 Mar 2015 18:27:33 +0000 (-0400)
Subject: Add comments for new functions
X-Git-Tag: tor-0.2.6.5-rc~3^2~1
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ddb1889eb8bc128ec0fca35f15b1bf90d2b629ac;p=thirdparty%2Ftor.git

Add comments for new functions
---

diff --git a/src/or/main.c b/src/or/main.c
index 888dabedc0..dd21b1a8f0 100644
--- a/src/or/main.c
+++ b/src/or/main.c
@@ -2087,6 +2087,10 @@ do_main_loop(void)
   return run_main_loop_until_done();
 }
 
+/**
+ * Run the main loop a single time. Return 0 for "exit"; -1 for "exit with
+ * error", and 1 for "run this again."
+ */
 static int
 run_main_loop_once(void)
 {
@@ -2139,6 +2143,11 @@ run_main_loop_once(void)
   return 1;
 }
 
+/** Run the run_main_loop_once() function until it declares itself done,
+ * and return its final return value.
+ *
+ * Shadow won't invoke this function, so don't fill it up with things.
+ */
 static int
 run_main_loop_until_done(void)
 {