rustdoc: set cfg(doctest) when collecting doctests#62213
Merged
bors merged 2 commits intorust-lang:masterfrom Jul 7, 2019
Merged
rustdoc: set cfg(doctest) when collecting doctests#62213bors merged 2 commits intorust-lang:masterfrom
bors merged 2 commits intorust-lang:masterfrom
Conversation
QuietMisdreavus
added
the
T-rustdoc
This was referenced Jun 28, 2019
Contributor
Author
|
r? @rust-lang/rustdoc |
Member
|
How long do we intend to keep this as a nightly only feature? |
Collaborator
|
☔ The latest upstream changes (presumably #62226) made this pull request unmergeable. Please resolve the merge conflicts. |
bors
added
the
S-waiting-on-author
Contributor
Author
|
It probably doesn't need to be unstable for long; users of |
QuietMisdreavus
force-pushed
the
cfg-doctest
branch
from
e6d9951 to
488310c
Compare
QuietMisdreavus
added
S-waiting-on-review
Contributor
Author
|
Updated. There was a CI error where the UI test i updated was flaky because the ordering was non-deterministic. I added |
Member
|
Once this is merged, I'll have to send "a few" PRs around. *sigh* Thanks for this anyway! |
Collaborator
|
☔ The latest upstream changes (presumably #61775) made this pull request unmergeable. Please resolve the merge conflicts. |
QuietMisdreavus
force-pushed
the
cfg-doctest
branch
from
589d5b5 to
cff6ce6
Compare
Contributor
Author
|
Force-pushed to resolve merge conflict. |
Member
|
Thanks! @bors: r+ |
Collaborator
|
📌 Commit cff6ce6 has been approved by |
bors
added
S-waiting-on-bors
Centril
added a commit
to Centril/rust
that referenced
this pull request
Jul 7, 2019
…laumeGomez rustdoc: set cfg(doctest) when collecting doctests Note: This PR builds on top of rust-lang#61199; only the last commit is specific to this PR. As discussed in rust-lang#61199, we want the ability to isolate items to only when rustdoc is collecting doctests, but we can't use `cfg(test)` because of libcore's `#![cfg(not(test))]`. This PR proposes a new cfg flag, `cfg(doctest)`, specific to this situation, rather than reusing an existing flag. I've isolated it behind a feature gate so that we can contain the effects to nightly only. (A stable workaround that can be used in lieu of `#[cfg(doctest)]` is `#[cfg(rustdoc)] #[doc(hidden)]`, at least once rust-lang#61351 lands.) Tracking issue: rust-lang#62210
bors
added a commit
that referenced
this pull request
Jul 7, 2019
Rollup of 4 pull requests Successful merges: - #61883 (`non_ascii_idents` lint (part of RFC 2457)) - #62042 (Support stability and deprecation checking for all macros) - #62213 (rustdoc: set cfg(doctest) when collecting doctests) - #62286 (Check if the archive has already been added to avoid duplicates) Failed merges: r? @ghost
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
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.
Note: This PR builds on top of #61199; only the last commit is specific to this PR.
As discussed in #61199, we want the ability to isolate items to only when rustdoc is collecting doctests, but we can't use
cfg(test)because of libcore's#![cfg(not(test))]. This PR proposes a new cfg flag,cfg(doctest), specific to this situation, rather than reusing an existing flag. I've isolated it behind a feature gate so that we can contain the effects to nightly only. (A stable workaround that can be used in lieu of#[cfg(doctest)]is#[cfg(rustdoc)] #[doc(hidden)], at least once #61351 lands.)Tracking issue: #62210