linux-kernel - Re: [PATCH 1/3] coccinelle.txt: add overview section

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <CAAxaTiNvF1GO2rMSHwRnn4SrDpRNm54y0ma6qyPoJwKGMyEAXQ@mail.gmail.com>
Date:	Tue, 26 Jul 2011 16:46:26 +0200
From:	Nicolas Palix <Nicolas.Palix@...ia.fr>
To:	Greg Dietsche <Gregory.Dietsche@....edu>
Cc:	julia@...u.dk, Gilles.Muller@...6.fr, rdunlap@...otime.net,
	linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
	cocci@...u.dk
Subject: Re: [PATCH 1/3] coccinelle.txt: add overview section

On Wed, Jul 13, 2011 at 3:26 AM, Greg Dietsche <Gregory.Dietsche@....edu> wrote:
> Add an overview section to the Coccinelle documentation.
>
> Signed-off-by: Greg Dietsche <Gregory.Dietsche@....edu>

Signed-off-by: Nicolas Palix <npalix.work@...il.com>

> ---
>  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
>
>



-- 
Nicolas Palix
http://sardes.inrialpes.fr/~npalix/
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/