diff options
| author | Nick Mathewson <nickm@torproject.org> | 2019-09-05 11:48:27 -0400 |
|---|---|---|
| committer | David Goulet <dgoulet@torproject.org> | 2019-09-11 09:42:19 -0400 |
| commit | 3bf38ffff5fc4a6af34d576962ca74080bbd5d87 (patch) | |
| tree | 12416b2d43c15f2afee2f81c48fbaee5eba33494 /src/app | |
| parent | 16cf9424c1480aea2443f6995d1056e8f04ba5e3 (diff) | |
| download | tor-3bf38ffff5fc4a6af34d576962ca74080bbd5d87.tar.gz tor-3bf38ffff5fc4a6af34d576962ca74080bbd5d87.zip | |
Document config_var_is_dumpable and config_var_is_settable.
Diffstat (limited to 'src/app')
| -rw-r--r-- | src/app/config/confparse.c | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/src/app/config/confparse.c b/src/app/config/confparse.c index 3d3f4e1bb1..3341ee7844 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) { |