Replace cfg(dox) with cfg(doc)
#920
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
`dox` has to be set explicitly, but `doc` is set whenever rustdoc runs. This simplifies the doc process to `cargo doc` and means bootstrap can stop passing `--cfg dox` when documenting crates.
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Amanieu (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
jyn514
added a commit
to jyn514/stdarch
that referenced
this pull request
Oct 1, 2020
This was changed from `cfg(dox)` to `cfg(doc)` in rust-lang#920. `cfg(doc)` is incorrect here; rustdoc sets `cfg(doctest)`, not `cfg(doc)` in doc-tests. However, this piece of code isn't needed anyway: this code will only ever be run as a doc-test, so it will never be compiled in.
Amanieu
pushed a commit
that referenced
this pull request
Oct 1, 2020
This was changed from `cfg(dox)` to `cfg(doc)` in #920. `cfg(doc)` is incorrect here; rustdoc sets `cfg(doctest)`, not `cfg(doc)` in doc-tests. However, this piece of code isn't needed anyway: this code will only ever be run as a doc-test, so it will never be compiled in.
jyn514
added a commit
to jyn514/rust
that referenced
this pull request
Oct 1, 2020
The primary purpose is to get the fixes from rust-lang/stdarch#920 and rust-lang/stdarch#922. The other changes included are rust-lang/stdarch#917 and rust-lang/stdarch#919.
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.
doxhas to be set explicitly, butdocis set whenever rustdoc runs.This simplifies the doc process to
cargo docand means bootstrap canstop passing
--cfg doxwhen documenting crates (rust-lang/rust#77347).