From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1756740Ab1GMBZi (ORCPT ); Tue, 12 Jul 2011 21:25:38 -0400 Received: from mta21.charter.net ([216.33.127.81]:46879 "EHLO mta21.charter.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932291Ab1GMBZg (ORCPT ); Tue, 12 Jul 2011 21:25:36 -0400 X-Authority-Analysis: v=1.1 cv=vT9vkN3vVXssH3Ov7r/wQUs/sfIFjNPEFFf4aeKIi4A= c=1 sm=1 a=NEHXXXmednoA:10 a=lDGNyK2vIvEA:10 a=xzrYXqw+0zwiO4gHSXHcAg==:17 a=l2E7mNOSAAAA:8 a=U7shPPFNyVZDUEyMoy0A:9 a=5w6YsWpAg55wD6sbf38A:7 a=xzrYXqw+0zwiO4gHSXHcAg==:117 From: Greg Dietsche 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 Subject: [PATCH 1/3] coccinelle.txt: add overview section Date: Tue, 12 Jul 2011 20:26:43 -0500 Message-Id: <1310520405-1558-2-git-send-email-Gregory.Dietsche@cuw.edu> X-Mailer: git-send-email 1.7.2.5 In-Reply-To: <1310520405-1558-1-git-send-email-Gregory.Dietsche@cuw.edu> References: <1310520405-1558-1-git-send-email-Gregory.Dietsche@cuw.edu> Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Add an overview section to the Coccinelle documentation. Signed-off-by: Greg Dietsche --- 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