doc: fix all headings to use title case

While we hoped to make the headings consistent over time while doing
other edits, we should instead just make the squirrels happy and do them
all at once or they'll likely never be made consistent.

A python script was used to find the headings, and then a call to
https://pypi.org/project/titlecase to transform the title.  A visual
inspection was used to tweak a few unexpected resulting titles.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder
2021-02-12 16:27:24 -08:00
committed by David Kinder
parent 6e655d098b
commit 0bd384d41b
119 changed files with 576 additions and 638 deletions

View File

@@ -54,12 +54,12 @@ The ACRN hypervisor shell supports the following commands:
- Write ``value`` (in hexadecimal) to the Model-Specific Register (MSR) at
index ``msr_index`` (in hexadecimal) for CPU ID ``pcpu_id``
Command examples
Command Examples
****************
The following sections provide further details and examples for some of these commands.
vm_list
Vm_list
=======
``vm_list`` provides the name of each virtual machine and its corresponding ID and
@@ -70,7 +70,7 @@ state.
vm_list information
vcpu_list
Vcpu_list
=========
``vcpu_list`` provides information about virtual CPUs (vCPU), including
@@ -82,7 +82,7 @@ STATE (init, paused, running, zombie or unknown).
vcpu_list information
vcpu_dumpreg
Vcpu_dumpreg
============
``vcpu_dumpreg vmid cpuid`` provides vCPU related information such as
@@ -107,7 +107,7 @@ function ``acpi_idle_do_entry``.
system map information
dump_host_mem
Dump_host_mem
=============
``dump_host_mem hva length`` provides the specified memory target data such as
@@ -132,7 +132,7 @@ pCPU number is 0x0000000000000004.
acrn map information
dump_guest_mem
Dump_guest_mem
==============
The ``dump_guest_mem`` command can dump guest memory according to the given
@@ -152,13 +152,13 @@ in guest console or through the ``system.map`` (Note that the path for
guest memory information
vm_console
Vm_console
===========
The ``vm_console`` command switches the ACRN's console to become the VM's console.
Press :kbd:`Ctrl` + :kbd:`Space` to return to the ACRN shell console.
vioapic
Vioapic
=======
``vioapic <vm_id>`` shows the virtual IOAPIC information for a specific
@@ -170,7 +170,7 @@ VM1:
vioapic information
dump_ioapic
Dump_ioapic
===========
``dump_ioapic`` provides IOAPIC information and we can get IRQ number,
@@ -181,7 +181,7 @@ IRQ vector number, etc.
dump_ioapic information
pt
Pt
==
``pt`` provides passthrough detailed information, such as the virtual
@@ -193,7 +193,7 @@ trigger mode, etc.
pt information
int
Int
===
``int`` provides interrupt information on all CPUs and their corresponding
@@ -204,7 +204,7 @@ interrupt vector.
int information
cpuid
Cpuid
=====
``cpuid <leaf> [subleaf]`` provides the CPUID leaf [subleaf] in
@@ -215,7 +215,7 @@ hexadecimal.
cpuid information
rdmsr
RDMSR
=====
We can read model specific register (MSR) to get register
@@ -238,7 +238,7 @@ and see that 1B (Hexadecimal) is the IA32_APIC_BASE MSR address.
rdmsr information
wrmsr
WRMSR
=====
We can write model specific register (MSR) to set register

View File

@@ -3,7 +3,7 @@
ACRN Hypervisor Parameters
##########################
Generic hypervisor parameters
Generic Hypervisor Parameters
*****************************
The ACRN hypervisor supports the following parameter:

View File

@@ -3,7 +3,7 @@
ACRN Kernel Parameters
######################
Generic kernel parameters
Generic Kernel Parameters
*************************
A number of kernel parameters control the behavior of ACRN-based systems. Some
@@ -379,13 +379,13 @@ section below has more details on a few select parameters.
.. _GVT-g-kernel-options:
GVT-g (AcrnGT) Kernel Options details
GVT-g (AcrnGT) Kernel Options Details
=====================================
This section provides additional information and details on the kernel command
line options that are related to AcrnGT.
i915.enable_gvt
I915.enable_gvt
---------------
This option enables support for Intel GVT-g graphics virtualization
@@ -393,7 +393,7 @@ support in the host. By default, it's not enabled, so we need to add
``i915.enable_gvt=1`` in the Service VM kernel command line. This is a Service
OS only parameter, and cannot be enabled in the User VM.
i915.enable_hangcheck
I915.enable_hangcheck
=====================
This parameter enable detection of a GPU hang. When enabled, the i915