The following directories have several .txt file. Please pick 2 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 with seems to be provided by its manufacturer.

Preparing to build the documentation:

There's a script with 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 warns:

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.

Shifting signed 32-bit value by 31 bits is undefined behaviour errors

These errors aren't real problems for us as compiler takes care of these. However, cleaning these up doesn't hurt, especially in public API headers. Some maintainers might like drivers fixed, on the other hand fixing public API headers first is a good idea. There are two ways to fix this:

• Change #define FOO (1 « 31) to #define FOO BIT(31) or
• Adding a “U” cast - changing (1 « 31) to (1U « 31)

cd git_repo_dir

cppcheck –force ./ > cppcheck.out 2>&1

You can run cppcheck on one or more files by passing a list of files: cppcheck –file-list=files

Grep for “Shifting signed 32-bit value by 31 bits is undefined behaviour” errors

You can refer to the one I generated on Linux 5.2-rc3 cppcheck 32-bit log

Linux 5.2-rc3 cppcheck full log

Defines in public headers - include/

Uninitialized variable errors/warns

Grep for Uninitialized variable errors and send fixes in. Make sure the error is real and not a false. Check to see if it is used before initializing.