Skip to content

Getting intra_doc_link_resolution_failure warnings from std when documenting winapi #54423

Closed

Description

@retep998
> cargo doc --all-features
   Compiling winapi v0.3.6 (C:\Users\Peter\Code\winapi-rs)
 Documenting winapi v0.3.6 (C:\Users\Peter\Code\winapi-rs)
warning: `[DefaultHasher::new]` cannot be resolved, ignoring it...
     |
     = note: #[warn(intra_doc_link_resolution_failure)] on by default
     = note: the link appears in this line:

              Creates a new `DefaultHasher` using [`new`][DefaultHasher::new].
                                                          ^^^^^^^^^^^^^^^^^^
     = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[DefaultHasher::new]` cannot be resolved, ignoring it...
     |
     = note: the link appears in this line:

              Creates a new `DefaultHasher` using [`new`][DefaultHasher::new].
                                                          ^^^^^^^^^^^^^^^^^^
     = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[RwLock::new]` cannot be resolved, ignoring it...
    |
    = note: the link appears in this line:

             This is equivalent to [`RwLock::new`].
                                    ^^^^^^^^^^^^^
    = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[String]` cannot be resolved, ignoring it...
    |
    = note: the link appears in this line:

             Converts a [`String`] into a [`OsString`].
                         ^^^^^^^^
    = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[OsString]` cannot be resolved, ignoring it...
    |
    = note: the link appears in this line:

             Converts a [`String`] into a [`OsString`].
                                           ^^^^^^^^^^
    = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[Mutex::new]` cannot be resolved, ignoring it...
    |
    = note: the link appears in this line:

             This is equivalent to [`Mutex::new`].
                                    ^^^^^^^^^^^^
    = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[Seek::seek_relative]` cannot be resolved, ignoring it...
    |
    = note: the link appears in this line:

             To seek without discarding the internal buffer, use [`Seek::seek_relative`].
                                                                  ^^^^^^^^^^^^^^^^^^^^^
    = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[Weak]` cannot be resolved, ignoring it...
    |
    = note: the link appears in this line:

             [`Weak`], so we `drop` the inner value.
              ^^^^^^
    = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[Weak]` cannot be resolved, ignoring it...
    |
    = note: the link appears in this line:

             [`Weak`], so we `drop` the inner value.
              ^^^^^^
    = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[Weak::upgrade]` cannot be resolved, ignoring it...
     |
     = note: the link appears in this line:

              it. Calling [`upgrade`][Weak::upgrade] on the return value always gives [`None`].
                                      ^^^^^^^^^^^^^
     = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[Weak::upgrade]` cannot be resolved, ignoring it...
     |
     = note: the link appears in this line:

              Calling [`upgrade`][Weak::upgrade] on the return value always
                                  ^^^^^^^^^^^^^
     = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

warning: `[String::push_str]` cannot be resolved, ignoring it...
     |
     = note: the link appears in this line:

              This has the same behavior as the [`push_str`][String::push_str] method.
                                                             ^^^^^^^^^^^^^^^^
     = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

    Finished dev [unoptimized + debuginfo] target(s) in 2m 05s
> rustc -vV
rustc 1.30.0-nightly (cb6d2dfa8 2018-09-16)
binary: rustc
commit-hash: cb6d2dfa8923902b0992a1522dc4a45a9d3ba690
commit-date: 2018-09-16
host: x86_64-pc-windows-msvc
release: 1.30.0-nightly
LLVM version: 8.0

Activity

  1. added
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    on Sep 21, 2018
  2. QuietMisdreavus commented on Sep 21, 2018

    @QuietMisdreavus
    Contributor

    I feel like this may have been fixed by #53162. Can you double-check that the newest nightly shows the same warnings?

    $ cargo +nightly doc --all-features --target x86_64-pc-windows-gnu
        Updating crates.io index
       Compiling winapi-x86_64-pc-windows-gnu v0.4.0
       Compiling winapi v0.3.6 (/home/misdreavus/clones/winapi)
     Documenting winapi-x86_64-pc-windows-gnu v0.4.0
     Documenting winapi v0.3.6 (/home/misdreavus/clones/winapi)
        Finished dev [unoptimized + debuginfo] target(s) in 1m 16s
    $ rustc +nightly -vV
    rustc 1.30.0-nightly (3bc2ca7e4 2018-09-20)
    binary: rustc
    commit-hash: 3bc2ca7e4f8507f82a4c357ee19300166bcd8099
    commit-date: 2018-09-20
    host: x86_64-unknown-linux-gnu
    release: 1.30.0-nightly
    LLVM version: 8.0
  3. retep998 commented on Sep 25, 2018

    @retep998
    ContributorAuthor

    Yep, this was fixed in a more recent nightly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions