From: "Simon A. Eugster" <simon.eu@gmail.com>
To: docs@lists.yoctoproject.org
Cc: "Simon A. Eugster" <simon.eu@gmail.com>
Subject: [PATCH] ref-manual: Describe grub-efi-cfg overrides and GRUB_TITLE
Date: Tue, 21 Jan 2025 12:18:36 +0100 [thread overview]
Message-ID: <20250121111836.47434-1-simon.eu@gmail.com> (raw)
In-Reply-To: <20250115080758.27000-1-simon.eu@gmail.com>
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.
- :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
--
2.43.0
next prev parent reply other threads:[~2025-01-21 11:19 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-01-15 8:07 [PATCH] ref-manual: Describe grub-efi-cfg overrides and GRUB_TITLE Simon A. Eugster
2025-01-17 10:46 ` [docs] " Antonin Godard
2025-01-21 11:20 ` Simon Eugster
2025-01-21 11:18 ` Simon A. Eugster [this message]
2025-01-23 15:32 ` Antonin Godard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250121111836.47434-1-simon.eu@gmail.com \
--to=simon.eu@gmail.com \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox