From 1ba9070d4094f6a7468ce46f1260b441f299b435 Mon Sep 17 00:00:00 2001 From: Amy Reyes Date: Wed, 24 Nov 2021 10:58:03 -0800 Subject: [PATCH] doc: terminology cleanup in config intro - Replace UOS or User OS with User VM - Capitalize ACRN Configurator and Board Inspector - Clean up some of the grammar Signed-off-by: Amy Reyes --- doc/tutorials/acrn_configuration_tool.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/tutorials/acrn_configuration_tool.rst b/doc/tutorials/acrn_configuration_tool.rst index 19471a851..7f97e0dca 100644 --- a/doc/tutorials/acrn_configuration_tool.rst +++ b/doc/tutorials/acrn_configuration_tool.rst @@ -13,9 +13,9 @@ ACRN configuration consists of the following key components. * A configuration toolset that helps users to generate and edit configuration data. The toolset includes: - - **Board inspector**: Collects board-specific information on target + - **Board Inspector**: Collects board-specific information on target machines. - - **ACRN configurator**: Enables you to edit configuration data via a + - **ACRN Configurator**: Enables you to edit configuration data via a web-based UI. The following sections introduce the concepts and tools of ACRN configuration @@ -121,8 +121,8 @@ Using ACRN Configuration Toolset The ACRN configuration toolset enables you to create and edit configuration data. The toolset consists of the following: -* :ref:`Board inspector tool ` -* :ref:`ACRN configurator tool ` +* :ref:`Board Inspector ` +* :ref:`ACRN Configurator ` As introduced in :ref:`overview_dev`, configuration takes place at :ref:`overview_dev_board_config` and :ref:`overview_dev_config_editor` in @@ -162,7 +162,7 @@ The ``board`` attribute defines the board name and must match the configuration file. The file name of the board configuration file (example: ``my_board.xml``) doesn't affect the board name. -Board XML files are input to the ACRN configurator tool and the build system, +Board XML files are input to the ACRN Configurator tool and the build system, and are not intended for end users to modify. Scenario XML Format @@ -188,11 +188,11 @@ Launch XML Format ================= The launch XML has an ``acrn-config`` root element as well as -``board``, ``scenario`` and ``uos_launcher`` attributes: +``board``, ``scenario``, and ``user_vm_launcher`` attributes: .. code-block:: xml - + The ``board`` attribute specifies the board name and must match the ``board`` attribute in the board configuration file and the scenario configuration file. @@ -200,8 +200,8 @@ attribute in the board configuration file and the scenario configuration file. The ``scenario`` attribute specifies the scenario name and must match the ``scenario`` attribute in the scenario configuration file. -The ``uos_launcher`` attribute specifies the number of post-launched User VMs -in a scenario. +The ``user_vm_launcher`` attribute specifies the number of post-launched User +VMs in a scenario. See :ref:`launch-config-options` for a full explanation of available launch XML elements.