rustdoc: Simplify modifications of effective visibility table #103010

petrochenkov · 2022-10-13T14:15:56Z

It is now obvious that rustdoc only calls set_access_level with foreign def ids and AccessLevel::Public.

The second commit makes one more step and separates effective visibilities coming from rustc from similar data collected by rustdoc for extern DefIds.
The original table is no longer modified and now only contains local def ids as populated by rustc.

cc #102026 @Bryanskiy

rust-highfive · 2022-10-13T14:16:00Z

r? @CraftSpider

(rust-highfive has picked a reviewer for you, use r? to override)

petrochenkov · 2022-10-13T14:17:56Z

src/librustdoc/visit_ast.rs

-                        // All items need to be handled here in case someone wishes to link
-                        // to them with intra-doc links
-                        self.cx.cache.access_levels.set_access_level(did, AccessLevel::Public);
-                    }


Behavior change 1: set_access_level is now called on DefKind::Mod items themselves too.
It was previously done in visit_lib.rs but not here.

petrochenkov · 2022-10-13T14:20:45Z

src/librustdoc/visit_lib.rs

-            self.access_levels.set_access_level(did, level.unwrap());
-            level
-        } else {
-            old_level


Possible behavior change 2: the visitor can no longer recurse into doc-hidden modules.
It was previously the case in visit_ast.rs but not here.

petrochenkov · 2022-10-19T20:11:52Z

I made one more step and separated effective visibilities ("access levels") coming from rustc from similar data collected by rustdoc for extern DefIds.
The original table is no longer modified and now only contains local def ids as populated by rustc.

petrochenkov · 2022-10-29T11:10:13Z

Ping @CraftSpider @GuillaumeGomez
This PR is a pre-requisite for other work, including #94857.

GuillaumeGomez · 2022-10-29T12:16:49Z

Looks good to me, thanks! Let's run a perf check to ensure it doesn't have an impact then let's r+.

@bors try @rust-timer queue

rust-timer · 2022-10-29T12:16:50Z

Awaiting bors try build completion.

@rustbot label: +S-waiting-on-perf

bors · 2022-10-29T12:16:57Z

⌛ Trying commit a5ea013436b3f11d263e1c5e3dc2383de2bc68c6 with merge 5e44172c9c9d88b400c5755c5caf906c9b8188f6...

bors · 2022-10-29T14:20:53Z

☀️ Try build successful - checks-actions
Build commit: 5e44172c9c9d88b400c5755c5caf906c9b8188f6 (5e44172c9c9d88b400c5755c5caf906c9b8188f6)

rust-timer · 2022-10-29T14:20:59Z

Queued 5e44172c9c9d88b400c5755c5caf906c9b8188f6 with parent 33b530e, future comparison URL.

rust-timer · 2022-10-29T15:40:29Z

Finished benchmarking commit (5e44172c9c9d88b400c5755c5caf906c9b8188f6): comparison URL.

Overall result: ✅ improvements - no action needed

Benchmarking this pull request likely means that it is perf-sensitive, so we're automatically marking it as not fit for rolling up. While you can manually mark this PR as fit for rollup, we strongly recommend not doing so since this PR may lead to changes in compiler perf.

@bors rollup=never
@rustbot label: +S-waiting-on-review -S-waiting-on-perf -perf-regression

Instruction count

This is a highly reliable metric that was used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	0.3%	[0.3%, 0.3%]	1
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-0.6%	[-1.1%, -0.3%]	21
Improvements ✅ (secondary)	-1.0%	[-1.3%, -0.3%]	19
All ❌✅ (primary)	-0.5%	[-1.1%, 0.3%]	22

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	2.0%	[2.0%, 2.0%]	1
Improvements ✅ (primary)	-3.4%	[-3.4%, -3.4%]	1
Improvements ✅ (secondary)	-3.3%	[-3.7%, -3.0%]	2
All ❌✅ (primary)	-3.4%	[-3.4%, -3.4%]	1

Cycles

This benchmark run did not return any relevant results for this metric.

GuillaumeGomez · 2022-10-29T15:43:30Z

Even if small, it does impact (positively) performance, nice!

@bors r+ rollup=iffy

bors · 2022-10-29T15:43:31Z

📌 Commit a5ea013436b3f11d263e1c5e3dc2383de2bc68c6 has been approved by GuillaumeGomez

It is now in the queue for this repository.

…ilt by rustdoc for external def-ids

petrochenkov · 2022-10-29T20:02:24Z

@bors r=GuillaumeGomez

bors · 2022-10-29T20:02:26Z

📌 Commit f1850d4 has been approved by GuillaumeGomez

It is now in the queue for this repository.

bors · 2022-10-30T10:52:07Z

⌛ Testing commit f1850d4 with merge fab0432...

bors · 2022-10-30T13:32:35Z

☀️ Test successful - checks-actions
Approved by: GuillaumeGomez
Pushing fab0432 to master...

rust-timer · 2022-10-30T14:51:07Z

Finished benchmarking commit (fab0432): comparison URL.

Overall result: ✅ improvements - no action needed

@rustbot label: -perf-regression

Instruction count

This is a highly reliable metric that was used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	1.1%	[1.1%, 1.1%]	1
Improvements ✅ (primary)	-0.6%	[-1.3%, -0.3%]	21
Improvements ✅ (secondary)	-1.1%	[-1.5%, -0.3%]	21
All ❌✅ (primary)	-0.6%	[-1.3%, -0.3%]	21

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	2.4%	[2.4%, 2.4%]	1
Improvements ✅ (primary)	-3.6%	[-3.6%, -3.6%]	1
Improvements ✅ (secondary)	-3.4%	[-3.8%, -3.2%]	3
All ❌✅ (primary)	-3.6%	[-3.6%, -3.6%]	1

Cycles

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-2.2%	[-2.2%, -2.2%]	3
All ❌✅ (primary)	-	-	0

…omez rustdoc: Simplify modifications of effective visibility table It is now obvious that rustdoc only calls `set_access_level` with foreign def ids and `AccessLevel::Public`. The second commit makes one more step and separates effective visibilities coming from rustc from similar data collected by rustdoc for extern `DefId`s. The original table is no longer modified and now only contains local def ids as populated by rustc. cc rust-lang#102026 `@Bryanskiy`

rust-highfive assigned CraftSpider Oct 13, 2022

rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Oct 13, 2022

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 13, 2022

petrochenkov commented Oct 13, 2022

View reviewed changes

This comment was marked as resolved.

Sign in to view

petrochenkov 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 Oct 13, 2022

petrochenkov force-pushed the effvisdoc branch from d1498ff to 434ba37 Compare October 14, 2022 17:51

petrochenkov 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 14, 2022

This comment was marked as resolved.

Sign in to view

petrochenkov force-pushed the effvisdoc branch from 434ba37 to 482e39f Compare October 19, 2022 20:06

This comment was marked as resolved.

Sign in to view

petrochenkov force-pushed the effvisdoc branch from 482e39f to a5ea013 Compare October 29, 2022 11:09

GuillaumeGomez approved these changes Oct 29, 2022

View reviewed changes

rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Oct 29, 2022

rustbot removed the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Oct 29, 2022

bors removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 29, 2022

bors added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Oct 29, 2022

This comment was marked as resolved.

Sign in to view

bors 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 29, 2022

petrochenkov added 3 commits October 29, 2022 23:17

rustdoc: Simplify modifications of effective visibility table

3f21bdd

rustdoc: Split effective visibilities from rustc from similar data bu…

90f27f9

…ilt by rustdoc for external def-ids

rustc_middle: Remove unnecessary type parameter from AccessLevels

f1850d4

petrochenkov force-pushed the effvisdoc branch from a5ea013 to f1850d4 Compare October 29, 2022 20:00

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 Oct 29, 2022

bors added the merged-by-bors This PR was explicitly merged by bors. label Oct 30, 2022

bors merged commit fab0432 into rust-lang:master Oct 30, 2022

rustbot added this to the 1.67.0 milestone Oct 30, 2022

This was referenced Oct 30, 2022

rustdoc: Do not add external traits to the crate in register_res #103649

Merged

Make rustdoc Item::visibility computed on-demand #103690

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rustdoc: Simplify modifications of effective visibility table #103010

rustdoc: Simplify modifications of effective visibility table #103010

petrochenkov commented Oct 13, 2022 •

edited

Loading

rust-highfive commented Oct 13, 2022

petrochenkov Oct 13, 2022

petrochenkov Oct 13, 2022

This comment was marked as resolved.

This comment was marked as resolved.

petrochenkov commented Oct 19, 2022

This comment was marked as resolved.

petrochenkov commented Oct 29, 2022

GuillaumeGomez commented Oct 29, 2022

rust-timer commented Oct 29, 2022

bors commented Oct 29, 2022

bors commented Oct 29, 2022

rust-timer commented Oct 29, 2022

rust-timer commented Oct 29, 2022

GuillaumeGomez commented Oct 29, 2022

bors commented Oct 29, 2022

This comment was marked as resolved.

petrochenkov commented Oct 29, 2022

bors commented Oct 29, 2022

bors commented Oct 30, 2022

bors commented Oct 30, 2022

rust-timer commented Oct 30, 2022

rustdoc: Simplify modifications of effective visibility table #103010

rustdoc: Simplify modifications of effective visibility table #103010

Conversation

petrochenkov commented Oct 13, 2022 • edited Loading

rust-highfive commented Oct 13, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

petrochenkov commented Oct 19, 2022

This comment was marked as resolved.

petrochenkov commented Oct 29, 2022

GuillaumeGomez commented Oct 29, 2022

rust-timer commented Oct 29, 2022

bors commented Oct 29, 2022

bors commented Oct 29, 2022

rust-timer commented Oct 29, 2022

rust-timer commented Oct 29, 2022

Overall result: ✅ improvements - no action needed

GuillaumeGomez commented Oct 29, 2022

bors commented Oct 29, 2022

This comment was marked as resolved.

petrochenkov commented Oct 29, 2022

bors commented Oct 29, 2022

bors commented Oct 30, 2022

bors commented Oct 30, 2022

rust-timer commented Oct 30, 2022

Overall result: ✅ improvements - no action needed

petrochenkov commented Oct 13, 2022 •

edited

Loading