Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 0cef67aa authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

Documentation/SubmitChecklist: update kernel-doc task 



Task 11 (kernel-doc) still mentions usage of make manpages, but
this won't work if the API is documented via Sphinx. So, update
it to use either htmldocs or pdfdocs, with are the documentation
targets that work for all.

While here, add ReST reference to the kernel documentation book.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent f1eebe92

Documentation/SubmitChecklist

+4 −3
Original line number Original line Diff line number Diff line
@@ -47,9 +47,10 @@ kernel patches. 
    but any one function that uses more than 512 bytes on the stack is a

    but any one function that uses more than 512 bytes on the stack is a

    candidate for change.

    candidate for change.





11: Include kernel-doc to document global kernel APIs.  (Not required for

11: Include :ref:`kernel-doc <kernel_doc>` to document global  kernel APIs.

    static functions, but OK there also.) Use 'make htmldocs' or 'make

    (Not required for static functions, but OK there also.) Use

    mandocs' to check the kernel-doc and fix any issues.

    ``make htmldocs`` or ``make pdfdocs`` to check the

    :ref:`kernel-doc <kernel_doc>` and fix any issues.





12: Has been tested with CONFIG_PREEMPT, CONFIG_DEBUG_PREEMPT,

12: Has been tested with CONFIG_PREEMPT, CONFIG_DEBUG_PREEMPT,

    CONFIG_DEBUG_SLAB, CONFIG_DEBUG_PAGEALLOC, CONFIG_DEBUG_MUTEXES,

    CONFIG_DEBUG_SLAB, CONFIG_DEBUG_PAGEALLOC, CONFIG_DEBUG_MUTEXES,

Documentation/kernel-documentation.rst

+2 −0
Original line number Original line Diff line number Diff line
@@ -294,6 +294,8 @@ The kernel-doc extension is included in the kernel source tree, at 
``scripts/kernel-doc`` script to extract the documentation comments from the

``scripts/kernel-doc`` script to extract the documentation comments from the

source.

source.





.. _kernel_doc:



Writing kernel-doc comments

Writing kernel-doc comments

===========================

===========================