Skip to content

Commit

Permalink
treewide: replace '---help---' in Kconfig files with 'help'
Browse files Browse the repository at this point in the history
Since commit 84af7a6 ("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 <masahiroy@kernel.org>
  • Loading branch information
masahir0y committed Jun 13, 2020
1 parent e4a42c8 commit a7f7f62
Show file tree
Hide file tree
Showing 427 changed files with 2,448 additions and 2,448 deletions.
4 changes: 2 additions & 2 deletions arch/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -876,7 +876,7 @@ config VMAP_STACK
bool "Use a virtually-mapped stack"
depends on HAVE_ARCH_VMAP_STACK
depends on !KASAN || KASAN_VMALLOC
---help---
help
Enable this if you want the use virtually-mapped kernel stacks
with guard pages. This causes kernel stack overflows to be
caught immediately rather than causing difficult-to-diagnose
Expand Down Expand Up @@ -948,7 +948,7 @@ config ARCH_USE_MEMREMAP_PROT
config LOCK_EVENT_COUNTS
bool "Locking event counts collection"
depends on DEBUG_FS
---help---
help
Enable light-weight counting of various locking related events
in the system with minimal performance impact. This reduces
the chance of application behavior change because of timing
Expand Down
18 changes: 9 additions & 9 deletions arch/alpha/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ menu "System setup"
choice
prompt "Alpha system type"
default ALPHA_GENERIC
---help---
help
This is the system type of your hardware. A "generic" kernel will
run on any supported Alpha system. However, if you configure a
kernel for your specific system, it will be faster and smaller.
Expand Down Expand Up @@ -480,7 +480,7 @@ config VGA_HOSE
config ALPHA_QEMU
bool "Run under QEMU emulation"
depends on !ALPHA_GENERIC
---help---
help
Assume the presence of special features supported by QEMU PALcode
that reduce the overhead of system emulation.

Expand All @@ -495,7 +495,7 @@ config ALPHA_SRM
bool "Use SRM as bootloader" if ALPHA_CABRIOLET || ALPHA_AVANTI_CH || ALPHA_EB64P || ALPHA_PC164 || ALPHA_TAKARA || ALPHA_EB164 || ALPHA_ALCOR || ALPHA_MIATA || ALPHA_LX164 || ALPHA_SX164 || ALPHA_NAUTILUS || ALPHA_NONAME
depends on TTY
default y if ALPHA_JENSEN || ALPHA_MIKASA || ALPHA_SABLE || ALPHA_LYNX || ALPHA_NORITAKE || ALPHA_DP264 || ALPHA_RAWHIDE || ALPHA_EIGER || ALPHA_WILDFIRE || ALPHA_TITAN || ALPHA_SHARK || ALPHA_MARVEL
---help---
help
There are two different types of booting firmware on Alphas: SRM,
which is command line driven, and ARC, which uses menus and arrow
keys. Details about the Linux/Alpha booting process are contained in
Expand All @@ -521,7 +521,7 @@ config ARCH_MAY_HAVE_PC_FDC
config SMP
bool "Symmetric multi-processing support"
depends on ALPHA_SABLE || ALPHA_LYNX || ALPHA_RAWHIDE || ALPHA_DP264 || ALPHA_WILDFIRE || ALPHA_TITAN || ALPHA_GENERIC || ALPHA_SHARK || ALPHA_MARVEL
---help---
help
This enables support for systems with more than one CPU. If you have
a system with only one CPU, say N. If you have a system with more
than one CPU, say Y.
Expand Down Expand Up @@ -569,7 +569,7 @@ config ALPHA_WTINT
default n if ALPHA_EV5 || ALPHA_EV56 || (ALPHA_EV4 && !ALPHA_LCA)
default n if !ALPHA_SRM && !ALPHA_GENERIC
default y if SMP
---help---
help
The Wait for Interrupt (WTINT) PALcall attempts to place the CPU
to sleep until the next interrupt. This may reduce the power
consumed, and the heat produced by the computer. However, it has
Expand All @@ -595,7 +595,7 @@ config NODES_SHIFT
# LARGE_VMALLOC is racy, if you *really* need it then fix it first
config ALPHA_LARGE_VMALLOC
bool
---help---
help
Process creation and other aspects of virtual memory management can
be streamlined if we restrict the kernel to one PGD for all vmalloc
allocations. This equates to about 8GB.
Expand All @@ -614,7 +614,7 @@ config VERBOSE_MCHECK_ON
int "Verbose Printing Mode (0=off, 1=on, 2=all)"
depends on VERBOSE_MCHECK
default 1
---help---
help
This option allows the default printing mode to be set, and then
possibly overridden by a boot command argument.

Expand All @@ -633,7 +633,7 @@ choice
default HZ_128 if ALPHA_QEMU
default HZ_1200 if ALPHA_RAWHIDE
default HZ_1024
---help---
help
The frequency at which timer interrupts occur. A high frequency
minimizes latency, whereas a low frequency minimizes overhead of
process accounting. The later effect is especially significant
Expand Down Expand Up @@ -668,7 +668,7 @@ config HZ
config SRM_ENV
tristate "SRM environment through procfs"
depends on PROC_FS
---help---
help
If you enable this option, a subdirectory inside /proc called
/proc/srm_environment will give you access to the all important
SRM environment variables (those which have a name) and also
Expand Down
2 changes: 1 addition & 1 deletion arch/alpha/Kconfig.debug
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ config ALPHA_LEGACY_START_ADDRESS
bool "Legacy kernel start address"
depends on ALPHA_GENERIC
default n
---help---
help
The 2.4 kernel changed the kernel start address from 0x310000
to 0x810000 to make room for the Wildfire's larger SRM console.
Recent consoles on Titan and Marvel machines also require the
Expand Down
2 changes: 1 addition & 1 deletion arch/arc/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ config NODES_SHIFT
default "0" if !DISCONTIGMEM
default "1" if DISCONTIGMEM
depends on NEED_MULTIPLE_NODES
---help---
help
Accessing memory beyond 1GB (with or w/o PAE) requires 2 memory
zones.

Expand Down
8 changes: 4 additions & 4 deletions arch/arm/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -1655,7 +1655,7 @@ config UACCESS_WITH_MEMCPY
config SECCOMP
bool
prompt "Enable seccomp to safely compute untrusted bytecode"
---help---
help
This kernel feature is useful for number crunching applications
that may need to compute untrusted bytecode during their
execution. By using pipes or other transports made available to
Expand Down Expand Up @@ -1963,7 +1963,7 @@ config EFI
select EFI_STUB
select EFI_GENERIC_STUB
select EFI_RUNTIME_WRAPPERS
---help---
help
This option provides support for runtime services provided
by UEFI firmware (such as non-volatile variables, realtime
clock, and platform reset). A UEFI stub is also provided to
Expand Down Expand Up @@ -2005,7 +2005,7 @@ comment "At least one emulation must be selected"
config FPE_NWFPE
bool "NWFPE math emulation"
depends on (!AEABI || OABI_COMPAT) && !THUMB2_KERNEL
---help---
help
Say Y to include the NWFPE floating point emulator in the kernel.
This is necessary to run most binaries. Linux does not currently
support floating point hardware so you need to say Y here even if
Expand All @@ -2029,7 +2029,7 @@ config FPE_NWFPE_XP
config FPE_FASTFPE
bool "FastFPE math emulation (EXPERIMENTAL)"
depends on (!AEABI || OABI_COMPAT) && !CPU_32v3
---help---
help
Say Y here to include the FAST floating point emulator in the kernel.
This is an experimental much faster emulator which now also has full
precision for the mantissa. It does not support any exceptions.
Expand Down
4 changes: 2 additions & 2 deletions arch/arm/Kconfig.debug
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ config ARM_PTDUMP_DEBUGFS
depends on MMU
select ARM_PTDUMP_CORE
select DEBUG_FS
---help---
help
Say Y here if you want to show the kernel pagetable layout in a
debugfs file. This information is only useful for kernel developers
who are working in architecture specific areas of the kernel.
Expand All @@ -21,7 +21,7 @@ config DEBUG_WX
bool "Warn on W+X mappings at boot"
depends on MMU
select ARM_PTDUMP_CORE
---help---
help
Generate a warning if any W+X mappings are found at boot.

This is useful for discovering cases where the kernel is leaving
Expand Down
2 changes: 1 addition & 1 deletion arch/arm/mach-footbridge/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ config ARCH_PERSONAL_SERVER
select ISA
select ISA_DMA
select FORCE_PCI
---help---
help
Say Y here if you intend to run this kernel on the Compaq
Personal Server.

Expand Down
4 changes: 2 additions & 2 deletions arch/arm64/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -1035,7 +1035,7 @@ config CC_HAVE_SHADOW_CALL_STACK

config SECCOMP
bool "Enable seccomp to safely compute untrusted bytecode"
---help---
help
This kernel feature is useful for number crunching applications
that may need to compute untrusted bytecode during their
execution. By using pipes or other transports made available to
Expand Down Expand Up @@ -1068,7 +1068,7 @@ config KEXEC
depends on PM_SLEEP_SMP
select KEXEC_CORE
bool "kexec system call"
---help---
help
kexec is a system call that implements the ability to shutdown your
current kernel, and to start another kernel. It is like a reboot
but it is independent of the system firmware. And like a reboot
Expand Down
6 changes: 3 additions & 3 deletions arch/arm64/kvm/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ source "virt/lib/Kconfig"

menuconfig VIRTUALIZATION
bool "Virtualization"
---help---
help
Say Y here to get to see options for using your Linux host to run
other operating systems inside virtual machines (guests).
This option alone does not add any kernel code.
Expand Down Expand Up @@ -40,7 +40,7 @@ menuconfig KVM
select HAVE_KVM_VCPU_RUN_PID_CHANGE
select TASKSTATS
select TASK_DELAY_ACCT
---help---
help
Support hosting virtualized guest machines.

If unsure, say N.
Expand All @@ -53,7 +53,7 @@ config KVM_ARM_PMU
bool "Virtual Performance Monitoring Unit (PMU) support"
depends on HW_PERF_EVENTS
default y
---help---
help
Adds support for a virtual Performance Monitoring Unit (PMU) in
virtual machines.

Expand Down
12 changes: 6 additions & 6 deletions arch/hexagon/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ config HEXAGON
select GENERIC_CLOCKEVENTS_BROADCAST
select MODULES_USE_ELF_RELA
select GENERIC_CPU_DEVICES
---help---
help
Qualcomm Hexagon is a processor architecture designed for high
performance and low power across a wide variety of applications.

config HEXAGON_PHYS_OFFSET
def_bool y
---help---
help
Platforms that don't load the kernel at zero set this.

config FRAME_POINTER
Expand Down Expand Up @@ -83,7 +83,7 @@ choice

config HEXAGON_COMET
bool "Comet Board"
---help---
help
Support for the Comet platform.

endchoice
Expand All @@ -104,15 +104,15 @@ config CMDLINE

config SMP
bool "Multi-Processing support"
---help---
help
Enables SMP support in the kernel. If unsure, say "Y"

config NR_CPUS
int "Maximum number of CPUs" if SMP
range 2 6 if SMP
default "1" if !SMP
default "6" if SMP
---help---
help
This allows you to specify the maximum number of CPUs which this
kernel will support. The maximum supported value is 6 and the
minimum value which makes sense is 2.
Expand All @@ -123,7 +123,7 @@ config NR_CPUS
choice
prompt "Kernel page size"
default PAGE_SIZE_4KB
---help---
help
Changes the default page size; use with caution.

config PAGE_SIZE_4KB
Expand Down
6 changes: 3 additions & 3 deletions arch/ia64/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ config HOTPLUG_CPU
bool "Support for hot-pluggable CPUs"
depends on SMP
default n
---help---
help
Say Y here to experiment with turning CPUs off and on. CPUs
can be controlled through /sys/devices/system/cpu/cpu#.
Say N if you want to disable CPU hotplug.
Expand All @@ -266,15 +266,15 @@ 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.

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.
Expand Down
6 changes: 3 additions & 3 deletions arch/m68k/Kconfig.cpu
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ config M68KFPU_EMU_ONLY
config ADVANCED
bool "Advanced configuration options"
depends on MMU
---help---
help
This gives you access to some advanced options for the CPU. The
defaults should be fine for most users, but these options may make
it possible for you to improve performance somewhat if you know what
Expand All @@ -358,7 +358,7 @@ config ADVANCED
config RMW_INSNS
bool "Use read-modify-write instructions"
depends on ADVANCED
---help---
help
This allows to use certain instructions that work with indivisible
read-modify-write bus cycles. While this is faster than the
workaround of disabling interrupts, it can conflict with DMA
Expand Down Expand Up @@ -386,7 +386,7 @@ config ARCH_DISCONTIGMEM_ENABLE
config 060_WRITETHROUGH
bool "Use write-through caching for 68060 supervisor accesses"
depends on ADVANCED && M68060
---help---
help
The 68060 generally uses copyback caching of recently accessed data.
Copyback caching means that memory writes will be held in an on-chip
cache and only written back to memory some time later. Saying Y
Expand Down
6 changes: 3 additions & 3 deletions arch/m68k/Kconfig.devices
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ config NFETH
config ATARI_ETHERNAT
bool "Atari EtherNAT Ethernet support"
depends on ATARI
---help---
help
Say Y to include support for the EtherNAT network adapter for the
CT/60 extension port.

Expand All @@ -69,7 +69,7 @@ config ATARI_ETHERNAT
config ATARI_ETHERNEC
bool "Atari EtherNEC Ethernet support"
depends on ATARI_ROM_ISA
---help---
help
Say Y to include support for the EtherNEC network adapter for the
ROM port. The driver works by polling instead of interrupts, so it
is quite slow.
Expand Down Expand Up @@ -120,7 +120,7 @@ config HPAPCI
config SERIAL_CONSOLE
bool "Support for serial port console"
depends on AMIGA_BUILTIN_SERIAL=y
---help---
help
If you say Y here, it will be possible to use a serial port as the
system console (the system console is the device which receives all
kernel messages and warnings and which allows logins in single user
Expand Down
2 changes: 1 addition & 1 deletion arch/m68k/Kconfig.machine
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,7 @@ config ROMSIZE

choice
prompt "Kernel executes from"
---help---
help
Choose the memory type that the kernel will be running in.

config RAMKERNEL
Expand Down
6 changes: 3 additions & 3 deletions arch/mips/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -2741,7 +2741,7 @@ config RELOCATION_TABLE_SIZE
depends on RELOCATABLE
range 0x0 0x01000000
default "0x00100000"
---help---
help
A table of relocation data will be appended to the kernel binary
and parsed at boot to fix up the relocated kernel.

Expand All @@ -2755,7 +2755,7 @@ config RELOCATION_TABLE_SIZE
config RANDOMIZE_BASE
bool "Randomize the address of the kernel image"
depends on RELOCATABLE
---help---
help
Randomizes the physical and virtual address at which the
kernel image is loaded, as a security feature that
deters exploit attempts relying on knowledge of the location
Expand All @@ -2773,7 +2773,7 @@ config RANDOMIZE_BASE_MAX_OFFSET
range 0x0 0x40000000 if EVA || 64BIT
range 0x0 0x08000000
default "0x01000000"
---help---
help
When kASLR is active, this provides the maximum offset that will
be applied to the kernel image. It should be set according to the
amount of physical RAM available in the target system minus
Expand Down
Loading

0 comments on commit a7f7f62

Please sign in to comment.