doc: extend bootloader documentation #264
Conversation
|
@mrksu could you please review? |
|
Congratulations! One of the builds has completed. 🍾 You can install the built RPMs by following these steps:
Please note that the RPMs should be used only in a testing environment. |
jmencak
left a comment
jmencak
left a comment
There was a problem hiding this comment.
Thanks for the docs, I appreciate this and it helps a lot! A few nits, but more importantly:
- when child's suffix is alphanumerically smaller than parent's, the removal of kernel boot parameters doesn't work for me
- the merge mechanism needs to be explained in more detail, probably elsewhere
- nits (will have another pass when this is more complete)
doc/manual/modules/performance/ref_available-tuned-plug-ins.adoc
Outdated
Show resolved
Hide resolved
doc/manual/modules/performance/ref_available-tuned-plug-ins.adoc
Outdated
Show resolved
Hide resolved
doc/manual/modules/performance/ref_available-tuned-plug-ins.adoc
Outdated
Show resolved
Hide resolved
doc/manual/modules/performance/ref_available-tuned-plug-ins.adoc
Outdated
Show resolved
Hide resolved
doc/manual/modules/performance/ref_available-tuned-plug-ins.adoc
Outdated
Show resolved
Hide resolved
doc/manual/modules/performance/ref_available-tuned-plug-ins.adoc
Outdated
Show resolved
Hide resolved
|
Hi and thanks for the contributions. I'm going to review the changes next week and backport them into the RHEL 8 docs set when I'm done. |
msuchane
left a comment
msuchane
left a comment
There was a problem hiding this comment.
I've briefly reviewed the changes. A proper review will be done by Apurva or Jacob, who are the current maintainers of Tuned documentation.
We're also discussing the best way to propagate the changes into the RHEL 8 documentation set from here.
Thanks again for the contribution!
| +cmdline+[replaceable]_suffix_=+[replaceable]_arg1_ [replaceable]_arg2_ ... [replaceable]_argN_ | ||
| ---- | ||
| + | ||
| Where [replaceable]_suffix_ can be arbitrary (even empty) alphanumeric string which should be unique across all loaded profiles. Good practice is to use the profile name as the [replaceable]_suffix_ (e.g. [option]`cmdline_my_profile`). If there are multiple [option]`cmdline` options with the same suffix (e.g. in the parent profiles), then during the profile load/merge the value which was assigned the last time wins (this is the same as with any other plugin options). Finaly, the kernel command line is constructed by concatenation of the all resulting [option]`cmdline` options. |
There was a problem hiding this comment.
Some style changes will be needed here to align the paragraph with our style guide.
There was a problem hiding this comment.
Unfortunately, I have no idea what to change.
| + | ||
| Such kernel options will be removed (instead of concatenated) during the final kernel command line construction. | ||
| -- | ||
| .Modifying the kernel command line |
There was a problem hiding this comment.
From this line on, the content is no longer aligned with the bootloader label on line 141, but I believe that it should be.
There was a problem hiding this comment.
Could you propose what to change?
| Switching to another profile or manually stopping the `tuned` service removes the additional options. If you shut down or reboot the system, the kernel options persist in the [filename]`grub.cfg` file. | ||
| Switching to another profile or manually stopping the `tuned` service removes the additional options. If you shut down or reboot the system, the kernel options persist in the [filename]`grub.cfg` file and grub environment files. | ||
| + | ||
| The kernel options can be specified by the following syntax: |
There was a problem hiding this comment.
With the new additions, this list item has grown to be quite long, both absolutely and in comparison to the other list items around.
This particular AsciiDoc file is intended as a reference listing the available Tuned plug-ins. The additions really explain the usage of the bootloader plug-in, rather than simply saying that this plug-in is available.
For this reason, I suggest that we split the content starting with this line into a new file, such as a procedure called "Editing boot loader options in a Tuned profile" or similar, or maybe a concept module focused just on the boot loader syntax and examples.
I leave it to the other writers to decide the best solution here.
There was a problem hiding this comment.
Could you or other writer provide patch or PR for it? I am really not good at AsciiDoc.
|
@mrksu thanks for the review. I fixed what was clear for me. Regarding the formatting changes, I am really not good at AsciiDoc. So more detailed description what to change and how or patch/PR is highly welcome. |
yarda
force-pushed
the
bootloader-docs-fix
branch
2 times, most recently
from
2c227a3 to
8c53cd8
Compare
|
We should add explicit note that it's not possible to remove kernel command line options that was not added by Tuned. |
| + | ||
| Customized non-standard location of the GRUB 2 configuration file can be specified by the [option]`grub2_cfg_file` option. | ||
| + | ||
| The kernel options are added to the current GRUB configuration and its templates. The system needs to be rebooted for the kernel options to take effect. |
There was a problem hiding this comment.
NOTE tuned will not remove or replace bootloader cmdline parameters added via other methods like grubby. tuned will only be able manage bootloader cmdline parameters added via tuned. Please refer to your platform bootloader documentation about how to identify and manage bootloader cmdline parameters set outside of tuned.
resolves: rhbz#1816168 Signed-off-by: Jaroslav Škarvada <[email protected]>
yarda
force-pushed
the
bootloader-docs-fix
branch
from
8c53cd8 to
c0692a9
Compare
|
LGTM from technical point of view. |
|
Obsoleted by: #337 |
5 participants
resolves: rhbz#1816168
Signed-off-by: Jaroslav Škarvada [email protected]