[PATCH] docs: deprecate kernel-doc-nano-HOWTO.txt

From: Jonathan Corbet
Date: Wed Jul 20 2016 - 18:43:41 EST

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@xxxxxxxx>
Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>
Documentation/00-INDEX | 4 ++--
Documentation/CodingStyle | 2 +-
Documentation/development-process/4.Coding | 2 +-
Documentation/kernel-doc-nano-HOWTO.txt | 3 +++
Documentation/zh_CN/CodingStyle | 2 +-
5 files changed, 8 insertions(+), 5 deletions(-)

diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX
index cd077ca0e1b8..cb9a6c6fa83b 100644
--- a/Documentation/00-INDEX
+++ b/Documentation/00-INDEX
@@ -255,10 +255,10 @@ kbuild/
- directory with info about the kernel build process.
- directory with mini HowTo on getting the crash dump code to work.
- - mini HowTo on generation and location of kernel documentation files.
- listing of various WWW + books that document kernel internals.
+ - how to write and format reStructuredText kernel documentation
- summary listing of command line / boot prompt args for the kernel.
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.
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

Anybody who reads through a significant amount of existing kernel code will
note that, often, comments are most notable by their absence. Once again,
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

diff --git a/Documentation/zh_CN/CodingStyle b/Documentation/zh_CN/CodingStyle
index bbb9d6ae05ca..12717791baac 100644
--- a/Documentation/zh_CN/CodingStyle
+++ b/Documentation/zh_CN/CodingStyle
@@ -399,7 +399,7 @@ Cæ?¯ä¸?个ç®?æ?´ç??语è¨?ï¼?ä½ ç??å?½å??ä¹?åº?该è¿?æ ·ã??å?? Modula-2 å?? Pasca
äº?äº?æ??ç??å??å? ã??

å½?注é??å??æ ¸APIå?½æ?°æ?¶ï¼?请使ç?¨ kernel-doc æ ¼å¼?ã??请ç??
-Documentation/kernel-doc-nano-HOWTO.txtå??scripts/kernel-doc 以è?·å¾?详ç»?ä¿¡æ?¯ã??
+Documentation/kernel-documentation.rstå??scripts/kernel-doc 以è?·å¾?详ç»?ä¿¡æ?¯ã??

Linuxç??注é??é£?æ ¼æ?¯ C89 â??/* ... */â?? é£?æ ¼ã??ä¸?è¦?使ç?¨ C99 é£?æ ¼ â??// ...â?? 注é??ã??