Skip to content

Disable docs for compiler-builtins and sysroot #143660

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
Merged
merged 1 commit into from
Jul 10, 2025
Merged

Disable docs for compiler-builtins and sysroot #143660

merged 1 commit into from
Jul 10, 2025

Conversation

cuviper
Copy link
Member

@cuviper cuviper commented Jul 8, 2025 •
edited by clubby789
Loading

Bootstrap already had a manual doc filter for the sysroot crate, but
other library crates keep themselves out of the public docs by setting
[lib] doc = false in their manifest. This seems like a better solution
to hide compiler-builtins docs, and removes the sysroot hack too.

Fixes #143215 (after backport)
@rustbot label beta-nominated

@cuviper cuviper requested a review from tgross35 July 8, 2025 23:43
@cuviper cuviper added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Jul 8, 2025
@rustbot
Copy link
Collaborator

rustbot commented Jul 8, 2025

r? @clubby789

rustbot has assigned @clubby789.
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

@rustbot rustbot added A-compiler-builtins Area: compiler-builtins (https://github.com/rust-lang/compiler-builtins) 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 8, 2025
@rustbot
Copy link
Collaborator

rustbot commented Jul 8, 2025

compiler-builtins is developed in its own repository. If possible, consider making this change to rust-lang/compiler-builtins instead.

cc @tgross35

@rustbot rustbot added the beta-nominated Nominated for backporting to the compiler in the beta channel. label Jul 8, 2025
tgross35
tgross35 reviewed Jul 8, 2025
View reviewed changes
@tgross35 tgross35 assigned tgross35 and unassigned clubby789 Jul 8, 2025
@cuviper
Disable docs for compiler-builtins and sysroot
87e7539 
Bootstrap already had a manual doc filter for the `sysroot` crate, but
other library crates keep themselves out of the public docs by setting
`[lib] doc = false` in their manifest. This seems like a better solution
to hide `compiler-builtins` docs, and removes the `sysroot` hack too.
@cuviper
Copy link
Member Author

cuviper commented Jul 9, 2025

@bors r=tgross35 rollup

@bors
Copy link
Collaborator

bors commented Jul 9, 2025

📌 Commit 87e7539 has been approved by tgross35

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-review Status: Awaiting review from the assignee but also interested parties. labels Jul 9, 2025
@tgross35 tgross35 mentioned this pull request Jul 9, 2025
Merged
jhpratt added a commit to jhpratt/rust that referenced this pull request Jul 9, 2025
@jhpratt
Rollup merge of rust-lang#143660 - cuviper:lib-doc-false, r=tgross35
c29423e 
Disable docs for `compiler-builtins` and `sysroot`

Bootstrap already had a manual doc filter for the `sysroot` crate, but
other library crates keep themselves out of the public docs by setting
`[lib] doc = false` in their manifest. This seems like a better solution
to hide `compiler-builtins` docs, and removes the `sysroot` hack too.

Fixes rust-lang#143215 (after backport)
`@rustbot` label beta-nominated
@jhpratt jhpratt mentioned this pull request Jul 9, 2025
Closed
bors added a commit that referenced this pull request Jul 9, 2025
@bors
Auto merge of #143664 - jhpratt:rollup-u9i9oen, r=jhpratt
17e73a5 
Rollup of 11 pull requests

Successful merges:

 - #143177 (Remove false label when `self` resolve failure does not relate to macro)
 - #143339 (Respect endianness correctly in CheckEnums test suite)
 - #143426 (clippy fix: indentation)
 - #143499 (Don't call `predicates_of` on a dummy obligation cause's body id)
 - #143520 (Fix perf regression caused by tracing)
 - #143532 (More carefully consider span context when suggesting remove `&mut`)
 - #143606 (configure.py: Write last key in each section)
 - #143632 (fix: correct parameter names in LLVMRustBuildMinNum and LLVMRustBuildMaxNum FFI declarations)
 - #143644 (Add triagebot stdarch mention ping)
 - #143651 (Win: Use exceptions with empty data for SEH panic exception copies instead of a new panic)
 - #143660 (Disable docs for `compiler-builtins` and `sysroot`)

r? `@ghost`
`@rustbot` modify labels: rollup
Kobzol added a commit to Kobzol/rust that referenced this pull request Jul 9, 2025
@Kobzol
Rollup merge of rust-lang#143660 - cuviper:lib-doc-false, r=tgross35
9e1872a 
Disable docs for `compiler-builtins` and `sysroot`

Bootstrap already had a manual doc filter for the `sysroot` crate, but
other library crates keep themselves out of the public docs by setting
`[lib] doc = false` in their manifest. This seems like a better solution
to hide `compiler-builtins` docs, and removes the `sysroot` hack too.

Fixes rust-lang#143215 (after backport)
``@rustbot`` label beta-nominated
@Kobzol Kobzol mentioned this pull request Jul 9, 2025
Closed
bors added a commit that referenced this pull request Jul 9, 2025
@bors
Auto merge of #143676 - Kobzol:rollup-njrvwsa, r=Kobzol
265c74d 
Rollup of 6 pull requests

Successful merges:

 - #143398 (tidy: add support for `--extra-checks=auto:` feature)
 - #143446 (use `--dynamic-list` for exporting executable symbols)
 - #143644 (Add triagebot stdarch mention ping)
 - #143660 (Disable docs for `compiler-builtins` and `sysroot`)
 - #143666 (Re-expose nested bodies in rustc_borrowck::consumers)
 - #143668 (Fix VxWorks build errors)

r? `@ghost`
`@rustbot` modify labels: rollup
@matthiaskrgr matthiaskrgr mentioned this pull request Jul 10, 2025
Merged
bors added a commit that referenced this pull request Jul 10, 2025
@bors
Auto merge of #143746 - matthiaskrgr:rollup-yaojj7t, r=matthiaskrgr
2a023bf 
Rollup of 9 pull requests

Successful merges:

 - #143446 (use `--dynamic-list` for exporting executable symbols)
 - #143590 (Fix weird rustdoc output when single and glob reexport conflict on a name)
 - #143599 (emit `.att_syntax` when global/naked asm use that option)
 - #143615 (Fix handling of no_std targets in `doc::Std` step)
 - #143632 (fix: correct parameter names in LLVMRustBuildMinNum and LLVMRustBuildMaxNum FFI declarations)
 - #143640 (Constify `Fn*` traits)
 - #143651 (Win: Use exceptions with empty data for SEH panic exception copies instead of a new panic)
 - #143660 (Disable docs for `compiler-builtins` and `sysroot`)
 - #143665 ([rustdoc-json] Add tests for `#[doc(hidden)]` handling of items.)

r? `@ghost`
`@rustbot` modify labels: rollup
@cuviper
Copy link
Member Author

cuviper commented Jul 10, 2025

The backport was discussed and accepted in the libs meeting: https://hackmd.io/bDIOjPOHTTCoo2ORspynYw

@rustbot label beta-accepted

@rustbot rustbot added the beta-accepted Accepted for backporting to the compiler in the beta channel. label Jul 10, 2025
@bors bors merged commit 6c4502d into rust-lang:master Jul 10, 2025
11 checks passed
@rustbot rustbot added this to the 1.90.0 milestone Jul 10, 2025
rust-timer added a commit that referenced this pull request Jul 10, 2025
@rust-timer
Unrolled build for #143660
5d5340b 
Rollup merge of #143660 - cuviper:lib-doc-false, r=tgross35

Disable docs for `compiler-builtins` and `sysroot`

Bootstrap already had a manual doc filter for the `sysroot` crate, but
other library crates keep themselves out of the public docs by setting
`[lib] doc = false` in their manifest. This seems like a better solution
to hide `compiler-builtins` docs, and removes the `sysroot` hack too.

Fixes #143215 (after backport)
```@rustbot``` label beta-nominated
@cuviper cuviper mentioned this pull request Jul 10, 2025
Merged
@cuviper cuviper modified the milestones: 1.90.0, 1.89.0 Jul 10, 2025
@cuviper cuviper removed the beta-nominated Nominated for backporting to the compiler in the beta channel. label Jul 10, 2025
github-actions bot pushed a commit to rust-lang/rustc-dev-guide that referenced this pull request Jul 11, 2025
@bors
Auto merge of #143746 - matthiaskrgr:rollup-yaojj7t, r=matthiaskrgr
a0d0875 
Rollup of 9 pull requests

Successful merges:

 - rust-lang/rust#143446 (use `--dynamic-list` for exporting executable symbols)
 - rust-lang/rust#143590 (Fix weird rustdoc output when single and glob reexport conflict on a name)
 - rust-lang/rust#143599 (emit `.att_syntax` when global/naked asm use that option)
 - rust-lang/rust#143615 (Fix handling of no_std targets in `doc::Std` step)
 - rust-lang/rust#143632 (fix: correct parameter names in LLVMRustBuildMinNum and LLVMRustBuildMaxNum FFI declarations)
 - rust-lang/rust#143640 (Constify `Fn*` traits)
 - rust-lang/rust#143651 (Win: Use exceptions with empty data for SEH panic exception copies instead of a new panic)
 - rust-lang/rust#143660 (Disable docs for `compiler-builtins` and `sysroot`)
 - rust-lang/rust#143665 ([rustdoc-json] Add tests for `#[doc(hidden)]` handling of items.)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit that referenced this pull request Jul 11, 2025
@bors
Auto merge of #143757 - cuviper:beta-next, r=cuviper
b123710 
[beta] backports

- Beta backport: null terminate UNICODE_STRINGs #143275
- Fix hang in --print=file-names in bootstrap #142928
- Reduce mismatched-lifetime-syntaxes suggestions to MaybeIncorrect #142980
- Update LLVM submodule #143126
- Do not unify borrowed locals in CopyProp. #143509
- Disable docs for `compiler-builtins` and `sysroot` #143660
- Update version placeholders in stdarch rust-lang/stdarch#1840

r? cuviper
github-actions bot pushed a commit to model-checking/verify-rust-std that referenced this pull request Jul 12, 2025
@matthiaskrgr
Rollup merge of rust-lang#143660 - cuviper:lib-doc-false, r=tgross35
1dc1e2d 
Disable docs for `compiler-builtins` and `sysroot`

Bootstrap already had a manual doc filter for the `sysroot` crate, but
other library crates keep themselves out of the public docs by setting
`[lib] doc = false` in their manifest. This seems like a better solution
to hide `compiler-builtins` docs, and removes the `sysroot` hack too.

Fixes rust-lang#143215 (after backport)
```@rustbot``` label beta-nominated
github-actions bot pushed a commit to rust-lang/compiler-builtins that referenced this pull request Jul 12, 2025
@bors
Auto merge of #143746 - matthiaskrgr:rollup-yaojj7t, r=matthiaskrgr
26f9d12 
Rollup of 9 pull requests

Successful merges:

 - rust-lang/rust#143446 (use `--dynamic-list` for exporting executable symbols)
 - rust-lang/rust#143590 (Fix weird rustdoc output when single and glob reexport conflict on a name)
 - rust-lang/rust#143599 (emit `.att_syntax` when global/naked asm use that option)
 - rust-lang/rust#143615 (Fix handling of no_std targets in `doc::Std` step)
 - rust-lang/rust#143632 (fix: correct parameter names in LLVMRustBuildMinNum and LLVMRustBuildMaxNum FFI declarations)
 - rust-lang/rust#143640 (Constify `Fn*` traits)
 - rust-lang/rust#143651 (Win: Use exceptions with empty data for SEH panic exception copies instead of a new panic)
 - rust-lang/rust#143660 (Disable docs for `compiler-builtins` and `sysroot`)
 - rust-lang/rust#143665 ([rustdoc-json] Add tests for `#[doc(hidden)]` handling of items.)

r? `@ghost`
`@rustbot` modify labels: rollup
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tgross35 tgross35 tgross35 left review comments

Assignees

@tgross35 tgross35

Labels
A-compiler-builtins Area: compiler-builtins (https://github.com/rust-lang/compiler-builtins) beta-accepted Accepted for backporting to the compiler in the beta channel. 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) T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.89.0
Development

Successfully merging this pull request may close these issues.

presence of compiler_builtins in the std doc crate sidebar on beta
5 participants
@cuviper @rustbot @bors @tgross35 @clubby789