Documentation/SubmitChecklist: update kernel-doc task
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 19 Sep 2016 11:08:00 +0000 (08:08 -0300)
committerJonathan Corbet <corbet@lwn.net>
Wed, 21 Sep 2016 00:41:44 +0000 (18:41 -0600)
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>
Documentation/SubmitChecklist
Documentation/kernel-documentation.rst

index 2b7e32dfe00d95fadabc535372bea6ba343fdc59..bb114c8a781c78bf7477c12463284a4df08cd020 100644 (file)
@@ -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,
index bc4c3f52681616ab4343fb41a3ab69e3f98a1954..ceb80b898bb307dd21485cdf4069a100e6319581 100644 (file)
@@ -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
 source.
 
+.. _kernel_doc:
+
 Writing kernel-doc comments
 ===========================