mirrors/linux
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2025-01-26 18:43:33 -05:00
Code Activity

docs: process/4.Coding.rst: Fix a couple of document refs

Browse source 
In Documentation/process/4.Coding.rst there were a couple of paragraphs
that spilled over the 80 character line length. This was likely caused
when the document was converted to reStructuredText. Re-flow the
paragraphs and make the document references proper reStructuredText
:ref: links.

This also adds the appropriate reStructuredText file heading to
kernel-parameters.rst as referenced by the kernel-parameters link in
this patch.

Signed-off-by: Andrew Clayton <andrew@digital-domain.net>
Reviewed-by: Jani Nikula <jani.nikula@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Andrew Clayton 2017-04-20 14:04:15 +01:00 • committed by Jonathan Corbet
parent e1c3e6e1ca
commit 9b9355a269
2 changed files with 11 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Documentation/admin-guide/kernel-parameters.rst
View file

@ -1,3 +1,5 @@
.. _kernelparameters:
The kernel's command-line parameters The kernel's command-line parameters
==================================== ====================================

17
Documentation/process/4.Coding.rst
View file

@ -22,11 +22,11 @@ Coding style
************ ************
The kernel has long had a standard coding style, described in The kernel has long had a standard coding style, described in
Documentation/process/coding-style.rst. For much of that time, the policies described :ref:`Documentation/process/coding-style.rst <codingstyle>`. For much of
in that file were taken as being, at most, advisory. As a result, there is that time, the policies described in that file were taken as being, at most,
a substantial amount of code in the kernel which does not meet the coding advisory. As a result, there is a substantial amount of code in the kernel
style guidelines. The presence of that code leads to two independent which does not meet the coding style guidelines. The presence of that code
hazards for kernel developers. leads to two independent hazards for kernel developers.
The first of these is to believe that the kernel coding standards do not The first of these is to believe that the kernel coding standards do not
matter and are not enforced. The truth of the matter is that adding new matter and are not enforced. The truth of the matter is that adding new
@ -343,9 +343,10 @@ user-space developers to know what they are working with. See
Documentation/ABI/README for a description of how this documentation should Documentation/ABI/README for a description of how this documentation should
be formatted and what information needs to be provided. be formatted and what information needs to be provided.
The file Documentation/admin-guide/kernel-parameters.rst describes all of the kernel's The file :ref:`Documentation/admin-guide/kernel-parameters.rst
boot-time parameters. Any patch which adds new parameters should add the <kernelparameters>` describes all of the kernel's boot-time parameters.
appropriate entries to this file. Any patch which adds new parameters should add the appropriate entries to
this file.
Any new configuration options must be accompanied by help text which Any new configuration options must be accompanied by help text which
clearly explains the options and when the user might want to select them. clearly explains the options and when the user might want to select them.