Document lib before bin. by ehuss · Pull Request #10172 · rust-lang/cargo

ehuss · 2021-12-05T23:46:49Z

This changes it so that documenting a library is required to finish before documenting a binary. The issue is that the binary may have intra-doc links to the library. If they are documented concurrently, then the links will sometimes fail (since it is a race). Or, if doing cargo doc --bins, then the library docs wouldn't exist at all.

Note that in the tests this introduces some more name collisions if you just run cargo doc --bins and there is a colliding library/binary name. There is some risk that someone might be trying to run the commands separately to get around the collision error, but I think it is unlikely.

rust-highfive · 2021-12-05T23:46:51Z

r? @alexcrichton

(rust-highfive has picked a reviewer for you, use r? to override)

alexcrichton · 2021-12-13T15:34:16Z

@bors: r+

bors · 2021-12-13T15:34:18Z

📌 Commit a09fbf2 has been approved by alexcrichton

bors · 2021-12-13T15:38:34Z

⌛ Testing commit a09fbf2 with merge 3aaa8f9...

bors · 2021-12-13T16:16:55Z

☀️ Test successful - checks-actions
Approved by: alexcrichton
Pushing 3aaa8f9 to master...

Update cargo 14 commits in 40dc281755137ee804bc9b3b08e782773b726e44..a359ce16073401f28b84840da85b268aa3d37c88 2021-12-06 21:54:44 +0000 to 2021-12-14 18:40:22 +0000 - Support `term.quiet` configuration (rust-lang/cargo#10152) - Display alias target on 'cargo help <alias>` (rust-lang/cargo#10193) - delete --host command and message (rust-lang/cargo#10145) - Improve I/O error message for fingerprint of build script (rust-lang/cargo#10191) - Explicitly mark aliases in `cargo list`. (rust-lang/cargo#10177) - Don't emit "executable" JSON field for non-executables. (rust-lang/cargo#10171) - Move scrape-examples docs to correct section. (rust-lang/cargo#10166) - Do not suggest source config if nothing to vendor (rust-lang/cargo#10161) - Bump versions of local deps. (rust-lang/cargo#10155) - Bump to 0.60.0, update changelog (rust-lang/cargo#10154) - Fix some profile documentation. (rust-lang/cargo#10153) - Document lib before bin. (rust-lang/cargo#10172) - Sync cargo-the-cli version with rustc. (rust-lang/cargo#10178) - Remove `-Z future-incompat-report` from message displayed to user (rust-lang/cargo#10185)

Mark-Simulacrum · 2021-12-15T14:56:42Z

FWIW, this caused an error in rustc-perf on the token-stream-stress benchmark:

stderr=warning: output filename collision.
The bin target `token-stream-stress` in package `token-stream-stress v0.0.0 (/tmp/.tmp4JOGMM)` has the same output filename as the lib target `token-stream-stress` in package `token-stream-stress v0.0.0 (/tmp/.tmp4JOGMM)`.
Colliding filename is: /tmp/.tmp4JOGMM/target/doc/token_stream_stress/index.html
The targets should have unique names.
This is a known bug where multiple crates with the same name use
the same path; see <https://github.com/rust-lang/cargo/issues/6313>.
 Documenting token-stream-stress v0.0.0 (/tmp/.tmp4JOGMM)
"/home/collector/rustc-perf/cache/3ee016ae4d4c6ee4a34faa2eb7fdae2ffa7c9b46/bin/rustdoc" ["--edition=2018", "--crate-type", "proc-macro", "--crate-name", "token_stream_stress", "src/lib.rs", "-o", "/tmp/.tmp4JOGMM/target/doc", "--error-format=json", "--json=diagnostic-rendered-ansi,future-incompat", "-C", "metadata=49e968af46dd2295", "-L", "dependency=/tmp/.tmp4JOGMM/target/debug/deps", "--extern", "proc_macro", "--crate-version", "0.0.0", "-Adeprecated", "-Aunknown-lints"]
exiting -- non-wrapped rustc
error: could not document `token-stream-stress`

Caused by:
  process didn't exit successfully: `/home/collector/rustc-perf/target/release/rustdoc-fake --edition=2018 --crate-type proc-macro --crate-name token_stream_stress src/lib.rs -o /tmp/.tmp4JOGMM/target/doc --error-format=json --json=diagnostic-rendered-ansi,future-incompat -C metadata=49e968af46dd2295 -L dependency=/tmp/.tmp4JOGMM/target/debug/deps --extern proc_macro --crate-version 0.0.0` (exit status: 1)


 stdout=

I'm going to work around it by not trying to renaming the bin target (which I think should work), but wanted to make a note of it as "one thing that broke" :)

This avoids file collisions, which lead to spurious rebuilds and errors from Cargo (recently added by rust-lang/cargo#10172).

pnkfelix · 2021-12-15T15:44:04Z

Is cargo doing anything to lint against these sorts of name collisions? (Should it?)

This avoids file collisions, which lead to spurious rebuilds and errors from Cargo (recently added by rust-lang/cargo#10172).

Pkgsrc changes: * Bump available bootstraps to 1.58.1. * Adjust one patch (and checksum) so that it still applies. Upstream changes: Version 1.59.0 (2022-02-24) ========================== Language -------- - [Stabilize default arguments for const generics][90207] - [Stabilize destructuring assignment][90521] - [Relax private in public lint on generic bounds and where clauses of trait impls][90586] - [Stabilize asm! and global_asm! for x86, x86_64, ARM, Aarch64, and RISC-V][91728] Compiler -------- - [Stabilize new symbol mangling format, leaving it opt-in (-Csymbol-mangling-version=v0)][90128] - [Emit LLVM optimization remarks when enabled with `-Cremark`][90833] - [Fix sparc64 ABI for aggregates with floating point members][91003] - [Warn when a `#[test]`-like built-in attribute macro is present multiple times.][91172] - [Add support for riscv64gc-unknown-freebsd][91284] - [Stabilize `-Z emit-future-incompat` as `--json future-incompat`][91535] - [Soft disable incremental compilation][94124] This release disables incremental compilation, unless the user has explicitly opted in via the newly added RUSTC_FORCE_INCREMENTAL=1 environment variable. This is due to a known and relatively frequently occurring bug in incremental compilation, which causes builds to issue internal compiler errors. This particular bug is already fixed on nightly, but that fix has not yet rolled out to stable and is deemed too risky for a direct stable backport. As always, we encourage users to test with nightly and report bugs so that we can track failures and fix issues earlier. See [94124] for more details. [94124]: rust-lang/rust#94124 Libraries --------- - [Remove unnecessary bounds for some Hash{Map,Set} methods][91593] Stabilized APIs --------------- - [`std::thread::available_parallelism`][available_parallelism] - [`Result::copied`][result-copied] - [`Result::cloned`][result-cloned] - [`arch::asm!`][asm] - [`arch::global_asm!`][global_asm] - [`ops::ControlFlow::is_break`][is_break] - [`ops::ControlFlow::is_continue`][is_continue] - [`TryFrom<char> for u8`][try_from_char_u8] - [`char::TryFromCharError`][try_from_char_err] implementing `Clone`, `Debug`, `Display`, `PartialEq`, `Copy`, `Eq`, `Error` - [`iter::zip`][zip] - [`NonZeroU8::is_power_of_two`][is_power_of_two8] - [`NonZeroU16::is_power_of_two`][is_power_of_two16] - [`NonZeroU32::is_power_of_two`][is_power_of_two32] - [`NonZeroU64::is_power_of_two`][is_power_of_two64] - [`NonZeroU128::is_power_of_two`][is_power_of_two128] - [`DoubleEndedIterator for ToLowercase`][lowercase] - [`DoubleEndedIterator for ToUppercase`][uppercase] - [`TryFrom<&mut [T]> for [T; N]`][tryfrom_ref_arr] - [`UnwindSafe for Once`][unwindsafe_once] - [`RefUnwindSafe for Once`][refunwindsafe_once] - [armv8 neon intrinsics for aarch64][stdarch/1266] Const-stable: - [`mem::MaybeUninit::as_ptr`][muninit_ptr] - [`mem::MaybeUninit::assume_init`][muninit_init] - [`mem::MaybeUninit::assume_init_ref`][muninit_init_ref] - [`ffi::CStr::from_bytes_with_nul_unchecked`][cstr_from_bytes] Cargo ----- - [Stabilize the `strip` profile option][cargo/10088] - [Stabilize future-incompat-report][cargo/10165] - [Support abbreviating `--release` as `-r`][cargo/10133] - [Support `term.quiet` configuration][cargo/10152] - [Remove `--host` from cargo {publish,search,login}][cargo/10145] Compatibility Notes ------------------- - [Refactor weak symbols in std::sys::unix][90846] This may add new, versioned, symbols when building with a newer glibc, as the standard library uses weak linkage rather than dynamically attempting to load certain symbols at runtime. - [Deprecate crate_type and crate_name nested inside `#![cfg_attr]`][83744] This adds a future compatibility lint to supporting the use of cfg_attr wrapping either crate_type or crate_name specification within Rust files; it is recommended that users migrate to setting the equivalent command line flags. - [Remove effect of `#[no_link]` attribute on name resolution][92034] This may expose new names, leading to conflicts with preexisting names in a given namespace and a compilation failure. - [Cargo will document libraries before binaries.][cargo/10172] - [Respect doc=false in dependencies, not just the root crate][cargo/10201] - [Weaken guarantee around advancing underlying iterators in zip][83791] - [Make split_inclusive() on an empty slice yield an empty output][89825] - [Update std::env::temp_dir to use GetTempPath2 on Windows when available.][89999] - [unreachable! was updated to match other formatting macro behavior on Rust 2021][92137] Internal Changes ---------------- These changes provide no direct user facing benefits, but represent significant improvements to the internals and overall performance of rustc and related tools. - [Fix many cases of normalization-related ICEs][91255] - [Replace dominators algorithm with simple Lengauer-Tarjan][85013] - [Store liveness in interval sets for region inference][90637] - [Remove `in_band_lifetimes` from the compiler and standard library, in preparation for removing this unstable feature.][91867] [91867]: rust-lang/rust#91867 [83744]: rust-lang/rust#83744 [83791]: rust-lang/rust#83791 [85013]: rust-lang/rust#85013 [89825]: rust-lang/rust#89825 [89999]: rust-lang/rust#89999 [90128]: rust-lang/rust#90128 [90207]: rust-lang/rust#90207 [90521]: rust-lang/rust#90521 [90586]: rust-lang/rust#90586 [90637]: rust-lang/rust#90637 [90833]: rust-lang/rust#90833 [90846]: rust-lang/rust#90846 [91003]: rust-lang/rust#91003 [91172]: rust-lang/rust#91172 [91255]: rust-lang/rust#91255 [91284]: rust-lang/rust#91284 [91535]: rust-lang/rust#91535 [91593]: rust-lang/rust#91593 [91728]: rust-lang/rust#91728 [91878]: rust-lang/rust#91878 [91896]: rust-lang/rust#91896 [91926]: rust-lang/rust#91926 [91984]: rust-lang/rust#91984 [92020]: rust-lang/rust#92020 [92034]: rust-lang/rust#92034 [92483]: rust-lang/rust#92483 [cargo/10088]: rust-lang/cargo#10088 [cargo/10133]: rust-lang/cargo#10133 [cargo/10145]: rust-lang/cargo#10145 [cargo/10152]: rust-lang/cargo#10152 [cargo/10165]: rust-lang/cargo#10165 [cargo/10172]: rust-lang/cargo#10172 [cargo/10201]: rust-lang/cargo#10201 [cargo/10269]: rust-lang/cargo#10269 [cstr_from_bytes]: https://doc.rust-lang.org/stable/std/ffi/struct.CStr.html#method.from_bytes_with_nul_unchecked [muninit_ptr]: https://doc.rust-lang.org/stable/std/mem/union.MaybeUninit.html#method.as_ptr [muninit_init]: https://doc.rust-lang.org/stable/std/mem/union.MaybeUninit.html#method.assume_init [muninit_init_ref]: https://doc.rust-lang.org/stable/std/mem/union.MaybeUninit.html#method.assume_init_ref [unwindsafe_once]: https://doc.rust-lang.org/stable/std/sync/struct.Once.html#impl-UnwindSafe [refunwindsafe_once]: https://doc.rust-lang.org/stable/std/sync/struct.Once.html#impl-RefUnwindSafe [tryfrom_ref_arr]: https://doc.rust-lang.org/stable/std/convert/trait.TryFrom.html#impl-TryFrom%3C%26%27_%20mut%20%5BT%5D%3E [lowercase]: https://doc.rust-lang.org/stable/std/char/struct.ToLowercase.html#impl-DoubleEndedIterator [uppercase]: https://doc.rust-lang.org/stable/std/char/struct.ToUppercase.html#impl-DoubleEndedIterator [try_from_char_err]: https://doc.rust-lang.org/stable/std/char/struct.TryFromCharError.html [available_parallelism]: https://doc.rust-lang.org/stable/std/thread/fn.available_parallelism.html [result-copied]: https://doc.rust-lang.org/stable/std/result/enum.Result.html#method.copied [result-cloned]: https://doc.rust-lang.org/stable/std/result/enum.Result.html#method.cloned [asm]: https://doc.rust-lang.org/stable/core/arch/macro.asm.html [global_asm]: https://doc.rust-lang.org/stable/core/arch/macro.global_asm.html [is_break]: https://doc.rust-lang.org/stable/std/ops/enum.ControlFlow.html#method.is_break [is_continue]: https://doc.rust-lang.org/stable/std/ops/enum.ControlFlow.html#method.is_continue [try_from_char_u8]: https://doc.rust-lang.org/stable/std/primitive.char.html#impl-TryFrom%3Cchar%3E [zip]: https://doc.rust-lang.org/stable/std/iter/fn.zip.html [is_power_of_two8]: https://doc.rust-lang.org/stable/core/num/struct.NonZeroU8.html#method.is_power_of_two [is_power_of_two16]: https://doc.rust-lang.org/stable/core/num/struct.NonZeroU16.html#method.is_power_of_two [is_power_of_two32]: https://doc.rust-lang.org/stable/core/num/struct.NonZeroU32.html#method.is_power_of_two [is_power_of_two64]: https://doc.rust-lang.org/stable/core/num/struct.NonZeroU64.html#method.is_power_of_two [is_power_of_two128]: https://doc.rust-lang.org/stable/core/num/struct.NonZeroU128.html#method.is_power_of_two [stdarch/1266]: rust-lang/stdarch#1266

Document lib before bin.

a09fbf2

rust-highfive assigned alexcrichton Dec 5, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 5, 2021

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 13, 2021

bors merged commit 3aaa8f9 into rust-lang:master Dec 13, 2021

This was referenced Dec 13, 2021

Implement "artifact dependencies" (RFC-3028) #9992

Merged

Implement 'multidep' (RFC-3176) #10061

Closed

When documenting private items in a binary, ignore warnings about links to private items #10142

Merged

ehuss mentioned this pull request Dec 14, 2021

Update cargo rust-lang/rust#91940

Merged

Mark-Simulacrum added a commit to Mark-Simulacrum/rustc-perf that referenced this pull request Dec 15, 2021

Name bin target differently from lib

d836c7b

This avoids file collisions, which lead to spurious rebuilds and errors from Cargo (recently added by rust-lang/cargo#10172).

Mark-Simulacrum mentioned this pull request Dec 15, 2021

Name bin target differently from lib rust-lang/rustc-perf#1122

Merged

Mark-Simulacrum added a commit to Mark-Simulacrum/rustc-perf that referenced this pull request Dec 15, 2021

Name bin target differently from lib

26938e1

This avoids file collisions, which lead to spurious rebuilds and errors from Cargo (recently added by rust-lang/cargo#10172).

ehuss added this to the 1.59.0 milestone Feb 6, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document lib before bin.#10172

Document lib before bin.#10172
bors merged 1 commit intorust-lang:masterfrom
ehuss:doc-lib-before-bin

ehuss commented Dec 5, 2021

Uh oh!

rust-highfive commented Dec 5, 2021

Uh oh!

alexcrichton commented Dec 13, 2021

Uh oh!

bors commented Dec 13, 2021

Uh oh!

bors commented Dec 13, 2021

Uh oh!

bors commented Dec 13, 2021

Uh oh!

Mark-Simulacrum commented Dec 15, 2021

Uh oh!

pnkfelix commented Dec 15, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

ehuss commented Dec 5, 2021

Uh oh!

rust-highfive commented Dec 5, 2021

Uh oh!

alexcrichton commented Dec 13, 2021

Uh oh!

bors commented Dec 13, 2021

Uh oh!

bors commented Dec 13, 2021

Uh oh!

bors commented Dec 13, 2021

Uh oh!

Mark-Simulacrum commented Dec 15, 2021

Uh oh!

pnkfelix commented Dec 15, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants