Skip to content

Commit

Permalink
docs: bootconfig: Update for mixing value and subkeys
Browse files Browse the repository at this point in the history
Update document for the mixing value and subkeys on a key.

Link: https://lkml.kernel.org/r/162262196510.264090.15044943496205914148.stgit@devnote2

Signed-off-by: Masami Hiramatsu <mhiramat@kernel.org>
Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
  • Loading branch information
Masami Hiramatsu authored and Steven Rostedt (VMware) committed Jun 10, 2021
1 parent 29e1c1a commit 0ff2bb7
Showing 1 changed file with 26 additions and 4 deletions.
30 changes: 26 additions & 4 deletions Documentation/admin-guide/bootconfig.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand Down

0 comments on commit 0ff2bb7

Please sign in to comment.