Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1384218 > unrolled thread

[PATCH 3/3] checkpatch: relax Kconfig help text line number threshold

Back to article view | Back to linux.kernel

This discussion starts older than the indexed window; earlier articles aren't shown. The article labeled Started by below is the oldest one visible, not the original post.

Contents

  [PATCH 3/3] checkpatch: relax Kconfig help text line number threshold Yingjoe Chen <yingjoe.chen@mediatek.com> - 2016-04-21 15:30 +0200
    Re: [PATCH 3/3] checkpatch: relax Kconfig help text line number  threshold Joe Perches <joe@perches.com> - 2016-04-21 19:10 +0200
      Re: [PATCH 3/3] checkpatch: relax Kconfig help text line number  threshold Andi Kleen <ak@linux.intel.com> - 2016-04-21 19:40 +0200
        Re: [PATCH 3/3] checkpatch: relax Kconfig help text line number  threshold Yingjoe Chen <yingjoe.chen@mediatek.com> - 2016-04-22 15:30 +0200

#1384218 — [PATCH 3/3] checkpatch: relax Kconfig help text line number threshold

Current threshold is too strict and many upstream patch doesn't pass
this test. Relax it.

Signed-off-by: Yingjoe Chen <yingjoe.chen@mediatek.com>

---
In v4.6-rc1, 171 new config options was added, and 87 of those options
have < 4 lines and 24 options have only 1 line. After this change,
checkpatch only raise warning when help text only contain 1 line.

Some options try to workaround this check by adding 2 lines
template like 'If you have this device...' which doesn't add value.

---
 scripts/checkpatch.pl | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 2bf4499..33b9bfc 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -47,7 +47,7 @@ my $configuration_file = ".checkpatch.conf";
 my $max_line_length = 80;
 my $ignore_perl_version = 0;
 my $minimum_perl_version = 5.10.0;
-my $min_conf_desc_length = 4;
+my $min_conf_desc_length = 2;
 my $spelling_file = "$D/spelling.txt";
 my $codespell = 0;
 my $codespellfile = "/usr/share/codespell/dictionary.txt";
-- 
1.9.1

[toc] | [next] | [standalone]

#1384435 — Re: [PATCH 3/3] checkpatch: relax Kconfig help text line number threshold

On Thu, 2016-04-21 at 21:28 +0800, Yingjoe Chen wrote:
> Current threshold is too strict and many upstream patch doesn't pass
> this test. Relax it.

I don't have an issue with this.
Maybe Andi Kleen does though.

> Signed-off-by: Yingjoe Chen <yingjoe.chen@mediatek.com>
> 
> ---
> In v4.6-rc1, 171 new config options was added, and 87 of those options
> have < 4 lines and 24 options have only 1 line. After this change,
> checkpatch only raise warning when help text only contain 1 line.
> 
> Some options try to workaround this check by adding 2 lines
> template like 'If you have this device...' which doesn't add value.
> 
> ---
>  scripts/checkpatch.pl | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 2bf4499..33b9bfc 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -47,7 +47,7 @@ my $configuration_file = ".checkpatch.conf";
>  my $max_line_length = 80;
>  my $ignore_perl_version = 0;
>  my $minimum_perl_version = 5.10.0;
> -my $min_conf_desc_length = 4;
> +my $min_conf_desc_length = 2;
>  my $spelling_file = "$D/spelling.txt";
>  my $codespell = 0;
>  my $codespellfile = "/usr/share/codespell/dictionary.txt";

[toc] | [prev] | [next] | [standalone]

#1384452 — Re: [PATCH 3/3] checkpatch: relax Kconfig help text line number threshold

On Thu, Apr 21, 2016 at 10:00:07AM -0700, Joe Perches wrote:
> On Thu, 2016-04-21 at 21:28 +0800, Yingjoe Chen wrote:
> > Current threshold is too strict and many upstream patch doesn't pass
> > this test. Relax it.
> 
> I don't have an issue with this.
> Maybe Andi Kleen does though.

So you spend all this time developing your kernel feature and can't be bothered to
write a real description? How should people even find out about it?

-Andi

[toc] | [prev] | [next] | [standalone]

#1385170 — Re: [PATCH 3/3] checkpatch: relax Kconfig help text line number threshold

On Thu, 2016-04-21 at 10:39 -0700, Andi Kleen wrote:
> On Thu, Apr 21, 2016 at 10:00:07AM -0700, Joe Perches wrote:
> > On Thu, 2016-04-21 at 21:28 +0800, Yingjoe Chen wrote:
> > > Current threshold is too strict and many upstream patch doesn't pass
> > > this test. Relax it.
> > 
> > I don't have an issue with this.
> > Maybe Andi Kleen does though.
> 
> So you spend all this time developing your kernel feature and can't be bothered to
> write a real description? How should people even find out about it?


I think it depends. For some features it would be helpful to have more
description. However for many device drivers, 2 lines is enough. For
example, I think the following help text is helpful and clean.

+config PINCTRL_IPQ4019
+       tristate "Qualcomm IPQ4019 pin controller driver"
+       depends on GPIOLIB && OF
+       select PINCTRL_MSM
+       help
+         This is the pinctrl, pinmux, pinconf and gpiolib driver for the
+         Qualcomm TLMM block found in the Qualcomm IPQ4019 platform.
+
+config SND_SOC_PCM179X_I2C
+       tristate "Texas Instruments PCM179X CODEC (I2C)"
+       depends on I2C
+       select SND_SOC_PCM179X
+       help
+         Enable support for Texas Instruments PCM179x CODEC.
+         Select this if your PCM179x is connected via an I2C bus.

Joe.C

[toc] | [prev] | [standalone]

Back to top | Article view | linux.kernel

csiph-web