checkpatch: support more uppercase $logFunctions
PATCH 1/1 checkpatch: support more uppercase $logFunctions
Add support for uppercase logging function names (so that they may exceed 80 cols) and regroup the matched expressions more logically.
Previously, WARN, WARN_RATELIMIT, WARN_ONCE were already supported but many other uppercase logging functions were not and this caused unfixable checkpatch warnings (an example: drivers/bluetooth/btusb.c)
Care was taken to avoid being overly broad by adding uppercase logging functions that do not exist (such as VDBG) or by making everything case insensitive.
Care was also taken to make sure that previously supported expressions are still matched (such as WARN*) unless they do not exist anywhere in the codebase (such as WARN_once or WARN_ratelimited).
--- scripts/checkpatch.pl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
scripts/checkpatch.pl +2 -2
@@ -351,8 +351,8 @@ our $typeTypedefs = qr{(?x: our $logFunctions = qr{(?x: printk(?:_ratelimited|_once|)| - (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| - WARN(?:_RATELIMIT|_ONCE|)| + (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont)(?:_ratelimited|_once|)| + (?:[A-Z0-9]+_){1,2}(?:EMERG|ALERT|CRIT|ERR|WARNING|WARN|NOTICE|INFO|DEBUG|DBG|DEVEL)(?:_RATELIMIT|_ONCE|)| panic| MODULE_[A-Z_]+| seq_vprintf|seq_printf|seq_puts
Signature · 1 line
2.1.0
PATCH v2 1/1 checkpatch: support more uppercase $logFunctions
Add support for uppercase logging function names (so that they may exceed 80 cols) and regroup the matched expressions more logically.
Previously, WARN, WARN_RATELIMIT, WARN_ONCE were already supported but many other uppercase logging functions were not and this caused unfixable checkpatch warnings (an example: drivers/bluetooth/btusb.c)
Care was taken to avoid being overly broad by adding uppercase logging functions that do not exist (such as VDBG) or by making everything case insensitive.
Care was also taken to make sure that previously supported expressions are still matched (such as WARN_RATELIMIT and WARN_ONCE).
--- scripts/checkpatch.pl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
scripts/checkpatch.pl +1 -1
@@ -352,7 +352,7 @@ our $typeTypedefs = qr{(?x: our $logFunctions = qr{(?x: printk(?:_ratelimited|_once|)| (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| - WARN(?:_RATELIMIT|_ONCE|)| + (?:[A-Z0-9]+_){1,2}(?:EMERG|ALERT|CRIT|ERR|WARNING|WARN|NOTICE|INFO|DEBUG|DBG|DEVEL)(?:_RATELIMIT|_ONCE|)| panic| MODULE_[A-Z_]+| seq_vprintf|seq_printf|seq_puts
Signature · 1 line
2.1.0
Joe Perches
maintainerQuoted 6 lines · Tom Van Braeckel
Add support for uppercase logging function names (so that they may exceed 80 cols) and regroup the matched expressions more logically.
Previously, WARN,
WARN_RATELIMIT,WARN_ONCEwere already supported but many other uppercase logging functions were not and this caused unfixable checkpatch warnings (an example:drivers/bluetooth/btusb.c)
I think BT_DBG is a poor macro as it's just
#define BT_DBG(fmt, ...) pr_debug(fmt "\n", ##__VA_ARGS__)
and I'd rather see a treewide sed for that to pr_debug
Quoted 7 lines
Quoted 1 line
unfixable checkpatch warnings (an example:
drivers/bluetooth/btusb.c)I think
BT_DBGis a poor macro as it's just#define
BT_DBG(fmt, ...)pr_debug(fmt "\n", ##__VA_ARGS__)and I'd rather see a treewide sed for that to
pr_debug
Indeed, I also think that BT_DBG() is a poor macro and that it should be fixed tree-wide. I might even do it myself, in a separate patch.
The reason for DBG being in the current patch is to match other *_DBG() log functions that make more sense, such as NS_DBG().
As for the btusb.c example case, this patch allows us to fix the "quoted string split across lines" warning caused by the BT_INFO() macro. The fix will be to not to split the quoted string, which will be allowed when BT_INFO() is recognized as a log function.
Joe Perches
maintainerQuoted 11 lines · Tom Van Braeckel
Quoted 7 lines
Quoted 1 line
unfixable checkpatch warnings (an example:
drivers/bluetooth/btusb.c)I think
BT_DBGis a poor macro as it's just#define
BT_DBG(fmt, ...)pr_debug(fmt "\n", ##__VA_ARGS__)and I'd rather see a treewide sed for that to
pr_debugIndeed, I also think that
BT_DBG()is a poor macro and that it should be fixed tree-wide. I might even do it myself, in a separate patch.
Quoted 7 lines
The reason for DBG being in the current patch is to match other
*_DBG()log functions that make more sense, such asNS_DBG().As for the
btusb.cexample case, this patch allows us to fix the "quoted string split across lines" warning caused by theBT_INFO()macro. The fix will be to not to split the quoted string, which will be allowed whenBT_INFO()is recognized as a log function.
The list of in-tree things this matches is long
and far too many are not logging functions
ABIT_UGURU_DEBUGACPI_BIOS_WARNINGACPI_INFOACPI_WARNINGADMA_LL_DBGAFUD_READ_INFOALLOW_DEBUGALX_ISR_ALERTAML_UART_ERRAPPTAG_ERRASC_DBGATA_ERRAT_DMA_ERRATH_DBG_WARNAUX_DBGAUX_ERRAX_SPR_ERRBLOCK_PRTY_INFOBMAC_HOST_INFOBOND_AD_INFOBOND_ALB_INFOBT_DBGBT_ERRBT_INFOCACHE_OP_ERRCANINTF_ERRCAUSE_DEBUGCH_ALERTCH_DBGCH_ERRCHNL_STS_ERRCH_WARNCISR_PAR_ERRCL_LOCK_DEBUGCLOCK_INFOCL_PAGE_DEBUGCMD_ERRCOH_DBGCPIA_MODULE_DEBUGCPSW_DEBUGCSW_PARITY_ERRCTCM_PR_DEBUGDAT_ERRDAVINCI_EMAC_DEBUGDBG_EMERGDBG_ERRDEBUG_ERRDEF_INT_ERRDEV_DBGDEV_ERRD_INFODMM_PATSTATUS_ERRDRM_DEBUGDRM_INFODRM_INFO_ONCEDRVSTAT_INFODRVSTAT_RX_INFODRVSTAT_TX_INFOECC_LAST_ERREISA_DBGEMAC_DBGEPB_TRANS_ERREZUSB_IS_INFOFC_DISC_DBGFC_EXCH_DBGFC_FCP_DBGFC_LIBFC_DBGFC_LPORT_DBGFCOE_DBGFCOE_NETDEV_DBGFC_RPORT_DBGFC_SCSI_DBGFENCE_WARNFLD_FRM_ERRFNIC_FCS_DBGFNIC_ISR_DBGFNIC_MAIN_DBGFNIC_SCSI_DBGGBE_STATSA_INFOGBE_STATSB_INFOGBE_STATSC_INFOGBE_STATSD_INFOGET_BT_INFOGET_RXD_ERRGUARD_ERRHERMES_EV_INFOHERMES_OFFSET_ERRHERMES_RXSTAT_ERRHF_EXT_ERRHOST_DEBUGHPEE_SLOT_INFOHS_COMP_ERRICSPI_FRM_ERRIEEE_DEBUG_INFOIESPI_FRM_ERRIF_ERRIF_QUERY_INFOIL_DBGIL_DL_INFOIL_ERRIL_INFOIL_WARNINTEL_INFOIPW_DEBUGIPW_DEBUG_INFOIPW_DEBUG_WARNINGIPW_DL_INFOIPW_DL_WARNINGIPW_LL_DEBUGIPW_WARNINGIRQ_ERRIRQ_MST_ERRIS_ERRIS_OPERATIONAL_ERRISPCCDC_HORZ_INFOISPPRV_HORZ_INFOISPPRV_VERT_INFOISR_INIT_ERRIVTV_ALSA_DEBUGIVTV_ALSA_ERRIVTV_ALSA_INFOIVTV_ALSA_WARNIVTV_DBGFLG_INFOIVTV_DBGFLG_WARNIVTV_DEBUGIVTV_DEBUG_INFOIVTV_DEBUG_WARNIVTV_ERRIVTVFB_DBGFLG_INFOIVTVFB_DBGFLG_WARNIVTVFB_DEBUGIVTVFB_DEBUG_INFOIVTVFB_DEBUG_WARNIVTVFB_ERRIVTVFB_INFOIVTVFB_WARNIVTV_INFOIVTV_WARNIWL_CRITIWL_DEBUGIWL_DEBUG_INFOIWL_ERRIWL_INFOIWL_WARNK_DEBUGLCDISR_UDR_ERRLCD_SLV_DBGLCONSOLE_EMERGLCONSOLE_INFOLCONSOLE_WARNLDLM_DEBUGLDLM_WARNLIBFCOE_DBGLIBFCOE_FIP_DBGLIBFCOE_SYSFS_DBGLIBFCOE_TRANSPORT_DBGLIBIPW_DEBUGLIBIPW_DEBUG_INFOLIBIPW_DL_INFOLIBIPW_WARNINGLU_OBJECT_DEBUGMAKE_BUDGET_INFOMAL_DBGMEDIA_INFOMG_DBGMODE_DEBUGMODULE_INFOMST_STATUS_ERRMTS_DEBUGMTS_WARNINGNAND_ECC_INFONETCP_DEBUGNS_DBGNS_ERRNS_INFONS_WARNNV_DEBUGNV_INFONV_WARNOCSPI_FRM_ERROD_INFOOESPI_FRM_ERROLYMPUS_MXL_INFOOSC_IO_DEBUGOSDBLK_DEBUGOSD_DEBUGOSD_ERROSD_INFOPACKAGE_INFOPHY_ERRPIN_INFOPRINT_DEBUGPROBE_DEBUGPROTOCOL_ERRPTR_ERRPWC_DEBUGPWC_INFOPWC_WARNINGQELM_NP_ERRQXL_DEBUGQXL_INFOQXL_INFO_ONCERBRQ_CRC_ERRRBRQ_HBUF_ERRRBRQ_LEN_ERRREFTAG_ERRREG_DBGREG_RXPKTBUF_DBGREG_TXPKTBUF_DBGRES_ERRRGMII_DBGRIA_DEBUGRTL_DEBUGRTLLIB_DEBUGRTLLIB_DEBUG_INFORTLLIB_DL_ERRRTLLIB_DL_INFORTLLIB_WARNINGRXBD_ERRRX_DESC_INFORXFSHR_ERRRX_PKT_ERRRXS_ERRRX_STATUS_ERRSITD_STS_ERRSLAVE_AD_INFOSLAVE_TLB_INFOSLINK_ERRSMC_DEBUGSMSC_WARNSN_PCIDEV_INFOSORT_CRITSPDIF_ERRSPI_ERRSR_CRITSR_TX_ERRSSIF_DEFAULT_DEBUGSTK_INFOSTK_WARNINGSTS_ERRSYS_CFGSTAT_ERRTCAM_ERRTDMC_INTR_DBGTHERMAL_ALERTTLAN_DBGTTM_DEBUGTXC_DEBUGTX_CS_DBGTX_DESC_INFOTX_INFOTX_STA_ERRUDC_DEBUGUDC_ISO_ERRULPI_INFOULTRASTOR_DEBUGURB_DBGURXD_ERRUSB_DEVICE_INFOUSB_INTERFACE_INFOUSB_STS_ERRUS_DEBUGUVC_STREAM_ERRUW_ERRV_CQ_ERRVELOCITY_DBGVMON_OV_WARNINGVMON_UV_WARNINGVREG_INFOV_UNMAPPED_ERRWUSBINTR_HOST_ERRWUSBSTS_HOST_ERRXENBUS_EXIST_ERRXE_PARITY_ERRXMAC_HOST_INFOZAURUS_PXA_INFOZAURUS_STRONGARM_INFOZMII_DBG