82 Commits

Author SHA1 Message Date
Weihang Lo
a5c8b96f82
fix: use host-tuple for host target subsitution
The "host" string is ambiguous

* We have `-Zhost-config` that config `[host]` table applies to
  artifacts running on host, such as build scripts and proc macros.
* `host` sounds like the default behavior, whereas `--target host`
  is in the cross-compilation mode: `target/<triple>/debug`.
* We might want to reserve `host` for future use
2025-09-23 20:08:28 -04:00
Ed Page
19f1d1561c fix: Switch from --nocapture to --no-capture
`--no-capture` was added in 1.88, with `--nocapture` being
soft-deprecated.
2025-09-05 10:33:00 -05:00
zdivelbiss
d5509ebacc
amend documentation style for host target specifier
We also rebuilt the manual pages, to ensure they're up-to-date with the changes made in the `host` target specifier PR.
2025-08-17 14:39:35 -05:00
zdivelbiss
b23e0a99b2
documentation for host target specifier 2025-08-17 12:52:11 -05:00
Weihang Lo
f7c9066169
fix: align first line of unordered list with following
This looks more nature.
Most of other popular softwares follow the same style.
For example, git-merge, tar, and bash.
2025-02-09 10:15:42 -05:00
Ralf Jung
2783a0f549 don't talk about benchmark mode / test mode in help 2024-10-12 16:33:32 +02:00
Ed Page
1dde071548 docs: Move Cache topic from Guide to Reference
It doesn't "guide" people through a topic but explains in a more
top-down fashion what caches exist and is not particularly a common
topic people need to know.
2024-10-03 08:23:45 -05:00
Ifropc
f8662171f4
doc: update lockfile-path tracking issue 2024-08-18 10:50:27 -07:00
Ifropc
bf7e2dcc1d
feat: lockfile path refactoring 2024-08-03 16:40:10 -07:00
Ifropc
3da56677e1
refactoring: lockfile-path documentation and implementation cleanup 2024-07-31 21:30:44 -07:00
Ifropc
c25dcf00df
doc: add docs for lockfile-path 2024-07-30 21:20:17 -07:00
Eric Huss
c65b7b2376 Fix some documentation misspellings 2024-06-13 16:48:47 -07:00
Ed Page
a0ba72918a fix(help): Generalize --ignore-rust-version 2024-04-11 13:45:39 -05:00
Weihang Lo
26b2e74e55
docs: clarify --locked disallows changes in Cargo.lock 2024-03-28 12:08:57 -04:00
Weihang Lo
e549bc809b
fix(cli): resolve confusion between --frozen and --locked 2024-03-27 22:05:03 -04:00
Martin Robinson
8fa25ba41d chore: Fix minor grammar nit in command-line help
A *very* minor grammar correction. "Require" used in this way is
typically followed by the infinitive.
2024-03-18 14:32:28 +01:00
Bryan Garza
604d2e40e2 chore: update pulldown-cmark to 0.10.0
Fixes: https://github.com/rust-lang/cargo/issues/13509
2024-03-04 20:14:44 +00:00
bors
220767c14b Auto merge of #12844 - shuoer86:master, r=weihanglo
docs: fix typo
2023-10-19 14:37:42 +00:00
shuoer86
6c2579184a
docs: fix typos 2023-10-19 21:13:07 +08:00
Weihang Lo
ff376df716
docs(cargo-bench): --bench is passed in unconditionally to bench harnesses 2023-10-18 15:40:12 -04:00
David Tolnay
ece5269e97
Stabilize --keep-going 2023-08-26 13:14:39 -07:00
Charalampos Mitrodimas
a777b82d5f Support "default" option for build.jobs
This commit adds support for passing the keyword "default"
to either the CLI "--jobs" argument on the "[build.jobs]"
section of ".cargo/config".

This is dony by:
  1. Changing the "jobs" config type to an enum that holds
     a String or an Integer(i.e. i32).
  2. Matching the enum & casting it to an integer

Signed-off-by: Charalampos Mitrodimas <charmitro@gmail.com>
2023-06-03 15:24:41 +03:00
Eric Huss
03a5d8f4a7 Clarify documentation around test target setting.
There was some confusion about the wording in this section regarding
what happens with an example's `main` function. This tries to be more
explicit to clarify what happens when an example is marked as a test.

This also adds a few other clarifications and a link to the reference
documentation.

