github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-07-05 19:47:48 +00:00
Code Issues Projects Releases Wiki Activity

doc: Update Configurator doc

Browse Source 
- Update per comments in PR 7781

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
This commit is contained in:
Reyes, Amy 2022-06-17 16:29:55 -07:00 committed by David Kinder
parent b34eb9ad1b
commit 55e13ec91c
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/tutorials/acrn_configurator_tool.rst
View File

@ -12,7 +12,8 @@ The ACRN Configurator ``acrn_configurator.py`` provides a user interface to help
you customize your :ref:`ACRN configuration <acrn_configuration_tool>`. you customize your :ref:`ACRN configuration <acrn_configuration_tool>`.
Capabilities: Capabilities:
* Reads board information from the specified board configuration file * Reads board information from the board configuration file generated by the
:ref:`board_inspector_tool`
* Helps you configure a scenario of hypervisor and VM settings * Helps you configure a scenario of hypervisor and VM settings
* Generates a scenario configuration file that stores the configured settings in * Generates a scenario configuration file that stores the configured settings in
XML format XML format
@ -181,7 +182,7 @@ Replace an Existing Board Configuration File
============================================ ============================================
After a board configuration file has been imported, you can choose to replace it After a board configuration file has been imported, you can choose to replace it
at any time. This option is useful, for example, when you need to iterate your at any time. This option is useful, for example, when you need to change your
board's configuration while you are customizing your hypervisor settings. board's configuration while you are customizing your hypervisor settings.
Whenever you change the configuration of your board, you must generate a new Whenever you change the configuration of your board, you must generate a new
board configuration file via the :ref:`board_inspector_tool`. Examples include board configuration file via the :ref:`board_inspector_tool`. Examples include
@ -249,8 +250,8 @@ information in the file to populate the UI, so that you can continue working on
the configuration where you left off. the configuration where you left off.
1. Due to the strict validation ACRN adopts, scenario configuration files for a 1. Due to the strict validation ACRN adopts, scenario configuration files for a
former release may not work for a latter if they are not upgraded. Starting former release may not work in the current release unless they are upgraded.
from v3.0, upgrade an older scenario XML per the steps in Starting from v3.0, upgrade an older scenario XML per the steps in
:ref:`upgrading_configuration` then import the upgraded file into the tool in :ref:`upgrading_configuration` then import the upgraded file into the tool in
the next step. the next step.
@ -297,13 +298,16 @@ Basic parameters are generally defined as:
* Parameters that are common for software like ACRN. * Parameters that are common for software like ACRN.
* Parameters that are anticipated to be commonly used for typical ACRN use
cases.
Advanced parameters are generally defined as: Advanced parameters are generally defined as:
* Parameters that are optional for ACRN configuration, compilation, and * Parameters that are optional for ACRN configuration, compilation, and
execution. execution. Default values cover most use cases.
* Parameters that are used for fine-grained tuning, such as reducing code * Parameters that are used for fine-grained tuning, such as reducing code
lines or optimizing performance. Default values cover most use cases. lines or optimizing performance.
Add a VM Add a VM
========= =========