Skip to content

Commit 81a2496

Browse files
Geoffroy Van Cutsemdbkinder
authored andcommitted
Getting Started Guide: add build instructions for the ACRN tools
This adds basic information about the new ACRN tools that have been integrated in the the acrn-hypervisor repo (under tools/). It also adds the build dependencies for those tools in the different development environment that we reference. Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
1 parent f4b9412 commit 81a2496

File tree

1 file changed

+57
-8
lines changed

1 file changed

+57
-8
lines changed

doc/getting_started/index.rst

Lines changed: 57 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,15 @@ each with their own way to install development tools:
374374
gnu-efi \
375375
libssl-dev \
376376
libpciaccess-dev \
377-
uuid-dev
377+
uuid-dev \
378+
libsystemd-dev \
379+
libevent-dev \
380+
libxml2-dev \
381+
libusb-1.0-0-dev
382+
383+
.. note::
384+
Ubuntu 14.04 requires ``libsystemd-journal-dev`` instead of ``libsystemd-dev``
385+
as indicated above.
378386

379387
* On a Fedora/Redhat development system:
380388

@@ -384,7 +392,12 @@ each with their own way to install development tools:
384392
gnu-efi-devel \
385393
libuuid-devel \
386394
openssl-devel \
387-
libpciaccess-devel
395+
libpciaccess-devel \
396+
systemd-devel \
397+
libxml2-devel \
398+
libevent-devel \
399+
libusbx-devel
400+
388401
389402
* On a CentOS development system:
390403

@@ -394,17 +407,46 @@ each with their own way to install development tools:
394407
gnu-efi-devel \
395408
libuuid-devel \
396409
openssl-devel \
397-
libpciaccess-devel
410+
libpciaccess-devel \
411+
systemd-devel \
412+
libxml2-devel \
413+
libevent-devel \
414+
libusbx-devel
398415
399-
Build the hypervisor and device model
400-
=====================================
401416
402-
#. Download the ACRN hypervisor and build it.
417+
Build the hypervisor, device model and tools
418+
============================================
419+
420+
The `acrn-hypervisor <https://github.com/projectacrn/acrn-hypervisor/>`_
421+
repository has three main components in it:
422+
423+
1. The ACRN hypervisor code located in the ``hypervisor`` directory
424+
#. The ACRN devicemodel code located in the ``devicemodel`` directory
425+
#. The ACRN tools source code located in the ``tools`` directory
426+
427+
You can build all these components in one go as follows:
428+
.. code-block:: console
429+
430+
$ git clone https://github.com/projectacrn/acrn-hypervisor
431+
$ cd acrn-hypervisor
432+
$ make
433+
434+
The build results are found in the ``build`` directory.
435+
436+
.. note::
437+
if you wish to use a different target folder for the build
438+
artefacts, set the ``O`` (that is capital letter 'O') to the
439+
desired value. Example: ``make O=build-uefi PLATFORM=uefi``.
440+
441+
You can also build these components individually. The following
442+
steps assume that you have already cloned the ``acrn-hypervisor`` repository
443+
and are using it as the current working directory.
444+
445+
#. Build the ACRN hypervisor.
403446

404447
.. code-block:: console
405448
406-
$ git clone https://github.com/projectacrn/acrn-hypervisor
407-
$ cd acrn-hypervisor/hypervisor
449+
$ cd hypervisor
408450
$ make PLATFORM=uefi
409451
410452
The build results are found in the ``build`` directory.
@@ -418,5 +460,12 @@ Build the hypervisor and device model
418460
419461
The build results are found in the ``build`` directory.
420462

463+
#. Build the ACRN tools (included in the acrn-hypervisor repo):
464+
465+
.. code-block:: console
466+
467+
$ cd ../tools
468+
$ for d in */; do make -C "$d"; done
469+
421470
Follow the same instructions to boot and test the images you created
422471
from your build.

0 commit comments

Comments
 (0)