rustdoc: Correctly handle reexports when --document-private-items is used by GuillaumeGomez · Pull Request #161362 · rust-lang/rust

GuillaumeGomez · 2026-08-19T15:24:54Z

This PR makes the (private) reexport work like the public ones when the --document-private-items option is used. I still differentiate between imports (use) and reexports (pub(...) use) in this PR as I don't think we should display imports.

r? @Urgau

GuillaumeGomez · 2026-08-19T15:26:32Z

 //@ hasraw - "Mod1Public"
-//@ !hasraw - "Mod1Private"
-//@ !hasraw - "mod2"
+//@ hasraw - "Mod1Private"


Fun fact: this test was added in 2016 in #37773. :)

View changes since the review

Urgau · 2026-08-19T16:39:31Z

I was wondering if this was a breaking change, but our documentation clearly states:

--document-private-items includes all non-public items in the generated documentation except for #[doc(hidden)] items.

as such, this seems clearly like a bug fix.

GuillaumeGomez · 2026-10-23T12:11:38Z

So now, all use in the crate module are visible.

GuillaumeGomez · 2026-10-23T12:11:58Z

@rustbot ready

GuillaumeGomez · 2026-10-24T15:58:32Z

Applied suggestions.

Urgau

LGTM, r=me with the comment fixed

View changes since this review

Urgau · 2026-10-24T18:53:37Z

+        // we're documenting private item. If we are, then we want all items, except if it's a
+        // `use`. In this case, we want to check if it's a reexport. To do so, we check if there is
+        // a `pub(...)` part with its `vis_span` field.


This comment needs updating, it still talks about checking vis_span.

Ah indeed, removing that part.

@Urgau

…private, r=Urgau rustdoc: Correctly handle reexports when --document-private-items is used Fixes rust-lang#159109. This PR makes the (private) reexport work like the public ones when the `--document-private-items` option is used. I still differentiate between imports (`use`) and reexports (`pub(...) use`) in this PR as I don't think we should display imports. r? @Urgau

jhpratt · 2026-10-25T02:06:06Z

@bors yield to rollup

rust-bors · 2026-10-25T02:06:10Z

Auto build was cancelled. Cancelled workflows:

https://github.com/rust-lang/rust/actions/runs/40151739065

The next pull request likely to be tested is #164882.

Rollup of 11 pull requests Successful merges: - #161362 ( rustdoc: Correctly handle reexports when --document-private-items is used) - #162808 (Enable `--generate-link-to-definition` rustdoc option on std docs) - #164834 (miri subtree update) - #164869 (rustc_codegen_gcc subtree update) - #157123 (library: optimize truncate method) - #159916 (Optimize `str.escape_default().to_string()`) - #164508 (ping me for layout invariant changes) - #164758 (Update dependency jinja2 to v3.1.6 [SECURITY]) - #164857 (Do not checkout Cargo for bootstrap tests) - #164872 (cg_llvm: clarify Send / Sync story for modules) - #164881 (Add FIXME comments to `from_ascii_bytes_radix_impl`)

rust-bors · 2026-10-25T02:52:38Z

⌛ Testing commit f87a2da with merge d652736...

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

@Urgau

…Urgau rustdoc: Correctly handle reexports when --document-private-items is used Fixes #159109. This PR makes the (private) reexport work like the public ones when the `--document-private-items` option is used. I still differentiate between imports (`use`) and reexports (`pub(...) use`) in this PR as I don't think we should display imports. r? @Urgau

jieyouxu · 2026-10-25T03:39:18Z

I think this failed in rollup: #164882 (comment)

@bors r-
@bors try jobs=dist-aarch64-msvc

rust-bors · 2026-10-25T03:39:26Z

This pull request was unapproved.

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

Auto build was cancelled due to unapproval. Cancelled workflows:

https://github.com/rust-lang/rust/actions/runs/40156114629

View changes since this unapproval

…<try> rustdoc: Correctly handle reexports when --document-private-items is used try-job: dist-aarch64-msvc

rust-bors · 2026-10-25T05:29:52Z

☀️ Try build successful (CI)
Build commit: a830b7d (a830b7d8ee6c3924e46b32f80504e09ff5b0bac9)
Base parent: dc44e7f (dc44e7f2c436b6041742e138b9c2176f093196d5)

jieyouxu · 2026-10-25T05:43:36Z

Huh, nevermind...
@bors r=Urgau

rust-bors · 2026-10-25T05:43:40Z

📌 Commit f87a2da has been approved by Urgau

It is now in the queue for this repository.

