From c62232c09df203320012b63095063e7fe8231555 Mon Sep 17 00:00:00 2001 From: Jonathan Lebon Date: Thu, 20 Dec 2018 09:21:20 -0500 Subject: [PATCH] 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 --- src/boot/grub2/ostree-grub-generator | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/boot/grub2/ostree-grub-generator b/src/boot/grub2/ostree-grub-generator index 5b7ea1ab..2208c1bf 100644 --- a/src/boot/grub2/ostree-grub-generator +++ b/src/boot/grub2/ostree-grub-generator @@ -1,11 +1,12 @@ #!/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 -# boot loader configuration file needs to be updated. It can be used as a template -# for a custom grub.cfg generator. What to consider when writing a custom grub.cfg -# generator: +# It can be used as a template 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 # https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec/ into GRUB2