Grub documentation out of date in System Administration Guide #17

Open
opened 2024-05-21 13:01:58 +00:00 by pbokoc · 0 comments
pbokoc commented 2024-05-21 13:01:58 +00:00 (Migrated from gitlab.com)

(Originally from https://bugzilla.redhat.com/show_bug.cgi?id=2033158)

Description of problem:

Grub2 documentation is out of date in System Administrators Guide.

It explains how grub was configured in previous releases, but doesn't explain the current configuration and tools sufficiently/

  • systemd Boot Loader Specification (/boot/loader/entries)

  • grubby description is inaccurate (it says it edits grub.cfg, while it looks like it now edits /boot/loader/entries/*conf files)

  • location of grub config (/boot/grub2/grub.cfg, even on EFI systems now)

  • menuentries in grub.cfg (not used now)

  • Gives instruction to grub2-mkconfig -o /boot/efi/EFI/fedora/grub.cfg several times, but that is not the proper location now

  • Above command is given for "Editing a Menu Entry" to change kernel command args, but it doesn't do that any more. grubby must be used for that task.

Version-Release number of selected component (if applicable):

Fedora 35 Documentation: https://docs.fedoraproject.org/en-US/fedora/f35/system-administrators-guide/kernel-module-driver-configuration/Working_with_the_GRUB_2_Boot_Loader/

Rawhide documentation appears the same.

How reproducible:

It's documentation, so every time.

Steps to Reproduce:

  1. Look at Fedora documentation to see where kernel menuentries are defined
  2. Documentation says /boot/efi/EFI/fedora/grub.cfg
  3. That is not correct.

Actual results:

  1. /boot/efi/EFI/fedora/grub.cfg is only a stub to load /boot/grub2/grub.cfg, even on EFI systems (documentation says this file is BIOS only)
  2. No kernel menu entries are defined there, either
  3. Kernel menu entries defined in /boot/loader/entries/*conf files, and probed by grub via unknown mechanism

Expected results:

Expected documentation to match and explain grub configuration on a current Fedora system.


It appears this change occurred in Fedora 30:

https://fedoraproject.org/wiki/Changes/BootLoaderSpecByDefault

That link also mentions the main problem with the change was out of date documentation, although it didn't specifically identify the Fedora System Administrator's Guide.


This issue is still present. I recently (accidentally) wiped my UEFI partition and instructions in Fedora documentation didn't help me to restore bootloader. Fortunately, I remembered about related change in F34 (https://fedoraproject.org/wiki/Changes/UnifyGrubConfig) and realised that they are incorrect. Unfortunately, it appears that /boot/efi/EFI/fedora/grub.cfg file that loads main /boot/grub2/grub.cfg is generated only when installing Fedora and there is no way to restore it so I had to download Anaconda source code to figure out what it should actually contain.

(Originally from https://bugzilla.redhat.com/show_bug.cgi?id=2033158) Description of problem: Grub2 documentation is out of date in System Administrators Guide. It explains how grub was configured in previous releases, but doesn't explain the current configuration and tools sufficiently/ * systemd Boot Loader Specification (/boot/loader/entries) * grubby description is inaccurate (it says it edits grub.cfg, while it looks like it now edits /boot/loader/entries/*conf files) * location of grub config (/boot/grub2/grub.cfg, even on EFI systems now) * menuentries in grub.cfg (not used now) * Gives instruction to `grub2-mkconfig -o /boot/efi/EFI/fedora/grub.cfg` several times, but that is not the proper location now * Above command is given for "Editing a Menu Entry" to change kernel command args, but it doesn't do that any more. grubby must be used for that task. Version-Release number of selected component (if applicable): Fedora 35 Documentation: https://docs.fedoraproject.org/en-US/fedora/f35/system-administrators-guide/kernel-module-driver-configuration/Working_with_the_GRUB_2_Boot_Loader/ Rawhide documentation appears the same. How reproducible: It's documentation, so every time. Steps to Reproduce: 1. Look at Fedora documentation to see where kernel menuentries are defined 2. Documentation says /boot/efi/EFI/fedora/grub.cfg 3. That is not correct. Actual results: 1. /boot/efi/EFI/fedora/grub.cfg is only a stub to load /boot/grub2/grub.cfg, even on EFI systems (documentation says this file is BIOS only) 2. No kernel menu entries are defined there, either 3. Kernel menu entries defined in /boot/loader/entries/*conf files, and probed by grub via unknown mechanism Expected results: Expected documentation to match and explain grub configuration on a current Fedora system. --- It appears this change occurred in Fedora 30: https://fedoraproject.org/wiki/Changes/BootLoaderSpecByDefault That link also mentions the main problem with the change was out of date documentation, although it didn't specifically identify the Fedora System Administrator's Guide. --- This issue is still present. I recently (accidentally) wiped my UEFI partition and instructions in Fedora documentation didn't help me to restore bootloader. Fortunately, I remembered about related change in F34 (https://fedoraproject.org/wiki/Changes/UnifyGrubConfig) and realised that they are incorrect. Unfortunately, it appears that /boot/efi/EFI/fedora/grub.cfg file that loads main /boot/grub2/grub.cfg is generated only when installing Fedora and there is no way to restore it so I had to download Anaconda source code to figure out what it should actually contain.
Commenting is not possible because the repository is archived.
No labels
No milestone
No project
No assignees
1 participant
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
docs-archive/sysadmin-guide#17
No description provided.