github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2026-01-04 23:24:56 +00:00
Code Issues Projects Releases Wiki Activity

doc: fix correct use of Clear Linux OS

Browse Source 
Proper use of the Clear Linux name is with a noun, specifically "OS".
Also fixed some grammar edits along the way.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder
2019-01-30 15:05:21 -08:00
committed by David Kinder
parent fc887eade4
commit 0881bae738
17 changed files with 108 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
doc/tutorials/building_uos_from_clearlinux.rst
View File

@@ -1,40 +1,39 @@
.. _build UOS from Clearlinux:
Building UOS from Clear Linux
#############################
Building UOS from Clear Linux OS
################################
This document builds on the :ref:`getting_started`,
and explains how to build UOS from Clear Linux.
Build UOS image in Clear Linux native
*************************************
This document builds on the :ref:`getting_started`,
and explains how to build UOS from Clear Linux OS.
In order to build out the image of UOS,
follow these steps to build a UOS image from Clear Linux:
Build UOS image in Clear Linux OS
*********************************
#. In Clear Linux native, install ``ister`` (a template-based
installer for Linux) included in the Clear Linux bundle
Follow these steps to build a UOS image from Clear Linux OS:
#. In Clear Linux OS, install ``ister`` (a template-based
installer for Linux) included in the Clear Linux OS bundle
``os-installer``.
For more information about ``ister``,
For more information about ``ister``,
please visit https://github.com/bryteise/ister.
.. code-block:: none
$ sudo swupd bundle-add os-installer
#. After installation is complete, use ``ister.py`` to
generate the image for UOS with the configuration in
#. After installation is complete, use ``ister.py`` to
generate the image for UOS with the configuration in
``uos-image.json``:
.. code-block:: none
$ cd ~
$ cd ~
$ sudo ister.py -t uos-image.json
An example of the configuration file ``uos-image.json``:
.. code-block:: none
{
"DestinationType" : "virtual",
"PartitionLayout" : [ { "disk" : "uos.img",
@@ -76,17 +75,17 @@ follow these steps to build a UOS image from Clear Linux:
}
.. note::
To generate the image with a specified version,
please modify the ``"Version"`` argument,
and we can set ``"Version": 26550`` instead of
To generate the image with a specified version,
please modify the ``"Version"`` argument,
and we can set ``"Version": 26550`` instead of
``"Version": "latest"`` for example.
Here we will use ``"Version": 26550`` for example,
and the UOS image called ``uos.img`` will be generated
Here we will use ``"Version": 26550`` for example,
and the UOS image called ``uos.img`` will be generated
after successful installation. An example output log is:
.. code-block:: none
Reading configuration
Validating configuration
Creating virtual disk
@@ -98,19 +97,19 @@ follow these steps to build a UOS image from Clear Linux:
Installing 9 bundles (and dependencies)...
Verifying version 26550
Downloading packs...
Extracting emacs pack for version 26550
Extracting vim pack for version 26550
...
Cleaning up
Successful installation
#. On your target device, boot the system and select "The ACRN Service OS", as shown below:
.. code-block:: console
:emphasize-lines: 1
=> The ACRN Service OS
Clear Linux OS for Intel Architecture (Clear-linux-iot-lts2018-4.19.0-19)
Clear Linux OS for Intel Architecture (Clear-linux-iot-lts2018-sos-4.19.0-19)
@@ -136,24 +135,24 @@ Start the User OS (UOS)
default-iot-lts2018 -> org.clearlinux.iot-lts2018.4.19.0-26
install.d
org.clearlinux.iot-lts2018.4.19.0-26
#. Adjust the ``/usr/share/acrn/samples/nuc/launch_uos.sh``
script to match your installation.
#. 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:
.. code-block:: none
-s 3,virtio-blk,~/uos.img \
-k /mnt/usr/lib/kernel/default-iot-lts2018 \
.. note::
UOS image ``uos.img`` is in the directory ``~/``
and UOS kernel ``default-iot-lts2018`` is in ``/mnt/usr/lib/kernel/``.
#. You are now all set to start the User OS (UOS):
.. code-block:: none
$ sudo /usr/share/acrn/samples/nuc/launch_uos.sh
You are now watching the User OS booting up!