[tor-commits] [tor/master] Document why dircache is not included in --list-modules

[nickm at torproject.org]

commit efb301c86c288c01e21dfb5da9f685f33341b2c2
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Jan 15 12:46:10 2020 -0500

    Document why dircache is not included in --list-modules
---
 configure.ac            | 2 +-
 src/app/config/config.c | 3 +++
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/configure.ac b/configure.ac
index 85ffc1c75..4571768d8 100644
--- a/configure.ac
+++ b/configure.ac
@@ -290,7 +290,7 @@ AM_COND_IF(BUILD_MODULE_RELAY,
                      [Compile with Relay feature support]))
 
 dnl Dircache module.  (This cannot be enabled or disabled independently of
-dnl the relay module.)
+dnl the relay module.  It is not listed by --list-modules for this reason.)
 AM_CONDITIONAL(BUILD_MODULE_DIRCACHE,
                [test "x$enable_module_relay" != "xno"])
 AM_COND_IF(BUILD_MODULE_DIRCACHE,
diff --git a/src/app/config/config.c b/src/app/config/config.c
index 9a5bb5265..1d4150089 100644
--- a/src/app/config/config.c
+++ b/src/app/config/config.c
@@ -2733,6 +2733,9 @@ list_enabled_modules(void)
 {
   printf("%s: %s\n", "relay", have_module_relay() ? "yes" : "no");
   printf("%s: %s\n", "dirauth", have_module_dirauth() ? "yes" : "no");
+  // We don't list dircache, because it cannot be enabled or disabled
+  // independently from relay.  Listing it here would proliferate
+  // test variants in test_parseconf.sh to no useful purpose.
 }
 
 /** Last value actually set by resolve_my_address. */