Skip to content

Commit

Permalink
docs: process/4.Coding.rst: Fix a couple of document refs
Browse files Browse the repository at this point in the history
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 <[email protected]>
Reviewed-by: Jani Nikula <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
  • Loading branch information
ac000 authored and Jonathan Corbet committed Apr 20, 2017
1 parent e1c3e6e commit 9b9355a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
2 changes: 2 additions & 0 deletions Documentation/admin-guide/kernel-parameters.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _kernelparameters:

The kernel's command-line parameters
====================================

Expand Down
17 changes: 9 additions & 8 deletions Documentation/process/4.Coding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ Coding style
************

The kernel has long had a standard coding style, described in
Documentation/process/coding-style.rst. For much of that time, the policies described
in that file were taken as being, at most, advisory. As a result, there is
a substantial amount of code in the kernel which does not meet the coding
style guidelines. The presence of that code leads to two independent
hazards for kernel developers.
:ref:`Documentation/process/coding-style.rst <codingstyle>`. For much of
that time, the policies described in that file were taken as being, at most,
advisory. As a result, there is a substantial amount of code in the kernel
which does not meet the coding style guidelines. The presence of that code
leads to two independent hazards for kernel developers.

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
Expand Down Expand Up @@ -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
be formatted and what information needs to be provided.

The file Documentation/admin-guide/kernel-parameters.rst describes all of the kernel's
boot-time parameters. Any patch which adds new parameters should add the
appropriate entries to this file.
The file :ref:`Documentation/admin-guide/kernel-parameters.rst
<kernelparameters>` describes all of the kernel's boot-time parameters.
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
clearly explains the options and when the user might want to select them.
Expand Down

0 comments on commit 9b9355a

Please sign in to comment.