rustdoc: separate test collection from the main "clean"-ing pipeline. #37890
Conversation
This file contains 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
|
(rust_highfive has picked a reviewer for you, use r? to override) |
|
Huge 👍 ! |
|
r? @nrc cc @rust-lang/tools |
|
Sounds like a good change to me, there's tons of technical debt in rustdoc to be shed at this point |
|
@bors: r+ |
|
📌 Commit 60aa513 has been approved by |
|
⌛ Testing commit 60aa513 with merge 5940fe3... |
|
💔 Test failed - auto-win-msvc-64-cargotest |
|
|
@alexcrichton Should the PR Travis builds include cargotest? |
|
@eddyb yeah once we start gating on travis I'd like to look into PR test coverage |
|
@bors r=nrc |
|
📌 Commit e7264d0 has been approved by |
|
⌛ Testing commit e7264d0 with merge d6d8d70... |
|
💔 Test failed - auto-win-gnu-32-opt-rustbuild |
eddyb
force-pushed
the
rustdoc-1
branch
3 times, most recently
from
084a3c9
to
1c5a529
Compare
|
Travis passed but the OSX builds are broken. @bors r=nrc |
|
📌 Commit 4be7786 has been approved by |
|
⌛ Testing commit 4be7786 with merge 29abe6f... |
bors
added a commit
that referenced
this pull request
Nov 24, 2016
rustdoc: separate test collection from the main "clean"-ing pipeline. While reusing the documentation "clean"-ing infrastructure for collecting code examples to test may have seemed appealing at some point, doing the same through a HIR visitor is barely any harder. At the same time, supporting both "regular documentation" and "test collection" modes in `rustdoc::clean` has its cost, requiring any use of a `TyCtxt` to be speculative, and provide some sort of fallback. This simplification is the first step towards bringing rustdoc closer to the compiler, and perhaps even unifying the "local crate" (based on the HIR AST) and "inlinined across crates" (based on crate metadata and typesystem information) implementations of rustdoc. Sadly, not all possible changes to rustdoc will be uncontroversial, so I'm starting small with this patch.
This was referenced Nov 24, 2016
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
While reusing the documentation "clean"-ing infrastructure for collecting code examples to test may have seemed appealing at some point, doing the same through a HIR visitor is barely any harder.
At the same time, supporting both "regular documentation" and "test collection" modes in
rustdoc::cleanhas its cost, requiring any use of aTyCtxtto be speculative, and provide some sort of fallback.This simplification is the first step towards bringing rustdoc closer to the compiler, and perhaps even unifying the "local crate" (based on the HIR AST) and "inlinined across crates" (based on crate metadata and typesystem information) implementations of rustdoc.
Sadly, not all possible changes to rustdoc will be uncontroversial, so I'm starting small with this patch.