1.. _scenario-config-options:
2
3Scenario Configuration Options
4##############################
5
6As explained in :ref:`acrn_configuration_tool`, ACRN scenarios define
7the hypervisor (hv) and VM settings for the execution environment of an
8ACRN-based application.  This document describes these option settings.
9
10.. rst-class:: rst-columns3
11
12.. contents::
13   :local:
14   :depth: 2
15
16Common Option Value Types
17*************************
18
19Within this option documentation, we refer to some common type
20definitions:
21
22Boolean
23  A true or false value displayed as a check box, checked indicating true.
24
25Hexadecimal
26  A base-16 (integer) value represented by a leading ``0x`` or ``0X`` followed by
27  one or more characters ``0`` to ``9``, ``a`` to ``f``, or ``A`` to ``F``.
28
29Integer
30  A base-10 value represented by the characters ``0`` to ``9``.  The
31  first character must not be a ``0``. Only positive values are
32  expected.
33
34String
35  A sequence of UTF-8 characters.  String-length limits or specific
36  string value restrictions are defined in the option description.
37
38.. comment These images are used in generated option documentation
39
40.. |icon-advanced| image:: images/Advanced.png
41   :alt: Find this option on the Configurator's Advanced Parameters tab
42.. |icon-basic| image:: images/Basic.png
43   :alt: Find this option on the Configurator's Basic Parameters tab
44.. |icon-not-available| image:: images/Not-available.png
45   :alt: This is a hidden option and not user-editable using the Configurator
46.. |icon-post-launched-vm| image:: images/Post-launched-VM.png
47   :alt: Find this option on a Configurator Post-launched VM tab
48.. |icon-pre-launched-vm| image:: images/Pre-launched-VM.png
49   :alt: Find this option on a Configurator Pre-launched VM tab
50.. |icon-service-vm| image:: images/Service-VM.png
51   :alt: Find this option on the Configurator Service VM tab
52.. |icon-hypervisor| image:: images/Hypervisor.png
53   :alt: Find this option on the Configurator's Hypervisor Global Settings tab
54
55We use icons within an option description to indicate where the option can be
56found within the Configurator UI:
57
58.. list-table::
59   :header-rows: 1
60
61   * - **Hypervisor/VM Tab**
62     - **Basic/Advanced Tab**
63
64   * - |icon-hypervisor|
65         Find this option on the Configurator's **Hypervisor Global Settings** tab
66     - |icon-basic|
67           Find this option on the Hypervisor's or VM's **Basic Parameters** tab
68
69   * - |icon-pre-launched-vm|
70          Find this option on a Configurator **Pre-Launched VM** tab
71     - |icon-advanced|
72           Find this option on the Hypervisor's or VM's **Advanced Parameters** tab
73
74   * - |icon-post-launched-vm|
75           Find this option on a Configurator **Post-Launched VM** tab
76     -
77
78   * - |icon-service-vm|
79           Find this option on the Configurator **Service VM** tab
80     -
81
82-----
83
84.. comment This configdoc.txt is generated during the doc build process
85   from the acrn config schema files found in misc/config_tools/schema
86
87.. include:: configdoc.txt
88