michaelh/zephyr
1
0
Fork 0
Code Releases Activity

kconfig: Clean up header comments and make them consistent

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

5
subsys/shell/Kconfig
View file

@ -1,12 +1,9 @@
# Kconfig - Shell configuration options
# Shell configuration options
#
# Copyright (c) 2014-2015 Wind River Systems, Inc.
# Copyright (c) 2016 Intel Corporation
# Copyright (c) 2018 Nordic Semiconductor ASA
#
# SPDX-License-Identifier: Apache-2.0
#
menuconfig SHELL
bool "Shell"

5
subsys/shell/Kconfig.backends
View file

@ -1,10 +1,7 @@
# Kconfig.backends - Shell badckends configuration options
# Shell badckends configuration options
#
# Copyright (c) 2018 Nordic Semiconductor ASA
#
# SPDX-License-Identifier: Apache-2.0
#
menuconfig SHELL_BACKENDS
bool "Enable shell backends"

6
subsys/shell/modules/Kconfig
View file

@ -1,11 +1,7 @@
# Kconfig - Shell configuration options
# Shell configuration options
#
# Copyright (c) 2016 Intel Corporation
#
# SPDX-License-Identifier: Apache-2.0
#
config KERNEL_SHELL
bool "Enable kernel shell"