aboutsummaryrefslogtreecommitdiff
path: root/src/lib/conf
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-08-24 17:46:08 -0400
committerNick Mathewson <nickm@torproject.org>2019-08-24 17:46:08 -0400
commitcde662e259005887b897b5108e8a4b63f99abb59 (patch)
tree8eebfd0e53216b585899055a34e6d90dd4715920 /src/lib/conf
parent078ba326a1255dbfbb442219c599e7961f4f85e2 (diff)
downloadtor-cde662e259005887b897b5108e8a4b63f99abb59.tar.gz
tor-cde662e259005887b897b5108e8a4b63f99abb59.zip
clarify usage of __ and ___ prefixes on config options
Diffstat (limited to 'src/lib/conf')
-rw-r--r--src/lib/conf/conftypes.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/lib/conf/conftypes.h b/src/lib/conf/conftypes.h
index 3b754e07be..fabad97d0c 100644
--- a/src/lib/conf/conftypes.h
+++ b/src/lib/conf/conftypes.h
@@ -112,12 +112,14 @@ typedef struct struct_magic_decl_t {
#define CVFLAG_OBSOLETE (1u<<0)
/**
* Flag to indicate that an option is undumpable. An undumpable option is
- * never saved to disk, and is prefixed with __.
+ * never saved to disk. For historical reasons it is prefixed with __ but
+ * not with ___.
**/
#define CVFLAG_NODUMP (1u<<1)
/**
* Flag to indicate that an option is "invisible". An invisible option
* is always undumpable, and we don't tell the controller about it.
+ * For historical reasons it is prefixed with ___.
**/
#define CVFLAG_INVISIBLE (1u<<2)