squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Update rustdoc-ui tests for intra-doc links errors

Browse source
This commit is contained in:
Guillaume Gomez 2021-07-19 17:00:35 +02:00
parent a2f3e4a5da
commit 0f7f85ede9
10 changed files with 166 additions and 92 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/test/rustdoc-ui/assoc-item-not-in-scope.stderr
View file

@ -1,8 +1,8 @@
error: unresolved link to `S::fmt`
--> $DIR/assoc-item-not-in-scope.rs:4:14
--> $DIR/assoc-item-not-in-scope.rs:4:15
|
LL | /// Link to [`S::fmt`]
| ^^^^^^^^ the struct `S` has no field or associated item named `fmt`
| ^^^^^^ the struct `S` has no field or associated item named `fmt`
|
note: the lint level is defined here
--> $DIR/assoc-item-not-in-scope.rs:1:9

38
src/test/rustdoc-ui/intra-doc/ambiguity.stderr
View file

@ -12,26 +12,26 @@ LL | #![deny(rustdoc::broken_intra_doc_links)]
help: to link to the module, prefix with `mod@`
|
LL | /// [mod@true]
| ^^^^^^^^
| ^^^^
help: to link to the builtin type, prefix with `prim@`
|
LL | /// [prim@true]
| ^^^^^^^^^
| ^^^^^
error: `ambiguous` is both a struct and a function
--> $DIR/ambiguity.rs:27:6
--> $DIR/ambiguity.rs:27:7
|
LL | /// [`ambiguous`] is ambiguous.
| ^^^^^^^^^^^ ambiguous link
| ^^^^^^^^^ ambiguous link
|
help: to link to the struct, prefix with `struct@`
|
LL | /// [`struct@ambiguous`] is ambiguous.
| ^^^^^^^^^^^^^^^^^^
| ^^^^^^^
help: to link to the function, add parentheses
|
LL | /// [`ambiguous()`] is ambiguous.
| ^^^^^^^^^^^^^
| ^^
error: `ambiguous` is both a struct and a function
--> $DIR/ambiguity.rs:29:6
@ -42,30 +42,30 @@ LL | /// [ambiguous] is ambiguous.
help: to link to the struct, prefix with `struct@`
|
LL | /// [struct@ambiguous] is ambiguous.
| ^^^^^^^^^^^^^^^^
| ^^^^^^^
help: to link to the function, add parentheses
|
LL | /// [ambiguous()] is ambiguous.
| ^^^^^^^^^^^
| ^^
error: `multi_conflict` is a struct, a function, and a macro
--> $DIR/ambiguity.rs:31:6
--> $DIR/ambiguity.rs:31:7
|
LL | /// [`multi_conflict`] is a three-way conflict.
| ^^^^^^^^^^^^^^^^ ambiguous link
| ^^^^^^^^^^^^^^ ambiguous link
|
help: to link to the struct, prefix with `struct@`
|
LL | /// [`struct@multi_conflict`] is a three-way conflict.
| ^^^^^^^^^^^^^^^^^^^^^^^
| ^^^^^^^
help: to link to the function, add parentheses
|
LL | /// [`multi_conflict()`] is a three-way conflict.
| ^^^^^^^^^^^^^^^^^^
| ^^
help: to link to the macro, add an exclamation mark
|
LL | /// [`multi_conflict!`] is a three-way conflict.
| ^^^^^^^^^^^^^^^^^
| ^
error: `type_and_value` is both a module and a constant
--> $DIR/ambiguity.rs:33:16
@ -76,26 +76,26 @@ LL | /// Ambiguous [type_and_value].
help: to link to the module, prefix with `mod@`
|
LL | /// Ambiguous [mod@type_and_value].
| ^^^^^^^^^^^^^^^^^^
| ^^^^
help: to link to the constant, prefix with `const@`
|
LL | /// Ambiguous [const@type_and_value].
| ^^^^^^^^^^^^^^^^^^^^
| ^^^^^^
error: `foo::bar` is both an enum and a function
--> $DIR/ambiguity.rs:35:42
--> $DIR/ambiguity.rs:35:43
|
LL | /// Ambiguous non-implied shortcut link [`foo::bar`].
| ^^^^^^^^^^ ambiguous link
| ^^^^^^^^ ambiguous link
|
help: to link to the enum, prefix with `enum@`
|
LL | /// Ambiguous non-implied shortcut link [`enum@foo::bar`].
| ^^^^^^^^^^^^^^^
| ^^^^^
help: to link to the function, add parentheses
|
LL | /// Ambiguous non-implied shortcut link [`foo::bar()`].
| ^^^^^^^^^^^^
| ^^
error: aborting due to 6 previous errors

8
src/test/rustdoc-ui/intra-doc/disambiguator-mismatch.rs
View file

