From: Masami Hiramatsu <mhiramat@kernel.org>
To: Steven Rostedt <rostedt@goodmis.org>
Cc: LKML <linux-kernel@vger.kernel.org>,
Ingo Molnar <mingo@kernel.org>,
Devin Moore <devinmoore@google.com>
Subject: [PATCH v2 4/4] docs: bootconfig: Update for mixing value and subkeys
Date: Fri, 21 May 2021 15:35:00 +0900 [thread overview]
Message-ID: <162157890064.78209.16783417415944826941.stgit@devnote2> (raw)
In-Reply-To: <162157886618.78209.11141970623539574861.stgit@devnote2>
Update document for the mixing value and subkeys on a key.
Signed-off-by: Masami Hiramatsu <mhiramat@kernel.org>
---
Changes in v2:
- Update an example of mixing value and subkeys.
---
Documentation/admin-guide/bootconfig.rst | 30 ++++++++++++++++++++++++++----
1 file changed, 26 insertions(+), 4 deletions(-)
diff --git a/Documentation/admin-guide/bootconfig.rst b/Documentation/admin-guide/bootconfig.rst
index 452b7dcd7f6b..6a79f2e59396 100644
--- a/Documentation/admin-guide/bootconfig.rst
+++ b/Documentation/admin-guide/bootconfig.rst
@@ -89,13 +89,35 @@ you can use ``+=`` operator. For example::
In this case, the key ``foo`` has ``bar``, ``baz`` and ``qux``.
-However, a sub-key and a value can not co-exist under a parent key.
-For example, following config is NOT allowed.::
+Moreover, sub-keys and a value can coexist under a parent key.
+For example, following config is allowed.::
foo = value1
- foo.bar = value2 # !ERROR! subkey "bar" and value "value1" can NOT co-exist
- foo.bar := value2 # !ERROR! even with the override operator, this is NOT allowed.
+ foo.bar = value2
+ foo := value3 # This will update foo's value.
+
+Note, since there is no syntax to put a raw value directly under a
+structured key, you have to define it outside of the brace. For example::
+
+ foo {
+ bar = value1
+ bar {
+ baz = value2
+ qux = value3
+ }
+ }
+
+Also, the order of the value node under a key is fixed. If there
+are a value and subkeys, the value is always the first child node
+of the key. Thus if user specifies subkeys first, e.g.::
+
+ foo.bar = value1
+ foo = value2
+
+In the program (and /proc/bootconfig), it will be shown as below::
+ foo = value2
+ foo.bar = value1
Comments
--------
next prev parent reply other threads:[~2021-05-21 6:35 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-21 6:34 [PATCH v2 0/4] bootconfig: Add mixed subkeys and value under the same key Masami Hiramatsu
2021-05-21 6:34 ` [PATCH v2 1/4] bootconfig: Change array value to use child node Masami Hiramatsu
2021-05-21 6:34 ` [PATCH v2 2/4] bootconfig: Support mixing a value and subkeys under a key Masami Hiramatsu
2021-05-21 6:34 ` [PATCH v2 3/4] tools/bootconfig: Support mixed value and subkey test cases Masami Hiramatsu
2021-05-21 6:35 ` Masami Hiramatsu [this message]
2021-05-21 22:06 ` [PATCH v2 0/4] bootconfig: Add mixed subkeys and value under the same key Devin Moore
2021-05-22 1:55 ` Masami Hiramatsu
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=162157890064.78209.16783417415944826941.stgit@devnote2 \
--to=mhiramat@kernel.org \
--cc=devinmoore@google.com \
--cc=linux-kernel@vger.kernel.org \
--cc=mingo@kernel.org \
--cc=rostedt@goodmis.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 NNTP newsgroup(s).