summaryrefslogtreecommitdiff
path: root/Documentation/process/coding-style.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-11-17 13:32:33 +0300
committerJonathan Corbet <corbet@lwn.net>2016-11-19 20:22:04 +0300
commit1dc4bbf0b268246f6202c761016735933b6f0b99 (patch)
tree0bb12a6c59472d8167dbebac4fe6a68023956813 /Documentation/process/coding-style.rst
parent726d661fea3e3f76d36515c74e4ce58e7789418e (diff)
downloadlinux-1dc4bbf0b268246f6202c761016735933b6f0b99.tar.xz
docs-rst: doc-guide: split the kernel-documentation.rst contents
Having the kernel-documentation at the topmost level doesn't allow generating a separate PDF file for it. Also, makes harder to add extra contents. So, place it on a sub-dir. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/process/coding-style.rst')
-rw-r--r--Documentation/process/coding-style.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
index 3e7905172000..d20d52a4d812 100644
--- a/Documentation/process/coding-style.rst
+++ b/Documentation/process/coding-style.rst
@@ -525,8 +525,8 @@ of the function, telling people what it does, and possibly WHY it does
it.
When commenting the kernel API functions, please use the kernel-doc format.
-See the files Documentation/kernel-documentation.rst and scripts/kernel-doc
-for details.
+See the files at :ref:`Documentation/doc-guide/ <doc_guide>` and
+``scripts/kernel-doc`` for details.
The preferred style for long (multi-line) comments is: