-
Notifications
You must be signed in to change notification settings - Fork 12.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support documenting cargo #105036
Support documenting cargo #105036
Conversation
(rustbot has picked a reviewer for you, use r? to override) |
What would be the consequence if Cargo breaks its rustdoc build? I mean, is there any lint rule set for building those internal docs? In Cargo, we currently set |
@weihanglo that will delay the submodule bump until it's fixed in cargo. I don't think rustc sets any custom warnings for out of tree tools though, so deny-warnings in cargo's CI should catch it ahead of time. Actually I need to investigate that, I saw a warning locally but CI hasn't failed, I'll see if I can build documentation in |
Diff itself seems fine (r=me), not sure if you wanted some other sign off (e.g., cargo team approval). I don't think that's necessary myself but will leave it up to you. |
(But please do investigate the warning as well). |
Ah, looks like we don't deny warnings for submodules: https://github.com/rust-lang/rust/blob/0a48fa3a8c31cb16290ef17ca6d69ee6718c2289/src/bootstrap/builder.rs#L1647-L1658 So this shouldn't block a submodule update; letting the cargo team decide what warnings they want seems reasonable. We can change it in a follow-up if anyone has strong opinions. @bors r=Mark-Simulacrum |
📌 Commit 0a48fa3a8c31cb16290ef17ca6d69ee6718c2289 has been approved by It is now in the queue for this repository. |
⌛ Testing commit 0a48fa3a8c31cb16290ef17ca6d69ee6718c2289 with merge df9ce1a876b243ffb94c0e3b9562b70c53d4cb07... |
💔 Test failed - checks-actions |
This comment has been minimized.
This comment has been minimized.
The primary motivation is to have the cargo docs show up on https://doc.rust-lang.org/nightly/nightly-rustc/cargo, but as a nice side effect this makes `x doc cargo` work locally.
@bors r=Mark-Simulacrum rollup=iffy (adding new crates to the workspace changes the lockfile a lot) |
☀️ Test successful - checks-actions |
Oh, sorry - @Mark-Simulacrum I just realized you've been missing context this whole time, the cargo team already approved this: https://rust-lang.zulipchat.com/#narrow/stream/246057-t-cargo/topic/cargo-sweep.20and.20.60incremental.60 |
Finished benchmarking commit (daccb3d): comparison URL. Overall result: no relevant changes - no action needed@rustbot label: -perf-regression Instruction countThis benchmark run did not return any relevant results for this metric. Max RSS (memory usage)ResultsThis is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.
CyclesResultsThis is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.
|
Support documenting cargo The primary motivation is to have the cargo docs show up on https://doc.rust-lang.org/nightly/nightly-rustc/cargo, but as a nice side effect this makes `x doc cargo` work locally. cc `@rust-lang/cargo`
The primary motivation is to have the cargo docs show up on https://doc.rust-lang.org/nightly/nightly-rustc/cargo, but as a nice side effect this makes
x doc cargo
work locally.cc @rust-lang/cargo