From b0d78f1248b5a44a554486553613cd6c8366699f Mon Sep 17 00:00:00 2001 From: leonzchang Date: Mon, 18 Dec 2023 14:50:08 +0800 Subject: [PATCH] update doc --- src/doc/src/commands/cargo-add.md | 8 ------- src/doc/src/commands/cargo-bench.md | 22 ----------------- src/doc/src/commands/cargo-build.md | 24 ------------------- src/doc/src/commands/cargo-check.md | 23 ------------------ src/doc/src/commands/cargo-clean.md | 9 ------- src/doc/src/commands/cargo-doc.md | 21 ---------------- src/doc/src/commands/cargo-fetch.md | 8 ------- src/doc/src/commands/cargo-fix.md | 22 ----------------- .../src/commands/cargo-generate-lockfile.md | 6 ----- src/doc/src/commands/cargo-init.md | 5 ---- src/doc/src/commands/cargo-install.md | 18 -------------- src/doc/src/commands/cargo-locate-project.md | 5 ---- src/doc/src/commands/cargo-login.md | 5 ---- src/doc/src/commands/cargo-logout.md | 5 ---- src/doc/src/commands/cargo-metadata.md | 7 ------ src/doc/src/commands/cargo-new.md | 5 ---- src/doc/src/commands/cargo-owner.md | 7 ------ src/doc/src/commands/cargo-package.md | 14 ----------- src/doc/src/commands/cargo-pkgid.md | 6 ----- src/doc/src/commands/cargo-publish.md | 15 ------------ src/doc/src/commands/cargo-remove.md | 7 ------ src/doc/src/commands/cargo-run.md | 18 -------------- src/doc/src/commands/cargo-rustc.md | 21 ---------------- src/doc/src/commands/cargo-rustdoc.md | 20 ---------------- src/doc/src/commands/cargo-search.md | 6 ----- src/doc/src/commands/cargo-test.md | 24 ------------------- src/doc/src/commands/cargo-tree.md | 10 -------- src/doc/src/commands/cargo-uninstall.md | 5 ---- src/doc/src/commands/cargo-update.md | 6 ----- src/doc/src/commands/cargo-vendor.md | 6 ----- src/doc/src/commands/cargo-verify-project.md | 5 ---- src/doc/src/commands/cargo-yank.md | 7 ------ 32 files changed, 370 deletions(-) diff --git a/src/doc/src/commands/cargo-add.md b/src/doc/src/commands/cargo-add.md index 1751114954a6..68b7c4c364c6 100644 --- a/src/doc/src/commands/cargo-add.md +++ b/src/doc/src/commands/cargo-add.md @@ -1,5 +1,4 @@ # cargo-add(1) - ## NAME cargo-add --- Add dependencies to a Cargo.toml manifest file @@ -67,7 +66,6 @@ which is defined by the registry.default config key which defaults crates-io. - ### Section options @@ -166,7 +164,6 @@ terminal.

May also be specified with the term.color config value. - ### Manifest Options @@ -177,7 +174,6 @@ terminal. Cargo.toml file in the current directory or any parent directory. -

-p spec
--package spec
Add dependencies to only the specified package.
@@ -206,7 +202,6 @@ See the cargo-fetch(1) command to download depend offline.

May also be specified with the net.offline config value. - ### Common Options @@ -249,19 +244,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Add `regex` as a dependency diff --git a/src/doc/src/commands/cargo-bench.md b/src/doc/src/commands/cargo-bench.md index d50b35f11c5d..582ca4914fbb 100644 --- a/src/doc/src/commands/cargo-bench.md +++ b/src/doc/src/commands/cargo-bench.md @@ -1,5 +1,4 @@ # cargo-bench(1) - ## NAME cargo-bench --- Execute benchmarks of a package @@ -80,7 +79,6 @@ as a whole. - ### Package Selection By default, when no package selection options are given, the packages selected @@ -109,12 +107,10 @@ double quotes around each pattern.

Benchmark all members in the workspace.
-
--all
Deprecated alias for --workspace.
-
--exclude SPEC…
Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports @@ -125,7 +121,6 @@ single quotes or double quotes around each pattern.
- ### Target Selection When no target selection options are given, `cargo bench` will build the @@ -160,7 +155,6 @@ is set when the integration test is built so that it can use the [`env` macro](https://doc.rust-lang.org/std/macro.env.html) to locate the executable. - Passing target selection flags will benchmark only the specified targets. @@ -184,7 +178,6 @@ and supports common Unix glob patterns.
Benchmark all binary targets.
-
--example name…
Benchmark the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
@@ -230,7 +223,6 @@ manifest settings for the target. - ### Feature Selection The feature flags allow you to control which features are enabled. When no @@ -259,7 +251,6 @@ be specified multiple times, which enables all specified features. - ### Compilation Options
@@ -275,19 +266,16 @@ target artifacts are placed in a separate directory. See the build cache documentation for more details. -
--profile name
Benchmark with the given profile. See the reference for more details on profiles.
-
--ignore-rust-version
Benchmark the target even if the selected Rust compiler is older than the required Rust version as configured in the project’s rust-version field.
-
--timings=fmts
Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output @@ -306,7 +294,6 @@ information about timing information. -
### Output Options @@ -318,7 +305,6 @@ specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. Defaults to target in the root of the workspace. - ### Display Options @@ -358,7 +344,6 @@ terminal. config value. -
--message-format fmt
The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

@@ -382,7 +367,6 @@ coming from rustc are still emitted. Cannot be used with human or <
- ### Manifest Options @@ -393,7 +377,6 @@ coming from rustc are still emitted. Cannot be used with human or < Cargo.toml file in the current directory or any parent directory. -
--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -417,7 +400,6 @@ See the cargo-fetch(1) command to download depend offline.

May also be specified with the net.offline config value.

