Go back to the main GSoC Linux Foundation page

Repository: https://github.com/kworkflow/kworkflow

Documentation: https://kworkflow.org/

IRC: #kworkflow on irc.freenode.net

Code License: GPLv2

Mentor: Rodrigo Siqueira, aka siqueira (siqueirajordao at riseup dot net)

Kworkflow, or just kw, is a tool that intends to simplify the kernel workflow by automating tasks such as:

1. Manage kernel build;
2. Manage installation/removal of Linux on a target machine (local, remote, or VMs);
3. Provide an easy way to collect basic information;
4. Manage config files;
5. Support working on DRM subsystem (we can expand to other subsystems). Etc;

By using kw we expect to speed up everyday tasks executed by kernel developers in their workflow, provide a unified development experience, and reduce the learning curve for newcomers. Finally, the project should be reasonably easy to contribute since it is written in Bash, has extensive test coverage, follows a code style rule, it is documented from the code level to the user level. Don't believe it? Check by yourself:

• https://kworkflow.org/index.html
• https://app.codecov.io/gh/kworkflow/kworkflow
• https://github.com/kworkflow/kworkflow/pull/563/checks

( ( This section is mandatory for everybody ) )

If you are interested in this project, we have a few but essential pre-requisites for you to try before your application:

1. Setup a virtual machine - https://flusp.ime.usp.br/others/use-qemu-to-play-with-linux/
2. Learn how to compile Linux kernel - https://flusp.ime.usp.br/others/Kernel-compilation-and-installation/
3. Learn how to install and remove a Linux kernel - https://flusp.ime.usp.br/others/Kernel-compilation-and-installation/
4. Learn how to deal with modules - https://flusp.ime.usp.br/others/play_with_modules/
5. Basic Bash knowledge - https://www.gnu.org/software/bash/manual/bash.pdf (Read until Chapter 7)

It is highly recommended that you try to send a small contribution to kw. For helping you to see what could be a good start, take a look at this link:

https://github.com/kworkflow/kworkflow/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22

Finally, before you try to submit a patch, take a few minutes to read the following page:

https://kworkflow.org/content/howtocontribute.html

If you could not complete the above topics or did not have fun doing it, this project may not fit you well. Don't worry, it's normal. I'm sure you will find some project that better suits your current skills and goals.

We are open to discuss the final project proposal. As guidance, follow some of the areas that we want to improve on kw:

1. Fix a few bugs, add more tests, and enlarge documentation;
2. Cleanup output and add verbose mode;
3. Add support to generate dpkg versions of the kernel;
4. Speed up kernel deploy to a machine;
5. Expand the set of OS supported by kw;

kw has many open tickets on the Github web page; feel free to propose some specific projects based on the available tickets.

The pre-requisites section is mandatory for everyone; for this reason, your final project proposal should have one section per assignment with two or three paragraphs that describe your experience with each task. Additionally, in your application, you must add print screens that follow the below instructions:

Contact Siqueira to get one specific ID

If you are really interested in this project, send a message to Siqueira and request one specific ID. You will need it for the next steps.

QEMU Setup

For demonstrating your QEMU setup, you will need need to take a print screen of your entire desktop with QEMU running and with the following comment in your TTY:

#kw 2021 GSoC <ID>

For your custom kernel installation

For showing that you were able to install a custom kernel in your VM system, add the following label in your kernel name suffix:

Kernel-<YOUR_NAME>-<YOUR_ID>
(( Replace YOUR_NAME by your first name, and YOUR_ID ))

Install it in your QEMU VM; in the TTY, run the following command:

uname -a

Take a print screen of the entire screen.

Finally, make sure that you have the following section in your application:

1. One or two paragraphs about you;
2. A couple of sections that describe your interaction with kw;
3. Highlight some of your contributions to kw;
4. A project proposal to be executed in the GSoC timeline. Please, make sure that you add three main milestones (it should match with the GSoC evaluation date) and a work breakdown.

P.s.: Feel free to share your draft before submitting the final version.