Skip to content

Commit e729b65

Browse files
lirui34dbkinder
authored andcommitted
doc: Add ACRN tag or Clear Linux version info for some tutorials
Neither ACRN tag nor Clear Linux version is specified in some tutorials. Declare those information for those tutorials. Signed-off-by: lirui34 <ruix.li@intel.com>
1 parent ffa7f80 commit e729b65

File tree

5 files changed

+15
-6
lines changed

5 files changed

+15
-6
lines changed

doc/tutorials/acrn-dm_QoS.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@ the maximal CPU resource for the VM0 or VM1 is 33% of the entire CPU resource.
7070

7171
How to use ACRN-DM QoS
7272
**********************
73+
#. Follow :ref:`getting-started-apl-nuc` to boot "The ACRN Service OS" based on Clear Linux 29970 (ACRN tag v1.1).
74+
7375
#. Add these parameters to the ``runC.json`` file:
7476

7577
.. code-block:: none

doc/tutorials/using_partition_mode_on_nuc.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Prerequisites
3434
filesystem. Set up each VM by following the `Install Clear Linux
3535
OS on bare metal with live server
3636
<https://clearlinux.org/documentation/clear-linux/get-started/bare-metal-install-server>`_
37-
and install Clear Linux OS first on a SATA disk and then again
37+
and install Clear Linux OS (version: 29970) first on a SATA disk and then again
3838
on a storage device with a USB interface. The two pre-launched
3939
VMs will mount the root file systems via the SATA controller and
4040
the USB controller respectively.
@@ -140,12 +140,14 @@ Update ACRN hypervisor Image
140140
Please refer :ref:`getting-started-building` to setup ACRN build environment
141141
on your development workstation.
142142

143-
Clone the ACRN source code:
143+
Clone the ACRN source code and checkout to the tag v1.1:
144144

145145
.. code-block:: none
146146
147147
$ git clone https://github.com/projectacrn/acrn-hypervisor.git
148-
$ cd acrn-hypervisor/hypervisor
148+
$ cd acrn-hypervisor
149+
$ git checkout v1.1
150+
$ cd hypervisor
149151
150152
Configure the build options:
151153

doc/tutorials/using_partition_mode_on_up2.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ To set up the Linux root filesystems for each VM, follow the Clear Linux OS
2626
to install Clear Linux OS on a **SATA disk** and a **USB flash disk** prior the setup,
2727
as the two privileged VMs will mount the root filesystems via the SATA controller
2828
and the USB controller respectively.
29+
This tutorial is verified on a tagged ACRN v0.6.
2930

3031
Build kernel and modules for partition mode UOS
3132
***********************************************
@@ -148,7 +149,9 @@ Enable partition mode in ACRN hypervisor
148149
.. code-block:: none
149150
150151
$ git clone https://github.com/projectacrn/acrn-hypervisor.git
151-
$ cd acrn-hypervisor/hypervisor
152+
$ cd acrn-hypervisor
153+
$ git checkout v0.6
154+
$ cd hypervisor
152155
$ make menuconfig
153156
154157
Set the ``Hypervisor mode`` option to ``Partition mode``, and depending

doc/tutorials/using_vxworks_as_uos.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Using VxWorks* as User OS
44
#########################
55

66
`VxWorks`_\* is a real-time proprietary OS designed for use in embedded systems requiring real-time, deterministic
7-
performance. This tutorial describes how to run VxWorks as the User OS on the ACRN hypervisor.
7+
performance. This tutorial describes how to run VxWorks as the User OS on the ACRN hypervisor
8+
based on Clear Linux 29970 (ACRN tag v1.1).
89

910
.. note:: You'll need to be a WindRiver* customer and have purchased VxWorks to follow this tutorial.
1011

doc/tutorials/using_zephyr_as_uos.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,8 @@ Steps for Using Zephyr as User OS
8686
You now have a virtual disk image with a bootable Zephyr in ``zephyr.img``. If the Zephyr build system is not
8787
the ACRN SOS, then you will need to transfer this image to the ACRN SOS (via, e.g, a USB stick or network )
8888

89-
#. Follow :ref:`getting-started-apl-nuc` to boot "The ACRN Service OS"
89+
#. Follow :ref:`getting-started-apl-nuc` to boot "The ACRN Service OS" based on Clear Linux OS 28620
90+
(ACRN tag: acrn-2019w14.3-140000p)
9091

9192
#. Boot Zephyr as User OS
9293

0 commit comments

Comments
 (0)