- ### Common Options @@ -460,7 +442,6 @@ requires the -Z unstable-options flag to enable (see - ### Miscellaneous Options The `--jobs` argument affects the building of the benchmark executable but @@ -477,7 +458,6 @@ parallel jobs to the number of logical CPUs plus provided value. If a string default is provided, it sets the value back to defaults. Should not be 0. - While `cargo bench` involves compilation, it does not provide a `--keep-going` @@ -493,13 +473,11 @@ stopping at the first failure. To "compile" as many benchmarks as possible, use See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Build and execute all the benchmarks of the current package: diff --git a/src/doc/src/commands/cargo-build.md b/src/doc/src/commands/cargo-build.md index 70c38a05b134..4c106ffeba11 100644 --- a/src/doc/src/commands/cargo-build.md +++ b/src/doc/src/commands/cargo-build.md @@ -1,5 +1,4 @@ # cargo-build(1) - ## NAME cargo-build --- Compile the current package @@ -42,12 +41,10 @@ double quotes around each pattern.
Build all members in the workspace.
-
--all
Deprecated alias for --workspace.
-
--exclude SPEC…
Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports @@ -58,7 +55,6 @@ single quotes or double quotes around each pattern.
- ### Target Selection When no target selection options are given, `cargo build` will build all @@ -74,7 +70,6 @@ is set when the integration test is built so that it can use the [`env` macro](https://doc.rust-lang.org/std/macro.env.html) to locate the executable. - Passing target selection flags will build only the specified targets. @@ -98,7 +93,6 @@ and supports common Unix glob patterns.
Build all binary targets.
-
--example name…
Build the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
@@ -144,7 +138,6 @@ manifest settings for the target. - ### Feature Selection The feature flags allow you to control which features are enabled. When no @@ -173,7 +166,6 @@ be specified multiple times, which enables all specified features. - ### Compilation Options
@@ -189,26 +181,22 @@ target artifacts are placed in a separate directory. See the build cache documentation for more details. -
-r
--release
Build optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.
-
--profile name
Build with the given profile. See the reference for more details on profiles.
-
--ignore-rust-version
Build the target even if the selected Rust compiler is older than the required Rust version as configured in the project’s rust-version field.
-
--timings=fmts
Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output @@ -227,7 +215,6 @@ information about timing information. -
### Output Options @@ -240,7 +227,6 @@ specified with the CARGO_TARGET_DIR environment variable, or the Defaults to target in the root of the workspace. -
--out-dir directory
Copy final artifacts to this directory.

This option is unstable and available only on the @@ -281,7 +267,6 @@ terminal. config value.

-
--message-format fmt
The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

@@ -305,7 +290,6 @@ coming from rustc are still emitted. Cannot be used with human or <
-
--build-plan
Outputs a series of JSON messages to stdout that indicate the commands to run the build.

@@ -324,7 +308,6 @@ See https://github.com/ Cargo.toml file in the current directory or any parent directory.
-
--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -348,7 +331,6 @@ See the cargo-fetch(1) command to download depend offline.

May also be specified with the net.offline config value.

- ### Common Options @@ -391,7 +373,6 @@ requires the -Z unstable-options flag to enable (see - ### Miscellaneous Options
@@ -404,7 +385,6 @@ parallel jobs to the number of logical CPUs plus provided value. If a string default is provided, it sets the value back to defaults. Should not be 0. -
--keep-going
Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

@@ -414,13 +394,11 @@ one that succeeds (depending on which one of the two builds Cargo picked to run first), whereas cargo build -j1 --keep-going would definitely run both builds, even if the one run first fails.
-
--future-incompat-report
Displays a future-incompat report for any future-incompatible warnings produced during execution of this command

See cargo-report(1)

-
## ENVIRONMENT @@ -428,13 +406,11 @@ produced during execution of this command

See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Build the local package and all of its dependencies: diff --git a/src/doc/src/commands/cargo-check.md b/src/doc/src/commands/cargo-check.md index 1bb0f85c18e4..25771fb91208 100644 --- a/src/doc/src/commands/cargo-check.md +++ b/src/doc/src/commands/cargo-check.md @@ -1,5 +1,4 @@ # cargo-check(1) - ## NAME cargo-check --- Check the current package @@ -47,12 +46,10 @@ double quotes around each pattern.
Check all members in the workspace.
-
--all
Deprecated alias for --workspace.
-
--exclude SPEC…
Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports @@ -63,7 +60,6 @@ single quotes or double quotes around each pattern.
- ### Target Selection When no target selection options are given, `cargo check` will check all @@ -93,7 +89,6 @@ and supports common Unix glob patterns.
Check all binary targets.
-
--example name…
Check the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
@@ -139,7 +134,6 @@ manifest settings for the target. - ### Feature Selection The feature flags allow you to control which features are enabled. When no @@ -168,7 +162,6 @@ be specified multiple times, which enables all specified features. - ### Compilation Options
@@ -184,14 +177,12 @@ target artifacts are placed in a separate directory. See the build cache documentation for more details. -
-r
--release
Check optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.
-
--profile name
Check with the given profile.

As a special case, specifying the test profile will also enable checking in @@ -201,13 +192,11 @@ detail.

See the reference for more details on profiles.

-
--ignore-rust-version
Check the target even if the selected Rust compiler is older than the required Rust version as configured in the project’s rust-version field.
-
--timings=fmts
Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output @@ -226,7 +215,6 @@ information about timing information. -
### Output Options @@ -238,7 +226,6 @@ specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. Defaults to target in the root of the workspace. - ### Display Options @@ -271,7 +258,6 @@ terminal. config value. -
--message-format fmt
The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

@@ -294,7 +280,6 @@ JSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.
- ### Manifest Options @@ -305,7 +290,6 @@ coming from rustc are still emitted. Cannot be used with human or < Cargo.toml file in the current directory or any parent directory. -
--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -329,7 +313,6 @@ See the cargo-fetch(1) command to download depend offline.

May also be specified with the net.offline config value.

- ### Common Options @@ -372,7 +355,6 @@ requires the -Z unstable-options flag to enable (see - ### Miscellaneous Options
@@ -385,7 +367,6 @@ parallel jobs to the number of logical CPUs plus provided value. If a string default is provided, it sets the value back to defaults. Should not be 0. -
--keep-going
Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

@@ -395,13 +376,11 @@ one that succeeds (depending on which one of the two builds Cargo picked to run first), whereas cargo check -j1 --keep-going would definitely run both builds, even if the one run first fails.
-
--future-incompat-report
Displays a future-incompat report for any future-incompatible warnings produced during execution of this command

