From 72f7119246923448f7db5ac2f18ec998b96da6e1 Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Tue, 29 Oct 2019 17:04:53 -0700 Subject: [PATCH] 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 --- doc/developer-guides/hld/hld-security.rst | 10 ++++++---- doc/developer-guides/hld/hv-cpu-virt.rst | 3 --- doc/developer-guides/hld/hv-virt-interrupt.rst | 2 +- doc/developer-guides/hld/index.rst | 1 - doc/developer-guides/hld/vuart-virt-hld.rst | 2 +- doc/tutorials/using_windows_as_uos.rst | 4 +++- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/developer-guides/hld/hld-security.rst b/doc/developer-guides/hld/hld-security.rst index 7af07d294..331406ecd 100644 --- a/doc/developer-guides/hld/hld-security.rst +++ b/doc/developer-guides/hld/hld-security.rst @@ -152,7 +152,7 @@ before launching. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ As shown in :numref:`security-bootflow-uefi`, in this boot sequence,UEFI authenticates and starts the ACRN hypervisor firstly,and hypervisor will return -to UEFI enviorment to authenticate and load SOS kernel bootloader. +to UEFI environment to authenticate and load SOS kernel bootloader. .. figure:: images/security-image-bootflow-uefi.png :width: 900px @@ -204,7 +204,8 @@ systems. To minimize the attack surfaces and achieve the goal of "defense in depth", there are many common guidelines to ensure the security of SOS system. -As shown in :numref:`security-bootflow` above, the integrity of the UOS +As shown in :numref:`security-bootflow-sbl` and +:numref:`security-bootflow-uefi` above, the integrity of the UOS depends on the integrity of the DM module and vBIOS/vOSloader in the SOS. Hence, SOS integrity is critical to the entire UOS security. If the SOS system is compromised, all the other guest UOS VMs may be @@ -833,8 +834,9 @@ Hypercall - Trusty Initialization When a UOS is created by the DM in the SOS, if this UOS supports a secure isolated world, then this hypercall will be invoked by OSLoader -(it could be Android OS loader in :numref:`security-bootflow` above) to -create / initialize the secure world (Trusty/TEE). +(it could be Android OS loader in :numref:`security-bootflow-sbl` and +:numref:`security-bootflow-uefi` above) to create / initialize the +secure world (Trusty/TEE). .. figure:: images/security-image9.png :width: 900px diff --git a/doc/developer-guides/hld/hv-cpu-virt.rst b/doc/developer-guides/hld/hv-cpu-virt.rst index 2995080fe..3e2861ab4 100644 --- a/doc/developer-guides/hld/hv-cpu-virt.rst +++ b/doc/developer-guides/hld/hv-cpu-virt.rst @@ -164,9 +164,6 @@ lifecycle: .. doxygenfunction:: create_vcpu :project: Project ACRN -.. doxygenfunction:: schedule_vcpu - :project: Project ACRN - .. doxygenfunction:: pause_vcpu :project: Project ACRN diff --git a/doc/developer-guides/hld/hv-virt-interrupt.rst b/doc/developer-guides/hld/hv-virt-interrupt.rst index 76a9d5440..54169e40b 100644 --- a/doc/developer-guides/hld/hv-virt-interrupt.rst +++ b/doc/developer-guides/hld/hv-virt-interrupt.rst @@ -98,7 +98,7 @@ an interrupt, for example: - from an emulated device for a MSI These APIs will finish by making a vCPU request. -_ + .. doxygenfunction:: vlapic_inject_intr :project: Project ACRN diff --git a/doc/developer-guides/hld/index.rst b/doc/developer-guides/hld/index.rst index 6996e96d9..49ff32ed8 100644 --- a/doc/developer-guides/hld/index.rst +++ b/doc/developer-guides/hld/index.rst @@ -21,7 +21,6 @@ system. Device Model Emulated Devices Virtio Devices - VM Management Power Management Tracing and Logging Virtual Bootloader diff --git a/doc/developer-guides/hld/vuart-virt-hld.rst b/doc/developer-guides/hld/vuart-virt-hld.rst index 5bb32b6f8..ce5df217a 100644 --- a/doc/developer-guides/hld/vuart-virt-hld.rst +++ b/doc/developer-guides/hld/vuart-virt-hld.rst @@ -1,7 +1,7 @@ .. _vuart_virtualization: vUART Virtualization -################### +#################### Architecture ************ diff --git a/doc/tutorials/using_windows_as_uos.rst b/doc/tutorials/using_windows_as_uos.rst index 9f21dadb3..7e84c1aea 100644 --- a/doc/tutorials/using_windows_as_uos.rst +++ b/doc/tutorials/using_windows_as_uos.rst @@ -329,7 +329,9 @@ together with the script used to install Windows 10. - Change ``-s 3,virtio-blk,./win10-ltsc-virtio.img`` to your path to the Windows 10 image. - Change ``-s 8,ahci,cd:./windows10-17763-107-LTSC-Virtio-Gfx.iso`` to the ISO you re-generated above. - Change ``-s 9,ahci,cd:./virtio-win-0.1.141.iso`` to your path to the virtio-win iso. - Or used Oracle driver + + Or if you used the Oracle driver: + - Change ``-s 9,ahci,cd:./winvirtio.iso`` to your path to the winvirtio iso. #. Run ``install_vga.sh`` and connect to the Windows guest using a vnc client.::