github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-09-08 20:29:40 +00:00
Code Issues Projects Releases Wiki Activity

doc: Change "configuration tool" to "ACRN configurator tool"

Browse Source 
- 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 <amy.reyes@intel.com>
This commit is contained in:
Amy Reyes
2021-10-05 11:27:57 -07:00
committed by David Kinder
parent 7bcfd58f05
commit b9cad70614
6 changed files with 21 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -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:
</xs:element>
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`.

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

@@ -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.

2
doc/developer-guides/hld/hv-dev-passthrough.rst
View File

@@ -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 <acrn_configuration_tool>` to enable PTM
:ref:`ACRN configurator tool <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