See cargo-report(1)

-
## ENVIRONMENT @@ -409,13 +388,11 @@ produced during execution of this command

See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Check the local package for errors: diff --git a/src/doc/src/commands/cargo-clean.md b/src/doc/src/commands/cargo-clean.md index b1415828b1f5..8caf90711a0a 100644 --- a/src/doc/src/commands/cargo-clean.md +++ b/src/doc/src/commands/cargo-clean.md @@ -1,5 +1,4 @@ # cargo-clean(1) - ## NAME cargo-clean --- Remove generated artifacts @@ -59,7 +58,6 @@ specified with the CARGO_TARGET_DIR environment variable, or the Defaults to target in the root of the workspace. -
--target triple
Clean for the given architecture. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for a @@ -71,7 +69,6 @@ target artifacts are placed in a separate directory. See the build cache documentation for more details.
- ### Display Options @@ -103,7 +100,6 @@ terminal.

May also be specified with the term.color config value. - ### Manifest Options @@ -114,7 +110,6 @@ terminal. Cargo.toml file in the current directory or any parent directory. -

--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -138,7 +133,6 @@ See the cargo-fetch(1) command to download depend offline.

May also be specified with the net.offline config value.

- ### Common Options @@ -181,19 +175,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Remove the entire target directory: diff --git a/src/doc/src/commands/cargo-doc.md b/src/doc/src/commands/cargo-doc.md index aebb04c9dd63..7eb518ec9f5b 100644 --- a/src/doc/src/commands/cargo-doc.md +++ b/src/doc/src/commands/cargo-doc.md @@ -1,5 +1,4 @@ # cargo-doc(1) - ## NAME cargo-doc --- Build a package's documentation @@ -64,12 +63,10 @@ double quotes around each pattern.
Document all members in the workspace.
-
--all
Deprecated alias for --workspace.
-
--exclude SPEC…
Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports @@ -80,7 +77,6 @@ single quotes or double quotes around each pattern.
- ### Target Selection When no target selection options are given, `cargo doc` will document all @@ -106,7 +102,6 @@ and supports common Unix glob patterns.
Document all binary targets.
-
--example name…
Document the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
@@ -146,7 +141,6 @@ be specified multiple times, which enables all specified features. - ### Compilation Options
@@ -162,26 +156,22 @@ target artifacts are placed in a separate directory. See the build cache documentation for more details. -
-r
--release
Document optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.
-
--profile name
Document with the given profile. See the reference for more details on profiles.
-
--ignore-rust-version
Document the target even if the selected Rust compiler is older than the required Rust version as configured in the project’s rust-version field.
-
--timings=fmts
Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output @@ -200,7 +190,6 @@ information about timing information. -
### Output Options @@ -212,7 +201,6 @@ specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. Defaults to target in the root of the workspace. - ### Display Options @@ -245,7 +233,6 @@ terminal. config value. -
--message-format fmt
The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

@@ -268,7 +255,6 @@ JSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.
- ### Manifest Options @@ -279,7 +265,6 @@ coming from rustc are still emitted. Cannot be used with human or < Cargo.toml file in the current directory or any parent directory. -
--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -303,7 +288,6 @@ See the cargo-fetch(1) command to download depend offline.

May also be specified with the net.offline config value.

- ### Common Options @@ -346,7 +330,6 @@ requires the -Z unstable-options flag to enable (see - ### Miscellaneous Options
@@ -359,7 +342,6 @@ parallel jobs to the number of logical CPUs plus provided value. If a string default is provided, it sets the value back to defaults. Should not be 0. -
--keep-going
Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

@@ -369,7 +351,6 @@ one that succeeds (depending on which one of the two builds Cargo picked to run first), whereas cargo doc -j1 --keep-going would definitely run both builds, even if the one run first fails.
-
## ENVIRONMENT @@ -377,13 +358,11 @@ builds, even if the one run first fails. See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Build the local package documentation and its dependencies and output to diff --git a/src/doc/src/commands/cargo-fetch.md b/src/doc/src/commands/cargo-fetch.md index 54ce48d3720c..aa0be675c2ca 100644 --- a/src/doc/src/commands/cargo-fetch.md +++ b/src/doc/src/commands/cargo-fetch.md @@ -1,5 +1,4 @@ # cargo-fetch(1) - ## NAME cargo-fetch --- Fetch dependencies of a package from the network @@ -39,7 +38,6 @@ list of supported targets. This flag may be specified multiple times.

target artifacts are placed in a separate directory. See the build cache documentation for more details. - ### Display Options @@ -71,7 +69,6 @@ terminal.

May also be specified with the term.color config value. - ### Manifest Options @@ -82,7 +79,6 @@ terminal. Cargo.toml file in the current directory or any parent directory. -

--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -106,7 +102,6 @@ See the cargo-fetch(1) command to download depend offline.

May also be specified with the net.offline config value.

- ### Common Options @@ -149,19 +144,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Fetch all dependencies: diff --git a/src/doc/src/commands/cargo-fix.md b/src/doc/src/commands/cargo-fix.md index 9211cf7f830c..f53f44ae75f8 100644 --- a/src/doc/src/commands/cargo-fix.md +++ b/src/doc/src/commands/cargo-fix.md @@ -1,5 +1,4 @@ # cargo-fix(1) - ## NAME cargo-fix --- Automatically fix lint warnings reported by rustc @@ -127,12 +126,10 @@ double quotes around each pattern.
Fix all members in the workspace.
-
--all
Deprecated alias for --workspace.
-
--exclude SPEC…
Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports @@ -143,7 +140,6 @@ single quotes or double quotes around each pattern.
- ### Target Selection When no target selection options are given, `cargo fix` will fix all targets @@ -173,7 +169,6 @@ and supports common Unix glob patterns.
Fix all binary targets.
-
--example name…
Fix the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
@@ -219,7 +214,6 @@ manifest settings for the target. - ### Feature Selection The feature flags allow you to control which features are enabled. When no @@ -248,7 +242,6 @@ be specified multiple times, which enables all specified features. - ### Compilation Options
@@ -264,14 +257,12 @@ target artifacts are placed in a separate directory. See the build cache documentation for more details. -
-r
--release
Fix optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.
-
--profile name
Fix with the given profile.

