bootconfig: tracing: Fix documentations of bootconfig and boot-time tracing
Subsystems (4)
Masami Hiramatsu
maintainercover bootconfig: tracing: Fix documentations of bootconfig and boot-time tracing
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 <[email protected]>
Masami Hiramatsu
maintainerPATCH 1/3 bootconfig: Fix Kconfig help message for BOOT_CONFIG
Fix Kconfig help message since the bootconfig file is only available to be appended to initramfs. And also add a reference to the documentation.
--- init/Kconfig | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
init/Kconfig +3 -1
@@ -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.
Masami Hiramatsu
maintainerPATCH 2/3 Documentation: bootconfig: Fix typos in bootconfig documentation
In reply to Masami HiramatsuFix typos in bootconfig.rst according to Randy's suggestions.
--- Documentation/admin-guide/bootconfig.rst | 32 ++++++++++++++++-------------- 1 file changed, 17 insertions(+), 15 deletions(-)
Documentation/admin-guide/bootconfig.rst +17 -15
@@ -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
Masami Hiramatsu
maintainerPATCH 3/3 Documentation: tracing: Fix typos in boot-time tracing documentation
In reply to Masami HiramatsuFix typos in boottime-trace.rst according to Randy's suggestions.
--- Documentation/trace/boottime-trace.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-)
Documentation/trace/boottime-trace.rst +9 -9
@@ -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 {
Quoted 10 lines · Masami Hiramatsu
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:
Thanks.
Quoted 15 lines
Masami Hiramatsu (3):
bootconfig: FixKconfighelp message forBOOT_CONFIG
Documentation: bootconfig: Fix typos in bootconfig documentation
Documentation: tracing: Fix typos in boot-time tracing documentationDocumentation/admin-guide/bootconfig.rst | 32 ++++++++++++++++-------------- Documentation/trace/boottime-trace.rst | 18 ++++++++--------- init/Kconfig | 4 +++- 3 files changed, 29 insertions(+), 25 deletions(-)--
Masami Hiramatsu <[email protected]>
Signature · 1 line
~Randy