-
Notifications
You must be signed in to change notification settings - Fork 12.7k
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
Ensure that ./x.py doc --stage 0 src/libstd
works via CI
#71649
Conversation
(rust_highfive has picked a reviewer for you, use r? to override) |
cc @rust-lang/rustdoc |
To be clear from a "implementation" perspective this looks good to me, but I agree it would be good to get rustdoc sign off as the team that's closest to docs today... basically, I think this means "new shiny features" would be less easy to use in std's docs, unless they're e.g. top-level attributes that can easily be cfg'd away. |
I'm going to go ahead and approve this, but if we run into trouble due to it and there's no nice fixes I would be open to reverting. @bors r+ |
📌 Commit 1f7c896 has been approved by |
⌛ Testing commit 1f7c896 with merge d88c74853164295717ffef1f8dc80efc39a63788... |
💔 Test failed - checks-azure |
Seemingly unrelated failure upon invoking the linker on MacOS: |
Perhaps a race condition? Doesn't seem like it should/can be related to this PR though so let's @bors try macOS linkers in general are pretty questionable so I wouldn't put it past this being spurious as well |
⌛ Trying commit 1f7c896 with merge 5d3f35f32f98377da91122864f55ad3a2607d09f... |
☀️ Try build successful - checks-azure |
What I meant was @bors retry |
⌛ Trying commit 1f7c896 with merge 95d1050f4d7ae3b8fca4736c31b7afb598ca3032... |
@bors retry- r+ |
@bors try- |
For some reason, the "try" build is still pending in the queue but is no longer marked as a "try" build after I did |
@bors r- retry |
@bors r+ Okay, I think this should do the trick... |
📌 Commit 1f7c896 has been approved by |
Will this help ensure that |
Hm, yes, it should help I think -- may not be a 100% fix for that command though as internally the plumbing of arguments is a little different between doc and test IIRC |
☀️ Test successful - checks-actions, checks-azure |
This was split off from #71645, which recommends that users first try building
libstd
docs with the bootstraprustdoc
. This should work in most cases, but will fail if we start using a very recentrustdoc
feature outside a#[cfg(not(bootstrap))]
.It would be very nice to guarantee that
./x.py doc --stage 0 src/libstd
works, since it allows documentation changes to be rendered locally without needing to build the compiler. However, it may put too big a burden onrustdoc
developers who presumably want to dogfood new features.