Closes #11528
2023-04-24 20:19:15 -07:00
Eric Huss
3da2b3c67b Mark -C as unstable 2023-04-11 19:46:05 -07:00
Eric Huss
9ba2ca2034 Clarify docs on -C that it appears before the command. 2023-04-09 09:58:06 -07:00
jofas
355ddf57ee documented working directory behaviour of cargo-test, cargo-bench and cargo-run commands 2023-03-29 10:02:17 +02:00
Enyium
b1754b2aa2 Regenerate derived doc formats. 2023-02-14 08:24:20 +01:00
Will Page
6510cc5c4b Regenerated documentation with updated '-C' cargo option 2023-02-10 07:42:48 -08:00
Weihang Lo
65332bc9f1
Expand details for --config cli arg 2022-09-13 10:25:54 +01:00
andrewpollack
195b1e0e50 Removing excess in 2022-08-11 16:47:52 -07:00
hi-rustin
a6e6b89d71 Mark -timings=html unstable in the document
Signed-off-by: hi-rustin <rustin.liu@gmail.com>
2022-08-05 19:39:13 +08:00
Yerkebulan Tulibergenov
767368fd02 Merge branch 'master' into yerke/negative_jobs 2022-07-31 18:21:33 -07:00
Weihang Lo
3e177e0f45
Update docs for -Zmultitarget stabilization 2022-07-17 11:02:01 +01:00
Yerkebulan Tulibergenov
5b76fb3d2b update man pages 2022-07-10 16:06:25 -07:00
Jon Gjengset
7eefb4221f Include --config in cargo help output 2022-06-21 16:24:41 +00:00
Eric Huss
5d336093e8 Small wording tweak. 2022-06-05 10:20:53 -07:00
Weihang Lo
38aea8e057
doc: don't mention #[test] in cargo-bench doc
This is too details and not for averaged users.
2022-06-04 21:43:58 +08:00
Weihang Lo
dd8841f6f3
Rephrase wordings in testing docs
- Rephrase doctest exec model as "not guranteed and may change" instead
- Mention `#[bench]` in what cargo-bench automatically runs
- Make it clear for build/rustc when mentioning bin targets auto-built
2022-06-04 08:24:08 +08:00
Weihang Lo
af0fbf4277
doc: mention cargo test runs test targets serially 2022-06-03 20:28:46 +08:00
Weihang Lo
370a481b43
doc: mention binary auto-built for build,bench,test,rustc 2022-06-03 19:49:15 +08:00
Ed Page
f728045729 doc: Include -F in option lists
The manual change is to `src/doc/man/includes/section-features.md`, the
rest is code-generated.
2022-04-18 19:19:40 -05:00
David Tolnay
4e45f58852
Unstable --keep-going flag 2022-03-21 18:36:40 -07:00
Piggy NL
08734a6643
Fix errors in cargo fetch usage guide
Co-authored-by: Caleb Maclennan <caleb@alerque.com>
2022-02-18 01:10:33 +08:00
Josh Triplett
086e71da00 Fix typo: --timing -> --timings 2022-01-30 21:43:52 -08:00
Josh Triplett
81e1998e11 Make --timings=html unstable, and only stabilize --timings 2022-01-30 21:43:52 -08:00
Josh Triplett
c854247149 Make --timings require = if passing an argument
This avoids ambiguity between its optional argument and positional
arguments.
2022-01-30 21:43:52 -08:00
Josh Triplett
e23f5f41d1 Move timing reports to target/cargo-timings
This avoids dropping them wherever Cargo happens to run from, and
instead places them under the target directory.

This has the advantage, and disadvantage, that `cargo clean` will remove
them.
2022-01-30 21:43:52 -08:00
Josh Triplett
c06691897a Stabilize -Ztimings as --timings
The `-Ztimings` option has existed for years, and many people use it to
profile and optimize their builds. It's one of the common reasons people
use nightly cargo.

The machine-readable JSON output may warrant further careful inspection
before we commit to a stable format. However, for the human-readable
output we don't need to make any commitment about the exact output.

Add a `--timings` option, as the stable equivalent to `-Ztimings`.
Stabilize the `html` output format, and require `-Zunstable-options` for
the `json` output format.

Document the new option, and update the testsuite.
2022-01-30 21:43:48 -08:00
Steven Joruk
cd4e280458 Update docs 2021-12-08 22:18:47 +00:00
hi-rustin
17c0ea7417 Improve the help text of the --quiet args for all commands
Signed-off-by: hi-rustin <rustin.liu@gmail.com>
2021-11-14 20:41:00 +08:00