summaryrefslogtreecommitdiff
path: root/Documentation/SubmitChecklist
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-09-19 14:08:00 +0300
committerJonathan Corbet <corbet@lwn.net>2016-09-21 03:41:44 +0300
commit0cef67aa651808bac9d79503ebf45246612262fe (patch)
tree54de8376a9f17196bb178f84482e584bfa8034b1 /Documentation/SubmitChecklist
parentf1eebe92c2653e8fc3760577e53befdc9b62ef26 (diff)
downloadlinux-0cef67aa651808bac9d79503ebf45246612262fe.tar.xz
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: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/SubmitChecklist')
-rw-r--r--Documentation/SubmitChecklist7
1 files changed, 4 insertions, 3 deletions
diff --git a/Documentation/SubmitChecklist b/Documentation/SubmitChecklist
index 2b7e32dfe00d..bb114c8a781c 100644
--- a/Documentation/SubmitChecklist
+++ b/Documentation/SubmitChecklist
@@ -47,9 +47,10 @@ kernel patches.
but any one function that uses more than 512 bytes on the stack is a
candidate for change.
-11: Include kernel-doc to document global kernel APIs. (Not required for
- static functions, but OK there also.) Use 'make htmldocs' or 'make
- mandocs' to check the kernel-doc and fix any issues.
+11: Include :ref:`kernel-doc <kernel_doc>` to document global kernel APIs.
+ (Not required for static functions, but OK there also.) Use
+ ``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,
CONFIG_DEBUG_SLAB, CONFIG_DEBUG_PAGEALLOC, CONFIG_DEBUG_MUTEXES,