From 55e13ec91c883521b6089a0095487f4c902fb5ad Mon Sep 17 00:00:00 2001 From: "Reyes, Amy" Date: Fri, 17 Jun 2022 16:29:55 -0700 Subject: [PATCH] doc: Update Configurator doc - Update per comments in PR 7781 Signed-off-by: Reyes, Amy --- doc/tutorials/acrn_configurator_tool.rst | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/doc/tutorials/acrn_configurator_tool.rst b/doc/tutorials/acrn_configurator_tool.rst index c69355ff3..c333b3324 100644 --- a/doc/tutorials/acrn_configurator_tool.rst +++ b/doc/tutorials/acrn_configurator_tool.rst @@ -12,7 +12,8 @@ The ACRN Configurator ``acrn_configurator.py`` provides a user interface to help you customize your :ref:`ACRN configuration `. 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 * Generates a scenario configuration file that stores the configured settings in 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 -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. Whenever you change the configuration of your board, you must generate a new 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. 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 - from v3.0, upgrade an older scenario XML per the steps in + former release may not work in the current release unless they are upgraded. + 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 the next step. @@ -297,13 +298,16 @@ Basic parameters are generally defined as: * 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: * 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 - lines or optimizing performance. Default values cover most use cases. + lines or optimizing performance. Add a VM =========