Skip to content

"cargo doc": error: could not document rustix v0.36.11 #109631

Closed
#109500
Closed
"cargo doc": error: could not document rustix v0.36.11#109631
#109500
Assignees
petrochenkov
Labels
A-intra-doc-linksArea: Intra-doc links, the ability to link to items in docs by nameC-bugCategory: This is a bug.I-ICEIssue: The compiler panicked, giving an Internal Compilation Error (ICE) ❄️T-compilerRelevant to the compiler team, which will review and decide on the PR/issue.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Description

@fekerr
fekerr
opened on Mar 26, 2023

Experimenting with Rocket and learning Rust. Updating this issue is a work in progress.

fekerr@LAPTOP:~/src/boing001$ cat Cargo.toml

[package]
name = "boing001"
version = "0.1.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
# rocket = "0.4.11"
rocket = "0.5.0-rc.3"

Code

<code>
fekerr@LAPTOP:~/src/boing001$ cat src/main.rs
// 20230325 fekerr
// main.rs
//
// traitobj crate - issues in future?

// Rocket requires rustc nightly, and these two lines.
#![feature(proc_macro_hygiene, decl_macro)]
#[macro_use] extern crate rocket;

fn main() {
    println!("Hello, world!");
}

Meta

rustc --version --verbose:

 rustc --version --verbose
rustc 1.70.0-nightly (1459b3128 2023-03-23)
binary: rustc
commit-hash: 1459b3128e288a85fcc4dd1fee7ada2cdcf28794
commit-date: 2023-03-23
host: x86_64-unknown-linux-gnu
release: 1.70.0-nightly
LLVM version: 15.0.7

Error output

<output>

