-
Notifications
You must be signed in to change notification settings - Fork 12.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
rustdoc: resolve intra-doc links when checking HTML
- Loading branch information
Showing
3 changed files
with
120 additions
and
2 deletions.
There are no files selected for viewing
This file contains 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
25 changes: 25 additions & 0 deletions
25
src/test/rustdoc-ui/intra-doc/html-as-generics-intra-doc.rs
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
#![deny(rustdoc::invalid_html_tags)] | ||
#![deny(rustdoc::broken_intra_doc_links)] | ||
|
||
pub struct ExistentStruct<T>(T); | ||
|
||
/// This [test][ExistentStruct<i32>] thing! | ||
pub struct NoError; | ||
|
||
/// This [ExistentStruct<i32>] thing! | ||
//~^ ERROR unclosed HTML tag `i32` | ||
pub struct PartialErrorOnlyHtml; | ||
|
||
/// This [test][NonExistentStruct<i32>] thing! | ||
//~^ ERROR unresolved link | ||
pub struct PartialErrorOnlyResolve; | ||
|
||
/// This [NonExistentStruct2<i32>] thing! | ||
//~^ ERROR unclosed HTML tag `i32` | ||
//~| ERROR unresolved link | ||
pub struct YesError; | ||
|
||
/// This [NonExistentStruct3<i32>][] thing! | ||
//~^ ERROR unclosed HTML tag `i32` | ||
//~| ERROR unresolved link | ||
pub struct YesErrorCollapsed; |
69 changes: 69 additions & 0 deletions
69
src/test/rustdoc-ui/intra-doc/html-as-generics-intra-doc.stderr
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
error: unresolved link to `NonExistentStruct` | ||
--> $DIR/html-as-generics-intra-doc.rs:13:17 | ||
| | ||
LL | /// This [test][NonExistentStruct<i32>] thing! | ||
| ^^^^^^^^^^^^^^^^^^^^^^ no item named `NonExistentStruct` in scope | ||
| | ||
note: the lint level is defined here | ||
--> $DIR/html-as-generics-intra-doc.rs:2:9 | ||
| | ||
LL | #![deny(rustdoc::broken_intra_doc_links)] | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` | ||
|
||
error: unresolved link to `NonExistentStruct2` | ||
--> $DIR/html-as-generics-intra-doc.rs:17:11 | ||
| | ||
LL | /// This [NonExistentStruct2<i32>] thing! | ||
| ^^^^^^^^^^^^^^^^^^^^^^^ no item named `NonExistentStruct2` in scope | ||
| | ||
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` | ||
|
||
error: unresolved link to `NonExistentStruct3` | ||
--> $DIR/html-as-generics-intra-doc.rs:22:11 | ||
| | ||
LL | /// This [NonExistentStruct3<i32>][] thing! | ||
| ^^^^^^^^^^^^^^^^^^^^^^^ no item named `NonExistentStruct3` in scope | ||
| | ||
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` | ||
|
||
error: unclosed HTML tag `i32` | ||
--> $DIR/html-as-generics-intra-doc.rs:9:25 | ||
| | ||
LL | /// This [ExistentStruct<i32>] thing! | ||
| ^^^^^ | ||
| | ||
note: the lint level is defined here | ||
--> $DIR/html-as-generics-intra-doc.rs:1:9 | ||
| | ||
LL | #![deny(rustdoc::invalid_html_tags)] | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
help: try marking as source code | ||
| | ||
LL | /// This [`ExistentStruct<i32>`] thing! | ||
| + + | ||
|
||
error: unclosed HTML tag `i32` | ||
--> $DIR/html-as-generics-intra-doc.rs:17:29 | ||
| | ||
LL | /// This [NonExistentStruct2<i32>] thing! | ||
| ^^^^^ | ||
| | ||
help: try marking as source code | ||
| | ||
LL | /// This [`NonExistentStruct2<i32>`] thing! | ||
| + + | ||
|
||
error: unclosed HTML tag `i32` | ||
--> $DIR/html-as-generics-intra-doc.rs:22:29 | ||
| | ||
LL | /// This [NonExistentStruct3<i32>][] thing! | ||
| ^^^^^ | ||
| | ||
help: try marking as source code | ||
| | ||
LL | /// This [`NonExistentStruct3<i32>`][] thing! | ||
| + + | ||
|
||
error: aborting due to 6 previous errors | ||
|