summaryrefslogtreecommitdiffstats
path: root/Documentation/development-process
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2016-07-20 16:43:41 -0600
committerJonathan Corbet <corbet@lwn.net>2016-07-20 16:45:37 -0600
commit8ed292fe864e9ed7d335515e97590122a56d7cba (patch)
treec86eb1cb91d7e728042c0a577c4eb9d2d87c88d2 /Documentation/development-process
parent47d6d752b9e20dbe8a2acd22e887be81a6f39de9 (diff)
downloadlinux-stable-8ed292fe864e9ed7d335515e97590122a56d7cba.tar.gz
linux-stable-8ed292fe864e9ed7d335515e97590122a56d7cba.tar.bz2
linux-stable-8ed292fe864e9ed7d335515e97590122a56d7cba.zip
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 <daniel.vetter@ffwll.ch> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/development-process')
-rw-r--r--Documentation/development-process/4.Coding2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/development-process/4.Coding b/Documentation/development-process/4.Coding
index e3cb6a56653a..9a3ee77cefb1 100644
--- a/Documentation/development-process/4.Coding
+++ b/Documentation/development-process/4.Coding
@@ -346,7 +346,7 @@ which have not been so documented, there is no harm in adding kerneldoc
comments for the future; indeed, this can be a useful activity for
beginning kernel developers. The format of these comments, along with some
information on how to create kerneldoc templates can be found in the file
-Documentation/kernel-doc-nano-HOWTO.txt.
+Documentation/kernel-documentation.rst.
Anybody who reads through a significant amount of existing kernel code will
note that, often, comments are most notable by their absence. Once again,