From 65332bc9f10bc2e40a92656e6619dd74bc4ecb65 Mon Sep 17 00:00:00 2001 From: Weihang Lo Date: Tue, 13 Sep 2022 09:54:33 +0100 Subject: [PATCH 1/3] Expand details for `--config` cli arg --- src/doc/man/generated_txt/cargo-add.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-bench.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-build.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-check.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-clean.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-doc.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-fetch.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-fix.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-generate-lockfile.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-init.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-install.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-locate-project.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-login.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-metadata.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-new.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-owner.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-package.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-pkgid.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-publish.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-run.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-rustc.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-rustdoc.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-search.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-test.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-tree.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-uninstall.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-update.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-vendor.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-verify-project.txt | 9 +++++++-- src/doc/man/generated_txt/cargo-yank.txt | 9 +++++++-- src/doc/man/generated_txt/cargo.txt | 9 +++++++-- src/doc/man/includes/section-options-common.md | 6 ++++-- src/doc/src/commands/cargo-add.md | 6 ++++-- src/doc/src/commands/cargo-bench.md | 6 ++++-- src/doc/src/commands/cargo-build.md | 6 ++++-- src/doc/src/commands/cargo-check.md | 6 ++++-- src/doc/src/commands/cargo-clean.md | 6 ++++-- src/doc/src/commands/cargo-doc.md | 6 ++++-- src/doc/src/commands/cargo-fetch.md | 6 ++++-- src/doc/src/commands/cargo-fix.md | 6 ++++-- src/doc/src/commands/cargo-generate-lockfile.md | 6 ++++-- src/doc/src/commands/cargo-init.md | 6 ++++-- src/doc/src/commands/cargo-install.md | 6 ++++-- src/doc/src/commands/cargo-locate-project.md | 6 ++++-- src/doc/src/commands/cargo-login.md | 6 ++++-- src/doc/src/commands/cargo-metadata.md | 6 ++++-- src/doc/src/commands/cargo-new.md | 6 ++++-- src/doc/src/commands/cargo-owner.md | 6 ++++-- src/doc/src/commands/cargo-package.md | 6 ++++-- src/doc/src/commands/cargo-pkgid.md | 6 ++++-- src/doc/src/commands/cargo-publish.md | 6 ++++-- src/doc/src/commands/cargo-run.md | 6 ++++-- src/doc/src/commands/cargo-rustc.md | 6 ++++-- src/doc/src/commands/cargo-rustdoc.md | 6 ++++-- src/doc/src/commands/cargo-search.md | 6 ++++-- src/doc/src/commands/cargo-test.md | 6 ++++-- src/doc/src/commands/cargo-tree.md | 6 ++++-- src/doc/src/commands/cargo-uninstall.md | 6 ++++-- src/doc/src/commands/cargo-update.md | 6 ++++-- src/doc/src/commands/cargo-vendor.md | 6 ++++-- src/doc/src/commands/cargo-verify-project.md | 6 ++++-- src/doc/src/commands/cargo-yank.md | 6 ++++-- src/doc/src/commands/cargo.md | 6 ++++-- src/etc/man/cargo-add.1 | 6 ++++-- src/etc/man/cargo-bench.1 | 6 ++++-- src/etc/man/cargo-build.1 | 6 ++++-- src/etc/man/cargo-check.1 | 6 ++++-- src/etc/man/cargo-clean.1 | 6 ++++-- src/etc/man/cargo-doc.1 | 6 ++++-- src/etc/man/cargo-fetch.1 | 6 ++++-- src/etc/man/cargo-fix.1 | 6 ++++-- src/etc/man/cargo-generate-lockfile.1 | 6 ++++-- src/etc/man/cargo-init.1 | 6 ++++-- src/etc/man/cargo-install.1 | 6 ++++-- src/etc/man/cargo-locate-project.1 | 6 ++++-- src/etc/man/cargo-login.1 | 6 ++++-- src/etc/man/cargo-metadata.1 | 6 ++++-- src/etc/man/cargo-new.1 | 6 ++++-- src/etc/man/cargo-owner.1 | 6 ++++-- src/etc/man/cargo-package.1 | 6 ++++-- src/etc/man/cargo-pkgid.1 | 6 ++++-- src/etc/man/cargo-publish.1 | 6 ++++-- src/etc/man/cargo-run.1 | 6 ++++-- src/etc/man/cargo-rustc.1 | 6 ++++-- src/etc/man/cargo-rustdoc.1 | 6 ++++-- src/etc/man/cargo-search.1 | 6 ++++-- src/etc/man/cargo-test.1 | 6 ++++-- src/etc/man/cargo-tree.1 | 6 ++++-- src/etc/man/cargo-uninstall.1 | 6 ++++-- src/etc/man/cargo-update.1 | 6 ++++-- src/etc/man/cargo-vendor.1 | 6 ++++-- src/etc/man/cargo-verify-project.1 | 6 ++++-- src/etc/man/cargo-yank.1 | 6 ++++-- src/etc/man/cargo.1 | 6 ++++-- 94 files changed, 469 insertions(+), 188 deletions(-) diff --git a/src/doc/man/generated_txt/cargo-add.txt b/src/doc/man/generated_txt/cargo-add.txt index 832f53169e1..91c47416bdb 100644 --- a/src/doc/man/generated_txt/cargo-add.txt +++ b/src/doc/man/generated_txt/cargo-add.txt @@ -145,8 +145,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-bench.txt b/src/doc/man/generated_txt/cargo-bench.txt index e39e498ae78..09d67668c63 100644 --- a/src/doc/man/generated_txt/cargo-bench.txt +++ b/src/doc/man/generated_txt/cargo-bench.txt @@ -355,8 +355,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-build.txt b/src/doc/man/generated_txt/cargo-build.txt index e03d37ddb4c..803a438eb8d 100644 --- a/src/doc/man/generated_txt/cargo-build.txt +++ b/src/doc/man/generated_txt/cargo-build.txt @@ -304,8 +304,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-check.txt b/src/doc/man/generated_txt/cargo-check.txt index 6c4b2faeb85..2af4fe06f3b 100644 --- a/src/doc/man/generated_txt/cargo-check.txt +++ b/src/doc/man/generated_txt/cargo-check.txt @@ -289,8 +289,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-clean.txt b/src/doc/man/generated_txt/cargo-clean.txt index 76bdf3fef06..ef8952df58f 100644 --- a/src/doc/man/generated_txt/cargo-clean.txt +++ b/src/doc/man/generated_txt/cargo-clean.txt @@ -119,8 +119,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-doc.txt b/src/doc/man/generated_txt/cargo-doc.txt index aadbfdf0ed1..abfe484a110 100644 --- a/src/doc/man/generated_txt/cargo-doc.txt +++ b/src/doc/man/generated_txt/cargo-doc.txt @@ -260,8 +260,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-fetch.txt b/src/doc/man/generated_txt/cargo-fetch.txt index 43aa77eae70..1598dc9d837 100644 --- a/src/doc/man/generated_txt/cargo-fetch.txt +++ b/src/doc/man/generated_txt/cargo-fetch.txt @@ -104,8 +104,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-fix.txt b/src/doc/man/generated_txt/cargo-fix.txt index 5e98ac602bd..7f1b05b429e 100644 --- a/src/doc/man/generated_txt/cargo-fix.txt +++ b/src/doc/man/generated_txt/cargo-fix.txt @@ -362,8 +362,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-generate-lockfile.txt b/src/doc/man/generated_txt/cargo-generate-lockfile.txt index 8ec1547cd63..6c742093281 100644 --- a/src/doc/man/generated_txt/cargo-generate-lockfile.txt +++ b/src/doc/man/generated_txt/cargo-generate-lockfile.txt @@ -79,8 +79,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-init.txt b/src/doc/man/generated_txt/cargo-init.txt index ee4077e6776..92d0f0c5f1e 100644 --- a/src/doc/man/generated_txt/cargo-init.txt +++ b/src/doc/man/generated_txt/cargo-init.txt @@ -87,8 +87,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-install.txt b/src/doc/man/generated_txt/cargo-install.txt index 2633511c5d3..6a92526d096 100644 --- a/src/doc/man/generated_txt/cargo-install.txt +++ b/src/doc/man/generated_txt/cargo-install.txt @@ -326,8 +326,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-locate-project.txt b/src/doc/man/generated_txt/cargo-locate-project.txt index 1abff535779..70625fa9308 100644 --- a/src/doc/man/generated_txt/cargo-locate-project.txt +++ b/src/doc/man/generated_txt/cargo-locate-project.txt @@ -62,8 +62,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-login.txt b/src/doc/man/generated_txt/cargo-login.txt index 847b7ec72d4..66238fb5a65 100644 --- a/src/doc/man/generated_txt/cargo-login.txt +++ b/src/doc/man/generated_txt/cargo-login.txt @@ -62,8 +62,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-metadata.txt b/src/doc/man/generated_txt/cargo-metadata.txt index 11e3a29bd20..efee01a9f9f 100644 --- a/src/doc/man/generated_txt/cargo-metadata.txt +++ b/src/doc/man/generated_txt/cargo-metadata.txt @@ -391,8 +391,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-new.txt b/src/doc/man/generated_txt/cargo-new.txt index e881418955a..7b429e347d6 100644 --- a/src/doc/man/generated_txt/cargo-new.txt +++ b/src/doc/man/generated_txt/cargo-new.txt @@ -82,8 +82,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-owner.txt b/src/doc/man/generated_txt/cargo-owner.txt index 269c988227a..dd1c017ab87 100644 --- a/src/doc/man/generated_txt/cargo-owner.txt +++ b/src/doc/man/generated_txt/cargo-owner.txt @@ -89,8 +89,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-package.txt b/src/doc/man/generated_txt/cargo-package.txt index 25312b39970..162c196d0c5 100644 --- a/src/doc/man/generated_txt/cargo-package.txt +++ b/src/doc/man/generated_txt/cargo-package.txt @@ -230,8 +230,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-pkgid.txt b/src/doc/man/generated_txt/cargo-pkgid.txt index 8c8e4f50afd..e2c3cbd99b6 100644 --- a/src/doc/man/generated_txt/cargo-pkgid.txt +++ b/src/doc/man/generated_txt/cargo-pkgid.txt @@ -109,8 +109,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-publish.txt b/src/doc/man/generated_txt/cargo-publish.txt index 1371bbc82b5..29ebfcdcecb 100644 --- a/src/doc/man/generated_txt/cargo-publish.txt +++ b/src/doc/man/generated_txt/cargo-publish.txt @@ -197,8 +197,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-run.txt b/src/doc/man/generated_txt/cargo-run.txt index e17e3f34751..6ef1e46a610 100644 --- a/src/doc/man/generated_txt/cargo-run.txt +++ b/src/doc/man/generated_txt/cargo-run.txt @@ -204,8 +204,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-rustc.txt b/src/doc/man/generated_txt/cargo-rustc.txt index 0542785719c..45c402e2c34 100644 --- a/src/doc/man/generated_txt/cargo-rustc.txt +++ b/src/doc/man/generated_txt/cargo-rustc.txt @@ -306,8 +306,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-rustdoc.txt b/src/doc/man/generated_txt/cargo-rustdoc.txt index 5211ba7f536..69ef35e50f7 100644 --- a/src/doc/man/generated_txt/cargo-rustdoc.txt +++ b/src/doc/man/generated_txt/cargo-rustdoc.txt @@ -276,8 +276,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-search.txt b/src/doc/man/generated_txt/cargo-search.txt index 5abaa85aa27..240adf02d6d 100644 --- a/src/doc/man/generated_txt/cargo-search.txt +++ b/src/doc/man/generated_txt/cargo-search.txt @@ -59,8 +59,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-test.txt b/src/doc/man/generated_txt/cargo-test.txt index 5333a8fa3a4..0872c9b1c4b 100644 --- a/src/doc/man/generated_txt/cargo-test.txt +++ b/src/doc/man/generated_txt/cargo-test.txt @@ -373,8 +373,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-tree.txt b/src/doc/man/generated_txt/cargo-tree.txt index 0b35d8ab0d0..af4a79532a5 100644 --- a/src/doc/man/generated_txt/cargo-tree.txt +++ b/src/doc/man/generated_txt/cargo-tree.txt @@ -269,8 +269,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-uninstall.txt b/src/doc/man/generated_txt/cargo-uninstall.txt index 0bebe8c3fd5..c14c01a65d0 100644 --- a/src/doc/man/generated_txt/cargo-uninstall.txt +++ b/src/doc/man/generated_txt/cargo-uninstall.txt @@ -71,8 +71,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-update.txt b/src/doc/man/generated_txt/cargo-update.txt index c1e27443669..5b7a072255e 100644 --- a/src/doc/man/generated_txt/cargo-update.txt +++ b/src/doc/man/generated_txt/cargo-update.txt @@ -109,8 +109,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-vendor.txt b/src/doc/man/generated_txt/cargo-vendor.txt index aafeaaa9e75..a466a7f9d98 100644 --- a/src/doc/man/generated_txt/cargo-vendor.txt +++ b/src/doc/man/generated_txt/cargo-vendor.txt @@ -105,8 +105,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-verify-project.txt b/src/doc/man/generated_txt/cargo-verify-project.txt index 7b0f30fc651..23d8842bd0b 100644 --- a/src/doc/man/generated_txt/cargo-verify-project.txt +++ b/src/doc/man/generated_txt/cargo-verify-project.txt @@ -82,8 +82,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo-yank.txt b/src/doc/man/generated_txt/cargo-yank.txt index cd6bc2be4e6..e844f06bcb6 100644 --- a/src/doc/man/generated_txt/cargo-yank.txt +++ b/src/doc/man/generated_txt/cargo-yank.txt @@ -85,8 +85,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/generated_txt/cargo.txt b/src/doc/man/generated_txt/cargo.txt index d44cb2aed6a..c8072e68700 100644 --- a/src/doc/man/generated_txt/cargo.txt +++ b/src/doc/man/generated_txt/cargo.txt @@ -188,8 +188,13 @@ OPTIONS for more information about how toolchain overrides work. - --config KEY=VALUE - Overrides a Cargo configuration value. + --config KEY=VALUE or PATH + Overrides a Cargo configuration value. The argument should be in + TOML syntax of KEY=VALUE, or provided as a path to an extra + configuration file. This flag may be specified multiple times. See + the command-line overrides section + + for more information. -h, --help Prints help information. diff --git a/src/doc/man/includes/section-options-common.md b/src/doc/man/includes/section-options-common.md index 1bafb317cbc..83b44fd83ed 100644 --- a/src/doc/man/includes/section-options-common.md +++ b/src/doc/man/includes/section-options-common.md @@ -10,8 +10,10 @@ See the [rustup documentation](https://rust-lang.github.io/rustup/overrides.html for more information about how toolchain overrides work. {{/option}} -{{#option "`--config` KEY=VALUE"}} -Overrides a Cargo configuration value. +{{#option "`--config` _KEY=VALUE_ or _PATH_"}} +Overrides a Cargo configuration value. The argument should be in TOML syntax of `KEY=VALUE`, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the [command-line overrides section](../reference/config.html#command-line-overrides) for more information. {{/option}} {{#option "`-h`" "`--help`"}} diff --git a/src/doc/src/commands/cargo-add.md b/src/doc/src/commands/cargo-add.md index da6f6fe2042..a397959816e 100644 --- a/src/doc/src/commands/cargo-add.md +++ b/src/doc/src/commands/cargo-add.md @@ -182,8 +182,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-bench.md b/src/doc/src/commands/cargo-bench.md index 01ce84dee26..b0ecf2159b7 100644 --- a/src/doc/src/commands/cargo-bench.md +++ b/src/doc/src/commands/cargo-bench.md @@ -421,8 +421,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-build.md b/src/doc/src/commands/cargo-build.md index 67a49a415f0..5e1fdd039a4 100644 --- a/src/doc/src/commands/cargo-build.md +++ b/src/doc/src/commands/cargo-build.md @@ -365,8 +365,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-check.md b/src/doc/src/commands/cargo-check.md index 528b312f71b..82ba76ee39f 100644 --- a/src/doc/src/commands/cargo-check.md +++ b/src/doc/src/commands/cargo-check.md @@ -346,8 +346,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-clean.md b/src/doc/src/commands/cargo-clean.md index eee69854dc6..c7cd8fe5274 100644 --- a/src/doc/src/commands/cargo-clean.md +++ b/src/doc/src/commands/cargo-clean.md @@ -150,8 +150,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-doc.md b/src/doc/src/commands/cargo-doc.md index 7aa313c9062..9258705b748 100644 --- a/src/doc/src/commands/cargo-doc.md +++ b/src/doc/src/commands/cargo-doc.md @@ -320,8 +320,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-fetch.md b/src/doc/src/commands/cargo-fetch.md index 9248fb98aeb..93e8aba3f26 100644 --- a/src/doc/src/commands/cargo-fetch.md +++ b/src/doc/src/commands/cargo-fetch.md @@ -124,8 +124,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-fix.md b/src/doc/src/commands/cargo-fix.md index fad6573fddf..dccffd579ae 100644 --- a/src/doc/src/commands/cargo-fix.md +++ b/src/doc/src/commands/cargo-fix.md @@ -426,8 +426,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-generate-lockfile.md b/src/doc/src/commands/cargo-generate-lockfile.md index a608cb2bcf0..9712cf66329 100644 --- a/src/doc/src/commands/cargo-generate-lockfile.md +++ b/src/doc/src/commands/cargo-generate-lockfile.md @@ -98,8 +98,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-init.md b/src/doc/src/commands/cargo-init.md index 267b6d59445..d2317c399ed 100644 --- a/src/doc/src/commands/cargo-init.md +++ b/src/doc/src/commands/cargo-init.md @@ -111,8 +111,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-install.md b/src/doc/src/commands/cargo-install.md index 8048ccebf8f..f1450a9333b 100644 --- a/src/doc/src/commands/cargo-install.md +++ b/src/doc/src/commands/cargo-install.md @@ -375,8 +375,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-locate-project.md b/src/doc/src/commands/cargo-locate-project.md index bb363cc0132..7c7e51cfa63 100644 --- a/src/doc/src/commands/cargo-locate-project.md +++ b/src/doc/src/commands/cargo-locate-project.md @@ -87,8 +87,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-login.md b/src/doc/src/commands/cargo-login.md index 590b99e205b..35fab6763d0 100644 --- a/src/doc/src/commands/cargo-login.md +++ b/src/doc/src/commands/cargo-login.md @@ -79,8 +79,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-metadata.md b/src/doc/src/commands/cargo-metadata.md index cd62d1b0b9a..feb56f87af3 100644 --- a/src/doc/src/commands/cargo-metadata.md +++ b/src/doc/src/commands/cargo-metadata.md @@ -427,8 +427,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-new.md b/src/doc/src/commands/cargo-new.md index 4763e079b34..0f4f8e7f3c3 100644 --- a/src/doc/src/commands/cargo-new.md +++ b/src/doc/src/commands/cargo-new.md @@ -106,8 +106,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-owner.md b/src/doc/src/commands/cargo-owner.md index 851c1936861..73df3cd9902 100644 --- a/src/doc/src/commands/cargo-owner.md +++ b/src/doc/src/commands/cargo-owner.md @@ -117,8 +117,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-package.md b/src/doc/src/commands/cargo-package.md index 13d08741892..a58614c6789 100644 --- a/src/doc/src/commands/cargo-package.md +++ b/src/doc/src/commands/cargo-package.md @@ -283,8 +283,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-pkgid.md b/src/doc/src/commands/cargo-pkgid.md index 23c15eb1631..873881d8b57 100644 --- a/src/doc/src/commands/cargo-pkgid.md +++ b/src/doc/src/commands/cargo-pkgid.md @@ -127,8 +127,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-publish.md b/src/doc/src/commands/cargo-publish.md index 9b8f47f8bc8..a308c4dca05 100644 --- a/src/doc/src/commands/cargo-publish.md +++ b/src/doc/src/commands/cargo-publish.md @@ -249,8 +249,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-run.md b/src/doc/src/commands/cargo-run.md index e649db8b705..43fcc026b84 100644 --- a/src/doc/src/commands/cargo-run.md +++ b/src/doc/src/commands/cargo-run.md @@ -258,8 +258,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-rustc.md b/src/doc/src/commands/cargo-rustc.md index 0f8ea1a1838..606ce778516 100644 --- a/src/doc/src/commands/cargo-rustc.md +++ b/src/doc/src/commands/cargo-rustc.md @@ -359,8 +359,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-rustdoc.md b/src/doc/src/commands/cargo-rustdoc.md index 37560f05f57..c8b6ecf97e5 100644 --- a/src/doc/src/commands/cargo-rustdoc.md +++ b/src/doc/src/commands/cargo-rustdoc.md @@ -339,8 +339,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-search.md b/src/doc/src/commands/cargo-search.md index aff276749d0..78dfa290f8d 100644 --- a/src/doc/src/commands/cargo-search.md +++ b/src/doc/src/commands/cargo-search.md @@ -83,8 +83,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-test.md b/src/doc/src/commands/cargo-test.md index c4cec8de1c4..69e9a5ae4e9 100644 --- a/src/doc/src/commands/cargo-test.md +++ b/src/doc/src/commands/cargo-test.md @@ -444,8 +444,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-tree.md b/src/doc/src/commands/cargo-tree.md index 98a4d55eae9..49b531a239c 100644 --- a/src/doc/src/commands/cargo-tree.md +++ b/src/doc/src/commands/cargo-tree.md @@ -313,8 +313,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-uninstall.md b/src/doc/src/commands/cargo-uninstall.md index f6a4a13456c..5d2561a19c9 100644 --- a/src/doc/src/commands/cargo-uninstall.md +++ b/src/doc/src/commands/cargo-uninstall.md @@ -93,8 +93,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-update.md b/src/doc/src/commands/cargo-update.md index 4720b1e5e0b..cbea81b3b9a 100644 --- a/src/doc/src/commands/cargo-update.md +++ b/src/doc/src/commands/cargo-update.md @@ -138,8 +138,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-vendor.md b/src/doc/src/commands/cargo-vendor.md index caeca4e85bd..194107265da 100644 --- a/src/doc/src/commands/cargo-vendor.md +++ b/src/doc/src/commands/cargo-vendor.md @@ -134,8 +134,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-verify-project.md b/src/doc/src/commands/cargo-verify-project.md index 0fb3184bcf4..2e44fedac21 100644 --- a/src/doc/src/commands/cargo-verify-project.md +++ b/src/doc/src/commands/cargo-verify-project.md @@ -104,8 +104,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo-yank.md b/src/doc/src/commands/cargo-yank.md index 8bf4f825c00..ec68e7ca9f3 100644 --- a/src/doc/src/commands/cargo-yank.md +++ b/src/doc/src/commands/cargo-yank.md @@ -113,8 +113,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/doc/src/commands/cargo.md b/src/doc/src/commands/cargo.md index f879fa5306c..683133838f8 100644 --- a/src/doc/src/commands/cargo.md +++ b/src/doc/src/commands/cargo.md @@ -221,8 +221,10 @@ See the rustup docum for more information about how toolchain overrides work. -
--config KEY=VALUE
-
Overrides a Cargo configuration value.
+
--config KEY=VALUE or PATH
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the command-line overrides section for more information.
-h
diff --git a/src/etc/man/cargo-add.1 b/src/etc/man/cargo-add.1 index 147e418d168..dfcb66dc9a1 100644 --- a/src/etc/man/cargo-add.1 +++ b/src/etc/man/cargo-add.1 @@ -190,9 +190,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-bench.1 b/src/etc/man/cargo-bench.1 index 94fe785b9b2..0f04fa3ef18 100644 --- a/src/etc/man/cargo-bench.1 +++ b/src/etc/man/cargo-bench.1 @@ -444,9 +444,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-build.1 b/src/etc/man/cargo-build.1 index 0947c39cf53..9421f5bf8c7 100644 --- a/src/etc/man/cargo-build.1 +++ b/src/etc/man/cargo-build.1 @@ -374,9 +374,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-check.1 b/src/etc/man/cargo-check.1 index cdec2538680..e9a91d362fa 100644 --- a/src/etc/man/cargo-check.1 +++ b/src/etc/man/cargo-check.1 @@ -355,9 +355,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-clean.1 b/src/etc/man/cargo-clean.1 index f0181fb5554..9570dd0e7e3 100644 --- a/src/etc/man/cargo-clean.1 +++ b/src/etc/man/cargo-clean.1 @@ -148,9 +148,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-doc.1 b/src/etc/man/cargo-doc.1 index 98a95e8fe4d..4bad7ec9144 100644 --- a/src/etc/man/cargo-doc.1 +++ b/src/etc/man/cargo-doc.1 @@ -322,9 +322,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-fetch.1 b/src/etc/man/cargo-fetch.1 index b87bbf9694c..960ee507e4b 100644 --- a/src/etc/man/cargo-fetch.1 +++ b/src/etc/man/cargo-fetch.1 @@ -122,9 +122,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-fix.1 b/src/etc/man/cargo-fix.1 index fb065b02a8c..0e92a8dfcd7 100644 --- a/src/etc/man/cargo-fix.1 +++ b/src/etc/man/cargo-fix.1 @@ -450,9 +450,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-generate-lockfile.1 b/src/etc/man/cargo-generate-lockfile.1 index 52ededfe7d5..5ac1d1ca34b 100644 --- a/src/etc/man/cargo-generate-lockfile.1 +++ b/src/etc/man/cargo-generate-lockfile.1 @@ -101,9 +101,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-init.1 b/src/etc/man/cargo-init.1 index 27bc3c7d671..6f4754b5cde 100644 --- a/src/etc/man/cargo-init.1 +++ b/src/etc/man/cargo-init.1 @@ -114,9 +114,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-install.1 b/src/etc/man/cargo-install.1 index e0ca7286241..b0b9cbe74a9 100644 --- a/src/etc/man/cargo-install.1 +++ b/src/etc/man/cargo-install.1 @@ -426,9 +426,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-locate-project.1 b/src/etc/man/cargo-locate-project.1 index e802e1b7444..37a0a81a807 100644 --- a/src/etc/man/cargo-locate-project.1 +++ b/src/etc/man/cargo-locate-project.1 @@ -87,9 +87,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-login.1 b/src/etc/man/cargo-login.1 index 79d16c906e2..7c197b62f43 100644 --- a/src/etc/man/cargo-login.1 +++ b/src/etc/man/cargo-login.1 @@ -78,9 +78,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-metadata.1 b/src/etc/man/cargo-metadata.1 index 774482256fa..95c386eec7f 100644 --- a/src/etc/man/cargo-metadata.1 +++ b/src/etc/man/cargo-metadata.1 @@ -425,9 +425,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-new.1 b/src/etc/man/cargo-new.1 index 7997788c386..766c11d6ac9 100644 --- a/src/etc/man/cargo-new.1 +++ b/src/etc/man/cargo-new.1 @@ -109,9 +109,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-owner.1 b/src/etc/man/cargo-owner.1 index d05b8a38fd8..4b9c2bb8fee 100644 --- a/src/etc/man/cargo-owner.1 +++ b/src/etc/man/cargo-owner.1 @@ -120,9 +120,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-package.1 b/src/etc/man/cargo-package.1 index bcb3b02ae93..2a8d0839645 100644 --- a/src/etc/man/cargo-package.1 +++ b/src/etc/man/cargo-package.1 @@ -294,9 +294,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-pkgid.1 b/src/etc/man/cargo-pkgid.1 index 315e38d306c..9026dd82441 100644 --- a/src/etc/man/cargo-pkgid.1 +++ b/src/etc/man/cargo-pkgid.1 @@ -156,9 +156,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-publish.1 b/src/etc/man/cargo-publish.1 index 5d0ebc0b960..1694299bd0d 100644 --- a/src/etc/man/cargo-publish.1 +++ b/src/etc/man/cargo-publish.1 @@ -244,9 +244,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-run.1 b/src/etc/man/cargo-run.1 index 461e88abd1a..af8b55820f7 100644 --- a/src/etc/man/cargo-run.1 +++ b/src/etc/man/cargo-run.1 @@ -255,9 +255,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-rustc.1 b/src/etc/man/cargo-rustc.1 index e5a16a82b31..9c2d5afc595 100644 --- a/src/etc/man/cargo-rustc.1 +++ b/src/etc/man/cargo-rustc.1 @@ -373,9 +373,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-rustdoc.1 b/src/etc/man/cargo-rustdoc.1 index 8c62edd9f83..cedf3d1db34 100644 --- a/src/etc/man/cargo-rustdoc.1 +++ b/src/etc/man/cargo-rustdoc.1 @@ -341,9 +341,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-search.1 b/src/etc/man/cargo-search.1 index f071661e8f2..921892370cf 100644 --- a/src/etc/man/cargo-search.1 +++ b/src/etc/man/cargo-search.1 @@ -81,9 +81,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-test.1 b/src/etc/man/cargo-test.1 index cf9887d00d1..ddf2e47774f 100644 --- a/src/etc/man/cargo-test.1 +++ b/src/etc/man/cargo-test.1 @@ -463,9 +463,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-tree.1 b/src/etc/man/cargo-tree.1 index 67759cc8f7a..8041fe6c4e5 100644 --- a/src/etc/man/cargo-tree.1 +++ b/src/etc/man/cargo-tree.1 @@ -354,9 +354,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-uninstall.1 b/src/etc/man/cargo-uninstall.1 index 5ac4204a561..6df3d9566da 100644 --- a/src/etc/man/cargo-uninstall.1 +++ b/src/etc/man/cargo-uninstall.1 @@ -104,9 +104,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-update.1 b/src/etc/man/cargo-update.1 index 12d8dbc31b3..307fe834c71 100644 --- a/src/etc/man/cargo-update.1 +++ b/src/etc/man/cargo-update.1 @@ -141,9 +141,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-vendor.1 b/src/etc/man/cargo-vendor.1 index 8e4fa3658f3..75dbbd08e14 100644 --- a/src/etc/man/cargo-vendor.1 +++ b/src/etc/man/cargo-vendor.1 @@ -132,9 +132,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-verify-project.1 b/src/etc/man/cargo-verify-project.1 index a31535179ed..09d6de02164 100644 --- a/src/etc/man/cargo-verify-project.1 +++ b/src/etc/man/cargo-verify-project.1 @@ -111,9 +111,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo-yank.1 b/src/etc/man/cargo-yank.1 index c144ea14f45..91d87dddbf3 100644 --- a/src/etc/man/cargo-yank.1 +++ b/src/etc/man/cargo-yank.1 @@ -112,9 +112,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, diff --git a/src/etc/man/cargo.1 b/src/etc/man/cargo.1 index 3d7e6aec590..f95fe9cdb96 100644 --- a/src/etc/man/cargo.1 +++ b/src/etc/man/cargo.1 @@ -244,9 +244,11 @@ See the \fIrustup documentation\fR for more information. .RE .sp \fB\-h\fR, From 164a8590be9e09ea1c1b1b589048b320dd5a4fcb Mon Sep 17 00:00:00 2001 From: Weihang Lo Date: Tue, 13 Sep 2022 09:25:13 +0100 Subject: [PATCH 2/3] Clarify config-relative paths for `--config ` --- src/doc/src/reference/config.md | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/src/doc/src/reference/config.md b/src/doc/src/reference/config.md index d7fe878bdbe..48e440ebb76 100644 --- a/src/doc/src/reference/config.md +++ b/src/doc/src/reference/config.md @@ -238,13 +238,26 @@ precedence rules as other options specified directly with `--config`. ### Config-relative paths -Paths in config files may be absolute, relative, or a bare name without any -path separators. Paths for executables without a path separator will use the -`PATH` environment variable to search for the executable. Paths for -non-executables will be relative to where the config value is defined. For -config files, that is relative to the parent directory of the `.cargo` -directory where the value was defined. For environment variables it is -relative to the current working directory. +Paths in config files may be absolute, relative, or a bare name without any path separators. +Paths for executables without a path separator will use the `PATH` environment variable to search for the executable. +Paths for non-executables will be relative to where the config value is defined. + +In particular, rules are: + +* For environment variables, paths are relative to the current working directory. +* For config files, paths are relative to the parent directory of the directory where the config files were defined, + no matter those files are from either the [hierarchical probing](#hierarchical-structure) + or the [`--config `](#command-line-overrides) option. + +> **Note:** To maintain consistency with existing `.cargo/config.toml` probing behavior, +> it is by design that a path in a config file passed via `--config ` +> is also relative to two levels up from the config file itself. +> +> To avoid unexpected results, the rule of thumb is putting your extra config files +> at the same level of discovered `.cargo/config.toml` in your porject. +> For instance, given a project `/my/project`, +> it is recommended to put config files under `/my/project/.cargo` +> or a new directory at the same level, such as `/my/project/.config`. ```toml # Relative path examples. From 758ee5dd1a6b8951706e37774c6baa1595448e24 Mon Sep 17 00:00:00 2001 From: Weihang Lo Date: Tue, 13 Sep 2022 16:46:08 +0100 Subject: [PATCH 3/3] Call out rule of relative path of `--config KEY=VALUE` --- src/doc/src/reference/config.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/doc/src/reference/config.md b/src/doc/src/reference/config.md index 48e440ebb76..e9eefc08272 100644 --- a/src/doc/src/reference/config.md +++ b/src/doc/src/reference/config.md @@ -245,6 +245,8 @@ Paths for non-executables will be relative to where the config value is defined. In particular, rules are: * For environment variables, paths are relative to the current working directory. +* For config values loaded directly from the [`--config KEY=VALUE`](#command-line-overrides) option, + paths are relative to the current working directory. * For config files, paths are relative to the parent directory of the directory where the config files were defined, no matter those files are from either the [hierarchical probing](#hierarchical-structure) or the [`--config `](#command-line-overrides) option.