rust-lang / rust-lang/socket2

Documentation for x86_64-unknown-linux-gnu is missing from `docs.rs`

Open
#562 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
870
Forks
305
PR merge metrics
No merged PRs in 30d

Description

The current documentation on docs.rs is missing the x86_64-unknown-linux-gnu platform: https://docs.rs/socket2/0.5.8/socket2/

The documentation build logs can be seen at https://docs.rs/crate/socket2/0.5.8/builds

Key takeaways:

A new documentation build was run on 2025-02-22. An older build for the same version 0.5.8 was run on 2024-11-27.

Both builds include 11 platforms. Cargo.toml lists 14 platforms as targets for documentation. The most recent build is missing x86_64-unknown-linux-gnu, the older build has that platform but is missing other platforms.

I don't see any information that docs.rs is limited to 11 platforms. But there is a very old mention that it's limited to 10 platforms: https://github.com/rust-windowing/winit/issues/1028#issuecomment-607882907

Contributor guide

Open the contributing guide

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

Inspect Cargo.toml's documentation targets and compare them with the two docs.rs build logs linked in the issue. Determine why x86_64-unknown-linux-gnu is omitted and verify the fix by confirming that the target appears in a subsequent docs.rs build.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation, networking
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.