torproject/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-12-06 19:41:15 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document config_var_is_dumpable and config_var_is_settable.

Browse Source
This commit is contained in:
Nick Mathewson
2019-09-05 11:48:27 -04:00
committed by David Goulet
parent 16cf9424c1
commit 3bf38ffff5
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/app/config/confparse.c
+13
View File
@@ -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)
{