From 25c677dc394314ce66cfb39459984d823c4a4c93 Mon Sep 17 00:00:00 2001 From: Kunhui-Li Date: Wed, 23 Jun 2021 16:19:40 +0800 Subject: [PATCH] doc: fix documentation's issue 1. Update the necessary libraries to consistent with the "Build ACRN From Source" document in the "Getting Started Guide" document. 2. Delete the related introduction with acrngt.conf and launch_uos_id1.sh files in "Getting Started Guide" document. 3. Update WHL-IPC-I7 board's processor in Supported HW document. 4. Add cpu_affinity element's description in ACRN Configuration Data. 5. Update the description for shm_region in Launch XML format. 6. Update configurable/readonly attributes values. 7. Update the description for hv.CAPACITIES.MAX_MSIX_TABLE_NUM in schema/config.xsd. Tracked-On: #5692 Signed-off-by: Kunhui-Li --- doc/getting-started/getting-started.rst | 24 ++++++----------------- doc/reference/hardware.rst | 2 +- doc/tutorials/acrn_configuration_tool.rst | 11 +++++++---- misc/config_tools/schema/config.xsd | 3 ++- 4 files changed, 16 insertions(+), 24 deletions(-) diff --git a/doc/getting-started/getting-started.rst b/doc/getting-started/getting-started.rst index c16a1a10d..57fbdb122 100644 --- a/doc/getting-started/getting-started.rst +++ b/doc/getting-started/getting-started.rst @@ -157,7 +157,7 @@ Build the ACRN Hypervisor on Ubuntu .. code-block:: none - $ sudo -E apt install gcc \ + $ sudo apt install gcc \ git \ make \ libssl-dev \ @@ -166,6 +166,7 @@ Build the ACRN Hypervisor on Ubuntu libsystemd-dev \ libevent-dev \ libxml2-dev \ + libxml2-utils \ libusb-1.0-0-dev \ python3 \ python3-pip \ @@ -176,7 +177,8 @@ Build the ACRN Hypervisor on Ubuntu liblz4-tool \ flex \ bison \ - xsltproc + xsltproc \ + clang-format $ sudo pip3 install lxml xmlschema @@ -558,22 +560,8 @@ Run Cyclictest Launch the Windows VM ********************* -#. Follow this :ref:`guide ` to prepare the Windows - image file and then reboot with a new ``acrngt.conf``. - -#. Modify the ``launch_uos_id1.sh`` script as follows and then launch - the Windows VM as one of the post-launched standard VMs: - - .. code-block:: none - :emphasize-lines: 2 - - acrn-dm -A -m $mem_size -s 0:0,hostbridge -s 1:0,lpc -l com1,stdio \ - -s 2,passthru,0/2/0,gpu \ - -s 3,virtio-blk,./win10-ltsc.img \ - -s 4,virtio-net,tap0 \ - --ovmf /usr/share/acrn/bios/OVMF.fd \ - --windows \ - $vm_name +Follow this :ref:`guide ` to prepare the Windows +image file and then reboot. Troubleshooting *************** diff --git a/doc/reference/hardware.rst b/doc/reference/hardware.rst index 5a5fc1c12..a148ebec9 100644 --- a/doc/reference/hardware.rst +++ b/doc/reference/hardware.rst @@ -127,7 +127,7 @@ Tested Hardware Specifications Detail | | +------------------------+------------------------------------------------------------+ | | | Serial Port | - Yes | +---------------------------+------------------------+------------------------+------------------------------------------------------------+ -| | **Whiskey Lake** | | WHL-IPC-I7 | Processor | - Intel |copy| Core |trade| i5-8265U CPU @ 1.80GHz (4C8T) | +| | **Whiskey Lake** | | WHL-IPC-I7 | Processor | - Intel |copy| Core |trade| i7-8565U CPU @ 1.80GHz (4C8T) | | | | | (Board: WHL-IPC-I7) | | | | | +------------------------+------------------------------------------------------------+ | | | Graphics | - HD Graphics 610/620 | diff --git a/doc/tutorials/acrn_configuration_tool.rst b/doc/tutorials/acrn_configuration_tool.rst index eb640e1e0..b6f4f8685 100644 --- a/doc/tutorials/acrn_configuration_tool.rst +++ b/doc/tutorials/acrn_configuration_tool.rst @@ -339,7 +339,7 @@ current scenario has: ``shm_region`` (a child node of ``shm_regions``): configure the shared memory regions for current VM, input format: - ``hv:/<;shm name>;, <;shm size in MB>;``. Refer to :ref:`ivshmem-hld` for details. + ``hv:/<;shm name>; (or dm:/;), <;shm size in MB>;``. Refer to :ref:`ivshmem-hld` for details. ``console_vuart``: Enable a PCI-based console vUART. Refer to :ref:`vuart_config` for details. @@ -369,12 +369,15 @@ current scenario has: Input format: ``[@]stdio|tty|pty|sock:portname[=portpath][,[@]stdio|tty|pty:portname[=portpath]]``. +``cpu_affinity``: + List of pCPU that this VM's vCPUs are pinned to. + .. note:: The ``configurable`` and ``readonly`` attributes are used to mark - whether the item is configurable for users. When ``configurable="0"`` - and ``readonly="true"``, the item is not configurable from the web - interface. When ``configurable="0"``, the item does not appear on the + whether the item is configurable for users. When ``configurable="n"`` + and ``readonly="y"``, the item is not configurable from the web + interface. When ``configurable="n"``, the item does not appear on the interface. .. _acrn_config_tool_ui: diff --git a/misc/config_tools/schema/config.xsd b/misc/config_tools/schema/config.xsd index baaa66253..3d504c705 100644 --- a/misc/config_tools/schema/config.xsd +++ b/misc/config_tools/schema/config.xsd @@ -273,7 +273,8 @@ devices. - Maximum number of MSI-X tables per device. + Maximum number of MSI-X tables per device. +If this value is empty, then the default value will be calculated from the board XML file.