From: ecordonnier@snap.com
To: docs@lists.yoctoproject.org
Cc: Etienne Cordonnier <ecordonnier@snap.com>
Subject: [docs][PATCH v2] manuals: document minidebuginfo
Date: Thu, 7 Dec 2023 15:08:28 +0100 [thread overview]
Message-ID: <20231207140828.3201054-1-ecordonnier@snap.com> (raw)
From: Etienne Cordonnier <ecordonnier@snap.com>
Signed-off-by: Etienne Cordonnier <ecordonnier@snap.com>
---
documentation/dev-manual/debugging.rst | 15 +++++++++++++++
documentation/ref-manual/features.rst | 3 +++
2 files changed, 18 insertions(+)
diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst
index fea2cb30a..12694b01b 100644
--- a/documentation/dev-manual/debugging.rst
+++ b/documentation/dev-manual/debugging.rst
@@ -1173,6 +1173,21 @@ To support this kind of debugging, you need do the following:
Consider that this will reduce the application's performance and is
recommended only for debugging purposes.
+Enabling Minidebuginfo
+======================
+
+Enabling the DISTRO_FEATURES minidebuginfo adds a compressed ELF section ".gnu_debugdata"
+to all binary files, containing only function names, and thus increasing the size of the
+binaries only by 5 to 10%. For comparison, full debug symbols can be 10 times as big as
+a stripped binary, and it is thus not always possible to deploy full debug symbols.
+Minidebuginfo data allows, on the one side, to retrieve a call-stack using
+gdb (command backtrace) without deploying full debug-symbols to the target. It also
+allows to retrieve a symbolicated call-stack when using systemd-coredump to manage
+coredumps (commands "coredumpctl list" and "coredumpctl info").
+
+This feature was created by Fedora, see https://fedoraproject.org/wiki/Features/MiniDebugInfo for
+more details.
+
Other Debugging Tips
====================
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
index dd14339bc..1320c3a58 100644
--- a/documentation/ref-manual/features.rst
+++ b/documentation/ref-manual/features.rst
@@ -161,6 +161,9 @@ metadata, as extra layers can define their own:
- *keyboard:* Include keyboard support (e.g. keymaps will be loaded
during boot).
+- *minidebuginfo:* Add minimal debug symbols :ref:`(minidebuginfo)<dev-manual/debugging:enabling minidebuginfo>`
+ to binary files containing, allowing coredumpctl and gdb to show symbolicated stack traces.
+
- *multiarch:* Enable building applications with multiple architecture
support.
--
2.36.1.vfs.0.0
next reply other threads:[~2023-12-07 14:08 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-07 14:08 ecordonnier [this message]
2023-12-08 8:19 ` [docs][PATCH v2] manuals: document minidebuginfo Michael Opdenacker
2023-12-11 10:08 ` Etienne Cordonnier
[not found] <179E91E4E2B2BCFA.29440@lists.yoctoproject.org>
2023-12-07 14:09 ` Etienne Cordonnier
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=20231207140828.3201054-1-ecordonnier@snap.com \
--to=ecordonnier@snap.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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).