From: Prasad Pandit <ppandit@redhat.com>
To: Masahiro Yamada <masahiroy@kernel.org>
Cc: linux-kbuild@vger.kernel.org, Prasad Pandit <pjp@fedoraproject.org>
Subject: [PATCH v1] kconfig: add config and source entry details
Date: Sun, 7 Apr 2024 12:59:33 +0530 [thread overview]
Message-ID: <20240407072933.3562124-1-ppandit@redhat.com> (raw)
From: Prasad Pandit <pjp@fedoraproject.org>
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@fedoraproject.org>
---
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@redhat.com/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
next reply other threads:[~2024-04-07 7:29 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-07 7:29 Prasad Pandit [this message]
2024-04-16 6:50 ` [PATCH v1] kconfig: add config and source entry details Prasad Pandit
2024-04-16 11:48 ` Masahiro Yamada
2024-04-17 6:29 ` Prasad Pandit
2024-04-20 7:24 ` Masahiro Yamada
2024-04-23 6:16 ` Prasad Pandit
2024-04-23 10:10 ` Masahiro Yamada
2024-04-24 5:25 ` Prasad Pandit
2024-04-26 19:21 ` Masahiro Yamada
2024-04-30 7:36 ` Prasad Pandit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240407072933.3562124-1-ppandit@redhat.com \
--to=ppandit@redhat.com \
--cc=linux-kbuild@vger.kernel.org \
--cc=masahiroy@kernel.org \
--cc=pjp@fedoraproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).