On Tue, 11 Aug 2020, Sumera Priyadarsini wrote: > Modify coccinelle documentation to further clarify > the usage of the makefile C variable by coccicheck. > > Signed-off-by: Sumera Priyadarsini <sylphrenadin@xxxxxxxxx> Acked-by: Julia Lawall <julia.lawall@xxxxxxxx> Thanks. > > --- > Changes in v4: > - Modify commit message to clarify C is a variable > --- > Documentation/dev-tools/coccinelle.rst | 15 +++++++++++---- > 1 file changed, 11 insertions(+), 4 deletions(-) > > diff --git a/Documentation/dev-tools/coccinelle.rst b/Documentation/dev-tools/coccinelle.rst > index 6c791af1c859..74c5e6aeeff5 100644 > --- a/Documentation/dev-tools/coccinelle.rst > +++ b/Documentation/dev-tools/coccinelle.rst > @@ -175,13 +175,20 @@ For example, to check drivers/net/wireless/ one may write:: > make coccicheck M=drivers/net/wireless/ > > To apply Coccinelle on a file basis, instead of a directory basis, the > -following command may be used:: > +C variable is used by the makefile to select which files to work with. > +This variable can be used to run scripts for the entire kernel, a > +specific directory, or for a single file. > > - make C=1 CHECK="scripts/coccicheck" > +For example, to check drivers/bluetooth/bfusb.c, the value 1 is > +passed to the C variable to check files that make considers > +need to be compiled.:: > > -To check only newly edited code, use the value 2 for the C flag, i.e.:: > + make C=1 CHECK=scripts/coccicheck drivers/bluetooth/bfusb.o > > - make C=2 CHECK="scripts/coccicheck" > +The value 2 is passed to the C variable to check files regardless of > +whether they need to be compiled or not.:: > + > + make C=2 CHECK=scripts/coccicheck drivers/bluetooth/bfusb.o > > In these modes, which work on a file basis, there is no information > about semantic patches displayed, and no commit message proposed. > -- > 2.17.1 > > _______________________________________________ > Cocci mailing list > Cocci@xxxxxxxxxxxxxxx > https://systeme.lip6.fr/mailman/listinfo/cocci >