As a special case, specifying the test profile will also enable checking in @@ -281,13 +272,11 @@ detail.

See the reference for more details on profiles.

-
--ignore-rust-version
Fix the target even if the selected Rust compiler is older than the required Rust version as configured in the project’s rust-version field.
-
--timings=fmts
Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output @@ -306,7 +295,6 @@ information about timing information. -
### Output Options @@ -318,7 +306,6 @@ specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. Defaults to target in the root of the workspace. - ### Display Options @@ -351,7 +338,6 @@ terminal. config value. -
--message-format fmt
The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

@@ -374,7 +360,6 @@ JSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.
- ### Manifest Options @@ -385,7 +370,6 @@ coming from rustc are still emitted. Cannot be used with human or < Cargo.toml file in the current directory or any parent directory. -
--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -409,7 +393,6 @@ See the cargo-fetch(1) command to download depend offline.

May also be specified with the net.offline config value.

- ### Common Options @@ -452,7 +435,6 @@ requires the -Z unstable-options flag to enable (see - ### Miscellaneous Options
@@ -465,7 +447,6 @@ parallel jobs to the number of logical CPUs plus provided value. If a string default is provided, it sets the value back to defaults. Should not be 0. -
--keep-going
Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

@@ -475,7 +456,6 @@ one that succeeds (depending on which one of the two builds Cargo picked to run first), whereas cargo fix -j1 --keep-going would definitely run both builds, even if the one run first fails.
-
## ENVIRONMENT @@ -483,13 +463,11 @@ builds, even if the one run first fails. See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Apply compiler suggestions to the local package: diff --git a/src/doc/src/commands/cargo-generate-lockfile.md b/src/doc/src/commands/cargo-generate-lockfile.md index eb8d2e30e13c..8bb22a0fae79 100644 --- a/src/doc/src/commands/cargo-generate-lockfile.md +++ b/src/doc/src/commands/cargo-generate-lockfile.md @@ -48,7 +48,6 @@ terminal.

May also be specified with the term.color config value. - ### Manifest Options @@ -59,7 +58,6 @@ terminal. Cargo.toml file in the current directory or any parent directory. -

--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -83,7 +81,6 @@ See the cargo-fetch(1) command to download depend offline.

May also be specified with the net.offline config value.

- ### Common Options @@ -126,19 +123,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Create or update the lockfile for the current package or workspace: diff --git a/src/doc/src/commands/cargo-init.md b/src/doc/src/commands/cargo-init.md index 70b54802bab8..fad9401e2425 100644 --- a/src/doc/src/commands/cargo-init.md +++ b/src/doc/src/commands/cargo-init.md @@ -66,7 +66,6 @@ be restricted. - ### Display Options
@@ -96,7 +95,6 @@ terminal.

May also be specified with the term.color config value. -

### Common Options @@ -139,19 +137,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Create a binary Cargo package in the current directory: diff --git a/src/doc/src/commands/cargo-install.md b/src/doc/src/commands/cargo-install.md index db0ff10dbd03..8538bf0a84cd 100644 --- a/src/doc/src/commands/cargo-install.md +++ b/src/doc/src/commands/cargo-install.md @@ -1,5 +1,4 @@ # cargo-install(1) - ## NAME cargo-install --- Build and install a Rust binary @@ -26,7 +25,6 @@ The installation root is determined, in order of precedence: - `CARGO_HOME` environment variable - `$HOME/.cargo` - There are multiple sources from which a crate can be installed. The default location is crates.io but the `--git`, `--path`, and `--registry` flags can change this source. If the source contains more than one package (such as @@ -170,12 +168,10 @@ which is defined by the registry.default config key which defaults crates-io. -
--index index
The URL of the registry index to use.
- ### Feature Selection @@ -206,7 +202,6 @@ be specified multiple times, which enables all specified features. - ### Compilation Options
@@ -222,7 +217,6 @@ target artifacts are placed in a separate directory. See the build cache documentation for more details. -
--target-dir directory
Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the @@ -234,7 +228,6 @@ of the local crate unless --target-dir is specified.
-
--debug
Build with the dev profile instead of the release profile. See also the --profile option for choosing a specific profile by name.
@@ -245,13 +238,11 @@ See also the --profile option for choosing a specific profile by na See the reference for more details on profiles. -
--ignore-rust-version
Install the target even if the selected Rust compiler is older than the required Rust version as configured in the project’s rust-version field.
-
--timings=fmts
Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output @@ -270,7 +261,6 @@ information about timing information. -
### Manifest Options @@ -299,7 +289,6 @@ See the cargo-fetch(1) command to download depend offline.

May also be specified with the net.offline config value. - ### Miscellaneous Options @@ -314,7 +303,6 @@ parallel jobs to the number of logical CPUs plus provided value. If a string default is provided, it sets the value back to defaults. Should not be 0. -

--keep-going
Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

@@ -324,7 +312,6 @@ one that succeeds (depending on which one of the two builds Cargo picked to run first), whereas cargo install -j1 --keep-going would definitely run both builds, even if the one run first fails.
- ### Display Options @@ -357,7 +344,6 @@ terminal. config value. -
--message-format fmt
The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

@@ -381,7 +367,6 @@ coming from rustc are still emitted. Cannot be used with human or <
- ### Common Options @@ -424,19 +409,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Install or upgrade a package from crates.io: diff --git a/src/doc/src/commands/cargo-locate-project.md b/src/doc/src/commands/cargo-locate-project.md index 00491b398c6d..163137307a52 100644 --- a/src/doc/src/commands/cargo-locate-project.md +++ b/src/doc/src/commands/cargo-locate-project.md @@ -68,7 +68,6 @@ terminal.

May also be specified with the term.color config value. - ### Manifest Options @@ -78,7 +77,6 @@ terminal.

Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.
- ### Common Options @@ -121,19 +119,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Display the path to the manifest based on the current directory: diff --git a/src/doc/src/commands/cargo-login.md b/src/doc/src/commands/cargo-login.md index ffdacfc5a082..4e45edbb8c61 100644 --- a/src/doc/src/commands/cargo-login.md +++ b/src/doc/src/commands/cargo-login.md @@ -41,7 +41,6 @@ files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to crates-io. - ### Display Options @@ -73,7 +72,6 @@ terminal.

