Skip to content
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

Merged
merged 1 commit into from Dec 23, 2022
Merged

Support documenting cargo #105036

merged 1 commit into from Dec 23, 2022

Conversation

jyn514
Copy link
Member

@jyn514 jyn514 commented Nov 28, 2022

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

@rustbot
Copy link
Collaborator

rustbot commented Nov 28, 2022

r? @Mark-Simulacrum

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 28, 2022
@weihanglo
Copy link
Member

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 -D warnings.

@jyn514
Copy link
Member Author

jyn514 commented Nov 29, 2022

@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 x86_64-gnu-tools instead of waiting for a full bors merge.

@Mark-Simulacrum
Copy link
Member

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.

@Mark-Simulacrum Mark-Simulacrum added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 5, 2022
@Mark-Simulacrum
Copy link
Member

(But please do investigate the warning as well).

@jyn514
Copy link
Member Author

jyn514 commented Dec 17, 2022

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

@bors
Copy link
Contributor

bors commented Dec 17, 2022

📌 Commit 0a48fa3a8c31cb16290ef17ca6d69ee6718c2289 has been approved by Mark-Simulacrum

It is now in the queue for this repository.

@bors 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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Dec 17, 2022
@bors
Copy link
Contributor

bors commented Dec 19, 2022

⌛ Testing commit 0a48fa3a8c31cb16290ef17ca6d69ee6718c2289 with merge df9ce1a876b243ffb94c0e3b9562b70c53d4cb07...

@bors
Copy link
Contributor

bors commented Dec 19, 2022

💔 Test failed - checks-actions

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

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.
@jyn514
Copy link
Member Author

jyn514 commented Dec 22, 2022

@bors r=Mark-Simulacrum rollup=iffy (adding new crates to the workspace changes the lockfile a lot)

@bors
Copy link
Contributor

bors commented Dec 22, 2022

📌 Commit f94c926 has been approved by Mark-Simulacrum

It is now in the queue for this repository.

@bors 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 22, 2022
@bors
Copy link
Contributor

bors commented Dec 23, 2022

⌛ Testing commit f94c926 with merge daccb3d...

@bors
Copy link
Contributor

bors commented Dec 23, 2022

☀️ Test successful - checks-actions
Approved by: Mark-Simulacrum
Pushing daccb3d to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Dec 23, 2022
@bors bors merged commit daccb3d into rust-lang:master Dec 23, 2022
@rustbot rustbot added this to the 1.68.0 milestone Dec 23, 2022
@jyn514 jyn514 deleted the cargo-docs branch December 23, 2022 02:49
@jyn514
Copy link
Member Author

jyn514 commented Dec 23, 2022

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.

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

@rust-timer
Copy link
Collaborator

Finished benchmarking commit (daccb3d): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results

This 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.

mean range count
Regressions ❌
(primary)
- - 0
Regressions ❌
(secondary)
- - 0
Improvements ✅
(primary)
-2.4% [-2.4%, -2.4%] 1
Improvements ✅
(secondary)
- - 0
All ❌✅ (primary) -2.4% [-2.4%, -2.4%] 1

Cycles

Results

This 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.

mean range count
Regressions ❌
(primary)
- - 0
Regressions ❌
(secondary)
2.3% [2.3%, 2.3%] 1
Improvements ✅
(primary)
- - 0
Improvements ✅
(secondary)
-2.5% [-2.5%, -2.5%] 1
All ❌✅ (primary) - - 0

Aaron1011 pushed a commit to Aaron1011/rust that referenced this pull request Jan 6, 2023
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`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merged-by-bors This PR was explicitly merged by bors. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants