From 30cdb2a28077d9a0364b9ef6b231927c52436a6b Mon Sep 17 00:00:00 2001
From: Xavier Claessens <xavier.claessens@collabora.com>
Date: Wed, 23 Feb 2022 08:17:08 -0500
Subject: devenv: Setup GDB auto-load scripts

When the project instals GDB helper scripts, copy them into
meson-private directory with the right tree layout and write a .gdbinit
script to load them automatically.
---
 docs/markdown/Commands.md | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'docs/markdown/Commands.md')

diff --git a/docs/markdown/Commands.md b/docs/markdown/Commands.md
index 2623b5c..3542aa4 100644
--- a/docs/markdown/Commands.md
+++ b/docs/markdown/Commands.md
@@ -324,4 +324,11 @@ These variables are set in environment in addition to those set using `meson.add
 Since *Since 0.62.0* if bash-completion scripts are being installed and the
 shell is bash, they will be automatically sourced.
 
+Since *Since 0.62.0* when GDB helper scripts (*-gdb.py, *-gdb.gdb, and *-gdb.csm)
+are installed with a library name that matches one being built, Meson adds the
+needed auto-load commands into `<builddir>/.gdbinit` file. When running gdb from
+top build directory, that file is loaded by gdb automatically. In the case of
+python scripts that needs to load other python modules, `PYTHONPATH` may need
+to be modified using `meson.add_devenv()`.
+
 {{ devenv_arguments.inc }}
-- 
cgit v1.1