Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

checkpatch: describe --min-conf-desc-length

Neither the warning nor the help message gives any hint on the unit for
length: Could be meters, inches, bytes, characters or ... lines.

Extend the output of `--help` to name the unit "lines" and the default:
- --min-conf-desc-length=n set the min description length, if shorter, warn
+ --min-conf-desc-length=n set the minimum description length for config symbols
+ in lines, if shorter, warn (default 4)

Include the minimum number of lines as other error messages already do:
- WARNING: please write a help paragraph that fully describes the config symbol
+ WARNING: please write a help paragraph that fully describes the config symbol with at least 4 lines

Link: https://lkml.kernel.org/r/c71c170c90eba26265951e248adfedd3245fe575.1741605695.git.p.hahn@avm.de
Signed-off-by: Philipp Hahn <p.hahn@avm.de>
Cc: Andy Whitcroft <apw@canonical.com>
Cc: Joe Perches <joe@perches.com>
Cc: Dwaipayan Ray <dwaipayanray1@gmail.com>
Cc: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>

authored by

Philipp Hahn and committed by
Andrew Morton
bc2f19d6 28939c3e

+3 -2
+3 -2
scripts/checkpatch.pl
··· 113 113 --max-line-length=n set the maximum line length, (default $max_line_length) 114 114 if exceeded, warn on patches 115 115 requires --strict for use with --file 116 - --min-conf-desc-length=n set the min description length, if shorter, warn 116 + --min-conf-desc-length=n set the minimum description length for config symbols 117 + in lines, if shorter, warn (default $min_conf_desc_length) 117 118 --tab-size=n set the number of spaces for tab (default $tabsize) 118 119 --root=PATH PATH to the kernel tree root 119 120 --no-summary suppress the per-file summary ··· 3646 3645 $help_length < $min_conf_desc_length) { 3647 3646 my $stat_real = get_stat_real($linenr, $ln - 1); 3648 3647 WARN("CONFIG_DESCRIPTION", 3649 - "please write a help paragraph that fully describes the config symbol\n" . "$here\n$stat_real\n"); 3648 + "please write a help paragraph that fully describes the config symbol with at least $min_conf_desc_length lines\n" . "$here\n$stat_real\n"); 3650 3649 } 3651 3650 } 3652 3651