mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Greg Dietsche <Gregory.Dietsche@cuw.edu>
To: julia@diku.dk, Gilles.Muller@lip6.fr, npalix.work@gmail.com
Cc: rdunlap@xenotime.net, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, cocci@diku.dk,
	Greg Dietsche <Gregory.Dietsche@cuw.edu>
Subject: [PATCH 1/3] coccinelle.txt: add overview section
Date: Tue, 12 Jul 2011 20:26:43 -0500	[thread overview]
Message-ID: <1310520405-1558-2-git-send-email-Gregory.Dietsche@cuw.edu> (raw)
In-Reply-To: <1310520405-1558-1-git-send-email-Gregory.Dietsche@cuw.edu>

Add an overview section to the Coccinelle documentation.

Signed-off-by: Greg Dietsche <Gregory.Dietsche@cuw.edu>
---
 Documentation/coccinelle.txt |   31 +++++++++++++++++++++++++++++++
 1 files changed, 31 insertions(+), 0 deletions(-)

diff --git a/Documentation/coccinelle.txt b/Documentation/coccinelle.txt
index 96b6903..9495a4b 100644
--- a/Documentation/coccinelle.txt
+++ b/Documentation/coccinelle.txt
@@ -41,6 +41,37 @@ The semantic patches in the kernel will work best with Coccinelle version
 semantic patch code, but any results that are obtained should still be
 correct.
 
+
+ Overview / Quick Start
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+There are two ways to use Coccinelle with the Linux kernel.
+
+1) Coccinelle can be used like sparse (see Documentation/sparse.txt):
+	make C=1 CHECK="scripts/coccicheck"
+	make C=2 CHECK="scripts/coccicheck"
+
+2) Coccinelle can be used via a build target in the kernel's Makefile:
+	make coccicheck
+
+There are a number of optional parameters that can be used with the build target.
+
+	make coccicheck MODE={patch,report,context,org} COCCI=? M=?
+
+MODE:
+	Determines what mode cocci operates in. If no mode is specified
+	then cocci will default to 'chain' mode which will run for each
+	available mode (patch, report, context, org).
+
+COCCI:
+	Process a specific .cocci SmPL script. If this is not set then
+	process all scripts under scripts/coccinelle/
+
+M:
+	Limit cocci to a subset of directories. This is very similar to the
+	way the build system works when building modules.
+
+
  Using Coccinelle on the Linux kernel
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- 
1.7.2.5


  reply	other threads:[~2011-07-13  1:25 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-07-13  1:26 [PATCH 0/3] coccinelle: add parallel execution Greg Dietsche
2011-07-13  1:26 ` Greg Dietsche [this message]
2011-07-26 14:46   ` [PATCH 1/3] coccinelle.txt: add overview section Nicolas Palix
2011-07-13  1:26 ` [PATCH 2/3] coccinelle.txt: add documentation of PARALLEL= flag Greg Dietsche
2011-07-27  6:19   ` Nicolas Palix
2011-07-13  1:26 ` [PATCH 3/3] coccicheck: add parallel execution Greg Dietsche
2011-07-13  2:42   ` Joe Perches
2011-07-14  2:14     ` Greg Dietsche
2011-07-26 13:33       ` Nicolas Palix
2011-07-26 13:53         ` Michal Marek
2011-07-26 22:46           ` Greg Dietsche
2011-07-26 22:36         ` [PATCH v2] " Greg Dietsche
2011-07-27  6:18           ` Nicolas Palix
2011-07-14  9:37 ` [PATCH 0/3] coccinelle: " Ian Campbell

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=1310520405-1558-2-git-send-email-Gregory.Dietsche@cuw.edu \
    --to=gregory.dietsche@cuw.edu \
    --cc=Gilles.Muller@lip6.fr \
    --cc=cocci@diku.dk \
    --cc=julia@diku.dk \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=npalix.work@gmail.com \
    --cc=rdunlap@xenotime.net \
    /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

all inboxes | Powered by JetHome®