Skip to content

guide: add instructions for running linux direct#2875

Merged
mattkur merged 5 commits intomicrosoft:mainfrom
mattkur:guide-run-direct
Mar 9, 2026
Merged

guide: add instructions for running linux direct#2875
mattkur merged 5 commits intomicrosoft:mainfrom
mattkur:guide-run-direct

Conversation

@mattkur
Copy link
Contributor

@mattkur mattkur commented Mar 3, 2026

Like #2874, but for linux direct.

It took me a few minutes to figure out something that should be in the guide. So, add it.

@mattkur mattkur requested a review from a team as a code owner March 3, 2026 06:30
Copilot AI review requested due to automatic review settings March 3, 2026 06:30
@github-actions github-actions bot added the Guide label Mar 3, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds documentation to the OpenVMM guide showing how to run OpenHCL in Linux direct boot mode from a locally built test IGVM, similar to PR #2874 which added instructions for specifying a UEFI firmware file.

Changes:

  • Adds a new "OpenHCL, via Linux Direct Boot" section in Guide/src/user_guide/openvmm/run.md with a build command, a PowerShell run command, and an admonish warning about the necessity of serial terminals when using rdinit=/bin/sh.

mattkur and others added 2 commits March 3, 2026 11:32
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@github-actions
Copy link

github-actions bot commented Mar 3, 2026

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

- Simplify command: only --vmbus-com1-serial is required for VTL0 boot,
  --com3 is optional (for VTL2 debug output), --vmbus-com2-serial removed
- Update admonish warning to clarify which flag is required and why
- Add tip about cargo xflowey build-igvm as faster alternative

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

```admonish tip
If you only need the IGVM binary (and already have `openvmm.exe`), you can
use `cargo xflowey build-igvm` instead — it's faster than building the full
Copy link
Contributor

Choose a reason for hiding this comment

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

At some point we need to rewrite xflowey vmm-tests to only rebuild the things needed for the tests you specify instead of building the world. All the wiring is there, someone just needs to do it...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think @chris-oo has something like this in progress. I will say: a rebuild of vmm-tests is pretty quick. It's the initial build (and downloading the vhd deps) that gets ya.

Copy link
Contributor

Choose a reason for hiding this comment

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

We've had two people get to 'in progress', but nobody's gotten to 'done' yet lol

@mattkur
Copy link
Contributor Author

mattkur commented Mar 9, 2026

Addressed both review threads in f6e06b8:

@chris-oo (terminal requirement): You were right — tested today and confirmed only --vmbus-com1-serial is needed for VTL0 to boot. --com3 and --vmbus-com2-serial are optional (useful for debugging but not required). Updated the example and the admonish warning accordingly.

@smalis-msft (build-igvm): Added a tip noting cargo xflowey build-igvm as a faster alternative when you already have openvmm.exe.

@mattkur mattkur enabled auto-merge (squash) March 9, 2026 17:52
@mattkur mattkur merged commit dd819b0 into microsoft:main Mar 9, 2026
56 checks passed
@mattkur mattkur deleted the guide-run-direct branch March 9, 2026 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants