[PATCH 1/2] media: cec: don't use the deprecated help tag

[PATCH 1/2] media: cec: don't use the deprecated help tag

[Mauro Carvalho Chehab]

According with changeset 3e1ad4054b8d ("doc: don't use deprecated "---help---" markers in target docs"),
We want to get rid of the old ---help--- tag.

There's just the cec/Kconfig file under drivers/media using it.
Replace it.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 drivers/staging/media/atomisp/Kconfig | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/staging/media/atomisp/Kconfig b/drivers/staging/media/atomisp/Kconfig
index f75765cb0fc8..fea06cb0eb48 100644
--- a/drivers/staging/media/atomisp/Kconfig
+++ b/drivers/staging/media/atomisp/Kconfig
@@ -15,7 +15,7 @@ config VIDEO_ATOMISP
 	depends on PMIC_OPREGION
 	select IOSF_MBI
 	select VIDEOBUF_VMALLOC
-	---help---
+	help
 	  Say Y here if your platform supports Intel Atom SoC
 	  camera imaging subsystem.
 	  To compile this driver as a module, choose M here: the
-- 
2.26.2

[PATCH 2/2] media: atomisp: replace old ---help--- tags by just help

[Mauro Carvalho Chehab]

There are several places on this file using the deprecated
---help--- tag.

Replaces them.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 drivers/staging/media/atomisp/i2c/Kconfig        | 14 +++++++-------
 drivers/staging/media/atomisp/i2c/ov5693/Kconfig | 14 +++++++-------
 2 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/drivers/staging/media/atomisp/i2c/Kconfig b/drivers/staging/media/atomisp/i2c/Kconfig
index 69f325c9a724..038de895ce40 100644
--- a/drivers/staging/media/atomisp/i2c/Kconfig
+++ b/drivers/staging/media/atomisp/i2c/Kconfig
@@ -9,7 +9,7 @@ config VIDEO_ATOMISP_OV2722
        tristate "OVT ov2722 sensor support"
 	depends on ACPI
        depends on I2C && VIDEO_V4L2
-       ---help---
+       help
 	 This is a Video4Linux2 sensor-level driver for the OVT
 	 OV2722 raw camera.
 
@@ -21,7 +21,7 @@ config VIDEO_ATOMISP_GC2235
        tristate "Galaxy gc2235 sensor support"
 	depends on ACPI
        depends on I2C && VIDEO_V4L2
-       ---help---
+       help
 	 This is a Video4Linux2 sensor-level driver for the OVT
 	 GC2235 raw camera.
 
@@ -32,7 +32,7 @@ config VIDEO_ATOMISP_GC2235
 config VIDEO_ATOMISP_MSRLIST_HELPER
        tristate "Helper library to load, parse and apply large register lists."
        depends on I2C
-       ---help---
+       help
 	 This is a helper library to be used from a sensor driver to load, parse
 	 and apply large register lists.
 
@@ -43,7 +43,7 @@ config VIDEO_ATOMISP_MT9M114
        tristate "Aptina mt9m114 sensor support"
 	depends on ACPI
        depends on I2C && VIDEO_V4L2
-       ---help---
+       help
 	 This is a Video4Linux2 sensor-level driver for the Micron
 	 mt9m114 1.3 Mpixel camera.
 
@@ -55,7 +55,7 @@ config VIDEO_ATOMISP_GC0310
 	tristate "GC0310 sensor support"
 	depends on ACPI
 	depends on I2C && VIDEO_V4L2
-	---help---
+	help
 	  This is a Video4Linux2 sensor-level driver for the Galaxycore
 	  GC0310 0.3MP sensor.
 
@@ -63,7 +63,7 @@ config VIDEO_ATOMISP_OV2680
        tristate "Omnivision OV2680 sensor support"
 	depends on ACPI
        depends on I2C && VIDEO_V4L2
-       ---help---
+       help
 	 This is a Video4Linux2 sensor-level driver for the Omnivision
 	 OV2680 raw camera.
 
@@ -79,7 +79,7 @@ config VIDEO_ATOMISP_LM3554
        tristate "LM3554 flash light driver"
 	depends on ACPI
        depends on VIDEO_V4L2 && I2C
-       ---help---
+       help
 	 This is a Video4Linux2 sub-dev driver for the LM3554
 	 flash light driver.
 
diff --git a/drivers/staging/media/atomisp/i2c/ov5693/Kconfig b/drivers/staging/media/atomisp/i2c/ov5693/Kconfig
index c6ee90b2d13f..536a731dba50 100644
--- a/drivers/staging/media/atomisp/i2c/ov5693/Kconfig
+++ b/drivers/staging/media/atomisp/i2c/ov5693/Kconfig
@@ -1,12 +1,12 @@
 # SPDX-License-Identifier: GPL-2.0
 config VIDEO_ATOMISP_OV5693
-       tristate "Omnivision ov5693 sensor support"
+	tristate "Omnivision ov5693 sensor support"
 	depends on ACPI
