Commit 1d3c1150 authored by Martí Bolívar's avatar Martí Bolívar Committed by Anas Nashif
Browse files

boards: x86_jailhouse: fix build documentation 



The build documentation for this board is misleading. It says to "set
JAILHOUSE_QEMU_IMG_FILE", *then* run cmake commands. But setting the
variable must be part of the cmake commands themselves. Fix it.

Signed-off-by: default avatarMarti Bolivar <marti@opensourcefoundries.com>
parent 2a7546fb

boards/x86/x86_jailhouse/doc/board.rst

+6 −6
Original line number Diff line number Diff line
@@ -63,20 +63,20 @@ tests in a QEMU emulated environment (we assume the same QEMU 
configuration used to accommodate Jailhouse's configs/qemu-x86.c root

cell configuration).



For example, with the :ref:`synchronization_sample`, first set

``JAILHOUSE_QEMU_IMG_FILE`` to the path to the :file:`.qcow2` file.

Then:

For example, with the :ref:`synchronization_sample`:



.. zephyr-app-commands::

   :zephyr-app: samples/synchronization

   :board: x86_jailhouse

   :goals: run

   :gen-args: -DJAILHOUSE_QEMU_IMG_FILE=some/valid.qcow2

   :goals: build run



This assumes the user has the binary qemu-system-x86_64 in their

system (not provided by Zephyr's toolchain). This is because the base

system here will be 64-bit and Zephyr will boot as a virtual guest in

it. The qcow2 image must contain the base image with Jailhouse

installed (not provided by Zephyr's SDK, again).

it. The variable ``JAILHOUSE_QEMU_IMG_FILE`` is the path to a

:file:`.qcow2` file. This qcow2 image must contain the base image with

Jailhouse installed (not provided by Zephyr's SDK, again).



This will build an image with the synchronization sample app and mount

the current directory inside QEMU under /mnt.

CRA Git | Maintained and supported by SUSTech CRA and CCSE