summaryrefslogtreecommitdiffstats
path: root/Documentation/kernel-doc-nano-HOWTO.txt
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/kernel-doc-nano-HOWTO.txt
parent47d6d752b9e20dbe8a2acd22e887be81a6f39de9 (diff)
downloadlinux-8ed292fe864e9ed7d335515e97590122a56d7cba.tar.gz
linux-8ed292fe864e9ed7d335515e97590122a56d7cba.tar.bz2
linux-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/kernel-doc-nano-HOWTO.txt')
-rw-r--r--Documentation/kernel-doc-nano-HOWTO.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt
index 78f69cdc9b3f..062e3af271b7 100644
--- a/Documentation/kernel-doc-nano-HOWTO.txt
+++ b/Documentation/kernel-doc-nano-HOWTO.txt
@@ -1,3 +1,6 @@
+NOTE: this document is outdated and will eventually be removed. See
+Documentation/kernel-documentation.rst for current information.
+
kernel-doc nano-HOWTO
=====================