@ -1,7 +1,9 @@
#![deny(rustdoc::broken_intra_doc_links)]
//~^ NOTE lint level is defined
pub enum S {}
fn S() {}
#[macro_export]
macro_rules! m {
() => {};
}
@ -41,6 +43,12 @@ trait T {}
//~| NOTE this link resolved
//~| HELP add an exclamation mark
/// Link to [m()]
//~^ ERROR unresolved link to `m`
//~| NOTE this link resolves to the macro `m`
//~| HELP add an exclamation mark
/// and to [m!()]
/// Link to [const@s]
//~^ ERROR incompatible link kind for `s`
//~| NOTE this link resolved

112
src/test/rustdoc-ui/intra-doc/disambiguator-mismatch.stderr
View file

@ -1,95 +1,139 @@
error: incompatible link kind for `S`
--> $DIR/disambiguator-mismatch.rs:14:14
--> $DIR/disambiguator-mismatch.rs:16:14
|
LL | /// Link to [struct@S]
| ^^^^^^^^ help: to link to the enum, prefix with `enum@`: `enum@S`
| ^^^^^^^^ this link resolved to an enum, which is not a struct
|
note: the lint level is defined here
--> $DIR/disambiguator-mismatch.rs:1:9
|
LL | #![deny(rustdoc::broken_intra_doc_links)]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
= note: this link resolved to an enum, which is not a struct
help: to link to the enum, prefix with `enum@`
|
LL | /// Link to [enum@S]
| ^^^^^
error: incompatible link kind for `S`
--> $DIR/disambiguator-mismatch.rs:19:14
--> $DIR/disambiguator-mismatch.rs:21:14
|
LL | /// Link to [mod@S]
| ^^^^^ help: to link to the enum, prefix with `enum@`: `enum@S`
| ^^^^^ this link resolved to an enum, which is not a module
|
= note: this link resolved to an enum, which is not a module
help: to link to the enum, prefix with `enum@`
|
LL | /// Link to [enum@S]
| ^^^^^
error: incompatible link kind for `S`
--> $DIR/disambiguator-mismatch.rs:24:14
--> $DIR/disambiguator-mismatch.rs:26:14
|
LL | /// Link to [union@S]
| ^^^^^^^ help: to link to the enum, prefix with `enum@`: `enum@S`
| ^^^^^^^ this link resolved to an enum, which is not a union
|
= note: this link resolved to an enum, which is not a union
help: to link to the enum, prefix with `enum@`
|
LL | /// Link to [enum@S]
| ^^^^^
error: incompatible link kind for `S`
--> $DIR/disambiguator-mismatch.rs:29:14
--> $DIR/disambiguator-mismatch.rs:31:14
|
LL | /// Link to [trait@S]
| ^^^^^^^ help: to link to the enum, prefix with `enum@`: `enum@S`
| ^^^^^^^ this link resolved to an enum, which is not a trait
|
= note: this link resolved to an enum, which is not a trait
help: to link to the enum, prefix with `enum@`
|
LL | /// Link to [enum@S]
| ^^^^^
error: incompatible link kind for `T`
--> $DIR/disambiguator-mismatch.rs:34:14
--> $DIR/disambiguator-mismatch.rs:36:14
|
LL | /// Link to [struct@T]
| ^^^^^^^^ help: to link to the trait, prefix with `trait@`: `trait@T`
| ^^^^^^^^ this link resolved to a trait, which is not a struct
|
= note: this link resolved to a trait, which is not a struct
help: to link to the trait, prefix with `trait@`
|
LL | /// Link to [trait@T]
| ^^^^^^
error: incompatible link kind for `m`
--> $DIR/disambiguator-mismatch.rs:39:14
--> $DIR/disambiguator-mismatch.rs:41:14
|
LL | /// Link to [derive@m]
| ^^^^^^^^ help: to link to the macro, add an exclamation mark: `m!`
| ^^^^^^^^ this link resolved to a macro, which is not a derive macro
|
= note: this link resolved to a macro, which is not a derive macro
help: to link to the macro, add an exclamation mark
|
LL | /// Link to [m!]
| --^
error: unresolved link to `m`
--> $DIR/disambiguator-mismatch.rs:46:14
|
LL | /// Link to [m()]
| ^^^ this link resolves to the macro `m`, which is not in the value namespace
|
help: to link to the macro, add an exclamation mark
|
LL | /// Link to [m!()]
| ^
error: incompatible link kind for `s`
--> $DIR/disambiguator-mismatch.rs:44:14
--> $DIR/disambiguator-mismatch.rs:52:14
|
LL | /// Link to [const@s]
| ^^^^^^^ help: to link to the static, prefix with `static@`: `static@s`
| ^^^^^^^ this link resolved to a static, which is not a constant
|
= note: this link resolved to a static, which is not a constant
help: to link to the static, prefix with `static@`
|
LL | /// Link to [static@s]
| ^^^^^^^
error: incompatible link kind for `c`
--> $DIR/disambiguator-mismatch.rs:49:14
--> $DIR/disambiguator-mismatch.rs:57:14
|
LL | /// Link to [static@c]
| ^^^^^^^^ help: to link to the constant, prefix with `const@`: `const@c`
| ^^^^^^^^ this link resolved to a constant, which is not a static
|
= note: this link resolved to a constant, which is not a static
help: to link to the constant, prefix with `const@`
|
LL | /// Link to [const@c]
| ^^^^^^
error: incompatible link kind for `c`
--> $DIR/disambiguator-mismatch.rs:54:14
--> $DIR/disambiguator-mismatch.rs:62:14
|
LL | /// Link to [fn@c]
| ^^^^ help: to link to the constant, prefix with `const@`: `const@c`
| ^^^^ this link resolved to a constant, which is not a function
|
= note: this link resolved to a constant, which is not a function
help: to link to the constant, prefix with `const@`
|
LL | /// Link to [const@c]
| ^^^^^^
error: incompatible link kind for `c`
--> $DIR/disambiguator-mismatch.rs:59:14
--> $DIR/disambiguator-mismatch.rs:67:14
|
LL | /// Link to [c()]
| ^^^ help: to link to the constant, prefix with `const@`: `const@c`
| ^^^ this link resolved to a constant, which is not a function
|
= note: this link resolved to a constant, which is not a function
help: to link to the constant, prefix with `const@`
|
LL | /// Link to [const@c]
| ^^^^^^--
error: incompatible link kind for `f`
--> $DIR/disambiguator-mismatch.rs:64:14
--> $DIR/disambiguator-mismatch.rs:72:14
|
LL | /// Link to [const@f]
| ^^^^^^^ help: to link to the function, add parentheses: `f()`
| ^^^^^^^ this link resolved to a function, which is not a constant
|
= note: this link resolved to a function, which is not a constant
help: to link to the function, add parentheses
|
LL | /// Link to [f()]
| --^^
error: aborting due to 11 previous errors
error: aborting due to 12 previous errors

