-
Notifications
You must be signed in to change notification settings - Fork 12.8k
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
Add miri to rustc docs.rs page #97773
Conversation
(rust-highfive has picked a reviewer for you, use r? to override) |
I couldn't figure out a way to generate doc.rust-lang.org/nightly/nightly-rustc Logs
, so checks might fail here too |
The pipeline doesn't seem to have failed, but since it failed on my side I don't think the same commands are being ran |
Correct, documentation is only built in bors try builds. You'll need to get x.py doc working locally before this can be merged. Since miri is a submodule, you'll need to either fix the warnings in rust-lang/miri (my preference) or allow the bootstrap warnings for miri in doc.rs. You should be able to replicate the warnings out of tree with |
ah wait, I'm wrong - this will block adding further lints to rustdoc and rustc in the future. You need to instead make the I think |
tool.rs effectively seems to have https://github.com/rust-lang/rust/blob/d2598caadafb0a32c8cee58c6bcb3d80f26ee4cf/src/bootstrap/tool.rs#L767 |
@InfRandomness the I don't understand the rest of your question, sorry. |
did you mean that I need to end up with something similar to :
? |
Yes, exactly :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
@bors r+ rollup=iffy (not tested in PR CI) |
📌 Commit 499ca27c974b2c70db1b3a26d8b5ae8bec4607bb has been approved by |
Actually, @InfRandomness can you confirm that |
logs
ah, seems like it works after having cleaned everything up with |
👍 @bors r- |
This comment has been minimized.
This comment has been minimized.
you can probably reproduce with |
Yes, that's #98107 |
However, this PR shouldn't have to update the submodule. Yes, Miri fails to build on master, but that happens regularly so the documentation generation code here has to be able to handle that situation. |
src/bootstrap/doc.rs
Outdated
@@ -707,7 +713,7 @@ macro_rules! tool_doc { | |||
target, | |||
"doc", | |||
$path, | |||
SourceType::InTree, | |||
source_type, | |||
&[], | |||
); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this command fails for Miri, that failure must be ignored. Miri failing to build is not a bug, it is expected. That's what the entire toolstate stuff is about.
@RalfJung this has to update the submodule to pull in the documentation fix, not so it gets miri building. Oh I see what you're saying though - if miri is broken, the docs will be broken too and we have to be able to handle that. @InfRandomness I think the right way to do that is to change https://github.com/rust-lang/rust/blob/7932f823b0fc912df339e28ca0ffac3a7b145e15/src/bootstrap/doc.rs#L732 to use |
The documentation fix is already in the submodule in rustc master. The submodule update in this PR currently does not contain any doc fixes. |
You mean |
🤷 there are only ~3 tools in tree that use submodules, I don't think it's going to cause problems in practice. |
☔ The latest upstream changes (presumably #98237) made this pull request unmergeable. Please resolve the merge conflicts. |
I don't know how to resolve a conflict with a submodule, |
I'd recommend to first remove the submodule update from this commit, and then rebase it. |
With |
The submodule update is already a separate commit. So just |
and of course I can't rebase because I've got plenty of uncommited changes :
This is really really irritating, |
Looks like you got your checkout into a broken state. I remember seeing some weird behavior with submodule+rebase in the past (git is definitely terrible at handling this), but I have no idea what I did to get out of it again. Probably random bashing against various git commands until it gave in... You also had bad luck; there was some trouble with the cargo and rust-analyzer submodules right around when you tried that (that is probably the reason of that cargo-related error). What you want to do is get back to commit d23264b9df5bd9d10b5553956b9ae523b1125055, somehow. If it is still rebasing, try |
I tried to git checkout the mentioned commit
still kept on going and force pushed |
Ok I've had enough of this git bullcrap I'm scraping all of this with my fork, recreating a new fork and a new PR. |
Nvm I won't even bother opening a new PR this submodule system needs to change, it shouldn't be normal for all of this to happen. |
Ah, one submodule has "modified content". Not sure if you edited it or some script changed a file in there, but I don't know of a good way to tell git to reset all submodule contents, you have to go to each affected submodule and do it by hand. :( I re-submitted this as #98714. |
add Miri to the nightly docs This is a follow-up to rust-lang#97773 and to rust-lang#98714 It adds miri to the doc.rust-lang.org/nightly/nightly-rustc](https://doc.rust-lang.org/nightly/nightly-rustc/
add Miri to the nightly docs This is a follow-up to rust-lang#97773 and to rust-lang#98714 It adds miri to the doc.rust-lang.org/nightly/nightly-rustc](https://doc.rust-lang.org/nightly/nightly-rustc/
This adds miri to https://doc.rust-lang.org/nightly/nightly-rustc/