[tor-commits] [tor/master] Document config_var_is_dumpable and config_var_is_settable.
dgoulet at torproject.org
dgoulet at torproject.org
Wed Sep 11 14:02:05 UTC 2019
commit 3bf38ffff5fc4a6af34d576962ca74080bbd5d87
Author: Nick Mathewson <nickm at torproject.org>
Date: Thu Sep 5 11:48:27 2019 -0400
Document config_var_is_dumpable and config_var_is_settable.
---
src/app/config/confparse.c | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/src/app/config/confparse.c b/src/app/config/confparse.c
index 3d3f4e1bb..3341ee784 100644
--- a/src/app/config/confparse.c
+++ b/src/app/config/confparse.c
@@ -522,6 +522,10 @@ config_var_is_replaced_on_set(const config_var_t *var)
return ! struct_var_is_cumulative(&var->member);
}
+/**
+ * Return true iff <b>var</b> may be assigned by name (e.g., via the
+ * CLI, the configuration files, or the controller API).
+ **/
bool
config_var_is_settable(const config_var_t *var)
{
@@ -529,6 +533,7 @@ config_var_is_settable(const config_var_t *var)
return false;
return struct_var_is_settable(&var->member);
}
+
bool
config_var_is_contained(const config_var_t *var)
{
@@ -545,6 +550,14 @@ config_var_is_listable(const config_var_t *var)
return (var->flags & CVFLAG_INVISIBLE) == 0;
}
+/**
+ * Return true iff variable <b>var</b> should be written out when we
+ * are writing our configuration to disk, to a controller, or via the
+ * --dump-config command.
+ *
+ * This option may be set because a variable is hidden, or because it is
+ * derived from another variable which will already be written out.
+ **/
bool
config_var_is_dumpable(const config_var_t *var)
{
More information about the tor-commits
mailing list