50
src/test/rustdoc-ui/intra-doc/errors.stderr
View file

@ -92,37 +92,45 @@ error: unresolved link to `Vec::into_iter`
--> $DIR/errors.rs:63:6
|
LL | /// [type@Vec::into_iter]
| ^^^^^^^^^^^^^^^^^^^
| |
| this link resolves to the associated function `into_iter`, which is not in the type namespace
| help: to link to the associated function, add parentheses: `Vec::into_iter()`
| ^^^^^^^^^^^^^^^^^^^ this link resolves to the associated function `into_iter`, which is not in the type namespace
|
help: to link to the associated function, add parentheses
|
LL | /// [Vec::into_iter()]
| -- ^^
error: unresolved link to `S`
--> $DIR/errors.rs:68:6
|
LL | /// [S!]
| ^^
| |
| this link resolves to the struct `S`, which is not in the macro namespace
| help: to link to the struct, prefix with `struct@`: `struct@S`
| ^^ this link resolves to the struct `S`, which is not in the macro namespace
|
help: to link to the struct, prefix with `struct@`
|
LL | /// [struct@S]
| ^^^^^^^--
error: unresolved link to `S::h`
--> $DIR/errors.rs:78:6
|
LL | /// [type@S::h]
| ^^^^^^^^^
| |
| this link resolves to the associated function `h`, which is not in the type namespace
| help: to link to the associated function, add parentheses: `S::h()`
| ^^^^^^^^^ this link resolves to the associated function `h`, which is not in the type namespace
|
help: to link to the associated function, add parentheses
|
LL | /// [S::h()]
| -- ^^
error: unresolved link to `T::g`
--> $DIR/errors.rs:86:6
|
LL | /// [type@T::g]
| ^^^^^^^^^
| |
| this link resolves to the associated function `g`, which is not in the type namespace
| help: to link to the associated function, add parentheses: `T::g()`
| ^^^^^^^^^ this link resolves to the associated function `g`, which is not in the type namespace
|
help: to link to the associated function, add parentheses
|
LL | /// [T::g()]
| -- ^^
error: unresolved link to `T::h`
--> $DIR/errors.rs:91:6
@ -134,10 +142,12 @@ error: unresolved link to `m`
--> $DIR/errors.rs:98:6
|
LL | /// [m()]
| ^^^
| |
| this link resolves to the macro `m`, which is not in the value namespace
| help: to link to the macro, add an exclamation mark: `m!`
| ^^^ this link resolves to the macro `m`, which is not in the value namespace
|
help: to link to the macro, add an exclamation mark
|
LL | /// [m!()]
| ^
error: aborting due to 20 previous errors

