commit 380d3ee1682ce5d202d754d442928710b477f59a Author: Nick Mathewson nickm@torproject.org Date: Mon Aug 26 19:36:17 2019 -0400
Better explain config_clear_fn_t --- src/app/config/confparse.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/src/app/config/confparse.h b/src/app/config/confparse.h index 9125c0be3..74ecb11a3 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,