github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-23 14:07:42 +00:00
Code Issues Projects Releases Wiki Activity

Getting Started Guide: add build instructions for the ACRN tools

Browse Source 
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>
This commit is contained in:
Geoffroy Van Cutsem 2018-05-23 13:58:43 +02:00 committed by David Kinder
parent f4b9412013
commit 81a2496218
1 changed files with 57 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
doc/getting_started/index.rst
View File

@ -374,7 +374,15 @@ each with their own way to install development tools:
gnu-efi \ gnu-efi \
libssl-dev \ libssl-dev \
libpciaccess-dev \ libpciaccess-dev \
uuid-dev uuid-dev \
libsystemd-dev \
libevent-dev \
libxml2-dev \
libusb-1.0-0-dev
.. note::
Ubuntu 14.04 requires ``libsystemd-journal-dev`` instead of ``libsystemd-dev``
as indicated above.
* On a Fedora/Redhat development system: * On a Fedora/Redhat development system:
@ -384,7 +392,12 @@ each with their own way to install development tools:
gnu-efi-devel \ gnu-efi-devel \
libuuid-devel \ libuuid-devel \
openssl-devel \ openssl-devel \
libpciaccess-devel libpciaccess-devel \
systemd-devel \
libxml2-devel \
libevent-devel \
libusbx-devel
* On a CentOS development system: * On a CentOS development system:
@ -394,17 +407,46 @@ each with their own way to install development tools:
gnu-efi-devel \ gnu-efi-devel \
libuuid-devel \ libuuid-devel \
openssl-devel \ openssl-devel \
libpciaccess-devel libpciaccess-devel \
systemd-devel \
libxml2-devel \
libevent-devel \
libusbx-devel
Build the hypervisor and device model
=====================================
#. Download the ACRN hypervisor and build it. Build the hypervisor, device model and tools
============================================
The `acrn-hypervisor <https://github.com/projectacrn/acrn-hypervisor/>`_
repository has three main components in it:
1. The ACRN hypervisor code located in the ``hypervisor`` directory
#. The ACRN devicemodel code located in the ``devicemodel`` directory
#. The ACRN tools source code located in the ``tools`` directory
You can build all these components in one go as follows:
.. code-block:: console .. code-block:: console
$ git clone https://github.com/projectacrn/acrn-hypervisor $ git clone https://github.com/projectacrn/acrn-hypervisor
$ cd acrn-hypervisor/hypervisor $ cd acrn-hypervisor
$ make
The build results are found in the ``build`` directory.
.. note::
if you wish to use a different target folder for the build
artefacts, set the ``O`` (that is capital letter 'O') to the
desired value. Example: ``make O=build-uefi PLATFORM=uefi``.
You can also build these components individually. The following
steps assume that you have already cloned the ``acrn-hypervisor`` repository
and are using it as the current working directory.
#. Build the ACRN hypervisor.
.. code-block:: console
$ cd hypervisor
$ make PLATFORM=uefi $ make PLATFORM=uefi
The build results are found in the ``build`` directory. The build results are found in the ``build`` directory.
@ -418,5 +460,12 @@ Build the hypervisor and device model
The build results are found in the ``build`` directory. The build results are found in the ``build`` directory.
#. Build the ACRN tools (included in the acrn-hypervisor repo):
.. code-block:: console
$ cd ../tools
$ for d in */; do make -C "$d"; done
Follow the same instructions to boot and test the images you created Follow the same instructions to boot and test the images you created
from your build. from your build.