Commit 8ed292fe authored by Jonathan Corbet's avatar Jonathan Corbet

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: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 47d6d752
...@@ -255,10 +255,10 @@ kbuild/ ...@@ -255,10 +255,10 @@ kbuild/
- directory with info about the kernel build process. - directory with info about the kernel build process.
kdump/ kdump/
- directory with mini HowTo on getting the crash dump code to work. - directory with mini HowTo on getting the crash dump code to work.
kernel-doc-nano-HOWTO.txt
- mini HowTo on generation and location of kernel documentation files.
kernel-docs.txt kernel-docs.txt
- listing of various WWW + books that document kernel internals. - listing of various WWW + books that document kernel internals.
kernel-documentation.rst
- how to write and format reStructuredText kernel documentation
kernel-parameters.txt kernel-parameters.txt
- summary listing of command line / boot prompt args for the kernel. - summary listing of command line / boot prompt args for the kernel.
kernel-per-CPU-kthreads.txt kernel-per-CPU-kthreads.txt
......
...@@ -458,7 +458,7 @@ of the function, telling people what it does, and possibly WHY it does ...@@ -458,7 +458,7 @@ of the function, telling people what it does, and possibly WHY it does
it. it.
When commenting the kernel API functions, please use the kernel-doc format. 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. for details.
Linux style for comments is the C89 "/* ... */" style. Linux style for comments is the C89 "/* ... */" style.
......
...@@ -346,7 +346,7 @@ which have not been so documented, there is no harm in adding kerneldoc ...@@ -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 comments for the future; indeed, this can be a useful activity for
beginning kernel developers. The format of these comments, along with some beginning kernel developers. The format of these comments, along with some
information on how to create kerneldoc templates can be found in the file 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 Anybody who reads through a significant amount of existing kernel code will
note that, often, comments are most notable by their absence. Once again, note that, often, comments are most notable by their absence. Once again,
......
NOTE: this document is outdated and will eventually be removed. See
Documentation/kernel-documentation.rst for current information.
kernel-doc nano-HOWTO kernel-doc nano-HOWTO
===================== =====================
......
...@@ -399,7 +399,7 @@ C是一个简朴的语言,你的命名也应该这样。和 Modula-2 和 Pasca ...@@ -399,7 +399,7 @@ C是一个简朴的语言,你的命名也应该这样。和 Modula-2 和 Pasca
些事情的原因。 些事情的原因。
当注释内核API函数时,请使用 kernel-doc 格式。请看 当注释内核API函数时,请使用 kernel-doc 格式。请看
Documentation/kernel-doc-nano-HOWTO.txt和scripts/kernel-doc 以获得详细信息。 Documentation/kernel-documentation.rst和scripts/kernel-doc 以获得详细信息。
Linux的注释风格是 C89 “/* ... */” 风格。不要使用 C99 风格 “// ...” 注释。 Linux的注释风格是 C89 “/* ... */” 风格。不要使用 C99 风格 “// ...” 注释。
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment