From 51543da180a6db860a56a1abb86f063af40b3918 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Tue, 12 Nov 2024 09:33:28 +0100 Subject: [PATCH] Rename ftldns/debugging -> ftldns/gdb for clarity Signed-off-by: DL6ER --- docs/ftldns/{debugging.md => gdb.md} | 0 docs/ftldns/valgrind.md | 2 +- mkdocs.yml | 3 ++- 3 files changed, 3 insertions(+), 2 deletions(-) rename docs/ftldns/{debugging.md => gdb.md} (100%) diff --git a/docs/ftldns/debugging.md b/docs/ftldns/gdb.md similarity index 100% rename from docs/ftldns/debugging.md rename to docs/ftldns/gdb.md diff --git a/docs/ftldns/valgrind.md b/docs/ftldns/valgrind.md index 9d2aabd..0dbeda3 100644 --- a/docs/ftldns/valgrind.md +++ b/docs/ftldns/valgrind.md @@ -79,7 +79,7 @@ When set to `yes`, Memcheck keeps track of the origins of all uninitialised valu You can also combine `valgrind` with `gdb` to get both the memory error detection and the ability to step through the code after a crash (or other unexpected behaviour). -1. Prepare `gdb` as described in [the `gdb` guide](debugging.md). +1. Prepare `gdb` as described in [the `gdb` guide](gdb.md). 2. Start `pihole-FTL` in `valgrind` as described above. The `--vgdb=full` option tells `valgrind` to start a GDB server. 3. Once FTL has started, you can attach `gdb` to the running process using diff --git a/mkdocs.yml b/mkdocs.yml index c8eea4e..5382c12 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -147,7 +147,7 @@ nav: - 'Cache dump': ftldns/cache_dump.md - 'Packet dump': ftldns/package_dump.md - 'Debugging': - - 'gdb': ftldns/debugging.md + - 'gdb': ftldns/gdb.md - 'valgrind': ftldns/valgrind.md - 'Group Management': - 'Group Management': group_management/index.md @@ -283,3 +283,4 @@ plugins: 'guides/vpn/openvpn/overview.md': guides/vpn/openvpn/index.md 'guides/misc/tor/overview.md': guides/misc/tor/index.md 'guides/github/contributing.md': guides/github/index.md + 'ftldns/debugging.md': ftldns/gdb.md