[Linux-kernel-mentees] [PATCH RFC 3/3] docs: add documentation for checkpatch

Lukas Bulwahn lukas.bulwahn at gmail.com
Sun Jan 24 16:38:00 UTC 2021


On Sun, Jan 24, 2021 at 4:19 PM Dwaipayan Ray <dwaipayanray1 at gmail.com> wrote:
>
> Link the tools directory to the document root for Sphinx.
>

Sorry, I did not mean "Documentation/tools/checkpatch.rst"
_literally_; I only remembered that there is a subdirectory for
"tools" in Documentation; and quickly wrote the mail without checking
the actual name of the directory... assuming you would find the
directory I meant.

The directory is called "Documentation/dev-tools", it already has an
index file and the checkpatch.pl documentation fits nicely there.

Luksa

> Signed-off-by: Dwaipayan Ray <dwaipayanray1 at gmail.com>
> ---
>  Documentation/index.rst | 11 +++++++++++
>  1 file changed, 11 insertions(+)
>
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index 5888e8a7272f..ddd30e08a440 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -182,6 +182,17 @@ subprojects.
>
>     filesystems/ext4/index
>
> +Tools Documentation
> +-------------------
> +
> +The documentation in this section provides details about the kernel tools
> +and scripts.
> +
> +.. toctree::
> +   :maxdepth: 2
> +
> +   tools/index
> +
>  Other documentation
>  -------------------
>
> --
> 2.30.0
>


More information about the Linux-kernel-mentees mailing list