kconfig: Clean up header comments and make them consistent

Use this short header style in all Kconfig files: # <description> # <copyright> # <license> ... Also change all <description>s from # Kconfig[.extension] - Foo-related options to just # Foo-related options It's clear enough that it's about Kconfig. The <description> cleanup was done with this command, along with some manual cleanup (big letter at the start, etc.) git ls-files '*Kconfig*' | \ xargs sed -i -E '1 s/#\s*Kconfig[\w.-]*\s*-\s*/# /' Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
marcoster · Nov 4, 2019 · bd6e044 · bd6e044
1 parent 86360cb
commit bd6e044
Show file tree

Hide file tree

Showing 1,169 changed files with 1,769 additions and 4,167 deletions.
diff --git a/Kconfig b/Kconfig
@@ -1,10 +1,8 @@
-# Kconfig - general configuration options
+# General configuration options
 
-#
 # Copyright (c) 2014-2015 Wind River Systems, Inc.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
+
 mainmenu "Zephyr Kernel Configuration"
 
 source "Kconfig.zephyr"
diff --git a/Kconfig.zephyr b/Kconfig.zephyr
@@ -1,11 +1,8 @@
-# Kconfig - general configuration options
+# General configuration options
 
-#
 # Copyright (c) 2014-2015 Wind River Systems, Inc.
 # Copyright (c) 2016 Intel Corporation
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 menu "Modules"
 

diff --git a/arch/Kconfig b/arch/Kconfig
@@ -1,12 +1,9 @@
-# Kconfig - general architecture configuration options
+# General architecture configuration options
 
-#
 # Copyright (c) 2014-2015 Wind River Systems, Inc.
 # Copyright (c) 2015 Intel Corporation
 # Copyright (c) 2016 Cadence Design Systems, Inc.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 # Include these first so that any properties (e.g. defaults) below can be
 # overridden (by defining symbols in multiple locations)

diff --git a/arch/arc/Kconfig b/arch/arc/Kconfig
@@ -1,10 +1,7 @@
 # ARC options
 
-#
 # Copyright (c) 2014, 2019 Wind River Systems, Inc.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 menu "ARC Options"
 	depends on ARC

diff --git a/arch/arc/core/mpu/Kconfig b/arch/arc/core/mpu/Kconfig
@@ -1,10 +1,8 @@
-# Kconfig - Memory Protection Unit (MPU) configuration options
+# Memory Protection Unit (MPU) configuration options
 
-#
 # Copyright (c) 2017 Synopsys
-#
 # SPDX-License-Identifier: Apache-2.0
-#
+
 config ARC_MPU_VER
 	int "ARC MPU version"
 	range 2 4

diff --git a/arch/arm/Kconfig b/arch/arm/Kconfig
@@ -1,11 +1,7 @@
-# Kconfig - ARM architecture configuration options
+# ARM architecture configuration options
 
-#
 # Copyright (c) 2014-2015 Wind River Systems, Inc.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
-
 
 menu "ARM Options"
 	depends on ARM

diff --git a/arch/arm/core/Kconfig b/arch/arm/core/Kconfig
@@ -1,10 +1,7 @@
-# Kconfig - ARM core configuration options
+# ARM core configuration options
 
-#
 # Copyright (c) 2015 Wind River Systems, Inc.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 config CPU_CORTEX
 	bool

diff --git a/arch/arm/core/cortex_m/Kconfig b/arch/arm/core/cortex_m/Kconfig
@@ -1,10 +1,7 @@
-# Kconfig - ARM Cortex-M platform configuration options
+# ARM Cortex-M platform configuration options
 
-#
 # Copyright (c) 2014-2015 Wind River Systems, Inc.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 # NOTE: We have the specific core implementations first and outside of the
 # if CPU_CORTEX_M block so that SoCs can select which core they are using

diff --git a/arch/arm/core/cortex_m/mpu/Kconfig b/arch/arm/core/cortex_m/mpu/Kconfig
@@ -1,10 +1,7 @@
-# Kconfig - Memory Protection Unit (MPU) configuration options
+# Memory Protection Unit (MPU) configuration options
 
-#
 # Copyright (c) 2017 Linaro Limited
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 if CPU_HAS_MPU
 

diff --git a/arch/arm/core/cortex_m/tz/Kconfig b/arch/arm/core/cortex_m/tz/Kconfig
@@ -1,8 +1,6 @@
-# Kconfig - ARM TrustZone-M core configuration options
+# ARM TrustZone-M core configuration options
 
-#
 # Copyright (c) 2018 Nordic Semiconductor ASA.
-#
 # SPDX-License-Identifier: Apache-2.0
 
 config ARM_TRUSTZONE_M

diff --git a/arch/arm/core/cortex_r/Kconfig b/arch/arm/core/cortex_r/Kconfig
@@ -1,11 +1,8 @@
-# Kconfig - ARM Cortex-R platform configuration options
+# ARM Cortex-R platform configuration options
 
-#
 # Copyright (c) 2018 Marvell
 # Copyright (c) 2018 Lexmark International, Inc.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 # NOTE: We have the specific core implementations first and outside of the
 # if CPU_CORTEX_R block so that SoCs can select which core they are using

