Commit 478141e6 authored by Nick Mathewson's avatar Nick Mathewson 🐦 Committed by David Goulet
Browse files

Document inconsistent usage of config_var_is_listable()

See also ticket 31654.
parent e61bfd0b
......@@ -2666,6 +2666,9 @@ list_torrc_options(void)
{
smartlist_t *vars = config_mgr_list_vars(get_options_mgr());
SMARTLIST_FOREACH_BEGIN(vars, const config_var_t *, var) {
/* Possibly this should check listable, rather than (or in addition to)
* settable. See ticket 31654.
*/
if (! config_var_is_settable(var)) {
/* This variable cannot be set, or cannot be set by this name. */
continue;
......@@ -2680,6 +2683,8 @@ static void
list_deprecated_options(void)
{
smartlist_t *deps = config_mgr_list_deprecated_vars(get_options_mgr());
/* Possibly this should check whether the variables are listable,
* but currently it does not. See ticket 31654. */
SMARTLIST_FOREACH(deps, const char *, name,
printf("%s\n", name));
smartlist_free(deps);
......@@ -8142,6 +8147,8 @@ getinfo_helper_config(control_connection_t *conn,
} else if (!strcmp(question, "config/defaults")) {
smartlist_t *sl = smartlist_new();
int dirauth_lines_seen = 0, fallback_lines_seen = 0;
/* Possibly this should check whether the variables are listable,
* but currently it does not. See ticket 31654. */
smartlist_t *vars = config_mgr_list_vars(get_options_mgr());
SMARTLIST_FOREACH_BEGIN(vars, const config_var_t *, var) {
if (var->initvalue != NULL) {
......
......@@ -592,6 +592,12 @@ config_var_needs_copy(const config_var_t *var)
/**
* Return true iff variable <b>var</b> should appear on list of variable
* names given to the controller or the CLI.
*
* (Note that this option is imperfectly obeyed. The
* --list-torrc-options command looks at the "settable" flag, whereas
* "GETINFO config/defaults" and "list_deprecated_*()" do not filter
* their results. It would be good for consistency to try to converge
* these behaviors in the future.)
**/
bool
config_var_is_listable(const config_var_t *var)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment