All of lore.kernel.org
 help / color / mirror / Atom feed
From: Antonin Godard <antonin.godard@bootlin.com>
To: docs@lists.yoctoproject.org
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
	 Antonin Godard <antonin.godard@bootlin.com>
Subject: [PATCH 7/7] ref-manual/variables.rst: document the IMAGE_*_DEBUGFS variables
Date: Tue, 30 Jun 2026 10:13:17 +0200	[thread overview]
Message-ID: <20260630-sync-documentation-conf-v1-7-da14b40cb515@bootlin.com> (raw)
In-Reply-To: <20260630-sync-documentation-conf-v1-0-da14b40cb515@bootlin.com>

Added by commit 41316293e442 ("lib/oe/image.py: Add image generation
for companion debug filesystem") in OE-Core.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/variables.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index d23eabad8..abb154f44 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -4356,6 +4356,21 @@ 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 :term:`IMAGE_FSTYPES` variable.
 
+   :term:`IMAGE_FSTYPES_DEBUGFS`
+      The :term:`IMAGE_FSTYPES_DEBUGFS` holds a list of filesystem image types
+      to generate when the :term:`IMAGE_GEN_DEBUGFS` variable is set to "1". The
+      content of this variable is the same as what is supported by the
+      :term:`IMAGE_FSTYPES` variable.
+
+   :term:`IMAGE_GEN_DEBUGFS`
+      When set to "1" in an :ref:`ref-classes-image` recipe, the
+      :term:`OpenEmbedded Build System` will generate a companion image that
+      contains the debug symbols and source code for the packages installed on
+      the image. The :term:`OpenEmbedded Build System` does this by adding all
+      the available ``-dbg`` and ``-src`` packages available in the package
+      feed, which are automatically generated during
+      :ref:`overview-manual/concepts:Package Splitting`.
+
    :term:`IMAGE_INSTALL`
       Used by recipes to specify the packages to install into an image
       through the :ref:`ref-classes-image` class. Use the

-- 
2.54.0



  parent reply	other threads:[~2026-06-30  8:13 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-06-30  8:13 [PATCH 0/7] Sync yocto-docs glossary with meta/conf/documentation.conf Antonin Godard
2026-06-30  8:13 ` [PATCH 1/7] ref-manual/variables.rst: document the CCACHE_NATIVE_RECIPES_ALLOWED variable Antonin Godard
2026-06-30  8:13 ` [PATCH 2/7] ref-manual/variables.rst: document missing CONFLICT_*_FEATURES variables Antonin Godard
2026-06-30  8:13 ` [PATCH 3/7] ref-manual/variables.rst: document the LOCALE_PATHS variable Antonin Godard
2026-06-30  8:13 ` [PATCH 4/7] ref-manual/variables.rst: document the TEST_SERIALCONTROL_CONNECT_TIMEOUT variable Antonin Godard
2026-06-30  8:13 ` [PATCH 5/7] ref-manual/variables.rst: document the LOCALE_UTF8_IS_DEFAULT variable Antonin Godard
2026-07-03  7:59   ` [docs] " Daniel Ammann
2026-07-03  9:57     ` Antonin Godard
2026-07-03 10:20       ` Paul Barker
2026-06-30  8:13 ` [PATCH 6/7] ref-manual/variables.rst: document the TEST_SERIALCONTROL_PS1 variable Antonin Godard
2026-06-30  8:13 ` Antonin Godard [this message]
2026-07-03 11:43 ` [PATCH 0/7] Sync yocto-docs glossary with meta/conf/documentation.conf 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=20260630-sync-documentation-conf-v1-7-da14b40cb515@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=thomas.petazzoni@bootlin.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.