From fa2bf69720876584b7ced517143fcb6f47cae46e Mon Sep 17 00:00:00 2001 From: Deb Taylor Date: Wed, 1 Apr 2020 11:08:08 -0400 Subject: [PATCH] Doc: Minor grammatical updates to rt_industry.html and building_acrn_in_docker.html Refer to PRs 4568 and 4559. Signed-off-by: Deb Taylor --- doc/getting-started/rt_industry.rst | 21 ++++++++++----------- doc/tutorials/building_acrn_in_docker.rst | 4 +--- 2 files changed, 11 insertions(+), 14 deletions(-) diff --git a/doc/getting-started/rt_industry.rst b/doc/getting-started/rt_industry.rst index b3d5d2621..b9a6e014e 100644 --- a/doc/getting-started/rt_industry.rst +++ b/doc/getting-started/rt_industry.rst @@ -120,7 +120,7 @@ Use the pre-installed industry ACRN hypervisor #. Boot Clear Linux from NVMe disk. -#. Login and download ACRN quick setup script: +#. Log in and download ACRN quick setup script: .. code-block:: none @@ -174,8 +174,8 @@ Use the pre-installed industry ACRN hypervisor [ 1.253291] ACRN HVLog: Failed to init last hvlog devs, errno -19 [ 1.253292] ACRN HVLog: Initialized hvlog module with 4 -.. note:: If you want to login the Service VM with root privileges, use ``sudo passwd`` to create a root user - so that you can login as root on the next reboot. +.. note:: If you want to log in to the Service VM with root privileges, use ``sudo passwd`` to create a root user + so that you can log in as root on the next reboot. .. _use industry ootb image: @@ -229,9 +229,8 @@ Install and launch the Preempt-RT VM ************************************ In this section, we will use :ref:`virtio-blk` to launch the Preempt-RT VM. -If you need a better performance, follow the :ref:`building-acrn-in-docker` to build the -ACRN kernel for the Service VM, then :ref:`passthrough SATA disk ` -to launch Preempt-RT VM. +If you need better performance, follow :ref:`building-acrn-in-docker` to +build the ACRN kernel for the Service VM, and then :ref:`passthrough the SATA disk ` to launch the Preempt-RT VM. #. Log in to the Service VM with root privileges. @@ -241,7 +240,7 @@ to launch Preempt-RT VM. # wget https://github.com/projectacrn/acrn-hypervisor/releases/download/acrn-2020w12.5-140000p/preempt-rt-32680.img.xz - .. note:: You may also follow the :ref:`set_up_ootb_rtvm` to build the Preempt-RT VM image by yourself. + .. note:: You may also follow :ref:`set_up_ootb_rtvm` to build the Preempt-RT VM image by yourself. #. Decompress the xz image:: @@ -497,18 +496,18 @@ If you need to access the internet, you must add the following command line to t .. _passthru rtvm: -How to passthrough hard disk to RTVM -==================================== +Passthrough a hard disk to the RTVM +=================================== #. Use the ``lspci`` command to ensure that the correct SATA device IDs will - be used for the passthru before launching the script: + be used for the passthrough before launching the script: .. code-block:: none # lspci -nn | grep -i sata 00:17.0 SATA controller [0106]: Intel Corporation Cannon Point-LP SATA Controller [AHCI Mode] [8086:9dd3] (rev 30) -#. Modify the script to use the correct SATA device IDs and bus number. +#. Modify the script to use the correct SATA device IDs and bus number: .. code-block:: none :emphasize-lines: 5, 10 diff --git a/doc/tutorials/building_acrn_in_docker.rst b/doc/tutorials/building_acrn_in_docker.rst index 99d2ed080..34395f8db 100644 --- a/doc/tutorials/building_acrn_in_docker.rst +++ b/doc/tutorials/building_acrn_in_docker.rst @@ -32,9 +32,7 @@ This tutorial presents two ways to get the Clear Linux Docker image that's neede Build the Docker Image from Dockerfile ====================================== .. note:: - - One known issue :acrn-issue:`4560` while building ACRN HV. - Please refer to "Get the Docker Image from Docker Hub" to get Docker Image for V1.6 release temporally. + A known `issue `_ exists while building the ACRN hypervisor. Refer to `Get the Docker Image from Docker Hub`_ as a temporary way to obtain the Docker Image for the v1.6 release. #. Download `Dockerfile `_ to your development machine.