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>
This commit is contained in:
Ulf Magnusson 2019-11-01 13:45:29 +01:00 committed by Anas Nashif
commit bd6e04411e
1169 changed files with 1785 additions and 4183 deletions

View file

@ -1,10 +1,7 @@
# Kconfig - CAN configuration options
# CAN configuration options
#
# Copyright (c) 2018 Alexander Wachter
#
# SPDX-License-Identifier: Apache-2.0
#
#
# CAN options

View file

@ -1,10 +1,7 @@
# Kconfig.loopback - CAN loopback device configuration options
# CAN loopback device configuration options
#
# Copyright (c) 2019 Alexander Wachter
#
# SPDX-License-Identifier: Apache-2.0
#
config CAN_LOOPBACK
bool "Loopback CAN driver"

View file

@ -1,10 +1,7 @@
# Kconfig.mcp2515 - MCP2515 CAN configuration options
# MCP2515 CAN configuration options
#
# Copyright (c) 2018 Karsten Koenig
#
# SPDX-License-Identifier: Apache-2.0
#
config CAN_MCP2515
bool "MCP2515 CAN Driver"

View file

@ -1,10 +1,7 @@
# Kconfig.mcux - MCUX CAN configuration options
# MCUX CAN configuration options
#
# Copyright (c) 2019 Vestas Wind Systems A/S
#
# SPDX-License-Identifier: Apache-2.0
#
config CAN_MCUX_FLEXCAN
bool "MCUX FlexCAN driver"

View file

@ -1,10 +1,7 @@
# Kconfig.net - Configuration options for IPv6 over CAN
# Configuration options for IPv6 over CAN
#
# Copyright (c) 2019 Alexander Wachter
#
# SPDX-License-Identifier: Apache-2.0
#
config CAN_NET
bool "Enable 6loCAN network interface [EXPERIMENTAL]"

View file

@ -1,10 +1,7 @@
# Kconfig.stm32 - STM32 CAN configuration options
# STM32 CAN configuration options
#
# Copyright (c) 2018 Alexander Wachter
#
# SPDX-License-Identifier: Apache-2.0
#
config CAN_STM32
bool "STM32 CAN Driver"