Repository navigation
Warnings when running rustdoc on rust/kernel/traits.rs #307
Description
I'm getting the following warnings when running make rustdoc.
This is also visible on CI (example here), so it's not a configuration issue on my side
warning: unresolved link to `Box`
--> rust/kernel/traits.rs:11:68
|
11 | /// Common pointer types which implement a `pin()` method include [`Box`], [`Arc`] and [`Rc`].
| ^^^^^ no item named `Box` in scope
|
= note: `#[warn(broken_intra_doc_links)]` on by default
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `Rc`
--> rust/kernel/traits.rs:11:89
|
11 | /// Common pointer types which implement a `pin()` method include [`Box`], [`Arc`] and [`Rc`].
| ^^^^ no item named `Rc` in scope
|
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: 2 warnings emitted
@TheSven73 it looks like this was introduced by 02138fd.
Activity
TheSven73 commentedon May 28, 2021
I'll fix. Should we let the CI error out on rustdoc warnings?
wedsonaf commentedon May 28, 2021
Thanks!
I think we should, in fact I was surprised to find out that we don't.
TheSven73 commentedon May 28, 2021
Same. The CI succeeded, so I didn't even look at rustdoc's output.
I'll add rustdoc err-on-warn to the fix PR.
TheSven73 commentedon May 28, 2021
Hm. There are plenty of other rustdoc warnings, not only coming from
traits.rs. The amount and types of warnings appear to change depending on the platform being built.ojeda commentedon May 28, 2021
IIRC, I did not enable it right away because we did not have yet docs for all public bits etc. But yes, we definitely want to enable it.
w1: fix WARNING after calling w1_process()