Skip to content

Commit

Permalink
drivers: kconfig: unify menuconfig title strings
Browse files Browse the repository at this point in the history
Unify the drivers/*/Kconfig menuconfig title strings to the format
"<class> [(acronym)] [bus] drivers".

Including both the full name of the driver class and an acronym makes
menuconfig more user friendly as some of the acronyms are less well-known
than others. It also improves Kconfig search, both via menuconfig and via
the generated Kconfig documentation.

Signed-off-by: Henrik Brix Andersen <[email protected]>
  • Loading branch information
henrikbrixandersen authored and carlescufi committed Mar 28, 2023
1 parent f43c736 commit c41dd36
Show file tree
Hide file tree
Showing 62 changed files with 62 additions and 62 deletions.
2 changes: 1 addition & 1 deletion drivers/adc/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# ADC options
#
menuconfig ADC
bool "ADC drivers"
bool "Analog-to-Digital Converter (ADC) drivers"
# All platforms that implement the ADC driver are now required to
# provide relevant DTS entries.
help
Expand Down
2 changes: 1 addition & 1 deletion drivers/audio/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig AUDIO
bool "Support for Audio"
bool "Audio drivers"
help
Enable support for Audio

Expand Down
2 changes: 1 addition & 1 deletion drivers/bbram/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig BBRAM
bool "Battery-backed RAM drivers"
bool "Battery-backed RAM (BBRAM) drivers"
help
Enable BBRAM (battery-backed RAM) driver configuration.

Expand Down
2 changes: 1 addition & 1 deletion drivers/bluetooth/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
# Controller support is an HCI driver in itself, so these HCI driver
# options are only applicable if controller support hasn't been enabled.
menuconfig BT_DRIVERS
bool "Bluetooth Drivers"
bool "Bluetooth drivers"
default y
depends on BT && !BT_CTLR

Expand Down
2 changes: 1 addition & 1 deletion drivers/cache/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig CACHE
bool "External cache controllers drivers"
bool "External cache controller drivers"
default y if CACHE_MANAGEMENT
help
Enable support for external cache controllers drivers
Expand Down
2 changes: 1 addition & 1 deletion drivers/can/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# CAN options
#
menuconfig CAN
bool "CAN Drivers"
bool "Controller Area Network (CAN) drivers"
help
Enable CAN Driver Configuration

Expand Down
2 changes: 1 addition & 1 deletion drivers/clock_control/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Clock controller drivers
#
menuconfig CLOCK_CONTROL
bool "Hardware clock controller support"
bool "Clock controller drivers"
help
Enable support for hardware clock controller. Such hardware can
provide clock for other subsystem, and thus can be also used for
Expand Down
2 changes: 1 addition & 1 deletion drivers/coredump/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig COREDUMP_DEVICE
bool "Coredump pseudo-device driver"
bool "Coredump pseudo-device drivers"
help
Enable support for a pseudo-device to help capturing
desired data into core dumps.
Expand Down
2 changes: 1 addition & 1 deletion drivers/counter/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig COUNTER
bool "Counter Drivers"
bool "Counter drivers"
help
Enable support for counter and timer.

Expand Down
2 changes: 1 addition & 1 deletion drivers/crypto/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# CRYPTO options
#
menuconfig CRYPTO
bool "Crypto Drivers"
bool "Crypto drivers"

if CRYPTO

Expand Down
2 changes: 1 addition & 1 deletion drivers/dac/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# DAC options
#
menuconfig DAC
bool "DAC drivers"
bool "Digital-to-Analog Converter (DAC) drivers"
help
Enable DAC (Digital to Analog Converter) driver configuration.

Expand Down
2 changes: 1 addition & 1 deletion drivers/dai/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# DAI Drivers
#
menuconfig DAI
bool "DAI drivers"
bool "Digital Audio Interface (DAI) drivers"
help
Enable support for the DAI interface drivers.

Expand Down
2 changes: 1 addition & 1 deletion drivers/disk/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig DISK_DRIVERS
bool "Disk Drivers"
bool "Disk drivers"
help
Disk Driver configuration

Expand Down
2 changes: 1 addition & 1 deletion drivers/display/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig DISPLAY
bool "Display Drivers"
bool "Display controller drivers"
help
Enable display drivers

Expand Down
2 changes: 1 addition & 1 deletion drivers/dma/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# DMA options
#
menuconfig DMA
bool "DMA driver Configuration"
bool "Direct Memory Access (DMA) drivers"

if DMA
config DMA_64BIT
Expand Down
2 changes: 1 addition & 1 deletion drivers/edac/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# EDAC configuration options

menuconfig EDAC
bool "Error Detection and Correction (EDAC) Drivers"
bool "Error Detection and Correction (EDAC) drivers"
help
Enable Error Detection and Correction (EDAC) driver.

Expand Down
2 changes: 1 addition & 1 deletion drivers/eeprom/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig EEPROM
bool "EEPROM hardware support"
bool "Electrically Erasable Programmable Read-Only Memory (EEPROM) drivers"
help
Enable support for EEPROM hardware.

Expand Down
2 changes: 1 addition & 1 deletion drivers/entropy/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig ENTROPY_GENERATOR
bool "Entropy Drivers"
bool "Entropy drivers"
help
Include entropy drivers in system config.

Expand Down
2 changes: 1 addition & 1 deletion drivers/espi/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig ESPI
bool "ESPI Driver"
bool "Enhanced Serial Peripheral Interface (eSPI) bus drivers"
help
Enable ESPI Driver.

Expand Down
2 changes: 1 addition & 1 deletion drivers/ethernet/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig ETH_DRIVER
bool "Ethernet Drivers"
bool "Ethernet drivers"
default y
depends on NET_L2_ETHERNET

Expand Down
2 changes: 1 addition & 1 deletion drivers/flash/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ config FLASH_JESD216
devices to enable building a common support module.

menuconfig FLASH
bool "Flash hardware support"
bool "Flash drivers"
help
Enable support for the flash hardware.

Expand Down
2 changes: 1 addition & 1 deletion drivers/fpga/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig FPGA
bool "FPGA Drivers"
bool "Field-Programmable Gate Array (FPGA) drivers"
help
Enable support for FPGA drivers.

Expand Down
2 changes: 1 addition & 1 deletion drivers/gpio/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig GPIO
bool "GPIO Drivers"
bool "General-Purpose Input/Output (GPIO) drivers"
help
Include GPIO drivers in system config

Expand Down
2 changes: 1 addition & 1 deletion drivers/hwinfo/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig HWINFO
bool "Hardware Information driver"
bool "Hardware Information drivers"
help
Enable hwinfo driver.

Expand Down
2 changes: 1 addition & 1 deletion drivers/i2c/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# I2C options
#
menuconfig I2C
bool "I2C Drivers"
bool "Inter-Integrated Circuit (I2C) bus drivers"
help
Enable I2C Driver Configuration

Expand Down
2 changes: 1 addition & 1 deletion drivers/i2s/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# I2S Drivers
#
menuconfig I2S
bool "I2S bus drivers"
bool "Inter-IC Sound (I2S) bus drivers"
help
Enable support for the I2S (Inter-IC Sound) hardware bus.

Expand Down
2 changes: 1 addition & 1 deletion drivers/i3c/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig I3C
bool "I3C Drivers"
bool "Improved Inter-Integrated Circuit (I3C) bus drivers"
help
Enable I3C Driver Configuration

Expand Down
2 changes: 1 addition & 1 deletion drivers/ieee802154/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# IEEE 802.15.4 options
#
menuconfig IEEE802154
bool "IEEE 802.15.4 drivers options"
bool "IEEE 802.15.4 drivers"
depends on NETWORKING
default y if NET_L2_PHY_IEEE802154

Expand Down
2 changes: 1 addition & 1 deletion drivers/input/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

if INPUT

menu "Input Drivers"
menu "Input drivers"

source "drivers/input/Kconfig.gpio_keys"

Expand Down
2 changes: 1 addition & 1 deletion drivers/interrupt_controller/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Copyright (c) 2015 Intel Corporation
# SPDX-License-Identifier: Apache-2.0

menu "Interrupt Controllers"
menu "Interrupt controller drivers"

config ARCV2_INTERRUPT_UNIT
bool "ARCv2 Interrupt Unit"
Expand Down
2 changes: 1 addition & 1 deletion drivers/ipm/Kconfig
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig IPM
bool "IPM drivers"
bool "Inter-Processor Mailbox (IPM) drivers"
help
Include interrupt-based inter-processor mailboxes
drivers in system configuration
Expand Down
2 changes: 1 addition & 1 deletion drivers/kscan/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig KSCAN
bool "Keyboard Scan Drivers"
bool "Keyboard scan drivers"
help
Include Keyboard scan drivers in system config.

Expand Down
2 changes: 1 addition & 1 deletion drivers/led/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Top-level configuration file for LED drivers.

menuconfig LED
bool "LED drivers"
bool "Light-Emitting Diode (LED) drivers"
help
Include LED drivers in the system configuration.

Expand Down
2 changes: 1 addition & 1 deletion drivers/led_strip/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig LED_STRIP
bool "LED strip drivers"
bool "Light-Emitting Diode (LED) strip drivers"
help
Include LED strip drivers in the system configuration.

Expand Down
2 changes: 1 addition & 1 deletion drivers/lora/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Top-level configuration file for LORA drivers.

menuconfig LORA
bool "LoRa support [EXPERIMENTAL]"
bool "LoRa drivers [EXPERIMENTAL]"
select POLL
select EXPERIMENTAL
help
Expand Down
2 changes: 1 addition & 1 deletion drivers/mbox/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig MBOX
bool "MBOX drivers"
bool "Multi-Channel Inter-Processor Mailbox (MBOX) drivers"
help
Include multi-channel interrupt-based inter-processor mailboxes
drivers in system configuration
Expand Down
2 changes: 1 addition & 1 deletion drivers/mdio/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# MDIO options
#
menuconfig MDIO
bool "MDIO Drivers"
bool "Management Data Input/Output (MDIO) drivers"
help
Enable MDIO Driver Configuration

Expand Down
2 changes: 1 addition & 1 deletion drivers/memc/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig MEMC
bool "Memory controllers [EXPERIMENTAL]"
bool "Memory controller drivers [EXPERIMENTAL]"
select EXPERIMENTAL
help
Add support for memory controllers
Expand Down
2 changes: 1 addition & 1 deletion drivers/mipi_dsi/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig MIPI_DSI
bool "MIPI-DSI Host Controllers [EXPERIMENTAL]"
bool "MIPI-DSI Host Controller drivers [EXPERIMENTAL]"
select EXPERIMENTAL
help
Add support for MIPI-DSI host controllers
Expand Down
2 changes: 1 addition & 1 deletion drivers/mm/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig MM_DRV
bool "Memory Management Drivers [EXPERIMENTAL]"
bool "Memory Management drivers [EXPERIMENTAL]"
select EXPERIMENTAL
select KERNEL_VM_SUPPORT
help
Expand Down
2 changes: 1 addition & 1 deletion drivers/modem/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig MODEM
bool "Modem Drivers"
bool "Modem drivers"
help
Enable config options for modem drivers.

Expand Down
2 changes: 1 addition & 1 deletion drivers/net/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig NET_DRIVERS
bool "Network Drivers"
bool "Network drivers"

if NET_DRIVERS

Expand Down
2 changes: 1 addition & 1 deletion drivers/neural_net/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig NEURAL_NET_ACCEL
bool "Neural Network Accelerator Drivers"
bool "Neural Network Accelerator drivers"
help
Enable support for Neural Network Accelerators

Expand Down
2 changes: 1 addition & 1 deletion drivers/peci/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: Apache-2.0

menuconfig PECI
bool "PECI Driver"
bool "Platform Environment Control Interface (PECI) drivers"
help
Include PECI drivers in system config.

Expand Down
Loading

0 comments on commit c41dd36

Please sign in to comment.