[tor-commits] [tor/master] Deprecate the "--dump-config non-builtin" option

[dgoulet at torproject.org]

commit 62e1d983cf362d6769e763e8b50ab8a51bdc84d4
Author: Nick Mathewson <nickm at torproject.org>
Date:   Thu Jun 25 10:00:28 2020 -0400

    Deprecate the "--dump-config non-builtin" option
    
    When it works, "non-builtin" doesn't do anything different from
    "short".  (When it doesn't work, it gives an assertion failure.)
    
    Closes ticket #33398.
---
 changes/ticket33398 | 4 ++++
 doc/tor.1.txt       | 7 +++----
 src/app/main/main.c | 6 ++++--
 3 files changed, 11 insertions(+), 6 deletions(-)

diff --git a/changes/ticket33398 b/changes/ticket33398
new file mode 100644
index 000000000..bd175bad2
--- /dev/null
+++ b/changes/ticket33398
@@ -0,0 +1,4 @@
+  o Deprecated features:
+    - The "non-builtin" argument to the "--dump-config" command is now
+      deprecated.  When it works, it behaves the same as "short", which
+      you should use instead. Closes ticket 33398.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 15d5775e2..a7b3a6787 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -97,11 +97,10 @@ The following options in this section are only recognized on the
 [[opt-verify-config]] **`--verify-config`**::
     Verify whether the configuration file is valid.
 
-[[opt-dump-config]] **`--dump-config`** **`short`**|**`full`**|**`non-builtin`**::
-    Write a complete list of Tor's configured options to standard output.
+[[opt-dump-config]] **`--dump-config`** **`short`**|**`full`**::
+    Write a list of Tor's configured options to standard output.
     When the `short` flag is selected, only write the options that
-    are different from their default values.  When `non-builtin` is selected,
-    write options that are not zero or the empty string.
+    are different from their default values
     When `full` is selected, write every option.
 
 [[opt-serviceinstall]] **`--service install`** [**`--options`** __command-line options__]::
diff --git a/src/app/main/main.c b/src/app/main/main.c
index 32c34ea82..93f2c9c2d 100644
--- a/src/app/main/main.c
+++ b/src/app/main/main.c
@@ -775,12 +775,14 @@ do_dump_config(void)
   if (!strcmp(arg, "short")) {
     how = OPTIONS_DUMP_MINIMAL;
   } else if (!strcmp(arg, "non-builtin")) {
-    how = OPTIONS_DUMP_DEFAULTS;
+    // Deprecated since 0.4.5.1-alpha.
+    fprintf(stderr, "'non-builtin' is deprecated; use 'short' instead.\n");
+    how = OPTIONS_DUMP_MINIMAL;
   } else if (!strcmp(arg, "full")) {
     how = OPTIONS_DUMP_ALL;
   } else {
     fprintf(stderr, "No valid argument to --dump-config found!\n");
-    fprintf(stderr, "Please select 'short', 'non-builtin', or 'full'.\n");
+    fprintf(stderr, "Please select 'short' or 'full'.\n");
 
     return -1;
   }