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.

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

Add option to include private items in library docs #107264

Merged
merged 2 commits into from
Jan 30, 2023

Conversation

pietroalbini
Copy link
Member

I need to perform some one-off analysis on libcore, and I wanted to use the unstable JSON rustdoc output to easily do it. Unfortunately, there is currently no way to include unstable items in the library docs. This PR adds support for that, with the off-by-default build.library-docs-private-items setting.

@rustbot
Copy link
Collaborator

rustbot commented Jan 24, 2023

r? @Mark-Simulacrum

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Jan 24, 2023
src/bootstrap/doc.rs Outdated Show resolved Hide resolved
@jyn514
Copy link
Member

jyn514 commented Jan 27, 2023

Can't you use RUSTDOCFLAGS=--document-private-items?

@Mark-Simulacrum
Copy link
Member

r=me if you think this is worth it given RUSTDOCFLAGS, either works for me.

@Mark-Simulacrum Mark-Simulacrum added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 29, 2023
@pietroalbini
Copy link
Member Author

Huh forgot about RUSTFLAGS... Still, sometimes I need to often build the standard library with private methods available, and having to pass RUSTFLAGS all the time is annoying.

@bors r=Mark-Simulacrum rollup

@bors
Copy link
Contributor

bors commented Jan 30, 2023

📌 Commit 8f84408 has been approved by Mark-Simulacrum

It is now in the queue for this repository.

@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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jan 30, 2023
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 30, 2023
Rollup of 6 pull requests

Successful merges:

 - rust-lang#101569 (Don't re-export private/unstable ArgumentV1 from `alloc`.)
 - rust-lang#106106 (Pass `branch.{branch}.remote=origin` to `git submodule update`)
 - rust-lang#107146 (Make `unsizing_params_for_adt` into a query)
 - rust-lang#107264 (Add option to include private items in library docs)
 - rust-lang#107452 (Fix typo in `{Rc, Arc}::get_mut_unchecked` docs)
 - rust-lang#107459 (end entry paragraph with a period (.))

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit d94698c into rust-lang:master Jan 30, 2023
@rustbot rustbot added this to the 1.69.0 milestone Jan 30, 2023
@pietroalbini pietroalbini deleted the pa-private-items branch January 31, 2023 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants