summaryrefslogtreecommitdiffstats
path: root/Documentation/kernel-documentation.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-09-19 08:08:00 -0300
committerJonathan Corbet <corbet@lwn.net>2016-09-20 18:41:44 -0600
commit0cef67aa651808bac9d79503ebf45246612262fe (patch)
tree54de8376a9f17196bb178f84482e584bfa8034b1 /Documentation/kernel-documentation.rst
parentf1eebe92c2653e8fc3760577e53befdc9b62ef26 (diff)
downloadop-kernel-dev-0cef67aa651808bac9d79503ebf45246612262fe.zip
op-kernel-dev-0cef67aa651808bac9d79503ebf45246612262fe.tar.gz
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/kernel-documentation.rst')
-rw-r--r--Documentation/kernel-documentation.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/Documentation/kernel-documentation.rst b/Documentation/kernel-documentation.rst
index bc4c3f5..ceb80b8 100644
--- a/Documentation/kernel-documentation.rst
+++ b/Documentation/kernel-documentation.rst
@@ -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
===========================
OpenPOWER on IntegriCloud