doc: add multiboot module string parameter

The multiboot module string will be used to identify the usage of current module, it must exactly match with "kernel_mod_tag" which configured in VM configurations files; Signed-off-by: Victor Sun <victor.sun@intel.com>
projectacrn · Jun 10, 2019 · e5a2574 · e5a2574
1 parent e63d32a
commit e5a2574
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/doc/tutorials/using_partition_mode_on_nuc.rst b/doc/tutorials/using_partition_mode_on_nuc.rst
@@ -210,7 +210,7 @@ Update Ubuntu GRUB to Boot hypervisor and Load Kernel Image
 
               echo 'Loading hypervisor logical partition scenario ...'
               multiboot --quirk-modules-after-kernel /boot/acrn.32.out
-              module /boot/bzImage
+              module /boot/bzImage XXXXXX
       }
 
    .. note::
@@ -220,6 +220,9 @@ Update Ubuntu GRUB to Boot hypervisor and Load Kernel Image
       ``hypervisor/scenarios/logical_partition/vm_configurations.h`` and
       configured by ``VMx_CONFIG_OS_BOOTARG_*`` MACROs (where x is the VM id
       number and ``*`` are arguments).
+      The multiboot module param ``XXXXXX`` is the bzImage tag and must
+      exactly match the ``kernel_mod_tag`` configured in file
+      ``hypervisor/scenarios/logical_partition/vm_configurations.c``.
 
 #. Modify the ``/etc/default/grub`` file as follows to make the GRUB menu
    visible when booting:

diff --git a/doc/tutorials/using_partition_mode_on_up2.rst b/doc/tutorials/using_partition_mode_on_up2.rst
@@ -327,9 +327,15 @@ Enable partition mode in ACRN hypervisor
 
              echo 'Loading partition mode hypervisor ...'
              multiboot /boot/acrn.32.out
-             module /boot/bzImage
+             module /boot/bzImage XXXXXX
      }
 
+   .. note::
+
+     The multiboot module param ``XXXXXX`` is the bzImage tag and must
+     exactly match the ``kernel_mod_tag`` configured in file
+     ``hypervisor/scenarios/logical_partition/vm_configurations.c``.
+
    Modify the ``/etc/default/grub`` file as follows to make the GRUB menu visible
    when booting: