diff options
-rw-r--r-- | documentation/ref-manual/classes.rst | 16 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 5 |
2 files changed, 21 insertions, 0 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 8ad77319ec..8763e9e17e 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -1048,6 +1048,7 @@ This class supports several variables: | |||
1048 | 1048 | ||
1049 | - :term:`INITRD`: Indicates list of filesystem images to | 1049 | - :term:`INITRD`: Indicates list of filesystem images to |
1050 | concatenate and use as an initial RAM disk (initrd) (optional). | 1050 | concatenate and use as an initial RAM disk (initrd) (optional). |
1051 | Can be specified for each ``LABEL``. | ||
1051 | 1052 | ||
1052 | - :term:`ROOTFS`: Indicates a filesystem image to include | 1053 | - :term:`ROOTFS`: Indicates a filesystem image to include |
1053 | as the root filesystem (optional). | 1054 | as the root filesystem (optional). |
@@ -1061,6 +1062,9 @@ This class supports several variables: | |||
1061 | - :term:`APPEND`: An override list of append strings for | 1062 | - :term:`APPEND`: An override list of append strings for |
1062 | each ``LABEL``. | 1063 | each ``LABEL``. |
1063 | 1064 | ||
1065 | - :term:`GRUB_TITLE`: A custom title for each ``LABEL``. If a label does not | ||
1066 | have a custom title, the label is used as title for the GRUB menu entry. | ||
1067 | |||
1064 | - :term:`GRUB_OPTS`: Additional options to add to the | 1068 | - :term:`GRUB_OPTS`: Additional options to add to the |
1065 | configuration (optional). Options are delimited using semi-colon | 1069 | configuration (optional). Options are delimited using semi-colon |
1066 | characters (``;``). | 1070 | characters (``;``). |
@@ -1068,6 +1072,18 @@ This class supports several variables: | |||
1068 | - :term:`GRUB_TIMEOUT`: Timeout before executing | 1072 | - :term:`GRUB_TIMEOUT`: Timeout before executing |
1069 | the default ``LABEL`` (optional). | 1073 | the default ``LABEL`` (optional). |
1070 | 1074 | ||
1075 | Each ``LABEL`` defined in the :term:`LABELS` variable creates a GRUB boot | ||
1076 | entry, and some variables can be defined individually per ``LABEL``. The label | ||
1077 | specific override names are defined as ``grub_LABEL``. | ||
1078 | |||
1079 | For example, for a label ``factory``, the override name would be | ||
1080 | ``grub_factory``. A custom GRUB menu entry titled "Factory Install" with the | ||
1081 | additional parameter ``factory=yes`` can be achieved as follows:: | ||
1082 | |||
1083 | LABELS:append = " factory" | ||
1084 | APPEND:grub_factory = "factory=yes" | ||
1085 | GRUB_TITLE:grub_factory = "Factory Install" | ||
1086 | |||
1071 | .. _ref-classes-gsettings: | 1087 | .. _ref-classes-gsettings: |
1072 | 1088 | ||
1073 | ``gsettings`` | 1089 | ``gsettings`` |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 86023195d3..adbef69d8f 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -3382,6 +3382,11 @@ system and gives an overview of their function and contents. | |||
3382 | :ref:`ref-classes-grub-efi` class for more information | 3382 | :ref:`ref-classes-grub-efi` class for more information |
3383 | on how this variable is used. | 3383 | on how this variable is used. |
3384 | 3384 | ||
3385 | :term:`GRUB_TITLE` | ||
3386 | Specifies custom titles for GRUB labels defined in :term:`LABELS`. See | ||
3387 | the :ref:`ref-classes-grub-efi` class for more information on how this | ||
3388 | variable is used. | ||
3389 | |||
3385 | :term:`GTKIMMODULES_PACKAGES` | 3390 | :term:`GTKIMMODULES_PACKAGES` |
3386 | When inheriting the :ref:`ref-classes-gtk-immodules-cache` class, | 3391 | When inheriting the :ref:`ref-classes-gtk-immodules-cache` class, |
3387 | this variable specifies the packages that contain the GTK+ input | 3392 | this variable specifies the packages that contain the GTK+ input |