diff --git a/README.md b/README.md index ff134914d067139edee87c2cf2a876116161164c..8e3f8a5e4bd906bb335779f3862371c2c09f61c7 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,15 @@ $ git clone <remote_of_your_private_fork> ``` ## Working on the assignment -Start the assignment from the skeleton inside the `src/` directory. +Start the assignment from the header inside the `src/` directory. +Please note that you must provide a `Kbuild` file and the module name must be `tracer.ko`. +> **Warning** +> You must not change this header, it will be overwritten by the checker. +> You can include any other headers in your project. + The first option is to code in the `src/` and run the checker using the following command: ``` -$ ./local.sh checker 0-list +$ ./local.sh checker 1-tracer ``` This will start the docker, start the SO2 VM inside the docker and run the checher for you inside the VM. If your run on Linux you can add the `--privileged` argument to the previous command and the checker will run with KVM support. @@ -35,8 +40,8 @@ Thus the container will be started in privileged mode and you have access to KVM After executing the last command you should get a prompter in the docker. > **Warning** -> When running in interactive mode the `src/` directory is mounted to the `/linux/tools/labs/skels/assignments/0-list` directory inside the docker. -> The previous directory is shared with the VM as well in `skels/assignments/0-list`. +> When running in interactive mode the `src/` directory is mounted to the `/linux/tools/labs/skels/assignments/1-tracer` directory inside the docker. +> The previous directory is shared with the VM as well in `skels/assignments/1-tracer`. > So any change in one would affect the other. > **Be careful not to delete your code!**. > We encourage you to make as many commits as possible on your **private** gitlab repo! @@ -54,21 +59,24 @@ $ make console ``` After this command you should get a prompter inside the VM -4. Copy the `*.ko` into the `skels/assginments/0-list-checker` directory +4. Copy the `*.ko` into the `skels/assginments/1-tracer-checker` directory ``` # you should be in /home/root inside the VM -$ cd skels/assignments/0-list-checker -$ cp ../0-list/list.ko . +$ cd skels/assignments/1-tracer-checker +$ cp ../1-tracer/tracer.ko . +# you should also copy the tracer_helper.ko from the _helper directory +# this module is part of the checker +$ cp _helper/tracer_helper.ko . ``` 5. Run the checker ``` -# you should be in skels/assignments/0-list-checker inside the VM +# you should be in skels/assignments/1-tracer-checker inside the VM sh _checker ``` ## Submiting the assignment -1. Create a `*.zip` archive containing all the source files and headers of your solution and a `Kbuild` file that results in the `list.ko` module. +1. Create a `*.zip` archive containing all the source files and headers of your solution and a `Kbuild` file that results in the `tracer.ko` module. 2. Upload the archive on moodle in the section corresponding to the assignment. 3. After a few minutes, you can see the checker results on the submission page, like in the following image. 