github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-26 15:31:35 +00:00
Code Issues Projects Releases Wiki Activity

doc: quick doc fix to remove build error from IVSHMEM changes

Browse Source 
PR #7115 removed ``IVSHMEM_ENABLED`` and ``IVSHMEM_REGION`` from
``types.xsd``.  We'll need to update the documentation to reflect this
change, but for now we need to remove the doc build error.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2022-02-18 08:59:09 -08:00 committed by David Kinder
parent 34037b88e0
commit 97855c54c2
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/tutorials/enable_ivshmem.rst
View File

@ -18,9 +18,9 @@ steps:
- Enable ``ivshmem`` via ACRN Configurator GUI.
- Set :option:`hv.FEATURES.IVSHMEM.IVSHMEM_ENABLED` to ``y``
- Set ``hv.FEATURES.IVSHMEM.IVSHMEM_ENABLED`` to ``y``
- Edit :option:`hv.FEATURES.IVSHMEM.IVSHMEM_REGION` to specify the shared
- Edit ``hv.FEATURES.IVSHMEM.IVSHMEM_REGION`` to specify the shared
memory name, size and
communication VMs. The ``IVSHMEM_REGION`` format is ``shm_name,shm_size,VM IDs``:
@ -55,7 +55,7 @@ where
- ``ivshmem`` - Virtual PCI device emulating the Shared Memory
- ``shm_name`` - Specify a shared memory name. This ``shm_name`` must be listed
in :option:`hv.FEATURES.IVSHMEM.IVSHMEM_REGION` in `Enable Ivshmem Support`_ section and needs to start
in ``hv.FEATURES.IVSHMEM.IVSHMEM_REGION`` in `Enable Ivshmem Support`_ section and needs to start
with ``dm:/`` prefix.
- ``shm_size`` - Shared memory size of selected ``shm_name``.
@ -67,7 +67,7 @@ There are two ways to insert the above boot parameter for ``acrn-dm``:
tool.
- Use the following command to create a launch script, when IVSHMEM is enabled
and :option:`hv.FEATURES.IVSHMEM.IVSHMEM_REGION` is properly configured via
and ``hv.FEATURES.IVSHMEM.IVSHMEM_REGION`` is properly configured via
the ACRN Configurator.
.. code-block:: none

2
doc/user-guides/acrn-dm-parameters.rst
View File

@ -350,7 +350,7 @@ arguments used for configuration. Here is a table describing these emulated dev
- Inter-VM shared memory (ivshmem) virtualized PCI device used specifically
for shared memory between VMs. Parameters should be added with the format
``ivshmem,<shm_name>,<shm_size>``. ``<shm-name>`` specifies a shared memory
name, and must be listed in :option:`hv.FEATURES.IVSHMEM.IVSHMEM_REGION`
name, and must be listed in ``hv.FEATURES.IVSHMEM.IVSHMEM_REGION``
as configured using the ACRN configurator tool UI, and needs to start
with a ``dm:/`` prefix.