Linux Documentation
 help / color / mirror / Atom feed
From: Sumera Priyadarsini <sylphrenadin@gmail.com>
To: Julia.Lawall@lip6.fr
Cc: gregkh@linuxfoundation.org, Gilles.Muller@lip6.fr,
	nicolas.palix@imag.fr, michal.lkml@markovi.net, corbet@lwn.net,
	cocci@systeme.lip6.fr, linux-doc@vger.kernel.org,
	Sumera Priyadarsini <sylphrenadin@gmail.com>
Subject: [PATCH] documentation: coccinelle: Improve command example
Date: Fri,  7 Aug 2020 16:24:45 +0530	[thread overview]
Message-ID: <20200807105445.16712-1-sylphrenadin@gmail.com> (raw)

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


             reply	other threads:[~2020-08-07 11:03 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-07 10:54 Sumera Priyadarsini [this message]
2020-08-07 11:10 ` [Cocci] [PATCH] documentation: coccinelle: Improve command example Julia Lawall

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200807105445.16712-1-sylphrenadin@gmail.com \
    --to=sylphrenadin@gmail.com \
    --cc=Gilles.Muller@lip6.fr \
    --cc=Julia.Lawall@lip6.fr \
    --cc=cocci@systeme.lip6.fr \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=michal.lkml@markovi.net \
    --cc=nicolas.palix@imag.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox