From 1df539b76c7ab6024a6875d2f9d783a7a38136e1 Mon Sep 17 00:00:00 2001 From: Deb Taylor Date: Fri, 1 May 2020 09:55:15 -0400 Subject: [PATCH] Doc: Updated "Advanced Guides" titles for naming consistency Updated WaaG file Signed-off-by: Deb Taylor --- doc/develop.rst | 29 ++++++++++--------- doc/tutorials/acrn-dm_QoS.rst | 4 +-- doc/tutorials/acrn_ootb.rst | 2 +- doc/tutorials/agl-vms.rst | 4 +-- doc/tutorials/building_acrn_in_docker.rst | 4 +-- .../building_uos_from_clearlinux.rst | 12 ++++---- doc/tutorials/cpu_sharing.rst | 4 +-- doc/tutorials/enable_laag_secure_boot.rst | 4 +-- doc/tutorials/enable_s5.rst | 23 ++++++++------- doc/tutorials/increase-uos-disk-size.rst | 8 ++--- doc/tutorials/kbl-nuc-sdc.rst | 4 +-- doc/tutorials/open_vswitch.rst | 4 +-- doc/tutorials/rdt_configuration.rst | 4 +-- doc/tutorials/realtime_performance_tuning.rst | 4 +-- .../rtvm_workload_design_guideline.rst | 2 +- doc/tutorials/running_deb_as_serv_vm.rst | 4 +-- doc/tutorials/running_deb_as_user_vm.rst | 4 +-- doc/tutorials/running_ubun_as_user_vm.rst | 4 +-- doc/tutorials/sgx_virtualization.rst | 4 +-- doc/tutorials/sign_clear_linux_image.rst | 4 +-- doc/tutorials/skl-nuc.rst | 5 ++-- doc/tutorials/sriov_virtualization.rst | 8 ++--- doc/tutorials/static-ip.rst | 14 ++++----- doc/tutorials/trustyACRN.rst | 4 +-- doc/tutorials/up2.rst | 4 +-- doc/tutorials/using_celadon_as_uos.rst | 12 ++++---- doc/tutorials/using_sbl_on_up2.rst | 8 ++--- doc/tutorials/using_ubuntu_as_sos.rst | 4 +-- doc/tutorials/using_vxworks_as_uos.rst | 8 ++--- doc/tutorials/using_windows_as_uos.rst | 6 ++-- doc/tutorials/using_xenomai_as_uos.rst | 4 +-- doc/tutorials/using_zephyr_as_uos.rst | 4 +-- doc/tutorials/vuart_configuration.rst | 4 +-- doc/tutorials/waag-secure-boot.rst | 4 +-- 34 files changed, 111 insertions(+), 110 deletions(-) diff --git a/doc/develop.rst b/doc/develop.rst index a7573c65f..0996a528b 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -35,15 +35,15 @@ User VM Tutorials .. toctree:: :maxdepth: 1 - tutorials/agl-vms - tutorials/using_celadon_as_uos tutorials/building_uos_from_clearlinux - tutorials/using_vxworks_as_uos tutorials/using_windows_as_uos - tutorials/using_zephyr_as_uos - tutorials/running_deb_as_user_vm tutorials/running_ubun_as_user_vm + tutorials/running_deb_as_user_vm tutorials/using_xenomai_as_uos + tutorials/using_celadon_as_uos + tutorials/using_vxworks_as_uos + tutorials/using_zephyr_as_uos + tutorials/agl-vms Enable ACRN Features ******************** @@ -53,18 +53,18 @@ Enable ACRN Features tutorials/acrn-dm_QoS tutorials/open_vswitch - tutorials/rtvm_workload_design_guideline tutorials/sgx_virtualization tutorials/vuart_configuration - tutorials/skl-nuc tutorials/rdt_configuration tutorials/using_sbl_on_up2 - tutorials/trustyACRN - tutorials/run_kata_containers tutorials/waag-secure-boot tutorials/enable_s5 tutorials/cpu_sharing tutorials/sriov_virtualization + tutorials/skl-nuc + tutorials/run_kata_containers + tutorials/trustyACRN + tutorials/rtvm_workload_design_guideline Debug ***** @@ -83,12 +83,13 @@ Additional Tutorials :maxdepth: 1 tutorials/up2 - tutorials/increase-uos-disk-size - tutorials/sign_clear_linux_image - tutorials/static-ip - tutorials/kbl-nuc-sdc - tutorials/enable_laag_secure_boot tutorials/building_acrn_in_docker tutorials/acrn_ootb + tutorials/static-ip + tutorials/increase-uos-disk-size + tutorials/sign_clear_linux_image + tutorials/enable_laag_secure_boot + tutorials/kbl-nuc-sdc + diff --git a/doc/tutorials/acrn-dm_QoS.rst b/doc/tutorials/acrn-dm_QoS.rst index 7f908d0d7..00796f493 100644 --- a/doc/tutorials/acrn-dm_QoS.rst +++ b/doc/tutorials/acrn-dm_QoS.rst @@ -1,7 +1,7 @@ .. _acrn-dm_qos: -Enable QoS based on runC container -################################## +Enable QoS based on runC Containers +################################### This document describes how ACRN supports Device-Model Quality of Service (QoS) based on using runC containers to control the Service VM resources (CPU, Storage, Memory, Network) by modifying the runC configuration file. diff --git a/doc/tutorials/acrn_ootb.rst b/doc/tutorials/acrn_ootb.rst index 598634dc8..e98c7100a 100644 --- a/doc/tutorials/acrn_ootb.rst +++ b/doc/tutorials/acrn_ootb.rst @@ -1,6 +1,6 @@ .. _acrn_ootb: -Install ACRN Out-of-the-box +Install ACRN Out of the Box ########################### In this tutorial, we will learn to generate an out-of-the-box (OOTB) diff --git a/doc/tutorials/agl-vms.rst b/doc/tutorials/agl-vms.rst index 956fffbe0..f98cd6c38 100644 --- a/doc/tutorials/agl-vms.rst +++ b/doc/tutorials/agl-vms.rst @@ -2,8 +2,8 @@ .. _agl-vms: -Running AGL as VMs -################## +Run two AGL images as User VMs +############################## This document describes how to run two Automotive Grade Linux (AGL) images as VMs on the ACRN hypervisor. This serves as the baseline for diff --git a/doc/tutorials/building_acrn_in_docker.rst b/doc/tutorials/building_acrn_in_docker.rst index ff787fdcf..709959f5e 100644 --- a/doc/tutorials/building_acrn_in_docker.rst +++ b/doc/tutorials/building_acrn_in_docker.rst @@ -1,7 +1,7 @@ .. _building-acrn-in-docker: -Building ACRN in Docker -####################### +Build ACRN in Docker +#################### This tutorial shows how to build ACRN in a Clear Linux Docker image. diff --git a/doc/tutorials/building_uos_from_clearlinux.rst b/doc/tutorials/building_uos_from_clearlinux.rst index 46600a5c4..1ded94141 100644 --- a/doc/tutorials/building_uos_from_clearlinux.rst +++ b/doc/tutorials/building_uos_from_clearlinux.rst @@ -1,15 +1,15 @@ .. _build User VM from Clearlinux: -Building User VM from Clear Linux OS -#################################### +Build a User VM from the Clear Linux OS +####################################### -This document builds on the :ref:`getting_started`, +This document builds on :ref:`getting_started`, and explains how to build a User VM from Clear Linux OS. -Build User VM image in Clear Linux OS -************************************* +Build User VM image from Clear Linux OS +*************************************** -Follow these steps to build a User VM image from Clear Linux OS: +Follow these steps to build a User VM image from the Clear Linux OS: #. In Clear Linux OS, install ``ister`` (a template-based installer for Linux) included in the Clear Linux OS bundle diff --git a/doc/tutorials/cpu_sharing.rst b/doc/tutorials/cpu_sharing.rst index 040867aa1..5a2c5eb2c 100644 --- a/doc/tutorials/cpu_sharing.rst +++ b/doc/tutorials/cpu_sharing.rst @@ -1,7 +1,7 @@ .. _cpu_sharing: -ACRN CPU Sharing -################ +Enable CPU Sharing in ACRN +########################## Introduction ************ diff --git a/doc/tutorials/enable_laag_secure_boot.rst b/doc/tutorials/enable_laag_secure_boot.rst index 6568d355d..804f314ca 100644 --- a/doc/tutorials/enable_laag_secure_boot.rst +++ b/doc/tutorials/enable_laag_secure_boot.rst @@ -1,7 +1,7 @@ .. _enable_laag_secure_boot: -Secure Boot enabling for Clear Linux User VM -############################################ +Enable Secure Boot in the Clear Linux User VM +############################################# Prerequisites ************* diff --git a/doc/tutorials/enable_s5.rst b/doc/tutorials/enable_s5.rst index 3722c8f80..6a30b5834 100644 --- a/doc/tutorials/enable_s5.rst +++ b/doc/tutorials/enable_s5.rst @@ -1,21 +1,22 @@ .. _enable-s5: -Platform S5 Enable Guide -######################## +Enable S5 in ACRN +################# Introduction ************ S5 is one of the `ACPI sleep states `_ -that refers to the system being shut down (although some power may still be supplied to -certain devices). In this document, S5 means the function to shut down the -**User VMs**, **the Service VM**, the hypervisor, and the hardware. In most cases, -directly shutting down the power of a computer system is not advisable because it can -damage some components. It can cause corruption and put the system in an unknown or -unstable state. On ACRN, the User VM must be shut down before powering off the Service VM. -Especially for some use cases, where User VMs could be used in industrial control or other -high safety requirement environment, a graceful system shutdown such as the ACRN S5 -function is required. +that refers to the system being shut down (although some power may still be +supplied to certain devices). In this document, S5 means the function to +shut down the **User VMs**, **the Service VM**, the hypervisor, and the +hardware. In most cases, directly shutting down the power of a computer +system is not advisable because it can damage some components. It can cause +corruption and put the system in an unknown or unstable state. On ACRN, the +User VM must be shut down before powering off the Service VM. Especially for +some use cases, where User VMs could be used in industrial control or other +high safety requirement environment, a graceful system shutdown such as the +ACRN S5 function is required. S5 Architecture *************** diff --git a/doc/tutorials/increase-uos-disk-size.rst b/doc/tutorials/increase-uos-disk-size.rst index abca9b92d..02c192b15 100644 --- a/doc/tutorials/increase-uos-disk-size.rst +++ b/doc/tutorials/increase-uos-disk-size.rst @@ -1,9 +1,9 @@ .. _Increase User VM disk size: -Increasing the User VM disk size -################################ +Increase the User VM Disk Size +############################## -This document builds on the :ref:`getting_started` and assumes you already have +This document builds on :ref:`getting_started` and assumes you already have a system with ACRN installed and running correctly. The size of the pre-built Clear Linux User OS (User VM) virtual disk is typically only 8GB and this may not be sufficient for some applications. This guide explains a simple few steps to @@ -112,4 +112,4 @@ partition space. $ sudo losetup -d $LOOP_DEV Congratulations! You have successfully resized the disk, partition, and -filesystem of your User OS. +filesystem of your User VM. diff --git a/doc/tutorials/kbl-nuc-sdc.rst b/doc/tutorials/kbl-nuc-sdc.rst index cb80e8a3b..388c8ba33 100644 --- a/doc/tutorials/kbl-nuc-sdc.rst +++ b/doc/tutorials/kbl-nuc-sdc.rst @@ -1,7 +1,7 @@ .. _kbl-nuc-sdc: -Using SDC Mode on the NUC -######################### +Use SDC Mode on the NUC +####################### The Intel |reg| NUC is the primary tested platform for ACRN development, and its setup is described below. diff --git a/doc/tutorials/open_vswitch.rst b/doc/tutorials/open_vswitch.rst index 915c0a1f6..b83e76280 100644 --- a/doc/tutorials/open_vswitch.rst +++ b/doc/tutorials/open_vswitch.rst @@ -1,7 +1,7 @@ .. _open_vswitch: -How to enable OVS in ACRN -######################### +Enable OVS in ACRN +################## Hypervisors need the ability to bridge network traffic between VMs and with the outside world. This tutorial describes how to use `Open Virtual Switch (OVS) diff --git a/doc/tutorials/rdt_configuration.rst b/doc/tutorials/rdt_configuration.rst index a4bbae309..c8223b400 100644 --- a/doc/tutorials/rdt_configuration.rst +++ b/doc/tutorials/rdt_configuration.rst @@ -1,7 +1,7 @@ .. _rdt_configuration: -RDT Configuration -################# +Enable RDT Configuration +######################## On x86 platforms that support Intel Resource Director Technology (RDT) allocation features such as Cache Allocation Technology (CAT) and Memory diff --git a/doc/tutorials/realtime_performance_tuning.rst b/doc/tutorials/realtime_performance_tuning.rst index 672fb980e..f347b1dec 100644 --- a/doc/tutorials/realtime_performance_tuning.rst +++ b/doc/tutorials/realtime_performance_tuning.rst @@ -1,7 +1,7 @@ .. _rt_performance_tuning: -Real-Time (RT) Performance Analysis on ACRN -########################################### +ACRN Real-Time (RT) Performance Analysis +######################################## The document describes the methods to collect trace/data for ACRN Real-Time VM (RTVM) real-time performance analysis. Two parts are included: diff --git a/doc/tutorials/rtvm_workload_design_guideline.rst b/doc/tutorials/rtvm_workload_design_guideline.rst index 19b748ef3..425e5c374 100644 --- a/doc/tutorials/rtvm_workload_design_guideline.rst +++ b/doc/tutorials/rtvm_workload_design_guideline.rst @@ -1,6 +1,6 @@ .. _rtvm_workload_guideline: -Real time VM application design guidelines +Real-Time VM Application Design Guidelines ########################################## An RTOS developer must be aware of the differences between running applications on a native diff --git a/doc/tutorials/running_deb_as_serv_vm.rst b/doc/tutorials/running_deb_as_serv_vm.rst index aba488999..3a0cac73e 100644 --- a/doc/tutorials/running_deb_as_serv_vm.rst +++ b/doc/tutorials/running_deb_as_serv_vm.rst @@ -1,7 +1,7 @@ .. _running_deb_as_serv_vm: -Running Debian as the Service VM -################################## +Run Debian as the Service VM +############################ The `Debian Project `_ is an association of individuals who have made common cause to create a `free `_ operating system. The `latest stable Debian release `_ is 10.0. diff --git a/doc/tutorials/running_deb_as_user_vm.rst b/doc/tutorials/running_deb_as_user_vm.rst index f29cc136d..c480f2650 100644 --- a/doc/tutorials/running_deb_as_user_vm.rst +++ b/doc/tutorials/running_deb_as_user_vm.rst @@ -1,7 +1,7 @@ .. _running_deb_as_user_vm: -Running Debian as the User VM -############################# +Run Debian as the User VM +######################### Prerequisites ************* diff --git a/doc/tutorials/running_ubun_as_user_vm.rst b/doc/tutorials/running_ubun_as_user_vm.rst index 2dfed3745..f0d6551bf 100644 --- a/doc/tutorials/running_ubun_as_user_vm.rst +++ b/doc/tutorials/running_ubun_as_user_vm.rst @@ -1,7 +1,7 @@ .. _running_ubun_as_user_vm: -Running Ubuntu as the User VM -############################# +Run Ubuntu as the User VM +######################### Prerequisites ************* diff --git a/doc/tutorials/sgx_virtualization.rst b/doc/tutorials/sgx_virtualization.rst index 9b97403ce..750a5ff15 100644 --- a/doc/tutorials/sgx_virtualization.rst +++ b/doc/tutorials/sgx_virtualization.rst @@ -1,7 +1,7 @@ .. _sgx_virt: -SGX Virtualization -################## +Enable SGX Virtualization +######################### SGX refers to `Intel® Software Guard Extensions `_ (Intel® SGX). This is a set of instructions that can be used by diff --git a/doc/tutorials/sign_clear_linux_image.rst b/doc/tutorials/sign_clear_linux_image.rst index 7d833a700..49b0b1396 100644 --- a/doc/tutorials/sign_clear_linux_image.rst +++ b/doc/tutorials/sign_clear_linux_image.rst @@ -1,7 +1,7 @@ .. _sign_clear_linux_image: -How to sign binaries of the Clear Linux image -############################################# +Sign Clear Linux Image Binaries +############################### In this tutorial, you will see how to sign the binaries of a Clear Linux image so that you can boot it through a secure boot enabled OVMF. diff --git a/doc/tutorials/skl-nuc.rst b/doc/tutorials/skl-nuc.rst index 0e3a9e443..0611e4f5b 100644 --- a/doc/tutorials/skl-nuc.rst +++ b/doc/tutorials/skl-nuc.rst @@ -1,8 +1,7 @@ .. _skl-nuc-gpu-passthrough: -GPU Passthrough on Skylake NUC -############################## - +Enable GPU Passthrough on the Skylake NUC +######################################### This community reference release for the Skylake NUC with GPU passthrough is a one-time snapshot release and is not supported diff --git a/doc/tutorials/sriov_virtualization.rst b/doc/tutorials/sriov_virtualization.rst index 2a0960f70..18099bc64 100644 --- a/doc/tutorials/sriov_virtualization.rst +++ b/doc/tutorials/sriov_virtualization.rst @@ -1,7 +1,7 @@ .. _sriov_virtualization: -SR-IOV Virtualization -===================== +Enable SR-IOV Virtualization +############################ SR-IOV (Single Root Input/Output Virtualization) can isolate PCIe devices to improve performance that is similar to bare-metal levels. SR-IOV consists @@ -15,7 +15,7 @@ For details, refer to Chapter 9 of PCI-SIG's `_. SR-IOV Architectural Overview ------------------------------ +***************************** .. figure:: images/sriov-image1.png :align: center @@ -101,7 +101,7 @@ SR-IOV Capabilities. For details, refer to the *PCI Express Base Specification Revision 4.0, Version 1.0 Chapter 9.3.3*. -SR-IOV Architecture In ACRN +SR-IOV Architecture in ACRN --------------------------- .. figure:: images/sriov-image3.png diff --git a/doc/tutorials/static-ip.rst b/doc/tutorials/static-ip.rst index f5fc8c608..369788b1c 100644 --- a/doc/tutorials/static-ip.rst +++ b/doc/tutorials/static-ip.rst @@ -1,19 +1,19 @@ .. _static_ip: -Using a static IP address -######################### +Set Up a Static IP Address +########################## -When you install ACRN on your system following the :ref:`getting_started`, a -bridge called ``acrn-br0`` will be created and attached to the Ethernet network +When you install ACRN on your system following :ref:`getting_started`, a +bridge called ``acrn-br0`` is created and attached to the Ethernet network interface of the platform. By default, the bridge gets its network configuration -using DHCP. This guide will explain how to modify the system to use a static IP +using DHCP. This guide explains how to modify the system to use a static IP address. You need ``root`` privileges to make these changes to the system. ACRN Network Setup ****************** -The ACRN Service OS is based on `Clear Linux OS`_ and it uses `systemd-networkd`_ -to set up the Service OS networking. A few files are responsible for setting up the +The ACRN Service VM is based on `Clear Linux OS`_ and it uses `systemd-networkd`_ +to set up the Service VM networking. A few files are responsible for setting up the ACRN bridge (``acrn-br0``), the TAP device (``tap0``), and how these are all connected. Those files are installed in ``/usr/lib/systemd/network`` on the target device and can also be found under ``misc/acrnbridge`` in the source code. diff --git a/doc/tutorials/trustyACRN.rst b/doc/tutorials/trustyACRN.rst index ef171a83e..68db03e5c 100644 --- a/doc/tutorials/trustyACRN.rst +++ b/doc/tutorials/trustyACRN.rst @@ -1,7 +1,7 @@ .. _trusty-security-services: -Trusty and Security Services in ACRN -#################################### +Trusty and Security Services Reference +###################################### This document provides an overview of the Trusty architecture for Linux-based system, what security services Trusty provides, and how diff --git a/doc/tutorials/up2.rst b/doc/tutorials/up2.rst index a59f33e5c..5ae4bd019 100644 --- a/doc/tutorials/up2.rst +++ b/doc/tutorials/up2.rst @@ -1,7 +1,7 @@ .. _getting-started-up2: -Getting started guide for UP2 board -################################### +Getting Started Guide for the UP2 Board +####################################### Hardware setup ************** diff --git a/doc/tutorials/using_celadon_as_uos.rst b/doc/tutorials/using_celadon_as_uos.rst index 283373114..a75d2ea6a 100644 --- a/doc/tutorials/using_celadon_as_uos.rst +++ b/doc/tutorials/using_celadon_as_uos.rst @@ -1,11 +1,11 @@ .. _using_celadon_as_uos: -Using Celadon as the User OS -############################ +Run Celadon as the User VM +########################## -`Celadon `_ is an open source Android* software reference stack +`Celadon `_ is an open source Android software reference stack for Intel architecture. It builds upon a vanilla Android stack and incorporates open sourced components -that are optimized for the hardware. This tutorial describes how to run Celadon as the User OS +that are optimized for the hardware. This tutorial describes how to run Celadon as the User VM on the ACRN hypervisor. We are using the Kaby Lake-based NUC (model NUC7i7DNHE) in this tutorial. Prerequisites @@ -76,10 +76,10 @@ Build Celadon from source in order to build the source code with parallel tasks. The Celadon gptimage will be generated to ``out/target/product/cel_apl/cel_apl_gptimage.img`` -Steps for Using Celadon as the User OS +Steps for Using Celadon as the User VM ************************************** -#. Follow :ref:`kbl-nuc-sdc` to boot the ACRN Service OS based on Clear Linux 29880. +#. Follow :ref:`kbl-nuc-sdc` to boot the ACRN Service VM based on Clear Linux 29880. #. Prepare dependencies on your NUC:: diff --git a/doc/tutorials/using_sbl_on_up2.rst b/doc/tutorials/using_sbl_on_up2.rst index ce4f52b80..f7dc040e5 100644 --- a/doc/tutorials/using_sbl_on_up2.rst +++ b/doc/tutorials/using_sbl_on_up2.rst @@ -1,10 +1,10 @@ .. _using-sbl-up2: -Using SBL on UP2 Board -###################### +Enable SBL on the UP2 Board +########################### -This document builds on the :ref:`getting-started-up2`, and explains how to use -SBL instead of UEFI to boot UP2 board. +This document builds on :ref:`getting-started-up2`, and explains how to use +SBL instead of UEFI to boot the UP2 board. Slim Bootloader is an open-source boot firmware solution, built from the ground up to be secure, lightweight, and highly diff --git a/doc/tutorials/using_ubuntu_as_sos.rst b/doc/tutorials/using_ubuntu_as_sos.rst index 1806f111c..be2ee29ab 100644 --- a/doc/tutorials/using_ubuntu_as_sos.rst +++ b/doc/tutorials/using_ubuntu_as_sos.rst @@ -1,7 +1,7 @@ .. _Ubuntu Service OS: -Running Ubuntu in the Service VM -################################ +Run Ubuntu as the Service VM +############################ This document builds on the :ref:`getting_started` series and explains how to use Ubuntu instead of `Clear Linux OS`_ as the Service VM with the ACRN diff --git a/doc/tutorials/using_vxworks_as_uos.rst b/doc/tutorials/using_vxworks_as_uos.rst index 983238326..11818f970 100644 --- a/doc/tutorials/using_vxworks_as_uos.rst +++ b/doc/tutorials/using_vxworks_as_uos.rst @@ -1,7 +1,7 @@ .. _using_vxworks_as_uos: -Using VxWorks* as User VM -######################### +Run VxWorks as the User VM +########################## `VxWorks`_\* is a real-time proprietary OS designed for use in embedded systems requiring real-time, deterministic performance. This tutorial describes how to run VxWorks as the User VM on the ACRN hypervisor @@ -92,7 +92,7 @@ Steps for Using VxWorks as User VM You now have a virtual disk image with bootable VxWorks in ``VxWorks.img``. -#. Follow :ref:`kbl-nuc-sdc` to boot "The ACRN Service OS". +#. Follow :ref:`kbl-nuc-sdc` to boot the ACRN Service VM. #. Boot VxWorks as User VM. @@ -106,7 +106,7 @@ Steps for Using VxWorks as User VM You will also need to copy the ``VxWorks.img`` created in the VxWorks build environment into directory ``vxworks`` (via, e.g. a USB stick or network). - Run the ``launch_vxworks.sh`` script to launch VxWorks as Uos. + Run the ``launch_vxworks.sh`` script to launch VxWorks as the User VM. .. code-block:: none diff --git a/doc/tutorials/using_windows_as_uos.rst b/doc/tutorials/using_windows_as_uos.rst index 944b1d679..7bf05cc0c 100644 --- a/doc/tutorials/using_windows_as_uos.rst +++ b/doc/tutorials/using_windows_as_uos.rst @@ -1,8 +1,8 @@ .. _using_windows_as_uos: -Using Windows as Guest VM on ACRN -################################# +Launch Windows as the Guest VM on ACRN +###################################### This tutorial describes how to launch Windows as a Guest (WaaG) VM on the ACRN hypervisor. @@ -321,7 +321,7 @@ secure boot enabling. Activate Windows 10 ******************** -If you are using a trial version of Windows 10, you may find that some +If you are using a trial version of Windows 10, you might find that some apps and features do not work or that Windows 10 automatically gets shut down by the Windows licensing monitoring service. To avoid these issues, obtain a licensed version of Windows. diff --git a/doc/tutorials/using_xenomai_as_uos.rst b/doc/tutorials/using_xenomai_as_uos.rst index d8c2657c0..a4f77808a 100644 --- a/doc/tutorials/using_xenomai_as_uos.rst +++ b/doc/tutorials/using_xenomai_as_uos.rst @@ -1,7 +1,7 @@ .. _using_xenomai_as_uos: -Using Xenomai as User VM OS (Real-Time VM) -########################################## +Run Xenomai as the User VM OS (Real-Time VM) +############################################ `Xenomai`_ is a versatile real-time framework that provides support to user space applications that are seamlessly integrated into Linux environments. diff --git a/doc/tutorials/using_zephyr_as_uos.rst b/doc/tutorials/using_zephyr_as_uos.rst index dde792b23..1cc140d7b 100644 --- a/doc/tutorials/using_zephyr_as_uos.rst +++ b/doc/tutorials/using_zephyr_as_uos.rst @@ -1,7 +1,7 @@ .. _using_zephyr_as_uos: -Using Zephyr as User VM -####################### +Run Zephyr as the User VM +######################### This tutorial describes how to run Zephyr as the User VM on the ACRN hypervisor. We are using Kaby Lake-based NUC (model NUC7i5DNHE) in this tutorial. diff --git a/doc/tutorials/vuart_configuration.rst b/doc/tutorials/vuart_configuration.rst index 5a3d74f62..d2a9aa57e 100644 --- a/doc/tutorials/vuart_configuration.rst +++ b/doc/tutorials/vuart_configuration.rst @@ -1,7 +1,7 @@ .. _vuart_config: -vUART Configuration -################### +Enable vUART Configurations +########################### Introduction ============ diff --git a/doc/tutorials/waag-secure-boot.rst b/doc/tutorials/waag-secure-boot.rst index 617100f06..257318baf 100644 --- a/doc/tutorials/waag-secure-boot.rst +++ b/doc/tutorials/waag-secure-boot.rst @@ -1,7 +1,7 @@ .. _how-to-enable-secure-boot-for-windows: -How to enable secure boot for Windows -##################################### +Enable Secure Boot in Windows +############################# This document shows how to enable secure boot to launch Windows 10 as a guest through OVMF on ACRNGT, including: