Skip to content

Commit

Permalink
Rollup merge of rust-lang#99766 - fmease:htmldocck-subst-channel-when…
Browse files Browse the repository at this point in the history
…-blessing, r=Mark-Simulacrum

Htmldocck: Substitute the doc channel when blessing

Since rust-lang#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 rust-lang#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
  • Loading branch information
JohnTitor authored Jul 29, 2022
2 parents b7beec9 + d411a08 commit 55296c4
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions src/etc/htmldocck.py
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,7 @@ def check_snapshot(snapshot_name, actual_tree, normalize_to_text):

if bless:
with open(snapshot_path, 'w') as snapshot_file:
actual_str = actual_str.replace(channel, "{{channel}}")
snapshot_file.write(actual_str)
else:
print('--- expected ---\n')
Expand Down

0 comments on commit 55296c4

Please sign in to comment.