Skip to content

Commit

Permalink
ArmVirtPkg: Fix MarkdownLint issues in Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Bret Barkelew authored and kenlautner committed Dec 19, 2023
1 parent bcb69c8 commit 6eac241
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions ArmVirtPkg/PlatformCI/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,25 +113,25 @@ the generic set of edk2 [Build Instructions](https://github.com/tianocore/tianoc
1. Including the expected build architecture and toolchain to the _stuart_update_ command is critical.
This is because there are extra scopes and tools that will be resolved during the update step that
need to match your build step.
2. Configuring *ACTIVE_PLATFORM* and *TARGET_ARCH* in Conf/target.txt is **not** required. This
2. Configuring _ACTIVE_PLATFORM_ and _TARGET_ARCH_ in Conf/target.txt is **not** required. This
environment is set by PlatformBuild.py based upon the `[-a <TARGET_ARCH>]` parameter.
3. QEMU must be on your path. On Windows this is a manual process and not part of the QEMU installer.

**NOTE:** Logging the execution output will be in the normal stuart log as well as to your console.

### Custom Build Options

**MAKE_STARTUP_NSH=TRUE** will output a *startup.nsh* file to the location mapped as fs0. This is
**MAKE_STARTUP_NSH=TRUE** will output a _startup.nsh_ file to the location mapped as fs0. This is
used in CI in combination with the `--FlashOnly` feature to run QEMU to the UEFI shell and then execute
the contents of *startup.nsh*.
the contents of _startup.nsh_.

**QEMU_HEADLESS=TRUE** Since CI servers run headless QEMU must be told to run with no display otherwise
an error occurs. Locally you don't need to set this.
### Passing Build Defines
To pass build defines through _stuart_build_, prepend `BLD_*_`to the define name and pass it on the
command-line. _stuart_build_ currently requires values to be assigned, so add an`=1` suffix for bare defines.
command-line. `stuart_build` currently requires values to be assigned, so add an `=1` suffix for bare defines.
For example, to enable the TPM2 support, instead of the traditional "-D TPM2_ENABLE=TRUE", the stuart_build
command-line would be:
Expand Down

0 comments on commit 6eac241

Please sign in to comment.