Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add note about the #[doc(no-inline)] usage #82870

Merged
merged 1 commit into from
Mar 9, 2021
Merged

Add note about the #[doc(no-inline)] usage #82870

merged 1 commit into from
Mar 9, 2021

Conversation

jfrimmel
Copy link
Contributor

@jfrimmel jfrimmel commented Mar 7, 2021

This is required to correctly build the documentation (including all submodules, that are only available in certain targets).

See the linked issue and #82861 for reference.

@rust-highfive
Copy link
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Mark-Simulacrum (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.

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 7, 2021
@jfrimmel
Copy link
Contributor Author

jfrimmel commented Mar 7, 2021

Maybe

r? @jyn514

@jfrimmel jfrimmel mentioned this pull request Mar 7, 2021
Closed
jyn514
jyn514 suggested changes Mar 7, 2021
View reviewed changes
Copy link
Member

@jyn514 jyn514 left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This no-inline-attribute is required to make all targets available.

This isn't quite correct - the only target available when compiling is always only the host target. The attribute is required to generate documentation for all targets, because stdarch special cases rustdoc (https://doc.rust-lang.org/nightly/rustdoc/advanced-features.html#cfgdoc-documenting-platform-specific-or-feature-specific-information) but that metadata isn't serialized to disk when stdarch is used as a dependency.

library/std/src/lib.rs Outdated Show resolved Hide resolved
@jfrimmel
Add note about the #[doc(no-inline)] usage
c40ef91 
This is required to correctly build the documentation (including all
submodules, that are only available in certain targets).
@jyn514
Copy link
Member

jyn514 commented Mar 7, 2021

Thanks!

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Mar 7, 2021

📌 Commit c40ef91 has been approved by jyn514

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 7, 2021
@m-ou-se m-ou-se mentioned this pull request Mar 8, 2021
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 9, 2021
@bors
Auto merge of rust-lang#82911 - m-ou-se:rollup-rjomgja, r=m-ou-se
bb3afe1 
Rollup of 11 pull requests

Successful merges:

 - rust-lang#82711 (Add documentation for string->Cow conversions)
 - rust-lang#82767 (Update minifier dependency version)
 - rust-lang#82800 (Move rustdoc UI tests into a subdirectory)
 - rust-lang#82810 (Typo fix in Unstable book: `cargo cov` -> `cargo profdata`)
 - rust-lang#82829 (Handle negative literals in cast overflow warning)
 - rust-lang#82854 (Account for `if (let pat = expr) {}`)
 - rust-lang#82870 (Add note about the `#[doc(no-inline)]` usage)
 - rust-lang#82874 (Add codegen tests for some issues closed by LLVM 12)
 - rust-lang#82881 (diagnostics: Be clear about "crate root" and `::foo` paths in resolve diagnostics)
 - rust-lang#82888 (Grammar Fixes)
 - rust-lang#82897 ([.mailmap] Add entry for Ramkumar Ramachandra)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit a55b192 into rust-lang:master Mar 9, 2021
@rustbot rustbot added this to the 1.52.0 milestone Mar 9, 2021
@jfrimmel jfrimmel deleted the improve-docs branch October 14, 2021 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jyn514 jyn514 jyn514 requested changes

Assignees

@jyn514 jyn514

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
1.52.0
Development

Successfully merging this pull request may close these issues.
6 participants
@jfrimmel @rust-highfive @jyn514 @bors @Mark-Simulacrum @rustbot