@Urgau

…private, r=Urgau rustdoc: Correctly handle reexports when --document-private-items is used Fixes rust-lang#159109. This PR makes the (private) reexport work like the public ones when the `--document-private-items` option is used. I still differentiate between imports (`use`) and reexports (`pub(...) use`) in this PR as I don't think we should display imports. r? @Urgau

…uwer Rollup of 12 pull requests Successful merges: - #161362 ( rustdoc: Correctly handle reexports when --document-private-items is used) - #164764 (Test(lib/sync): Fix `test_rwlock_max_readers` for 32bit architectures) - #164869 (rustc_codegen_gcc subtree update) - #157123 (library: optimize truncate method) - #159916 (Optimize `str.escape_default().to_string()`) - #164508 (ping me for layout invariant changes) - #164758 (Update dependency jinja2 to v3.1.6 [SECURITY]) - #164836 (Add regression test for #162109) - #164857 (Do not checkout Cargo for bootstrap tests) - #164868 (Fix skipping library build with `--keep-stage[-std]`) - #164872 (cg_llvm: clarify Send / Sync story for modules) - #164881 (Add FIXME comments to `from_ascii_bytes_radix_impl`)

…uwer Rollup of 20 pull requests Successful merges: - #160404 (fd-views: AsRef<File>&Co. for BorrowedFd) - #161362 ( rustdoc: Correctly handle reexports when --document-private-items is used) - #163769 (reborrow: Fix various ICEs related to auto reborrowing of user-space types) - #164764 (Test(lib/sync): Fix `test_rwlock_max_readers` for 32bit architectures) - #164860 (std::fs: read interrupted by a signal, read_buf_exact_at reports EOF.) - #164869 (rustc_codegen_gcc subtree update) - #157123 (library: optimize truncate method) - #159916 (Optimize `str.escape_default().to_string()`) - #163510 (process: Improve the output of `Debug` for `ExitStatus` on Unix) - #164508 (ping me for layout invariant changes) - #164758 (Update dependency jinja2 to v3.1.6 [SECURITY]) - #164816 (Take the colon span into account for struct field initializers) - #164836 (Add regression test for #162109) - #164846 (Remove contradictory inequalities from overflow safety docs) - #164857 (Do not checkout Cargo for bootstrap tests) - #164868 (Fix skipping library build with `--keep-stage[-std]`) - #164872 (cg_llvm: clarify Send / Sync story for modules) - #164880 (Add context span showing item that can't be annotated) - #164881 (Add FIXME comments to `from_ascii_bytes_radix_impl`) - #164884 (Windows: bounds-check the reparse point name in `read_link`)

@Urgau

Rollup merge of #161362 - GuillaumeGomez:reexports-document-private, r=Urgau rustdoc: Correctly handle reexports when --document-private-items is used Fixes #159109. This PR makes the (private) reexport work like the public ones when the `--document-private-items` option is used. I still differentiate between imports (`use`) and reexports (`pub(...) use`) in this PR as I don't think we should display imports. r? @Urgau

rust-timer · 2026-10-25T22:31:14Z

Note

This PR was benchmarked as part of triage of its containing rollup: triage URL.

Finished benchmarking commit (2c386ff): comparison URL.

Overall result: ❌ regressions - please read:

Our benchmarks found a performance regression caused by this PR.
This might be an actual regression, but it can also be just noise.

Next Steps:

If the regression was expected or you think it can be justified,
please write a comment with sufficient written justification, and add
@rustbot label: +perf-regression-triaged to it, to mark the regression as triaged.
If you think that you know of a way to resolve the regression, try to create
a new PR with a fix for the regression.
If you do not understand the regression or you think that it is just noise,
you can ask the @rust-lang/wg-compiler-performance working group for help (members of this group
were already notified of this PR).

@rustbot label: +perf-regression
cc @rust-lang/wg-compiler-performance

Instruction count

Our most reliable metric. Used to determine the overall result above. However, even this metric can be noisy.

	mean	range	count
Regressions ❌ (primary)	0.9%	[0.1%, 7.9%]	19
Regressions ❌ (secondary)	27.3%	[0.1%, 189.6%]	8
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	0.9%	[0.1%, 7.9%]	19

Max RSS (memory usage)

Results (primary 0.7%, secondary 29.6%)

A less reliable metric. May be of interest, but not used to determine the overall result above.

	mean	range	count
Regressions ❌ (primary)	1.3%	[0.5%, 4.8%]	9
Regressions ❌ (secondary)	29.6%	[20.3%, 38.9%]	2
Improvements ✅ (primary)	-1.1%	[-1.5%, -0.5%]	3
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	0.7%	[-1.5%, 4.8%]	12

