Re: [Cocci] [PATCH v2] documentation: coccinelle: Improve command example for make C={1, 2}

From: Markus Elfring <Markus.Elfring@web.de>
To: Sumera Priyadarsini <sylphrenadin@gmail.com>,
	Coccinelle <cocci@systeme.lip6.fr>,
	linux-doc@vger.kernel.org
Cc: Michal Marek <michal.lkml@markovi.net>,
	Gilles Muller <Gilles.Muller@lip6.fr>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Jonathan Corbet <corbet@lwn.net>,
	kernel-janitors@vger.kernel.org, linux-kernel@vger.kernel.org,
	Matthew Wilcox <willy@infradead.org>,
	Julia Lawall <Julia.Lawall@lip6.fr>,
	Randy Dunlap <rdunlap@infradead.org>,
	Nicolas Palix <nicolas.palix@imag.fr>,
	Sam Ravnborg <sam@ravnborg.org>,
	Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
Subject: Re: [Cocci] [PATCH v2] documentation: coccinelle: Improve command example for make C={1, 2}
Date: Mon, 10 Aug 2020 09:30:18 +0200	[thread overview]
Message-ID: <ffe8c50d-0bb5-9477-a20c-96aa7bb45067@web.de> (raw)

> Modify coccinelle documentation to further clarify
> the usage of the makefile C variable flag by coccicheck.

How do you think about a wording variant like the following
for the change description?

   Clarify the usage of the make variable “C” for coccicheck.

> +C flag is used. The C flag is a variable used by the makefile

Can such a wording approach trigger understanding difficulties?

> +                                    This flag can be used to
> +run scripts for …

I find this description improvable.

> +The value 1 is passed to the C flag to check for files that make considers
> +need to be recompiled.::

Would you like to distinguish consequences between “compilation” and “recompilation”?

The mentioned parameter is assigned to the macro “KBUILD_CHECKSRC”.
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Makefile?id=fc80c51fd4b23ec007e88d4c688f2cac1b8648e7#n198

The macro “KBUILD_CHECKSRC” is eventually checked for the setting of a few additional macros.
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/scripts/Makefile.build?id=fc80c51fd4b23ec007e88d4c688f2cac1b8648e7#n97

Would you like to determine where these macros are actually applied?

Do you find the commit 0c33f125732d0d33392ba6774d85469d565d3496 ("kbuild:
run the checker after the compiler") from 2020-07-07 interesting for
the discussed documentation adjustment?
https://lore.kernel.org/patchwork/patch/1260832/
https://lore.kernel.org/lkml/20200622154512.82758-1-luc.vanoostenryck@gmail.com/

> +    make C=1 CHECK="scripts/coccicheck" "drivers/bluetooth/bfusb.o"

* Can double quotes be omitted here?

* How do you think about to enclose any data by apostrophes?

Regards,
Markus
_______________________________________________
Cocci mailing list
Cocci@systeme.lip6.fr
https://systeme.lip6.fr/mailman/listinfo/cocci