Files
doomemacs/modules/tools/debugger/README.org
Henrik Lissner b4bd368485 refactor!(debugger): replace realgud with dape
BREAKING CHANGE: Anyone used to realgud will find it missing as of this
commit. It's been replaced with Dape (see
https://github.com/svaante/dape).

This change was made because realgud's implementation was archaic and
over-complicated, dap-mode requires lsp-mode (and has a lot of moving
parts and points of failure), and dape is straight-forward by
comparison; to set up and use. Note that dap-mode and dap-ui is now
deprecated and will be removed in the future, but still remains behind
the +lsp flag for backwards compatibility, at least until v3.

This also adds a '<leader> d' prefix for debugger commands (except for
vanilla users, who already have dape's prefix on 'C-x C-a')
2025-04-23 04:02:06 -04:00

2.2 KiB

:tools debugger

Description   unfold

Turns Emacs into a debug adapter client, powered by doom-package:dape. The debug adapter protocol aims to establish a standardized interface and API for debuggers.

Maintainers

This module has no dedicated maintainers. Become a maintainer?

Module flags

+lsp
(This flag is deprecated) Installs doom-package:dap-mode and doom-package:dap-ui. Requires doom-module::tools lsp (not compatible with Eglot).

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

Then check out the install instructions for the debug adapters you want to work with.

 Dape's documentation will instruct you to install debug adapters to $EMACSDIR/debug-adapters/, but Doom uses $DOOMDIR/debug-adapters/ instead! Alter dape-adapter-dir to change this.

Usage

Start the debugger with M-x +debugger/start (bound to <leader> o d). You'll be prompted to enter a debugger configuration to launch (use <up>/<down> to traverse your history of debugger configs).

Once the session is started, it can be terminated by M-x +debugger/quit.

TODO Configuration

󱌣 This module has no configuration documentation yet. Write some?

The default debugger configs can be found in var:dape-configs.

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

󱌣 This module has no appendix yet. Write one?