From d120e6f0775c3e0c2f177fd77b49b8c016864020 Mon Sep 17 00:00:00 2001 From: Diogo21Costa Date: Thu, 27 Jul 2023 16:06:30 +0100 Subject: [PATCH] doc(fix): fix spelling typos --- source/bao_hyp/config.rst | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/source/bao_hyp/config.rst b/source/bao_hyp/config.rst index 8aa57bb..1f8f19a 100644 --- a/source/bao_hyp/config.rst +++ b/source/bao_hyp/config.rst @@ -3,8 +3,8 @@ Bao Configuration File Overview -------- -The Bao hypervisor's configuration is managed through a dedicated configuration -file (denoted by the .c file). This section serves to provide an in-depth +The Bao hypervisor's configuration is managed through a dedicated configuration +file (denoted by the .c file). This section serves to provide an in-depth exploration of the various configuration options available. The configuration file follows a specific structure, as outlined below: @@ -21,13 +21,13 @@ The configuration is represented by a structure named ``config``, which must be named accordingly to ensure proper functionality. Before defining the ``config`` struct, it is necessary to declare the VM images. In this regard, the configuration file expects to receive a compiled image of -each guest (``.bin`` file) which will further be assigned to each VM. For instance, -the number of VM images declared can vary between 1 and the number of CPU cores -available in the target platform (as Bao hypervisor follows a 1-1 CPU +each guest (``.bin`` file) which will further be assigned to each VM. For +instance, the number of VM images declared can vary between 1 and the number of +CPU cores available in the target platform (as Bao hypervisor follows a 1-1 CPU partitioning policy). -Regarding the ``config`` struct, the configuration requires a macro to initialize -configuration-independent fields, as shown below: +Regarding the ``config`` struct, the configuration requires a macro to +initialize configuration-independent fields, as shown below: .. code-block:: c @@ -37,11 +37,11 @@ configuration-independent fields, as shown below: ... Afterward, the configuration allows the definition of two distinct lists: (i) a -list of shared memories (``shmemlist``) and (ii) a list of VMs (or guests) (``vmlist``). -While the list of shared memories is optional and may be omitted from the -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``. +list of shared memories (``shmemlist``) and (ii) a list of VMs (or guests) +(``vmlist``). While the list of shared memories is optional and may be omitted +from the 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``. .. code-block:: c @@ -59,8 +59,8 @@ parameters ``shmemlist_size`` and ``vmlist_size``. .vmlist_size = NUM_VMs, .vmlist = { + { /* VM 0 Config*/}, { /* VM 1 Config*/}, - { /* VM 2 Config*/}, ... { /* VM N Config*/}, }