From 6eeef6943327821617de9a793cddd130440984e0 Mon Sep 17 00:00:00 2001 From: "Reyes, Amy" Date: Mon, 6 Jun 2022 15:41:58 -0700 Subject: [PATCH] doc: Remove Launch Configuration Options Removing Launch Configuation Options doc because all the launch script options are part of the new combined scenario XML and covered in Scenario Configuration Options doc. Signed-off-by: Reyes, Amy --- doc/develop.rst | 1 - doc/reference/config-options-launch.rst | 92 ----------------------- doc/tutorials/acrn_configuration_tool.rst | 3 - 3 files changed, 96 deletions(-) delete mode 100644 doc/reference/config-options-launch.rst diff --git a/doc/develop.rst b/doc/develop.rst index 424ed0167..8283ec5c0 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -42,7 +42,6 @@ Configuration Tutorials tutorials/acrn_configurator_tool tutorials/upgrading_configuration reference/config-options - reference/config-options-launch reference/hv-make-options user-guides/hv-parameters user-guides/kernel-parameters diff --git a/doc/reference/config-options-launch.rst b/doc/reference/config-options-launch.rst deleted file mode 100644 index 2b04dd230..000000000 --- a/doc/reference/config-options-launch.rst +++ /dev/null @@ -1,92 +0,0 @@ -.. _launch-config-options: - -Launch Configuration Options -############################## - -As explained in :ref:`acrn_configuration_tool`, launch configuration files -define post-launched User VM settings. This document describes these option settings. - -``user_vm``: - Specify the User VM ``id`` to the Service VM. - -``user_vm_type``: - Specify the User VM type, such as ``CLEARLINUX``, ``ANDROID``, ``ALIOS``, - ``PREEMPT-RT LINUX``, ``GENERIC LINUX``, ``WINDOWS``, ``YOCTO``, ``UBUNTU``, - ``ZEPHYR`` or ``VXWORKS``. - -``rtos_type``: - Specify the User VM Real-time capability: Soft RT, Hard RT, or none of them. - -``mem_size``: - Specify the User VM memory size in megabytes. - -``vbootloader``: - Virtual bootloader type; only supports OVMF. - -``vuart0``: - Specify whether the Device Model emulates the vUART0 (vCOM1); refer to - :ref:`vuart_config` for details. If set to ``Enable``, the vUART0 is - emulated by the Device Model; if set to ``Disable``, the vUART0 is - emulated by the hypervisor if it is configured in the scenario XML. - -``enable_ptm``: - Enable the Precision Timing Measurement (PTM) feature. - -``usb_xhci``: - USB xHCI mediator configuration. Input format: - ``bus#-port#[:bus#-port#: ...]``, e.g.: ``1-2:2-4``. - Refer to :ref:`usb_virtualization` for details. - -``shm_regions``: - List of shared memory regions for inter-VM communication. - -``shm_region`` (a child node of ``shm_regions``): - Configure the shared memory regions for the current VM, input format: - ``[hv|dm]:/,``. Refer to :ref:`ivshmem-hld` - for details. - -``console_vuart``: - Enable a PCI-based console vUART. Refer to :ref:`vuart_config` for details. - -``communication_vuarts``: - List of PCI-based communication vUARTs. Refer to :ref:`vuart_config` for - details. - -``communication_vuart`` (a child node of ``communication_vuarts``): - Enable a PCI-based communication vUART with its ID. Refer to - :ref:`vuart_config` for details. - -``passthrough_devices``: - Select the passthrough device from the PCI device list. We support: - ``usb_xdci``, ``audio``, ``audio_codec``, ``ipu``, ``ipu_i2c``, - ``cse``, ``wifi``, ``bluetooth``, ``sd_card``, - ``ethernet``, ``sata``, and ``nvme``. - -``network`` (a child node of ``virtio_devices``): - The virtio network device setting. - Input format: ``[,vhost][,mac=]``. - The ```` is the name of the TAP (or MacVTap) device. - It must include the keyword ``tap``. ``vhost`` specifies the - vhost backend; otherwise, the VBSU backend is used. The ``mac`` - address is optional. - -``block`` (a child node of ``virtio_devices``): - The virtio block device setting. - Input format: ``[blk partition:][img path]`` e.g.: ``/dev/sda3:./a/b.img``. - -``console`` (a child node of ``virtio_devices``): - The virtio console device setting. - Input format: - ``[@]stdio|tty|pty|sock:portname[=portpath][,[@]stdio|tty|pty:portname[=portpath]]``. - -``cpu_affinity``: - A comma-separated list of Service VM vCPUs assigned to this VM. A Service VM vCPU is identified - by its lapic ID. - -.. note:: - - The ``configurable`` and ``readonly`` attributes are used to mark - 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. diff --git a/doc/tutorials/acrn_configuration_tool.rst b/doc/tutorials/acrn_configuration_tool.rst index a47e47856..6af41903d 100644 --- a/doc/tutorials/acrn_configuration_tool.rst +++ b/doc/tutorials/acrn_configuration_tool.rst @@ -202,6 +202,3 @@ The ``scenario`` attribute specifies the scenario name and must match the The ``user_vm_launcher`` attribute specifies the number of post-launched User VMs in a scenario. - -See :ref:`launch-config-options` for a full explanation of available launch -XML elements.