cargo doc 2> cargo_doc.txt
[cargo_doc.txt](https://github.com/rust-lang/rust/files/11071785/cargo_doc.txt)
Backtrace 


<backtrace>

fekerr@LAPTOP:~/src/boing001$ RUST_BACKTRACE=1 cargo build 2> cargo_build_rbt1.txt
fekerr@LAPTOP:~/src/boing001$ RUST_BACKTRACE=1 cargo build 2> cargo_doc_rbt1.txt
[cargo_build_rbt1.txt](https://github.com/rust-lang/rust/files/11071820/cargo_build_rbt1.txt)
[cargo_doc_rbt1.txt](https://github.com/rust-lang/rust/files/11071821/cargo_doc_rbt1.txt)

Activity

  1. fekerr
    added
    C-bugCategory: This is a bug.
    I-ICEIssue: The compiler panicked, giving an Internal Compilation Error (ICE) ❄️
    T-compilerRelevant to the compiler team, which will review and decide on the PR/issue.
    on Mar 26, 2023

  2. clubby789 commented on Mar 26, 2023

    @clubby789
    clubby789
    on Mar 26, 2023
    Contributor

    Looks like a duplicate of #109614/#109424

    @rustbot label +A-intra-doc-links +T-rustdoc

  3. rustbot
    added
    A-intra-doc-linksArea: Intra-doc links, the ability to link to items in docs by name
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    on Mar 26, 2023

  4. GuillaumeGomez commented on Mar 27, 2023

    @GuillaumeGomez
    GuillaumeGomez
    on Mar 27, 2023
    Member

    #109330 should fix this bug. Just waiting for a final review.

  5. petrochenkov
    self-assigned this
    on Mar 28, 2023

  6. petrochenkov commented on Mar 28, 2023

    @petrochenkov
    petrochenkov
    on Mar 28, 2023
    Contributor

    Not fixed by #109330, but fixed by #109500.

  7. fekerr commented on Mar 31, 2023

    @fekerr
    fekerr
    on Mar 31, 2023
    Author

    rustup update
    cargo update
    cargo doc

    "cargo doc" completes now

    That's literally all I just tried (not the literal commands) - what is the process to close this issue?

  8. GuillaumeGomez commented on Mar 31, 2023

    @GuillaumeGomez
    GuillaumeGomez
    on Mar 31, 2023
    Member

    It'll be closed once #109500 is merged. But I'm surprised it got fixed. When I tested it with my changes, it still failed.

  9. clubby789 commented on Mar 31, 2023

    @clubby789
    clubby789
    on Mar 31, 2023
    Contributor

    cargo update may have caused an update to a dependency so you no longer had the buggy rustix

  10. fekerr commented on Apr 1, 2023

    @fekerr
    fekerr
    on Apr 1, 2023
    Author

    diff Cargo.toml ../boing002/Cargo.toml
    9d8
    < # rocket = "0.4.11"
    10a10,12

    serde = { version = "1.0", features = ["derive"] }
    serde_json = "1.0"
    fnv = "1.0"

  11. fekerr commented on Apr 1, 2023

    @fekerr
    fekerr
    on Apr 1, 2023
    Author

    cargo doc fails in this tree:

    :~/src/boing001$ cat Cargo.toml
    [package]
    name = "boing001"
    version = "0.1.0"
    edition = "2021"

    See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

    [dependencies]

    rocket = "0.4.11"

    rocket = "0.5.0-rc.3"

  12. fekerr commented on Apr 1, 2023

    @fekerr
    fekerr
    on Apr 1, 2023
    Author

    Does not fail in this tree:

    ~/src/boing002$ cat Cargo.toml
    [package]
    name = "boing001"
    version = "0.1.0"
    edition = "2021"

    See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

    [dependencies]
    rocket = "0.5.0-rc.3"
    serde = { version = "1.0", features = ["derive"] }
    serde_json = "1.0"
    fnv = "1.0"

  13. fekerr commented on Apr 1, 2023

    @fekerr
    fekerr
    on Apr 1, 2023
    Author

    main.rs in boing001 is just this:

    // 20230325 fekerr
    // main.rs
    //
    // traitobj crate - issues in future?

    // Rocket requires rustc nightly, and these two lines.
    #![feature(proc_macro_hygiene, decl_macro)]
    #[macro_use] extern crate rocket;

    fn main() {
    println!("Hello, world!");
    }

  14. fekerr commented on Apr 1, 2023

    @fekerr
    fekerr
    on Apr 1, 2023
    Author

    $ grep -i rustix fekerr@LAPTOP\ ~srcboing003src.txt
    Updating rustix v0.37.5 -> v0.37.6
    Downloaded rustix v0.37.6
    Compiling rustix v0.37.6
    Documenting rustix v0.37.6
    Compiling rustix v0.37.6
    Compiling rustix v0.36.11
    Documenting rustix v0.36.11
    error: could not document rustix
    process didn't exit successfully: rustdoc --edition=2018 --crate-type lib --crate-name rustix /home/fekerr/.cargo/registry/src/index.crates.io-6f17d22bba15001f/rustix-0.36.11/src/lib.rs --cap-lints allow -o /home/fekerr/src/boing001/target/doc --cfg 'feature="default"' --cfg 'feature="fs"' --cfg 'feature="io-lifetimes"' --cfg 'feature="libc"' --cfg 'feature="std"' --cfg 'feature="termios"' --cfg 'feature="use-libc-auxv"' --error-format=json --json=diagnostic-rendered-ansi,artifacts,future-incompat --diagnostic-width=108 -C metadata=ff3e1caa83851d6d -L dependency=/home/fekerr/src/boing001/target/debug/deps --extern bitflags=/home/fekerr/src/boing001/target/debug/deps/libbitflags-f75283d3dcd3daad.rmeta --extern io_lifetimes=/home/fekerr/src/boing001/target/debug/deps/libio_lifetimes-0e896a4daa128e32.rmeta --extern libc=/home/fekerr/src/boing001/target/debug/deps/liblibc-8aab922602f2fc15.rmeta --extern linux_raw_sys=/home/fekerr/src/boing001/target/debug/deps/liblinux_raw_sys-a31463b73c270e13.rmeta --crate-version 0.36.11 --cfg rustc_attrs --cfg linux_raw --cfg core_intrinsics --cfg asm (exit status: 101)
    Compiling rustix v0.37.6
    Documenting rustix v0.37.6
    Compiling rustix v0.37.6
    Documenting rustix v0.37.6
    Compiling rustix v0.37.6
    Documenting rustix v0.37.6

  15. fekerr commented on Apr 8, 2023

    @fekerr
    fekerr
    on Apr 8, 2023
    Author

    I doubt I'm really contributing anything here, but a cargo new with just rustix dependency. (I need to look up how to find the available versions of rustix if it's worth narrowing down any further.)

    "cargo doc" fails with rustix 0.36.11, doesn't fail with 0.37.9.

    [package]
name = "rustix_doc_test"
version = "0.1.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
# 37.9 works with "cargo doc"
# rustix = "0.37.9"

rustix = "0.36.11"
  16. fekerr
    changed the title [-]"cargo doc": error: could not document `rustix`[/-] [+]"cargo doc": error: could not document `rustix` v0.36.11[/+] on Apr 9, 2023
  17. bors
    added a commit that references this issue on Apr 9, 2023

    Auto merge of rust-lang#109500 - petrochenkov:modchainld, r=oli-obk

    7201301
  18. bors
    closed this as completedin 7201301on Apr 9, 2023
  19. thomcc
    added a commit that references this issue on Jun 1, 2023

    Auto merge of #109500 - petrochenkov:modchainld, r=oli-obk

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

Metadata

Metadata

Assignees

Labels

A-intra-doc-linksArea: Intra-doc links, the ability to link to items in docs by nameC-bugCategory: This is a bug.I-ICEIssue: The compiler panicked, giving an Internal Compilation Error (ICE) ❄️T-compilerRelevant to the compiler team, which will review and decide on the PR/issue.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