tor

commit 12d980027a52fd8a5c0a5f0c4088ce91b15f0a92
parent 9cfc811c377be8e30532b6faef78e3c97f0ae7e8
Author: Nick Mathewson <nickm@torproject.org>
Date:   Mon, 26 Aug 2019 19:21:26 -0400

document return lifespans for config_mgr_list_vars()

Diffstat:
M
src/app/config/confparse.c
 | 
6
++++--

1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/src/app/config/confparse.c b/src/app/config/confparse.c
@@ -306,7 +306,7 @@ config_mgr_free_(config_mgr_t *mgr)
 
 /** Return a new smartlist_t containing a config_var_t for every variable that
  * <b>mgr</b> knows about.  The elements of this smartlist do not need
- * to be freed. */
+ * to be freed; they have the same lifespan as <b>mgr</b>. */
 smartlist_t *
 config_mgr_list_vars(const config_mgr_t *mgr)
 {
@@ -318,7 +318,9 @@ config_mgr_list_vars(const config_mgr_t *mgr)
 }
 
 /** Return a new smartlist_t containing the names of all deprecated variables.
- * The elements of this smartlist do not need to be freed. */
+ * The elements of this smartlist do not need to be freed; they have the same
+ * lifespan as <b>mgr</b>.
+ */
 smartlist_t *
 config_mgr_list_deprecated_vars(const config_mgr_t *mgr)
 {