mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Nicolas Palix <npalix.work@gmail.com>
To: Randy Dunlap <rdunlap@xenotime.net>,
	Nicolas Palix <npalix.work@gmail.com>,
	Julia Lawall <julia@diku.dk>, Michal Marek <mmarek@suse.cz>,
	Kulikov Vasiliy <segooon@gmail.com>,
	Gilles Muller <Gilles.Muller@lip6.fr>,
	Sam Ravnborg <sam@ravnborg.org>,
	Joerg Roedel <joerg.roedel@amd.com>,
	linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
	cocci@diku.dk
Subject: [PATCH 2/6] Coccinelle: Update documentation
Date: Fri,  8 Oct 2010 21:27:37 +0200	[thread overview]
Message-ID: <1286566061-17122-3-git-send-email-npalix.work@gmail.com> (raw)
In-Reply-To: <1286566061-17122-1-git-send-email-npalix.work@gmail.com>

 - Add information about use of the C={1,2} make flag
 - Add a description of the new chain mode mechanism
 - Add a link to the wiki

Signed-off-by: Nicolas Palix <npalix.work@gmail.com>
Signed-off-by: Julia Lawall <julia@diku.dk>
---
 Documentation/coccinelle.txt |   42 +++++++++++++++++++++++++++++++++++-------
 1 files changed, 35 insertions(+), 7 deletions(-)

diff --git a/Documentation/coccinelle.txt b/Documentation/coccinelle.txt
index cd2b028..a43eaeb 100644
--- a/Documentation/coccinelle.txt
+++ b/Documentation/coccinelle.txt
@@ -24,6 +24,9 @@ of many distributions, e.g. :
 You can get the latest version released from the Coccinelle homepage at
 http://coccinelle.lip6.fr/
 
+Information and tips about Coccinelle are also provided on the wiki
+pages at http://cocci.ekstranet.diku.dk/wiki/doku.php
+
 Once you have it, run the following command:
 
      	./configure
@@ -41,20 +44,22 @@ A Coccinelle-specific target is defined in the top level
 Makefile. This target is named 'coccicheck' and calls the 'coccicheck'
 front-end in the 'scripts' directory.
 
-Four modes are defined: report, patch, context, and org. The mode to
+Four modes are defined: patch, report, context, and org. The mode to
 use is specified by setting the MODE variable with 'MODE=<mode>'.
 
+'patch' proposes a fix, when possible.
+
 'report' generates a list in the following format:
   file:line:column-column: message
 
-'patch' proposes a fix, when possible.
-
 'context' highlights lines of interest and their context in a
 diff-like style.Lines of interest are indicated with '-'.
 
 'org' generates a report in the Org mode format of Emacs.
 
-Note that not all semantic patches implement all modes.
+Note that not all semantic patches implement all modes. To easy use
+of Coccinelle, the default mode is "chain" which tries the previous
+modes in the order above until one successes. 
 
 To make a report for every semantic patch, run the following command:
 
@@ -68,9 +73,9 @@ To produce patches, run:
 
 
 The coccicheck target applies every semantic patch available in the
-subdirectories of 'scripts/coccinelle' to the entire Linux kernel.
+sub-directories of 'scripts/coccinelle' to the entire Linux kernel.
 
-For each semantic patch, a changelog message is proposed.  It gives a
+For each semantic patch, a commit message is proposed.  It gives a
 description of the problem being checked by the semantic patch, and
 includes a reference to Coccinelle.
 
@@ -93,12 +98,35 @@ or
 	make coccicheck COCCI=<my_SP.cocci> MODE=report
 
 
+ Using Coccinelle on (modified) files
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To apply Coccinelle on a file basis, instead of a directory basis, the
+following command may be used:
+    
+    make C=1 CHECK="scripts/coccicheck"
+    
+To check only newly edited code, use the value 2 for the C flag, i.e.
+    
+    make C=2 CHECK="scripts/coccicheck"
+    
+This runs every semantic patch in scripts/coccinelle by default. The
+COCCI variable may additionally be used to only apply a single
+semantic patch as shown in the previous section.
+
+The "chain" mode is the default. You can select another one with the
+MODE variable explained above.
+
+In this mode, there is no information about semantic patches
+displayed, and no commit message proposed.
+
+
  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
-subdirectories of 'scripts/coccinelle/'.
+sub-directories of 'scripts/coccinelle/'.
 
 
  Detailed description of the 'report' mode
-- 
1.7.0.4


  parent reply	other threads:[~2010-10-08 19:28 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-10-08 19:27 [PATCH 0/6] Update coccinelle related files/information Nicolas Palix
2010-10-08 19:27 ` [PATCH 1/6] MAINTAINERS: Coccinelle: Update email address Nicolas Palix
2010-10-08 19:27 ` Nicolas Palix [this message]
2010-10-11 19:49   ` [PATCH 2/6] Coccinelle: Update documentation Randy Dunlap
2010-10-12 22:49     ` Nicolas Palix
2010-10-13 12:29       ` Michal Marek
2010-10-08 19:27 ` [PATCH 3/6] Coccinelle: Improve user information with a new kind of comment Nicolas Palix
2010-10-08 19:27 ` [PATCH 4/6] Coccinelle: Use new comment format to explain kfree.cocci Nicolas Palix
2010-10-08 19:27 ` [PATCH 5/6] Coccinelle: Add a new mode named 'chain' Nicolas Palix
2010-10-08 19:27 ` [PATCH 6/6] Coccinelle: Use the -no_show_diff option for org and report mode Nicolas Palix

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=1286566061-17122-3-git-send-email-npalix.work@gmail.com \
    --to=npalix.work@gmail.com \
    --cc=Gilles.Muller@lip6.fr \
    --cc=cocci@diku.dk \
    --cc=joerg.roedel@amd.com \
    --cc=julia@diku.dk \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mmarek@suse.cz \
    --cc=rdunlap@xenotime.net \
    --cc=sam@ravnborg.org \
    --cc=segooon@gmail.com \
    /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

Powered by JetHome