From 2060a0302ece8734c1f91479deb7c458f3db10b3 Mon Sep 17 00:00:00 2001
From: Regia König
Date: Thu, 11 Aug 2022 15:30:23 +0200
Subject: GDB Documentation

---
 documentation/GDB commands | 52 ++++++++++++++++++++++++++++++++++++++++++++++
 documentation/gdb commands | 19 -----------------
 2 files changed, 52 insertions(+), 19 deletions(-)
 create mode 100644 documentation/GDB commands
 delete mode 100644 documentation/gdb commands

diff --git a/documentation/GDB commands b/documentation/GDB commands
new file mode 100644
index 0000000..761eeb9
--- /dev/null
+++ b/documentation/GDB commands	
@@ -0,0 +1,52 @@
+###################################################################
+######################                #############################
+###			GDB COMMANDS				###
+######################                #############################
+###################################################################
+
+1. QEMU CONFIGURATION
+
+	qemu must be started with "-s" option
+	(shorthand for "-gdb tcp::1234")
+
+
+2. GDB PART - CONNECTION
+	- source gdbscript 
+		(if a gdbscript is created, which contains
+		add-symbol-file commandos)
+
+	- target remote localhost:1234
+
+
+3. BREAKPOINTS
+
+	- b CoreHandleProtocol | or OutputString
+
+
+4. INFORMATION
+
+	- info 
+		files		|| get Entry point + sections
+		address SYM
+		all-registers	|| all registers & their contents
+		args		|| Argument variables of current stack frame
+		breakpoints
+		files		|| Names of targets & files being debugged
+		functions	|| all function names
+		locals		|| local variables of current stack frame
+		variables	|| all gloabl & static variables
+
+5. CONTROL FLOW
+
+	- c
+	- bt			|| print back_trace of all stack frames
+	- stop			|| stop program until it reaches a different source line
+
+6. FILES (perhaps not applicable when debugging with QEMU)
+
+	- file MemtestEfi.efi	|| load file   ...no debugging symbols found...done
+	- file			|| unload files
+
+7. LIST
+
+	- list			|| list specified function or line
diff --git a/documentation/gdb commands b/documentation/gdb commands
deleted file mode 100644
index 416a758..0000000
--- a/documentation/gdb commands	
+++ /dev/null
@@ -1,19 +0,0 @@
-GDB COMMANDS
-============
-
-qemu must be started with "-s" option (shorthand for "-gdb tcp::1234")
-
-source gdbscript
-
-file MemtestEfi.efi	|| load file   ...no debugging symbols found...done
-info files		|| get Entry point + sections
-file			|| unload files
-
-b CoreHandleProtocol | or OutputString
-
-target remote localhost:1234
-
-c
-bt			|| print back_trace of all stack frames
-stop			|| stop program until it reaches a different source line
-list			|| list specified function or line
-- 
cgit v1.2.3-55-g7522