rustdoc: make srcIndex no longer a global variable#142100

lolbinarycat · 2025-06-05T23:45:46Z

this is one-time initialization data, it can just
be a function parameter.

while we're doing that, we can more the json parsing into the function and save a few extra bytes of storage for free, at least in the case of multiple crates in a doc bundle.

fixes #138467

rustbot · 2025-06-05T23:45:50Z

r? @notriddle

rustbot has assigned @notriddle.
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 · 2025-06-05T23:45:52Z

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @jsha, @lolbinarycat

Some changes occurred in GUI tests.

cc @GuillaumeGomez

src/librustdoc/html/static/js/src-script.js

GuillaumeGomez · 2025-06-06T09:25:28Z

Seems good to me, thanks! Please remove the left-over debugging and then I'll approve.

notriddle · 2025-06-06T14:54:27Z

tests/rustdoc-gui/globals.goml

Why does this exist? searchIndex isn't part of the intended external interface, either.

I mean, at least the search index is something we actually want to persist, but I suppose it could just live in a closure upvar instead of a global.

The results table needs to be public for integration testing, although i'm not sure if the same is true of searchIndex (it's definitely not true for srcIndex, I checked)

lolbinarycat · 2025-06-16T20:00:23Z

@GuillaumeGomez debug print has been removed.

GuillaumeGomez · 2025-06-16T20:19:48Z

Thanks!

Considering the second commit is the removal of a forgotten debug log, please squash it. Then I'll r+ the PR.

lolbinarycat · 2025-06-16T20:38:18Z

@GuillaumeGomez squashed and rebased

lolbinarycat · 2025-06-16T20:49:12Z

sigh rebased this onto a broken master, gotta fix...

lolbinarycat · 2025-06-16T20:53:31Z

@GuillaumeGomez ok, rebased properly this time.

GuillaumeGomez · 2025-06-16T21:22:32Z

Perfect, thanks! r=me once CI pass.

@bors delegate

GuillaumeGomez · 2025-06-16T21:23:13Z

@bors delegate+

bors · 2025-06-16T21:23:17Z

✌️ @lolbinarycat, you can now approve this pull request!

If @GuillaumeGomez told you to "r=me" after making some further change, please make that change, then do @bors r=@GuillaumeGomez

yotamofek · 2025-06-16T22:28:36Z

src/librustdoc/html/static/js/src-script.js

+ * @param {string} srcIndexStr - strinified json map from crate name to dir structure
+ */
+function createSrcSidebar(srcIndexStr) {
+    console.log(srcIndexStr);


Another one? 😅 https://github.com/rust-lang/rust/pull/142100/files#r2131358481
I think we have eslint run on tidy, and it can catch these console.logs... might be an easy and helpful change to enable that lint.

there's a few that have just been sitting in the repo for a while, i think.. unless they are there intentionally, which might be why the lint is disabled.

I'll add this check. We can handle each remaining console.log by telling eslint to ignore them.

Thanks @yotamofek!

this is one-time initialization data, it can just be a function parameter. we also move the json parsing into createSrcSidebar to save a few bytes.

lolbinarycat · 2025-06-17T04:12:37Z

@bors r=@GuillaumeGomez

bors · 2025-06-17T04:12:40Z

📌 Commit 00c1042 has been approved by GuillaumeGomez

It is now in the queue for this repository.

…67, r=GuillaumeGomez rustdoc: make srcIndex no longer a global variable this is one-time initialization data, it can just be a function parameter. while we're doing that, we can more the json parsing into the function and save a few extra bytes of storage for free, at least in the case of multiple crates in a doc bundle. fixes rust-lang#138467

GuillaumeGomez · 2025-06-17T09:15:55Z

@bors r-

GuillaumeGomez · 2025-06-17T09:17:29Z

Double-checked the console.log and nothing remaining so all good.

@bors r+ rollup

bors · 2025-06-17T09:17:31Z

📌 Commit 00c1042 has been approved by GuillaumeGomez

It is now in the queue for this repository.

…r=lolbinarycat Lint about `console` calls in rustdoc JS As discussed [here](rust-lang#142100 (comment)), this PR enforces that `console` is not used in rustdoc JS by default. cc `@lolbinarycat`

Rollup of 14 pull requests Successful merges: - #141574 (impl `Default` for `array::IntoIter`) - #141608 (Add support for repetition to `proc_macro::quote`) - #142100 (rustdoc: make srcIndex no longer a global variable) - #142371 (avoid `&mut P<T>` in `visit_expr` etc methods) - #142517 (Windows: Use anonymous pipes in Command) - #142520 (alloc: less static mut + some cleanup) - #142588 (Generic ctx imprv) - #142605 (Don't unwrap in enzyme builds in case of missing llvm-config) - #142608 (Refresh module-level docs for `rustc_target::spec`) - #142618 (Lint about `console` calls in rustdoc JS) - #142620 (Remove a panicking branch in `BorrowedCursor::advance`) - #142631 (Dont suggest remove semi inside macro expansion for redundant semi lint) - #142632 (Update cargo) - #142635 (Temporarily add back -Zwasm-c-abi=spec) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of #142618 - GuillaumeGomez:eslint-no-console, r=lolbinarycat Lint about `console` calls in rustdoc JS As discussed [here](#142100 (comment)), this PR enforces that `console` is not used in rustdoc JS by default. cc `@lolbinarycat`

Rollup merge of #142100 - lolbinarycat:rustdoc-srcIndex-138467, r=GuillaumeGomez rustdoc: make srcIndex no longer a global variable this is one-time initialization data, it can just be a function parameter. while we're doing that, we can more the json parsing into the function and save a few extra bytes of storage for free, at least in the case of multiple crates in a doc bundle. fixes #138467

…rycat Lint about `console` calls in rustdoc JS As discussed [here](rust-lang/rust#142100 (comment)), this PR enforces that `console` is not used in rustdoc JS by default. cc `@lolbinarycat`

Rollup of 14 pull requests Successful merges: - rust-lang/rust#141574 (impl `Default` for `array::IntoIter`) - rust-lang/rust#141608 (Add support for repetition to `proc_macro::quote`) - rust-lang/rust#142100 (rustdoc: make srcIndex no longer a global variable) - rust-lang/rust#142371 (avoid `&mut P<T>` in `visit_expr` etc methods) - rust-lang/rust#142517 (Windows: Use anonymous pipes in Command) - rust-lang/rust#142520 (alloc: less static mut + some cleanup) - rust-lang/rust#142588 (Generic ctx imprv) - rust-lang/rust#142605 (Don't unwrap in enzyme builds in case of missing llvm-config) - rust-lang/rust#142608 (Refresh module-level docs for `rustc_target::spec`) - rust-lang/rust#142618 (Lint about `console` calls in rustdoc JS) - rust-lang/rust#142620 (Remove a panicking branch in `BorrowedCursor::advance`) - rust-lang/rust#142631 (Dont suggest remove semi inside macro expansion for redundant semi lint) - rust-lang/rust#142632 (Update cargo) - rust-lang/rust#142635 (Temporarily add back -Zwasm-c-abi=spec) r? `@ghost` `@rustbot` modify labels: rollup

rustbot assigned notriddle Jun 5, 2025

This comment has been minimized.

Sign in to view

lolbinarycat force-pushed the rustdoc-srcIndex-138467 branch from 80d65ae to 1f4435a Compare June 5, 2025 23:57

erikdesjardins reviewed Jun 6, 2025

View reviewed changes

src/librustdoc/html/static/js/src-script.js Outdated Show resolved Hide resolved

notriddle reviewed Jun 6, 2025

View reviewed changes

GuillaumeGomez approved these changes Jun 16, 2025

View reviewed changes

lolbinarycat force-pushed the rustdoc-srcIndex-138467 branch from 6cecd76 to 4236f4b Compare June 16, 2025 20:36

This comment has been minimized.

Sign in to view

lolbinarycat force-pushed the rustdoc-srcIndex-138467 branch from 4236f4b to f62e2de Compare June 16, 2025 20:37

This comment has been minimized.

Sign in to view

lolbinarycat force-pushed the rustdoc-srcIndex-138467 branch from f62e2de to a07ddd9 Compare June 16, 2025 20:50

GuillaumeGomez approved these changes Jun 16, 2025

View reviewed changes

yotamofek reviewed Jun 16, 2025

View reviewed changes

rustdoc: make srcIndex no longer a global variable

00c1042

this is one-time initialization data, it can just be a function parameter. we also move the json parsing into createSrcSidebar to save a few bytes.

lolbinarycat force-pushed the rustdoc-srcIndex-138467 branch from a07ddd9 to 00c1042 Compare June 17, 2025 01:22

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 Jun 17, 2025

workingjubilee mentioned this pull request Jun 17, 2025

Rollup of 9 pull requests #142615

Closed

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 Jun 17, 2025

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 Jun 17, 2025

GuillaumeGomez mentioned this pull request Jun 17, 2025

Lint about console calls in rustdoc JS #142618

Merged

jhpratt mentioned this pull request Jun 17, 2025

Rollup of 14 pull requests #142644

Merged

bors merged commit 0772ee7 into rust-lang:master Jun 18, 2025
10 checks passed

rustbot added this to the 1.89.0 milestone Jun 18, 2025

Uh oh!

Conversation

lolbinarycat commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Jun 5, 2025

Uh oh!

rustbot commented Jun 5, 2025

Uh oh!

This comment has been minimized.

Uh oh!

GuillaumeGomez commented Jun 6, 2025

Uh oh!

notriddle Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

lolbinarycat Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

lolbinarycat commented Jun 16, 2025

Uh oh!

GuillaumeGomez commented Jun 16, 2025

Uh oh!

This comment has been minimized.

lolbinarycat commented Jun 16, 2025

Uh oh!

This comment has been minimized.

lolbinarycat commented Jun 16, 2025

Uh oh!

lolbinarycat commented Jun 16, 2025

Uh oh!

GuillaumeGomez commented Jun 16, 2025

Uh oh!

GuillaumeGomez commented Jun 16, 2025

Uh oh!

bors commented Jun 16, 2025

Uh oh!

yotamofek Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

lolbinarycat Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

lolbinarycat commented Jun 17, 2025

Uh oh!

bors commented Jun 17, 2025

Uh oh!

GuillaumeGomez commented Jun 17, 2025

Uh oh!

GuillaumeGomez commented Jun 17, 2025

Uh oh!

bors commented Jun 17, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

lolbinarycat commented Jun 5, 2025 •

edited

Loading