diff options
| author | Jonathan Corbet <corbet@lwn.net> | 2016-07-21 00:43:41 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2016-07-21 00:45:37 +0200 |
| commit | 8ed292fe864e9ed7d335515e97590122a56d7cba (patch) | |
| tree | c86eb1cb91d7e728042c0a577c4eb9d2d87c88d2 /Documentation/CodingStyle | |
| parent | doc/sphinx: Enable keep_warnings (diff) | |
| download | linux-8ed292fe864e9ed7d335515e97590122a56d7cba.tar.xz 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/CodingStyle')
| -rw-r--r-- | Documentation/CodingStyle | 2 |
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 it. 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. |