compiletest: pass rustdoc mode as param, rather than implicitly #148003
+27
−11
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Spun out of https://www.github.com/rust-lang/rust/pull/142642 In the future, I want the rustdoc-json test suite to invoke rustdoc twice, once with `--output-format=json`, and once with the (not yet implemented) `--output-format=postcard` flag. Doing that requires being able to explicitly tell the `.document()` function which format to use, rather then implicitly using json in the rustdoc-json suite, and HTML in all others.
|
Some changes occurred in src/tools/compiletest cc @jieyouxu |
rustbot
added
A-compiletest
jalil-salame
approved these changes
Oct 23, 2025
| kind: DocKind, | ||
| ) -> ProcRes { | ||
| if self.props.build_aux_docs { | ||
| assert_eq!(kind, DocKind::Html, "build-aux-docs doesn't make sense for rustdoc json"); |
There was a problem hiding this comment.
nit:
Since the plan is to add postcard wouldn't it make sense to invert the statement? build-aux-docs only makes sense for rustdoc HTML, this way the message is still valid after postcard is introduced.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Spun out of #142642
In the future, I want the rustdoc-json test suite to invoke rustdoc twice, once with
--output-format=json, and once with the (not yet implemented)--output-format=postcardflag.Doing that requires being able to explicitly tell the
.document()function which format to use, rather then implicitly using json in the rustdoc-json suite, and HTML in all others.r? @jieyouxu
CC @jalil-salame