gdb_packet: add note on gdb remote protocol debugging

This information is hard to find, so while not directly related to BMD it is useful while developing. Adding it for future developer reference
blackmagic-debug · Dec 19, 2024 · 1f2d949 · 1f2d949
1 parent 223a1ad
commit 1f2d949
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/gdb_packet.c b/src/gdb_packet.c
@@ -81,6 +81,10 @@ void gdb_set_noackmode(bool enable)
 }
 
 #ifndef DEBUG_GDB_IS_NOOP
+/*
+ * To see what packets GDB is seeing you can enable remote protocol debugging with:
+ * `(gdb) set debug remote 1`
+ */
 static void gdb_packet_debug(const char *const func, const gdb_packet_s *const packet)
 {
 	/* Log packet for debugging */