Skip to content

Commit 037410b

Browse files
dragosargintdbaluta
authored andcommitted
Update documentation for lab1
* Add reference to so2-labs gitlab repo * Change `make boot` to `make console` Signed-off-by: Dragoș-Iulian ARGINT <dragosargint21@gmail.com>
1 parent 42f075b commit 037410b

4 files changed

Lines changed: 18 additions & 17 deletions

File tree

Documentation/teaching/info/vm.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
.. _vm_link:
22

3+
=====================
4+
Recommended Setup
5+
=====================
6+
The simplest way to achieve a functional setup is to follow the steps listed in `this repo <https://gitlab.cs.pub.ro/so2/so2-labs>`__.
7+
38
=====================
49
Virtual Machine Setup
510
=====================

Documentation/teaching/labs/exercises-summary.hrst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
.. important::
22

3-
To solve exercises, you need to perform these steps:
3+
We strongly encourage you to use the setup from `this repository <https://gitlab.cs.pub.ro/so2/so2-labs>`__.
44

5+
To solve exercises, you need to perform these steps:
56
* prepare skeletons from templates
67
* build modules
7-
* copy modules to the VM
88
* start the VM and test the module in the VM.
99

1010
The current lab name is |LAB_NAME|. See the exercises for the task name.
@@ -30,17 +30,16 @@
3030

3131
tools/labs $ make build
3232

33-
Then, copy the modules and start the VM:
33+
Then, start the VM:
3434

3535
.. code-block:: shell
3636

37-
tools/labs $ make copy
38-
tools/labs $ make boot
37+
tools/labs $ make console
3938

4039
The modules are placed in /home/root/skels/|LAB_NAME|/<task_name>.
4140

42-
Alternatively, we can copy files via :command:`scp`, in order to avoid restarting the VM.
43-
For additional details about connecting to the VM via the network, please check :ref:`vm_interaction_link`.
41+
You DO NOT need to STOP the VM when rebuilding modules!
42+
The local `skels` directory is shared with the VM.
4443

4544
Review the `Exercises`_ section for more detailed information.
4645

Documentation/teaching/labs/kernel_modules.rst

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -996,17 +996,15 @@ in the Linux kernel source code:
996996
To work with the kernel modules, we will follow the steps described
997997
:ref:`above <exercises_summary>`.
998998
999-
Generate the skeleton for the task named **1-2-test-mod** then build and
1000-
copy the module to the VM, by running the following commands in
1001-
:file:`tools/labs`.
999+
Generate the skeleton for the task named **1-2-test-mod** then build the module,
1000+
by running the following command in :file:`tools/labs`.
10021001
10031002
.. code-block:: bash
10041003
10051004
$ LABS=kernel_modules make skels
10061005
$ make build
1007-
$ make copy
10081006
1009-
These commands will build and copy all the modules in the current
1007+
These command will build all the modules in the current
10101008
lab skeleton.
10111009
10121010
.. warning::
@@ -1015,8 +1013,7 @@ lab skeleton.
10151013
:file:`skels/kernel_modules/3-error-mod/` and remove the corresponding
10161014
line from ``skels/Kbuild``.
10171015
1018-
Start the VM using :command:`make boot`, connect to the serial console
1019-
using `minicom -D serial.pts` and perform the following tasks:
1016+
Start the VM using :command:`make console`, and perform the following tasks:
10201017
10211018
* load the kernel module.
10221019

Documentation/teaching/so2/lab1-intro.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ Exercises
6363
.. include:: ../labs/exercises-summary.hrst
6464
.. |LAB_NAME| replace:: kernel_modules
6565

66-
.. include:: ../labs/introduction.rst
67-
:start-after: [EXERCISE1-BEGIN]
68-
:end-before: [EXERCISE1-END]
66+
.. .. include:: ../labs/introduction.rst
67+
.. :start-after: [EXERCISE1-BEGIN]
68+
.. :end-before: [EXERCISE1-END]
6969
7070
.. include:: ../labs/kernel_modules.rst
7171
:start-after: [EXERCISE1-BEGIN]

0 commit comments

Comments
 (0)