scripts/checkpatch.pl was written originally for the Linux kernel, and
its code reflects the kernel's coding style. In particular, it has
checks for unneeded braces around single-statement if/else/for/while
conditions. In Zephyr however, braces are always required, and so the
checks needed modifying to verify the opposite condition.
In order to enable the now-compatible checks, we also remove the
--ignore BRACES statement in .checkpatch.conf.
Limitations: the current code works well if there are not conditional
statements (e.g. #if, #ifdef or #endif) next to the if/else/for/while
conditions. This is rarely the case, but triggers with the Bluetooth
controller in code like this:
```
#if defined(CONFIG_BT_PERIPHERAL)
if (!lll->is_hdcd)
#endif /* CONFIG_BT_PERIPHERAL */
{
```
```
} else
#endif /* CONFIG_BT_CTLR_PRIVACY */
{
```
```
#if defined(CONFIG_BT_CTLR_DF_ADV_CTE_TX)
if (lll->cte_started) {
radio_switch_complete(phy_s, 0, phy_s, 0);
} else
#endif /* CONFIG_BT_CTLR_DF_ADV_CTE_TX */
{
```
```
#ifdef DUAL_BANK
while ((FLASH_STM32_REGS(dev)->SR1 & FLASH_SR_QW) ||
(FLASH_STM32_REGS(dev)->SR2 & FLASH_SR_QW))
#else
while (FLASH_STM32_REGS(dev)->SR1 & FLASH_SR_QW)
#endif
{
```
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
checkpatch isn't smart enough to detect a function / variable has
been declared e.g. with K_SEM_DEFINE and will incorrectly flag
such cases.
Signed-off-by: Lauren Murphy <lauren.murphy@intel.com>
Warning IS_ENABLED_CONFIG allows checkpatch.pl to generate a warning
when IS_ENABLED macro is used with an argument which is not a CONFIG_
symbol.
This is abusive as the macro definition implicitly mentions it could
be used with other symbols ("It is often used with a @p CONFIG_FOO").
In Zephyr, IS_ENABLED macro is also used with for instance DT macros,
which generates github CI failures, which then require waiver from
maintainers.
Make things more simple by just removing this warning.
Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
Remove Linux specific warning which has been causing confusion and
incorrect usage of return codes just to comply with checkpatch.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Ignore yet another macro rule. We have many multistatement macros
in-tree which do not use do { ... } while().
Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
We are heavy users of macros and those rules keep coming up as false
positives that need to be overriden, so lets ignore them.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This has never been enforced and we have our own DT related checks.
Removing for now as it seems to be Linux specific.
- UNDOCUMENTED_DT_STRING
- DT_SPLIT_BINDING_PATCH
- DT_SCHEMA_BINDING_PATCH
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Change max line length to 100, this is to follow Linux and to allow for
more readable code. Most warning we get now from checkpatch are because
of this limit which has prevented us from enforcing warning.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Zephyr doesn't use the __section macro, so stop warnings like this
from producing a compliance rejection.
WARNING:PREFER_SECTION: __section(.device_) is preferred over
__attribute__((section(".device_")))
#702: FILE: include/device.h:743:
__attribute__((__section__(".device_" #level STRINGIFY(prio))))
Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
A new check in Linux checks for repeated words, which spews false
positives from text like:
* @param param the parameter
* @param device device instance
Signed-off-by: Peter A. Bigot <pab@pabigot.com>
When checkpatch was updated, this behavour seems to have changed.
This change re-adds the check for C99 comments to prevent them.
Signed-off-by: Christian Taedcke <christian.taedcke@lemonbeat.com>
Now that we are standardizing C99 integer types we can revert the commit
that warned about C99 type usage.
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
Zephyr has not committed to complying with the upstream requirement
that the SPDX declaration be on the first line of a file, so disable
the warning.
Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
Suppress mailback conf to allow to use the -g parameter.
With the -g option it is possible to check coding style for multi
commits in the git tree without extracting them.
For instance the './scripts/checkpatch.pl --strict --git HEAD-4' command
checks the last 4 patches of the current branch.
Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@st.com>
checkpatch expects typedefs to be suffixed with _t and has different
rules when typedefs are being used as arguments of a function. This
seems to be a known issue and defining typedefs in a file resolves this
issue.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Only in rare cases should we allow C99 types, so lets warn about it to
catch issues.
Change-Id: I2bacdd4ba98f88482e0b7acc0567ff1139e749bf
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
Old uIP based legacy IP stack is no longer there so it can
be removed from checkpatch conf file.
Change-Id: I2a17391f9cc8c0f8f8b81d520be1db8e2e8608f7
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
Ignore for now and until we make this feature of checkpatch work with
zephyr in a more optimal way.
Change-Id: I9d08980994416a291f3143e3a22f8a2036ff2f8a
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Useless message at least for now that basically ends up
in every single gerrit change.
Change-Id: I56cea2b1b4e60d696c0ff9496d4464afca8c43ca
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Kernel makes use of __DATE__ and __TIME__ to get its build time.
Change-Id: I34b07a413cd79b2e9c34a2eae5803b9bb837e4ee
Signed-off-by: Benjamin Walsh <benjamin.walsh@windriver.com>
Added rule to ignore net/ip/contiki content in the checkpatch style.
Change-Id: I06d8575d2a00d0032099c8a6d804fef3aaad8381
Signed-off-by: Javier B Perez <javier.b.perez.hernandez@intel.com>
Enable warning about updating the MAINTAINERS file when new
files are being added.
Change-Id: I3b13ca25cd01e3254fd4b9e169546a395ebfcacd
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
File and directories under ext/ are not original to Zephyr and have
different coding style.
Change-Id: Ie09eb324c35eb6e7be2cc3bcbc6ce6676376e346
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Added default value for min-conf-desc-length = 1 for kconfig help.
Jira: ZEP-303
Change-Id: Ieab66a5cb76e2ab8dea4e80b056600173c333c01
Signed-off-by: Javier B Perez <javier.b.perez.hernandez@intel.com>
All patches should have Signed-off-by line in commit message as
described in doc/collaboration/code/changes.rst.
Change-Id: Iba6bad47115fd5323a096fa58c2d0d8c5ec9db75
Signed-off-by: Szymon Janc <ext.szymon.janc@tieto.com>
Added flag to ignore NETWORKING_BLOCK_COMMENT_STYLE warnings
Change-Id: I022319366a9d956159d05bd5875215594a6f1aa6
Signed-off-by: Javier B Perez Hernandez <javier.b.perez.hernandez@linux.intel.com>
Created config file for checkpatch ".checkpatch.conf"
Change-Id: Ic2d72eed38b333d4b05d2d0c8953cbe2795d2429
Signed-off-by: Javier B Perez Hernandez <javier.b.perez.hernandez@linux.intel.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Carles Cufi
Lauren Murphy
Erwan Gouriou
Anas Nashif
Henrik Brix Andersen
Peter Bigot
Peter A. Bigot
Christian Taedcke
Kumar Gala
Arnaud Pouliquen
Antony Pavlov
Jukka Rissanen
Benjamin Walsh
Javier B Perez
Szymon Janc
Javier B Perez Hernandez