github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-01 20:05:30 +00:00
Code Issues Projects Releases Wiki Activity

doc: Capitalize Board Inspector and ACRN Configurator

Browse Source 
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
This commit is contained in:
Reyes, Amy 2022-04-14 13:28:30 -07:00 committed by David Kinder
parent 7f2175cdce
commit 89c15567b0
7 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/developer-guides/doc_guidelines.rst
View File

@ -734,7 +734,7 @@ header files,
along with some prose documentation in ``.rst`` files. The ACRN configuration along with some prose documentation in ``.rst`` files. The ACRN configuration
option documentation is created based on details maintained in schema definition option documentation is created based on details maintained in schema definition
files (``.xsd``) in the ``misc/config_tools/schema`` folder. These schema files (``.xsd``) in the ``misc/config_tools/schema`` folder. These schema
definition files are used by the ACRN configurator tool to validate the XML definition files are used by the ACRN Configurator tool to validate the XML
scenario scenario
configuration files as well as to hold documentation about each option. For configuration files as well as to hold documentation about each option. For
example: example:

2
doc/developer-guides/hld/hld-splitlock.rst
View File

@ -132,5 +132,5 @@ If the CPU supports Split-locked Access detection, the ACRN hypervisor
uses it to prevent any VM running with potential system performance uses it to prevent any VM running with potential system performance
impacting split-locked instructions. This detection can be disabled impacting split-locked instructions. This detection can be disabled
(by changing the :option:`hv.FEATURES.ENFORCE_TURNOFF_AC` setting in (by changing the :option:`hv.FEATURES.ENFORCE_TURNOFF_AC` setting in
the ACRN configurator tool) for customers not the ACRN Configurator tool) for customers not
caring about system performance. caring about system performance.

2
doc/glossary.rst
View File

@ -135,7 +135,7 @@ Glossary of Terms
Scenario Scenario
A collection of hypervisor and VM configuration settings that define an A collection of hypervisor and VM configuration settings that define an
ACRN-based application's environment. A scenario configuration is stored ACRN-based application's environment. A scenario configuration is stored
in a scenario XML file and edited using the ACRN configurator tool. The in a scenario XML file and edited using the ACRN Configurator tool. The
scenario configuration, along with the target board configuration, is used scenario configuration, along with the target board configuration, is used
by the ACRN build system to modify the source code to build tailored by the ACRN build system to modify the source code to build tailored
images of the hypervisor and Service VM for the application. ACRN provides images of the hypervisor and Service VM for the application. ACRN provides

10
doc/introduction/index.rst
View File

@ -287,7 +287,7 @@ Scenarios are a way to describe the system configuration settings of the ACRN
hypervisor, VMs, and resources they have access to that meet your specific hypervisor, VMs, and resources they have access to that meet your specific
application's needs such as compute, memory, storage, graphics, networking, and application's needs such as compute, memory, storage, graphics, networking, and
other devices. Scenario configurations are stored in an XML format file and other devices. Scenario configurations are stored in an XML format file and
edited using the ACRN configurator. edited using the ACRN Configurator.
Following a general embedded-system programming model, the ACRN hypervisor is Following a general embedded-system programming model, the ACRN hypervisor is
designed to be statically customized at build time per hardware and scenario, designed to be statically customized at build time per hardware and scenario,
@ -307,9 +307,9 @@ parsing is not used in the ACRN hypervisor for these reasons:
The scenario XML file together with a target board XML file are used to build The scenario XML file together with a target board XML file are used to build
the ACRN hypervisor image tailored to your hardware and application needs. The ACRN the ACRN hypervisor image tailored to your hardware and application needs. The ACRN
project provides a board inspector tool to automatically create the board XML project provides the Board Inspector tool to automatically create the board XML
file by inspecting the target hardware. ACRN also provides a file by inspecting the target hardware. ACRN also provides the
:ref:`configurator tool <acrn_configuration_tool>` :ref:`ACRN Configurator tool <acrn_configuration_tool>`
to create and edit a tailored scenario XML file based on predefined sample to create and edit a tailored scenario XML file based on predefined sample
scenario configurations. scenario configurations.
@ -400,7 +400,7 @@ can define your own configuration scenarios.
You can find the predefined scenario XML files in the You can find the predefined scenario XML files in the
:acrn_file:`misc/config_tools/data` folder in the hypervisor source code. The :acrn_file:`misc/config_tools/data` folder in the hypervisor source code. The
:ref:`acrn_configuration_tool` tutorial explains how to use the ACRN :ref:`acrn_configuration_tool` tutorial explains how to use the ACRN
configurator to create your own scenario, or to view and modify an existing one. Configurator to create your own scenario, or to view and modify an existing one.
Boot Sequence Boot Sequence
************* *************

2
doc/reference/hv-make-options.rst
View File

@ -181,7 +181,7 @@ Thus, there is no need to duplicate ``BOARD`` and ``SCENARIO`` in the second
``make`` above. ``make`` above.
While the scenario configuration files can be changed manually, we recommend While the scenario configuration files can be changed manually, we recommend
you use the :ref:`ACRN configurator tool <acrn_configurator_tool>`, which you use the :ref:`ACRN Configurator tool <acrn_configurator_tool>`, which
provides valid options and descriptions of the configuration entries. provides valid options and descriptions of the configuration entries.
The targets ``hvdiffconfig`` and ``hvapplydiffconfig`` are provided for users The targets ``hvdiffconfig`` and ``hvapplydiffconfig`` are provided for users

2
doc/tutorials/cpu_sharing.rst
View File

@ -137,7 +137,7 @@ Scheduler configuration
* The scheduler used at runtime is defined in the scenario XML file * The scheduler used at runtime is defined in the scenario XML file
via the :option:`hv.FEATURES.SCHEDULER` option. The default scheduler via the :option:`hv.FEATURES.SCHEDULER` option. The default scheduler
is **SCHED_BVT**. Use the :ref:`ACRN configurator tool <acrn_configurator_tool>` is **SCHED_BVT**. Use the :ref:`ACRN Configurator tool <acrn_configurator_tool>`
if you want to change this scenario option value. if you want to change this scenario option value.

2
doc/user-guides/acrn-dm-parameters.rst
View File

@ -342,7 +342,7 @@ arguments used for configuration. Here is a table describing these emulated dev
for shared memory between VMs. Parameters should be added with the format for shared memory between VMs. Parameters should be added with the format
``ivshmem,<shm_name>,<shm_size>``. ``<shm-name>`` specifies a shared memory ``ivshmem,<shm_name>,<shm_size>``. ``<shm-name>`` specifies a shared memory
name, and must be listed in ``hv.FEATURES.IVSHMEM.IVSHMEM_REGION`` name, and must be listed in ``hv.FEATURES.IVSHMEM.IVSHMEM_REGION``
as configured using the ACRN configurator tool UI, and needs to start as configured using the ACRN Configurator UI, and needs to start
with a ``dm:/`` prefix. with a ``dm:/`` prefix.
* - ``ahci`` * - ``ahci``