github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-09-24 10:17:28 +00:00
Code Issues Projects Releases Wiki Activity

doc: fix utf-8 punctuation, branding, spelling

Browse Source 
Fix some stray UTF-8 punctuation and symbol characters, unnecessary
trademark symbols, and some misspellings missed during regular reviews.

Tracked-On: #2712

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder
2019-03-08 11:01:04 -08:00
committed by David Kinder
parent 9e78ad52d9
commit e9335fcee6
24 changed files with 94 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/tutorials/agl-vms.rst
View File

@@ -132,9 +132,9 @@ Service OS
<https://clearlinux.org/documentation/clear-linux/get-started/bare-metal-install>`_
as a starting point for installing Clear Linux OS onto your platform.
Follow the recommended options for choosing an Automatic installation
type, and using the platform’s storage as the target device for
type, and using the platform's storage as the target device for
installation (overwriting the existing data and creating three
partitions on the platform’s storage drive).
partitions on the platform's storage drive).
#. After installation is complete, boot into Clear Linux OS, login as
root, and set a password.

4
doc/tutorials/skl-nuc.rst
View File

@@ -42,10 +42,10 @@ Please follow the :ref:`getting-started-apl-nuc`, with the following changes:
Clear Linux OS will update to the latest version during installation.
Run this command (as root) to roll back to version 25130, using the
``–x`` switch to ignore version mismatch::
``-x`` switch to ignore version mismatch::
# swupd verify -x --fix --picky -m 25130
# swupd autoupdate -–disable
# swupd autoupdate --disable
# reboot
#. Add the ACRN hypervisor to the EFI Partition

2
doc/tutorials/using_agl_as_uos.rst
View File

@@ -23,7 +23,7 @@ accelerate the development and adoption of a fully open software stack
for the connected car. With Linux at its core, AGL is developing an open
platform from the ground up that can serve as the de facto industry
standard to enable rapid development of new features and technologies.
For more information about AGL, please visit `AGL’s official website
For more information about AGL, please visit `AGL's official website
<https://www.automotivelinux.org/>`_.
Steps for using AGL as the UOS

10
doc/tutorials/using_sbl_on_up2.rst
View File

@@ -15,7 +15,7 @@ please visit `<https://slimbootloader.github.io/how-tos/boot-acrn.html>`_.
.. image:: images/sbl_boot_flow_UP2.png
:align: center
We show a verified Boot Sequence with SBL on an Intel® Architecture platform UP2,
We show a verified Boot Sequence with SBL on an Intel Architecture platform UP2,
and the boot process proceeds as follows:
#. SBL verifies and boots the ACRN hypervisor and Service OS kernel
@@ -162,7 +162,7 @@ which is also in the directory ``~/acrn-hypervisor/doc/tutorials/``.
| up2_laag.img | This is the root filesystem image for the SOS. |
| | It has an integrated kernel and userspace. |
+------------------------------+---------------------------------------------------+
| flash_LaaG.json | Configuration file for Intel® Platform Flash Tool |
| flash_LaaG.json | Configuration file for Intel Platform Flash Tool |
| | to flash SOS image + hypervisor/SOS boot image + |
| | SOS userland |
+------------------------------+---------------------------------------------------+
@@ -173,7 +173,7 @@ which is also in the directory ``~/acrn-hypervisor/doc/tutorials/``.
Download and install flash tool
*******************************
#. Download Intel® Platform Flash Tool Lite from
#. Download Intel Platform Flash Tool Lite from
`<https://github.com/projectceladon/tools/tree/master/platform_flash_tool_lite/latest/>`_.
#. For Ubuntu host, install `platformflashtoollite_5.8.9.0_linux_x86_64.deb
@@ -203,7 +203,7 @@ SOS and LaaG Installation
both HW and SW flow control are turned off.
#. When you see following console log, please press any key to enter
shell command：
shell command:
.. code-block:: none
@@ -245,7 +245,7 @@ SOS and LaaG Installation
Shell> exit
…
...
40E0 | 175118 ms | 158 ms | Kernel setup
40F0 | 175144 ms | 26 ms | FSP ReadyToBoot/EndOfFirmware notify

64
doc/tutorials/using_ubuntu_as_sos.rst
View File

@@ -16,10 +16,10 @@ Ubuntu 18.04.1 LTS was used throughout this document, other older versions such
16.04 works too.
* Download Ubuntu 18.04 from the `Ubuntu 18.04.1 LTS (Bionic Beaver) page
<http://releases.ubuntu.com/18.04.1/>`_ and select the `ubuntu-18.04.1-desktop-amd64.iso
<http://releases.ubuntu.com/18.04.1/>`_ and select the `ubuntu-18.04.1-desktop-amd64.iso
<http://releases.ubuntu.com/18.04.1/ubuntu-18.04.1-desktop-amd64.iso>`_ image.
* Follow Ubuntu's `online instructions <https://tutorials.ubuntu.com/tutorial/tutorial-install-ubuntu-desktop?_ga=2.114179015.1954550575.1530817291-1278304647.1523530035>`_
* Follow Ubuntu's `online instructions <https://tutorials.ubuntu.com/tutorial/tutorial-install-ubuntu-desktop>`_
to install it on your device.
.. note::
@@ -83,7 +83,7 @@ the source code, build it, and install it on your device.
#. Add the ACRN hypervisor and Service OS kernel to it (as ``root``)
.. code-block:: none
ls /boot/efi/EFI/ubuntu/
You should see the following output:
@@ -102,28 +102,28 @@ the source code, build it, and install it on your device.
#. Configure the EFI firmware to boot the ACRN hypervisor by default
.. code-block:: none
# For SATA
sudo efibootmgr -c -l "\EFI\acrn\acrn.efi" -d /dev/sda -p 1 \
-L "ACRN Hypervisor" -u "bootloader=\EFI\ubuntu\grubx64.efi"
# For NVMe
sudo efibootmgr -c -l "\EFI\acrn\acrn.efi" -d /dev/nvme0n1 -p 1 \
-L "ACRN Hypervisor" -u "bootloader=\EFI\ubuntu\grubx64.efi"
-L "ACRN Hypervisor" -u "bootloader=\EFI\ubuntu\grubx64.efi"
#. Verify that the "ACRN Hypervisor" is added and make sure it will be booted first
.. code-block:: none
.. code-block:: none
sudo efibootmgr -v
#. You can change the boot order at any time using ``efibootmgr -o XXX,XXX,XXX``
.. code-block:: none
sudo efibootmgr -o xxx,xxx,xxx
.. code-block:: none
sudo efibootmgr -o xxx,xxx,xxx
.. note::
By default, the “ACRN Hypervisor” you have just added should be
By default, the "ACRN Hypervisor" you have just added should be
the first one to boot. Verify this by using ``efibootmgr -v`` or
by entering the EFI firmware at boot (using :kbd:`F10`)
@@ -183,7 +183,7 @@ You can download latest Service OS kernel from
.. note::
You will also need to adjust the kernel name if you used a different
RPM file as the source of your Service OS kernel.
.. note::
The command line for the kernel in /etc/grub.d/40_custom should be all
as a single line, not as multiple lines. Otherwise the kernel will fail to boot
@@ -192,7 +192,7 @@ You can download latest Service OS kernel from
There are a couple of lines to be modified, as shown below.
.. code-block:: none
#GRUB_TIMEOUT_STYLE=hidden
#GRUB_HIDDEN_TIMEOUT=0
GRUB_HIDDEN_TIMEOUT_QUIET=false
@@ -204,20 +204,20 @@ You can download latest Service OS kernel from
sudo update-grub
#. Reboot the system
Reboot system. You should see the Grub menu with the new “ACRN ubuntu SOS”
Reboot system. You should see the Grub menu with the new "ACRN ubuntu SOS"
entry. Select it and proceed to booting the platform. The system will start
the Ubuntu Desktop and you can now log in (as before).
.. note::
If you don't see the Grub menu after rebooting the system (and you're
not booting into the ACRN hypervisor), you'll need to enter the
EFI firmware at boot (using :kbd:`F10`) and manually select ``ACRN Hypervisor``.
EFI firmware at boot (using :kbd:`F10`) and manually select ``ACRN Hypervisor``.
.. note::
If you see a black screen on the first-time reboot after installing the ACRN Hypervisor,
If you see a black screen on the first-time reboot after installing the ACRN Hypervisor,
wait a few moments and the Ubuntu desktop will be displayed.
To check if the hypervisor is effectively running, check ``dmesg``. The
typical output of a successful installation will look like this:
@@ -243,7 +243,7 @@ For the User OS, we are using the same `Clear Linux OS`_ release version as the
* Download the "kernel-iot-lts2018" kernel
.. code-block:: none
sudo mkdir ~/uos-kernel-build
cd ~/uos-kernel-build
wget https://download.clearlinux.org/releases/26440/clear/x86_64/os/Packages/linux-iot-lts2018-4.19.0-22.x86_64.rpm
@@ -274,7 +274,7 @@ For the User OS, we are using the same `Clear Linux OS`_ release version as the
sudo cp /usr/bin/iasl /usr/sbin/iasl
* Adjust ``launch_uos.sh``
You need to adjust the ``/usr/share/acrn/samples/nuc/launch_uos.sh`` script
to match your installation. These are the couple of lines you need to modify:
@@ -282,9 +282,9 @@ For the User OS, we are using the same `Clear Linux OS`_ release version as the
-s 3,virtio-blk,~/clear-26440-kvm.img
-k /lib/modules/kernel/default-iot-lts2018
.. note::
The image of UOS can be stored in other directories instead of ``~/``,
The image of UOS can be stored in other directories instead of ``~/``,
and please remember to modify the directory of image in ``launch_uos.sh`` too.
Start the User OS (UOS)
@@ -299,7 +299,7 @@ You are now all set to start the User OS (UOS)
**Congratulations**, you are now watching the User OS booting up!
Enabling network sharing
Enabling network sharing
************************
After booting up the SOS and UOS, network sharing must be enabled to give network
@@ -308,15 +308,15 @@ script example shows how to set this up (verified in Ubuntu 16.04 and 18.04 as t
.. code-block:: none
#!/bin/bash
#setup bridge for uos network
br=$(brctl show | grep acrn-br0)
br=${br-:0:6}
ip tuntap add dev acrn_tap0 mode tap
taps=$(ifconfig | grep acrn_ | awk '{print $1}')
# if bridge not existed
if [ "$br"x != "acrn-br0"x ]; then
#setup bridge for uos network
@@ -332,7 +332,7 @@ script example shows how to set this up (verified in Ubuntu 16.04 and 18.04 as t
ip link set dev $tap up
done
fi
brctl addif acrn-br0 acrn_tap0
ip link set dev acrn_tap0 up
@@ -346,5 +346,5 @@ Enabling USB keyboard and mouse
Please refer to :ref:`getting-started-apl-nuc` for enabling the
USB keyboard and mouse for the UOS.
.. _Clear Linux OS: https://clearlinux.org