diff mbox series

[v3,1/2] profile-manual: Document the PACKAGE_KEEP_DEBUG_FRAME variable.

Message ID 20250211161239.5396-2-othacehe@gnu.org
State Under Review
Headers show
Series Document the PACKAGE_KEEP_DEBUG_FRAME variable | expand

Commit Message

Mathieu Othacehe Feb. 11, 2025, 4:12 p.m. UTC 
Document the 'PACKAGE_KEEP_DEBUG_FRAME' variable that can be used to keep the
.debug_frame ELF section when stripping.

By using libunwind + minidebuginfo, that provides a way for users to get
debug_frame based backtraces on target.

Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
---
 documentation/ref-manual/variables.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 47d4e814f..f5bd7b353 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -6243,6 +6243,15 @@  system and gives an overview of their function and contents.
       install, the build system does not generate an error. This variable
       is generally not user-defined.
 
+   :term:`PACKAGE_KEEP_DEBUG_FRAME`
+      Keep the ``.debug_frame`` ELF section when stripping during package
+      creation. You can set this variable in your ``local.conf`` file::
+
+        PACKAGE_KEEP_DEBUG_FRAME = "1"
+
+      That will result in passing the ``--keep-section=.debug_frame`` argument
+      to the ``strip`` command.
+
    :term:`PACKAGE_PREPROCESS_FUNCS`
       Specifies a list of functions run to pre-process the
       :term:`PKGD` directory prior to splitting the files out