Linux Kernel Mentorship Task List

The following directories have several .txt files. Please pick two files and convert to ReST. There are a few exceptions that should be kept as plain text files:

• a configuration file whose extension is .txt;
• a dump of chapter extracted from an old arch-specific manual which seems to be provided by its manufacturer.

Preparing to build the documentation:

There's a script that checks if you have all needed dependencies to build the documentation. It is called automatically when you run make htmldocs. Alternatively, you can call the script directly with:

./scripts/sphinx-pre-install 

Building docs and looking for warnings:

Once you have all the requirements, you can do the building with:

make htmldocs > doc_make.log 2>&1

And check the warnings with the following script.

#!/bin/bash
#
# SPDX-License-Identifier: GPL-2.0
#
# Copyright(c) Shuah Khan <skhan@linuxfoundation.org>
# License: GPLv2
#
# Generates wiki format table of task list from Document
# build log
# Usage: gen_doc_task_list.sh <doc_build_log_file>

# Print Table header
echo "| **Task** | **Description** | **Owner** | **Status** | **Commit ID** |"
for f in `egrep "warn|WARN|error|ERROR" $1 | \
        egrep ".c:|.h:|.rst:" | \
        awk -F: '{print $1}' | awk '!a[$0]++' | \
        sed -e "s/^.\///" | sed -e "s/^\/mnt\/data\/lkml\/linux_5.3\///"`
do
        echo "| $f | Fix warns | | | |"
done

Before starting work on a task, please check the archive first to see if a patch is already in progress. Please avoid duplicated efforts. Liunx Kernel Mentees Archive. Send email to the list informing others that you are working on the task.