Skip to contentSkip to conversation

treewide: replace '---help---' in Kconfig files with 'help'

DISCUSSION Geert Uytterhoeven 2 participants 2 messages Jun 15, 2020 – Jun 19, 2020 1 message not in the archive

lore
Share & tools
lore

A message that is not in the archive (sent off-list or not yet received): git-mailbomb-linux-master-a7f7f6248d9740d710fd6bd190293fe5e16410ac@kernel.org

#1 lore raw

Hi Yamada-san,

Quoted 48 lines · Linux Kernel Mailing List
Commit:     a7f7f6248d9740d710fd6bd190293fe5e16410ac
Parent:     e4a42c82e943b97ce124539fcd7a47445b43fa0d
Refname:    refs/heads/master
Web:        https://git.kernel.org/torvalds/c/a7f7f6248d9740d710fd6bd190293fe5e16410ac
Author:     Masahiro Yamada <[email protected]>
AuthorDate: Sun Jun 14 01:50:22 2020 +0900
Committer:  Masahiro Yamada <[email protected]>
CommitDate: Sun Jun 14 01:57:21 2020 +0900

treewide: replace '---help---' in Kconfig files with 'help'

Since commit 84af7a6194e4 ("checkpatch: kconfig: prefer 'help' over '---help---'"), the number of '---help---' has been gradually decreasing, but there are still more than 2400 instances.

   This commit finishes the conversion. While I touched the lines,
   I also fixed the indentation.

   There are a variety of indentation styles found.

     a) 4 spaces + '---help---'
     b) 7 spaces + '---help---'
     c) 8 spaces + '---help---'
     d) 1 space + 1 tab + '---help---'
     e) 1 tab + '---help---'    (correct indentation)
     f) 1 tab + 1 space + '---help---'
     g) 1 tab + 2 spaces + '---help---'

   In order to convert all of them to 1 tab + 'help', I ran the
   following commend:

     $ find . -name 'Kconfig*' | xargs sed -i 's/^[[:space:]]*---help---/\thelp/'

   Signed-off-by: Masahiro Yamada <[email protected]>
arch/ia64/Kconfig +1 -1
index 88b05b5256a9..1fa2fe2ef053 100644
@@ -266,7 +266,7 @@ config PERMIT_BSP_REMOVE
 	bool "Support removal of Bootstrap Processor"
 	depends on HOTPLUG_CPU
 	default n
-	---help---
+	help
 	Say Y here if your platform SAL will support removal of BSP with HOTPLUG_CPU
 	support.
 

arch/ia64/Kconfig config FORCE_CPEI_RETARGET · line 280

Quoted 8 lines
arch/ia64/Kconfig +1 -1
@@ -274,7 +274,7 @@ config FORCE_CPEI_RETARGET
 	bool "Force assumption that CPEI can be re-targeted"
 	depends on PERMIT_BSP_REMOVE
 	default n
-	---help---
+	help
 	Say Y if you need to force the assumption that CPEI can be re-targeted to
 	any cpu in the system. This hint is available via ACPI 3.0 specifications.
 	Tiger4 systems are capable of re-directing CPEI to any CPU other than BSP.

I guess help text blocks like the above should be indented? Unfortunately there are many of them.

Thanks!

Gr{oetje,eeting}s,

Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected]

In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that.
-- Linus Torvalds

#2 lore raw
Quoted 51 lines · Geert Uytterhoeven

Hi Yamada-san,

Quoted 47 lines · Linux Kernel Mailing List
Commit:     a7f7f6248d9740d710fd6bd190293fe5e16410ac
Parent:     e4a42c82e943b97ce124539fcd7a47445b43fa0d
Refname:    refs/heads/master
Web:        https://git.kernel.org/torvalds/c/a7f7f6248d9740d710fd6bd190293fe5e16410ac
Author:     Masahiro Yamada <[email protected]>
AuthorDate: Sun Jun 14 01:50:22 2020 +0900
Committer:  Masahiro Yamada <[email protected]>
CommitDate: Sun Jun 14 01:57:21 2020 +0900

treewide: replace '---help---' in Kconfig files with 'help'

Since commit 84af7a6194e4 ("checkpatch: kconfig: prefer 'help' over '---help---'"), the number of '---help---' has been gradually decreasing, but there are still more than 2400 instances.

   This commit finishes the conversion. While I touched the lines,
   I also fixed the indentation.

   There are a variety of indentation styles found.

     a) 4 spaces + '---help---'
     b) 7 spaces + '---help---'
     c) 8 spaces + '---help---'
     d) 1 space + 1 tab + '---help---'
     e) 1 tab + '---help---'    (correct indentation)
     f) 1 tab + 1 space + '---help---'
     g) 1 tab + 2 spaces + '---help---'

   In order to convert all of them to 1 tab + 'help', I ran the
   following commend:

     $ find . -name 'Kconfig*' | xargs sed -i 's/^[[:space:]]*---help---/\thelp/'

   Signed-off-by: Masahiro Yamada <[email protected]>
arch/ia64/Kconfig +1 -1
index 88b05b5256a9..1fa2fe2ef053 100644
@@ -266,7 +266,7 @@ config PERMIT_BSP_REMOVE
      bool "Support removal of Bootstrap Processor"
      depends on HOTPLUG_CPU
      default n
-     ---help---
+     help
      Say Y here if your platform SAL will support removal of BSP with HOTPLUG_CPU
      support.
 
Quoted 12 lines

arch/ia64/Kconfig config FORCE_CPEI_RETARGET · line 280

Quoted 9 lines
arch/ia64/Kconfig +1 -1
@@ -274,7 +274,7 @@ config FORCE_CPEI_RETARGET
      bool "Force assumption that CPEI can be re-targeted"
      depends on PERMIT_BSP_REMOVE
      default n
-     ---help---
+     help
      Say Y if you need to force the assumption that CPEI can be re-targeted to
      any cpu in the system. This hint is available via ACPI 3.0 specifications.
      Tiger4 systems are capable of re-directing CPEI to any CPU other than BSP.

I guess help text blocks like the above should be indented? Unfortunately there are many of them.

Yes, the help body should be indented by 1 tab + 2 spaces, which is documented in Documentation/process/coding-style.rst

Since there are too many, I cannot fix them all.

Quoted 12 lines

Thanks!

Gr{oetje,eeting}s,

Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected]

In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that.
-- Linus Torvalds

Signature · 2 lines
Best Regards
Masahiro Yamada