rust-lang / rust-lang/docs.rs

Docs not built on target platform, causing failures

Open
#1,957 13 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-builds E-hard
Dominant language
Rust
Stars
1.2k
Forks
232
Avg merge
11h 35m
Merged PRs (30d)
60

Description

Crate name

getargv

Build failure link

https://docs.rs/crate/getargv/0.1.1/builds/701636

Additional details

This crate has a dep getargv-sys which requires an apple OS to build, I specify:

[package.metadata.docs.rs]
targets = ["x86_64-apple-darwin", "aarch64-apple-darwin"]

In both crates' Cargo.toml; but when docs.rs builds the getargv crate, the getargv-sys crate is built with an incompatible system/command.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked docs.rs build failure and the [package.metadata.docs.rs] sections in getargv and getargv-sys Cargo.toml files. Trace how the getargv-sys dependency is built for the x86_64-apple-darwin and aarch64-apple-darwin targets. Done means both documented target builds complete without the incompatible system or command failure.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.