rustdoc: Remove doc link resolution fallback to all `macro_rules` in the crate by petrochenkov · Pull Request #96676 · rust-lang/rust

petrochenkov · 2022-05-03T17:10:50Z

Fallback to all macro_rules in the crate is removed, as discussed in #96521, with compatibility measures described in #96676 (comment).

rust-highfive · 2022-05-03T17:10:53Z

r? @GuillaumeGomez

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

petrochenkov · 2022-05-03T17:11:01Z

@bors try

bors · 2022-05-03T17:11:09Z

⌛ Trying commit 27f0349f6a579e74d1c1e2bade8ff093b7879135 with merge 6fd27704e643b25711e6a97ec2b04873b411b97d...

bors · 2022-05-03T18:41:16Z

☀️ Try build successful - checks-actions
Build commit: 6fd27704e643b25711e6a97ec2b04873b411b97d (6fd27704e643b25711e6a97ec2b04873b411b97d)

petrochenkov · 2022-05-03T19:05:49Z

@craterbot run mode=rustdoc

craterbot · 2022-05-03T19:05:54Z

👌 Experiment pr-96676 created and queued.
🤖 Automatically detected try build 6fd27704e643b25711e6a97ec2b04873b411b97d
🔍 You can check out the queue and this experiment's details.

ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more

craterbot · 2022-05-05T16:11:06Z

🚧 Experiment pr-96676 is now running

ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more

craterbot · 2022-05-11T08:19:48Z

🎉 Experiment pr-96676 is completed!
📊 323 regressed and 93 fixed (231017 total)
📰 Open the full report.

⚠️ If you notice any spurious failure please add them to the blacklist!
ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more

petrochenkov · 2022-05-13T17:33:37Z

There's a huge number of spurious regressions, but 190 regressions are indeed due to the removal of the macro_rules fallback.

I think I have a plan for addressing this:

First we remove the fallback from fn resolve_path
Then we detect this case in fn resolution_failure and add a note to the lint message telling that "a macro with this name exists in this crate, but it's not in scope at the link's location".
Then we quietly return a link pointing to the found macro_rules from fn resolution_failure.

As a result we only break crates that explicitly deny broken_intra_doc_links, and produce working links in other cases (e.g. for docs.rs) while at the same time pretending that such links are not produced by showing the broken_intra_doc_links warnings.

petrochenkov · 2022-05-13T17:34:41Z

Marking this as blocked on #96345 because the plan is hard to implement without a preparational cleanup.

…the crate

petrochenkov · 2022-05-15T18:11:01Z

src/librustdoc/passes/collect_intra_doc_links.rs


-                        // If the link has `::` in it, assume it was meant to be an intra-doc link.
-                        // Otherwise, the `[]` might be unrelated.
-                        // FIXME: don't show this for autolinks (`<>`), `()` style links, or reference links


The FIXME is no longer relevant after #96187 as I understand, so I removed it.

Indeed. Thanks for the cleanup!

petrochenkov · 2022-05-15T18:11:54Z

PR updated in accordance with the plan from #96676 (comment).
@rustbot ready

GuillaumeGomez · 2022-05-16T13:53:34Z

Thanks!

@bors r+

bors · 2022-05-16T13:53:35Z

📌 Commit b4019de has been approved by GuillaumeGomez

bors · 2022-05-16T13:53:48Z

⌛ Testing commit b4019de with merge c52b9c1...

bors · 2022-05-16T16:18:04Z

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

rust-timer · 2022-05-16T18:10:56Z

Finished benchmarking commit (c52b9c1): comparison url.

Summary: This benchmark run did not return any relevant results.

If you disagree with this performance assessment, please file an issue in rust-lang/rustc-perf.

@rustbot label: -perf-regression

831: Add spin loop hints in tests for Miri r=taiki-e a=cbeuw This is a better way to do #829 Miri does not have a pre-emptive scheduler, so once the execution falls into a spin loop it'll hang forever: rust-lang/miri#1388 Similar measures (`yield_now()`) are already present in [some other tests](https://github.com/crossbeam-rs/crossbeam/blob/master/crossbeam-queue/tests/array_queue.rs), but it's missing here 832: Fix links to macro rules in docs r=taiki-e a=alygin The fix provides explicit links to macro rules in docs because they [are not resolved globally anymore](rust-lang/rust#96676). Co-authored-by: Andy Wang <cbeuw.andy@gmail.com> Co-authored-by: Andrew Lygin <alygin@gmail.com>

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

rust-highfive assigned GuillaumeGomez May 3, 2022

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

petrochenkov added S-waiting-on-crater Status: Waiting on a crater run to be completed. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 3, 2022

GuillaumeGomez approved these changes May 3, 2022

View reviewed changes

craterbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-crater Status: Waiting on a crater run to be completed. labels May 11, 2022

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 May 11, 2022

rustdoc: Remove doc link resolution fallback to all macro_rules in …

b4019de

…the crate

petrochenkov force-pushed the docrules branch from 27f0349 to b4019de Compare May 15, 2022 18:08

petrochenkov commented May 15, 2022

View reviewed changes

rustbot removed the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label May 15, 2022

rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 15, 2022

GuillaumeGomez approved these changes May 16, 2022

View reviewed changes

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 May 16, 2022

bors added the merged-by-bors This PR was explicitly merged by bors. label May 16, 2022

bors merged commit c52b9c1 into rust-lang:master May 16, 2022

rustbot added this to the 1.63.0 milestone May 16, 2022

davidbarsky mentioned this pull request May 18, 2022

chore: add Netlify doc previews tokio-rs/tokio#4699

Merged

alygin mentioned this pull request May 19, 2022

Fix links to macro rules in docs crossbeam-rs/crossbeam#832

Merged

petrochenkov mentioned this pull request May 27, 2022

private macros break intra-doc links #81633

Closed

hellow554 mentioned this pull request Jun 2, 2022

add rustdoc and clippy to github workflow rust-itertools/itertools#618

Closed

petrochenkov mentioned this pull request Jul 2, 2022

Spurious rustdoc::broken_intra_doc_links reported by linking to macro defined later #98804

Closed

jyn514 mentioned this pull request Apr 27, 2023

Remove rustdoc intra-doc-link macro resolution fallback #110879

Closed

petrochenkov deleted the docrules branch February 22, 2025 18:30

Uh oh!

Conversation

petrochenkov commented May 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rust-highfive commented May 3, 2022

Uh oh!

petrochenkov commented May 3, 2022

Uh oh!

bors commented May 3, 2022

Uh oh!

bors commented May 3, 2022

Uh oh!

petrochenkov commented May 3, 2022

Uh oh!

craterbot commented May 3, 2022

Uh oh!

craterbot commented May 5, 2022

Uh oh!

craterbot commented May 11, 2022

Uh oh!

petrochenkov commented May 13, 2022

Uh oh!

petrochenkov commented May 13, 2022

Uh oh!

petrochenkov May 15, 2022

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez May 16, 2022

Choose a reason for hiding this comment

Uh oh!

petrochenkov commented May 15, 2022

Uh oh!

GuillaumeGomez commented May 16, 2022

Uh oh!

bors commented May 16, 2022

Uh oh!

bors commented May 16, 2022

Uh oh!

bors commented May 16, 2022

Uh oh!

rust-timer commented May 16, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

petrochenkov commented May 3, 2022 •

edited

Loading