rust-lang / rust-lang/rust

No documentation for minimal and maximal LLVM versions supported

Open
#131,588 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-docs
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

Location

Nowhere

Summary

When I build rustc with the local llvm, I want to know with what external LLVM versions will rustc work.

https://github.com/rust-lang/rust/pull/122649 upgrades in March the minimum external LLVM version to 17.
https://github.com/rust-lang/rust/pull/127513 updates in July LLVM to version 19.

But the above links do not touch the user-visible documentation. For me it is unclear, if I want to compile rust 1.82 later, if I can use LLVM 18, or I must use LLVM 19. I find no place, where this is documented.

  • Document the minimal and maximal versions for external LLVM supported by rustc.

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

Start by reading the linked pull requests #122649 and #127513 and searching the repository for existing user-facing LLVM version documentation. Document the minimum and maximum external LLVM versions supported by rustc, including the version information relevant to the cited releases, and verify that users can find it.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.