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

Htmldocck: Substitute the doc channel when blessing #99766

Merged
merged 1 commit into from
Jul 29, 2022

Conversation

fmease
Copy link
Member

@fmease fmease commented Jul 26, 2022

Since #84942, the snippet {{channel}} gets substituted with the concrete “doc channel” (e.g. https://doc.rust-lang.org/nightly) when snapshot files are checked against the actual rustdoc output.

However, when you --bless rustdoc tests, htmldocck just dumps the concrete channel into the snapshot file and
you have to manually do a find-and-replace after blessing to uphold what #84942 set out to fix.

I admit it's a bit fragile to blindly replace URLs like this but I guess it's not too bad in practice.
Feel free to close this PR if you don't think that this is a good idea.

@rustbot label T-rustdoc A-testsuite

@rustbot rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jul 26, 2022
@rust-highfive
Copy link
Collaborator

r? @Mark-Simulacrum

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

@rustbot rustbot added the A-testsuite Area: The testsuite used to check the correctness of rustc label Jul 26, 2022
@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 26, 2022
@Mark-Simulacrum
Copy link
Member

I think this matches what compiletest does with normalization, so it seems OK to me. If we run into trouble we should definitely improve this check, though, rather than manually fixing things -- thank you for filing the PR!

@bors r+

@bors
Copy link
Contributor

bors commented Jul 28, 2022

📌 Commit d411a08 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 Jul 28, 2022
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 29, 2022
Rollup of 8 pull requests

Successful merges:

 - rust-lang#99686 (add suggestion when there is a impl of external trait on pointer with wrong coherence rules)
 - rust-lang#99760 (doc/rustc: describe the uefi target platforms)
 - rust-lang#99766 (Htmldocck: Substitute the doc channel when blessing)
 - rust-lang#99781 (Use String::from_utf8_lossy in CStr demo)
 - rust-lang#99803 (Update mentions to `rustc_metadata::rmeta::Lazy`)
 - rust-lang#99845 (Remove `$` prefix for bash scripts in doc)
 - rust-lang#99850 (rustdoc: Remove more Clean trait implementations)
 - rust-lang#99872 (Clone the `src/llvm-project` submodule if profiling is enabled)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 55296c4 into rust-lang:master Jul 29, 2022
@rustbot rustbot added this to the 1.64.0 milestone Jul 29, 2022
@fmease fmease deleted the htmldocck-subst-channel-when-blessing branch July 29, 2022 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-testsuite Area: The testsuite used to check the correctness of rustc S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants