From: Prasad Pandit <pjp@xxxxxxxxxxxxxxxxx> Add details to the 'config' and 'source' entry description, to make it unambiguous. It'd come handy as reference for Kconfig language or patch reviews for Kconfig source files. Signed-off-by: Prasad Pandit <pjp@xxxxxxxxxxxxxxxxx> --- Documentation/kbuild/kconfig-language.rst | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) v1: - Fix typo path -> patch - https://lore.kernel.org/linux-kbuild/20240404064037.3440433-1-ppandit@xxxxxxxxxx/T/#u diff --git a/Documentation/kbuild/kconfig-language.rst b/Documentation/kbuild/kconfig-language.rst index 0135905c0aa3..0783850d5a00 100644 --- a/Documentation/kbuild/kconfig-language.rst +++ b/Documentation/kbuild/kconfig-language.rst @@ -39,11 +39,14 @@ them. A single configuration option is defined like this:: kernel. ... Every line starts with a key word and can be followed by multiple -arguments. "config" starts a new config entry. The following lines -define attributes for this config option. Attributes can be the type of -the config option, input prompt, dependencies, help text and default -values. A config option can be defined multiple times with the same -name, but every definition can have only a single input prompt and the +arguments. "config" starts a new config entry. The following lines, +indented by a leading tab (\t) character, define attributes for this +config option. Attributes can be the type of the config option, +input prompt, dependencies, default values and help text. Help text +is further indented by two more spaces. + +A config option can be defined multiple times with the same name, +but every definition can have only a single input prompt and the type must not conflict. Menu attributes @@ -451,6 +454,11 @@ source:: "source" <prompt> This reads the specified configuration file. This file is always parsed. +The specified file path is from the top source directory ($SRCTREE). +It allows one to source a file from any subdirectory under the source +tree. Such path is always unique under the source directory. +A configuration file must terminate with a new line (\n) character +at the end. mainmenu:: -- 2.44.0
