diff options
author | Andrew Clayton <andrew@digital-domain.net> | 2017-04-20 09:04:15 -0400 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2017-04-20 15:56:17 -0400 |
commit | 9b9355a2692621be80f95ac31e16d2c16c1c07c9 (patch) | |
tree | 098fc1a9f5877293f24e9010f2425249352ec616 | |
parent | e1c3e6e1ca996e0403a5958c054d2cebf1642b15 (diff) |
docs: process/4.Coding.rst: Fix a couple of document refs
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>
-rw-r--r-- | Documentation/admin-guide/kernel-parameters.rst | 2 | ||||
-rw-r--r-- | Documentation/process/4.Coding.rst | 17 |
2 files changed, 11 insertions, 8 deletions
diff --git a/Documentation/admin-guide/kernel-parameters.rst b/Documentation/admin-guide/kernel-parameters.rst index c5eae20d5691..33b90e273489 100644 --- a/Documentation/admin-guide/kernel-parameters.rst +++ b/Documentation/admin-guide/kernel-parameters.rst | |||
@@ -1,3 +1,5 @@ | |||
1 | .. _kernelparameters: | ||
2 | |||
1 | The kernel's command-line parameters | 3 | The kernel's command-line parameters |
2 | ==================================== | 4 | ==================================== |
3 | 5 | ||
diff --git a/Documentation/process/4.Coding.rst b/Documentation/process/4.Coding.rst index 2a728d898fc5..6df19943dd4d 100644 --- a/Documentation/process/4.Coding.rst +++ b/Documentation/process/4.Coding.rst | |||
@@ -22,11 +22,11 @@ Coding style | |||
22 | ************ | 22 | ************ |
23 | 23 | ||
24 | The kernel has long had a standard coding style, described in | 24 | The kernel has long had a standard coding style, described in |
25 | Documentation/process/coding-style.rst. For much of that time, the policies described | 25 | :ref:`Documentation/process/coding-style.rst <codingstyle>`. For much of |
26 | in that file were taken as being, at most, advisory. As a result, there is | 26 | that time, the policies described in that file were taken as being, at most, |
27 | a substantial amount of code in the kernel which does not meet the coding | 27 | advisory. As a result, there is a substantial amount of code in the kernel |
28 | style guidelines. The presence of that code leads to two independent | 28 | which does not meet the coding style guidelines. The presence of that code |
29 | hazards for kernel developers. | 29 | leads to two independent hazards for kernel developers. |
30 | 30 | ||
31 | The first of these is to believe that the kernel coding standards do not | 31 | The first of these is to believe that the kernel coding standards do not |
32 | matter and are not enforced. The truth of the matter is that adding new | 32 | 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 | |||
343 | Documentation/ABI/README for a description of how this documentation should | 343 | Documentation/ABI/README for a description of how this documentation should |
344 | be formatted and what information needs to be provided. | 344 | be formatted and what information needs to be provided. |
345 | 345 | ||
346 | The file Documentation/admin-guide/kernel-parameters.rst describes all of the kernel's | 346 | The file :ref:`Documentation/admin-guide/kernel-parameters.rst |
347 | boot-time parameters. Any patch which adds new parameters should add the | 347 | <kernelparameters>` describes all of the kernel's boot-time parameters. |
348 | appropriate entries to this file. | 348 | Any patch which adds new parameters should add the appropriate entries to |
349 | this file. | ||
349 | 350 | ||
350 | Any new configuration options must be accompanied by help text which | 351 | Any new configuration options must be accompanied by help text which |
351 | clearly explains the options and when the user might want to select them. | 352 | clearly explains the options and when the user might want to select them. |