Skip to content

Commit 33b8706

Browse files
coneypodbkinder
authored andcommitted
Doc: Update the doc of "Build UOS from ClearLinux"
1 parent 8b83cad commit 33b8706

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

doc/tutorials/building_uos_from_clearlinux.rst

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,24 @@ Build UOS image in Clear Linux native
1212
In order to build out the image of UOS,
1313
please follow these steps in Clear Linux native:
1414

15-
#. In Clear Linxu native, please install ``ister`` at first,
16-
``ister`` is a template based installer for linux,
17-
which is inclued in the bundle ``os-installer`` in Clear Linux.
15+
#. In Clear Linux native, install ``ister`` (a template-based
16+
installer for Linux) inclued in the Clear Linux bundle
17+
``os-installer``.
1818
For more information about ``ister``,
1919
please visit https://github.com/bryteise/ister.
2020

2121
.. code-block:: none
2222
23-
# sudo swupd bundle-add os-installer
23+
$ sudo swupd bundle-add os-installer
2424
2525
#. After installation is complete, use ``ister.py`` to
2626
generate the image for UOS with the configuration in
2727
``uos-image.json``:
2828

2929
.. code-block:: none
3030
31-
# cd ~
32-
# sudo ister.py -t uos-image.json
31+
$ cd ~
32+
$ sudo ister.py -t uos-image.json
3333
3434
An example of the configuration file ``uos-image.json``
3535
is shown as below:
@@ -81,6 +81,8 @@ please follow these steps in Clear Linux native:
8181
To generate the image with a specified version,
8282
please modify with the ``"Version"`` argument,
8383
and we can set ``"Version": 26550`` for example.
84+
If you want to build out the latest, please
85+
set ``"Version": "latest"`` here.
8486

8587
Here we will use ``"Version": 26550`` for example,
8688
and the image of UOS called ``uos.img`` will be generated
@@ -138,7 +140,7 @@ Start the User OS (UOS)
138140
install.d
139141
org.clearlinux.iot-lts2018.4.19.0-26
140142
141-
#. And you need to adjust the ``/usr/share/acrn/samples/nuc/launch_uos.sh``
143+
#. Adjust the ``/usr/share/acrn/samples/nuc/launch_uos.sh``
142144
script to match your installation.
143145
These are the couple of lines you need to modify:
144146

@@ -148,13 +150,13 @@ Start the User OS (UOS)
148150
-k /mnt/usr/lib/kernel/default-iot-lts2018 \
149151
150152
.. note::
151-
UOS image ``uos.img`` stored in the directory ``~/``
152-
and UOS kernel ``default-iot-lts2018`` stored ``/mnt/usr/lib/kernel/``.
153+
UOS image ``uos.img`` is in the directory ``~/``
154+
and UOS kernel ``default-iot-lts2018`` is in ``/mnt/usr/lib/kernel/``.
153155

154156
#. You are now all set to start the User OS (UOS):
155157

156158
.. code-block:: none
157159
158-
sudo /usr/share/acrn/samples/nuc/launch_uos.sh
160+
$ sudo /usr/share/acrn/samples/nuc/launch_uos.sh
159161
160162
You are now watching the User OS booting up!

0 commit comments

Comments
 (0)