Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the help text of the --quiet args for all commands #10080

Merged
merged 1 commit into from
Nov 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/bin/cargo/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@ See 'cargo help <command>' for more information on a specific command.\n",
.multiple(true)
.global(true),
)
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(
opt("color", "Coloring: auto, always, never")
.value_name("WHEN")
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/bench.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ pub fn cli() -> App {
subcommand("bench")
.setting(AppSettings::TrailingVarArg)
.about("Execute all benchmarks of a local package")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(
Arg::with_name("BENCHNAME")
.help("If specified, only run benches containing this string in their names"),
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ pub fn cli() -> App {
// subcommand aliases are handled in aliased_command()
// .alias("b")
.about("Compile a local package and all of its dependencies")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg_package_spec(
"Package to build (see `cargo help pkgid`)",
"Build all packages in the workspace",
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/check.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ pub fn cli() -> App {
// subcommand aliases are handled in aliased_command()
// .alias("c")
.about("Check a local package and all of its dependencies for errors")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg_package_spec(
"Package(s) to check",
"Check all packages in the workspace",
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/clean.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use cargo::util::print_available_packages;
pub fn cli() -> App {
subcommand("clean")
.about("Remove artifacts that cargo has generated in the past")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg_package_spec_simple("Package to clean artifacts for")
.arg_manifest_path()
.arg_target_triple("Target triple to clean output for")
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ pub fn cli() -> App {
// subcommand aliases are handled in aliased_command()
// .alias("d")
.about("Build a package's documentation")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(opt(
"open",
"Opens the docs in a browser after the operation",
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/fetch.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use cargo::ops::FetchOptions;
pub fn cli() -> App {
subcommand("fetch")
.about("Fetch dependencies of a package from the network")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg_manifest_path()
.arg_target_triple("Fetch dependencies for the target triple")
.after_help("Run `cargo help fetch` for more detailed information.\n")
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/fix.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use cargo::ops::{self, CompileFilter, FilterRule, LibRule};
pub fn cli() -> App {
subcommand("fix")
.about("Automatically fix lint warnings reported by rustc")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg_package_spec(
"Package(s) to fix",
"Fix all packages in the workspace",
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/generate_lockfile.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use cargo::ops;
pub fn cli() -> App {
subcommand("generate-lockfile")
.about("Generate the lockfile for a package")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg_manifest_path()
.after_help("Run `cargo help generate-lockfile` for more detailed information.\n")
}
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/init.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use cargo::ops;
pub fn cli() -> App {
subcommand("init")
.about("Create a new cargo package in an existing directory")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(Arg::with_name("path").default_value("."))
.arg(opt("registry", "Registry to use").value_name("REGISTRY"))
.arg_new_opts()
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/install.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use cargo::util::IntoUrl;
pub fn cli() -> App {
subcommand("install")
.about("Install a Rust binary. Default location is $HOME/.cargo/bin")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(Arg::with_name("crate").empty_values(false).multiple(true))
.arg(
opt("version", "Specify a version to install")
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/locate_project.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use serde::Serialize;
pub fn cli() -> App {
subcommand("locate-project")
.about("Print a JSON representation of a Cargo.toml file's location")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg_manifest_path()
.arg(
opt(
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/login.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ pub fn cli() -> App {
"Save an api token from the registry locally. \
If token is not specified, it will be read from stdin.",
)
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(Arg::with_name("token"))
// --host is deprecated (use --registry instead)
.arg(
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/logout.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use cargo::ops;
pub fn cli() -> App {
subcommand("logout")
.about("Remove an API token from the registry locally")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(opt("registry", "Registry to use").value_name("REGISTRY"))
.after_help("Run `cargo help logout` for more detailed information.\n")
}
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/new.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use cargo::ops;
pub fn cli() -> App {
subcommand("new")
.about("Create a new cargo package at <path>")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(Arg::with_name("path").required(true))
.arg(opt("registry", "Registry to use").value_name("REGISTRY"))
.arg_new_opts()
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/owner.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use cargo::ops::{self, OwnersOptions};
pub fn cli() -> App {
subcommand("owner")
.about("Manage the owners of a crate on the registry")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(Arg::with_name("crate"))
.arg(
multi_opt(
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/package.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use cargo::ops::{self, PackageOpts};
pub fn cli() -> App {
subcommand("package")
.about("Assemble the local package into a distributable tarball")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(
opt(
"list",
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/pkgid.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use cargo::util::print_available_packages;
pub fn cli() -> App {
subcommand("pkgid")
.about("Print a fully qualified package specification")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(Arg::with_name("spec"))
.arg_package("Argument to get the package ID specifier for")
.arg_manifest_path()
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/publish.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use cargo::ops::{self, PublishOpts};
pub fn cli() -> App {
subcommand("publish")
.about("Upload a package to the registry")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg_index()
.arg(opt("token", "Token to use when uploading").value_name("TOKEN"))
.arg(opt(
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/read_manifest.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Print a JSON representation of a Cargo.toml manifest.
Deprecated, use `cargo metadata --no-deps` instead.\
",
)
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg_manifest_path()
}

Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/run.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ pub fn cli() -> App {
// .alias("r")
.setting(AppSettings::TrailingVarArg)
.about("Run a binary or example of the local package")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(Arg::with_name("args").multiple(true))
.arg_targets_bin_example(
"Name of the bin target to run",
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/rustc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ pub fn cli() -> App {
subcommand("rustc")
.setting(AppSettings::TrailingVarArg)
.about("Compile a package, and pass extra options to the compiler")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(Arg::with_name("args").multiple(true).help("Rustc flags"))
.arg_package("Package to build")
.arg_jobs()
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/rustdoc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ pub fn cli() -> App {
subcommand("rustdoc")
.setting(AppSettings::TrailingVarArg)
.about("Build a package's documentation, using specified custom flags.")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(Arg::with_name("args").multiple(true))
.arg(opt(
"open",
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/search.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use cargo::ops;
pub fn cli() -> App {
subcommand("search")
.about("Search packages in crates.io")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(Arg::with_name("query").multiple(true))
.arg_index()
.arg(
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/uninstall.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use cargo::ops;
pub fn cli() -> App {
subcommand("uninstall")
.about("Remove a Rust binary")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(Arg::with_name("spec").multiple(true))
.arg_package_spec_simple("Package to uninstall")
.arg(multi_opt("bin", "NAME", "Only uninstall the binary NAME"))
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/update.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use cargo::util::print_available_packages;
pub fn cli() -> App {
subcommand("update")
.about("Update dependencies as recorded in the local lock file")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(opt("workspace", "Only update the workspace packages").short("w"))
.arg_package_spec_simple("Package to update")
.arg(opt(
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/vendor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use std::path::PathBuf;
pub fn cli() -> App {
subcommand("vendor")
.about("Vendor all dependencies for a project locally")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg_manifest_path()
.arg(Arg::with_name("path").help("Where to vendor crates (`vendor` by default)"))
.arg(
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/verify_project.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use std::process;
pub fn cli() -> App {
subcommand("verify-project")
.about("Check correctness of crate manifest")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg_manifest_path()
.after_help("Run `cargo help verify-project` for more detailed information.\n")
}
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/version.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use crate::command_prelude::*;
pub fn cli() -> App {
subcommand("version")
.about("Show version information")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.after_help("Run `cargo help version` for more detailed information.\n")
}

Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/yank.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use cargo::ops;
pub fn cli() -> App {
subcommand("yank")
.about("Remove a pushed crate from the index")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg(Arg::with_name("crate"))
.arg(
opt("vers", "The version to yank or un-yank")
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-bench.txt
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ OPTIONS
value <https://doc.rust-lang.org/cargo/reference/config.html>.

-q, --quiet
No output printed to stdout.
Do not print cargo log messages.

--color when
Control when colored output is used. Valid values:
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-build.txt
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ OPTIONS
value <https://doc.rust-lang.org/cargo/reference/config.html>.

-q, --quiet
No output printed to stdout.
Do not print cargo log messages.

--color when
Control when colored output is used. Valid values:
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-check.txt
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ OPTIONS
value <https://doc.rust-lang.org/cargo/reference/config.html>.

-q, --quiet
No output printed to stdout.
Do not print cargo log messages.

--color when
Control when colored output is used. Valid values:
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-clean.txt
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ OPTIONS
value <https://doc.rust-lang.org/cargo/reference/config.html>.

-q, --quiet
No output printed to stdout.
Do not print cargo log messages.

--color when
Control when colored output is used. Valid values:
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ OPTIONS
value <https://doc.rust-lang.org/cargo/reference/config.html>.

-q, --quiet
No output printed to stdout.
Do not print cargo log messages.

--color when
Control when colored output is used. Valid values:
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-fetch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ OPTIONS
value <https://doc.rust-lang.org/cargo/reference/config.html>.

-q, --quiet
No output printed to stdout.
Do not print cargo log messages.

--color when
Control when colored output is used. Valid values:
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-fix.txt
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ OPTIONS
value <https://doc.rust-lang.org/cargo/reference/config.html>.

-q, --quiet
No output printed to stdout.
Do not print cargo log messages.

--color when
Control when colored output is used. Valid values:
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-generate-lockfile.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ OPTIONS
value <https://doc.rust-lang.org/cargo/reference/config.html>.

-q, --quiet
No output printed to stdout.
Do not print cargo log messages.

--color when
Control when colored output is used. Valid values:
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-init.txt
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ OPTIONS
value <https://doc.rust-lang.org/cargo/reference/config.html>.

-q, --quiet
No output printed to stdout.
Do not print cargo log messages.

--color when
Control when colored output is used. Valid values:
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-install.txt
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ OPTIONS
value <https://doc.rust-lang.org/cargo/reference/config.html>.

-q, --quiet
No output printed to stdout.
Do not print cargo log messages.

--color when
Control when colored output is used. Valid values:
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-locate-project.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ OPTIONS
value <https://doc.rust-lang.org/cargo/reference/config.html>.

-q, --quiet
No output printed to stdout.
Do not print cargo log messages.

--color when
Control when colored output is used. Valid values:
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-login.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ OPTIONS
value <https://doc.rust-lang.org/cargo/reference/config.html>.

-q, --quiet
No output printed to stdout.
Do not print cargo log messages.

--color when
Control when colored output is used. Valid values:
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-metadata.txt
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ OPTIONS
value <https://doc.rust-lang.org/cargo/reference/config.html>.

-q, --quiet
No output printed to stdout.
Do not print cargo log messages.

--color when
Control when colored output is used. Valid values:
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-new.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ OPTIONS
value <https://doc.rust-lang.org/cargo/reference/config.html>.

-q, --quiet
No output printed to stdout.
Do not print cargo log messages.

--color when
Control when colored output is used. Valid values:
Expand Down
Loading