[Perf] Optimize documentation lints **a lot** (1/2) (18% -> 10%) #14693
+60
−19
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
blyxyas
added
the
performance-project
rustbot
added
the
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
Turns out that `doc_markdown` uses a non-cheap rustdoc function to convert from markdown ranges into source spans. And it was using it a lot (about once every 18 lines of documentation on `tokio`, which ends up being about 1800 times). This ended up being about 18% of the total Clippy runtime as discovered by lintcheck --perf in docs-heavy crates. This PR optimizes one of the cases in which Clippy calls the function, and a future PR once pulldown-cmark/pulldown-cmark issue number 1034 is merged will be open. Note that not all crates were affected by this crate equally, those with more docs are affected far more than those light ones.
blyxyas
force-pushed
the
optimize-doc-lints
branch
from
fe7ec9b to
565cf5a
Compare
Jarcho
reviewed
Apr 26, 2025
Comment on lines
+137
to
+147
| let Some(fragment_span) = fragments.span(cx, range.clone()) else { | ||
| return ControlFlow::Break(()); | ||
| }; | ||
|
|
||
| let span = Span::new( | ||
| fragment_span.lo() + BytePos::from_usize(fragment_offset), | ||
| fragment_span.lo() + BytePos::from_usize(fragment_offset + word.len()), | ||
| fragment_span.ctxt(), | ||
| fragment_span.parent(), | ||
| ); | ||
|
|
There was a problem hiding this comment.
Should you not be adjusting the range before creating the span? fragment_offset looks like it's an offset in the markdown text.
| @@ -117,6 +134,17 @@ fn check_word(cx: &LateContext<'_>, word: &str, span: Span, code_level: isize, b | |||
| // try to get around the fact that `foo::bar` parses as a valid URL | |||
| && !url.cannot_be_a_base() | |||
| { | |||
| let Some(fragment_span) = fragments.span(cx, range.clone()) else { | |||
| return ControlFlow::Break(()); | |||
There was a problem hiding this comment.
This seems wrong. One spot failing to get a span doesn't mean all the others will.
Comment on lines
+168
to
+177
| let Some(fragment_span) = fragments.span(cx, range.clone()) else { | ||
| return ControlFlow::Break(()); | ||
| }; | ||
|
|
||
| let span = Span::new( | ||
| fragment_span.lo() + BytePos::from_usize(fragment_offset), | ||
| fragment_span.lo() + BytePos::from_usize(fragment_offset + word.len()), | ||
| fragment_span.ctxt(), | ||
| fragment_span.parent(), | ||
| ); |
There was a problem hiding this comment.
Same as the previous two comments.
| /// Checks if a string is upper-camel-case, i.e., starts with an uppercase and | ||
| /// contains at least two uppercase letters (`Clippy` is ok) and one lower-case | ||
| /// letter (`NASA` is ok). | ||
| /// letter (`NASA` is ok).[ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Turns out that
doc_markdownuses a non-cheap rustdoc function to convert from markdown ranges into source spans. And it was using it a lot (about once every 17 lines of documentation ontokio, which ends up being about 2000 times).This ended up being about 18% of the total Clippy runtime as discovered by lintcheck --perf in docs-heavy crates. This PR optimizes one of the cases in which Clippy calls the function, and a future PR once pulldown-cmark/pulldown-cmark#1034 is merged will be opened. This PR lands the use of the function into the single-digit zone.
Note that not all crates were affected by this crate equally, those with more docs are affected far more than those light ones.
changelog:[
clippy::doc_markdown] has been optimized by 50%