Mirrors_Framework/nuttx
1
0
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2026-05-22 05:42:05 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Documentation: move debug pages to a separate top level page

Browse Source 
Move debug related pages from Guides to a separate top level page.
This way all pages related to debugging will be in one place
which is more user friendly.

Related Github issue: https://github.com/apache/nuttx/issues/15667

Signed-off-by: raiden00pl <raiden00@railab.me>
This commit is contained in:
raiden00pl
2025-03-22 08:15:08 +01:00
committed by Xiang Xiao
parent a4777f153b
commit 9394962cf6
30 changed files with 22 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Documentation/debugging/gdbwithpython.rst
+48
View File
@@ -0,0 +1,48 @@
===============
GDB with Python
===============
Introduction
============
The NuttX kernel can be effectively debugged using GDB's Python extension.
Commonly used classes and utilities are implemented in the ``nuttx/tools/gdb/nuttxgdb`` directory.
Users can also create custom Python scripts tailored to their debugging needs to analyze and troubleshoot the NuttX kernel more efficiently.
Usage
=====
1. Compile NuttX with CONFIG_DEBUG_SYMBOLS=y enabled and change ``CONFIG_DEBUG_SYMBOLS_LEVEL`` to ``-g3``.
2. Use GDB to debug the NuttX ELF binary (on a real device, a simulator, or with a coredump).
3. Add the following argument to the GDB command line: ``-ix="nuttx/tools/pynuttx/gdbinit.py"``
4. GDB will automatically load the Python script, enabling the use of custom commands.
How to write a GDB python script
================================
Here is an article that introduces the fundamental principles of Python in GDB. Read it to gain a basic understanding.
`Automate Debugging with GDB Python API <https://interrupt.memfault.com/blog/automate-debugging-with-gdb-python-api>`_.
For more documentation on gdb python, please refer to the official documentation of GDB.
`GDB Python API <https://sourceware.org/gdb/current/onlinedocs/gdb.html/Python-API.html#Python-API>`_.
Requirements
============
To use GDB with Python, the following requirements must be met:
- Use GDB compiled with Python support, Python 3.8 or later
- Install required Python packages: ``pip install -r tools/pynuttx/requirements.txt``
- Compile NuttX with debug level 3: ``CONFIG_DEBUG_SYMBOLS_LEVEL="-g3"``
.. Warning::
The GDB Python API is not available in all versions of GDB. Make sure to use a version that supports Python.
.. Warning::
NuttX must be compile with ``CONFIG_DEBUG_SYMBOLS=y`` and ``CONFIG_DEBUG_SYMBOLS_LEVEL="-g3"`` to use GDB with Python.
.. toctree::
:caption: GDB Plugin Commands
:maxdepth: 1
gdb/irqinfo.rst