[tor-commits] [tor/master] clarify usage of __ and ___ prefixes on config options

[dgoulet at torproject.org]

commit cde662e259005887b897b5108e8a4b63f99abb59
Author: Nick Mathewson <nickm at torproject.org>
Date:   Sat Aug 24 17:46:08 2019 -0400

    clarify usage of __ and ___ prefixes on config options
---
 src/lib/conf/conftypes.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/lib/conf/conftypes.h b/src/lib/conf/conftypes.h
index 3b754e07b..fabad97d0 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)