From b9cad70614294ae2c928e6abc5e9479bcd060fad Mon Sep 17 00:00:00 2001 From: Amy Reyes Date: Tue, 5 Oct 2021 11:27:57 -0700 Subject: [PATCH] doc: Change "configuration tool" to "ACRN configurator tool" - Change "configuration tool" to "ACRN configurator tool" to match the tool's UI - Change "configuration toolset" to "ACRN configurator tool" in cases that clearly refer to the configurator and not the entire toolset, update cross-ref Signed-off-by: Amy Reyes --- doc/developer-guides/doc_guidelines.rst | 9 ++++---- doc/developer-guides/hld/hld-splitlock.rst | 2 +- .../hld/hv-dev-passthrough.rst | 2 +- doc/glossary.rst | 2 +- doc/tutorials/enable_ivshmem.rst | 21 +++++++++++-------- doc/tutorials/vuart_configuration.rst | 2 +- 6 files changed, 21 insertions(+), 17 deletions(-) diff --git a/doc/developer-guides/doc_guidelines.rst b/doc/developer-guides/doc_guidelines.rst index 4bd420d61..194112fee 100644 --- a/doc/developer-guides/doc_guidelines.rst +++ b/doc/developer-guides/doc_guidelines.rst @@ -681,7 +681,8 @@ header files, along with some prose documentation in ``.rst`` files. The ACRN configuration option documentation is created based on details maintained in schema definition files (``.xsd``) in the ``misc/config_tools/schema`` folder. These schema -definition files are used by the configuration tool to validate the XML scenario +definition files are used by the ACRN configurator tool to validate the XML +scenario configuration files as well as to hold documentation about each option. For example: @@ -697,10 +698,10 @@ example: During the documentation ``make html`` processing, the documentation annotations -in the ``.xsd`` files are extracted and transformed into restructureText using +in the ``.xsd`` files are extracted and transformed into reStructuredText using an XSLT transformation found in ``doc/scripts/configdoc.xsl``. The generated -option documentation is organized and formatted to make it easy to created links -to specific option descriptions using an ``:option:`` role, for example +option documentation is organized and formatted to make it easy to create links +to specific option descriptions using an ``:option:`` role, for example, ``:option:`hv.DEBUG_OPTIONS.RELEASE``` would link to :option:`hv.DEBUG_OPTIONS.RELEASE`. diff --git a/doc/developer-guides/hld/hld-splitlock.rst b/doc/developer-guides/hld/hld-splitlock.rst index 4791378c6..418c5f9bb 100644 --- a/doc/developer-guides/hld/hld-splitlock.rst +++ b/doc/developer-guides/hld/hld-splitlock.rst @@ -133,5 +133,5 @@ Disable Split-Locked Access Detection If the CPU supports Split-locked Access detection, the ACRN hypervisor uses it to prevent any VM running with potential system performance impacting split-locked instructions. This detection can be disabled -(eventually by using the ACRN configuration tools) for customers not +(eventually by using the ACRN configurator tool) for customers not caring about system performance. diff --git a/doc/developer-guides/hld/hv-dev-passthrough.rst b/doc/developer-guides/hld/hv-dev-passthrough.rst index dbe735050..d83b4db07 100644 --- a/doc/developer-guides/hld/hv-dev-passthrough.rst +++ b/doc/developer-guides/hld/hv-dev-passthrough.rst @@ -414,7 +414,7 @@ VM. When you enable PTM, the passthrough device is connected to a virtual root port instead of the host bridge. By default, the :ref:`vm.PTM` option is disabled in ACRN VMs. Use the -:ref:`ACRN configuration tool ` to enable PTM +:ref:`ACRN configurator tool ` to enable PTM in the scenario XML file that configures the Guest VM. Here is an example launch script that configures a supported Ethernet card for diff --git a/doc/glossary.rst b/doc/glossary.rst index bfe1a653d..2b93dda5e 100644 --- a/doc/glossary.rst +++ b/doc/glossary.rst @@ -136,7 +136,7 @@ Glossary of Terms Scenario A collection of hypervisor and VM configuration settings that define an ACRN-based application's environment. A scenario configuration is stored - in a scenario XML file and edited using a GUI configuration 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 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 diff --git a/doc/tutorials/enable_ivshmem.rst b/doc/tutorials/enable_ivshmem.rst index 848e3b2f0..36a280c95 100644 --- a/doc/tutorials/enable_ivshmem.rst +++ b/doc/tutorials/enable_ivshmem.rst @@ -13,14 +13,15 @@ Enable Ivshmem Support ********************** The ``ivshmem`` solution is disabled by default in ACRN. You can enable -it using the :ref:`ACRN configuration toolset ` with these +it using the :ref:`ACRN configurator tool ` with these steps: -- Enable ``ivshmem`` via ACRN configuration tool GUI. +- Enable ``ivshmem`` via ACRN configurator tool GUI. - Set :option:`hv.FEATURES.IVSHMEM.IVSHMEM_ENABLED` to ``y`` - - Edit :option:`hv.FEATURES.IVSHMEM.IVSHMEM_REGION` to specify the shared memory name, size and + - Edit :option:`hv.FEATURES.IVSHMEM.IVSHMEM_REGION` to specify the shared + memory name, size and communication VMs. The ``IVSHMEM_REGION`` format is ``shm_name,shm_size,VM IDs``: - ``shm_name`` - Specify a shared memory name. The name needs to start @@ -59,13 +60,15 @@ where - ``shm_size`` - Shared memory size of selected ``shm_name``. -There are two ways to insert above boot parameter for ``acrn-dm`` +There are two ways to insert the above boot parameter for ``acrn-dm``: -- Manually edit launch script file, in this case, user shall ensure that both - ``shm_name`` and ``shm_size`` match with that are defined via configuration tool GUI. +- Manually edit the launch script file. In this case, ensure that both + ``shm_name`` and ``shm_size`` match those defined via the ACRN configurator + tool. -- Use the command following below format to create a launch script, when IVSHMEM is enabled - and :option:`hv.FEATURES.IVSHMEM.IVSHMEM_REGION` is properly configured via configuration tool GUI. +- Use the following command to create a launch script, when IVSHMEM is enabled + and :option:`hv.FEATURES.IVSHMEM.IVSHMEM_REGION` is properly configured via + the ACRN configurator tool. .. code-block:: none :emphasize-lines: 5 @@ -73,7 +76,7 @@ There are two ways to insert above boot parameter for ``acrn-dm`` python3 misc/config_tools/launch_config/launch_cfg_gen.py \ --board \ --scenario \ - --launch \ + --launch \ --uosid .. note:: This device can be used with real-time VM (RTVM) as well. diff --git a/doc/tutorials/vuart_configuration.rst b/doc/tutorials/vuart_configuration.rst index 0cd0c31fe..3e179ab0d 100644 --- a/doc/tutorials/vuart_configuration.rst +++ b/doc/tutorials/vuart_configuration.rst @@ -12,7 +12,7 @@ only works on a single function. Only two vUART configurations are added to the predefined scenarios, but you can customize the scenarios to enable more using the :ref:`ACRN -configuration toolset `. +configurator tool `. Console Enable List ===================