Skip to content

Fix rustdoc warning: unresolved link to ino in virtual_fs/mod.rs:140 #210

Description

@gvatsal60

Warning

warning: unresolved link to `ino`
   --> src/virtual_fs/mod.rs:140:25
    |
140 | ///   dir_loading_locks[ino]      (tokio::sync::Mutex, per-directory)
    |                         ^^^ no item named `ino` in scope
    |
    = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
    = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default

warning: `hf-mount` (lib doc) generated 1 warning
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 12m 48s

How to Reproduce

Run the documentation build: cargo doc --no-deps

Cause

The documentation comment uses [ino] which rustdoc interprets as an intra-doc link, but ino is not a valid item in scope.

Fix

Escape the brackets: change dir_loading_locks[ino] to dir_loading_locks\[ino\] in the doc comment at src/virtual_fs/mod.rs:140.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions