OrgACRN
/
acrn-hypervisor
mirror of https://github.com/projectacrn/acrn-hypervisor.git
1
0
Fork 0
Code Issues Releases Wiki Activity
acrn-hypervisor/doc/reference/config-options.rst

44 lines
1.2 KiB
ReStructuredText
Raw Normal View History

doc: integrate config xsl transform into doc build Documentation for the scenario XML configuration options is pulled from the schema definition files (xsd) maintained in the misc/config_tools/schema folder. Update the doc build process to generate and incorporate the option documentation. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-01-28 10:14:00 +08:00
.. _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.
doc: cleanup xsd-derived config doc text Start cleaning up formatting and content layout issues in the xsd-derived configuration option documentation. Includes adding documentation for unnamed embedded simple types within an element (and updates to the XSLT transformation to display these), cleanup of element and type documentation, typos and description clarity. Improved xsdl translation to automatically include default values and if an option is optional (instead of manually documenting this in the description text). Tracked-On: #5692 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-02-03 09:28:21 +08:00
.. rst-class:: rst-columns3
doc: integrate config xsl transform into doc build Documentation for the scenario XML configuration options is pulled from the schema definition files (xsd) maintained in the misc/config_tools/schema folder. Update the doc build process to generate and incorporate the option documentation. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-01-28 10:14:00 +08:00
.. contents::
:local:
:depth: 2
doc: fix all headings to use title case While we hoped to make the headings consistent over time while doing other edits, we should instead just make the squirrels happy and do them all at once or they'll likely never be made consistent. A python script was used to find the headings, and then a call to https://pypi.org/project/titlecase to transform the title. A visual inspection was used to tweak a few unexpected resulting titles. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-02-13 08:27:24 +08:00
Common Option Value Types
doc: integrate config xsl transform into doc build Documentation for the scenario XML configuration options is pulled from the schema definition files (xsd) maintained in the misc/config_tools/schema folder. Update the doc build process to generate and incorporate the option documentation. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-01-28 10:14:00 +08:00
*************************
Within this option documentation, we refer to some common type
definitions:
Boolean
A true or false value specified as either ``y`` or ``n``. Other
values such as ``t`` or ``f`` are not supported.
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 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