Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

kconfig: Make header comments consistent globally #20280

Merged

Conversation

ulfalizer
Copy link
Collaborator

@ulfalizer ulfalizer commented Nov 1, 2019

Similar deal to #20266,
cleaning up all header comments to use a consistent format. Also includes some
stuff I missed in the first PR.

Main commit:

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*/# /'

Other stuff:

kconfig: Clean up 'config  FOO' (two spaces) definitions

Must've been copy-pasted around.
kconfig: Change some '#Comment' comments to '# Comment'

For consistency. Newly-introduced stuff.

@nashif nashif merged commit 39f2281 into zephyrproject-rtos:master Nov 4, 2019
@finikorg
Copy link
Collaborator

finikorg commented Nov 5, 2019

@ulfalizer Could you document templates in the Zephyr documentation?

Added documentation for the header format. See the new doc: kconfig: Document recommended header format commit.

Thanks! That is what I meant.

ulfalizer added a commit to ulfalizer/zephyr that referenced this pull request Nov 18, 2019
Same deal as in zephyrproject-rtos#20280,
for newly-introduced stuff.

Will avoid failures with the new CI test in
zephyrproject-rtos/ci-tools#112, though it only
checks changed files.

Also fix some un-indented properties on choices. Choice properties work
the same as symbol properties syntactically.

Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
nashif pushed a commit that referenced this pull request Nov 19, 2019
Same deal as in #20280,
for newly-introduced stuff.

Will avoid failures with the new CI test in
zephyrproject-rtos/ci-tools#112, though it only
checks changed files.

Also fix some un-indented properties on choices. Choice properties work
the same as symbol properties syntactically.

Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

10 participants