zephyr/samples/subsys/debug/gdbstub
Benjamin Cabé 4f1cd0e428 doc: Migrate subsys/ code samples to new Sphinx extension
This migrates the subsys code samples to the new Sphinx code-sample
extension, making it easier to find relevant samples when browsing
API reference.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-21 09:28:31 +02:00
..
boards
src
CMakeLists.txt
prj.conf
README.rst doc: Migrate subsys/ code samples to new Sphinx extension 2023-09-21 09:28:31 +02:00
run.gdbinit
sample.yaml

.. zephyr:code-sample:: gdb-debug
   :name: GDB debug

   Use GDB Remote Serial Protocol to debug a Zephyr application running on QEMU.

Overview
********

A simple sample that can be used with QEMU to show debug using GDB
Remote Serial Protocol (RSP) capabilities.

Building and Running
********************

This application can be built and executed on QEMU as follows:

.. zephyr-app-commands::
   :zephyr-app: samples/subsys/debug/gdbstub
   :host-os: unix
   :board: qemu_x86
   :goals: run
   :compact:

Open a new terminal and use gdb to connect to the running qemu as follows:

.. code-block:: bash

    gdb build/zephyr/zephyr.elf
    (gdb) target remote :5678

Exit QEMU by pressing :kbd:`CTRL+A` :kbd:`x`.