github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-23 05:57:33 +00:00
Code Issues Projects Releases Wiki Activity

doc: restore lists inside of notes

Browse Source 
Lists inside of a note are displayed properly now, thanks to #4966 so
let's put some back in.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2020-06-18 13:36:14 -07:00 committed by David Kinder
parent 9ff0d30ad6
commit d479894ce4
2 changed files with 32 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/introduction/index.rst
View File

@ -629,9 +629,8 @@ ACRN Device model incorporates these three aspects:
notifying it that the IOREQ has completed. notifying it that the IOREQ has completed.
.. note:: .. note::
Userland: dm as ACRN Device Model. * Userland: dm as ACRN Device Model.
* Kernel space: VBS-K, MPT Service, VHM itself
Kernel space: VBS-K, MPT Service, VHM itself
.. _pass-through: .. _pass-through:

46
doc/tutorials/using_grub.rst
View File

@ -29,10 +29,10 @@ ELF format when ``CONFIG_RELOC`` is not set, or RAW format when
``CONFIG_RELOC`` is set. ``CONFIG_RELOC`` is set.
.. note:: .. note::
``CONFIG_RELOC`` is set by default, so use ``acrn.32.out`` in multiboot * ``CONFIG_RELOC`` is set by default, so use ``acrn.32.out`` in multiboot
protocol and ``acrn.bin`` in multiboot2 protocol. protocol and ``acrn.bin`` in multiboot2 protocol.
Per ACPI specification, the RSDP pointer is described in the EFI System * Per ACPI specification, the RSDP pointer is described in the EFI System
Table instead of legacy ACPI RSDP area on a UEFI enabled platform. To make Table instead of legacy ACPI RSDP area on a UEFI enabled platform. To make
sure ACRN hypervisor gets the correct ACPI RSDP info, we recommend using sure ACRN hypervisor gets the correct ACPI RSDP info, we recommend using
``acrn.bin`` with multiboot2 protocol to load hypervisor on a UEFI platform. ``acrn.bin`` with multiboot2 protocol to load hypervisor on a UEFI platform.
@ -88,29 +88,35 @@ pre-launched VMs (the SOS_VM is also a kind of pre-launched VM):
.. note:: .. note::
The module ``/boot/kernel4vm0`` is the VM0 kernel file. The param ``xxxxxx`` is The module ``/boot/kernel4vm0`` is the VM0 kernel file. The param
VM0's kernel file tag and must exactly match the ``kernel_mod_tag`` of VM0 ``xxxxxx`` is VM0's kernel file tag and must exactly match the
configured in the ``hypervisor/scenarios/$(SCENARIO)/vm_configurations.c`` ``kernel_mod_tag`` of VM0 configured in the
file. The multiboot module ``/boot/kernel4vm1`` is the VM1 kernel file and the param ``hypervisor/scenarios/$(SCENARIO)/vm_configurations.c`` file. The
``yyyyyy`` is its tag and must exactly match the ``kernel_mod_tag`` of VM1 in the multiboot module ``/boot/kernel4vm1`` is the VM1 kernel file and the
param ``yyyyyy`` is its tag and must exactly match the
``kernel_mod_tag`` of VM1 in the
``hypervisor/scenarios/$(SCENARIO)/vm_configurations.c`` file. ``hypervisor/scenarios/$(SCENARIO)/vm_configurations.c`` file.
The guest kernel command line arguments is configured in the hypervisor source code by default The guest kernel command line arguments is configured in the
if no ``$(VMx bootargs)`` is present. If ``$(VMx bootargs)`` is present, the default hypervisor source code by default if no ``$(VMx bootargs)`` is present.
command line arguments is overridden by the ``$(VMx bootargs)`` parameters. If ``$(VMx bootargs)`` is present, the default command line arguments
are overridden by the ``$(VMx bootargs)`` parameters.
The ``$(Service VM bootargs)`` parameter in the multiboot command is appended to the end of Service The ``$(Service VM bootargs)`` parameter in the multiboot command
VM kernel command line. This is useful to override some Service VM kernel cmdline parameters because is appended to the end of the Service VM kernel command line. This is
the later one would win if same parameters configured in Linux kernel cmdline. For example, useful to override some Service VM kernel cmdline parameters because the
adding ``root=/dev/sda3`` will override the original root device later one would win if the same parameters were configured in the Linux
to ``/dev/sda3`` for the Service VM kernel. kernel cmdline. For example, adding ``root=/dev/sda3`` will override the
original root device to ``/dev/sda3`` for the Service VM kernel.
All parameters after ``#`` character are ignored since GRUB treat them as comments. All parameters after a ``#`` character are ignored since GRUB
treat them as comments.
``\``, ``$``, ``#`` are special characters in GRUB, a escape character ``\`` must be added ``\``, ``$``, ``#`` are special characters in GRUB. An escape
before these special characters if they are included in ``$(HV bootargs)`` or ``$(VM bootargs)``. character ``\`` must be added before these special characters if they
For example, ``memmap=0x200000$0xE00000`` for guest kernel cmdline are included in ``$(HV bootargs)`` or ``$(VM bootargs)``. For example,
must be written as ``memmap=0x200000\$0xE00000`` ``memmap=0x200000$0xE00000`` for guest kernel cmdline must be written as
``memmap=0x200000\$0xE00000``
#. Update GRUB:: #. Update GRUB::