diff --git a/arch/nios2/Kconfig b/arch/nios2/Kconfig
@@ -1,8 +1,5 @@
-#
 # Copyright (c) 2016 Intel Corporation
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 menu "Nios II Options"
 	depends on NIOS2

diff --git a/arch/posix/Kconfig b/arch/posix/Kconfig
@@ -1,10 +1,7 @@
-# Kconfig - General configuration options
+# General configuration options
 
-#
 # Copyright (c) 2017 Intel Corporation
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 menu "POSIX (native) Options"
 	depends on ARCH_POSIX

diff --git a/arch/riscv/Kconfig b/arch/riscv/Kconfig
@@ -1,8 +1,5 @@
-#
 # Copyright (c) 2016 Jean-Paul Etienne <fractalclone@gmail.com>
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 menu "RISCV Options"
 	depends on RISCV

diff --git a/arch/x86/Kconfig b/arch/x86/Kconfig
@@ -1,5 +1,5 @@
-# Kconfig - x86 general configuration options
-#
+# x86 general configuration options
+
 # Copyright (c) 2014-2015 Wind River Systems, Inc.
 # SPDX-License-Identifier: Apache-2.0
 

diff --git a/arch/x86/core/Kconfig.ia32 b/arch/x86/core/Kconfig.ia32
@@ -1,5 +1,5 @@
-# Kconfig.ia32 - IA32-specific X86 subarchitecture options
-#
+# IA32-specific X86 subarchitecture options
+
 # Copyright (c) 2019 Intel Corp.
 # SPDX-License-Identifier: Apache-2.0
 

diff --git a/arch/x86/core/Kconfig.intel64 b/arch/x86/core/Kconfig.intel64
@@ -1,5 +1,5 @@
-# Kconfig.intel64 - Intel64-specific X86 subarchitecture options
-#
+# Intel64-specific X86 subarchitecture options
+
 # Copyright (c) 2019 Intel Corp.
 # SPDX-License-Identifier: Apache-2.0
 

diff --git a/arch/xtensa/Kconfig b/arch/xtensa/Kconfig
@@ -1,5 +1,5 @@
-# Kconfig - XTENSA architecture configuration options
-#
+# XTENSA architecture configuration options
+
 # Copyright (c) 2016 Cadence Design Systems, Inc.
 # SPDX-License-Identifier: Apache-2.0
 

diff --git a/boards/arc/em_starterkit/Kconfig b/boards/arc/em_starterkit/Kconfig
@@ -1,10 +1,7 @@
-# Kconfig - DesignWare ARC EM Starter Kit board configuration options
+# DesignWare ARC EM Starter Kit board configuration options
 
-#
 # Copyright (c) 2017 Synopsys, Inc. All rights reserved.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 if BOARD_EM_STARTERKIT
 

diff --git a/boards/arc/em_starterkit/Kconfig.board b/boards/arc/em_starterkit/Kconfig.board
@@ -1,9 +1,8 @@
-# Kconfig - DesignWare ARC EM Starter Kit board configuration
-#
+# DesignWare ARC EM Starter Kit board configuration
+
 # Copyright (c) 2016 Synopsys, Inc. All rights reserved.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
+
 config BOARD_EM_STARTERKIT
 	bool "ARC EM Starter Kit"
 	depends on SOC_EMSK

diff --git a/boards/arc/emsdp/Kconfig.board b/boards/arc/emsdp/Kconfig.board
@@ -1,9 +1,8 @@
-# Kconfig - DesignWare ARC EM Software Development Platform board configuration
-#
+# DesignWare ARC EM Software Development Platform board configuration
+
 # Copyright (c) 2019 Synopsys, Inc. All rights reserved.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
+
 config BOARD_EMSDP
 	bool "EM Software Development Platform"
 	depends on SOC_ARC_EMSDP

diff --git a/boards/arc/emsdp/Kconfig.defconfig b/boards/arc/emsdp/Kconfig.defconfig
@@ -1,9 +1,7 @@
-# Kconfig - DesignWare ARC EM Software Development Platform board configuration
-#
+# DesignWare ARC EM Software Development Platform board configuration
+
 # Copyright (c) 2019 Synopsys, Inc. All rights reserved.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 if BOARD_EMSDP
 

diff --git a/boards/arc/hsdk/Kconfig.board b/boards/arc/hsdk/Kconfig.board
@@ -1,9 +1,8 @@
-# Kconfig - DesignWare ARC HS Development Kit board configuration
-#
+# DesignWare ARC HS Development Kit board configuration
+
 # Copyright (c) 2019 Synopsys, Inc. All rights reserved.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
+
 config BOARD_HSDK
 	bool "ARC HS Development Kit"
 	depends on SOC_ARC_HSDK

diff --git a/boards/arc/hsdk/Kconfig.defconfig b/boards/arc/hsdk/Kconfig.defconfig
@@ -1,6 +1,4 @@
-#
 # Copyright (c) 2019 Synopsys, Inc. All rights reserved.
-#
 # SPDX-License-Identifier: Apache-2.0
 
 if BOARD_HSDK

