mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-10-09 09:33:24 +00:00
f71c7a8032
Change the generated config option documentation to use the DX-friendly names defined for the configurator UI (instead of the XML element name hierarchy previously used). Options are grouped by the top-level section (aka complex type) they belong to and then sorted alphabetically with these groups. Use badges to indicate where options can be found in the configurator UI and whether they're applicable to the Hypervisor or Pre/Post/Service VM. Add a custom css style for the config-option doc that puts the first paragraph of a glossary item on the same line as the glossary term so these badges look pretty. Added a acrn-custom.js patch that copies the alt text for images into a title property for images within the config-doc document. This provides tooltip text when hovering over the badges. Don't display options not visible in the configurator UI (elements with acrn:views=""). A missing acrn:views or acrn:applicable-vm means we look for an applicable value from an ancestor element. Add processing of a second xs:documentation element within an xs:annotation element. This second documentation element's content will be appended as a new paragraph to the first xs:documentation content in the generated documentation. Only the first xs:documentation element is used by the Configurator for its tooltips. Update documents that were referring to options by their XML names. Because we're now using a glossary to provide links to config options, we can't duplicate option names or glosary names anywhere in the doc set. 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 specified as either ``y`` or ``n``.
|
|
|
|
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
|