github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-09-06 11:20:32 +00:00
Code Issues Projects Releases Wiki Activity

doc: fix all headings to use title case

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/getting-started/building-from-source.rst
View File

@@ -1,6 +1,6 @@
.. _getting-started-building:
Build ACRN from Source
Build ACRN From Source
######################
Following a general embedded-system programming model, the ACRN
@@ -45,7 +45,7 @@ these steps.
.. rst-class:: numbered-step
Install build tools and dependencies
Install Build Tools and Dependencies
************************************
ACRN development is supported on popular Linux distributions, each with
@@ -99,7 +99,7 @@ Install the necessary tools for the following systems:
.. rst-class:: numbered-step
Get the ACRN hypervisor source code
Get the ACRN Hypervisor Source Code
***********************************
The `acrn-hypervisor <https://github.com/projectacrn/acrn-hypervisor/>`_
@@ -120,7 +120,7 @@ Enter the following to get the acrn-hypervisor source code:
.. rst-class:: numbered-step
Build with the ACRN scenario
Build With the ACRN Scenario
****************************
Currently, the ACRN hypervisor defines these typical usage scenarios:
@@ -187,10 +187,10 @@ for each scenario.
.. rst-class:: numbered-step
Build the hypervisor configuration
Build the Hypervisor Configuration
**********************************
Modify the hypervisor configuration
Modify the Hypervisor Configuration
===================================
The ACRN hypervisor leverages Kconfig to manage configurations; it is
@@ -239,7 +239,7 @@ Refer to the help on menuconfig for a detailed guide on the interface:
.. rst-class:: numbered-step
Build the hypervisor, device model, and tools
Build the Hypervisor, Device Model, and Tools
*********************************************
Now you can build all these components at once as follows:

26
doc/getting-started/roscube/roscube-gsg.rst
View File

@@ -1,11 +1,11 @@
Getting Started Guide for ACRN Industry Scenario with ROScube-I
Getting Started Guide for ACRN Industry Scenario With ROScube-I
###############################################################
.. contents::
:local:
:depth: 1
Verified version
Verified Version
****************
- Ubuntu version: **18.04**
@@ -68,10 +68,10 @@ Prerequisites
.. rst-class:: numbered-step
Install ACRN hypervisor
Install ACRN Hypervisor
***********************
Set up Environment
Set Up Environment
==================
#. Open ``/etc/default/grub/`` and add ``idle=nomwait intel_pstate=disable``
@@ -203,10 +203,10 @@ Configure Hypervisor
.. rst-class:: numbered-step
Install Service VM kernel
Install Service VM Kernel
*************************
Build Service VM kernel
Build Service VM Kernel
=======================
#. Get code from GitHub
@@ -302,7 +302,7 @@ Update Grub
Install User VM
***************
Before create User VM
Before Create User VM
=====================
#. Download Ubuntu image (Here we use `Ubuntu 18.04 LTS
@@ -316,7 +316,7 @@ Before create User VM
bridge-utils virt-manager ovmf
sudo reboot
Create User VM image
Create User VM Image
====================
.. note:: Reboot into the **native Linux kernel** (not the ACRN kernel)
@@ -451,10 +451,10 @@ the User VM.
.. rst-class:: numbered-step
Install real-time VM
Install Real-Time VM
********************
Copy real-time VM image
Copy Real-Time VM Image
=======================
.. note:: Reboot into the **native Linux kernel** (not the ACRN kernel)
@@ -468,7 +468,7 @@ Copy real-time VM image
.. figure:: images/rqi-acrn-rtos-ready.png
Set up real-time VM
Set Up Real-Time VM
===================
.. note:: The section will show you how to install Xenomai on ROScube-I.
@@ -548,7 +548,7 @@ Set up real-time VM
sudo poweroff
Run real-time VM
Run Real-Time VM
================
Now back to the native machine and we'll set up the environment for
@@ -582,7 +582,7 @@ launching the real-time VM.
In ACRN design, rebooting the real-time VM will also reboot the whole
system.
Customizing the launch file
Customizing the Launch File
***************************
The launch file in this tutorial has the following hardware resource allocation.

42
doc/getting-started/rt_industry_ubuntu.rst
View File

@@ -1,13 +1,13 @@
.. _rt_industry_ubuntu_setup:
Getting Started Guide for ACRN Industry Scenario with Ubuntu Service VM
Getting Started Guide for ACRN Industry Scenario With Ubuntu Service VM
#######################################################################
.. contents::
:local:
:depth: 1
Verified version
Verified Version
****************
- Ubuntu version: **18.04**
@@ -51,7 +51,7 @@ Connect the WHL Maxtang with the appropriate external devices.
.. _install-ubuntu-rtvm-sata:
Install the Ubuntu User VM (RTVM) on the SATA disk
Install the Ubuntu User VM (RTVM) on the SATA Disk
**************************************************
.. note:: The WHL Maxtang machine contains both an NVMe and SATA disk.
@@ -84,7 +84,7 @@ to turn it into a real-time User VM (RTVM).
.. _install-ubuntu-Service VM-NVMe:
Install the Ubuntu Service VM on the NVMe disk
Install the Ubuntu Service VM on the NVMe Disk
**********************************************
.. note:: Before you install the Ubuntu Service VM on the NVMe disk, either
@@ -209,7 +209,7 @@ Build the ACRN Hypervisor on Ubuntu
$ sudo mkdir -p /boot/acrn
$ sudo cp build/hypervisor/acrn.bin /boot/acrn/
Build and install the ACRN kernel
Build and Install the ACRN Kernel
=================================
#. Build the Service VM kernel from the ACRN repo:
@@ -224,12 +224,12 @@ Build and install the ACRN kernel
.. code-block:: none
$ git checkout v2.3
$ git checkout v2.3
$ cp kernel_config_uefi_sos .config
$ make olddefconfig
$ make all
Install the Service VM kernel and modules
Install the Service VM Kernel and Modules
=========================================
.. code-block:: none
@@ -289,7 +289,7 @@ Update Grub for the Ubuntu Service VM
$ sudo update-grub
Enable network sharing for the User VM
Enable Network Sharing for the User VM
======================================
In the Ubuntu Service VM, enable network sharing for the User VM:
@@ -300,7 +300,7 @@ In the Ubuntu Service VM, enable network sharing for the User VM:
$ sudo systemctl start systemd-networkd
Reboot the system
Reboot the System
=================
Reboot the system. You should see the Grub menu with the new **ACRN
@@ -317,10 +317,10 @@ typical output of a successful installation resembles the following:
[ 0.862942] ACRN HVLog: acrn_hvlog_init
Additional settings in the Service VM
Additional Settings in the Service VM
=====================================
BIOS settings of GVT-d for WaaG
BIOS Settings of GVT-d for WaaG
-------------------------------
.. note::
@@ -333,11 +333,11 @@ Set **DVMT Pre-Allocated** to **64MB**:
.. figure:: images/DVMT-reallocated-64mb.png
Set **PM Support** to **Enabled**:
Set **PM Support** to **Enabled**:
.. figure:: images/PM-support-enabled.png
Use OVMF to launch the User VM
Use OVMF to Launch the User VM
------------------------------
The User VM will be launched by OVMF, so copy it to the specific folder:
@@ -347,7 +347,7 @@ The User VM will be launched by OVMF, so copy it to the specific folder:
$ sudo mkdir -p /usr/share/acrn/bios
$ sudo cp /home/acrn/work/acrn-hypervisor/devicemodel/bios/OVMF.fd /usr/share/acrn/bios
Build and Install the RT kernel for the Ubuntu User VM
Build and Install the RT Kernel for the Ubuntu User VM
------------------------------------------------------
Follow these instructions to build the RT kernel.
@@ -398,7 +398,7 @@ Grub in the Ubuntu User VM (RTVM) needs to be configured to use the new RT
kernel that was just built and installed on the rootfs. Follow these steps to
perform this operation.
Update the Grub file
Update the Grub File
====================
#. Reboot into the Ubuntu User VM located on the SATA drive and log on.
@@ -461,7 +461,7 @@ Launch the RTVM
$ sudo cp /home/acrn/work/acrn-hyperviso/misc/vm_configs/sample_launch_scripts/nuc/launch_hard_rt_vm.sh /usr/share/acrn/
$ sudo /usr/share/acrn/launch_hard_rt_vm.sh
Recommended BIOS settings for RTVM
Recommended BIOS Settings for RTVM
----------------------------------
.. csv-table::
@@ -491,7 +491,7 @@ Recommended BIOS settings for RTVM
.. note:: BIOS settings depend on the platform and BIOS version; some may
not be applicable.
Recommended kernel cmdline for RTVM
Recommended Kernel Cmdline for RTVM
-----------------------------------
.. code-block:: none
@@ -513,7 +513,7 @@ automatically at the time of RTVM creation. Refer to :ref:`rdt_configuration`
for details on RDT configuration and :ref:`hv_rdt` for details on RDT
high-level design.
Set up the core allocation for the RTVM
Set Up the Core Allocation for the RTVM
---------------------------------------
In our recommended configuration, two cores are allocated to the RTVM:
@@ -563,7 +563,7 @@ this, follow the below steps to allocate all housekeeping tasks to core 0:
.. note:: Ignore the error messages that might appear while the script is
running.
Run cyclictest
Run Cyclictest
--------------
#. Refer to the :ref:`troubleshooting section <enabling the network on the RTVM>`
@@ -621,7 +621,7 @@ Troubleshooting
.. _enabling the network on the RTVM:
Enabling the network on the RTVM
Enabling the Network on the RTVM
================================
If you need to access the internet, you must add the following command line
@@ -644,7 +644,7 @@ to the ``launch_hard_rt_vm.sh`` script before launching it:
.. _passthru to rtvm:
Passthrough a hard disk to RTVM
Passthrough a Hard Disk to RTVM
===============================
#. Use the ``lspci`` command to ensure that the correct SATA device IDs will