Skip to content

Commit 17463fd

Browse files
committed
fixed documentation and regenaration of the pages
Fix all the broken intra-doc links docs(build-rs): Fix broken intra-doc links These were caught with the latest nightly This was pulled from rust-lang#15800 chore(deps): update rust crate cargo_metadata to 0.21.0 docs: `-Zpackage-workspace` has been stabilized chore: bump to 0.92.0 docs: update changelog for 1.90.0 Add test for multiple build scripts in different order Preserve order of build scripts Update semver tests for 1.89 This updates the tests where messages have changed in 1.89. chore(deps): update msrv (1 version) to v1.89 chore: Bump versions test(build-std): relax the thread name assertion rust-lang/rust#115746 changed to print thread ID, so we update accordingly. chore(deps): update cargo-semver-checks to v0.43.0 docs(unstable): Link out to the Plumbing commands effort This is intended to help people discover where to go to discuss plumbing command efforts. chore(deps): update compatible add is_inherited method to InheritableDependency add is_inherited method to InheritableField Add unstable `-Zsection-timings` flag Pass `--json=timings` to rustc when `--timings` and `-Zsection-timings` is enabled Parse and store section timing events Add section timing data to JSON `--timings` output Make headers of the HTML `--timings` unit table dynamic Add compilation sections to the HTML unit table Duplicates of unknown_feature test More helpful error for invalid cargo-features = [] test(package): Add test to verify package build cache behavior fix(package): Fixed inconsistent build cache behavior during package verify When running `cargo package` the verify the build cache (target-dir/build-dir) will not be used and all dependencies will be recompiled. This is inconsistent as setting target dir (via `CARGO_TARGET_DIR` for example) will cause `cargo package` to reuse the build cache. This commit changes the default behavior to always use the build cache, matching the behavior of having target-dir set. chore(deps): update msrv (3 versions) to v1.87 chore: remove x86_64-apple-darwin from CI and tests RFC 3841 has merged, and x86_64-apple-darwin will be demoted to tier-2 in 1.90.0. In Cargo we usually run test against tier-1 platforms, so x86_64-apple-darwin should be removed. Also, that target platform is often the slowest one in CI, we are happy to remove it to save us a couple of minutes. https://rust-lang.github.io/rfcs/3841-demote-x86_64-apple-darwin.html chore(deps): bump slab from 0.4.10 to 0.4.11 Bumps [slab](https://github.com/tokio-rs/slab) from 0.4.10 to 0.4.11. - [Release notes](https://github.com/tokio-rs/slab/releases) - [Changelog](https://github.com/tokio-rs/slab/blob/master/CHANGELOG.md) - [Commits](tokio-rs/slab@v0.4.10...v0.4.11) --- updated-dependencies: - dependency-name: slab dependency-version: 0.4.11 dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> refactor: make resolve features public feat(build-dir): Stabilize build-dir docs: Formatting and cross-linking to build-dir/target-dir docs Update src/doc/man/cargo-doc.md as per the feedback recieved regenerated pages using cargo build-man and ran ./ci/validate-man.sh and sync branch with master branch
1 parent c204194 commit 17463fd

File tree

4 files changed

+10
-0
lines changed

4 files changed

+10
-0
lines changed

src/doc/man/cargo-doc.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ cargo-doc --- Build a package's documentation
1616
Build the documentation for the local package and all dependencies. The output
1717
is placed in `target/doc` in rustdoc's usual format.
1818

19+
**Note:** Documentation generation is cumulative: existing doc files in the target directory are preserved across different `cargo doc` invocations. To remove existing generated docs, pass `--doc` to {{man "cargo-clean" 1}}.
20+
1921
## OPTIONS
2022

2123
### Documentation Options

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ DESCRIPTION
1010
Build the documentation for the local package and all dependencies. The
1111
output is placed in target/doc in rustdoc’s usual format.
1212

13+
Note: Documentation generation is cumulative: existing doc files in the
14+
target directory are preserved across different cargo doc invocations.
15+
To remove existing generated docs, pass --doc to cargo-clean(1).
16+
1317
OPTIONS
1418
Documentation Options
1519
--open

src/doc/src/commands/cargo-doc.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ cargo-doc --- Build a package's documentation
1212
Build the documentation for the local package and all dependencies. The output
1313
is placed in `target/doc` in rustdoc's usual format.
1414

15+
**Note:** Documentation generation is cumulative: existing doc files in the target directory are preserved across different `cargo doc` invocations. To remove existing generated docs, pass `--doc` to [cargo-clean(1)](cargo-clean.html).
16+
1517
## OPTIONS
1618

1719
### Documentation Options

src/etc/man/cargo-doc.1

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ cargo\-doc \[em] Build a package\[cq]s documentation
1010
.SH "DESCRIPTION"
1111
Build the documentation for the local package and all dependencies. The output
1212
is placed in \fBtarget/doc\fR in rustdoc\[cq]s usual format.
13+
.sp
14+
\fBNote:\fR Documentation generation is cumulative: existing doc files in the target directory are preserved across different \fBcargo doc\fR invocations. To remove existing generated docs, pass \fB\-\-doc\fR to \fBcargo\-clean\fR(1).
1315
.SH "OPTIONS"
1416
.SS "Documentation Options"
1517
.sp

0 commit comments

Comments
 (0)