Allow cross-compiling doctests #60387
Merged
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
Goirad
changed the title
|
The job Click to expand the log.I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
jethrogb
reviewed
Apr 29, 2019
|
r? @kennytm |
|
The job Click to expand the log.I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
|
The job Click to expand the log.I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
kennytm
added
the
S-waiting-on-author
|
The job Click to expand the log.I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
|
Awaiting review, all checks pass now. |
|
|
|
☔ The latest upstream changes (presumably #61027) made this pull request unmergeable. Please resolve the merge conflicts. |
Goirad
changed the title
|
The job Click to expand the log.I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
|
@kennytm I have restricted the scope of this PR to only adding runtool functionality to rustdoc, along with Cargo in the other PR. |
kennytm
reviewed
Jun 6, 2019
|
Yes ignore is still a part of this PR, since being able to ignore on a per-target basis is relevant to using the crosscompilation feature. |
|
🤔 It's better to delegate the review to @rust-lang/rustdoc then, as it is changing the behavior of |
|
Sorry, how would that behavior change? |
|
@Goirad yeah that's what the "insta-stable" comment in #60387 (comment) is about. |
kennytm
removed
the
S-waiting-on-author
JohnCSimon
added
S-waiting-on-author
|
ping from triage -
|
|
☔ The latest upstream changes (presumably #62855) made this pull request unmergeable. Please resolve the merge conflicts. |
|
Just to be sure: shouldn't it be done over #63827 considering they'll make doctests run outside of rustdoc? |
|
This PR has been open for months, if @ollie27 is not available for review, can the docs team appoint a different reviewer? |
|
Sorry for the delay. As far as I'm concerned this feature and code looks good so r=me with a rebase. This could do with some tests like We also need tracking issues for the new features. |
updated and augmented tests in html/markdown.rs
…e at argument parsing time if no --target arguments
Goirad
force-pushed
the
test-expansion
branch
from
ed7e510
to
4a2094c
Compare
|
Thanks, lets get this in. @bors r+ |
|
📌 Commit 4a2094c has been approved by |
bors
added
S-waiting-on-bors
bors
added a commit
that referenced
this pull request
Sep 10, 2019
Allow cross-compiling doctests This PR allows doctest to receive a --runtool argument, as well as possibly many --runtool-arg arguments, which are then used to run cross compiled doctests. Also, functionality has been added to rustdoc to allow it to skip testing doctests on a per-target basis, in the same way that compiletest does it. For example, tagging the doctest with "ignore-sgx" disables testing on any targets that contain "sgx". A plain "ignore" still skips testing on all targets. See [here](rust-lang/cargo#6892) for the companion PR in the cargo project that extends functionality in Cargo so that it passes the appropriate parameters to rustdoc when cross compiling and testing doctests. Part of [#6460](rust-lang/cargo#6460)
|
☀️ Test successful - checks-azure |
bors
added a commit
to rust-lang/cargo
that referenced
this pull request
Sep 18, 2019
Added ability to crosscompile doctests This commit adds the ability to cross-compile and run doctests. Like before cargo checks if target == host, the difference is that if there is a runtool defined in config.toml, it passes the information forward to rustdoc so that it can run the doctests with that tool. If no tool is defined and the target != host, cargo instead displays a message that doctests will not be compiled because of the missing runtool. See [here](rust-lang/rust#60387) for the companion PR in the rust project that modifies rustdoc to accept the relevant options as well as allow ignoring doctests on a per target level. Partially resolves [#6460](#6460) See [here](#7040) for the tracking issue.
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.
This PR allows doctest to receive a --runtool argument, as well as possibly many --runtool-arg arguments, which are then used to run cross compiled doctests.
Also, functionality has been added to rustdoc to allow it to skip testing doctests on a per-target basis, in the same way that compiletest does it. For example, tagging the doctest with "ignore-sgx" disables testing on any targets that contain "sgx". A plain "ignore" still skips testing on all targets.
See here for the companion PR in the cargo project that extends functionality in Cargo so that it passes the appropriate parameters to rustdoc when cross compiling and testing doctests.
Part of #6460