May also be specified with the term.color config value. - ### Common Options @@ -116,19 +114,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Save the token for the default registry: diff --git a/src/doc/src/commands/cargo-logout.md b/src/doc/src/commands/cargo-logout.md index 3cc50f6e9292..a7d29ba4e0a4 100644 --- a/src/doc/src/commands/cargo-logout.md +++ b/src/doc/src/commands/cargo-logout.md @@ -40,7 +40,6 @@ files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to crates-io. - ### Display Options @@ -72,7 +71,6 @@ terminal.

May also be specified with the term.color config value. - ### Common Options @@ -115,19 +113,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Remove the default registry token: diff --git a/src/doc/src/commands/cargo-metadata.md b/src/doc/src/commands/cargo-metadata.md index 24b68d283175..82caa0dbe64a 100644 --- a/src/doc/src/commands/cargo-metadata.md +++ b/src/doc/src/commands/cargo-metadata.md @@ -386,7 +386,6 @@ be specified multiple times, which enables all specified features. - ### Display Options

@@ -416,7 +415,6 @@ terminal.

May also be specified with the term.color config value. -

### Manifest Options @@ -427,7 +425,6 @@ terminal. Cargo.toml file in the current directory or any parent directory. -
--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -451,7 +448,6 @@ See the cargo-fetch(1) command to download depend offline.

May also be specified with the net.offline config value.

- ### Common Options @@ -494,19 +490,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Output JSON about the current package: diff --git a/src/doc/src/commands/cargo-new.md b/src/doc/src/commands/cargo-new.md index 4e9da6715a8a..e10e2dcb9b11 100644 --- a/src/doc/src/commands/cargo-new.md +++ b/src/doc/src/commands/cargo-new.md @@ -61,7 +61,6 @@ be restricted. - ### Display Options
@@ -91,7 +90,6 @@ terminal.

May also be specified with the term.color config value. -

### Common Options @@ -134,19 +132,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Create a binary Cargo package in the given directory: diff --git a/src/doc/src/commands/cargo-owner.md b/src/doc/src/commands/cargo-owner.md index caf16f4b29e9..7dba77cd9e00 100644 --- a/src/doc/src/commands/cargo-owner.md +++ b/src/doc/src/commands/cargo-owner.md @@ -57,12 +57,10 @@ variables of the form CARGO_REGISTRIES_NAME_TOKEN where NAME< of the registry in all capital letters. -
--index index
The URL of the registry index to use.
-
--registry registry
Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, @@ -70,7 +68,6 @@ which is defined by the registry.default config key which defaults crates-io.
- ### Display Options @@ -102,7 +99,6 @@ terminal.

May also be specified with the term.color config value. - ### Common Options @@ -145,19 +141,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. List owners of a package: diff --git a/src/doc/src/commands/cargo-package.md b/src/doc/src/commands/cargo-package.md index 12684aa3cf60..376f8140b605 100644 --- a/src/doc/src/commands/cargo-package.md +++ b/src/doc/src/commands/cargo-package.md @@ -1,5 +1,4 @@ # cargo-package(1) - ## NAME cargo-package --- Assemble the local package into a distributable tarball @@ -112,7 +111,6 @@ double quotes around each pattern. -

--exclude SPEC…
Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports @@ -123,7 +121,6 @@ single quotes or double quotes around each pattern.
- ### Compilation Options
@@ -139,7 +136,6 @@ target artifacts are placed in a separate directory. See the build cache documentation for more details. -
--target-dir directory
Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the @@ -147,7 +143,6 @@ specified with the CARGO_TARGET_DIR environment variable, or the Defaults to target in the root of the workspace.
-
### Feature Selection @@ -178,7 +173,6 @@ be specified multiple times, which enables all specified features. - ### Manifest Options
@@ -188,7 +182,6 @@ be specified multiple times, which enables all specified features. Cargo.toml file in the current directory or any parent directory. -
--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -213,7 +206,6 @@ offline.

May also be specified with the net.offline config value.

-
### Miscellaneous Options @@ -228,7 +220,6 @@ parallel jobs to the number of logical CPUs plus provided value. If a string default is provided, it sets the value back to defaults. Should not be 0. -
--keep-going
Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

@@ -238,7 +229,6 @@ one that succeeds (depending on which one of the two builds Cargo picked to run first), whereas cargo package -j1 --keep-going would definitely run both builds, even if the one run first fails.
- ### Display Options @@ -270,7 +260,6 @@ terminal.

May also be specified with the term.color config value. - ### Common Options @@ -313,19 +302,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Create a compressed `.crate` file of the current package: diff --git a/src/doc/src/commands/cargo-pkgid.md b/src/doc/src/commands/cargo-pkgid.md index d7e507506b0c..52d3bb78d6ac 100644 --- a/src/doc/src/commands/cargo-pkgid.md +++ b/src/doc/src/commands/cargo-pkgid.md @@ -75,7 +75,6 @@ terminal.

May also be specified with the term.color config value. - ### Manifest Options @@ -87,7 +86,6 @@ terminal. Cargo.toml file in the current directory or any parent directory. -

--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -112,7 +110,6 @@ offline.

May also be specified with the net.offline config value.

- ### Common Options @@ -155,19 +152,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Retrieve package specification for `foo` package: diff --git a/src/doc/src/commands/cargo-publish.md b/src/doc/src/commands/cargo-publish.md index bc84e61c08ad..873c3e68668c 100644 --- a/src/doc/src/commands/cargo-publish.md +++ b/src/doc/src/commands/cargo-publish.md @@ -1,5 +1,4 @@ # cargo-publish(1) - ## NAME cargo-publish --- Upload a package to the registry @@ -52,7 +51,6 @@ variables of the form CARGO_REGISTRIES_NAME_TOKEN where NAME< of the registry in all capital letters. -
--no-verify
Don’t verify the contents by building them.
@@ -65,7 +63,6 @@ of the registry in all capital letters.
The URL of the registry index to use.
-
--registry registry
Name of the registry to publish to. Registry names are defined in Cargo config files. If not specified, and there is a @@ -93,7 +90,6 @@ format.
- ### Compilation Options
@@ -109,7 +105,6 @@ target artifacts are placed in a separate directory. See the build cache documentation for more details. -
--target-dir directory
Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the @@ -117,7 +112,6 @@ specified with the CARGO_TARGET_DIR environment variable, or the Defaults to target in the root of the workspace.
-
### Feature Selection @@ -148,7 +142,6 @@ be specified multiple times, which enables all specified features. - ### Manifest Options
@@ -158,7 +151,6 @@ be specified multiple times, which enables all specified features. Cargo.toml file in the current directory or any parent directory. -
--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -183,7 +175,6 @@ offline.

