[PATCH] kconfig: document Kconfig source file comments
From: Randy Dunlap
Date: Fri Jun 22 2018 - 23:08:54 EST
From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
I saw this type of Kconfig construct on LKML:
config SYMBOOL
#bool "prompt string"
default y
and wondered what it does. Then I wondered if '#' comments are
even documented. They aren't, so add a little doc for that.
Ah, good. kconfig says:
arch/x86/Kconfig:2942:warning: config symbol defined without type
Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
---
Documentation/kbuild/kconfig-language.txt | 6 ++++++
1 file changed, 6 insertions(+)
--- lnx-418-rc1.orig/Documentation/kbuild/kconfig-language.txt
+++ lnx-418-rc1/Documentation/kbuild/kconfig-language.txt
@@ -430,6 +430,12 @@ This sets the config program's title bar
to use it. It should be placed at the top of the configuration, before any
other statement.
+'#' Kconfig source file comment:
+
+An unquoted '#' character anywhere in a source file line indicates
+the beginning of a source file comment. The remainder of that line
+is a comment.
+
Kconfig hints
-------------