Merge pull request #5564 from twinstar26/master

Add log channels to Aleth command-line help output

Author: gumb0

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - Added: [#5537](https://github.com/ethereum/aleth/pull/5537) Creating Ethereum Node Record (ENR) at program start.
 - Added: [#5557](https://github.com/ethereum/aleth/pull/5557) Improved debug logging of full sync.
+- Added: [#5564](https://github.com/ethereum/aleth/pull/5564) Improved help output of Aleth by adding list of channels.
 - Changed: [#5559](https://github.com/ethereum/aleth/pull/5559) Update peer validation error messages.
 - Fixed: [#5562](https://github.com/ethereum/aleth/pull/5562) Don't send header request messages to peers that haven't sent us Status yet.
 - Changed: [#5568](https://github.com/ethereum/aleth/pull/5568) Improve rlpx handshake log messages and create new rlpx log channel.

aleth/main.cpp

@@ -321,9 +321,12 @@ int main(int argc, char** argv)
     addImportExportOption("import-snapshot", po::value<string>()->value_name("<path>"),
         "Import blockchain and state data from the Parity Warp Sync snapshot\n");
 
+    std::string const logChannels =
+        "block blockhdr bq chain client debug discov error ethcap exec host impolite info net "
+        "overlaydb peer rlpx rpc snap statedb sync timer tq trace vmtrace warn watch";
     LoggingOptions loggingOptions;
     po::options_description loggingProgramOptions(
-        createLoggingProgramOptions(c_lineWidth, loggingOptions));
+        createLoggingProgramOptions(c_lineWidth, loggingOptions, logChannels));
 
     po::options_description generalOptions("GENERAL OPTIONS", c_lineWidth);
     auto addGeneralOption = generalOptions.add_options();

libdevcore/LoggingProgramOptions.cpp

@@ -21,17 +21,22 @@ namespace po = boost::program_options;
 
 namespace dev
 {
-po::options_description createLoggingProgramOptions(unsigned _lineLength, LoggingOptions& _options)
+po::options_description createLoggingProgramOptions(
+    unsigned _lineLength, LoggingOptions& _options, std::string const& _logChannels)
 {
     po::options_description optionsDescr("LOGGING OPTIONS", _lineLength);
     auto addLoggingOption = optionsDescr.add_options();
     addLoggingOption("log-verbosity,v", po::value<int>(&_options.verbosity)->value_name("<0 - 4>"),
         "Set the log verbosity from 0 to 4 (default: 2).");
+
+    std::string const logChannelsDescription =
+        "Space-separated list of the log channels to show (default: show all channels)." +
+        (_logChannels.empty() ? "" : "\nChannels: " + _logChannels);
     addLoggingOption("log-channels",
         po::value<std::vector<std::string>>(&_options.includeChannels)
             ->value_name("<channel_list>")
             ->multitoken(),
-        "Space-separated list of the log channels to show (default: show all channels).");
+        logChannelsDescription.c_str());
     addLoggingOption("log-exclude-channels",
         po::value<std::vector<std::string>>(&_options.excludeChannels)
             ->value_name("<channel_list>")

libdevcore/LoggingProgramOptions.h

@@ -23,6 +23,6 @@
 namespace dev
 {
 boost::program_options::options_description createLoggingProgramOptions(
-    unsigned _lineLength, LoggingOptions& _options);
+    unsigned _lineLength, LoggingOptions& _options, std::string const& _logChannels = {});
 
 }  // namespace dev