From: Nick Mathewson <nickm@torproject.org>
Date: Sat, 24 Aug 2019 21:46:08 +0000 (-0400)
Subject: clarify usage of __ and ___ prefixes on config options
X-Git-Tag: tor-0.4.2.1-alpha~68^2~1
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=cde662e259005887b897b5108e8a4b63f99abb59;p=thirdparty%2Ftor.git

clarify usage of __ and ___ prefixes on config options
---

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)