Skip to content

Commit

Permalink
fix(doc):improve documentation readability
Browse files Browse the repository at this point in the history
  • Loading branch information
Diogo21Costa committed Sep 19, 2023
1 parent 8678de3 commit d91a99d
Showing 1 changed file with 31 additions and 8 deletions.
39 changes: 31 additions & 8 deletions source/bao_hyp/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,37 @@ configuration, the list of VMs is mandatory and must include at least 1 VM.
Additionally, for each list, it is necessary to specify the list size using the
parameters ``shmemlist_size`` and ``vmlist_size``.

Config file name and location
-----------------------------
The configuration file with the ``.c`` extension can be assigned various names.
As part of the Bao hypervisor's build system, it expects to find the
configuration file in the ``configs`` folder. This means that users need to
place their custom configuration files with the appropriate settings in the
designated ``configs`` directory. The build system then relies on this file to
extract and apply the desired configuration options for the hypervisor.
Building Bao Hypervisor
-----------------------
The configuration files for the Bao hypervisor are stored in a designated
folder known as the configuration repository - ``CONFIG_REPO``. By default,
the ``CONFIG_REPO`` is set to the configs folder located in the top-level
directory of the Bao hypervisor. However, users have the flexibility to specify
a different folder by using the ``CONFIG_REPO`` option in the make command
during the hypervisor building process. For instance, the build command of Bao
follows the nomenclature presented below:

.. code-block:: console
make -C /path/to/bao-dir\
PLATFORM=target-platform\
CONFIG_REPO=/path/to/config\
CONFIG=config-name\
Considering a configuration named ``config-name``, the configuration naming can
be provided in two formats:

**1. Single C Source File**: Save the configuration as a C source file with the\
name ``config-name.c``.

**2. Directory Format:**: Alternatively, you can organize it as a directory\
named ``config-name`` and place the C source file within, naming it\
``config.c``.

In both cases, the build system will search for the configuration in the
specified ``CONFIG_REPO`` using the defined naming convention. This allows
users to seamlessly integrate their custom configurations into the Bao
hypervisor build process.

.. warning::
Modifying the number of elements in the ``shmemlist`` or \
Expand Down

0 comments on commit d91a99d

Please sign in to comment.