From: Otto Moerbeek <otto.moerbeek@open-xchange.com>
Date: Mon, 30 Jan 2023 10:39:11 +0000 (+0100)
Subject: Man page and help changes for new syntax
X-Git-Tag: dnsdist-1.8.0-rc1~38^2~7
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3c54b6612c6a9ecd578d0d997638d8d35a72262e;p=thirdparty%2Fpdns.git

Man page and help changes for new syntax
---

diff --git a/pdns/recursordist/docs/manpages/rec_control.1.rst b/pdns/recursordist/docs/manpages/rec_control.1.rst
index 7b464ff217..c78fccbbc7 100644
--- a/pdns/recursordist/docs/manpages/rec_control.1.rst
+++ b/pdns/recursordist/docs/manpages/rec_control.1.rst
@@ -286,8 +286,12 @@ top-timeouts
     Shows the top-20 most active downstream timeout destinations.
     Statistics are over the last 'stats-ringbuffer-entries' queries.
 
-trace-regex *REGEX*
-    Emit resolution trace for matching queries. Empty regex to disable trace.
+trace-regex *REGEX* *FILE*
+    Emit resolution trace for matching queries. No arguments disables tracing.
+    Before version 4.9.0, there was no *FILE* argument, traces were always
+    written to the log. Starting with version 4.9.0, trace information is
+    written to the file specified, which may be ``-`` for the standard out
+    stream.
 
     Queries matching this regular expression will generate voluminous tracing
     output. Be aware that matches from the packet cache will still not generate
diff --git a/pdns/recursordist/pdns_recursor.cc b/pdns/recursordist/pdns_recursor.cc
index 1d7ddd6ce0..1dbf5bb171 100644
--- a/pdns/recursordist/pdns_recursor.cc
+++ b/pdns/recursordist/pdns_recursor.cc
@@ -838,8 +838,6 @@ static bool isEnabledForUDRs(const std::shared_ptr<std::vector<std::unique_ptr<F
 }
 #endif // HAVE_FSTRM
 
-const char* timestamp(const struct timeval& tv, char* buf, size_t sz);
-
 static void dumpTrace(const string& trace, const timeval& timev)
 {
   if (trace.empty()) {
diff --git a/pdns/recursordist/rec_channel_rec.cc b/pdns/recursordist/rec_channel_rec.cc
index 36dcfb1db2..2766c7cf57 100644
--- a/pdns/recursordist/rec_channel_rec.cc
+++ b/pdns/recursordist/rec_channel_rec.cc
@@ -2110,7 +2110,7 @@ RecursorControlChannel::Answer RecursorControlParser::getAnswer(int s, const str
             "set-carbon-server                set a carbon server for telemetry\n"
             "set-dnssec-log-bogus SETTING     enable (SETTING=yes) or disable (SETTING=no) logging of DNSSEC validation failures\n"
             "set-event-trace-enabled SETTING  set logging of event trace messages, 0 = disabled, 1 = protobuf, 2 = log file, 3 = both\n"
-            "trace-regex [regex]              emit resolution trace for matching queries (empty regex to clear trace)\n"
+            "trace-regex [regex file]         emit resolution trace for matching queries (no arguments clears tracing)\n"
             "top-largeanswer-remotes          show top remotes receiving large answers\n"
             "top-queries                      show top queries\n"
             "top-pub-queries                  show top queries grouped by public suffix list\n"
diff --git a/pdns/recursordist/syncres.hh b/pdns/recursordist/syncres.hh
index 8554398386..b500c143ff 100644
--- a/pdns/recursordist/syncres.hh
+++ b/pdns/recursordist/syncres.hh
@@ -922,6 +922,7 @@ uint64_t* pleaseGetPacketCacheHits();
 uint64_t* pleaseGetPacketCacheSize();
 void doCarbonDump(void*);
 bool primeHints(time_t now = time(nullptr));
+const char* timestamp(const struct timeval& tv, char* buf, size_t sz);
 
 struct WipeCacheResult
 {