Skip to content

Disallow linking to items with a mismatched disambiguator #75079

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.

Sign up for GitHub

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

Merged
bors merged 13 commits into from
Aug 7, 2020
Merged

Disallow linking to items with a mismatched disambiguator #75079

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
8e0e925
Disallow linking to items with a mismatched disambiguator
jyn514 Aug 3, 2020
519c854
Don't mark associated items as traits
jyn514 Aug 3, 2020
743f932
Keep the previous behavior of `register_res`
jyn514 Aug 3, 2020
99354f5
item -> link
jyn514 Aug 3, 2020
444f5a0
Give a much better error message if the struct failed to resolve
jyn514 Aug 5, 2020
fc273a0
Unresolved link -> incompatible link kind
jyn514 Aug 5, 2020
2dad90d
Suggest f() for functions and add a test case
jyn514 Aug 6, 2020
f05e9da
Still print help even if there's no span
jyn514 Aug 6, 2020
0c99d80
Use the proper kind for associated items
jyn514 Aug 6, 2020
ef54cde
Improve tests
jyn514 Aug 6, 2020
d240490
Fix outdated code
jyn514 Aug 6, 2020
17263bc
Remove dead code
jyn514 Aug 6, 2020
9914f73
Add doc-comment for `kind_side_channel`
jyn514 Aug 7, 2020
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
2 changes: 1 addition & 1 deletion src/librustdoc/passes/collect_intra_doc_links.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -819,7 +819,7 @@ impl<'a, 'tcx> DocFolder for LinkCollector<'a, 'tcx> {
// The resolved item did not match the disambiguator; give a better error than 'not found'
let msg = format!("unresolved link to `{}`", path_str);
report_diagnostic(cx, &msg, &item, &dox, link_range, |diag, sp| {
let msg = format!("this item resolved to {} {}, which did not match the disambiguator '{}'", kind.article(), kind.descr(id), disambiguator);
let msg = format!("this link resolved to {} {}, which did not match the disambiguator '{}'", kind.article(), kind.descr(id), disambiguator);
if let Some(sp) = sp {
diag.span_note(sp, &msg);
} else {
Expand Down
60 changes: 30 additions & 30 deletions src/test/rustdoc-ui/intra-links-disambiguator-mismatch.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
error: unresolved link to `S`
--> $DIR/intra-links-disambiguator-mismatch.rs:16:14
--> $DIR/intra-links-disambiguator-mismatch.rs:14:14
|
LL | /// Link to [struct@S]
| ^^^^^^^^
Expand All @@ -9,116 +9,116 @@ note: the lint level is defined here
|
LL | #![deny(broken_intra_doc_links)]
| ^^^^^^^^^^^^^^^^^^^^^^
note: this item resolved to an enum, which did not match the disambiguator 'struct'
--> $DIR/intra-links-disambiguator-mismatch.rs:16:14
note: this link resolved to an enum, which did not match the disambiguator 'struct'
--> $DIR/intra-links-disambiguator-mismatch.rs:14:14
|
LL | /// Link to [struct@S]
| ^^^^^^^^

error: unresolved link to `S`
--> $DIR/intra-links-disambiguator-mismatch.rs:20:14
--> $DIR/intra-links-disambiguator-mismatch.rs:18:14
|
LL | /// Link to [mod@S]
| ^^^^^
|
note: this item resolved to an enum, which did not match the disambiguator 'mod'
--> $DIR/intra-links-disambiguator-mismatch.rs:20:14
note: this link resolved to an enum, which did not match the disambiguator 'mod'
--> $DIR/intra-links-disambiguator-mismatch.rs:18:14
|
LL | /// Link to [mod@S]
| ^^^^^

error: unresolved link to `S`
--> $DIR/intra-links-disambiguator-mismatch.rs:24:14
--> $DIR/intra-links-disambiguator-mismatch.rs:22:14
|
LL | /// Link to [union@S]
| ^^^^^^^
|
note: this item resolved to an enum, which did not match the disambiguator 'union'
--> $DIR/intra-links-disambiguator-mismatch.rs:24:14
note: this link resolved to an enum, which did not match the disambiguator 'union'
--> $DIR/intra-links-disambiguator-mismatch.rs:22:14
|
LL | /// Link to [union@S]
| ^^^^^^^

error: unresolved link to `S`
--> $DIR/intra-links-disambiguator-mismatch.rs:28:14
--> $DIR/intra-links-disambiguator-mismatch.rs:26:14
|
LL | /// Link to [trait@S]
| ^^^^^^^
|
note: this item resolved to an enum, which did not match the disambiguator 'trait'
--> $DIR/intra-links-disambiguator-mismatch.rs:28:14
note: this link resolved to an enum, which did not match the disambiguator 'trait'
--> $DIR/intra-links-disambiguator-mismatch.rs:26:14
|
LL | /// Link to [trait@S]
| ^^^^^^^

error: unresolved link to `T`
--> $DIR/intra-links-disambiguator-mismatch.rs:32:14
--> $DIR/intra-links-disambiguator-mismatch.rs:30:14
|
LL | /// Link to [struct@T]
| ^^^^^^^^
|
note: this item resolved to a trait, which did not match the disambiguator 'struct'
--> $DIR/intra-links-disambiguator-mismatch.rs:32:14
note: this link resolved to a trait, which did not match the disambiguator 'struct'
--> $DIR/intra-links-disambiguator-mismatch.rs:30:14
|
LL | /// Link to [struct@T]
| ^^^^^^^^

error: unresolved link to `m`
--> $DIR/intra-links-disambiguator-mismatch.rs:36:14
--> $DIR/intra-links-disambiguator-mismatch.rs:34:14
|
LL | /// Link to [derive@m]
| ^^^^^^^^
|
note: this item resolved to a macro, which did not match the disambiguator 'derive'
--> $DIR/intra-links-disambiguator-mismatch.rs:36:14
note: this link resolved to a macro, which did not match the disambiguator 'derive'
--> $DIR/intra-links-disambiguator-mismatch.rs:34:14
|
LL | /// Link to [derive@m]
| ^^^^^^^^

error: unresolved link to `s`
--> $DIR/intra-links-disambiguator-mismatch.rs:40:14
--> $DIR/intra-links-disambiguator-mismatch.rs:38:14
|
LL | /// Link to [const@s]
| ^^^^^^^
|
note: this item resolved to a static, which did not match the disambiguator 'const'
--> $DIR/intra-links-disambiguator-mismatch.rs:40:14
note: this link resolved to a static, which did not match the disambiguator 'const'
--> $DIR/intra-links-disambiguator-mismatch.rs:38:14
|
LL | /// Link to [const@s]
| ^^^^^^^

error: unresolved link to `c`
--> $DIR/intra-links-disambiguator-mismatch.rs:44:14
--> $DIR/intra-links-disambiguator-mismatch.rs:42:14
|
LL | /// Link to [static@c]
| ^^^^^^^^
|
note: this item resolved to a constant, which did not match the disambiguator 'static'
--> $DIR/intra-links-disambiguator-mismatch.rs:44:14
note: this link resolved to a constant, which did not match the disambiguator 'static'
--> $DIR/intra-links-disambiguator-mismatch.rs:42:14
|
LL | /// Link to [static@c]
| ^^^^^^^^

error: unresolved link to `c`
--> $DIR/intra-links-disambiguator-mismatch.rs:48:14
--> $DIR/intra-links-disambiguator-mismatch.rs:46:14
|
LL | /// Link to [fn@c]
| ^^^^
|
note: this item resolved to a constant, which did not match the disambiguator 'fn'
--> $DIR/intra-links-disambiguator-mismatch.rs:48:14
note: this link resolved to a constant, which did not match the disambiguator 'fn'
--> $DIR/intra-links-disambiguator-mismatch.rs:46:14
|
LL | /// Link to [fn@c]
| ^^^^

error: unresolved link to `c`
--> $DIR/intra-links-disambiguator-mismatch.rs:52:14
--> $DIR/intra-links-disambiguator-mismatch.rs:50:14
|
LL | /// Link to [c()]
| ^^^
|
note: this item resolved to a constant, which did not match the disambiguator 'fn'
--> $DIR/intra-links-disambiguator-mismatch.rs:52:14
note: this link resolved to a constant, which did not match the disambiguator 'fn'
--> $DIR/intra-links-disambiguator-mismatch.rs:50:14
|
LL | /// Link to [c()]
| ^^^
Expand Down