Skip to content

doc: install rust 1.95#6779

Open
amd-arosa wants to merge 1 commit into
mainfrom
users/arosa/doc-rustup
Open

doc: install rust 1.95#6779
amd-arosa wants to merge 1 commit into
mainfrom
users/arosa/doc-rustup

Conversation

@amd-arosa

@amd-arosa amd-arosa commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

@amd-arosa
amd-arosa requested review from ScottTodd and marbre and removed request for marbre July 22, 2026 16:16
@therock-pr-bot

therock-pr-bot Bot commented Jul 22, 2026

Copy link
Copy Markdown

✅ All Checks Passed — Ready for Review

Check Status Details
🌿 Branch Name ✅ Pass
📝 PR Title/Description ✅ Pass
Forbidden Files ✅ Pass
🧪 Unit Test ✅ Pass PR does not contain code files — Unit Test auto-passed
🔎 pre-commit ✅ Pass
🚫 Draft PR 🔜 To Be Enabled
🚩 Feature Flag 🔜 To Be Enabled
📊 Code Coverage 🔜 To Be Enabled
🤖 therock-pr-bot ✅ Pass

🎉 All checks passed! This PR is ready for review.

📖 Need help? See the Policy FAQ for details on every check and how to fix failures.

@therock-pr-bot therock-pr-bot Bot added the Not ready to Review PR has unresolved policy failures — reviews blocked label Jul 22, 2026
@therock-pr-bot

therock-pr-bot Bot commented Jul 22, 2026

Copy link
Copy Markdown

🎉 All checks passed! This PR is ready for review.

@therock-pr-bot therock-pr-bot Bot removed the Not ready to Review PR has unresolved policy failures — reviews blocked label Jul 22, 2026

@ScottTodd ScottTodd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I edited more details into the PR description.

  • You can remove fields from the template that aren't applicable like "test plan" for docs changes
  • PRs by definition close themselves, text like Closes #6779 to satisfy the PR policy bot are invalid. This PR does actually address #6418, so I added a link to that instead

Comment on lines +201 to +208
> winget install --id Rustlang.Rustup --exact --source winget
> # Open a new terminal before running the remaining commands.
> rustup install 1.95
> ```

Rust 1.95 and Cargo are general build dependencies. The `rustup` installation
provides both tools. Open a new terminal after installation if `rustup`,
`rustc`, or `cargo` is not immediately available on `PATH`.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Source builds of Mirage are not currently enabled on Windows. Do you still want to add this requirement here?

TheRock/BUILD_TOPOLOGY.toml

Lines 822 to 827 in 0f2827e

[artifacts.mirage]
artifact_group = "rocjitsu"
type = "target-neutral"
artifact_deps = []
feature_group = "EMULATION"
disable_platforms = ["windows"]

Comment on lines +20 to +47
## Required Build Toolchains

### Rust 1.95

Rust 1.95 and Cargo are general build dependencies on Linux and Windows. Install
the required toolchain with [`rustup`](https://rustup.rs/).

On Linux:

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | \
sh -s -- --default-toolchain 1.95.0
source "$HOME/.cargo/env"
rustc --version
cargo --version
```

On Windows:

```powershell
winget install --id Rustlang.Rustup --exact --source winget
# Open a new terminal before running the remaining commands.
rustup install 1.95
rustc --version
cargo --version
```

If `rustup` is already installed, only `rustup install 1.95` is needed.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation like this should go below Reference Build Environments, not above it. The reference build environments are containers that already have all prerequisites included.

Comment thread README.md
Comment on lines 110 to +115
# Install dependencies following the Windows support guide

# Install Rust and Cargo through rustup
winget install --id Rustlang.Rustup --exact --source winget
# Open a new terminal before running the remaining commands.
rustup install 1.95

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Omit from here

  • "Install dependencies following the Windows support guide" already covers other deps (like MSVC), rust is not worth calling out on its own here
  • Rust is not currently used on Windows anyways?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: TODO

Development

Successfully merging this pull request may close these issues.

docs: cargo is an undocumented build dependency for the mirage emulation component

2 participants