aboutsummaryrefslogtreecommitdiff
path: root/src/app
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-08-26 19:36:17 -0400
committerNick Mathewson <nickm@torproject.org>2019-08-28 09:42:17 -0400
commit380d3ee1682ce5d202d754d442928710b477f59a (patch)
tree3ec99f19ef7d6c852ccbe1a4db5578fba5db3a56 /src/app
parent06da2c0d28e41c5a230d96ae8e4f72471bccb5d3 (diff)
downloadtor-380d3ee1682ce5d202d754d442928710b477f59a.tar.gz
tor-380d3ee1682ce5d202d754d442928710b477f59a.zip
Better explain config_clear_fn_t
Diffstat (limited to 'src/app')
-rw-r--r--src/app/config/confparse.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/app/config/confparse.h b/src/app/config/confparse.h
index 9125c0be3d..74ecb11a36 100644
--- a/src/app/config/confparse.h
+++ b/src/app/config/confparse.h
@@ -41,7 +41,13 @@ typedef int (*validate_fn_t)(void*,void*,void*,int,char**);
struct config_mgr_t;
-/** Callback to clear all non-managed fields of a configuration object. */
+/**
+ * Callback to clear all non-managed fields of a configuration object.
+ *
+ * (Regular fields get cleared by config_reset(), but you might have fields
+ * in the object that do not correspond to configuration variables. If those
+ * fields need to be cleared or freed, this is where to do it.)
+ */
typedef void (*clear_cfg_fn_t)(const struct config_mgr_t *mgr, void*);
/** Information on the keys, value types, key-to-struct-member mappings,