Skip to content

Always generate private and hidden items in JSON docs of the stdlib#159188

Merged
rust-bors[bot] merged 2 commits into
rust-lang:mainfrom
Kobzol:rustdoc-json-private
Jul 20, 2026
Merged

Always generate private and hidden items in JSON docs of the stdlib#159188
rust-bors[bot] merged 2 commits into
rust-lang:mainfrom
Kobzol:rustdoc-json-private

Conversation

@Kobzol

@Kobzol Kobzol commented Jul 12, 2026

Copy link
Copy Markdown
Member

View all comments

This data is needed for downstream tools, e.g. cargo-semver-checks, to analyse the whole stdlib.

For the HTML output it is configurable using build.library-docs-private-items, but to avoid adding a separate config for just the JSON format, I think that we can just enable it unconditionally.

An alternative would be to change the flag from a bool to something like

enum StdDocsPrivateItems {
    No,
    Yes,
    Html,
    Json
}

@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 Jul 12, 2026
@rustbot

rustbot commented Jul 12, 2026

Copy link
Copy Markdown
Collaborator

r? @Mark-Simulacrum

rustbot has assigned @Mark-Simulacrum.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

Why was this reviewer chosen?

The reviewer was selected based on:

  • Owners of files modified in this PR: bootstrap
  • bootstrap expanded to 6 candidates
  • Random selection from Mark-Simulacrum, clubby789, jieyouxu

@Mark-Simulacrum

Copy link
Copy Markdown
Member

@bors r+ rollup=iff

