Update documentation for lab1

* Add reference to so2-labs gitlab repo * Change `make boot` to `make console` Signed-off-by: Dragoș-Iulian ARGINT <[email protected]>
linux-kernel-labs · Mar 6, 2024 · 00ffad9 · 00ffad9
1 parent 42f075b
commit 00ffad9
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 17 deletions.
diff --git a/Documentation/teaching/info/vm.rst b/Documentation/teaching/info/vm.rst
@@ -1,5 +1,10 @@
 .. _vm_link:
 
+=====================
+Recommended Setup
+=====================
+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>`__.
+
 =====================
 Virtual Machine Setup
 =====================

diff --git a/Documentation/teaching/labs/exercises-summary.hrst b/Documentation/teaching/labs/exercises-summary.hrst
@@ -1,10 +1,10 @@
 .. important::
 
-   To solve exercises, you need to perform these steps:
+   We strongly encourage you to use the setup from `this repository <https://gitlab.cs.pub.ro/so2/so2-labs>`__.
 
+   To solve exercises, you need to perform these steps:
       * prepare skeletons from templates
       * build modules
-      * copy modules to the VM
       * start the VM and test the module in the VM.
 
    The current lab name is |LAB_NAME|. See the exercises for the task name.
@@ -30,17 +30,16 @@
 
       tools/labs $ make build
 
-   Then, copy the modules and start the VM:
+   Then, start the VM:
 
    .. code-block:: shell
 
-      tools/labs $ make copy
-      tools/labs $ make boot
+      tools/labs $ make console
 
    The modules are placed in /home/root/skels/|LAB_NAME|/<task_name>.
 
-   Alternatively, we can copy files via :command:`scp`, in order to avoid restarting the VM.
-   For additional details about connecting to the VM via the network, please check :ref:`vm_interaction_link`.
+   You DO NOT need to STOP the VM when rebuilding modules!
+   The local `skels` directory is shared with the VM.
 
    Review the `Exercises`_ section for more detailed information.
 

diff --git a/Documentation/teaching/labs/kernel_modules.rst b/Documentation/teaching/labs/kernel_modules.rst
@@ -996,17 +996,15 @@ in the Linux kernel source code:
 To work with the kernel modules, we will follow the steps described
 :ref:`above <exercises_summary>`.
 
-Generate the skeleton for the task named **1-2-test-mod** then build and
-copy the module to the VM, by running the following commands in
-:file:`tools/labs`.
+Generate the skeleton for the task named **1-2-test-mod** then build the module,
+ by running the following command in :file:`tools/labs`.
 
 .. code-block:: bash
 
   $ LABS=kernel_modules make skels
   $ make build
-  $ make copy
 
-These commands will build and copy all the modules in the current
+These command will build all the modules in the current
 lab skeleton.
 
 .. warning::
@@ -1015,8 +1013,7 @@ lab skeleton.
   :file:`skels/kernel_modules/3-error-mod/` and remove the corresponding
   line from ``skels/Kbuild``.
 
-Start the VM using :command:`make boot`, connect to the serial console
-using `minicom -D serial.pts` and perform the following tasks:
+Start the VM using :command:`make console`, and perform the following tasks:
 
 * load the kernel module.
 

diff --git a/Documentation/teaching/so2/lab1-intro.rst b/Documentation/teaching/so2/lab1-intro.rst
@@ -63,9 +63,9 @@ Exercises
 .. include:: ../labs/exercises-summary.hrst
 .. |LAB_NAME| replace:: kernel_modules
 
-.. include:: ../labs/introduction.rst
-    :start-after: [EXERCISE1-BEGIN]
-    :end-before: [EXERCISE1-END]
+.. .. include:: ../labs/introduction.rst
+..     :start-after: [EXERCISE1-BEGIN]
+..     :end-before: [EXERCISE1-END]
 
 .. include:: ../labs/kernel_modules.rst
     :start-after: [EXERCISE1-BEGIN]