Skip to content

[doc] Add OS notes - #284

Open
yangrongwei wants to merge 1 commit into
OpenDevicePartnership:mainfrom
uefi-lab:yangrongwei-patch-1
Open

[doc] Add OS notes#284
yangrongwei wants to merge 1 commit into
OpenDevicePartnership:mainfrom
uefi-lab:yangrongwei-patch-1

Conversation

@yangrongwei

@yangrongwei yangrongwei commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Description

Highlight the OS environment to run the QemuArmVirtPkg

  • Impacts functionality?
  • Impacts security?
  • Breaking change?
  • Includes tests?
  • Includes documentation?

How This Was Tested

Documentation change only

Integration Instructions

N/A

@github-actions github-actions Bot added the impact:non-functional Does not have a functional impact label Jul 2, 2026
@yangrongwei

yangrongwei commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

To run QemuArmVirtPkg on WSL, I was stuck on the QEMU setup for quite some time. Although I first encountered the issue in 2025, I only found the correct solution last month after reviewing the devcontainer configuration. I then built QEMU v10.2.3 from source.

I really think this update should be included in our documentation.

Cross ref issue
#275

@yangrongwei yangrongwei changed the title add OS notes [doc] Add OS notes Jul 2, 2026
command line.
```

(As of 2026-07)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'd remove the data note. To me, it implies staleness with time, even if it's still accurate.

```

(As of 2026-07)
The officially supported way to build is using the [devcontainer](https://github.com/OpenDevicePartnership/patina-qemu/blob/main/.devcontainer/devcontainer.json) specified in the repo which currently uses Ubuntu 24.04

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we should make this a full section calling out the specific dev container, using this in vscode, etc.

To me it would be more helpful to explain what is supported then try to explain what may not be supported, mostly because we are going to keep our support up-to-date (or at least should), but things that are not supported are going to become stale, such as the support called out below in 24.04.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I agree more information about the container should be given. Also consider moving the container information to its own file and link from here. That way this file does not get too bloated, and the container info can be linked as a standalone reference from other places.

@github-actions github-actions Bot added the type:documentation Improvements or additions to documentation label Jul 2, 2026
@makubacki

Copy link
Copy Markdown
Collaborator

@yangrongwei, are you planning to return to this PR?

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

Labels

impact:non-functional Does not have a functional impact type:documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants