Skip to content

Commit

Permalink
fix(doc): improve documentation readability
Browse files Browse the repository at this point in the history
Signed-off-by: Diogo21Costa <[email protected]>
  • Loading branch information
Diogo21Costa committed Sep 19, 2023
1 parent 9b83e14 commit 698ade9
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions source/bao_hyp/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ 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
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
Expand All @@ -84,12 +84,12 @@ follows the nomenclature presented below:
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``.
**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\
**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``.
``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
Expand Down

0 comments on commit 698ade9

Please sign in to comment.