Skip to content

Commit 34cb1ea

Browse files
committed
Auto merge of #11947 - ehuss:c-before-command, r=weihanglo
Clarify docs on `-C` that it appears before the command. The docs for `-C` currently don't mention that it must appear before the command name. This is the only root option that behaves this way that is documented in every page (except for `+toolchain`, which already mentions its position restriction). This adds some text to explain this restriction.
2 parents 1b2de21 + 9ba2ca2 commit 34cb1ea

File tree

97 files changed

+226
-97
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+226
-97
lines changed

src/doc/man/generated_txt/cargo-add.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,9 @@ OPTIONS
191191
Changes the current working directory before executing any specified
192192
operations. This affects things like where cargo looks by default
193193
for the project manifest (Cargo.toml), as well as the directories
194-
searched for discovering .cargo/config.toml, for example.
194+
searched for discovering .cargo/config.toml, for example. This
195+
option must appear before the command name, for example cargo -C
196+
path/to/my-project build.
195197

196198
-h, --help
197199
Prints help information.

src/doc/man/generated_txt/cargo-bench.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,9 @@ OPTIONS
376376
Changes the current working directory before executing any specified
377377
operations. This affects things like where cargo looks by default
378378
for the project manifest (Cargo.toml), as well as the directories
379-
searched for discovering .cargo/config.toml, for example.
379+
searched for discovering .cargo/config.toml, for example. This
380+
option must appear before the command name, for example cargo -C
381+
path/to/my-project build.
380382

381383
-h, --help
382384
Prints help information.

src/doc/man/generated_txt/cargo-build.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,9 @@ OPTIONS
318318
Changes the current working directory before executing any specified
319319
operations. This affects things like where cargo looks by default
320320
for the project manifest (Cargo.toml), as well as the directories
321-
searched for discovering .cargo/config.toml, for example.
321+
searched for discovering .cargo/config.toml, for example. This
322+
option must appear before the command name, for example cargo -C
323+
path/to/my-project build.
322324

323325
-h, --help
324326
Prints help information.

src/doc/man/generated_txt/cargo-check.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,9 @@ OPTIONS
303303
Changes the current working directory before executing any specified
304304
operations. This affects things like where cargo looks by default
305305
for the project manifest (Cargo.toml), as well as the directories
306-
searched for discovering .cargo/config.toml, for example.
306+
searched for discovering .cargo/config.toml, for example. This
307+
option must appear before the command name, for example cargo -C
308+
path/to/my-project build.
307309

308310
-h, --help
309311
Prints help information.

src/doc/man/generated_txt/cargo-clean.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,9 @@ OPTIONS
132132
Changes the current working directory before executing any specified
133133
operations. This affects things like where cargo looks by default
134134
for the project manifest (Cargo.toml), as well as the directories
135-
searched for discovering .cargo/config.toml, for example.
135+
searched for discovering .cargo/config.toml, for example. This
136+
option must appear before the command name, for example cargo -C
137+
path/to/my-project build.
136138

137139
-h, --help
138140
Prints help information.

src/doc/man/generated_txt/cargo-doc.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,9 @@ OPTIONS
274274
Changes the current working directory before executing any specified
275275
operations. This affects things like where cargo looks by default
276276
for the project manifest (Cargo.toml), as well as the directories
277-
searched for discovering .cargo/config.toml, for example.
277+
searched for discovering .cargo/config.toml, for example. This
278+
option must appear before the command name, for example cargo -C
279+
path/to/my-project build.
278280

279281
-h, --help
280282
Prints help information.

src/doc/man/generated_txt/cargo-fetch.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,9 @@ OPTIONS
117117
Changes the current working directory before executing any specified
118118
operations. This affects things like where cargo looks by default
119119
for the project manifest (Cargo.toml), as well as the directories
120-
searched for discovering .cargo/config.toml, for example.
120+
searched for discovering .cargo/config.toml, for example. This
121+
option must appear before the command name, for example cargo -C
122+
path/to/my-project build.
121123

122124
-h, --help
123125
Prints help information.

src/doc/man/generated_txt/cargo-fix.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,9 @@ OPTIONS
376376
Changes the current working directory before executing any specified
377377
operations. This affects things like where cargo looks by default
378378
for the project manifest (Cargo.toml), as well as the directories
379-
searched for discovering .cargo/config.toml, for example.
379+
searched for discovering .cargo/config.toml, for example. This
380+
option must appear before the command name, for example cargo -C
381+
path/to/my-project build.
380382

381383
-h, --help
382384
Prints help information.

src/doc/man/generated_txt/cargo-generate-lockfile.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,9 @@ OPTIONS
9292
Changes the current working directory before executing any specified
9393
operations. This affects things like where cargo looks by default
9494
for the project manifest (Cargo.toml), as well as the directories
95-
searched for discovering .cargo/config.toml, for example.
95+
searched for discovering .cargo/config.toml, for example. This
96+
option must appear before the command name, for example cargo -C
97+
path/to/my-project build.
9698

9799
-h, --help
98100
Prints help information.

src/doc/man/generated_txt/cargo-init.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,9 @@ OPTIONS
100100
Changes the current working directory before executing any specified
101101
operations. This affects things like where cargo looks by default
102102
for the project manifest (Cargo.toml), as well as the directories
103-
searched for discovering .cargo/config.toml, for example.
103+
searched for discovering .cargo/config.toml, for example. This
104+
option must appear before the command name, for example cargo -C
105+
path/to/my-project build.
104106

105107
-h, --help
106108
Prints help information.

0 commit comments

Comments
 (0)