Add better help on what tracing destinations exist

project-chip · Jun 13, 2023 · a2690dc · a2690dc
1 parent 2c229fd
commit a2690dc
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 5 deletions.
diff --git a/examples/chip-tool/commands/common/CHIPCommand.h b/examples/chip-tool/commands/common/CHIPCommand.h
@@ -24,6 +24,7 @@
 
 #include "Command.h"
 
+#include <TracingCommandLinArgument.h>
 #include <commands/common/CredentialIssuerCommands.h>
 #include <commands/example/ExampleCredentialIssuerCommands.h>
 #include <credentials/GroupDataProviderImpl.h>
@@ -85,7 +86,7 @@ class CHIPCommand : public Command
         AddArgument("trace_log", 0, 1, &mTraceLog);
         AddArgument("trace_decode", 0, 1, &mTraceDecode);
 #endif // CHIP_CONFIG_TRANSPORT_TRACE_ENABLED
-        AddArgument("trace-to", &mTraceTo, "Trace destinations, comma-separated (e.g. log)");
+        AddArgument("trace-to", &mTraceTo, "Trace destinations, comma-separated (" SUPPORTED_COMMAND_LINE_TRACING_TARGETS ")");
         AddArgument("ble-adapter", 0, UINT16_MAX, &mBleAdapterId);
         AddArgument("storage-directory", &mStorageDirectory,
                     "Directory to place chip-tool's storage files in.  Defaults to $TMPDIR, with fallback to /tmp");

diff --git a/examples/common/tracing/TracingCommandLineArgument.h b/examples/common/tracing/TracingCommandLineArgument.h
@@ -17,9 +17,14 @@
  */
 #pragma once
 
+/// A string with supported command line tracing targets
+/// to be pretty-printed in help strings if needed
+#define SUPPORTED_COMMAND_LINE_TRACING_TARGETS "log"
+
 namespace chip {
 namespace CommandLineApp {
 
+
 /// Enable tracing based on the given command line argument
 /// like "log" or "log,perfetto" or similar
 ///

diff --git a/examples/minimal-mdns/advertiser.cpp b/examples/minimal-mdns/advertiser.cpp
@@ -236,7 +236,7 @@ OptionSet cmdLineOptions = { HandleOptions, cmdLineOptionsDef, "PROGRAM OPTIONS"
                              "        Operational node id.\n"
                              "  -t <dest>\n"
                              "  --trace-to <dest>\n"
-                             "        trace to the given destination.\n"
+                             "        trace to the given destination (supported: " SUPPORTED_COMMAND_LINE_TRACING_TARGETS ").\n"
                              "\n" };
 
 HelpOptions helpOptions("advertiser", "Usage: advertiser [options]", "1.0");

diff --git a/examples/minimal-mdns/client.cpp b/examples/minimal-mdns/client.cpp
@@ -170,7 +170,7 @@ OptionSet cmdLineOptions = { HandleOptions, cmdLineOptionsDef, "PROGRAM OPTIONS"
                              "  --multicast-reply\n"
                              "        Do not request unicast replies\n"
                              "  --trace-to <dest>\n"
-                             "        trace to the given destination.\n"
+                             "        trace to the given destination (supported: " SUPPORTED_COMMAND_LINE_TRACING_TARGETS ").\n"
                              "\n" };
 
 HelpOptions helpOptions("minimal-mdns-client", "Usage: minimal-mdns-client [options]", "1.0");

diff --git a/examples/minimal-mdns/server.cpp b/examples/minimal-mdns/server.cpp
@@ -109,7 +109,7 @@ OptionSet cmdLineOptions = { HandleOptions, cmdLineOptionsDef, "PROGRAM OPTIONS"
                              "        instance name to advertise.\n"
                              "  -t <dest>\n"
                              "  --trace-to <dest>\n"
-                             "        trace to the given destination.\n"
+                             "        trace to the given destination (supported: " SUPPORTED_COMMAND_LINE_TRACING_TARGETS ").\n"
                              "\n" };
 
 HelpOptions helpOptions("minimal-mdns-server", "Usage: minimal-mdns-server [options]", "1.0");

diff --git a/src/lib/address_resolve/tool.cpp b/src/lib/address_resolve/tool.cpp
@@ -45,7 +45,7 @@ const char * const sHelp =
     "Usage: address-resolve-tool [<options...>] <command> [ <args...> ]\n"
     "\n"
     "Options:\n"
-    "   --trace-to <dest> -- Trace to the given destination\n"
+    "   --trace-to <dest> -- Trace to the given destination (" SUPPORTED_COMMAND_LINE_TRACING_TARGETS ")\n"
     "Commands:\n"
     "\n"
     "    node <nodeid> <compressed_fabricid> -- Find the node for the given node/fabric.\n"