diff --git a/boards/arc/iotdk/Kconfig.board b/boards/arc/iotdk/Kconfig.board
@@ -1,9 +1,8 @@
-# Kconfig - DesignWare ARC IoT Development Kit board configuration
-#
+# DesignWare ARC IoT Development Kit board configuration
+
 # Copyright (c) 2018 Synopsys, Inc. All rights reserved.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
+
 config BOARD_IOTDK
 	bool "ARC IoT Development Kit"
 	depends on SOC_ARC_IOT

diff --git a/boards/arc/nsim/Kconfig.board b/boards/arc/nsim/Kconfig.board
@@ -1,9 +1,8 @@
-# Kconfig - DesignWare ARC nSIM simulated platform configuration
-#
+# DesignWare ARC nSIM simulated platform configuration
+
 # Copyright (c) 2016, 2019 Synopsys, Inc. All rights reserved.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
+
 config BOARD_NSIM
 	bool "ARC nSIM simulator"
 	depends on SOC_NSIM

diff --git a/boards/arm/96b_argonkey/Kconfig.board b/boards/arm/96b_argonkey/Kconfig.board
@@ -1,9 +1,8 @@
-# Kconfig - 96Boards Argonkey Board Configuration
-#
+# 96Boards Argonkey Board Configuration
+
 # Copyright (c) 2018 STMicroelectronics
-#
 # SPDX-License-Identifier: Apache-2.0
-#
+
 config BOARD_96B_ARGONKEY
 	bool "96Boards Argonkey"
 	depends on SOC_STM32F412CG
diff --git a/boards/arm/96b_argonkey/Kconfig.defconfig b/boards/arm/96b_argonkey/Kconfig.defconfig
@@ -1,9 +1,7 @@
-# Kconfig - 96Boards Argonkey Board Configuration
-#
+# 96Boards Argonkey Board Configuration
+
 # Copyright (c) 2018 STMicroelectronics
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 if BOARD_96B_ARGONKEY
 

diff --git a/boards/arm/96b_avenger96/Kconfig.board b/boards/arm/96b_avenger96/Kconfig.board
@@ -1,9 +1,7 @@
-# Kconfig - 96Boards Avenger96 board configuration
-#
+# 96Boards Avenger96 board configuration
+
 # Copyright (c) 2019 Linaro Ltd.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 config BOARD_96B_AVENGER96
 	bool "96Boards Avenger96 Board"

diff --git a/boards/arm/96b_avenger96/Kconfig.defconfig b/boards/arm/96b_avenger96/Kconfig.defconfig
@@ -1,9 +1,7 @@
-# Kconfig - 96Boards Avenger96 board configuration
-#
+# 96Boards Avenger96 board configuration
+
 # Copyright (c) 2019 Linaro Ltd.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 if BOARD_96B_AVENGER96
 

diff --git a/boards/arm/96b_carbon/Kconfig.board b/boards/arm/96b_carbon/Kconfig.board
@@ -1,9 +1,7 @@
-# Kconfig - 96boards Carbon STMF401RE board configuration
-#
+# 96boards Carbon STMF401RE board configuration
+
 # Copyright (c) 2016 Linaro Limited.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 config BOARD_96B_CARBON
 	bool "96Boards Carbon (STM32F401)"

diff --git a/boards/arm/96b_carbon/Kconfig.defconfig b/boards/arm/96b_carbon/Kconfig.defconfig
@@ -1,9 +1,7 @@
-# Kconfig - 96boards Carbon board configuration
-#
+# 96boards Carbon board configuration
+
 # Copyright (c) 2016 Linaro Limited.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 if BOARD_96B_CARBON
 

diff --git a/boards/arm/96b_carbon_nrf51/Kconfig.board b/boards/arm/96b_carbon_nrf51/Kconfig.board
@@ -1,7 +1,6 @@
-# Kconfig - 96Boards Carbon nRF51 board configuration
-#
+# 96Boards Carbon nRF51 board configuration
+
 # Copyright (c) 2016, 2017 Linaro Limited.
-#
 # SPDX-License-Identifier: Apache-2.0
 
 config BOARD_96B_CARBON_NRF51

diff --git a/boards/arm/96b_carbon_nrf51/Kconfig.defconfig b/boards/arm/96b_carbon_nrf51/Kconfig.defconfig
@@ -1,7 +1,6 @@
-# Kconfig - 96Boards Carbon nRF51 board default configuration
-#
+# 96Boards Carbon nRF51 board default configuration
+
 # Copyright (c) 2016, 2017 Linaro Limited.
-#
 # SPDX-License-Identifier: Apache-2.0
 
 if BOARD_96B_CARBON_NRF51

diff --git a/boards/arm/96b_meerkat96/Kconfig.board b/boards/arm/96b_meerkat96/Kconfig.board
@@ -1,9 +1,7 @@
-# Kconfig - 96Boards Meerkat96 board
-#
+# 96Boards Meerkat96 board
+
 # Copyright (c) 2019, Linaro Ltd.
-#
 # SPDX-License-Identifier: Apache-2.0
-#
 
 config BOARD_96B_MEERKAT96
 	bool "96Boards Meerkat96 board"