Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

QemuPkg: building.md: Update instructions for using QEMU #1013

Merged
merged 5 commits into from
Aug 12, 2024

Conversation

Javagedes
Copy link
Contributor

@Javagedes Javagedes commented Aug 8, 2024

Description

Updates the build instructions for using QEMU on windows and Linux to accurately specify that QEMU is provided automatically on Windows but should manually be downloaded on Linux. Additionally specifies that QEMU 9.0.2 or greater is necessary to boot the operating system on Linux.

Closes #1012

  • Impacts functionality?
    • Functionality - Does the change ultimately impact how firmware functions?
    • Examples: Add a new library, publish a new PPI, update an algorithm, ...
  • Impacts security?
    • Security - Does the change have a direct security impact on an application,
      flow, or firmware?
    • Examples: Crypto algorithm change, buffer overflow fix, parameter
      validation improvement, ...
  • Breaking change?
    • Breaking change - Will anyone consuming this change experience a break
      in build or boot behavior?
    • Examples: Add a new library class, move a module to a different repo, call
      a function in a new library class in a pre-existing module, ...
  • Includes tests?
    • Tests - Does the change include any explicit test code?
    • Examples: Unit tests, integration tests, robot tests, ...
  • Includes documentation?
    • Documentation - Does the change contain explicit documentation additions
      outside direct code modifications (and comments)?
    • Examples: Update readme file, add feature readme file, link to documentation
      on an a separate Web page, ...

How This Was Tested

N/A

Integration Instructions

N/A

@github-actions github-actions bot added impact:non-functional Does not have a functional impact type:documentation Improvements or additions to documentation labels Aug 8, 2024
@Javagedes Javagedes requested a review from os-d August 8, 2024 17:21
Copy link
Contributor

@os-d os-d left a comment

Choose a reason for hiding this comment

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

I think lines 10 -12 need an update, too, since at the beginning it instructs you to go download qemu

Copy link

@eeshanl eeshanl left a comment

Choose a reason for hiding this comment

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

test

Javagedes and others added 5 commits August 12, 2024 14:39
Updates the build instructions for using QEMU on windows and linux to
accurately specify that QEMU is provided automatically on windows, but
should manually be downloaded on linux. Additionally specifies that
QEMU 9.0.2 or greater is necessary to boot the the operationg system
on Linux.
Co-authored-by: Michael Kubacki <[email protected]>
Signed-off-by: Joey Vagedes <[email protected]>
@Javagedes
Copy link
Contributor Author

test

Secondary effect of this, you reminded me I never merged it. Thanks :)

@Javagedes Javagedes merged commit aedfc20 into microsoft:main Aug 12, 2024
31 checks passed
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.

[Documentation]: Update Documentation to Include Qemu Ext Dep Info
5 participants