Re: [PATCH] docs: process/4.Coding.rst: Re-flow a couple of paragraphs

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Wed, 19 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 brings them back in line with the rest of the document.
>
> Signed-off-by: Andrew Clayton <andrew@xxxxxxxxxxxxxxxxxx>

While this change is technically fine, fixing an issue likely introduced
by changing the filenames using sed, I think the right thing to do would
be to cross-reference the documents using reStructuredText constructs
rather than just naming files inline.

BR,
Jani.


> ---
>  Documentation/process/4.Coding.rst | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/Documentation/process/4.Coding.rst b/Documentation/process/4.Coding.rst
> index 2a728d898fc5..017f22fa970c 100644
> --- a/Documentation/process/4.Coding.rst
> +++ b/Documentation/process/4.Coding.rst
> @@ -22,10 +22,10 @@ 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
> +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.
>  
>  The first of these is to believe that the kernel coding standards do not
> @@ -343,9 +343,9 @@ 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 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.
>  
>  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



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux