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.

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

Host compiler documentation: Include private items #49654

Merged
merged 2 commits into from Apr 5, 2018

Conversation

Projects
None yet
4 participants
@davidtwco
Member

davidtwco commented Apr 4, 2018

Fixes #29893. Now that compiler documentation is being hosted, including private items seems sensible as these types are going to be being used by contributors working on the compiler.

However, including this means that doc comments that contain codeblocks with invalid Rust and can fail the documenting of a given crate (as evidenced by the changes in the second commit included in this PR). We'd need some way of ensuring that this cannot happen so that these failures don't cause documenting to fail. I'm unsure whether this change to documentation steps will cause this to happen already or if something new will be required.

r? @alexcrichton

davidtwco added some commits Apr 4, 2018

@alexcrichton

This comment has been minimized.

Member

alexcrichton commented Apr 4, 2018

@bors: r+

@bors

This comment has been minimized.

Contributor

bors commented Apr 4, 2018

📌 Commit 809d01c has been approved by alexcrichton

kennytm added a commit to kennytm/rust that referenced this pull request Apr 5, 2018

Rollup merge of rust-lang#49654 - davidtwco:issue-29893, r=alexcrichton
Host compiler documentation: Include private items

Fixes rust-lang#29893. Now that compiler documentation is being hosted, including private items seems sensible as these types are going to be being used by contributors working on the compiler.

However, including this means that doc comments that contain codeblocks with invalid Rust and can fail the documenting of a given crate (as evidenced by the changes in the second commit included in this PR). We'd need some way of ensuring that this cannot happen so that these failures don't cause documenting to fail. I'm unsure whether this change to documentation steps will cause this to happen already or if something new will be required.

r? @alexcrichton

@kennytm kennytm referenced this pull request Apr 5, 2018

Merged

Rollup of 9 pull requests #49684

bors added a commit that referenced this pull request Apr 5, 2018

Auto merge of #49684 - kennytm:rollup, r=kennytm
Rollup of 9 pull requests

Successful merges:

 - #48658 (Add a generic CAS loop to std::sync::Atomic*)
 - #49253 (Take the original extra-filename passed to a crate into account when resolving it as a dependency)
 - #49345 (RFC 2008: Finishing Touches)
 - #49432 (Flush executables to disk after linkage)
 - #49496 (Add more vec![... ; n] optimizations)
 - #49503 (Inject the `compiler_builtins` crate whenever the `core` crate is injected)
 - #49563 (add a dist builder to build rust-std components for the THUMB targets)
 - #49654 (Host compiler documentation: Include private items)
 - #49667 (Add more features to rust_2018_preview)

Failed merges:

kennytm added a commit to kennytm/rust that referenced this pull request Apr 5, 2018

Rollup merge of rust-lang#49654 - davidtwco:issue-29893, r=alexcrichton
Host compiler documentation: Include private items

Fixes rust-lang#29893. Now that compiler documentation is being hosted, including private items seems sensible as these types are going to be being used by contributors working on the compiler.

However, including this means that doc comments that contain codeblocks with invalid Rust and can fail the documenting of a given crate (as evidenced by the changes in the second commit included in this PR). We'd need some way of ensuring that this cannot happen so that these failures don't cause documenting to fail. I'm unsure whether this change to documentation steps will cause this to happen already or if something new will be required.

r? @alexcrichton

bors added a commit that referenced this pull request Apr 5, 2018

Auto merge of #49684 - kennytm:rollup, r=kennytm
Rollup of 9 pull requests

Successful merges:

 - #48658 (Add a generic CAS loop to std::sync::Atomic*)
 - #49253 (Take the original extra-filename passed to a crate into account when resolving it as a dependency)
 - #49345 (RFC 2008: Finishing Touches)
 - #49432 (Flush executables to disk after linkage)
 - #49496 (Add more vec![... ; n] optimizations)
 - #49563 (add a dist builder to build rust-std components for the THUMB targets)
 - #49654 (Host compiler documentation: Include private items)
 - #49667 (Add more features to rust_2018_preview)
 - #49674 (ci: Remove x86_64-gnu-incremental builder)

Failed merges:

@bors bors merged commit 809d01c into rust-lang:master Apr 5, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@davidtwco davidtwco deleted the davidtwco:issue-29893 branch Apr 5, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment