[PATCH] documentation: coccinelle: Improve command example

[PATCH] documentation: coccinelle: Improve command example

[Sumera Priyadarsini]

This patch modifies the coccinelle documentation to add further
description for the usage of the C variable flags by coccicheck.

Signed-off-by: Sumera Priyadarsini <sylphrenadin@gmail.com>
---
 Documentation/dev-tools/coccinelle.rst | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/Documentation/dev-tools/coccinelle.rst b/Documentation/dev-tools/coccinelle.rst
index 6c791af1c859..dfc5d390307b 100644
--- a/Documentation/dev-tools/coccinelle.rst
+++ b/Documentation/dev-tools/coccinelle.rst
@@ -177,9 +177,12 @@ For example, to check drivers/net/wireless/ one may write::
 To apply Coccinelle on a file basis, instead of a directory basis, the
 following command may be used::
 
+To check only recompiled files, use the value 1 for the C flag, i.e.::
+
     make C=1 CHECK="scripts/coccicheck"
 
-To check only newly edited code, use the value 2 for the C flag, i.e.::
+To check sourcefiles regardless of whether they are recompiled or not, 
+use the value 2 for the C flag, i.e.::
 
     make C=2 CHECK="scripts/coccicheck"
 
-- 
2.17.1

Re: [Cocci] [PATCH] documentation: coccinelle: Improve command example

[Julia Lawall]

On Fri, 7 Aug 2020, Sumera Priyadarsini wrote:

> This patch modifies the coccinelle documentation to add further
> description for the usage of the C variable flags by coccicheck.
>
> Signed-off-by: Sumera Priyadarsini <sylphrenadin@gmail.com>
> ---
>  Documentation/dev-tools/coccinelle.rst | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/dev-tools/coccinelle.rst b/Documentation/dev-tools/coccinelle.rst
> index 6c791af1c859..dfc5d390307b 100644
> --- a/Documentation/dev-tools/coccinelle.rst
> +++ b/Documentation/dev-tools/coccinelle.rst
> @@ -177,9 +177,12 @@ For example, to check drivers/net/wireless/ one may write::
>  To apply Coccinelle on a file basis, instead of a directory basis, the
>  following command may be used::
>
> +To check only recompiled files, use the value 1 for the C flag, i.e.::
> +
>      make C=1 CHECK="scripts/coccicheck"
>
> -To check only newly edited code, use the value 2 for the C flag, i.e.::
> +To check sourcefiles regardless of whether they are recompiled or not,
> +use the value 2 for the C flag, i.e.::
>
>      make C=2 CHECK="scripts/coccicheck"

I'm not sure that this is clear enough.  Should you give an example with a
specific file?  The command as presented seems to work on all files having
the given property.

I'm also not sure to understand the work "recompiled".  It's in the past
tense, so it seems like it is talking about files that have already been
compiled more than once (ie, compiled the first time and then recompiled
the second time).  Maybe it would be clearer to say "files that make
considers need to be recompiled".

julia