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

[Nicolas Palix]

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

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

> ---
> Â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@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/