| Message ID | 20250121111836.47434-1-simon.eu@gmail.com |
|---|---|
| State | Under Review |
| Headers | show |
| Series | ref-manual: Describe grub-efi-cfg overrides and GRUB_TITLE | expand |
Hi Simon, Please send new versions of the patch in a separate email thread, and include the version in the Subject. See the contributor guide for more details on how to do that: https://docs.yoctoproject.org/contributor-guide/submit-changes.html#taking-patch-review-into-account Please, also make sure to include your Signed-off-by in your patches. The contributor guide goes over that too. On Tue Jan 21, 2025 at 12:18 PM CET, Simon A. Eugster via lists.yoctoproject.org wrote: > This patch describes how to use overrides for grub-efi-cfg because that > is otherwise only clear after reading the .bbclass file. It also adds > a description for GRUB_TITLE. > --- > documentation/ref-manual/classes.rst | 18 +++++++++++++++++- > documentation/ref-manual/variables.rst | 6 ++++++ > 2 files changed, 23 insertions(+), 1 deletion(-) > > diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst > index 761be7b545..df6092f082 100644 > --- a/documentation/ref-manual/classes.rst > +++ b/documentation/ref-manual/classes.rst > @@ -987,10 +987,11 @@ introspection. This functionality is only enabled if the > The :ref:`ref-classes-grub-efi` class provides ``grub-efi``-specific functions for > building bootable images. > > -This class supports several variables: > +This class supports several variables. You can leave the colon here. > > - :term:`INITRD`: Indicates list of filesystem images to > concatenate and use as an initial RAM disk (initrd) (optional). > + Can be specified for each ``LABEL``. > > - :term:`ROOTFS`: Indicates a filesystem image to include > as the root filesystem (optional). > @@ -1004,6 +1005,9 @@ This class supports several variables: > - :term:`APPEND`: An override list of append strings for > each ``LABEL``. > > +- :term:`GRUB_TITLE`: A custom title for each ```LABEL``. > + Defaults to ``LABEL`` if it is not defined. > + > - :term:`GRUB_OPTS`: Additional options to add to the > configuration (optional). Options are delimited using semi-colon > characters (``;``). > @@ -1011,6 +1015,18 @@ This class supports several variables: > - :term:`GRUB_TIMEOUT`: Timeout before executing > the default ``LABEL`` (optional). > > +Each ``LABEL`` defined in the ``LABELS`` variable creates a GRUB boot entry, > +and some variables can be defined individually per ``LABEL``. The label > +specific override names are defined as ``grub_LABEL``. > + > +For example, for a label ``factory``, the override name would be > +``grub_factory``. A custom GRUB menu entry titled "Factory Install" with the > +additional parameter ``factory=yes`` can be achieved as follows:: > + > + LABELS:append = " factory" > + APPEND:grub_factory = "factory=yes" > + GRUB_TITLE:grub_factory = "Factory Install" Our standards.md file recommends three spaces for code block indentation, can you fix this? > + > .. _ref-classes-gsettings: > > ``gsettings`` > diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst > index 0c5c7aab97..9061c206a7 100644 > --- a/documentation/ref-manual/variables.rst > +++ b/documentation/ref-manual/variables.rst > @@ -3320,6 +3320,12 @@ system and gives an overview of their function and contents. > :ref:`ref-classes-grub-efi` class for more information > on how this variable is used. > > + :term:`GRUB_TITLE` > + Specifies custom titles for GRUB labels defined in :ref:`LABELS`. See > + the :ref:`ref-classes-grub-efi` class for more information on how this > + variable is used. > + > + Extra newline, can you remove it? > :term:`GTKIMMODULES_PACKAGES` > When inheriting the :ref:`ref-classes-gtk-immodules-cache` class, > this variable specifies the packages that contain the GTK+ input Antonin
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 761be7b545..df6092f082 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -987,10 +987,11 @@ introspection. This functionality is only enabled if the The :ref:`ref-classes-grub-efi` class provides ``grub-efi``-specific functions for building bootable images. -This class supports several variables: +This class supports several variables. - :term:`INITRD`: Indicates list of filesystem images to concatenate and use as an initial RAM disk (initrd) (optional). + Can be specified for each ``LABEL``. - :term:`ROOTFS`: Indicates a filesystem image to include as the root filesystem (optional). @@ -1004,6 +1005,9 @@ This class supports several variables: - :term:`APPEND`: An override list of append strings for each ``LABEL``. +- :term:`GRUB_TITLE`: A custom title for each ```LABEL``. + Defaults to ``LABEL`` if it is not defined. + - :term:`GRUB_OPTS`: Additional options to add to the configuration (optional). Options are delimited using semi-colon characters (``;``). @@ -1011,6 +1015,18 @@ This class supports several variables: - :term:`GRUB_TIMEOUT`: Timeout before executing the default ``LABEL`` (optional). +Each ``LABEL`` defined in the ``LABELS`` variable creates a GRUB boot entry, +and some variables can be defined individually per ``LABEL``. The label +specific override names are defined as ``grub_LABEL``. + +For example, for a label ``factory``, the override name would be +``grub_factory``. A custom GRUB menu entry titled "Factory Install" with the +additional parameter ``factory=yes`` can be achieved as follows:: + + LABELS:append = " factory" + APPEND:grub_factory = "factory=yes" + GRUB_TITLE:grub_factory = "Factory Install" + .. _ref-classes-gsettings: ``gsettings`` diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 0c5c7aab97..9061c206a7 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -3320,6 +3320,12 @@ system and gives an overview of their function and contents. :ref:`ref-classes-grub-efi` class for more information on how this variable is used. + :term:`GRUB_TITLE` + Specifies custom titles for GRUB labels defined in :ref:`LABELS`. See + the :ref:`ref-classes-grub-efi` class for more information on how this + variable is used. + + :term:`GTKIMMODULES_PACKAGES` When inheriting the :ref:`ref-classes-gtk-immodules-cache` class, this variable specifies the packages that contain the GTK+ input