* [PATCH 0/3] bootconfig: tracing: Fix documentations of bootconfig and boot-time tracing
@ 2020-01-20 3:22 Masami Hiramatsu
2020-01-20 3:23 ` [PATCH 1/3] bootconfig: Fix Kconfig help message for BOOT_CONFIG Masami Hiramatsu
` (3 more replies)
0 siblings, 4 replies; 5+ messages in thread
From: Masami Hiramatsu @ 2020-01-20 3:22 UTC (permalink / raw
To: Steven Rostedt
Cc: Ingo Molnar, Randy Dunlap, Frank Rowand, Namhyung Kim, Tim Bird,
Jiri Olsa, Arnaldo Carvalho de Melo, Tom Zanussi, Rob Herring,
Andrew Morton, Thomas Gleixner, Greg Kroah-Hartman,
Alexey Dobriyan, Jonathan Corbet, Linus Torvalds, linux-doc,
linux-fsdevel, linux-kernel
Hi,
Here is the bootconfig and boot-time tracing documentation fix
and updates. These can be applied on the latest tracing tree.
Thanks for Randy about reporting and suggesting these fixes!
Thank you,
---
Masami Hiramatsu (3):
bootconfig: Fix Kconfig help message for BOOT_CONFIG
Documentation: bootconfig: Fix typos in bootconfig documentation
Documentation: tracing: Fix typos in boot-time tracing documentation
Documentation/admin-guide/bootconfig.rst | 32 ++++++++++++++++--------------
Documentation/trace/boottime-trace.rst | 18 ++++++++---------
init/Kconfig | 4 +++-
3 files changed, 29 insertions(+), 25 deletions(-)
--
Masami Hiramatsu <mhiramat@kernel.org>
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH 1/3] bootconfig: Fix Kconfig help message for BOOT_CONFIG
2020-01-20 3:22 [PATCH 0/3] bootconfig: tracing: Fix documentations of bootconfig and boot-time tracing Masami Hiramatsu
@ 2020-01-20 3:23 ` Masami Hiramatsu
2020-01-20 3:23 ` [PATCH 2/3] Documentation: bootconfig: Fix typos in bootconfig documentation Masami Hiramatsu
` (2 subsequent siblings)
3 siblings, 0 replies; 5+ messages in thread
From: Masami Hiramatsu @ 2020-01-20 3:23 UTC (permalink / raw
To: Steven Rostedt
Cc: Ingo Molnar, Randy Dunlap, Frank Rowand, Namhyung Kim, Tim Bird,
Jiri Olsa, Arnaldo Carvalho de Melo, Tom Zanussi, Rob Herring,
Andrew Morton, Thomas Gleixner, Greg Kroah-Hartman,
Alexey Dobriyan, Jonathan Corbet, Linus Torvalds, linux-doc,
linux-fsdevel, linux-kernel
Fix Kconfig help message since the bootconfig file is
only available to be appended to initramfs. And also
add a reference to the documentation.
Reported-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Masami Hiramatsu <mhiramat@kernel.org>
---
init/Kconfig | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/init/Kconfig b/init/Kconfig
index ffd240fb88c3..9506299a53e3 100644
--- a/init/Kconfig
+++ b/init/Kconfig
@@ -1223,7 +1223,9 @@ config BOOT_CONFIG
help
Extra boot config allows system admin to pass a config file as
complemental extension of kernel cmdline when booting.
- The boot config file is usually attached at the end of initramfs.
+ The boot config file must be attached at the end of initramfs
+ with checksum and size.
+ See <file:Documentation/admin-guide/bootconfig.rst> for details.
If unsure, say Y.
^ permalink raw reply related [flat|nested] 5+ messages in thread
* [PATCH 2/3] Documentation: bootconfig: Fix typos in bootconfig documentation
2020-01-20 3:22 [PATCH 0/3] bootconfig: tracing: Fix documentations of bootconfig and boot-time tracing Masami Hiramatsu
2020-01-20 3:23 ` [PATCH 1/3] bootconfig: Fix Kconfig help message for BOOT_CONFIG Masami Hiramatsu
@ 2020-01-20 3:23 ` Masami Hiramatsu
2020-01-20 3:23 ` [PATCH 3/3] Documentation: tracing: Fix typos in boot-time tracing documentation Masami Hiramatsu
2020-01-20 23:54 ` [PATCH 0/3] bootconfig: tracing: Fix documentations of bootconfig and boot-time tracing Randy Dunlap
3 siblings, 0 replies; 5+ messages in thread
From: Masami Hiramatsu @ 2020-01-20 3:23 UTC (permalink / raw
To: Steven Rostedt
Cc: Ingo Molnar, Randy Dunlap, Frank Rowand, Namhyung Kim, Tim Bird,
Jiri Olsa, Arnaldo Carvalho de Melo, Tom Zanussi, Rob Herring,
Andrew Morton, Thomas Gleixner, Greg Kroah-Hartman,
Alexey Dobriyan, Jonathan Corbet, Linus Torvalds, linux-doc,
linux-fsdevel, linux-kernel
Fix typos in bootconfig.rst according to Randy's suggestions.
Suggested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Masami Hiramatsu <mhiramat@kernel.org>
---
Documentation/admin-guide/bootconfig.rst | 32 ++++++++++++++++--------------
1 file changed, 17 insertions(+), 15 deletions(-)
diff --git a/Documentation/admin-guide/bootconfig.rst b/Documentation/admin-guide/bootconfig.rst
index c8f7cd4cf44e..4d617693c0c8 100644
--- a/Documentation/admin-guide/bootconfig.rst
+++ b/Documentation/admin-guide/bootconfig.rst
@@ -11,20 +11,22 @@ Boot Configuration
Overview
========
-The boot configuration is expanding current kernel cmdline to support
-additional key-value data when boot the kernel in an efficient way.
-This allows adoministrators to pass a structured-Key config file.
+The boot configuration expands the current kernel command line to support
+additional key-value data when booting the kernel in an efficient way.
+This allows administrators to pass a structured-Key config file.
Config File Syntax
==================
The boot config syntax is a simple structured key-value. Each key consists
-of dot-connected-words, and key and value are connected by "=". The value
+of dot-connected-words, and key and value are connected by ``=``. The value
has to be terminated by semi-colon (``;``) or newline (``\n``).
For array value, array entries are separated by comma (``,``). ::
KEY[.WORD[...]] = VALUE[, VALUE2[...]][;]
+Unlike the kernel command line syntax, spaces are OK around the comma and ``=``.
+
Each key word must contain only alphabets, numbers, dash (``-``) or underscore
(``_``). And each value only contains printable characters or spaces except
for delimiters such as semi-colon (``;``), new-line (``\n``), comma (``,``),
@@ -35,7 +37,7 @@ quotes (``"VALUE"``) or single-quotes (``'VALUE'``) to quote it. Note that
you can not escape these quotes.
There can be a key which doesn't have value or has an empty value. Those keys
-are used for checking the key exists or not (like a boolean).
+are used for checking if the key exists or not (like a boolean).
Key-Value Syntax
----------------
@@ -63,7 +65,7 @@ at boot time. So you can append similar trees or key-values.
Comments
--------
-The config syntax accepts shell-script style comments. The comments start
+The config syntax accepts shell-script style comments. The comments starting
with hash ("#") until newline ("\n") will be ignored.
::
@@ -108,7 +110,7 @@ update the boot loader and the kernel image itself.
To do this operation, Linux kernel provides "bootconfig" command under
tools/bootconfig, which allows admin to apply or delete the config file
-to/from initrd image. You can build it by follwoing command::
+to/from initrd image. You can build it by the following command::
# make -C tools/bootconfig
@@ -122,7 +124,7 @@ To remove the config from the image, you can use -d option as below::
# tools/bootconfig/bootconfig -d /boot/initrd.img-X.Y.Z
-C onfig File Limitation
+Config File Limitation
======================
Currently the maximum config size size is 32KB and the total key-words (not
@@ -145,10 +147,10 @@ User can query or loop on key-value pairs, also it is possible to find
a root (prefix) key node and find key-values under that node.
If you have a key string, you can query the value directly with the key
-using xbc_find_value(). If you want to know what keys exist in the SKC
-tree, you can use xbc_for_each_key_value() to iterate key-value pairs.
+using xbc_find_value(). If you want to know what keys exist in the boot
+config, you can use xbc_for_each_key_value() to iterate key-value pairs.
Note that you need to use xbc_array_for_each_value() for accessing
-each arraies value, e.g.::
+each array's value, e.g.::
vnode = NULL;
xbc_find_value("key.word", &vnode);
@@ -157,8 +159,8 @@ each arraies value, e.g.::
printk("%s ", value);
}
-If you want to focus on keys which has a prefix string, you can use
-xbc_find_node() to find a node which prefix key words, and iterate
+If you want to focus on keys which have a prefix string, you can use
+xbc_find_node() to find a node by the prefix string, and iterate
keys under the prefix node with xbc_node_for_each_key_value().
But the most typical usage is to get the named value under prefix
@@ -174,8 +176,8 @@ or get the named array under prefix as below::
This accesses a value of "key.prefix.option" and an array of
"key.prefix.array-option".
-Locking is not needed, since after initialized, the config becomes readonly.
-All data and keys must be copied if you need to modify it.
+Locking is not needed, since after initialization, the config becomes
+read-only. All data and keys must be copied if you need to modify it.
Functions and structures
^ permalink raw reply related [flat|nested] 5+ messages in thread
* [PATCH 3/3] Documentation: tracing: Fix typos in boot-time tracing documentation
2020-01-20 3:22 [PATCH 0/3] bootconfig: tracing: Fix documentations of bootconfig and boot-time tracing Masami Hiramatsu
2020-01-20 3:23 ` [PATCH 1/3] bootconfig: Fix Kconfig help message for BOOT_CONFIG Masami Hiramatsu
2020-01-20 3:23 ` [PATCH 2/3] Documentation: bootconfig: Fix typos in bootconfig documentation Masami Hiramatsu
@ 2020-01-20 3:23 ` Masami Hiramatsu
2020-01-20 23:54 ` [PATCH 0/3] bootconfig: tracing: Fix documentations of bootconfig and boot-time tracing Randy Dunlap
3 siblings, 0 replies; 5+ messages in thread
From: Masami Hiramatsu @ 2020-01-20 3:23 UTC (permalink / raw
To: Steven Rostedt
Cc: Ingo Molnar, Randy Dunlap, Frank Rowand, Namhyung Kim, Tim Bird,
Jiri Olsa, Arnaldo Carvalho de Melo, Tom Zanussi, Rob Herring,
Andrew Morton, Thomas Gleixner, Greg Kroah-Hartman,
Alexey Dobriyan, Jonathan Corbet, Linus Torvalds, linux-doc,
linux-fsdevel, linux-kernel
Fix typos in boottime-trace.rst according to Randy's suggestions.
Suggested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Masami Hiramatsu <mhiramat@kernel.org>
---
Documentation/trace/boottime-trace.rst | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/Documentation/trace/boottime-trace.rst b/Documentation/trace/boottime-trace.rst
index 1d10fdebf1b2..dcb390075ca1 100644
--- a/Documentation/trace/boottime-trace.rst
+++ b/Documentation/trace/boottime-trace.rst
@@ -13,7 +13,7 @@ Boot-time tracing allows users to trace boot-time process including
device initialization with full features of ftrace including per-event
filter and actions, histograms, kprobe-events and synthetic-events,
and trace instances.
-Since kernel cmdline is not enough to control these complex features,
+Since kernel command line is not enough to control these complex features,
this uses bootconfig file to describe tracing feature programming.
Options in the Boot Config
@@ -21,7 +21,7 @@ Options in the Boot Config
Here is the list of available options list for boot time tracing in
boot config file [1]_. All options are under "ftrace." or "kernel."
-refix. See kernel parameters for the options which starts
+prefix. See kernel parameters for the options which starts
with "kernel." prefix [2]_.
.. [1] See :ref:`Documentation/admin-guide/bootconfig.rst <bootconfig>`
@@ -50,7 +50,7 @@ kernel.fgraph_filters = FILTER[, FILTER2...]
Add fgraph tracing function filters.
kernel.fgraph_notraces = FILTER[, FILTER2...]
- Add fgraph non tracing function filters.
+ Add fgraph non-tracing function filters.
Ftrace Per-instance Options
@@ -81,10 +81,10 @@ ftrace.[instance.INSTANCE.]tracer = TRACER
Set TRACER to current tracer on boot. (e.g. function)
ftrace.[instance.INSTANCE.]ftrace.filters
- This will take an array of tracing function filter rules
+ This will take an array of tracing function filter rules.
ftrace.[instance.INSTANCE.]ftrace.notraces
- This will take an array of NON-tracing function filter rules
+ This will take an array of NON-tracing function filter rules.
Ftrace Per-Event Options
@@ -93,7 +93,7 @@ Ftrace Per-Event Options
These options are setting per-event options.
ftrace.[instance.INSTANCE.]event.GROUP.EVENT.enable
- Enables GROUP:EVENT tracing.
+ Enable GROUP:EVENT tracing.
ftrace.[instance.INSTANCE.]event.GROUP.EVENT.filter = FILTER
Set FILTER rule to the GROUP:EVENT.
@@ -145,10 +145,10 @@ below::
}
}
-Also, boottime tracing supports "instance" node, which allows us to run
+Also, boot-time tracing supports "instance" node, which allows us to run
several tracers for different purpose at once. For example, one tracer
-is for tracing functions start with "user\_", and others tracing "kernel\_"
-functions, you can write boot config as below::
+is for tracing functions starting with "user\_", and others tracing
+"kernel\_" functions, you can write boot config as below::
ftrace.instance {
foo {
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH 0/3] bootconfig: tracing: Fix documentations of bootconfig and boot-time tracing
2020-01-20 3:22 [PATCH 0/3] bootconfig: tracing: Fix documentations of bootconfig and boot-time tracing Masami Hiramatsu
` (2 preceding siblings ...)
2020-01-20 3:23 ` [PATCH 3/3] Documentation: tracing: Fix typos in boot-time tracing documentation Masami Hiramatsu
@ 2020-01-20 23:54 ` Randy Dunlap
3 siblings, 0 replies; 5+ messages in thread
From: Randy Dunlap @ 2020-01-20 23:54 UTC (permalink / raw
To: Masami Hiramatsu, Steven Rostedt
Cc: Ingo Molnar, Frank Rowand, Namhyung Kim, Tim Bird, Jiri Olsa,
Arnaldo Carvalho de Melo, Tom Zanussi, Rob Herring, Andrew Morton,
Thomas Gleixner, Greg Kroah-Hartman, Alexey Dobriyan,
Jonathan Corbet, Linus Torvalds, linux-doc, linux-fsdevel,
linux-kernel
On 1/19/20 7:22 PM, Masami Hiramatsu wrote:
> Hi,
>
> Here is the bootconfig and boot-time tracing documentation fix
> and updates. These can be applied on the latest tracing tree.
>
> Thanks for Randy about reporting and suggesting these fixes!
>
> Thank you,
>
> ---
for all 3 patches:
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.
>
> Masami Hiramatsu (3):
> bootconfig: Fix Kconfig help message for BOOT_CONFIG
> Documentation: bootconfig: Fix typos in bootconfig documentation
> Documentation: tracing: Fix typos in boot-time tracing documentation
>
>
> Documentation/admin-guide/bootconfig.rst | 32 ++++++++++++++++--------------
> Documentation/trace/boottime-trace.rst | 18 ++++++++---------
> init/Kconfig | 4 +++-
> 3 files changed, 29 insertions(+), 25 deletions(-)
>
> --
> Masami Hiramatsu <mhiramat@kernel.org>
>
--
~Randy
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2020-01-20 23:54 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-01-20 3:22 [PATCH 0/3] bootconfig: tracing: Fix documentations of bootconfig and boot-time tracing Masami Hiramatsu
2020-01-20 3:23 ` [PATCH 1/3] bootconfig: Fix Kconfig help message for BOOT_CONFIG Masami Hiramatsu
2020-01-20 3:23 ` [PATCH 2/3] Documentation: bootconfig: Fix typos in bootconfig documentation Masami Hiramatsu
2020-01-20 3:23 ` [PATCH 3/3] Documentation: tracing: Fix typos in boot-time tracing documentation Masami Hiramatsu
2020-01-20 23:54 ` [PATCH 0/3] bootconfig: tracing: Fix documentations of bootconfig and boot-time tracing Randy Dunlap
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.