Skip to content

Commit 72f7119

Browse files
dbkinderwenlingz
authored andcommitted
doc: fix doc build errors previously masked
As reported in PR #3959, doc build errors were being masked by a script error. This PR fixes a chunk of them. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
1 parent 2a6f2fa commit 72f7119

File tree

6 files changed

+11
-11
lines changed

6 files changed

+11
-11
lines changed

doc/developer-guides/hld/hld-security.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ before launching.
152152
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153153
As shown in :numref:`security-bootflow-uefi`, in this boot sequence,UEFI
154154
authenticates and starts the ACRN hypervisor firstly,and hypervisor will return
155-
to UEFI enviorment to authenticate and load SOS kernel bootloader.
155+
to UEFI environment to authenticate and load SOS kernel bootloader.
156156

157157
.. figure:: images/security-image-bootflow-uefi.png
158158
:width: 900px
@@ -204,7 +204,8 @@ systems. To minimize the attack surfaces and achieve the goal of
204204
"defense in depth", there are many common guidelines to ensure the
205205
security of SOS system.
206206

207-
As shown in :numref:`security-bootflow` above, the integrity of the UOS
207+
As shown in :numref:`security-bootflow-sbl` and
208+
:numref:`security-bootflow-uefi` above, the integrity of the UOS
208209
depends on the integrity of the DM module and vBIOS/vOSloader in the
209210
SOS. Hence, SOS integrity is critical to the entire UOS security. If the
210211
SOS system is compromised, all the other guest UOS VMs may be
@@ -833,8 +834,9 @@ Hypercall - Trusty Initialization
833834

834835
When a UOS is created by the DM in the SOS, if this UOS supports a
835836
secure isolated world, then this hypercall will be invoked by OSLoader
836-
(it could be Android OS loader in :numref:`security-bootflow` above) to
837-
create / initialize the secure world (Trusty/TEE).
837+
(it could be Android OS loader in :numref:`security-bootflow-sbl` and
838+
:numref:`security-bootflow-uefi` above) to create / initialize the
839+
secure world (Trusty/TEE).
838840

839841
.. figure:: images/security-image9.png
840842
:width: 900px

doc/developer-guides/hld/hv-cpu-virt.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,9 +164,6 @@ lifecycle:
164164
.. doxygenfunction:: create_vcpu
165165
:project: Project ACRN
166166

167-
.. doxygenfunction:: schedule_vcpu
168-
:project: Project ACRN
169-
170167
.. doxygenfunction:: pause_vcpu
171168
:project: Project ACRN
172169

doc/developer-guides/hld/hv-virt-interrupt.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ an interrupt, for example:
9898
- from an emulated device for a MSI
9999

100100
These APIs will finish by making a vCPU request.
101-
_
101+
102102
.. doxygenfunction:: vlapic_inject_intr
103103
:project: Project ACRN
104104

doc/developer-guides/hld/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ system.
2121
Device Model <hld-devicemodel>
2222
Emulated Devices <hld-emulated-devices>
2323
Virtio Devices <hld-virtio-devices>
24-
VM Management <hld-vm-management>
2524
Power Management <hld-power-management>
2625
Tracing and Logging <hld-trace-log>
2726
Virtual Bootloader <hld-vsbl>

doc/developer-guides/hld/vuart-virt-hld.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _vuart_virtualization:
22

33
vUART Virtualization
4-
###################
4+
####################
55

66
Architecture
77
************

doc/tutorials/using_windows_as_uos.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,9 @@ together with the script used to install Windows 10.
329329
- Change ``-s 3,virtio-blk,./win10-ltsc-virtio.img`` to your path to the Windows 10 image.
330330
- Change ``-s 8,ahci,cd:./windows10-17763-107-LTSC-Virtio-Gfx.iso`` to the ISO you re-generated above.
331331
- Change ``-s 9,ahci,cd:./virtio-win-0.1.141.iso`` to your path to the virtio-win iso.
332-
Or used Oracle driver
332+
333+
Or if you used the Oracle driver:
334+
333335
- Change ``-s 9,ahci,cd:./winvirtio.iso`` to your path to the winvirtio iso.
334336

335337
#. Run ``install_vga.sh`` and connect to the Windows guest using a vnc client.::

0 commit comments

Comments
 (0)