docs: clarify documentation of sync module #6955
Open
Cirrus CI / FreeBSD docs
failed
Nov 6, 2024 in 39s
Task Summary
Instruction test failed in 00:19
Details
✅ 00:03 clone
✅ 00:14 setup
❌ 00:19 test
| ^^^^^ help: if this is intentional, prefix it with an underscore: `_token`
warning: unused variable: `interests`
--> tokio/src/doc/mod.rs:29:9
|
29 | interests: mio::Interest,
| ^^^^^^^^^ help: if this is intentional, prefix it with an underscore: `_interests`
warning: unused variable: `registry`
--> tokio/src/doc/mod.rs:35:9
|
35 | registry: &mio::Registry,
| ^^^^^^^^ help: if this is intentional, prefix it with an underscore: `_registry`
warning: unused variable: `token`
--> tokio/src/doc/mod.rs:36:9
|
36 | token: mio::Token,
| ^^^^^ help: if this is intentional, prefix it with an underscore: `_token`
warning: unused variable: `interests`
--> tokio/src/doc/mod.rs:37:9
|
37 | interests: mio::Interest,
| ^^^^^^^^^ help: if this is intentional, prefix it with an underscore: `_interests`
warning: unused variable: `registry`
--> tokio/src/doc/mod.rs:41:30
|
41 | fn deregister(&mut self, registry: &mio::Registry) -> std::io::Result<()> {
| ^^^^^^^^ help: if this is intentional, prefix it with an underscore: `_registry`
warning: `tokio` (lib) generated 7 warnings
Checking tokio-util v0.7.12 (/tmp/cirrus-ci-build/tokio-util)
Checking futures v0.3.31
Documenting tokio-macros v2.4.0 (/tmp/cirrus-ci-build/tokio-macros)
Documenting tests-build v0.1.0 (/tmp/cirrus-ci-build/tests-build)
Checking tokio-stream v0.1.16 (/tmp/cirrus-ci-build/tokio-stream)
Documenting tokio-stream v0.1.16 (/tmp/cirrus-ci-build/tokio-stream)
Checking tokio-test v0.4.4 (/tmp/cirrus-ci-build/tokio-test)
Documenting tests-integration v0.1.0 (/tmp/cirrus-ci-build/tests-integration)
Documenting tokio-test v0.4.4 (/tmp/cirrus-ci-build/tokio-test)
Documenting tokio-util v0.7.12 (/tmp/cirrus-ci-build/tokio-util)
Documenting tokio v1.41.0 (/tmp/cirrus-ci-build/tokio)
error: unresolved link to `crate::runtime::Handle::dump`
--> tokio/src/sync/mod.rs:17:19
|
17 | //! [Task Dumps]: crate::runtime::Handle::dump
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `Handle` has no field or associated item named `dump`
|
= note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
= help: to override `-D warnings` add `#[allow(rustdoc::broken_intra_doc_links)]`
error: could not document `tokio`
Exit status: 101
Loading