diff options
| author | Nick Mathewson <nickm@torproject.org> | 2019-11-11 11:54:02 -0500 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2019-11-11 11:54:02 -0500 |
| commit | 9d562bba40d1e56ba459467611c815ab8d27f27e (patch) | |
| tree | ab199a1992b697e76c1f7bb836e1c564d0d3617a /src/lib/conf | |
| parent | a08969e460af2834c037761e96e2c1e9fedf5b14 (diff) | |
| download | tor-9d562bba40d1e56ba459467611c815ab8d27f27e.tar.gz tor-9d562bba40d1e56ba459467611c815ab8d27f27e.zip | |
clarify OBSOLETE vs IGNORE.
Diffstat (limited to 'src/lib/conf')
| -rw-r--r-- | src/lib/conf/conftypes.h | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/src/lib/conf/conftypes.h b/src/lib/conf/conftypes.h index ea1c8d4764..19ea997316 100644 --- a/src/lib/conf/conftypes.h +++ b/src/lib/conf/conftypes.h @@ -64,8 +64,18 @@ typedef enum config_type_t { CONFIG_TYPE_LINELIST_V, /**< Catch-all "virtual" option to summarize * context-sensitive config lines when fetching. */ - CONFIG_TYPE_OBSOLETE, /**< Ignored (obsolete) option. Uses no storage. */ - CONFIG_TYPE_IGNORE, /**< Ignored option. Uses no storage. */ + /** Ignored (obsolete) option. Uses no storage. + * + * Reported as "obsolete" when its type is queried. + */ + CONFIG_TYPE_OBSOLETE, + /** Ignored option. Uses no storage. + * + * Reported as "ignored" when its type is queried. For use with options used + * by disabled modules. + **/ + CONFIG_TYPE_IGNORE, + /** * Extended type: definition appears in the <b>type_def</b> pointer * of the corresponding struct_member_t. |