ref-manual: add DEBUGFS-related variables to glossary

Submitted by Robert P. J. Day on May 21, 2021, 9:35 a.m. | Patch ID: 179745

Details

Message ID b3b0312-688f-1b68-ac2b-29db8163cc9a@crashcourse.ca
State New
Headers show

Commit Message

Robert P. J. Day May 21, 2021, 9:35 a.m.
Add variable glossary entries for all of:

  * IMAGE_GEN_DEBUGFS
  * IMAGE_FSTYPES_DEBUGFS
  * IMAGE_INSTALL_DEBUGFS

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

Patch hide | download patch | download mbox

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 0b61f77cb..1ce43a954 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3006,6 +3006,24 @@  system and gives an overview of their function and contents.
             or ``_prepend``. You must use the ``+=`` operator to add one or
             more options to the ``IMAGE_FSTYPES`` variable.

+   :term:`IMAGE_FSTYPES_DEBUGFS`
+      Similar to :term:`IMAGE_FSTYPES`, specifies the formats the
+      OpenEmbedded build system uses during the build when creating the
+      debug filesystem, as long as :term:`IMAGE_GEN_DEBUGFS` has been
+      set to '1'.
+
+      The default value from ``bitbake.conf``::
+
+         IMAGE_FSTYPES_DEBUGFS ?= "tar.gz"
+
+   :term:`IMAGE_GEN_DEBUGFS`
+      Set to '1' in order to generate a separate debug fileystem::
+
+         IMAGE_GEN_DEBUGFS = '1'
+
+      If set, the debugfs will be generated with all of the filesystem
+      formats listed in :term:`IMAGE_FSTYPES_DEBUGFS`.
+
    :term:`IMAGE_INSTALL`
       Used by recipes to specify the packages to install into an image
       through the :ref:`image <ref-classes-image>` class. Use the
@@ -3055,6 +3073,11 @@  system and gives an overview of their function and contents.
             specific situation. In both these cases, the behavior is
             contrary to how most users expect the ``+=`` operator to work.

+   :term:`IMAGE_INSTALL_DEBUGFS`
+      Analogous to :term:`IMAGE_INSTALL`, specify a list of additional
+      packages to add to the debug filesystem which would not normally
+      be installed as complementary packages of standard ones.
+
    :term:`IMAGE_LINGUAS`
       Specifies the list of locales to install into the image during the
       root filesystem construction process. The OpenEmbedded build system