Cycles

Results (primary 0.9%, secondary 63.7%)

A less reliable metric. May be of interest, but not used to determine the overall result above.

	mean	range	count
Regressions ❌ (primary)	1.2%	[0.4%, 4.9%]	11
Regressions ❌ (secondary)	63.7%	[2.3%, 161.8%]	3
Improvements ✅ (primary)	-0.7%	[-0.8%, -0.6%]	2
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	0.9%	[-0.8%, 4.9%]	13

Binary size

This perf run didn't have relevant results for this metric.

Artifact size: 405.87 MiB -> 405.94 MiB (0.02%)

rustbot assigned Urgau Aug 19, 2026

GuillaumeGomez commented Aug 19, 2026

View reviewed changes

GuillaumeGomez mentioned this pull request Aug 19, 2026

--document-private-items does not document private reexports #159109

Closed

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the reexports-document-private branch from bdb8873 to 9baaae5 Compare August 19, 2026 16:10

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the reexports-document-private branch from 9baaae5 to 7d595c2 Compare August 19, 2026 16:23

Urgau reviewed Aug 19, 2026

View reviewed changes

Comment thread src/librustdoc/visit_ast.rs Outdated

This comment was marked as resolved.

Sign in to view

GuillaumeGomez force-pushed the reexports-document-private branch from 7d595c2 to 819238e Compare October 23, 2026 10:42

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 23, 2026

GuillaumeGomez force-pushed the reexports-document-private branch from 819238e to 5862ffc Compare October 24, 2026 15:58

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the reexports-document-private branch 2 times, most recently from 8844d76 to 59f6fd9 Compare October 24, 2026 17:51

Urgau approved these changes Oct 24, 2026

View reviewed changes

jhpratt mentioned this pull request Oct 25, 2026

Rollup of 11 pull requests #164882

Closed

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 Oct 25, 2026

rust-bors Bot pushed a commit that referenced this pull request Oct 25, 2026

Auto merge of #161362 - GuillaumeGomez:reexports-document-private, r=…

a830b7d

…<try> rustdoc: Correctly handle reexports when --document-private-items is used try-job: dist-aarch64-msvc

This comment has been minimized.

Sign in to view

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 Oct 25, 2026

JonathanBrouwer mentioned this pull request Oct 25, 2026

Rollup of 12 pull requests #164886

Closed

JonathanBrouwer mentioned this pull request Oct 25, 2026

Rollup of 20 pull requests #164894

Merged

rust-bors Bot merged commit 86e7417 into rust-lang:main Oct 25, 2026
15 of 16 checks passed

rustbot added this to the 1.101.0 milestone Oct 25, 2026

GuillaumeGomez deleted the reexports-document-private branch October 25, 2026 21:11

rustbot added the perf-regression Performance regression. label Oct 25, 2026

Conversation

GuillaumeGomez commented Aug 19, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GuillaumeGomez Aug 19, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

Uh oh!

Urgau commented Aug 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as resolved.

GuillaumeGomez commented Oct 23, 2026

Uh oh!

GuillaumeGomez commented Oct 23, 2026

Uh oh!

GuillaumeGomez commented Oct 24, 2026

Uh oh!

This comment has been minimized.

Urgau left a comment • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Urgau Oct 24, 2026

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Oct 24, 2026

Choose a reason for hiding this comment

Uh oh!

jhpratt commented Oct 25, 2026

Uh oh!

rust-bors Bot commented Oct 25, 2026

Uh oh!

rust-bors Bot commented Oct 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jieyouxu commented Oct 25, 2026

Uh oh!

rust-bors Bot commented Oct 25, 2026

Uh oh!

This comment has been minimized.

rust-bors Bot commented Oct 25, 2026

Uh oh!

jieyouxu commented Oct 25, 2026

Uh oh!

rust-bors Bot commented Oct 25, 2026

Uh oh!

Uh oh!

rust-timer commented Oct 25, 2026

Overall result: ❌ regressions - please read:

Instruction count

Max RSS (memory usage)

Cycles

Binary size

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

GuillaumeGomez commented Aug 19, 2026 •

edited by rustbot

Loading

GuillaumeGomez Aug 19, 2026 •

edited by rustbot

Loading

Urgau commented Aug 19, 2026 •

edited

Loading

Urgau left a comment •

edited by rustbot

Loading

rust-bors Bot commented Oct 25, 2026 •

edited

Loading