User_documentation

User's documentation

In this page, you will find all useful details for an user to go further in this project use. If you want to learn more or to help, we advise you to read the developers documentation afterward.

Firstly, you can check our <a target='_blank' href={require('files/User_Manual.pdf')}>PDF Doc User manual

Table of content :

• Python script entry point : kernel_generator.py
• Sample generation workflow
• Database structure : what do we retrieve?

Python script entry point : kernel_generator.py

Work in progress

Sample generation workflow

Work in progress

Database structure : what do we retrieve?

Work in progress

Advanced use case: Compilation inside Docker Tuxml

(Related to issue #140) TODO: maybe add some screenshots

The goal of this tutorial is to use the docker container in order to build a specific kernel configuration, in order to do that we need to manipulate the container.

First of all we need to install the docker image locally if it isn't done yet. using this command you can download the image:

$ python3 kernel_generator.py 1 --tiny 

first we need to run the container based on the tuxml/tuxml:prod, then copy the file, you can use this command to run a container:

$ docker run -it tuxml/tuxml:prod

(to list all images use: $ docker images or $ docker image ls -> same output)

this will open you a shell inside the container, from that point you could exit the container to start it again then copy then attach. or you could simply open another terminal, list the running containers, and then copy your file in the right one.

• open another terminal
• use $ docker container ls to find your container's id or alias (funny two words names).
• then: $ docker cp <file> <container-id>:/<rest of the path>

so as an example:

$ docker cp .config objective_montalcini:/TuxML/linux-4.13.3/.config

The other method (one terminal):

• exit the shell with the "exit" command.
• restart the container, to know which one it is used $ docker container ls -a, once you find it use: $ docker restart <container-id>
• then: $ docker cp <file> <container-id>:/<rest of the path> Example:

$ docker cp .config objective_montalcini:/TuxML/linux-4.13.3/.config"

and then do what you have to do, that is installing dependencies through apt or using make on the kernel to see what happens.

(as an example if you need git: "apt install git")