-       depends on I2C && VIDEO_V4L2
-       ---help---
-	 This is a Video4Linux2 sensor-level driver for the Micron
-	 ov5693 5 Mpixel camera.
+	depends on I2C && VIDEO_V4L2
+	help
+	  This is a Video4Linux2 sensor-level driver for the Micron
+	  ov5693 5 Mpixel camera.
 
-	 ov5693 is video camera sensor.
+	  ov5693 is video camera sensor.
 
-	 It currently only works with the atomisp driver.
+	  It currently only works with the atomisp driver.
-- 
2.26.2

Re: [PATCH 1/2] media: cec: don't use the deprecated help tag

[Mauro Carvalho Chehab]

Em Mon, 15 Jun 2020 07:18:33 +0200
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> escreveu:

> According with changeset 3e1ad4054b8d ("doc: don't use deprecated "---help---" markers in target docs"),
> We want to get rid of the old ---help--- tag.
> 
> There's just the cec/Kconfig file under drivers/media using it.
> Replace it.

Just ignore it. A treewide patch already changed it:

	a7f7f6248d97 ("treewide: replace '---help---' in Kconfig files with 'help'")

> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
>  drivers/staging/media/atomisp/Kconfig | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/staging/media/atomisp/Kconfig b/drivers/staging/media/atomisp/Kconfig
> index f75765cb0fc8..fea06cb0eb48 100644
> --- a/drivers/staging/media/atomisp/Kconfig
> +++ b/drivers/staging/media/atomisp/Kconfig
> @@ -15,7 +15,7 @@ config VIDEO_ATOMISP
>  	depends on PMIC_OPREGION
>  	select IOSF_MBI
>  	select VIDEOBUF_VMALLOC
> -	---help---
> +	help
>  	  Say Y here if your platform supports Intel Atom SoC
>  	  camera imaging subsystem.
>  	  To compile this driver as a module, choose M here: the



Thanks,
Mauro

Re: [PATCH 2/2] media: atomisp: replace old ---help--- tags by just help

[Mauro Carvalho Chehab]

Em Mon, 15 Jun 2020 07:18:34 +0200
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> escreveu:

> There are several places on this file using the deprecated
> ---help--- tag.
> 
> Replaces them.


Just ignore it. A treewide patch already changed it:

	a7f7f6248d97 ("treewide: replace '---help---' in Kconfig files with 'help'")

I'll double-check the spacing things here. If it lasts upstream, I'll
send the changes on a separate patch.

> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
>  drivers/staging/media/atomisp/i2c/Kconfig        | 14 +++++++-------
>  drivers/staging/media/atomisp/i2c/ov5693/Kconfig | 14 +++++++-------
>  2 files changed, 14 insertions(+), 14 deletions(-)
> 
> diff --git a/drivers/staging/media/atomisp/i2c/Kconfig b/drivers/staging/media/atomisp/i2c/Kconfig
> index 69f325c9a724..038de895ce40 100644
> --- a/drivers/staging/media/atomisp/i2c/Kconfig
> +++ b/drivers/staging/media/atomisp/i2c/Kconfig
> @@ -9,7 +9,7 @@ config VIDEO_ATOMISP_OV2722
>         tristate "OVT ov2722 sensor support"
>  	depends on ACPI
>         depends on I2C && VIDEO_V4L2
> -       ---help---
> +       help
>  	 This is a Video4Linux2 sensor-level driver for the OVT
>  	 OV2722 raw camera.
>  
> @@ -21,7 +21,7 @@ config VIDEO_ATOMISP_GC2235
>         tristate "Galaxy gc2235 sensor support"
>  	depends on ACPI
>         depends on I2C && VIDEO_V4L2
> -       ---help---
> +       help
>  	 This is a Video4Linux2 sensor-level driver for the OVT
>  	 GC2235 raw camera.
>  
> @@ -32,7 +32,7 @@ config VIDEO_ATOMISP_GC2235
>  config VIDEO_ATOMISP_MSRLIST_HELPER
>         tristate "Helper library to load, parse and apply large register lists."
>         depends on I2C
> -       ---help---
> +       help
>  	 This is a helper library to be used from a sensor driver to load, parse
>  	 and apply large register lists.
>  
> @@ -43,7 +43,7 @@ config VIDEO_ATOMISP_MT9M114
>         tristate "Aptina mt9m114 sensor support"
>  	depends on ACPI
>         depends on I2C && VIDEO_V4L2
> -       ---help---
> +       help
>  	 This is a Video4Linux2 sensor-level driver for the Micron
>  	 mt9m114 1.3 Mpixel camera.
>  
> @@ -55,7 +55,7 @@ config VIDEO_ATOMISP_GC0310
>  	tristate "GC0310 sensor support"
>  	depends on ACPI
>  	depends on I2C && VIDEO_V4L2
> -	---help---
> +	help
>  	  This is a Video4Linux2 sensor-level driver for the Galaxycore
>  	  GC0310 0.3MP sensor.
>  
> @@ -63,7 +63,7 @@ config VIDEO_ATOMISP_OV2680
>         tristate "Omnivision OV2680 sensor support"
>  	depends on ACPI
>         depends on I2C && VIDEO_V4L2
> -       ---help---
> +       help
>  	 This is a Video4Linux2 sensor-level driver for the Omnivision
>  	 OV2680 raw camera.
>  
> @@ -79,7 +79,7 @@ config VIDEO_ATOMISP_LM3554
>         tristate "LM3554 flash light driver"
>  	depends on ACPI
>         depends on VIDEO_V4L2 && I2C
> -       ---help---
> +       help
>  	 This is a Video4Linux2 sub-dev driver for the LM3554
>  	 flash light driver.
>  
> diff --git a/drivers/staging/media/atomisp/i2c/ov5693/Kconfig b/drivers/staging/media/atomisp/i2c/ov5693/Kconfig
> index c6ee90b2d13f..536a731dba50 100644
> --- a/drivers/staging/media/atomisp/i2c/ov5693/Kconfig
> +++ b/drivers/staging/media/atomisp/i2c/ov5693/Kconfig
> @@ -1,12 +1,12 @@
>  # SPDX-License-Identifier: GPL-2.0
>  config VIDEO_ATOMISP_OV5693
> -       tristate "Omnivision ov5693 sensor support"
> +	tristate "Omnivision ov5693 sensor support"
>  	depends on ACPI
> -       depends on I2C && VIDEO_V4L2
> -       ---help---
> -	 This is a Video4Linux2 sensor-level driver for the Micron
> -	 ov5693 5 Mpixel camera.
> +	depends on I2C && VIDEO_V4L2
> +	help
> +	  This is a Video4Linux2 sensor-level driver for the Micron
> +	  ov5693 5 Mpixel camera.
>  
> -	 ov5693 is video camera sensor.
> +	  ov5693 is video camera sensor.
>  
> -	 It currently only works with the atomisp driver.
> +	  It currently only works with the atomisp driver.



