mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-06-30 09:12:57 +00:00
doc: fix utf8 chars and missing EOF newlines
Fix some stray and missing characters, and extra newlines. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
parent
6d7d417a9f
commit
732a399215
@ -157,10 +157,10 @@ The board XML has an ``acrn-config`` root element and a
|
|||||||
|
|
||||||
<acrn-config board="BOARD">
|
<acrn-config board="BOARD">
|
||||||
|
|
||||||
The ``board`` attribute defines the board name and must match the
|
The ``board`` attribute defines the board name and must match the
|
||||||
``board`` attribute in the scenario configuration file and the launch
|
``board`` attribute in the scenario configuration file and the launch
|
||||||
configuration file. The file name of the board configuration file
|
configuration file. The file name of the board configuration file
|
||||||
(example: ``my_board.xml``) doesn’t affect the board name.
|
(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.
|
and are not intended for end users to modify.
|
||||||
|
@ -8,7 +8,7 @@ This guide describes all features and uses of the tool.
|
|||||||
About the ACRN Configurator Tool
|
About the ACRN Configurator Tool
|
||||||
*********************************
|
*********************************
|
||||||
|
|
||||||
The ACRN configurator tool ``acrn_configurator.py`` provides a web-based
|
The ACRN configurator tool ``acrn_configurator.py`` provides a web-based
|
||||||
user interface to help you customize your
|
user interface to help you customize your
|
||||||
:ref:`ACRN configuration <acrn_configuration_tool>`. Capabilities:
|
:ref:`ACRN configuration <acrn_configuration_tool>`. Capabilities:
|
||||||
|
|
||||||
@ -51,7 +51,7 @@ a custom scenario configuration file and launch scripts.
|
|||||||
#. Make sure the development computer is set up and ready to launch the ACRN
|
#. Make sure the development computer is set up and ready to launch the ACRN
|
||||||
configurator, according to :ref:`gsg-dev-setup` in the Getting Started Guide.
|
configurator, according to :ref:`gsg-dev-setup` in the Getting Started Guide.
|
||||||
|
|
||||||
#. Launch the ACRN configurator. This example assumes the tool is in the
|
#. Launch the ACRN configurator. This example assumes the tool is in the
|
||||||
``~/acrn-work/`` directory. Feel free to modify the command as needed.
|
``~/acrn-work/`` directory. Feel free to modify the command as needed.
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
@ -72,19 +72,19 @@ a custom scenario configuration file and launch scripts.
|
|||||||
scenario configuration file via the **Import XML** button. The four options
|
scenario configuration file via the **Import XML** button. The four options
|
||||||
are described below:
|
are described below:
|
||||||
|
|
||||||
* Click **Create a new scenario** from the **Scenario Setting** menu to
|
* Click **Create a new scenario** from the **Scenario Setting** menu to
|
||||||
dynamically create a new scenario configuration for the current board.
|
dynamically create a new scenario configuration for the current board.
|
||||||
|
|
||||||
* Click **Load a default scenario** from the **Scenario Setting** menu to
|
* Click **Load a default scenario** from the **Scenario Setting** menu to
|
||||||
select a :ref:`predefined scenario configuration <usage-scenarios>`.
|
select a :ref:`predefined scenario configuration <usage-scenarios>`.
|
||||||
|
|
||||||
* Click the **Scenario Setting** menu and select a scenario from the list
|
* Click the **Scenario Setting** menu and select a scenario from the list
|
||||||
under **scenario setting list**.
|
under **scenario setting list**.
|
||||||
|
|
||||||
.. image:: images/choose_scenario.png
|
.. image:: images/choose_scenario.png
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
* Click the **Import XML** button to import a customized scenario
|
* Click the **Import XML** button to import a customized scenario
|
||||||
configuration file.
|
configuration file.
|
||||||
The file must be one that was written for the current board. Any mismatch
|
The file must be one that was written for the current board. Any mismatch
|
||||||
in the board name and the one found in the scenario configuration file you
|
in the board name and the one found in the scenario configuration file you
|
||||||
@ -106,10 +106,10 @@ a custom scenario configuration file and launch scripts.
|
|||||||
|
|
||||||
#. Add or delete VMs:
|
#. Add or delete VMs:
|
||||||
|
|
||||||
* Click **Add a VM below** in a VM’s settings, and then select a VM type
|
* Click **Add a VM below** in a VM's settings, and then select a VM type
|
||||||
to add a new VM under the current VM.
|
to add a new VM under the current VM.
|
||||||
|
|
||||||
* Click **Remove this VM** in a VM’s settings to remove the VM from the
|
* Click **Remove this VM** in a VM's settings to remove the VM from the
|
||||||
scenario.
|
scenario.
|
||||||
|
|
||||||
When a VM is added or removed, the configurator reassigns the VM IDs for
|
When a VM is added or removed, the configurator reassigns the VM IDs for
|
||||||
@ -119,11 +119,10 @@ a custom scenario configuration file and launch scripts.
|
|||||||
.. image:: images/configure_vm_add.png
|
.. image:: images/configure_vm_add.png
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
#. Click **Export XML** to save the scenario configuration file. A dialog box
|
#. Click **Export XML** to save the scenario configuration file. A dialog box
|
||||||
appears, enabling you to save the file to a specific folder by inputting the
|
appears, enabling you to save the file to a specific folder by inputting the
|
||||||
absolute path to this folder. If you don’t specify a path, the file will be
|
absolute path to this folder. If you don't specify a path, the file will be
|
||||||
saved to the default folder:
|
saved to the default folder: ``acrn-hypervisor/../user_config/<board name>``.
|
||||||
``acrn-hypervisor/../user_config/<board name>``.
|
|
||||||
|
|
||||||
Before saving the scenario configuration file, the configurator validates
|
Before saving the scenario configuration file, the configurator validates
|
||||||
the configurable items. If errors exist, the configurator lists all
|
the configurable items. If errors exist, the configurator lists all
|
||||||
@ -135,7 +134,7 @@ a custom scenario configuration file and launch scripts.
|
|||||||
After the scenario is saved, the page automatically displays the saved
|
After the scenario is saved, the page automatically displays the saved
|
||||||
scenario configuration file.
|
scenario configuration file.
|
||||||
|
|
||||||
#. To delete a scenario configuration file, click **Export XML** > **Remove**.
|
#. To delete a scenario configuration file, click **Export XML** > **Remove**.
|
||||||
The configurator will delete the loaded file, even if you change the name of
|
The configurator will delete the loaded file, even if you change the name of
|
||||||
the file in the dialog box.
|
the file in the dialog box.
|
||||||
|
|
||||||
@ -148,23 +147,23 @@ a custom scenario configuration file and launch scripts.
|
|||||||
the UI or by importing a launch configuration file via the **Import XML**
|
the UI or by importing a launch configuration file via the **Import XML**
|
||||||
button. The four options are described below:
|
button. The four options are described below:
|
||||||
|
|
||||||
* Click **Create a new launch script** from the **Launch Setting** menu to
|
* Click **Create a new launch script** from the **Launch Setting** menu to
|
||||||
dynamically create a new launch configuration for the current board.
|
dynamically create a new launch configuration for the current board.
|
||||||
|
|
||||||
* Click **Load a default launch script** from the **Launch Setting** menu to
|
* Click **Load a default launch script** from the **Launch Setting** menu to
|
||||||
select a predefined launch configuration.
|
select a predefined launch configuration.
|
||||||
|
|
||||||
* Click the **Launch Setting** menu and select a launch configuration
|
* Click the **Launch Setting** menu and select a launch configuration
|
||||||
from the list under **launch setting list**.
|
from the list under **launch setting list**.
|
||||||
|
|
||||||
.. image:: images/choose_launch.png
|
.. image:: images/choose_launch.png
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
* Click the **Import XML** button to import a customized launch
|
* Click the **Import XML** button to import a customized launch
|
||||||
configuration file.
|
configuration file.
|
||||||
|
|
||||||
#. Select a scenario for the current launch configuration from the
|
#. Select a scenario for the current launch configuration from the
|
||||||
**Select Scenario** drop-down box.
|
**Select Scenario** drop-down box.
|
||||||
|
|
||||||
#. When the launch configuration file is available for editing, the
|
#. When the launch configuration file is available for editing, the
|
||||||
configurable items appear below the **Launch Setting** row. You may need
|
configurable items appear below the **Launch Setting** row. You may need
|
||||||
@ -182,28 +181,28 @@ a custom scenario configuration file and launch scripts.
|
|||||||
|
|
||||||
#. Add or remove User VM (UOS) launch scripts:
|
#. Add or remove User VM (UOS) launch scripts:
|
||||||
|
|
||||||
* Click **Configure an UOS below** to add a User VM launch script.
|
* Click **Configure an UOS below** to add a User VM launch script.
|
||||||
|
|
||||||
* Click **Remove this VM** to remove a User VM launch script.
|
* Click **Remove this VM** to remove a User VM launch script.
|
||||||
|
|
||||||
.. image:: images/configure_launch_add.png
|
.. image:: images/configure_launch_add.png
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
#. Click **Export XML** to save the launch configuration file. A dialog box
|
#. Click **Export XML** to save the launch configuration file. A dialog box
|
||||||
appears, enabling you to save the file to a specific folder by inputting the
|
appears, enabling you to save the file to a specific folder by inputting the
|
||||||
absolute path to this folder. If you don’t specify a path, the file will
|
absolute path to this folder. If you don't specify a path, the file will
|
||||||
be saved to the default folder:
|
be saved to the default folder:
|
||||||
``acrn-hypervisor/../user_config/<board name>``.
|
``acrn-hypervisor/../user_config/<board name>``.
|
||||||
|
|
||||||
Before saving the launch configuration file, the configurator validates the
|
Before saving the launch configuration file, the configurator validates the
|
||||||
configurable items. If errors exist, the configurator lists all incorrectly
|
configurable items. If errors exist, the configurator lists all incorrectly
|
||||||
configured items and shows the errors.
|
configured items and shows the errors.
|
||||||
|
|
||||||
#. To delete a launch configuration file, click **Export XML** > **Remove**.
|
#. To delete a launch configuration file, click **Export XML** > **Remove**.
|
||||||
The configurator will delete the loaded file, even if you change the name of
|
The configurator will delete the loaded file, even if you change the name of
|
||||||
the file in the dialog box.
|
the file in the dialog box.
|
||||||
|
|
||||||
#. Click **Generate Launch Script** to save the current launch configuration
|
#. Click **Generate Launch Script** to save the current launch configuration
|
||||||
and then generate a launch script for each VM defined in the launch
|
and then generate a launch script for each VM defined in the launch
|
||||||
configuration.
|
configuration.
|
||||||
|
|
||||||
|
@ -35,8 +35,8 @@ a board configuration file.
|
|||||||
sudo modprobe msr
|
sudo modprobe msr
|
||||||
|
|
||||||
#. Run the board inspector tool (``board_inspector.py``) to generate the board
|
#. Run the board inspector tool (``board_inspector.py``) to generate the board
|
||||||
configuration file. This example assumes the tool is in the
|
configuration file. This example assumes the tool is in the
|
||||||
``~/acrn-work/`` directory and ``my_board`` is the desired file
|
``~/acrn-work/`` directory and ``my_board`` is the desired file
|
||||||
name. Feel free to modify the commands as needed.
|
name. Feel free to modify the commands as needed.
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
@ -50,7 +50,7 @@ a board configuration file.
|
|||||||
|
|
||||||
PTCT table has been saved to PTCT successfully!
|
PTCT table has been saved to PTCT successfully!
|
||||||
|
|
||||||
#. Confirm that the board configuration file ``my_board.xml`` was generated in
|
#. Confirm that the board configuration file ``my_board.xml`` was generated in
|
||||||
the current directory.
|
the current directory.
|
||||||
|
|
||||||
.. _board_inspector_cl:
|
.. _board_inspector_cl:
|
||||||
@ -67,19 +67,13 @@ board inspector with the ``-h`` option yields the following usage message:
|
|||||||
[--check-device-status] board_name
|
[--check-device-status] board_name
|
||||||
|
|
||||||
positional arguments:
|
positional arguments:
|
||||||
|
|
||||||
board_name the name of the board that runs the ACRN hypervisor
|
board_name the name of the board that runs the ACRN hypervisor
|
||||||
|
|
||||||
optional arguments:
|
optional arguments:
|
||||||
|
|
||||||
-h, --help show this help message and exit
|
-h, --help show this help message and exit
|
||||||
|
|
||||||
--out OUT the name of board info file
|
--out OUT the name of board info file
|
||||||
|
|
||||||
--basic do not extract advanced information such as ACPI namespace
|
--basic do not extract advanced information such as ACPI namespace
|
||||||
|
|
||||||
--loglevel LOGLEVEL choose log level, e.g. info, warning or error
|
--loglevel LOGLEVEL choose log level, e.g. info, warning or error
|
||||||
|
|
||||||
--check-device-status
|
--check-device-status
|
||||||
|
|
||||||
filter out devices whose _STA object evaluates to 0
|
filter out devices whose _STA object evaluates to 0
|
||||||
|
Loading…
Reference in New Issue
Block a user