[cli] Document available settings keys for set cmd

Refactor to reduce duplication.
canonical · Sep 27, 2019 · ec8fcd2 · ec8fcd2
1 parent 7245eab
commit ec8fcd2
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 6 deletions.
diff --git a/src/client/cli/cmd/common_cli.cpp b/src/client/cli/cmd/common_cli.cpp
@@ -21,6 +21,7 @@
 #include <multipass/cli/argparser.h>
 #include <multipass/cli/format_utils.h>
 #include <multipass/exceptions/settings_exceptions.h>
+#include <multipass/settings.h>
 
 #include <fmt/ostream.h>
 #include <sstream>
@@ -154,3 +155,10 @@ auto cmd::return_code_from(const mp::SettingsException& e) -> mp::ReturnCode
 {
     return dynamic_cast<const InvalidSettingsException*>(&e) ? ReturnCode::CommandLineError : ReturnCode::CommandFail;
 }
+
+QString multipass::cmd::describe_settings_keys()
+{
+    const auto keys = Settings::instance().keys();
+    return std::accumulate(cbegin(keys), cend(keys), QStringLiteral("Keys:"),
+                           [](const auto& a, const auto& b) { return a + "\n  " + b; });
+}
diff --git a/src/client/cli/cmd/common_cli.h b/src/client/cli/cmd/common_cli.h
@@ -46,6 +46,7 @@ std::string instance_action_message_for(const InstanceNames& instance_names, con
 ReturnCode run_cmd(const QStringList& args, const ArgParser* parser, std::ostream& cout, std::ostream& cerr);
 ReturnCode run_cmd_and_retry(const QStringList& args, const ArgParser* parser, std::ostream& cout, std::ostream& cerr);
 ReturnCode return_code_from(const SettingsException& e);
+QString describe_settings_keys();
 
 // helpers for update handling
 bool update_available(const multipass::UpdateInfo& update_info);

diff --git a/src/client/cli/cmd/get.cpp b/src/client/cli/cmd/get.cpp
@@ -60,11 +60,8 @@ QString cmd::Get::short_help() const
 
 QString cmd::Get::description() const
 {
-    auto desc = QStringLiteral("Get the configuration setting corresponding to the given key.\n\n"
-                               "Keys:");
-    const auto keys = Settings::instance().keys();
-
-    return std::accumulate(cbegin(keys), cend(keys), desc, [](const auto& a, const auto& b) { return a + "\n  " + b; });
+    auto desc = QStringLiteral("Get the configuration setting corresponding to the given key.");
+    return desc + "\n\n" + describe_settings_keys();
 }
 
 mp::ParseCode cmd::Get::parse_args(mp::ArgParser* parser)

diff --git a/src/client/cli/cmd/set.cpp b/src/client/cli/cmd/set.cpp
@@ -101,7 +101,8 @@ QString cmd::Set::short_help() const
 
 QString cmd::Set::description() const
 {
-    return QStringLiteral("Set, to the given value, the configuration setting corresponding to the given key");
+    auto desc = QStringLiteral("Set, to the given value, the configuration setting corresponding to the given key.");
+    return desc + "\n\n" + describe_settings_keys();
 }
 
 mp::ParseCode cmd::Set::parse_args(mp::ArgParser* parser)