Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for wasmer 3 fails to build for docs.rs #3066

Closed
silwol opened this issue Aug 2, 2022 · 0 comments · Fixed by #3069
Closed

Documentation for wasmer 3 fails to build for docs.rs #3066

silwol opened this issue Aug 2, 2022 · 0 comments · Fixed by #3069
Assignees
Labels
bug Something isn't working priority-medium Medium priority issue
Milestone

Comments

@silwol
Copy link
Contributor

silwol commented Aug 2, 2022

Describe the bug

https://docs.rs/ contains documentation built for all crates that are published on https://crates.io/. Their infrastructure attempts to build the documentation, but that failed for wasmer 3.0.0-alpha.4. I consider API documentation availability on https://docs.rs/ very important, as it's the go-to location for many who want to develop something against a crate API. Therefore we should get it working with one of the 3.0 pre-releases in order to be certain we have a proper docs.rs rendering for the final release.

Additional context

The log of the failed build can be found here. Pasting here because I don't know anything about retention of the logs at https://docs.rs/

# rustc version
rustc 1.64.0-nightly (9067d5277 2022-07-28)
# docs.rs version
docsrs 0.6.0 (f9ffabd 2022-07-24)

# build log
[INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace/builds/wasmer-3.0.0-alpha.4/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/wasmer-3.0.0-alpha.4/source:/opt/rustwide/workdir:ro,Z" "-v" "/home/cratesfyi/workspace/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/home/cratesfyi/workspace/rustup-home:/opt/rustwide/rustup-home:ro,Z" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "DOCS_RS=1" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "-m" "3221225472" "--cpus" "3" "--user" "1001:1001" "--network" "none" "ghcr.io/rust-lang/crates-build-env/linux@sha256:ecb52c4cf6672b83cc996368a05b4a059042425f2b6ba9cd23a06cdead5d8d70" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "--features" "compiler core cranelift engine jit native singlepass sys sys-default" "-Z" "unstable-options" "--config" "build.rustdocflags=[\"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20220728-1.64.0-nightly-9067d5277\", \"--static-root-path\", \"/\", \"--cap-lints\", \"warn\", \"--disable-per-crate-search\", \"--extern-html-root-takes-precedence\"]" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs/{pkg_name}/{version}/x86_64-unknown-linux-gnu\"" "-j3" "--target" "x86_64-unknown-linux-gnu", kill_on_drop: false }`
[INFO] [stdout] ff14961d8d3a166d7846b0b602ba350465903e6b288195a048dec7ed1b1376b0
[INFO] [stderr] WARNING: Your kernel does not support swap limit capabilities or the cgroup is not mounted. Memory limited without swap.
[INFO] running `Command { std: "docker" "start" "-a" "ff14961d8d3a166d7846b0b602ba350465903e6b288195a048dec7ed1b1376b0", kill_on_drop: false }`
[INFO] [stderr] error: none of the selected packages contains these features: native
[INFO] running `Command { std: "docker" "inspect" "ff14961d8d3a166d7846b0b602ba350465903e6b288195a048dec7ed1b1376b0", kill_on_drop: false }`
[INFO] running `Command { std: "docker" "rm" "-f" "ff14961d8d3a166d7846b0b602ba350465903e6b288195a048dec7ed1b1376b0", kill_on_drop: false }`
[INFO] [stdout] ff14961d8d3a166d7846b0b602ba350465903e6b288195a048dec7ed1b1376b0

I assume the relevant message is this:
[INFO] [stderr] error: none of the selected packages contains these features: native

@silwol silwol added the bug Something isn't working label Aug 2, 2022
@syrusakbary syrusakbary added this to the v3.0 milestone Aug 3, 2022
@syrusakbary syrusakbary added the priority-medium Medium priority issue label Aug 3, 2022
bors bot added a commit that referenced this issue Aug 4, 2022
3069: Remove native feature entry from docs.rs metadata r=silwol a=silwol

The native feature is no longer present, but was still in the list of
features to be enabled when building the documentation for docs.rs,
causing the build there to fail. Removal should re-enable the build of
the documentation for docs.rs.

Closes: #3066

Co-authored-by: Wolfgang Silbermayr <[email protected]>
@bors bors bot closed this as completed in 42bb6b0 Aug 4, 2022
ptitSeb pushed a commit that referenced this issue Oct 20, 2022
The native feature is no longer present, but was still in the list of
features to be enabled when building the documentation for docs.rs,
causing the build there to fail. Removal should re-enable the build of
the documentation for docs.rs.

Closes: #3066
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working priority-medium Medium priority issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants