Changes in bootconfig.rst

b743852c - Allow forcing unconditional bootconfig processing

Tue, 21 Feb 2023 23:27:48 +0000

Allow forcing unconditional bootconfig processingThe BOOT_CONFIG family of Kconfig options allows a bootconfig filecontaining kernel boot parameters to be embedded into an initrd or intothe kernel itself. This can be extremely useful when deploying kernelsin cases where some of the boot parameters depend on the kernel versionrather than on the server hardware, firmware, or workload.Unfortunately, the "bootconfig" kernel parameter must be specified inorder to cause the kernel to look for the embedded bootconfig file,and it clearly does not help to embed this "bootconfig" kernel parameterinto that file.Therefore, provide a new BOOT_CONFIG_FORCE Kconfig option that causes thekernel to act as if the "bootconfig" kernel parameter had been specified.In other words, kernels built with CONFIG_BOOT_CONFIG_FORCE=y will lookfor the embedded bootconfig file even when the "bootconfig" kernelparameter is omitted. This permits kernel-version-dependent kernelboot parameters to be embedded into the kernel image without the need to(for example) update large numbers of boot loaders.Link: https://lore.kernel.org/all/20230105005838.GA1772817@paulmck-ThinkPad-P17-Gen-1/Signed-off-by: Paul E. McKenney Cc: Masami Hiramatsu Cc: Jonathan Corbet Cc: Andrew Morton Cc: Nick Desaulniers Cc: Vlastimil Babka Cc: Johannes Weiner Cc: Acked-by: Masami Hiramatsu (Google) Signed-off-by: Masami Hiramatsu (Google) List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

e378cb9a - Documentation: Fixed a typo in bootconfig.rst

Fri, 02 Dec 2022 12:22:03 +0000

Documentation: Fixed a typo in bootconfig.rstFixed a typo in the word 'concatenated'.Signed-off-by: Kushagra Verma Link: https://lore.kernel.org/r/HK0PR01MB2801DA243B726141A97FE92EF8179@HK0PR01MB2801.apcprd01.prod.exchangelabs.comSigned-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

2f51efc6 - docs: bootconfig: Add how to embed the bootconfig into kernel

Wed, 06 Apr 2022 02:31:30 +0000

docs: bootconfig: Add how to embed the bootconfig into kernelAdd a description how to embed the bootconfig file into kernel.Link: https://lkml.kernel.org/r/164921228987.1090670.16843569536974147213.stgit@devnote2Cc: Padmanabha Srinivasaiah Cc: Jonathan Corbet Cc: Randy Dunlap Cc: Nick Desaulniers Cc: Sami Tolvanen Cc: Nathan Chancellor Cc: Masahiro Yamada Cc: Linux Kbuild mailing list Signed-off-by: Masami Hiramatsu Signed-off-by: Steven Rostedt (Google) List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

26c9c72f - docs: bootconfig: Add how to use bootconfig for kernel parameters

Sat, 04 Sep 2021 15:54:24 +0000

docs: bootconfig: Add how to use bootconfig for kernel parametersAdd a section to describe how to use the bootconfig forspecifying kernel and init parameters. This is an importantsection because it is the reason why this document is underthe admin-guide.Link: https://lkml.kernel.org/r/163077086399.222577.5881779375643977991.stgit@devnote2Signed-off-by: Masami Hiramatsu Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.orgSigned-off-by: Steven Rostedt (VMware) List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

0ff2bb7d - docs: bootconfig: Update for mixing value and subkeys

Wed, 02 Jun 2021 08:19:25 +0000

docs: bootconfig: Update for mixing value and subkeysUpdate document for the mixing value and subkeys on a key.Link: https://lkml.kernel.org/r/162262196510.264090.15044943496205914148.stgit@devnote2Signed-off-by: Masami Hiramatsu Signed-off-by: Steven Rostedt (VMware) List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

9d54ee78 - docs: admin-guide: bootconfig: Fix feils to fails

Thu, 07 Jan 2021 12:56:10 +0000

docs: admin-guide: bootconfig: Fix feils to failss/feils/fails/pSigned-off-by: Bhaskar Chowdhury Acked-by: Randy Dunlap Link: https://lore.kernel.org/r/20210107125610.1576368-1-unixbhaskar@gmail.comSigned-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

05227490 - docs: bootconfig: Add the endianness of fields

Fri, 20 Nov 2020 02:29:22 +0000

docs: bootconfig: Add the endianness of fieldsAdd a description about the endianness of the size and the checksumfields. Those must be stored as le32 instead of u32. This will allowus to apply bootconfig to the cross build initrd without caringthe endianness.Link: https://lkml.kernel.org/r/160583936246.547349.10964204130590955409.stgit@devnote2Reported-by: Steven Rostedt Suggested-by: Linus Torvalds Signed-off-by: Masami Hiramatsu Signed-off-by: Steven Rostedt (VMware) List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

fbc6e1c6 - docs: bootconfig: Update file format on initrd image

Thu, 19 Nov 2020 05:53:49 +0000

docs: bootconfig: Update file format on initrd imageTo align the total file size, add padding null character when appendingthe bootconfig to initrd image.Link: https://lkml.kernel.org/r/160576522916.320071.4145530996151028855.stgit@devnote2Signed-off-by: Masami Hiramatsu Signed-off-by: Steven Rostedt (VMware) List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

c58b46cb - Documentation: bootconfig: Add bootconfig override operator

Wed, 15 Jul 2020 16:00:47 +0000

Documentation: bootconfig: Add bootconfig override operatorAdd a sentence about bootconfig override operator (":=") tobootconfig.rst.Link: https://lkml.kernel.org/r/159482884682.126704.7198860675721719878.stgit@devnote2Signed-off-by: Masami Hiramatsu Signed-off-by: Steven Rostedt (VMware) List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

5f811c57 - bootconfig: Add append value operator support

Fri, 21 Feb 2020 08:13:52 +0000

bootconfig: Add append value operator supportAdd append value operator "+=" support to bootconfig syntax.With this operator, user can add new value to the key asan entry of array instead of overwriting.For example, foo = bar ... foo += bazThen the key "foo" has "bar" and "baz" values as an array.Link: http://lkml.kernel.org/r/158227283195.12842.8310503105963275584.stgit@devnote2Signed-off-by: Masami Hiramatsu Signed-off-by: Steven Rostedt (VMware) List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

4e4694d8 - bootconfig: Prohibit re-defining value on same key

Fri, 21 Feb 2020 08:13:42 +0000

bootconfig: Prohibit re-defining value on same keyCurrently, bootconfig adds a new value on the existing key to the tail of anarray. But this looks a bit confusing because an admin can easily rewritethe original value in the same config file.This rejects the following value re-definition. key = value1 ... key = value2You should rewrite value1 to value2 in this case.Link: http://lkml.kernel.org/r/158227282199.12842.10110929876059658601.stgit@devnote2Suggested-by: Steven Rostedt (VMware) Signed-off-by: Masami Hiramatsu [ Fixed spelling of arraies to arrays ]Signed-off-by: Steven Rostedt (VMware) List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

a24d286f - bootconfig: Reject subkey and value on same parent key

Thu, 20 Feb 2020 12:19:12 +0000

bootconfig: Reject subkey and value on same parent keyReject if a value node is mixed with subkey node on sameparent key node.A value node can not co-exist with subkey node under some keynode, e.g.key = valuekey.subkey = another-valueThis is not be allowed because bootconfig API is not designedto handle such case.Link: http://lkml.kernel.org/r/158220115232.26565.7792340045009731803.stgit@devnote2Signed-off-by: Masami Hiramatsu Signed-off-by: Steven Rostedt (VMware) List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

85c46b78 - bootconfig: Add bootconfig magic word for indicating bootconfig explicitly

Thu, 20 Feb 2020 12:18:42 +0000

