guide: add instructions on specifying a UEFI firmware file#2874
Merged
mattkur merged 4 commits intomicrosoft:mainfrom Mar 5, 2026
Merged
guide: add instructions on specifying a UEFI firmware file#2874mattkur merged 4 commits intomicrosoft:mainfrom
mattkur merged 4 commits intomicrosoft:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation clarifying how to provide a UEFI firmware image when running OpenVMM outside of cargo run, which otherwise sets firmware-related environment variables automatically via .cargo/config.toml.
Changes:
- Add a new “UEFI firmware required when running outside cargo” tip block to the “Running OpenVMM” guide with example invocation and common firmware paths.
- Update the CLI reference to document
--uefi-firmwareand its relationship to environment-variable defaults.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| Guide/src/user_guide/openvmm/run.md | Adds a tip explaining why --uefi-firmware is needed outside cargo run, with example usage and firmware locations. |
| Guide/src/reference/openvmm/management/cli.md | Documents the --uefi-firmware flag and its defaulting behavior via environment variables. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
smalis-msft
reviewed
Mar 4, 2026
smalis-msft
reviewed
Mar 4, 2026
smalis-msft
approved these changes
Mar 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I found myself confused when running openvmm to boot from a VHD with a UEFI formware. So, add a note in the guide.