Skip to content
This repository was archived by the owner on Oct 1, 2026. It is now read-only.
This repository was archived by the owner on Oct 1, 2026. It is now read-only.

cargo doc failing #36

Closed
Closed

Description

@carado

Hi!
While running cargo doc in a project which (indirectly) depends on pin-utils, I noticed that I encountered an error during the documentation of pin-utils 0.1.0.
The issue can be reproduced in a standalone project with pin-utils as its only dependency.

~/tmp/rust33 $ cargo init
     Created binary (application) package
~/tmp/rust33 $ echo 'pin-utils = "0.1.0"' >> Cargo.toml
~/tmp/rust33 $ cargo doc
    Updating crates.io index
 Documenting pin-utils v0.1.0
    Checking pin-utils v0.1.0
error[E0658]: linking to associated items of raw pointers is experimental
  --> /home/carado/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/core/src/ptr/metadata.rs:51:23
   |
51 | /// [`to_raw_parts`]: *const::to_raw_parts
   |                       ^^^^^^^^^^^^^^^^^^^^
   |
   = note: see issue #80896 <https://github.com/rust-lang/rust/issues/80896> for more information
   = help: add `#![feature(intra_doc_pointers)]` to the crate attributes to enable
   = note: rustdoc does not allow disambiguating between `*const` and `*mut`, and pointers are unstable until it does

error: aborting due to previous error

For more information about this error, try `rustc --explain E0658`.
error: could not document `pin-utils`

Caused by:
  process didn't exit successfully: `rustdoc --edition=2018 --crate-type lib --crate-name pin_utils /home/carado/.cargo/registry/src/github.com-1ecc6299db9ec823/pin-utils-0.1.0/src/lib.rs --cap-lints allow -o /home/carado/tmp/rust33/target/doc --error-format=json --json=diagnostic-rendered-ansi -L dependency=/home/carado/tmp/rust33/target/debug/deps --crate-version 0.1.0` (exit code: 1)
~/tmp/rust33 $ cargo --version
cargo 1.51.0-nightly (ab64d1393 2021-02-10)
~/tmp/rust33 $ rustc --version
rustc 1.52.0-nightly (0148b971c 2021-02-18)
~/tmp/rust33 $ rustdoc --version
rustdoc 1.52.0-nightly (0148b971c 2021-02-18)

Activity

  1. taiki-e commented on Feb 19, 2021

    @taiki-e
    Member
    error[E0658]: linking to associated items of raw pointers is experimental
      --> /home/carado/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/core/src/ptr/metadata.rs:51:23
       |
    51 | /// [`to_raw_parts`]: *const::to_raw_parts
       |                       ^^^^^^^^^^^^^^^^^^^^
       |
       = note: see issue #80896 <https://github.com/rust-lang/rust/issues/80896> for more information
       = help: add `#![feature(intra_doc_pointers)]` to the crate attributes to enable
       = note: rustdoc does not allow disambiguating between `*const` and `*mut`, and pointers are unstable until it does
    

    The problem seems to be occurring in core::ptr, and unrelated to pin-utils. cc @Nemo157

    maybe related to rust-lang/rust#81172

  2. Nemo157 commented on Feb 19, 2021

    @Nemo157
    Contributor
  3. taiki-e commented on Feb 19, 2021

    @taiki-e
    Member

    closing in favor of the upstream issue.

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

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions