Skip to content

Commit

Permalink
fix(doc): include some format tweaks
Browse files Browse the repository at this point in the history
Signed-off-by: Diogo21Costa <diogoandreveigacosta@gmail.com>
  • Loading branch information
Diogo21Costa committed Sep 27, 2023
1 parent 133b776 commit ee5f294
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions source/bao_hyp/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,21 +40,19 @@ The configuration file follows a specific structure, as outlined below:
Before the configuration itself, it is necessary to declare the VM images using
the ``VM_IMAGE`` macro. This macro directly embeds the guest binary file into
the hypervisor image. Here's an example usage of the
``VM_IMAGE``:
the hypervisor image. Here's an example usage of the ``VM_IMAGE``:

.. code-block:: c
VM_IMAGE(img_name, "/path/to/VM/binary.bin");
The ``VM_IMAGE`` macro has two parameters:

1. The ``img_name``, an unique identifier associated with the image that
will later be used to describe the image running on the VM (see
`Guest Image`_);
1. The ``img_name``, an unique identifier associated with the image that will
later be used to describe the image running on the VM (see `Guest Image`_);

2. A C string with the guest image's binary file path. It can be either an
absolute path or a path relative to the config source file.
2. A C string with the guest image's binary file path. It can be either an
absolute path or a path relative to the config source file.

The configuration takes the form of a C struct (``struct config``) defining
name ``config``. This struct containing two distinct lists: (i) a list of
Expand Down

0 comments on commit ee5f294

Please sign in to comment.