diff mbox series

[1/2] ref-manual: document SPLASH variable

Message ID 20230526114322.1698988-1-michael.opdenacker@bootlin.com
State New
Headers show
Series [1/2] ref-manual: document SPLASH variable | expand

Commit Message

Michael Opdenacker May 26, 2023, 11:43 a.m. UTC 
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/ref-manual/features.rst  | 2 +-
 documentation/ref-manual/variables.rst | 6 ++++++
 2 files changed, 7 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
index 5a064329f1..d6307f1a2f 100644
--- a/documentation/ref-manual/features.rst
+++ b/documentation/ref-manual/features.rst
@@ -344,7 +344,7 @@  Here are the image features available for all images:
 -  *splash:* Enables showing a splash screen during boot. By default,
    this screen is provided by ``psplash``, which does allow
    customization. If you prefer to use an alternative splash screen
-   package, you can do so by setting the ``SPLASH`` variable to a
+   package, you can do so by setting the :term:`SPLASH` variable to a
    different package name (or names) within the image recipe or at the
    distro configuration level.
 
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index e213478326..6680322f4c 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7820,6 +7820,12 @@  system and gives an overview of their function and contents.
       certificate stored in the :term:`SPL_SIGN_KEYDIR` directory, you will 
       have to set :term:`SPL_SIGN_KEYNAME` to ``dev``.
 
+   :term:`SPLASH`
+      This variable, used by the :ref:`ref-classes-image` class, allows
+      to choose splashscreen applications. Set it to the names of packages
+      for such applications to use. This variable is set by default to
+      ``psplash``.
+
    :term:`SRCREV_FORMAT`
       See :term:`bitbake:SRCREV_FORMAT` in the BitBake manual.