diff mbox series

[v4,39/42] doc: Move coccinelle into its own section

Message ID 20210304135118.643277-38-sjg@chromium.org
State Superseded
Delegated to: Tom Rini
Headers show
Series test: Refactor tests to have a single test runner | expand

Commit Message

Simon Glass March 4, 2021, 1:51 p.m. UTC
This tool has nothing to do with testing. Create a new section for
'refactoring' and move it into there. It is likely that other topics may
fall under the same heading, such as using moveconfig and search/replace
tools.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

(no changes since v1)

 doc/develop/index.rst | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

Comments

Heinrich Schuchardt March 4, 2021, 5:23 p.m. UTC | #1
On 04.03.21 14:51, Simon Glass wrote:
> This tool has nothing to do with testing. Create a new section for
> 'refactoring' and move it into there. It is likely that other topics may
> fall under the same heading, such as using moveconfig and search/replace
> tools.

Coccinelle makes static code analysis. This has nothing to do with
refactoring. I saw it as static testing compared to the dynamic testing
done for instance by pytest.

You might put it into one chapter with our continuous integration.

Best regards

Heinrich

>
> Signed-off-by: Simon Glass <sjg@chromium.org>
> ---
>
> (no changes since v1)
>
>  doc/develop/index.rst | 9 ++++++++-
>  1 file changed, 8 insertions(+), 1 deletion(-)
>
> diff --git a/doc/develop/index.rst b/doc/develop/index.rst
> index 50b1de3bdff..9208668a2d4 100644
> --- a/doc/develop/index.rst
> +++ b/doc/develop/index.rst
> @@ -30,7 +30,14 @@ Testing
>  .. toctree::
>     :maxdepth: 1
>
> -   coccinelle
>     testing
>     py_testing
>     tests_sandbox
> +
> +Refactoring
> +-----------
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +   coccinelle
>
Simon Glass March 7, 2021, 10:18 p.m. UTC | #2
Hi Heinrich,

On Thu, 4 Mar 2021 at 12:23, Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
>
> On 04.03.21 14:51, Simon Glass wrote:
> > This tool has nothing to do with testing. Create a new section for
> > 'refactoring' and move it into there. It is likely that other topics may
> > fall under the same heading, such as using moveconfig and search/replace
> > tools.
>
> Coccinelle makes static code analysis. This has nothing to do with
> refactoring. I saw it as static testing compared to the dynamic testing
> done for instance by pytest.
>
> You might put it into one chapter with our continuous integration.

I don't know where that is, so I'll drop this patch.

I have only every used spatch, and that only for refactoring.

Regards,
Simon
diff mbox series

Patch

diff --git a/doc/develop/index.rst b/doc/develop/index.rst
index 50b1de3bdff..9208668a2d4 100644
--- a/doc/develop/index.rst
+++ b/doc/develop/index.rst
@@ -30,7 +30,14 @@  Testing
 .. toctree::
    :maxdepth: 1
 
-   coccinelle
    testing
    py_testing
    tests_sandbox
+
+Refactoring
+-----------
+
+.. toctree::
+   :maxdepth: 1
+
+   coccinelle