diff options
| author |   Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-11-17 08:32:33 -0200 |
|---|---|---|
| committer |   Jonathan Corbet <corbet@lwn.net> | 2016-11-19 10:22:04 -0700 |
| commit | 1dc4bbf0b268246f6202c761016735933b6f0b99 (patch) | |
| tree | 0bb12a6c59472d8167dbebac4fe6a68023956813 /Documentation/process | |
| parent | Merge remote-tracking branch 'sound/topic/restize-docs' into sound (diff) | |
| download | linux-dev-1dc4bbf0b268246f6202c761016735933b6f0b99.tar.xz linux-dev-1dc4bbf0b268246f6202c761016735933b6f0b99.zip | |
docs-rst: doc-guide: split the kernel-documentation.rst contents
Having the kernel-documentation at the topmost level doesn't
allow generating a separate PDF file for it. Also, makes harder
to add extra contents. So, place it on a sub-dir.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/process')
| -rw-r--r-- | Documentation/process/4.Coding.rst | 4 | ||||
| -rw-r--r-- | Documentation/process/coding-style.rst | 4 |
2 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/process/4.Coding.rst b/Documentation/process/4.Coding.rst index 983d628c1112..2a728d898fc5 100644 --- a/Documentation/process/4.Coding.rst +++ b/Documentation/process/4.Coding.rst @@ -358,8 +358,8 @@ them, as appropriate, for externally-available functions. Even in areas 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-documentation.rst. +information on how to create kerneldoc templates can be found at +:ref:`Documentation/doc-guide/ <doc_guide>`. 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/process/coding-style.rst b/Documentation/process/coding-style.rst index 3e7905172000..d20d52a4d812 100644 --- a/Documentation/process/coding-style.rst +++ b/Documentation/process/coding-style.rst @@ -525,8 +525,8 @@ 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-documentation.rst and scripts/kernel-doc -for details. +See the files at :ref:`Documentation/doc-guide/ <doc_guide>` and +``scripts/kernel-doc`` for details. The preferred style for long (multi-line) comments is: |