2020-06-05 03:07:45

by Heinrich Schuchardt

[permalink] [raw]
Subject: [PATCH 1/1] docs: dev-tools: coccinelle: underlines

Underline lengths should match the lengths of headings to avoid build
warnings with Sphinx.

Signed-off-by: Heinrich Schuchardt <[email protected]>
---
Documentation/dev-tools/coccinelle.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/dev-tools/coccinelle.rst b/Documentation/dev-tools/coccinelle.rst
index 00a3409b0c28..70274c3f5f5a 100644
--- a/Documentation/dev-tools/coccinelle.rst
+++ b/Documentation/dev-tools/coccinelle.rst
@@ -14,7 +14,7 @@ many uses in kernel development, including the application of complex,
tree-wide patches and detection of problematic programming patterns.

Getting Coccinelle
--------------------
+------------------

The semantic patches included in the kernel use features and options
which are provided by Coccinelle version 1.0.0-rc11 and above.
@@ -56,7 +56,7 @@ found at:
https://github.com/coccinelle/coccinelle/blob/master/install.txt

Supplemental documentation
----------------------------
+--------------------------

For supplemental documentation refer to the wiki:

@@ -128,7 +128,7 @@ To enable verbose messages set the V= variable, for example::
make coccicheck MODE=report V=1

Coccinelle parallelization
----------------------------
+--------------------------

By default, coccicheck tries to run as parallel as possible. To change
the parallelism, set the J= variable. For example, to run across 4 CPUs::
@@ -333,7 +333,7 @@ as an example if requiring at least Coccinelle >= 1.0.5::
// Requires: 1.0.5

Proposing new semantic patches
--------------------------------
+------------------------------

New semantic patches can be proposed and submitted by kernel
developers. For sake of clarity, they should be organized in the
--
2.26.2


2020-06-05 06:01:49

by Julia Lawall

[permalink] [raw]
Subject: Re: [PATCH 1/1] docs: dev-tools: coccinelle: underlines



On Fri, 5 Jun 2020, Heinrich Schuchardt wrote:

> Underline lengths should match the lengths of headings to avoid build
> warnings with Sphinx.
>
> Signed-off-by: Heinrich Schuchardt <[email protected]>


Acked-by: Julia Lawall <[email protected]>

Thanks for your help.

> ---
> Documentation/dev-tools/coccinelle.rst | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/dev-tools/coccinelle.rst b/Documentation/dev-tools/coccinelle.rst
> index 00a3409b0c28..70274c3f5f5a 100644
> --- a/Documentation/dev-tools/coccinelle.rst
> +++ b/Documentation/dev-tools/coccinelle.rst
> @@ -14,7 +14,7 @@ many uses in kernel development, including the application of complex,
> tree-wide patches and detection of problematic programming patterns.
>
> Getting Coccinelle
> --------------------
> +------------------
>
> The semantic patches included in the kernel use features and options
> which are provided by Coccinelle version 1.0.0-rc11 and above.
> @@ -56,7 +56,7 @@ found at:
> https://github.com/coccinelle/coccinelle/blob/master/install.txt
>
> Supplemental documentation
> ----------------------------
> +--------------------------
>
> For supplemental documentation refer to the wiki:
>
> @@ -128,7 +128,7 @@ To enable verbose messages set the V= variable, for example::
> make coccicheck MODE=report V=1
>
> Coccinelle parallelization
> ----------------------------
> +--------------------------
>
> By default, coccicheck tries to run as parallel as possible. To change
> the parallelism, set the J= variable. For example, to run across 4 CPUs::
> @@ -333,7 +333,7 @@ as an example if requiring at least Coccinelle >= 1.0.5::
> // Requires: 1.0.5
>
> Proposing new semantic patches
> --------------------------------
> +------------------------------
>
> New semantic patches can be proposed and submitted by kernel
> developers. For sake of clarity, they should be organized in the
> --
> 2.26.2
>
>

2020-06-08 15:18:29

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH 1/1] docs: dev-tools: coccinelle: underlines

On Fri, 5 Jun 2020 05:04:05 +0200
Heinrich Schuchardt <[email protected]> wrote:

> Underline lengths should match the lengths of headings to avoid build
> warnings with Sphinx.
>
> Signed-off-by: Heinrich Schuchardt <[email protected]>
> ---
> Documentation/dev-tools/coccinelle.rst | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)

Applied, thanks.

jon