mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-08-04 09:50:54 +00:00
8ffb0dee4d
Edit the schema (.xsd) files to modify the order options are presented. None of these changes invalidate existing scenario XML files, as they only reorder elements within the existing parent element, or tweak the acrn:views, acrn:title, or documentation content. Move simple type elements before complex type options (under the same parent element) to avoid the confusion where options look like they're part of a section based on the title that's added before complex typed options but not simple typed options. * add acrn:title to pcpu (pCPU list) * change documentation for binary option saying "checked" instead of 'y' * move HYPERV_ENABLED before RDT (simple type before complex type) * move vuart_connections before FEATURES * move name before vm_type * move console_vuart, os_type, vuart0, vbootloader, usb_xhci before lapic_passthrough * add acrn:title to epc_section * add acrn:title to memory * move gpu to top of virtio_devices (simple type before completx type) Tracked-On: #5692 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
88 lines
2.9 KiB
ReStructuredText
88 lines
2.9 KiB
ReStructuredText
.. _scenario-config-options:
|
|
|
|
Scenario Configuration Options
|
|
##############################
|
|
|
|
As explained in :ref:`acrn_configuration_tool`, ACRN scenarios define
|
|
the hypervisor (hv) and VM settings for the execution environment of an
|
|
ACRN-based application. This document describes these option settings.
|
|
|
|
.. rst-class:: rst-columns3
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 2
|
|
|
|
Common Option Value Types
|
|
*************************
|
|
|
|
Within this option documentation, we refer to some common type
|
|
definitions:
|
|
|
|
Boolean
|
|
A true or false value displayed as a check box, checked indicating true.
|
|
|
|
Hexadecimal
|
|
A base-16 (integer) value represented by a leading ``0x`` or ``0X`` followed by
|
|
one or more characters ``0`` to ``9``, ``a`` to ``f``, or ``A`` to ``F``.
|
|
|
|
Integer
|
|
A base-10 value represented by the characters ``0`` to ``9``. The
|
|
first character must not be a ``0``. Only positive values are
|
|
expected.
|
|
|
|
String
|
|
A sequence of UTF-8 characters. String-length limits or specific
|
|
string value restrictions are defined in the option description.
|
|
|
|
.. comment These images are used in generated option documentation
|
|
|
|
.. |icon-advanced| image:: images/Advanced.svg
|
|
:alt: Find this option on the Configurator's Advanced Parameters tab
|
|
.. |icon-basic| image:: images/Basic.svg
|
|
:alt: Find this option on the Configurator's Basic Parameters tab
|
|
.. |icon-not-available| image:: images/Not-available.svg
|
|
:alt: This is a hidden option and not user-editable using the Configurator
|
|
.. |icon-post-launched-vm| image:: images/Post-launched-VM.svg
|
|
:alt: Find this option on a Configurator Post-launched VM tab
|
|
.. |icon-pre-launched-vm| image:: images/Pre-launched-VM.svg
|
|
:alt: Find this option on a Configurator Pre-launched VM tab
|
|
.. |icon-service-vm| image:: images/Service-VM.svg
|
|
:alt: Find this option on the Configurator Service VM tab
|
|
.. |icon-hypervisor| image:: images/Hypervisor.svg
|
|
:alt: Find this option on the Configurator's Hypervisor Global Settings tab
|
|
|
|
We use icons within an option description to indicate where the option can be
|
|
found within the Configurator UI:
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - **Hypervisor/VM Tab**
|
|
- **Basic/Advanced Tab**
|
|
|
|
* - |icon-hypervisor|
|
|
Find this option on the Configurator's **Hypervisor Global Settings** tab
|
|
- |icon-basic|
|
|
Find this option on the Hypervisor's or VM's **Basic Parameters** tab
|
|
|
|
* - |icon-pre-launched-vm|
|
|
Find this option on a Configurator **Pre-Launched VM** tab
|
|
- |icon-advanced|
|
|
Find this option on the Hypervisor's or VM's **Advanced Parameters** tab
|
|
|
|
* - |icon-post-launched-vm|
|
|
Find this option on a Configurator **Post-Launched VM** tab
|
|
-
|
|
|
|
* - |icon-service-vm|
|
|
Find this option on the Configurator **Service VM** tab
|
|
-
|
|
|
|
-----
|
|
|
|
.. comment This configdoc.txt is generated during the doc build process
|
|
from the acrn config schema files found in misc/config_tools/schema
|
|
|
|
.. include:: configdoc.txt
|