diff options
author | Klaus Aehlig <klaus.aehlig@huawei.com> | 2024-01-09 12:10:40 +0100 |
---|---|---|
committer | Klaus Aehlig <klaus.aehlig@huawei.com> | 2024-01-09 15:58:52 +0100 |
commit | e15f11ce0a7813602d9627e95ae9fb125afa891e (patch) | |
tree | 8a7625b82d58403a732a64739263cfa3a42c9150 /src | |
parent | fc95fe665e603477dd8bfd68da703862713b4648 (diff) | |
download | justbuild-e15f11ce0a7813602d9627e95ae9fb125afa891e.tar.gz |
just-mr: don't make the command line pretend a fixed name
Our fetch and launch tool is parametric in the tool to be launched.
Reflect this in the documentation and do not pretend it to be the
name "just" hard coded. While there, also fix the hard-coded name
"git" in the documentation of the default value.
Diffstat (limited to 'src')
-rw-r--r-- | src/other_tools/just_mr/cli.hpp | 10 | ||||
-rw-r--r-- | src/other_tools/just_mr/main.cpp | 16 |
2 files changed, 16 insertions, 10 deletions
diff --git a/src/other_tools/just_mr/cli.hpp b/src/other_tools/just_mr/cli.hpp index b4f6607d..130b7611 100644 --- a/src/other_tools/just_mr/cli.hpp +++ b/src/other_tools/just_mr/cli.hpp @@ -186,7 +186,10 @@ static inline void SetupMultiRepoCommonArguments( "CA certificate bundle to use for SSL verification when fetching " "archives from remote.") ->type_name("CA_BUNDLE"); - app->add_option("--just", clargs->just_path, "Path to the just binary.") + app->add_option("--just", + clargs->just_path, + fmt::format("The build tool to be launched (default: {}).", + kDefaultJustPath)) ->type_name("PATH"); app->add_option("--main", clargs->main, @@ -202,7 +205,8 @@ static inline void SetupMultiRepoCommonArguments( ->type_name("RCFILE"); app->add_option("--git", clargs->git_path, - "Path to the git binary. (Default: \"git\")") + fmt::format("Path to the git binary. (Default: {})", + kDefaultGitPath)) ->type_name("PATH"); app->add_flag("--norc", clargs->norc, "Do not use any just-mrrc file."); app->add_option("-j, --jobs", @@ -229,7 +233,7 @@ static inline void SetupMultiRepoCommonArguments( "the flag must be used consistently for all related invocations."); app->add_option("-R,--remote-serve-address", clargs->remote_serve_address, - "Address of a remote 'just serve' service.") + "Address of a remote 'serve' service.") ->type_name("NAME:PORT"); app->add_flag("--fetch-absent", clargs->fetch_absent, diff --git a/src/other_tools/just_mr/main.cpp b/src/other_tools/just_mr/main.cpp index bee5243b..b1f0ed85 100644 --- a/src/other_tools/just_mr/main.cpp +++ b/src/other_tools/just_mr/main.cpp @@ -77,12 +77,13 @@ void SetupSetupCommandArguments( [[nodiscard]] auto ParseCommandLineArguments(int argc, char const* const* argv) -> CommandLineArguments { CLI::App app( - "just-mr, a multi-repository configuration tool and launcher for just"); + "just-mr, a multi-repository configuration tool and launcher for the " + "build tool"); app.option_defaults()->take_last(); auto* cmd_mrversion = app.add_subcommand( "mrversion", "Print version information in JSON format of this tool."); - auto* cmd_setup = - app.add_subcommand("setup", "Setup and generate just configuration"); + auto* cmd_setup = app.add_subcommand( + "setup", "Setup and generate configuration for the build tool"); auto* cmd_setup_env = app.add_subcommand( "setup-env", "Setup without workspace root for the main repository."); auto* cmd_fetch = @@ -91,15 +92,16 @@ void SetupSetupCommandArguments( "update", "Advance Git commit IDs and print updated just-mr configuration."); auto* cmd_do = app.add_subcommand( - "do", "Canonical way of specifying just subcommands."); + "do", "Canonical way of specifying subcommands to be launched."); cmd_do->set_help_flag(); // disable help flag // define just subcommands std::vector<CLI::App*> cmd_just_subcmds{}; cmd_just_subcmds.reserve(kKnownJustSubcommands.size()); for (auto const& known_subcmd : kKnownJustSubcommands) { - auto* subcmd = app.add_subcommand( - known_subcmd.first, - "Run setup and call \"just " + known_subcmd.first + "\"."); + auto* subcmd = + app.add_subcommand(known_subcmd.first, + "Run setup and launch the \"" + + known_subcmd.first + "\" subcommand."); subcmd->set_help_flag(); // disable help flag cmd_just_subcmds.emplace_back(subcmd); } |