path: root/Documentation/CodingStyle
diff options
authorJonathan Corbet <>2016-07-20 16:43:41 -0600
committerJonathan Corbet <>2016-07-20 16:45:37 -0600
commit8ed292fe864e9ed7d335515e97590122a56d7cba (patch)
treec86eb1cb91d7e728042c0a577c4eb9d2d87c88d2 /Documentation/CodingStyle
parent47d6d752b9e20dbe8a2acd22e887be81a6f39de9 (diff)
docs: deprecate kernel-doc-nano-HOWTO.txt
Now that the new Sphinx world order is taking over, the information in kernel-doc-nano-HOWTO.txt is outmoded. I hate to remove it altogether, since it's one of those files that people expect to find. But we can add a warning and fix all the other pointers to it. Reminded-by: Daniel Vetter <> Signed-off-by: Jonathan Corbet <>
Diffstat (limited to 'Documentation/CodingStyle')
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index 9a70ddd16584..a096836723ca 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -458,7 +458,7 @@ of the function, telling people what it does, and possibly WHY it does
When commenting the kernel API functions, please use the kernel-doc format.
-See the files Documentation/kernel-doc-nano-HOWTO.txt and scripts/kernel-doc
+See the files Documentation/kernel-documentation.rst and scripts/kernel-doc
for details.
Linux style for comments is the C89 "/* ... */" style.