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

[fekerr]

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)

[clubby789]

Looks like a duplicate of #109614/#109424

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

[GuillaumeGomez]

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

[petrochenkov]

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

[fekerr]

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?

[GuillaumeGomez]

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.

[clubby789]

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

[fekerr]

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"

[fekerr]

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"

[fekerr]

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"

[fekerr]

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!");
}

[fekerr]

$ 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

[fekerr]

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"