9
src/test/rustdoc-ui/intra-doc/field-ice.stderr
View file

@ -1,15 +1,18 @@
error: incompatible link kind for `Foo::bar`
--> $DIR/field-ice.rs:5:6
--> $DIR/field-ice.rs:5:7
|
LL | /// [`Foo::bar()`]
| ^^^^^^^^^^^^ help: to link to the field, remove the disambiguator: ``Foo::bar``
| ^^^^^^^^^^ this link resolved to a field, which is not a function
|
note: the lint level is defined here
--> $DIR/field-ice.rs:1:9
|
LL | #![deny(rustdoc::broken_intra_doc_links)]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
= note: this link resolved to a field, which is not a function
help: to link to the field, remove the disambiguator
|
LL | /// [`Foo::bar`]
| ^^^^^^^^
error: aborting due to previous error

7
src/test/rustdoc-ui/intra-doc/incompatible-primitive-disambiguator.stderr
View file

@ -2,14 +2,17 @@ error: incompatible link kind for `u8::MIN`
--> $DIR/incompatible-primitive-disambiguator.rs:2:6
|
LL | //! [static@u8::MIN]
| ^^^^^^^^^^^^^^ help: to link to the associated constant, prefix with `const@`: `const@u8::MIN`
| ^^^^^^^^^^^^^^ this link resolved to an associated constant, which is not a static
|
note: the lint level is defined here
--> $DIR/incompatible-primitive-disambiguator.rs:1:9
|
LL | #![deny(rustdoc::broken_intra_doc_links)]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
= note: this link resolved to an associated constant, which is not a static
help: to link to the associated constant, prefix with `const@`
|
LL | //! [const@u8::MIN]
| ^^^^^^
error: aborting due to previous error

22
src/test/rustdoc-ui/intra-doc/prim-conflict.stderr
View file

@ -12,11 +12,11 @@ LL | #![deny(rustdoc::broken_intra_doc_links)]
help: to link to the module, prefix with `mod@`
|
LL | /// [mod@char]
| ^^^^^^^^
| ^^^^
help: to link to the builtin type, prefix with `prim@`
|
LL | /// [prim@char]
| ^^^^^^^^^
| ^^^^^
error: `char` is both a module and a builtin type
--> $DIR/prim-conflict.rs:10:6
@ -27,27 +27,33 @@ LL | /// [type@char]
help: to link to the module, prefix with `mod@`
|
LL | /// [mod@char]
| ^^^^^^^^
| ^^^^
help: to link to the builtin type, prefix with `prim@`
|
LL | /// [prim@char]
| ^^^^^^^^^
| ^^^^^
error: incompatible link kind for `char`
--> $DIR/prim-conflict.rs:19:6
|
LL | /// [struct@char]
| ^^^^^^^^^^^ help: to link to the module, prefix with `mod@`: `mod@char`
| ^^^^^^^^^^^ this link resolved to a module, which is not a struct
|
= note: this link resolved to a module, which is not a struct
help: to link to the module, prefix with `mod@`
|
LL | /// [mod@char]
| ^^^^
error: incompatible link kind for `char`
--> $DIR/prim-conflict.rs:26:10
|
LL | //! [struct@char]
| ^^^^^^^^^^^ help: to link to the builtin type, prefix with `prim@`: `prim@char`
| ^^^^^^^^^^^ this link resolved to a builtin type, which is not a struct
|
= note: this link resolved to a builtin type, which is not a struct
help: to link to the builtin type, prefix with `prim@`
|
LL | //! [prim@char]
| ^^^^^
error: aborting due to 4 previous errors

4
src/test/rustdoc-ui/issue-74134.private.stderr
View file

@ -1,8 +1,8 @@
warning: public documentation for `public_item` links to private item `PrivateType`
--> $DIR/issue-74134.rs:19:10
--> $DIR/issue-74134.rs:19:11
|
LL | /// [`PrivateType`]
| ^^^^^^^^^^^^^ this item is private
| ^^^^^^^^^^^ this item is private
|
= note: `#[warn(rustdoc::private_intra_doc_links)]` on by default
= note: this link resolves only because you passed `--document-private-items`, but will break without

4
src/test/rustdoc-ui/issue-74134.public.stderr
View file

@ -1,8 +1,8 @@
warning: public documentation for `public_item` links to private item `PrivateType`
--> $DIR/issue-74134.rs:19:10
--> $DIR/issue-74134.rs:19:11
|
LL | /// [`PrivateType`]
| ^^^^^^^^^^^^^ this item is private
| ^^^^^^^^^^^ this item is private
|
= note: `#[warn(rustdoc::private_intra_doc_links)]` on by default
= note: this link will resolve properly if you pass `--document-private-items`