doc: discourage modifications to predefined scenario XMLs

This patch modifies the instructions that lead users to modify predefined
scenario XMLs under ``misc/config_tools/data`` which is not a preferred
way. It is recommended to make and edit a local copy, instead.

Also fixes a few references to ``misc/vm_configs`` which has been moved.

v2:
 * fix typos in paths
 * explain on the candidate values of ``port_base`` and ``irq`` fields

Tracked-On: #5644
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
This commit is contained in:
Junjie Mao
2021-03-04 14:12:29 +08:00
committed by fitchbe
parent c0da58c7ec
commit 42fd1b1d5c
4 changed files with 34 additions and 53 deletions

View File

@@ -95,9 +95,11 @@ Usage
- For console vUART
To enable the console port for a VM, change the
port_base and IRQ in ``misc/vm_configs/scenarios/<scenario
name>/vm_configurations.c``. If the IRQ number has been used in your
To enable the console port for a VM, change the ``port_base`` and ``irq``
fields in
``configs/scenarios/<scenario name>/vm_configurations.c`` under the
hypervisor build directory using the combinations listed below. If the IRQ
number has been used in your
system ( ``cat /proc/interrupt``), you can choose other IRQ number. Set
the ``.irq =0``, the vUART will work in polling mode.