Clarify that cargo doc --no-deps is cumulative and won’t delete prev#15800
Conversation
b5fbe40 to
465c2af
Compare
src/doc/man/cargo-doc.md
Outdated
| {{#option "`--no-deps`" }} | ||
| Do not build documentation for dependencies. | ||
|
|
||
| **Note:** Documentation is _cumulative_. If you’ve already run |
There was a problem hiding this comment.
The cumulative behavior is not specific to the --no-deps flag. I would personally prefer to seeing this in DESCRIPTION than here.
There was a problem hiding this comment.
Sure, I have added this information in DESCRIPTION.
src/doc/man/cargo-doc.md
Outdated
| old dependency docs. To remove them, you can either: | ||
|
|
||
| 1. Run `cargo clean --doc` before `cargo doc --no-deps`, or | ||
| 2. Manually delete the unwanted folders under `target/doc/`. |
There was a problem hiding this comment.
Why did this call out manually? Anything cargo clean --doc can't achieve?
There was a problem hiding this comment.
This has been fixed, thanks !
892bd12 to
55cb10b
Compare
weihanglo
left a comment
There was a problem hiding this comment.
Not sure why putting this in draft again. Ready for review?
src/doc/man/cargo-doc.md
Outdated
| old dependency docs. To remove them, you can either: | ||
|
|
||
| 1. Run `cargo clean --doc` before `cargo doc --no-deps`, or | ||
| 2. Manually delete the unwanted folders under `target/doc/`. |
src/doc/man/cargo-doc.md
Outdated
| simply prevent *rebuilding* those pages—they will remain until you | ||
| explicitly clean them up. | ||
|
|
||
| ### Removing old docs |
There was a problem hiding this comment.
I don't feel like "Remvoing old docs" requires its own paragraph. We should probably put less doc on this.
Perhaps in combination of the previous paragraph, we do this
Documentation generation is cumulative: existing doc files in the target directory are preserved across different
cargo docinvocations. To remove existing generated docs, pass--docto {{man "cargo-clean" 1}}.
55cb10b to
330f1de
Compare
One test failed for docs so i am fixing it and then i will push the changes again. |
4986b8f to
b29b82e
Compare
b29b82e to
004fa29
Compare
23e20fc to
7e44417
Compare
weihanglo
left a comment
There was a problem hiding this comment.
Normally I would suggest splitting the second commit (fixing lint error) into its own pull request, though it is too much a hassle here atm so going to merge it as-is. I would still encourage fixing unrelated errors separately in the future.
Thanks for the contribution anyway.
These were caught with the latest nightly This was pulled from rust-lang#15800
### What does this PR try to resolve? Unblock CI ### How to test and review this PR? ### Notes These were caught with the latest nightly This was pulled from #15800
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] <support@github.com> 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
1a6b1da to
17463fd
Compare
…d regenerated pages using cargo build-man and ran ./ci/validate-man.sh
17463fd to
ff9a9c8
Compare
cargo doc --no-deps is cumulative and won’t delete prev issue #15728cargo doc --no-deps is cumulative and won’t delete prev
What does this PR try to resolve?
clarifies that cargo doc --no-deps will not delete previously-built dependency docs, and points users to cargo clean --doc or manual deletion if they want a truly “fresh” doc set. This pr fixed #15728
How to test and review this PR?
No testing required.