]> git.ipfire.org Git - thirdparty/tor.git/commitdiff
Update the documentation in tor_api.h
authorNick Mathewson <nickm@torproject.org>
Tue, 13 Mar 2018 09:00:41 +0000 (10:00 +0100)
committerNick Mathewson <nickm@torproject.org>
Tue, 13 Mar 2018 09:00:41 +0000 (10:00 +0100)
src/or/tor_api.h

index 7e86c7fec5859071a7e59a7909470c930357eef6..6d4a9518e0c1150e6a614ccce1668fb486ee1263 100644 (file)
@@ -66,14 +66,12 @@ void tor_main_configuration_free(tor_main_configuration_t *cfg);
  * This function will not return until Tor is done running.  It returns zero
  * on success, and nonzero on failure.
  *
- * BUG 23848: In many cases, tor_main will call exit() or abort() instead of
- * returning.  This is not the intended long-term behavior; we are trying to
- * fix it.
- *
- * BUG 23847: You can only call tor_main() once in a single process; if it
- * returns and you call it again, you may crash, or you may encounter other
- * unexpected behavior, including possible security issues.  This is not
- * intended long-term behavior; we are trying to fix it.
+ * If you want to control when Tor exits, make sure to configure a control
+ * socket. The OwningControllerFD option may be helpful there.
+ *
+ * BUG 23847: Sometimes, if you call tor_main a second time (after it has
+ * returned), Tor may crash or behave strangely.  We have fixed all issues of
+ * this type that we could find, but more may remain.
  *
  * LIMITATION: You cannot run more than one instance of Tor in the same
  * process at the same time. Concurrent calls will cause undefined behavior.