rust-lang / rust-lang/rust

Documentation differ when Rust is build on i386 Solaris vs SPARC Solaris

Open
#124,843 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-docs C-bug T-libs T-rustdoc
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

On i386 Solaris it contains following files which are not generated for SPARC Solaris:

usr/share/doc/rust/html/core/arch/aarch64/fn\.v.*\.html
usr/share/doc/rust/html/core/arch/aarch64/struct\.(f|i|p|u).*
usr/share/doc/rust/html/core/arch/arm/fn\.v.*\.html
usr/share/doc/rust/html/core/arch/arm/struct\.(f|u?int64|u?int32|u?int16x4|u?int16x8|u?int8x16|u?int8x8|p).*
usr/share/doc/rust/html/core/core_arch/aarch64/neon/fn\.v.*\.html
usr/share/doc/rust/html/core/core_arch/aarch64/neon/generated/fn\.v.*\.html
usr/share/doc/rust/html/core/core_arch/aarch64/neon/struct\.(f|i|p|u).*
usr/share/doc/rust/html/core/core_arch/arm/neon/fn\.v.*\.html
usr/share/doc/rust/html/core/core_arch/arm_shared/crypto/fn\.v.*\.html
usr/share/doc/rust/html/core/core_arch/arm_shared/neon/generated/fn\.v.*\.html
usr/share/doc/rust/html/core/core_arch/arm_shared/neon/fn\.v.*\.html
usr/share/doc/rust/html/core/core_arch/arm_shared/neon/struct\.(f|i|p|u).*
usr/share/doc/rust/html/src/core/portable-simd/crates/core_simd/src/vendor/x86\.rs\.html
usr/share/doc/rust/html/src/core/stdarch/crates/core_arch/src/aarch64/neon/.*
usr/share/doc/rust/html/src/core/stdarch/crates/core_arch/src/arm_shared/crypto\.rs\.html
usr/share/doc/rust/html/src/core/stdarch/crates/core_arch/src/arm_shared/neon/.*
usr/share/doc/rust/html/src/core/stdarch/crates/core_arch/src/arm/neon\.rs\.html

On the other hand SPARC Solaris contains following files with are not generated for i386 Solaris:

usr/share/doc/rust/html/std/os/linux/raw/arch/fn.stat.html
usr/share/doc/rust/html/std/os/linux/raw/fn.stat.html

This is causing some problems during packaging. But mainly I would like to know why is this happening...

The above files are valid with Rust 1.78 but previous versions did have similar issues.

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

Compare the listed generated documentation paths between i386 Solaris and SPARC Solaris, using the Rust 1.78 behavior as the reference point. Trace the documentation generation and packaging inputs for the affected core, std, ARM, AArch64, and x86 sources; done means explaining the architecture-dependent differences and identifying a consistent packaging result.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system, documentation
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.