From 962486173030751358543bbe3c2f4a32adcf0b20 Mon Sep 17 00:00:00 2001 From: Michael Diamond Date: Fri, 16 Jun 2023 00:47:12 -0700 Subject: [PATCH] Clarify the default behavior of cargo-install. --- src/doc/man/cargo-install.md | 4 ++-- src/doc/man/generated_txt/cargo-install.txt | 5 +++-- src/doc/src/commands/cargo-install.md | 4 ++-- src/etc/man/cargo-install.1 | 4 ++-- 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/src/doc/man/cargo-install.md b/src/doc/man/cargo-install.md index 385ed27c268..e6786318f26 100644 --- a/src/doc/man/cargo-install.md +++ b/src/doc/man/cargo-install.md @@ -18,7 +18,7 @@ cargo-install --- Build and install a Rust binary This command manages Cargo's local set of installed binary crates. Only packages which have executable `[[bin]]` or `[[example]]` targets can be installed, and all executables are installed into the installation root's -`bin` folder. +`bin` folder. By default only binaries, not examples, are installed. {{> description-install-root }} @@ -141,7 +141,7 @@ Install only the specified binary. {{/option}} {{#option "`--bins`" }} -Install all binaries. +Install all binaries. This is the default behavior. {{/option}} {{#option "`--example` _name_..." }} diff --git a/src/doc/man/generated_txt/cargo-install.txt b/src/doc/man/generated_txt/cargo-install.txt index 6e755667d84..a5b696111c8 100644 --- a/src/doc/man/generated_txt/cargo-install.txt +++ b/src/doc/man/generated_txt/cargo-install.txt @@ -13,7 +13,8 @@ DESCRIPTION This command manages Cargo’s local set of installed binary crates. Only packages which have executable [[bin]] or [[example]] targets can be installed, and all executables are installed into the installation - root’s bin folder. + root’s bin folder. By default only binaries, not examples, are + installed. The installation root is determined, in order of precedence: @@ -137,7 +138,7 @@ OPTIONS Install only the specified binary. --bins - Install all binaries. + Install all binaries. This is the default behavior. --example name… Install only the specified example. diff --git a/src/doc/src/commands/cargo-install.md b/src/doc/src/commands/cargo-install.md index 612fdbe62d8..af8efcae89e 100644 --- a/src/doc/src/commands/cargo-install.md +++ b/src/doc/src/commands/cargo-install.md @@ -18,7 +18,7 @@ cargo-install --- Build and install a Rust binary This command manages Cargo's local set of installed binary crates. Only packages which have executable `[[bin]]` or `[[example]]` targets can be installed, and all executables are installed into the installation root's -`bin` folder. +`bin` folder. By default only binaries, not examples, are installed. The installation root is determined, in order of precedence: @@ -150,7 +150,7 @@ same time.
--bins
-
Install all binaries.
+
Install all binaries. This is the default behavior.
--example name
diff --git a/src/etc/man/cargo-install.1 b/src/etc/man/cargo-install.1 index 4308ec8d563..917c0d0e19f 100644 --- a/src/etc/man/cargo-install.1 +++ b/src/etc/man/cargo-install.1 @@ -17,7 +17,7 @@ cargo\-install \[em] Build and install a Rust binary This command manages Cargo\[cq]s local set of installed binary crates. Only packages which have executable \fB[[bin]]\fR or \fB[[example]]\fR targets can be installed, and all executables are installed into the installation root\[cq]s -\fBbin\fR folder. +\fBbin\fR folder. By default only binaries, not examples, are installed. .sp The installation root is determined, in order of precedence: .sp @@ -177,7 +177,7 @@ Install only the specified binary. .sp \fB\-\-bins\fR .RS 4 -Install all binaries. +Install all binaries. This is the default behavior. .RE .sp \fB\-\-example\fR \fIname\fR\[u2026]