Remove blank help texts from Kconfig files and add warning

PATCH In review Ulf Magnusson 6 participants 31 messages Jan 31, 2018 – Mar 12, 2018

Subsystems (14)

Networking Network drivers Arm (32-bit) Arm sub-architectures +10 more subsystems

lore

Share & tools

lore

Ulf Magnusson

author

2018-01-31 09:35 UTC #0 lore raw

cover Remove blank help texts from Kconfig files and add warning

This patchset first removes all blank help texts from Kconfig files for all arches, and then makes Kconfig print a warning for blank help texts.

All patches can be applied independently, but to avoid warning spam, the blank help texts ought to be removed before the warning is added.

Ulf Magnusson (11):
net/sched: kconfig: Remove blank help texts
video: fbdev: kconfig: Remove blank help text
mmc: kconfig: Remove blank help text
Staging: rtl8192u: kconfig: Remove blank help text
Staging: rtl8192e: kconfig: Remove blank help text lib/Kconfig.debug: Remove blank help text
MIPS: BCM63XX: kconfig: Remove blank help text
MIPS: kconfig: Remove blank help text
arm: vt8500: kconfig: Remove blank help text
nios2: kconfig: Remove blank help text
kconfig: Warn if help text is blank

 arch/arm/mach-vt8500/Kconfig              | 1 -
 arch/mips/Kconfig                         | 1 -
 arch/mips/bcm63xx/boards/Kconfig          | 1 -
 arch/nios2/Kconfig                        | 1 -
 drivers/mmc/host/Kconfig                  | 1 -
 drivers/staging/rtl8192e/rtl8192e/Kconfig | 1 -
 drivers/staging/rtl8192u/Kconfig          | 1 -
 drivers/video/fbdev/Kconfig               | 1 -
 lib/Kconfig.debug                         | 1 -
 net/sched/Kconfig                         | 3 ---
 scripts/kconfig/zconf.y                   | 6 ++++++
 11 files changed, 6 insertions(+), 12 deletions(-)

Signature · 1 line

2.14.1

Ulf Magnusson

author

2018-01-31 09:34 UTC #1 lore raw

PATCH 1/11 net/sched: kconfig: Remove blank help texts

