diff mbox series

[Concept,09/10] backtrace: doc: Mention the feature

Message ID 20251129080014.758001-10-sjg@u-boot.org
State New
Headers
Series backtrace: Add runtime support for looking at the backtrace |

Commit Message

Simon Glass Nov. 29, 2025, 7:59 a.m. UTC 
  From: Simon Glass <simon.glass@canonical.com>

Add a short section about the backtrace feature to the sandbox docs.

Co-developed-by: Claude <noreply@anthropic.com>
Signed-off-by: Simon Glass <simon.glass@canonical.com>
---

 doc/arch/sandbox/sandbox.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
diff mbox series

Patch

diff --git a/doc/arch/sandbox/sandbox.rst b/doc/arch/sandbox/sandbox.rst
index fc2b7c482f4..9e9b027be8b 100644
--- a/doc/arch/sandbox/sandbox.rst
+++ b/doc/arch/sandbox/sandbox.rst
@@ -616,6 +616,23 @@  Here is an example trace::
    Hit any key to stop autoboot:  1
 
 
+Backtrace Support
+-----------------
+
+Sandbox supports printing a backtrace of the current call stack, which can be
+useful for debugging. The :doc:`backtrace <../../usage/cmd/backtrace>` command
+prints a backtrace showing function names, source files, and line numbers.
+
+This uses the libbacktrace library (bundled with GCC) to provide detailed symbol
+information, including for static functions.
+
+To use it, simply run::
+
+    => backtrace
+
+This command is enabled with ``CONFIG_CMD_BACKTRACE``.
+
+
 Debugging the init sequence
 ---------------------------