Skip to content

Commit 5244300

Browse files
committed
Auto merge of #11652 - hi-rustin:rustin-patch-docs, r=epage
Mention current default value in `publish.timeout` docs I think it would help if we mention the default value in the docs.
2 parents 99b1369 + cd6cbe4 commit 5244300

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

src/doc/src/reference/unstable.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -459,18 +459,18 @@ CLI paths are relative to the current working directory.
459459
* Tracking Issue: [#9453](https://github.com/rust-lang/cargo/issues/9453)
460460

461461
Historically, Cargo's behavior for whether the `linker` and `rustflags`
462-
configuration options from environment variables and
463-
[`[target]`](config.md#target) are respected for build scripts, plugins,
464-
and other artifacts that are _always_ built for the host platform has
462+
configuration options from environment variables and
463+
[`[target]`](config.md#target) are respected for build scripts, plugins,
464+
and other artifacts that are _always_ built for the host platform has
465465
been somewhat inconsistent.
466466
When `--target` is _not_ passed, Cargo respects the same `linker` and
467467
`rustflags` for build scripts as for all other compile artifacts. When
468468
`--target` _is_ passed, however, Cargo respects `linker` from
469-
[`[target.<host triple>]`](config.md#targettriplelinker), and does not
470-
pick up any `rustflags` configuration.
471-
This dual behavior is confusing, but also makes it difficult to correctly
472-
configure builds where the host triple and the [target triple] happen to
473-
be the same, but artifacts intended to run on the build host should still
469+
[`[target.<host triple>]`](config.md#targettriplelinker), and does not
470+
pick up any `rustflags` configuration.
471+
This dual behavior is confusing, but also makes it difficult to correctly
472+
configure builds where the host triple and the [target triple] happen to
473+
be the same, but artifacts intended to run on the build host should still
474474
be configured differently.
475475

476476
`-Ztarget-applies-to-host` enables the top-level
@@ -813,7 +813,8 @@ The `publish.timeout` key in a config file can be used to control how long
813813
`cargo publish` waits between posting a package to the registry and it being
814814
available in the local index.
815815

816-
A timeout of `0` prevents any checks from occurring.
816+
A timeout of `0` prevents any checks from occurring. The current default is
817+
`60` seconds.
817818

818819
It requires the `-Zpublish-timeout` command-line options to be set.
819820

@@ -1152,7 +1153,7 @@ like this:
11521153
cargo doc -Z unstable-options -Z rustdoc-scrape-examples
11531154
```
11541155

1155-
By default, Cargo will scrape examples from the example targets of packages being documented.
1156+
By default, Cargo will scrape examples from the example targets of packages being documented.
11561157
You can individually enable or disable targets from being scraped with the `doc-scrape-examples` flag, such as:
11571158

11581159
```toml
@@ -1170,8 +1171,8 @@ doc-scrape-examples = false
11701171
examples from tests is a work-in-progress.
11711172

11721173
**Note on dev-dependencies:** documenting a library does not normally require the crate's dev-dependencies. However,
1173-
example targets require dev-deps. For backwards compatibility, `-Z rustdoc-scrape-examples` will *not* introduce a
1174-
dev-deps requirement for `cargo doc`. Therefore examples will *not* be scraped from example targets under the
1174+
example targets require dev-deps. For backwards compatibility, `-Z rustdoc-scrape-examples` will *not* introduce a
1175+
dev-deps requirement for `cargo doc`. Therefore examples will *not* be scraped from example targets under the
11751176
following conditions:
11761177

11771178
1. No target being documented requires dev-deps, AND

0 commit comments

Comments
 (0)