Probably has some implications for shipping these on stable/beta channels (though not sure that it's a blocker), but seems reasonable.

@rust-bors

rust-bors Bot commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Invalid command: Invalid rollup mode iff. Possible values are always/iffy/never/maybe. Run @bors help or go to https://bors.rust-lang.org/help to see available commands.

@Mark-Simulacrum

Copy link
Copy Markdown
Member

@bors rollup=iffy r+

@Mark-Simulacrum

Copy link
Copy Markdown
Member

@bors r+ rollup=iffy

@rust-bors

rust-bors Bot commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

📌 Commit d9466af has been approved by Mark-Simulacrum

It is now in the queue for this repository.

@rust-bors rust-bors Bot 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 Jul 18, 2026
jhpratt added a commit to jhpratt/rust that referenced this pull request Jul 19, 2026
…k-Simulacrum

Always generate private and hidden items in JSON docs of the stdlib

This data is needed for downstream tools, e.g. cargo-semver-checks, to analyse the whole stdlib.

For the HTML output it is configurable using `build.library-docs-private-items`, but to avoid adding a separate config for just the JSON format, I think that we can just enable it unconditionally.

An alternative would be to change the flag from a bool to something like
```rust
enum StdDocsPrivateItems {
    No,
    Yes,
    Html,
    Json
}
```
rust-bors Bot pushed a commit that referenced this pull request Jul 19, 2026
Rollup of 3 pull requests

Successful merges:

 - #159188 (Always generate private and hidden items in JSON docs of the stdlib)
 - #158546 (Move `std::io::BufRead` to `alloc::io`)
 - #159372 (Remove SIZE generic param from DisplayBuffer in core::net)
@jhpratt

jhpratt commented Jul 19, 2026

Copy link
Copy Markdown
Member

Looks like we need a drive-by change to fix a trivial lint.

@bors r- #159546 (comment)

warning: this URL is not a hyperlink
   --> library/std_detect/src/detect/os/linux/aarch64.rs:261:9
    |
261 |     /// https://github.com/llvm/llvm-project/blob/main/llvm/lib/Target/AArch64/AArch64.td
    |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
    = note: bare URLs are not automatically turned into clickable links
    = note: `#[warn(rustdoc::bare_urls)]` on by default
help: use an automatic link instead
    |
261 |     /// <https://github.com/llvm/llvm-project/blob/main/llvm/lib/Target/AArch64/AArch64.td>
    |         +                                                                                 +

@rust-bors rust-bors Bot 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-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jul 19, 2026
@rust-bors

rust-bors Bot commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

This pull request was unapproved.

This PR was contained in a rollup (#159546), which was unapproved.

View changes since this unapproval

@Kobzol

Kobzol commented Jul 19, 2026

Copy link
Copy Markdown
Member Author

Oh, that's interesting. Looks like actually documenting private/hidden docs on CI also helps catch bugs in docs!

@rustbot

rustbot commented Jul 19, 2026

Copy link
Copy Markdown
Collaborator

Some changes occurred in std_detect

cc @Amanieu, @folkertdev, @sayantn

@Kobzol

Kobzol commented Jul 19, 2026

Copy link
Copy Markdown
Member Author

@bors try jobs=dist-aarch64-linux

I tried x dist rust-doc-json and it went through. Let's test on CI.

@rust-bors

This comment has been minimized.

rust-bors Bot pushed a commit that referenced this pull request Jul 19, 2026
Always generate private and hidden items in JSON docs of the stdlib


try-job: dist-aarch64-linux
@rust-bors

rust-bors Bot commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

☀️ Try build successful (CI)
Build commit: 7143f4c (7143f4c1acac6ee5ed85b0d897b7ee7a92d7cb3a)
Base parent: c904ba3 (c904ba32e22c9d6fd31140b4283c5cc6c6b2fb5c)

@Kobzol

Kobzol commented Jul 19, 2026

Copy link
Copy Markdown
Member Author

Fixed the CI failure.

@bors r=Mark-Simulacrum rollup=iffy

@rust-bors

rust-bors Bot commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

📌 Commit c84d862 has been approved by Mark-Simulacrum

It is now in the queue for this repository.

@rust-bors rust-bors Bot 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 Jul 19, 2026
@rust-bors rust-bors Bot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jul 19, 2026
@rust-bors

rust-bors Bot commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

💔 Test for e4ac328 failed: CI. Failed job:

@Mark-Simulacrum

Mark-Simulacrum commented Jul 19, 2026

Copy link
Copy Markdown
Member

@bors retry

@bors try jobs=aarch64-msvc-1

I'm hoping that debuginfo-cdb] tests\debuginfo\basic-stepping.rs#opt-level-0 isn't failing due to this PR.

@rust-bors rust-bors Bot 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 Jul 19, 2026
@rust-bors

This comment has been minimized.

rust-bors Bot pushed a commit that referenced this pull request Jul 19, 2026
Always generate private and hidden items in JSON docs of the stdlib


try-job: arch64-msvc-1
@Mark-Simulacrum

This comment was marked as resolved.

@rust-bors

This comment was marked as resolved.

@rust-bors

This comment has been minimized.

rust-bors Bot pushed a commit that referenced this pull request Jul 19, 2026
Always generate private and hidden items in JSON docs of the stdlib


try-job: aarch64-msvc-1
@rust-bors

rust-bors Bot commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

☀️ Try build successful (CI)
Build commit: 81e6674 (81e6674494994e913afc3cea1ca2111a93a7e02e)
Base parent: 234c31c (234c31cd674e11703f15d290cba7ff81dfe8b4b8)

JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Jul 19, 2026
…k-Simulacrum

Always generate private and hidden items in JSON docs of the stdlib

This data is needed for downstream tools, e.g. cargo-semver-checks, to analyse the whole stdlib.

For the HTML output it is configurable using `build.library-docs-private-items`, but to avoid adding a separate config for just the JSON format, I think that we can just enable it unconditionally.

An alternative would be to change the flag from a bool to something like
```rust
enum StdDocsPrivateItems {
    No,
    Yes,
    Html,
    Json
}
```
rust-bors Bot pushed a commit that referenced this pull request Jul 19, 2026
…uwer

Rollup of 6 pull requests

Successful merges:

 - #159188 (Always generate private and hidden items in JSON docs of the stdlib)
 - #159567 (Update rustc crate crossbeam-epoch to 0.9.20)
 - #150732 (Convert `-Ctarget-cpu` into a target-modifier for AVR, AMDGCN and NVPTX )
 - #151793 (Add mul_add_relaxed methods for floating-point types)
 - #159549 (restrict const-eval-related 'content' triggers to library/ folder)
 - #159570 (fix ICE in opsem inhabitedness check)
rust-bors Bot pushed a commit that referenced this pull request Jul 19, 2026
…uwer

Rollup of 5 pull requests

Successful merges:

 - #159188 (Always generate private and hidden items in JSON docs of the stdlib)
 - #159567 (Update rustc crate crossbeam-epoch to 0.9.20)
 - #150732 (Convert `-Ctarget-cpu` into a target-modifier for AVR, AMDGCN and NVPTX )
 - #159549 (restrict const-eval-related 'content' triggers to library/ folder)
 - #159570 (fix ICE in opsem inhabitedness check)
@jhpratt

jhpratt commented Jul 20, 2026

Copy link
Copy Markdown
Member

@bors try dist-x86_64-linux

Making sure this isn't an unexpected cause of #159579

@rust-bors

rust-bors Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Unknown argument "dist-x86_64-linux". Did you mean to use @bors jobs=<jobs>|parent=<parent>? Run @bors help or go to https://bors.rust-lang.org/help to see available commands.

@jhpratt

jhpratt commented Jul 20, 2026

Copy link
Copy Markdown
Member

@bors try jobs=dist-x86_64-linux

@rust-bors

rust-bors Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

⌛ Trying commit c84d862 with merge f33fe6c

To cancel the try build, run the command @bors try cancel.

Workflow: https://github.com/rust-lang/rust/actions/runs/29711723531

rust-bors Bot pushed a commit that referenced this pull request Jul 20, 2026
Always generate private and hidden items in JSON docs of the stdlib


try-job: dist-x86_64-linux
rust-bors Bot pushed a commit that referenced this pull request Jul 20, 2026
…uwer

Rollup of 5 pull requests

Successful merges:

 - #159188 (Always generate private and hidden items in JSON docs of the stdlib)
 - #159567 (Update rustc crate crossbeam-epoch to 0.9.20)
 - #150732 (Convert `-Ctarget-cpu` into a target-modifier for AVR, AMDGCN and NVPTX )
 - #159549 (restrict const-eval-related 'content' triggers to library/ folder)
 - #159570 (fix ICE in opsem inhabitedness check)
rust-timer added a commit that referenced this pull request Jul 20, 2026
Rollup merge of #159188 - Kobzol:rustdoc-json-private, r=Mark-Simulacrum

Always generate private and hidden items in JSON docs of the stdlib

This data is needed for downstream tools, e.g. cargo-semver-checks, to analyse the whole stdlib.

For the HTML output it is configurable using `build.library-docs-private-items`, but to avoid adding a separate config for just the JSON format, I think that we can just enable it unconditionally.

An alternative would be to change the flag from a bool to something like
```rust
enum StdDocsPrivateItems {
    No,
    Yes,
    Html,
    Json
}
```
@rust-bors
rust-bors Bot merged commit 1b823bd into rust-lang:main Jul 20, 2026
13 of 15 checks passed
@rustbot rustbot added this to the 1.99.0 milestone Jul 20, 2026
@Kobzol
Kobzol deleted the rustdoc-json-private branch July 20, 2026 06:30
@jhpratt

jhpratt commented Jul 20, 2026

Copy link
Copy Markdown
Member

Somehow the try job took longer than the actual run?

@bors try cancel

@rust-bors

rust-bors Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Try build cancelled. Cancelled workflows:

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.

5 participants