May also be specified with the net.offline config value.

-
### Miscellaneous Options @@ -198,7 +189,6 @@ parallel jobs to the number of logical CPUs plus provided value. If a string default is provided, it sets the value back to defaults. Should not be 0. -
--keep-going
Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

@@ -208,7 +198,6 @@ one that succeeds (depending on which one of the two builds Cargo picked to run first), whereas cargo publish -j1 --keep-going would definitely run both builds, even if the one run first fails.
- ### Display Options @@ -240,7 +229,6 @@ terminal.

May also be specified with the term.color config value. - ### Common Options @@ -283,19 +271,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Publish the current package: diff --git a/src/doc/src/commands/cargo-remove.md b/src/doc/src/commands/cargo-remove.md index 9e97b533a465..81f677e19757 100644 --- a/src/doc/src/commands/cargo-remove.md +++ b/src/doc/src/commands/cargo-remove.md @@ -1,5 +1,4 @@ # cargo-remove(1) - ## NAME cargo-remove --- Remove dependencies from a Cargo.toml manifest file @@ -72,7 +71,6 @@ terminal.

May also be specified with the term.color config value. - ### Manifest Options @@ -83,7 +81,6 @@ terminal. Cargo.toml file in the current directory or any parent directory. -

--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -107,7 +104,6 @@ See the cargo-fetch(1) command to download depend offline.

May also be specified with the net.offline config value.

- ### Package Selection @@ -161,19 +157,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Remove `regex` as a dependency diff --git a/src/doc/src/commands/cargo-run.md b/src/doc/src/commands/cargo-run.md index 8c24b83529e3..ada7864791b5 100644 --- a/src/doc/src/commands/cargo-run.md +++ b/src/doc/src/commands/cargo-run.md @@ -1,5 +1,4 @@ # cargo-run(1) - ## NAME cargo-run --- Run the current package @@ -37,7 +36,6 @@ format. - ### Target Selection When no target selection options are given, `cargo run` will run the binary @@ -85,7 +83,6 @@ be specified multiple times, which enables all specified features. - ### Compilation Options
@@ -101,26 +98,22 @@ target artifacts are placed in a separate directory. See the build cache documentation for more details. -
-r
--release
Run optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.
-
--profile name
Run with the given profile. See the reference for more details on profiles.
-
--ignore-rust-version
Run the target even if the selected Rust compiler is older than the required Rust version as configured in the project’s rust-version field.
-
--timings=fmts
Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output @@ -139,7 +132,6 @@ information about timing information. -
### Output Options @@ -151,7 +143,6 @@ specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. Defaults to target in the root of the workspace. - ### Display Options @@ -185,7 +176,6 @@ terminal. config value. -
--message-format fmt
The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

@@ -209,7 +199,6 @@ coming from rustc are still emitted. Cannot be used with human or <
- ### Manifest Options @@ -221,7 +210,6 @@ coming from rustc are still emitted. Cannot be used with human or < Cargo.toml file in the current directory or any parent directory. -
--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -246,7 +234,6 @@ offline.

May also be specified with the net.offline config value.

- ### Common Options @@ -289,7 +276,6 @@ requires the -Z unstable-options flag to enable (see - ### Miscellaneous Options
@@ -302,7 +288,6 @@ parallel jobs to the number of logical CPUs plus provided value. If a string default is provided, it sets the value back to defaults. Should not be 0. -
--keep-going
Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

@@ -312,7 +297,6 @@ one that succeeds (depending on which one of the two builds Cargo picked to run first), whereas cargo run -j1 --keep-going would definitely run both builds, even if the one run first fails.
-
## ENVIRONMENT @@ -320,13 +304,11 @@ builds, even if the one run first fails. See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Build the local package and run its main target (assuming only one binary): diff --git a/src/doc/src/commands/cargo-rustc.md b/src/doc/src/commands/cargo-rustc.md index f58c8fddaeea..ff6b39abe918 100644 --- a/src/doc/src/commands/cargo-rustc.md +++ b/src/doc/src/commands/cargo-rustc.md @@ -1,5 +1,4 @@ # cargo-rustc(1) - ## NAME cargo-rustc --- Compile the current package, and pass extra options to the compiler @@ -46,7 +45,6 @@ format. - ### Target Selection When no target selection options are given, `cargo rustc` will build all @@ -61,7 +59,6 @@ is set when the integration test is built so that it can use the [`env` macro](https://doc.rust-lang.org/std/macro.env.html) to locate the executable. - Passing target selection flags will build only the specified targets. @@ -85,7 +82,6 @@ and supports common Unix glob patterns.
Build all binary targets.
-
--example name…
Build the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
@@ -131,7 +127,6 @@ manifest settings for the target. - ### Feature Selection The feature flags allow you to control which features are enabled. When no @@ -160,7 +155,6 @@ be specified multiple times, which enables all specified features. - ### Compilation Options
@@ -176,14 +170,12 @@ target artifacts are placed in a separate directory. See the build cache documentation for more details. -
-r
--release
Build optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.
-
--profile name
Build with the given profile.

The rustc subcommand will treat the following named profiles with special behaviors:

@@ -205,7 +197,6 @@ similar to the test profile. required Rust version as configured in the project’s rust-version field.
-
--timings=fmts
Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output @@ -224,7 +215,6 @@ information about timing information. -
--crate-type crate-type
Build for the given crate type. This flag accepts a comma-separated list of 1 or more crate types, of which the allowed values are the same as crate-type @@ -247,7 +237,6 @@ specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. Defaults to target in the root of the workspace.
-
### Display Options @@ -281,7 +270,6 @@ terminal. config value. -
--message-format fmt
The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

@@ -305,7 +293,6 @@ coming from rustc are still emitted. Cannot be used with human or <
- ### Manifest Options @@ -317,7 +304,6 @@ coming from rustc are still emitted. Cannot be used with human or < Cargo.toml file in the current directory or any parent directory. -
--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -342,7 +328,6 @@ offline.

May also be specified with the net.offline config value.

- ### Common Options @@ -385,7 +370,6 @@ requires the -Z unstable-options flag to enable (see - ### Miscellaneous Options
@@ -398,7 +382,6 @@ parallel jobs to the number of logical CPUs plus provided value. If a string default is provided, it sets the value back to defaults. Should not be 0. -
--keep-going
Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

@@ -408,13 +391,11 @@ one that succeeds (depending on which one of the two builds Cargo picked to run first), whereas cargo rustc -j1 --keep-going would definitely run both builds, even if the one run first fails.
-
--future-incompat-report
Displays a future-incompat report for any future-incompatible warnings produced during execution of this command

See cargo-report(1)

-
## ENVIRONMENT @@ -422,13 +403,11 @@ produced during execution of this command

See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Check if your package (not including dependencies) uses unsafe code: diff --git a/src/doc/src/commands/cargo-rustdoc.md b/src/doc/src/commands/cargo-rustdoc.md index 2e0e67d972cf..79e56c8a8790 100644 --- a/src/doc/src/commands/cargo-rustdoc.md +++ b/src/doc/src/commands/cargo-rustdoc.md @@ -1,5 +1,4 @@ # cargo-rustdoc(1) - ## NAME cargo-rustdoc --- Build a package's documentation, using specified custom flags @@ -59,7 +58,6 @@ format. - ### Target Selection When no target selection options are given, `cargo rustdoc` will document all @@ -90,7 +88,6 @@ and supports common Unix glob patterns.
Document all binary targets.
-
--example name…
Document the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
@@ -136,7 +133,6 @@ manifest settings for the target. - ### Feature Selection The feature flags allow you to control which features are enabled. When no @@ -165,7 +161,6 @@ be specified multiple times, which enables all specified features. - ### Compilation Options
@@ -181,26 +176,22 @@ target artifacts are placed in a separate directory. See the build cache documentation for more details. -
-r
--release
Document optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.
-
--profile name
Document with the given profile. See the reference for more details on profiles.
-
--ignore-rust-version
Document the target even if the selected Rust compiler is older than the required Rust version as configured in the project’s rust-version field.
-
--timings=fmts
Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output @@ -219,7 +210,6 @@ information about timing information. -
### Output Options @@ -231,7 +221,6 @@ specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. Defaults to target in the root of the workspace. - ### Display Options @@ -264,7 +253,6 @@ terminal. config value. -
--message-format fmt
The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

@@ -287,7 +275,6 @@ JSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.
- ### Manifest Options @@ -298,7 +285,6 @@ coming from rustc are still emitted. Cannot be used with human or < Cargo.toml file in the current directory or any parent directory. -
--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -322,7 +308,6 @@ See the cargo-fetch(1) command to download depend offline.

May also be specified with the net.offline config value.

- ### Common Options @@ -365,7 +350,6 @@ requires the -Z unstable-options flag to enable (see - ### Miscellaneous Options
@@ -378,7 +362,6 @@ parallel jobs to the number of logical CPUs plus provided value. If a string default is provided, it sets the value back to defaults. Should not be 0. -
--keep-going
Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

@@ -388,7 +371,6 @@ one that succeeds (depending on which one of the two builds Cargo picked to run first), whereas cargo rustdoc -j1 --keep-going would definitely run both builds, even if the one run first fails.
-
## ENVIRONMENT @@ -396,13 +378,11 @@ builds, even if the one run first fails. See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Build documentation with custom CSS included from a given file: diff --git a/src/doc/src/commands/cargo-search.md b/src/doc/src/commands/cargo-search.md index 1a98f2869167..9bfdfeadb101 100644 --- a/src/doc/src/commands/cargo-search.md +++ b/src/doc/src/commands/cargo-search.md @@ -28,7 +28,6 @@ for copying into a `Cargo.toml` manifest.
The URL of the registry index to use.
-
--registry registry
Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, @@ -36,7 +35,6 @@ which is defined by the registry.default config key which defaults crates-io.
- ### Display Options @@ -68,7 +66,6 @@ terminal.

May also be specified with the term.color config value. - ### Common Options @@ -111,19 +108,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Search for a package from crates.io: diff --git a/src/doc/src/commands/cargo-test.md b/src/doc/src/commands/cargo-test.md index ef978570ea89..54a9f28cc4fa 100644 --- a/src/doc/src/commands/cargo-test.md +++ b/src/doc/src/commands/cargo-test.md @@ -1,5 +1,4 @@ # cargo-test(1) - ## NAME cargo-test --- Execute unit and integration tests of a package @@ -88,7 +87,6 @@ as a whole. - ### Package Selection By default, when no package selection options are given, the packages selected @@ -117,12 +115,10 @@ double quotes around each pattern.

Test all members in the workspace.
-
--all
Deprecated alias for --workspace.
-
--exclude SPEC…
Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports @@ -133,7 +129,6 @@ single quotes or double quotes around each pattern.
- ### Target Selection When no target selection options are given, `cargo test` will build the @@ -173,7 +168,6 @@ is set when the integration test is built so that it can use the [`env` macro](https://doc.rust-lang.org/std/macro.env.html) to locate the executable. - Passing target selection flags will test only the specified targets. @@ -197,7 +191,6 @@ and supports common Unix glob patterns.
Test all binary targets.
-
--example name…
Test the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
@@ -243,7 +236,6 @@ manifest settings for the target. -
--doc
@@ -281,7 +273,6 @@ be specified multiple times, which enables all specified features.
- ### Compilation Options
@@ -297,26 +288,22 @@ target artifacts are placed in a separate directory. See the build cache documentation for more details. -
-r
--release
Test optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.
-
--profile name
Test with the given profile. See the reference for more details on profiles.
-
--ignore-rust-version
Test the target even if the selected Rust compiler is older than the required Rust version as configured in the project’s rust-version field.
-
--timings=fmts
Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output @@ -335,7 +322,6 @@ information about timing information. -
### Output Options @@ -347,7 +333,6 @@ specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. Defaults to target in the root of the workspace. - ### Display Options @@ -387,7 +372,6 @@ terminal. config value. -
--message-format fmt
The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

@@ -411,7 +395,6 @@ coming from rustc are still emitted. Cannot be used with human or <
- ### Manifest Options @@ -423,7 +406,6 @@ coming from rustc are still emitted. Cannot be used with human or < Cargo.toml file in the current directory or any parent directory. -
--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -448,7 +430,6 @@ offline.

May also be specified with the net.offline config value.

- ### Common Options @@ -491,7 +472,6 @@ requires the -Z unstable-options flag to enable (see - ### Miscellaneous Options The `--jobs` argument affects the building of the test executable but does not @@ -511,14 +491,12 @@ parallel jobs to the number of logical CPUs plus provided value. If a string default is provided, it sets the value back to defaults. Should not be 0. -
--future-incompat-report
Displays a future-incompat report for any future-incompatible warnings produced during execution of this command

See cargo-report(1)

- While `cargo test` involves compilation, it does not provide a `--keep-going` @@ -534,13 +512,11 @@ build test binaries separately. For example: See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Execute all the unit and integration tests of the current package: diff --git a/src/doc/src/commands/cargo-tree.md b/src/doc/src/commands/cargo-tree.md index 948c3581cae5..2bbe546da67d 100644 --- a/src/doc/src/commands/cargo-tree.md +++ b/src/doc/src/commands/cargo-tree.md @@ -1,5 +1,4 @@ # cargo-tree(1) - ## NAME cargo-tree --- Display a tree visualization of a dependency graph @@ -204,7 +203,6 @@ double quotes around each pattern. -
--exclude SPEC…
Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports @@ -215,7 +213,6 @@ single quotes or double quotes around each pattern.
- ### Manifest Options
@@ -225,7 +222,6 @@ single quotes or double quotes around each pattern. Cargo.toml file in the current directory or any parent directory. -
--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -250,7 +246,6 @@ offline.

May also be specified with the net.offline config value.

-
### Feature Selection @@ -281,7 +276,6 @@ be specified multiple times, which enables all specified features. - ### Display Options
@@ -313,7 +307,6 @@ terminal. config value. -
### Common Options @@ -356,19 +349,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Display the tree for the package in the current directory: diff --git a/src/doc/src/commands/cargo-uninstall.md b/src/doc/src/commands/cargo-uninstall.md index e9c73b0cd56d..3d150b7c0a1e 100644 --- a/src/doc/src/commands/cargo-uninstall.md +++ b/src/doc/src/commands/cargo-uninstall.md @@ -25,7 +25,6 @@ The installation root is determined, in order of precedence: - `CARGO_HOME` environment variable - `$HOME/.cargo` - ## OPTIONS ### Install Options @@ -78,7 +77,6 @@ terminal. config value. - ### Common Options @@ -121,19 +119,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Uninstall a previously installed package. diff --git a/src/doc/src/commands/cargo-update.md b/src/doc/src/commands/cargo-update.md index 234998faa5e0..ef44e487bb09 100644 --- a/src/doc/src/commands/cargo-update.md +++ b/src/doc/src/commands/cargo-update.md @@ -85,7 +85,6 @@ terminal.

May also be specified with the term.color config value. - ### Manifest Options @@ -97,7 +96,6 @@ terminal. Cargo.toml file in the current directory or any parent directory. -

--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -122,7 +120,6 @@ offline.

May also be specified with the net.offline config value.

- ### Common Options @@ -165,19 +162,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Update all dependencies in the lockfile: diff --git a/src/doc/src/commands/cargo-vendor.md b/src/doc/src/commands/cargo-vendor.md index 84560a688fe7..5e137bd938a8 100644 --- a/src/doc/src/commands/cargo-vendor.md +++ b/src/doc/src/commands/cargo-vendor.md @@ -62,7 +62,6 @@ only a subset of the packages have changed. Cargo.toml file in the current directory or any parent directory. -
--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -87,7 +86,6 @@ offline.

May also be specified with the net.offline config value.

- ### Display Options @@ -121,7 +119,6 @@ terminal. config value. - ### Common Options @@ -164,19 +161,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Vendor all dependencies into a local "vendor" folder diff --git a/src/doc/src/commands/cargo-verify-project.md b/src/doc/src/commands/cargo-verify-project.md index 2a1d5d950be3..e27724b92ae5 100644 --- a/src/doc/src/commands/cargo-verify-project.md +++ b/src/doc/src/commands/cargo-verify-project.md @@ -52,7 +52,6 @@ terminal. config value. - ### Manifest Options @@ -64,7 +63,6 @@ terminal. Cargo.toml file in the current directory or any parent directory. -
--frozen
--locked
Either of these flags requires that the Cargo.lock file is @@ -89,7 +87,6 @@ offline.

May also be specified with the net.offline config value.

- ### Common Options @@ -132,13 +129,11 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: The workspace is OK. diff --git a/src/doc/src/commands/cargo-yank.md b/src/doc/src/commands/cargo-yank.md index c0be657bc478..0c505205ce35 100644 --- a/src/doc/src/commands/cargo-yank.md +++ b/src/doc/src/commands/cargo-yank.md @@ -101,12 +101,10 @@ variables of the form CARGO_REGISTRIES_NAME_TOKEN where NAME< of the registry in all capital letters. -
--index index
The URL of the registry index to use.
-
--registry registry
Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, @@ -114,7 +112,6 @@ which is defined by the registry.default config key which defaults crates-io.
- ### Display Options @@ -148,7 +145,6 @@ terminal. config value. - ### Common Options @@ -191,19 +187,16 @@ requires the -Z unstable-options flag to enable (see - ## ENVIRONMENT See [the reference](../reference/environment-variables.html) for details on environment variables that Cargo reads. - ## EXIT STATUS * `0`: Cargo succeeded. * `101`: Cargo failed to complete. - ## EXAMPLES 1. Yank a crate from the index: