On Thu, 20 Apr 2017, Andrew Clayton <andrew@xxxxxxxxxxxxxxxxxx> wrote: > 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@xxxxxxxxxxxxxxxxxx> > --- > V2 - Convert the document references into :ref: links Thanks, this seems like a much better change to me. Reviewed-by: Jani Nikula <jani.nikula@xxxxxxxxx> Jon, Mauro, am I right in that the only place that actually leads to the development process documentation that starts at 1.Intro.rst is in fact submitting-patches.rst? It's not referenced in any indexes is it? BR, Jani. > > Documentation/admin-guide/kernel-parameters.rst | 2 ++ > 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 b516164999a8..e41d90dbd6c8 100644 > --- a/Documentation/admin-guide/kernel-parameters.rst > +++ b/Documentation/admin-guide/kernel-parameters.rst > @@ -1,3 +1,5 @@ > +.. _kernelparameters: > + > The kernel's command-line parameters > ==================================== > > 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 > ************ > > 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 > @@ -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. -- Jani Nikula, Intel Open Source Technology Center -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
