diff options
author | Etienne Cordonnier <ecordonnier@snap.com> | 2023-12-11 11:01:41 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-12-18 13:18:55 +0000 |
commit | a1ae83c59b099543f7097247a9f56ca67923a9e8 (patch) | |
tree | d240ea1cc484161907c82b6750af8f350af502af /documentation | |
parent | bd8f3acd14386d62b9510aab5fbd878e7a2902cd (diff) | |
download | poky-a1ae83c59b099543f7097247a9f56ca67923a9e8.tar.gz |
manuals: document minidebuginfo
(From yocto-docs rev: 1a6327f2d92b390248afb45119d79bb05cda3dcc)
Signed-off-by: Etienne Cordonnier <ecordonnier@snap.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/debugging.rst | 15 | ||||
-rw-r--r-- | documentation/ref-manual/features.rst | 3 |
2 files changed, 18 insertions, 0 deletions
diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst index bd1e716b0b..834eade766 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: | |||
1173 | Consider that this will reduce the application's performance and is | 1173 | Consider that this will reduce the application's performance and is |
1174 | recommended only for debugging purposes. | 1174 | recommended only for debugging purposes. |
1175 | 1175 | ||
1176 | Enabling Minidebuginfo | ||
1177 | ====================== | ||
1178 | |||
1179 | Enabling the :term:`DISTRO_FEATURES` minidebuginfo adds a compressed ELF section ``.gnu_debugdata`` | ||
1180 | to all binary files, containing only function names, and thus increasing the size of the | ||
1181 | binaries only by 5 to 10%. For comparison, full debug symbols can be 10 times as big as | ||
1182 | a stripped binary, and it is thus not always possible to deploy full debug symbols. | ||
1183 | Minidebuginfo data allows, on the one side, to retrieve a call-stack using | ||
1184 | GDB (command backtrace) without deploying full debug symbols to the target. It also | ||
1185 | allows to retrieve a symbolicated call-stack when using ``systemd-coredump`` to manage | ||
1186 | coredumps (commands ``coredumpctl list`` and ``coredumpctl info``). | ||
1187 | |||
1188 | This feature was created by Fedora, see https://fedoraproject.org/wiki/Features/MiniDebugInfo for | ||
1189 | more details. | ||
1190 | |||
1176 | Other Debugging Tips | 1191 | Other Debugging Tips |
1177 | ==================== | 1192 | ==================== |
1178 | 1193 | ||
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst index dd14339bc2..b9d3b30f18 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: | |||
161 | - *keyboard:* Include keyboard support (e.g. keymaps will be loaded | 161 | - *keyboard:* Include keyboard support (e.g. keymaps will be loaded |
162 | during boot). | 162 | during boot). |
163 | 163 | ||
164 | - *minidebuginfo:* Add minimal debug symbols :ref:`(minidebuginfo)<dev-manual/debugging:enabling minidebuginfo>` | ||
165 | to binary files containing, allowing ``coredumpctl`` and ``gdb`` to show symbolicated stack traces. | ||
166 | |||
164 | - *multiarch:* Enable building applications with multiple architecture | 167 | - *multiarch:* Enable building applications with multiple architecture |
165 | support. | 168 | support. |
166 | 169 | ||