Closed
Description
Line 215 in 1137d29
This error lives on nightly for ages:
$ rustc -Vv
rustc 1.32.0-nightly (4a45578bc 2018-12-07)
binary: rustc
commit-hash: 4a45578bc58ff262864f72680cc02e83f5d2f5b3
commit-date: 2018-12-07
host: x86_64-unknown-linux-gnu
release: 1.32.0-nightly
LLVM version: 8.0
~/tokio$ cargo doc
Documenting tokio v0.1.13 (/home/humbug/tokio)
error: `[ErrorKind]` cannot be resolved, ignoring it...
|
note: lint level defined here
--> src/lib.rs:2:23
|
2 | #![deny(missing_docs, warnings, missing_debug_implementations)]
| ^^^^^^^^
= note: #[deny(intra_doc_link_resolution_failure)] implied by #[deny(warnings)]
= note: the link appears in this line:
Converts an [`ErrorKind`] into an [`Error`].
^^^^^^^^^^^
= help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`
error: `[Error]` cannot be resolved, ignoring it...
|
= note: the link appears in this line:
Converts an [`ErrorKind`] into an [`Error`].
^^^^^^^
= help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`
error: Could not document `tokio`.
Caused by:
process didn't exit successfully: `rustdoc --crate-name tokio src/lib.rs --color always -o ..............
I am not sure this is an std::io::Error error, but it looks very strange there is no any link to FILE:LINE.
The source code can be found at tokio-rs/tokio#792
Metadata
Metadata
Assignees
Labels
Area: Documentation for any part of the project, including the compiler, standard library, and toolsCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Activity
estebank commentedon Dec 10, 2018
Mentoring instructions:
Update the linked doc with the following two lines:
kpp commentedon Dec 10, 2018
Hold on. The bug would be found in 10 seconds if you provided FILE:LINE. So the issue is a little bit more complicated.
euclio commentedon Dec 11, 2018
Shouldn't this warning be capped when documenting tokio since it occurs in the standard library?
cc #51684
estebank commentedon Dec 11, 2018
@euclio that would be my expectation. I am not sure why that isn't the case here.
@kpp I meant the link you provided:
rust/src/libstd/io/error.rs
Line 215 in 1137d29
Adding the mentioned lines at the end of it should be enough to get around the current tokio problem, but a more general solution needs to be devised, as brought up by @euclio.
brunoczim commentedon Dec 11, 2018
This is why
#[deny(warnings)]
is a really bad idea.euclio commentedon Dec 17, 2018
Minimal repro:
Rollup merge of rust-lang#56941 - euclio:deny-libstd-resolution-failu…
Rollup merge of rust-lang#56941 - euclio:deny-libstd-resolution-failu…
7 remaining items