bootconfig: Add bootconfig magic word for indicating bootconfig explicitlyAdd bootconfig magic word to the end of bootconfig on initrdimage for indicating explicitly the bootconfig is there.Also tools/bootconfig treats wrong size or wrong checksum orparse error as an error, because if there is a bootconfig magicword, there must be a bootconfig.The bootconfig magic word is "#BOOTCONFIG\n", 12 bytes word.Thus the block image of the initrd file with bootconfig isas follows.[Initrd][bootconfig][size][csum][#BOOTCONFIG\n]Link: http://lkml.kernel.org/r/158220112263.26565.3944814205960612841.stgit@devnote2Suggested-by: Steven Rostedt Signed-off-by: Masami Hiramatsu Signed-off-by: Steven Rostedt (VMware) List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

2e5b1886 - Documentation: bootconfig: fix Sphinx block warning

Mon, 10 Feb 2020 03:53:17 +0000

Documentation: bootconfig: fix Sphinx block warningFix Sphinx format warning:lnx-56-rc1/Documentation/admin-guide/bootconfig.rst:26: WARNING: Literal block expected; none found.Signed-off-by: Randy Dunlap Cc: Steven Rostedt Acked-by: Masami Hiramatsu Link: https://lore.kernel.org/r/07b3e31f-9b1e-1876-aa60-4436e4dd6da0@infradead.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

7495e092 - bootconfig: Only load bootconfig if "bootconfig" is on the kernel cmdline

Tue, 04 Feb 2020 12:33:53 +0000

bootconfig: Only load bootconfig if "bootconfig" is on the kernel cmdlineAs the bootconfig is appended to the initrd it is not as easy to modify asthe kernel command line. If there's some issue with the kernel, and thedeveloper wants to boot a pristine kernel, it should not be needed to modifythe initrd to remove the bootconfig for a single boot.As bootconfig is silently added (if the admin does not know where to lookthey may not know it's being loaded). It should be explicitly added to thekernel cmdline. The loading of the bootconfig is only done if "bootconfig"is on the kernel command line. This will let admins know that the kernelcommand line is extended.Note, after adding printk()s for when the size is too great or the checksumis wrong, exposed that the current method always looked for the boot config,and if this size and checksum matched, it would parse it (as if either iswrong a printk has been added to show this). It's better to only check thisif the boot config is asked to be looked for.Link: https://lore.kernel.org/r/CAHk-=wjfjO+h6bQzrTf=YCZA53Y3EDyAs3Z4gEsT7icA3u_Psw@mail.gmail.comAcked-by: Masami Hiramatsu Suggested-by: Linus Torvalds Signed-off-by: Steven Rostedt (VMware) List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

a4798eb4 - Documentation: bootconfig: Fix typos in bootconfig documentation

Mon, 20 Jan 2020 03:23:12 +0000

Documentation: bootconfig: Fix typos in bootconfig documentationFix typos in bootconfig.rst according to Randy's suggestions.Link: http://lkml.kernel.org/r/157949059219.25888.16939971423610233631.stgit@devnote2Suggested-by: Randy Dunlap Acked-by: Randy Dunlap Signed-off-by: Masami Hiramatsu Signed-off-by: Steven Rostedt (VMware) List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

47781947 - Documentation: tracing: Add boot-time tracing document

Fri, 10 Jan 2020 16:07:40 +0000

Documentation: tracing: Add boot-time tracing documentAdd a documentation about boot-time tracing options inboot config.Link: http://lkml.kernel.org/r/157867246028.17873.8047384554383977870.stgit@devnote2Signed-off-by: Masami Hiramatsu Signed-off-by: Steven Rostedt (VMware) List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst

7b9b816f - Documentation: bootconfig: Add a doc for extended boot config

Fri, 10 Jan 2020 16:05:06 +0000

Documentation: bootconfig: Add a doc for extended boot configAdd a documentation for extended boot config underadmin-guide, since it is including the syntax of boot config.Link: http://lkml.kernel.org/r/157867230658.17873.9309879174829924324.stgit@devnote2Signed-off-by: Masami Hiramatsu Signed-off-by: Steven Rostedt (VMware) List of files: /linux-6.15/Documentation/admin-guide/bootconfig.rst