Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rustdoc: Fix LinkReplacer link matching #108459

Merged
merged 1 commit into from
Jun 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions src/librustdoc/html/markdown.rs
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,6 @@ impl<'a, I: Iterator<Item = Event<'a>>> Iterator for LinkReplacer<'a, I> {
Some(Event::Code(text)) => {
trace!("saw code {}", text);
if let Some(link) = self.shortcut_link {
trace!("original text was {}", link.original_text);
GuillaumeGomez marked this conversation as resolved.
Show resolved Hide resolved
// NOTE: this only replaces if the code block is the *entire* text.
// If only part of the link has code highlighting, the disambiguator will not be removed.
// e.g. [fn@`f`]
Expand All @@ -391,8 +390,11 @@ impl<'a, I: Iterator<Item = Event<'a>>> Iterator for LinkReplacer<'a, I> {
// So we could never be sure we weren't replacing too much:
// [fn@my_`f`unc] is treated the same as [my_func()] in that pass.
//
// NOTE: &[1..len() - 1] is to strip the backticks
if **text == link.original_text[1..link.original_text.len() - 1] {
// NOTE: .get(1..len() - 1) is to strip the backticks
if let Some(link) = self.links.iter().find(|l| {
l.href == link.href
&& Some(&**text) == l.original_text.get(1..l.original_text.len() - 1)
}) {
debug!("replacing {} with {}", text, link.new_text);
*text = CowStr::Borrowed(&link.new_text);
}
Expand All @@ -403,9 +405,12 @@ impl<'a, I: Iterator<Item = Event<'a>>> Iterator for LinkReplacer<'a, I> {
Some(Event::Text(text)) => {
trace!("saw text {}", text);
if let Some(link) = self.shortcut_link {
trace!("original text was {}", link.original_text);
GuillaumeGomez marked this conversation as resolved.
Show resolved Hide resolved
// NOTE: same limitations as `Event::Code`
if **text == *link.original_text {
if let Some(link) = self
.links
.iter()
.find(|l| l.href == link.href && **text == *l.original_text)
{
debug!("replacing {} with {}", text, link.new_text);
*text = CowStr::Borrowed(&link.new_text);
}
Expand Down
37 changes: 37 additions & 0 deletions tests/rustdoc/intra-doc/issue-108459.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
#![deny(rustdoc::broken_intra_doc_links)]

pub struct S;
pub mod char {}

// Ensure this doesn't ICE due to trying to slice off non-existent backticks from "S"

/// See [S] and [`S`]
pub struct MyStruct1;

// Ensure that link texts are replaced correctly even if there are multiple links with
// the same target but different text

/// See also [crate::char] and [mod@char] and [prim@char]
// @has issue_108459/struct.MyStruct2.html '//*[@href="char/index.html"]' 'crate::char'
// @has - '//*[@href="char/index.html"]' 'char'
// @has - '//*[@href="{{channel}}/std/primitive.char.html"]' 'char'
pub struct MyStruct2;

/// See also [mod@char] and [prim@char] and [crate::char]
// @has issue_108459/struct.MyStruct3.html '//*[@href="char/index.html"]' 'crate::char'
// @has - '//*[@href="char/index.html"]' 'char'
// @has - '//*[@href="{{channel}}/std/primitive.char.html"]' 'char'
pub struct MyStruct3;

// Ensure that links are correct even if there are multiple links with the same text but
// different targets

/// See also [char][mod@char] and [char][prim@char]
// @has issue_108459/struct.MyStruct4.html '//*[@href="char/index.html"]' 'char'
// @has - '//*[@href="{{channel}}/std/primitive.char.html"]' 'char'
pub struct MyStruct4;

/// See also [char][prim@char] and [char][crate::char]
// @has issue_108459/struct.MyStruct5.html '//*[@href="char/index.html"]' 'char'
// @has - '//*[@href="{{channel}}/std/primitive.char.html"]' 'char'
pub struct MyStruct5;
2 changes: 1 addition & 1 deletion tests/rustdoc/intra-doc/prim-precedence.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ pub struct MyString;

/// See also [crate::char] and [mod@char]
// @has prim_precedence/struct.MyString2.html '//*[@href="char/index.html"]' 'crate::char'
// @has - '//*[@href="char/index.html"]' 'mod@char'
// @has - '//*[@href="char/index.html"]' 'char'
pub struct MyString2;