Thanks,
Mauro

Re: [PATCH 2/2] media: atomisp: replace old ---help--- tags by just help

[Joe Perches]

On Mon, 2020-06-15 at 07:22 +0200, Mauro Carvalho Chehab wrote:
> Em Mon, 15 Jun 2020 07:18:34 +0200
> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> escreveu:
> 
> > There are several places on this file using the deprecated
> > ---help--- tag.
> > 
> > Replaces them.
> 
> Just ignore it. A treewide patch already changed it:
> 
> 	a7f7f6248d97 ("treewide: replace '---help---' in Kconfig files with 'help'")
> 
> I'll double-check the spacing things here. If it lasts upstream, I'll
> send the changes on a separate patch.

Another possible change to avoid more ---help--- lines:
---
 scripts/checkkconfigsymbols.py | 2 +-
 scripts/checkpatch.pl          | 6 +-----
 scripts/kconfig/lexer.l        | 2 +-
 3 files changed, 3 insertions(+), 7 deletions(-)

diff --git a/scripts/checkkconfigsymbols.py b/scripts/checkkconfigsymbols.py
index 00a10a293f4f..1548f9ce4682 100755
--- a/scripts/checkkconfigsymbols.py
+++ b/scripts/checkkconfigsymbols.py
@@ -34,7 +34,7 @@ REGEX_SOURCE_SYMBOL = re.compile(SOURCE_SYMBOL)
 REGEX_KCONFIG_DEF = re.compile(DEF)
 REGEX_KCONFIG_EXPR = re.compile(EXPR)
 REGEX_KCONFIG_STMT = re.compile(STMT)
-REGEX_KCONFIG_HELP = re.compile(r"^\s+(help|---help---)\s*$")
+REGEX_KCONFIG_HELP = re.compile(r"^\s+help\s*$")
 REGEX_FILTER_SYMBOLS = re.compile(r"[A-Za-z0-9]$")
 REGEX_NUMERIC = re.compile(r"0[xX][0-9a-fA-F]+|[0-9]+")
 REGEX_QUOTES = re.compile("(\"(.*?)\")")
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 524df88f9364..738bb3fcf202 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3044,11 +3044,7 @@ sub process {
 
 				if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
 					$is_start = 1;
-				} elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
-					if ($lines[$ln - 1] =~ "---help---") {
-						WARN("CONFIG_DESCRIPTION",
-						     "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
-					}
+				} elsif ($lines[$ln - 1] =~ /^\+\s*help\s*$/) {
 					$length = -1;
 				}
 
diff --git a/scripts/kconfig/lexer.l b/scripts/kconfig/lexer.l
index 6354c905b006..4b7339ff4c8b 100644
--- a/scripts/kconfig/lexer.l
+++ b/scripts/kconfig/lexer.l
@@ -105,7 +105,7 @@ n	[A-Za-z0-9_-]
 "endchoice"		return T_ENDCHOICE;
 "endif"			return T_ENDIF;
 "endmenu"		return T_ENDMENU;
-"help"|"---help---"	return T_HELP;
+"help"			return T_HELP;
 "hex"			return T_HEX;
 "if"			return T_IF;
 "imply"			return T_IMPLY;