Blank help texts are probably either a typo, a Kconfig misunderstanding, or some kind of half-committing to adding a help text (in which case a TODO comment would be clearer, if the help text really can't be added right away).

Best to remove them, IMO.

Signed-off-by Ulf Magnusson <[email protected]>

---
 net/sched/Kconfig | 3 ---
 1 file changed, 3 deletions(-)

net/sched/Kconfig +0 -3

index c03d86a7775e..f24a6ae6819a 100644
@@ -857,17 +857,14 @@ config NET_ACT_TUNNEL_KEY
 config NET_IFE_SKBMARK
         tristate "Support to encoding decoding skb mark on IFE action"
         depends on NET_ACT_IFE
-        ---help---
 
 config NET_IFE_SKBPRIO
         tristate "Support to encoding decoding skb prio on IFE action"
         depends on NET_ACT_IFE
-        ---help---
 
 config NET_IFE_SKBTCINDEX
         tristate "Support to encoding decoding skb tcindex on IFE action"
         depends on NET_ACT_IFE
-        ---help---
 
 config NET_CLS_IND
 	bool "Incoming device classification"

Signature · 1 line

2.14.1

Ulf Magnusson

author

2018-01-31 09:34 UTC #2 lore raw

PATCH 2/11 video: fbdev: kconfig: Remove blank help text

In reply to Ulf Magnusson

Best to remove them, IMO.

Signed-off-by Ulf Magnusson <[email protected]>

---
 drivers/video/fbdev/Kconfig | 1 -
 1 file changed, 1 deletion(-)

drivers/video/fbdev/Kconfig +0 -1

index 6962b4583fd7..11e699f1062b 100644
@@ -1156,7 +1156,6 @@ config FB_I810_I2C
 	bool "Enable DDC Support"
 	depends on FB_I810 && FB_I810_GTF
 	select FB_DDC
-	help
 
 config FB_LE80578
 	tristate "Intel LE80578 (Vermilion) support"

Signature · 1 line

2.14.1

Bartlomiej Zolnierkiewicz

2018-02-01 15:52 UTC #3 lore raw

Re: [PATCH 02/11] video: fbdev: kconfig: Remove blank help text

Hi,

Quoted 6 lines · Ulf Magnusson

Blank help texts are probably either a typo, a Kconfig misunderstanding, or some kind of half-committing to adding a help text (in which case a TODO comment would be clearer, if the help text really can't be added right away).
Best to remove them, IMO.

How about actually adding some meaningful help texts instead (as a general rule each user visible option should have valid help text)?

Quoted 10 lines

Signed-off-by Ulf Magnusson <[email protected]>
---
 drivers/video/fbdev/Kconfig | 1 -
 1 file changed, 1 deletion(-)
drivers/video/fbdev/Kconfig +0 -0
index 6962b4583fd7..11e699f1062b 100644

drivers/video/fbdev/Kconfig config FB_I810_I2C · line 1159

Quoted 4 lines

drivers/video/fbdev/Kconfig +0 -1

@@ -1156,7 +1156,6 @@ config FB_I810_I2C
 	bool "Enable DDC Support"
 	depends on FB_I810 && FB_I810_GTF
 	select FB_DDC
-	help

Please add a missing help text instead (take a look at FB_SAVAGE_I2C config option to see how a valid help text entry should look like).

In the longer term we should consider removing *_I2C config options and just make the main config options always enable I2C subsystem directly if needed/useful (some fbdev drivers are doing it this way already).

drivers/video/fbdev/Kconfig config FB_I810_I2C · line 1161

Quoted 2 lines

drivers/video/fbdev/Kconfig +0 -0

 config FB_LE80578
 	tristate "Intel LE80578 (Vermilion) support"

Best regards,
--
Bartlomiej Zolnierkiewicz
Samsung R&D Institute Poland
Samsung Electronics

Ulf Magnusson

author

2018-02-01 16:56 UTC #4 lore raw

Re: [PATCH 02/11] video: fbdev: kconfig: Remove blank help text

Quoted 20 lines · Bartlomiej Zolnierkiewicz

Hi,
Quoted 6 lines · Ulf Magnusson
Blank help texts are probably either a typo, a Kconfig misunderstanding, or some kind of half-committing to adding a help text (in which case a TODO comment would be clearer, if the help text really can't be added right away).
Best to remove them, IMO.
How about actually adding some meaningful help texts instead (as a general rule each user visible option should have valid help text)?
Quoted 5 lines
Signed-off-by Ulf Magnusson <[email protected]>
---
 drivers/video/fbdev/Kconfig | 1 -
 1 file changed, 1 deletion(-)

Quoted 12 lines

drivers/video/fbdev/Kconfig config FB_I810_I2C · line 1159
Quoted 9 lines
drivers/video/fbdev/Kconfig +0 -1
index 6962b4583fd7..11e699f1062b 100644
@@ -1156,7 +1156,6 @@ config FB_I810_I2C
      bool "Enable DDC Support"
      depends on FB_I810 && FB_I810_GTF
      select FB_DDC
-     help
Please add a missing help text instead (take a look at FB_SAVAGE_I2C config option to see how a valid help text entry should look like).

The FB_I810_I2C option was added in 74f6ae84b23 ("[PATCH] i810fb: Add i2c/DDC support"). What do you think about adding this bit from the commit message as the help text?

Add DDC/I2C support for i810fb. This will allow the driver to get display information, especially for monitors with fickle timings.

I'm not familiar with this code, so I don't want to do too much guessing myself. :)

Quoted 6 lines

In the longer term we should consider removing *_I2C config options and just make the main config options always enable I2C subsystem directly if needed/useful (some fbdev drivers are doing it this way already).

Quoted 9 lines

drivers/video/fbdev/Kconfig config FB_I810_I2C · line 1161
Quoted 2 lines
drivers/video/fbdev/Kconfig +0 -0
 config FB_LE80578
      tristate "Intel LE80578 (Vermilion) support"
Best regards,
--
Bartlomiej Zolnierkiewicz
Samsung R&D Institute Poland
Samsung Electronics

Cheers,
Ulf

Masahiro Yamada

2018-02-01 17:07 UTC #5 lore raw

Re: [PATCH 02/11] video: fbdev: kconfig: Remove blank help text

2018-02-02 1:56 GMT+09:00 Ulf Magnusson <[email protected]>:

Quoted 5 lines

Quoted 3 lines · Bartlomiej Zolnierkiewicz
Hi,

Quoted 7 lines

Quoted 7 lines · Ulf Magnusson
Quoted 6 lines
Blank help texts are probably either a typo, a Kconfig misunderstanding, or some kind of half-committing to adding a help text (in which case a TODO comment would be clearer, if the help text really can't be added right away).
Best to remove them, IMO.

FYI.

I picked up this patch to kbuild
because I need this to suppress warning messages
introduced by 11/11.

I am planning to send a PR for this series.

Signature · 2 lines

Best Regards
Masahiro Yamada

Bartlomiej Zolnierkiewicz

2018-02-13 12:31 UTC #6 lore raw

Re: [PATCH 02/11] video: fbdev: kconfig: Remove blank help text

In reply to Ulf Magnusson

Quoted 35 lines · Ulf Magnusson

Quoted 20 lines · Bartlomiej Zolnierkiewicz
Hi,
Quoted 6 lines · Ulf Magnusson
Blank help texts are probably either a typo, a Kconfig misunderstanding, or some kind of half-committing to adding a help text (in which case a TODO comment would be clearer, if the help text really can't be added right away).
Best to remove them, IMO.
How about actually adding some meaningful help texts instead (as a general rule each user visible option should have valid help text)?
Quoted 5 lines
Signed-off-by Ulf Magnusson <[email protected]>
---
 drivers/video/fbdev/Kconfig | 1 -
 1 file changed, 1 deletion(-)
Quoted 12 lines
drivers/video/fbdev/Kconfig config FB_I810_I2C · line 1159
Quoted 9 lines
drivers/video/fbdev/Kconfig +0 -1
index 6962b4583fd7..11e699f1062b 100644
@@ -1156,7 +1156,6 @@ config FB_I810_I2C
      bool "Enable DDC Support"
      depends on FB_I810 && FB_I810_GTF
      select FB_DDC
-     help
Please add a missing help text instead (take a look at FB_SAVAGE_I2C config option to see how a valid help text entry should look like).

Quoted 6 lines

The FB_I810_I2C option was added in 74f6ae84b23 ("[PATCH] i810fb: Add i2c/DDC support"). What do you think about adding this bit from the commit message as the help text?
Add DDC/I2C support for i810fb. This will allow the driver to get display information, especially for monitors with fickle timings.

Seems fine to me, please add:

If unsure, say Y.

and send it as a proper patch.

Quoted 2 lines

I'm not familiar with this code, so I don't want to do too much guessing myself. :)

Quoted 15 lines

Quoted 5 lines
In the longer term we should consider removing *_I2C config options and just make the main config options always enable I2C subsystem directly if needed/useful (some fbdev drivers are doing it this way already).
Quoted 9 lines
drivers/video/fbdev/Kconfig config FB_I810_I2C · line 1161
Quoted 2 lines
drivers/video/fbdev/Kconfig +0 -0
 config FB_LE80578
      tristate "Intel LE80578 (Vermilion) support"
Best regards,
--
Bartlomiej Zolnierkiewicz
Samsung R&D Institute Poland
Samsung Electronics

Quoted 2 lines

Cheers,
Ulf

Best regards,
--
Bartlomiej Zolnierkiewicz
Samsung R&D Institute Poland
Samsung Electronics

Ulf Magnusson

author

2018-02-13 14:02 UTC #7 lore raw

PATCH 1/1 video: fbdev: kconfig: Add help text to FB_I810_I2C

The FB_I810_I2C symbol previously had a blank help text, which was removed in e9829ac4e5fd ("video: fbdev: kconfig: Remove blank help text").

Give it a proper help text, derived from commit 74f6ae84b23 ("[PATCH]
i810fb: Add > i2c/DDC support").

Signed-off-by Ulf Magnusson <[email protected]>

---
Note: The removal of the blank help text is already in Linus' tree.

 drivers/video/fbdev/Kconfig | 5 +++++
 1 file changed, 5 insertions(+)

drivers/video/fbdev/Kconfig +5 -0

index 11e699f1062b..c691f1489bb7 100644
@@ -1156,6 +1156,11 @@ config FB_I810_I2C
 	bool "Enable DDC Support"
 	depends on FB_I810 && FB_I810_GTF
 	select FB_DDC
+	help
+	  Add DDC/I2C support for i810fb.  This will allow the driver to get
+	  display information, especially for monitors with fickle timings.
+
+	  If unsure, say Y.
 
 config FB_LE80578
 	tristate "Intel LE80578 (Vermilion) support"

Signature · 1 line

2.14.1

Bartlomiej Zolnierkiewicz

2018-03-12 15:08 UTC #8 lore raw

Re: [PATCH] video: fbdev: kconfig: Add help text to FB_I810_I2C

Quoted 8 lines · Ulf Magnusson

The FB_I810_I2C symbol previously had a blank help text, which was removed in e9829ac4e5fd ("video: fbdev: kconfig: Remove blank help text").
Give it a proper help text, derived from commit 74f6ae84b23 ("[PATCH]
i810fb: Add > i2c/DDC support").
Signed-off-by Ulf Magnusson <[email protected]>

Patch queued for 4.17, thanks.

Best regards,
--
Bartlomiej Zolnierkiewicz
Samsung R&D Institute Poland
Samsung Electronics

Ulf Magnusson

author

2018-01-31 09:34 UTC #9 lore raw

PATCH 3/11 mmc: kconfig: Remove blank help text

In reply to Ulf Magnusson

Best to remove them, IMO.

Signed-off-by Ulf Magnusson <[email protected]>

---
 drivers/mmc/host/Kconfig | 1 -
 1 file changed, 1 deletion(-)

drivers/mmc/host/Kconfig +0 -1

index 67bd3344dd03..24dee8eb5270 100644
@@ -874,7 +874,6 @@ config MMC_CQHCI
 config MMC_TOSHIBA_PCI
 	tristate "Toshiba Type A SD/MMC Card Interface Driver"
 	depends on PCI
-	help
 
 config MMC_BCM2835
 	tristate "Broadcom BCM2835 SDHOST MMC Controller support"

Signature · 1 line

2.14.1

Masahiro Yamada

2018-02-01 17:10 UTC #10 lore raw

Re: [PATCH 03/11] mmc: kconfig: Remove blank help text

2018-01-31 18:34 GMT+09:00 Ulf Magnusson <[email protected]>:

Quoted 9 lines

Blank help texts are probably either a typo, a Kconfig misunderstanding, or some kind of half-committing to adding a help text (in which case a TODO comment would be clearer, if the help text really can't be added right away).
Best to remove them, IMO.
Signed-off-by Ulf Magnusson <[email protected]>
---

FYI.

I picked up this patch to kbuild
because I need this to suppress warning messages
introduced by 11/11.

I am planning to send a PR for this series next week.

Ulf Hansson

2018-02-14 10:11 UTC #11 lore raw

Re: [PATCH 03/11] mmc: kconfig: Remove blank help text

Quoted 12 lines · Masahiro Yamada

2018-01-31 18:34 GMT+09:00 Ulf Magnusson <[email protected]>:
Quoted 9 lines
Blank help texts are probably either a typo, a Kconfig misunderstanding, or some kind of half-committing to adding a help text (in which case a TODO comment would be clearer, if the help text really can't be added right away).
Best to remove them, IMO.
Signed-off-by Ulf Magnusson <[email protected]>
---

Quoted 5 lines

FYI.
I picked up this patch to kbuild
because I need this to suppress warning messages
introduced by 11/11.

Okay. Feel free to add my ack.

[...]

Kind regards
Uffe

Ulf Magnusson

author

2018-01-31 09:34 UTC #12 lore raw

PATCH 4/11 Staging: rtl8192u: kconfig: Remove blank help text

In reply to Ulf Magnusson

Best to remove them, IMO.

Signed-off-by Ulf Magnusson <[email protected]>

---
 drivers/staging/rtl8192u/Kconfig | 1 -
 1 file changed, 1 deletion(-)

drivers/staging/rtl8192u/Kconfig +0 -1

index 3ee9d0d00fb6..97df6507a485 100644
@@ -5,4 +5,3 @@ config RTL8192U
 	select WIRELESS_EXT
 	select WEXT_PRIV
 	select CRYPTO
-	---help---

Signature · 6 lines

2.14.1

_______________________________________________
devel mailing list
[email protected]
http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel

Masahiro Yamada

2018-02-01 17:09 UTC #13 lore raw

Re: [PATCH 04/11] Staging: rtl8192u: kconfig: Remove blank help text

2018-01-31 18:34 GMT+09:00 Ulf Magnusson <[email protected]>:

Quoted 9 lines

Blank help texts are probably either a typo, a Kconfig misunderstanding, or some kind of half-committing to adding a help text (in which case a TODO comment would be clearer, if the help text really can't be added right away).
Best to remove them, IMO.
Signed-off-by Ulf Magnusson <[email protected]>
---

FYI.

I picked up this patch to kbuild
because I need this to suppress warning messages
introduced by 11/11.

I am planning to send a PR for this series next week.
_______________________________________________
devel mailing list [email protected]
http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel

Ulf Magnusson

author

2018-01-31 09:34 UTC #14 lore raw

PATCH 5/11 Staging: rtl8192e: kconfig: Remove blank help text

In reply to Ulf Magnusson

Best to remove them, IMO.

Signed-off-by Ulf Magnusson <[email protected]>

---
 drivers/staging/rtl8192e/rtl8192e/Kconfig | 1 -
 1 file changed, 1 deletion(-)

drivers/staging/rtl8192e/rtl8192e/Kconfig +0 -1

index 282e293da18f..7ac42a590e21 100644
@@ -6,4 +6,3 @@ config RTL8192E
 	select WEXT_PRIV
 	select CRYPTO
 	select FW_LOADER
-	---help---

Signature · 6 lines

2.14.1

_______________________________________________
devel mailing list
[email protected]
http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel

Masahiro Yamada

2018-02-01 17:09 UTC #15 lore raw

Re: [PATCH 05/11] Staging: rtl8192e: kconfig: Remove blank help text

2018-01-31 18:34 GMT+09:00 Ulf Magnusson <[email protected]>:

Quoted 9 lines

Blank help texts are probably either a typo, a Kconfig misunderstanding, or some kind of half-committing to adding a help text (in which case a TODO comment would be clearer, if the help text really can't be added right away).
Best to remove them, IMO.
Signed-off-by Ulf Magnusson <[email protected]>
---

FYI.

I picked up this patch to kbuild
because I need this to suppress warning messages
introduced by 11/11.

I am planning to send a PR for this series next week.

Signature · 6 lines

Best Regards
Masahiro Yamada
_______________________________________________
devel mailing list
[email protected]
http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel

Ulf Magnusson

author

2018-01-31 09:35 UTC #16 lore raw

PATCH 6/11 lib/Kconfig.debug: Remove blank help text

In reply to Ulf Magnusson

Best to remove them, IMO.

Signed-off-by Ulf Magnusson <[email protected]>

---
 lib/Kconfig.debug | 1 -
 1 file changed, 1 deletion(-)

lib/Kconfig.debug +0 -1

index b66c264d4194..6088408ef26c 100644
@@ -351,7 +351,6 @@ config SECTION_MISMATCH_WARN_ONLY
 #
 config ARCH_WANT_FRAME_POINTERS
 	bool
-	help
 
 config FRAME_POINTER
 	bool "Compile the kernel with frame pointers"

Signature · 1 line

2.14.1

Masahiro Yamada

2018-02-01 17:11 UTC #17 lore raw

Re: [PATCH 06/11] lib/Kconfig.debug: Remove blank help text

2018-01-31 18:34 GMT+09:00 Ulf Magnusson <[email protected]>:

Quoted 9 lines

Blank help texts are probably either a typo, a Kconfig misunderstanding, or some kind of half-committing to adding a help text (in which case a TODO comment would be clearer, if the help text really can't be added right away).
Best to remove them, IMO.
Signed-off-by Ulf Magnusson <[email protected]>
---

FYI.

I picked up this patch to kbuild
because I need this to suppress warning messages
introduced by 11/11.

I am planning to send a PR for this series next week.

Ulf Magnusson

author

2018-01-31 09:34 UTC #18 lore raw

PATCH 7/11 MIPS: BCM63XX: kconfig: Remove blank help text

In reply to Ulf Magnusson

Best to remove them, IMO.

Signed-off-by Ulf Magnusson <[email protected]>

---
 arch/mips/bcm63xx/boards/Kconfig | 1 -
 1 file changed, 1 deletion(-)

arch/mips/bcm63xx/boards/Kconfig +0 -1

index 6ff0a7481081..f60d96610ace 100644
@@ -7,6 +7,5 @@ choice
 config BOARD_BCM963XX
        bool "Generic Broadcom 963xx boards"
 	select SSB
-       help
 
 endchoice

Signature · 1 line

2.14.1

Masahiro Yamada

2018-02-01 17:12 UTC #19 lore raw

PATCH 7/11 MIPS: BCM63XX: kconfig: Remove blank help text

2018-01-31 18:34 GMT+09:00 Ulf Magnusson <[email protected]>:

Quoted 9 lines

Blank help texts are probably either a typo, a Kconfig misunderstanding, or some kind of half-committing to adding a help text (in which case a TODO comment would be clearer, if the help text really can't be added right away).
Best to remove them, IMO.
Signed-off-by Ulf Magnusson <[email protected]>
---

FYI.

I picked up this patch to kbuild
because I need this to suppress warning messages
introduced by 11/11.

I am planning to send a PR for this series next week.

Signature · 2 lines

Best Regards
Masahiro Yamada

Ulf Magnusson

author

2018-01-31 09:36 UTC #20 lore raw

PATCH 8/11 MIPS: kconfig: Remove blank help text

In reply to Ulf Magnusson

Best to remove them, IMO.

Signed-off-by Ulf Magnusson <[email protected]>

---
 arch/mips/Kconfig | 1 -
 1 file changed, 1 deletion(-)

arch/mips/Kconfig +0 -1

index ab98569994f0..57cd591e7b28 100644
@@ -2326,7 +2326,6 @@ config MIPS_VPE_LOADER_TOM
 config MIPS_VPE_APSP_API
 	bool "Enable support for AP/SP API (RTLX)"
 	depends on MIPS_VPE_LOADER
-	help
 
 config MIPS_VPE_APSP_API_CMP
 	bool

Signature · 1 line

2.14.1

Masahiro Yamada

2018-02-01 17:11 UTC #21 lore raw

Re: [PATCH 08/11] MIPS: kconfig: Remove blank help text

2018-01-31 18:34 GMT+09:00 Ulf Magnusson <[email protected]>:

Quoted 9 lines

Blank help texts are probably either a typo, a Kconfig misunderstanding, or some kind of half-committing to adding a help text (in which case a TODO comment would be clearer, if the help text really can't be added right away).
Best to remove them, IMO.
Signed-off-by Ulf Magnusson <[email protected]>
---

FYI.

I picked up this patch to kbuild
because I need this to suppress warning messages
introduced by 11/11.

I am planning to send a PR for this series next week.

Signature · 2 lines

Best Regards
Masahiro Yamada

Ulf Magnusson

author

2018-01-31 09:34 UTC #22 lore raw

PATCH 9/11 arm: vt8500: kconfig: Remove blank help text

In reply to Ulf Magnusson

Best to remove them, IMO.

Signed-off-by Ulf Magnusson <[email protected]>

---
 arch/arm/mach-vt8500/Kconfig | 1 -
 1 file changed, 1 deletion(-)

arch/arm/mach-vt8500/Kconfig +0 -1

index 1156a585dafc..8841199058ea 100644
@@ -13,7 +13,6 @@ config ARCH_WM8505
  	depends on ARCH_MULTI_V5
  	select ARCH_VT8500
  	select CPU_ARM926T
- 	help
 
 config ARCH_WM8750
 	bool "WonderMedia WM8750"

Signature · 1 line

2.14.1

Masahiro Yamada

2018-02-01 17:11 UTC #23 lore raw

Re: [PATCH 09/11] arm: vt8500: kconfig: Remove blank help text

2018-01-31 18:34 GMT+09:00 Ulf Magnusson <[email protected]>:

Quoted 9 lines

Blank help texts are probably either a typo, a Kconfig misunderstanding, or some kind of half-committing to adding a help text (in which case a TODO comment would be clearer, if the help text really can't be added right away).
Best to remove them, IMO.
Signed-off-by Ulf Magnusson <[email protected]>
---

FYI.

I picked up this patch to kbuild
because I need this to suppress warning messages
introduced by 11/11.

I am planning to send a PR for this series next week.

Ulf Magnusson

author

2018-01-31 09:36 UTC #24 lore raw

PATCH 10/11 nios2: kconfig: Remove blank help text

In reply to Ulf Magnusson

Best to remove them, IMO.

Signed-off-by Ulf Magnusson <[email protected]>

---
 arch/nios2/Kconfig | 1 -
 1 file changed, 1 deletion(-)

arch/nios2/Kconfig +0 -1

index 60fae03dac79..3d4ec88f1db1 100644
@@ -152,7 +152,6 @@ menu "Advanced setup"
 
 config ADVANCED_OPTIONS
 	bool "Prompt for advanced kernel configuration options"
-	help
 
 comment "Default settings for advanced configuration options are used"
 	depends on !ADVANCED_OPTIONS

Signature · 1 line

2.14.1

Masahiro Yamada

2018-02-01 17:12 UTC #25 lore raw

Re: [PATCH 10/11] nios2: kconfig: Remove blank help text

2018-01-31 18:34 GMT+09:00 Ulf Magnusson <[email protected]>:

Quoted 9 lines

Blank help texts are probably either a typo, a Kconfig misunderstanding, or some kind of half-committing to adding a help text (in which case a TODO comment would be clearer, if the help text really can't be added right away).
Best to remove them, IMO.
Signed-off-by Ulf Magnusson <[email protected]>
---

FYI.

I picked up this patch to kbuild
because I need this to suppress warning messages
introduced by 11/11.

I am planning to send a PR for this series next week.

Ley Foon Tan

Acked-by on v1 10/11

2018-02-02 01:28 UTC #26 lore raw

Re: [PATCH 10/11] nios2: kconfig: Remove blank help text

In reply to Ulf Magnusson

Quoted 24 lines · Ulf Magnusson

Blank help texts are probably either a typo, a Kconfig misunderstanding,
or some kind of half-committing to adding a help text (in which case a
TODO comment would be clearer, if the help text really can't be added right away).
Best to remove them, IMO.
Signed-off-by Ulf Magnusson <[email protected]>
---
arch/nios2/Kconfig | 1 -
 1 file changed, 1 deletion(-)
arch/nios2/Kconfig +0 -0
index 60fae03dac79..3d4ec88f1db1 100644
@@ -152,7 +152,6 @@ menu "Advanced setup"
 
config ADVANCED_OPTIONS
bool "Prompt for advanced kernel configuration options" - help

Quoted 6 lines

comment "Default settings for advanced configuration options are used"
depends on !ADVANCED_OPTIONS
--
2.14.1

Acked-by Ley Foon Tan <[email protected]>

Ulf Magnusson

author

2018-01-31 09:36 UTC #27 lore raw

PATCH 11/11 kconfig: Warn if help text is blank

In reply to Ulf Magnusson

Best to flag them, IMO.

Example warning:

drivers/mmc/host/Kconfig:877: warning: 'MMC_TOSHIBA_PCI' defined with blank help text

Signed-off-by Ulf Magnusson <[email protected]>

---
 scripts/kconfig/zconf.y | 6 ++++++
 1 file changed, 6 insertions(+)

scripts/kconfig/zconf.y +6 -0

index 21ce883e5d9e..4be98050b961 100644
@@ -436,6 +436,12 @@ help: help_start T_HELPTEXT
 		zconfprint("warning: '%s' defined with more than one help text -- only the last one will be used",
 			   current_entry->sym->name ?: "<choice>");
 	}
+
+	/* Is the help text empty or all whitespace? */
+	if ($2[strspn($2, " \f\n\r\t\v")] == '\0')
+		zconfprint("warning: '%s' defined with blank help text",
+			   current_entry->sym->name ?: "<choice>");
+
 	current_entry->help = $2;
 };

Signature · 1 line

2.14.1

Masahiro Yamada

2018-01-31 15:28 UTC #28 lore raw

In reply to Ulf Magnusson

2018-01-31 18:34 GMT+09:00 Ulf Magnusson <[email protected]>:

Quoted 6 lines

This patchset first removes all blank help texts from Kconfig files for all arches, and then makes Kconfig print a warning for blank help texts.
All patches can be applied independently, but to avoid warning spam, the blank help texts ought to be removed before the warning is added.

Quoted 12 lines

Ulf Magnusson (11):
net/sched: kconfig: Remove blank help texts
video: fbdev: kconfig: Remove blank help text
mmc: kconfig: Remove blank help text
Staging: rtl8192u: kconfig: Remove blank help text
Staging: rtl8192e: kconfig: Remove blank help text lib/Kconfig.debug: Remove blank help text
MIPS: BCM63XX: kconfig: Remove blank help text
MIPS: kconfig: Remove blank help text
arm: vt8500: kconfig: Remove blank help text
nios2: kconfig: Remove blank help text
kconfig: Warn if help text is blank

Whole of the series, applied to linux-kbuild/kconfig. Thanks!

Quoted 20 lines

 arch/arm/mach-vt8500/Kconfig              | 1 -
 arch/mips/Kconfig                         | 1 -
 arch/mips/bcm63xx/boards/Kconfig          | 1 -
 arch/nios2/Kconfig                        | 1 -
 drivers/mmc/host/Kconfig                  | 1 -
 drivers/staging/rtl8192e/rtl8192e/Kconfig | 1 -
 drivers/staging/rtl8192u/Kconfig          | 1 -
 drivers/video/fbdev/Kconfig               | 1 -
 lib/Kconfig.debug                         | 1 -
 net/sched/Kconfig                         | 3 ---
 scripts/kconfig/zconf.y                   | 6 ++++++
 11 files changed, 6 insertions(+), 12 deletions(-)

--
2.14.1

--
To unsubscribe from this list: send the line "unsubscribe linux-kbuild" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

Signature · 2 lines

Best Regards
Masahiro Yamada

Randy Dunlap

Acked-by

2018-01-31 20:47 UTC #29 lore raw

Quoted 21 lines · Masahiro Yamada

2018-01-31 18:34 GMT+09:00 Ulf Magnusson <[email protected]>:
Quoted 6 lines
This patchset first removes all blank help texts from Kconfig files for all arches, and then makes Kconfig print a warning for blank help texts.
All patches can be applied independently, but to avoid warning spam, the blank help texts ought to be removed before the warning is added.
Quoted 12 lines
Ulf Magnusson (11):
net/sched: kconfig: Remove blank help texts
video: fbdev: kconfig: Remove blank help text
mmc: kconfig: Remove blank help text
Staging: rtl8192u: kconfig: Remove blank help text
Staging: rtl8192e: kconfig: Remove blank help text lib/Kconfig.debug: Remove blank help text
MIPS: BCM63XX: kconfig: Remove blank help text
MIPS: kconfig: Remove blank help text
arm: vt8500: kconfig: Remove blank help text
nios2: kconfig: Remove blank help text
kconfig: Warn if help text is blank

Quoted 2 lines

Whole of the series, applied to linux-kbuild/kconfig. Thanks!

That probably means that I am too late, but anyway:

Acked-by Randy Dunlap <[email protected]> # series of 11 patches

Thanks.

Quoted 14 lines


 arch/arm/mach-vt8500/Kconfig              | 1 -
 arch/mips/Kconfig                         | 1 -
 arch/mips/bcm63xx/boards/Kconfig          | 1 -
 arch/nios2/Kconfig                        | 1 -
 drivers/mmc/host/Kconfig                  | 1 -
 drivers/staging/rtl8192e/rtl8192e/Kconfig | 1 -
 drivers/staging/rtl8192u/Kconfig          | 1 -
 drivers/video/fbdev/Kconfig               | 1 -
 lib/Kconfig.debug                         | 1 -
 net/sched/Kconfig                         | 3 ---
 scripts/kconfig/zconf.y                   | 6 ++++++
 11 files changed, 6 insertions(+), 12 deletions(-)

Signature · 1 line

~Randy

Masahiro Yamada

2018-02-01 17:08 UTC #30 lore raw

2018-02-01 5:46 GMT+09:00 Randy Dunlap <[email protected]>:

Quoted 22 lines · Masahiro Yamada

Quoted 21 lines
2018-01-31 18:34 GMT+09:00 Ulf Magnusson <[email protected]>:
Quoted 18 lines
This patchset first removes all blank help texts from Kconfig files for all arches, and then makes Kconfig print a warning for blank help texts.
All patches can be applied independently, but to avoid warning spam, the blank help texts ought to be removed before the warning is added.
Ulf Magnusson (11):
net/sched: kconfig: Remove blank help texts
video: fbdev: kconfig: Remove blank help text
mmc: kconfig: Remove blank help text
Staging: rtl8192u: kconfig: Remove blank help text
Staging: rtl8192e: kconfig: Remove blank help text lib/Kconfig.debug: Remove blank help text
MIPS: BCM63XX: kconfig: Remove blank help text
MIPS: kconfig: Remove blank help text
arm: vt8500: kconfig: Remove blank help text
nios2: kconfig: Remove blank help text
kconfig: Warn if help text is blank

Quoted 7 lines

Quoted 2 lines
Whole of the series, applied to linux-kbuild/kconfig. Thanks!
That probably means that I am too late, but anyway:
Acked-by Randy Dunlap <[email protected]> # series of 11 patches

I will add your Acked-by. Thanks!

Signature · 2 lines

Best Regards
Masahiro Yamada