github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-08-08 03:35:14 +00:00
Code Issues Projects Releases Wiki Activity

doc: add clang-format to setup package list

Browse Source 
clang-format is now used as part of the config tools creating c files
based on the XML configuration

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2021-05-06 15:48:18 -07:00 committed by David Kinder
parent 7c92ac425f
commit 50c1292365
1 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
doc/getting-started/building-from-source.rst
View File

@ -57,7 +57,7 @@ ACRN.
.. code-block:: none .. code-block:: none
$ sudo apt install gcc \ sudo apt install gcc \
git \ git \
make \ make \
libssl-dev \ libssl-dev \
@ -77,14 +77,16 @@ ACRN.
liblz4-tool \ liblz4-tool \
flex \ flex \
bison \ bison \
xsltproc xsltproc \
clang-format
$ sudo pip3 install lxml xmlschema sudo pip3 install lxml xmlschema
$ wget https://acpica.org/sites/acpica/files/acpica-unix-20210105.tar.gz
$ tar zxvf acpica-unix-20210105.tar.gz wget https://acpica.org/sites/acpica/files/acpica-unix-20210105.tar.gz
$ cd acpica-unix-20210105 tar zxvf acpica-unix-20210105.tar.gz
$ make clean && make iasl cd acpica-unix-20210105
$ sudo cp ./generate/unix/bin/iasl /usr/sbin/ make clean && make iasl
sudo cp ./generate/unix/bin/iasl /usr/sbin/
.. rst-class:: numbered-step .. rst-class:: numbered-step
@ -103,7 +105,7 @@ Enter the following to get the ACRN hypervisor source code:
.. code-block:: none .. code-block:: none
$ git clone https://github.com/projectacrn/acrn-hypervisor git clone https://github.com/projectacrn/acrn-hypervisor
.. _build-with-acrn-scenario: .. _build-with-acrn-scenario:
@ -154,26 +156,26 @@ the following to build the hypervisor, device model, and tools:
.. code-block:: none .. code-block:: none
$ make BOARD=nuc7i7dnb SCENARIO=industry make BOARD=nuc7i7dnb SCENARIO=industry
* Build the release version of ``HYBRID`` scenario on the ``whl-ipc-i5``: * Build the release version of ``HYBRID`` scenario on the ``whl-ipc-i5``:
.. code-block:: none .. code-block:: none
$ make BOARD=whl-ipc-i5 SCENARIO=hybrid RELEASE=y make BOARD=whl-ipc-i5 SCENARIO=hybrid RELEASE=y
* Build the release version of ``HYBRID_RT`` scenario on the ``whl-ipc-i7`` * Build the release version of ``HYBRID_RT`` scenario on the ``whl-ipc-i7``
(hypervisor only): (hypervisor only):
.. code-block:: none .. code-block:: none
$ make BOARD=whl-ipc-i7 SCENARIO=hybrid_rt RELEASE=y hypervisor make BOARD=whl-ipc-i7 SCENARIO=hybrid_rt RELEASE=y hypervisor
* Build the release version of the device model and tools: * Build the release version of the device model and tools:
.. code-block:: none .. code-block:: none
$ make RELEASE=y devicemodel tools make RELEASE=y devicemodel tools
You can also build ACRN with your customized scenario: You can also build ACRN with your customized scenario:
@ -182,14 +184,14 @@ You can also build ACRN with your customized scenario:
.. code-block:: none .. code-block:: none
$ make BOARD=nuc6cayh SCENARIO=/path/to/scenario.xml make BOARD=nuc6cayh SCENARIO=/path/to/scenario.xml
* Build with your own board and scenario configuration, assuming the board and * Build with your own board and scenario configuration, assuming the board and
scenario XML files are ``/path/to/board.xml`` and ``/path/to/scenario.xml``: scenario XML files are ``/path/to/board.xml`` and ``/path/to/scenario.xml``:
.. code-block:: none .. code-block:: none
$ make BOARD=/path/to/board.xml SCENARIO=/path/to/scenario.xml make BOARD=/path/to/board.xml SCENARIO=/path/to/scenario.xml
.. note:: .. note::
ACRN uses XML files to summarize board characteristics and scenario ACRN uses XML files to summarize board characteristics and scenario
@ -245,10 +247,10 @@ building the hypervisor, allowing users to tweak the configurations.
.. code-block:: none .. code-block:: none
$ make BOARD=nuc7i7dnb SCENARIO=industry hvdefconfig make BOARD=nuc7i7dnb SCENARIO=industry hvdefconfig
$ vim build/hypervisor/.scenario.xml vim build/hypervisor/.scenario.xml
(Modify the XML file per your needs) #(Modify the XML file per your needs)
$ make make
.. note:: .. note::
A hypervisor build remembers the board and scenario previously A hypervisor build remembers the board and scenario previously