packaging
/
ostree
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

boot/grub2: Add some more explanation in ostree-grub-generator 

Even with the previous docstring, I didn't understand at first the
relationship between the `ostree-grub-generator` script and
`ostree-bootloader-grub2.c`. Throw some more docs to clarify things a
bit.

Closes: #1791
Approved by: cgwalters
This commit is contained in:
Jonathan Lebon 2018-12-20 09:21:20 -05:00 committed by Atomic Bot
parent f2d4537ffb
commit c62232c09d
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/boot/grub2/ostree-grub-generator
View File

@ -1,11 +1,12 @@
#!/bin/sh #!/bin/sh
# The builtin grub.cfg generator. # The builtin grub.cfg generator. This script is called by
# ostree/src/libostree/ostree-bootloader-grub2.c whenever boot loader
# configuration file needs to be updated on systems which do not use
# grub2-mkconfig (and thus, the `ostree admin instutil grub2-generate` path).
# #
# This script is called by ostree/src/libostree/ostree-bootloader-grub2.c whenever # It can be used as a template for a custom grub.cfg generator. What to consider
# boot loader configuration file needs to be updated. It can be used as a template # when writing a custom grub.cfg generator:
# for a custom grub.cfg generator. What to consider when writing a custom grub.cfg
# generator:
# #
# - The populate_menu() function converts boot loader entries as defined by # - The populate_menu() function converts boot loader entries as defined by
# https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec/ into GRUB2 # https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec/ into GRUB2