From 1969cd6f8d30dace81d9848c6bacbb8bad9dacd8 Mon Sep 17 00:00:00 2001
From: Ciro Santilli <ciro.santilli@gmail.com>
Date: Sat, 27 May 2017 08:39:09 +0100
Subject: [PATCH] document kdb

---
 README.md | 28 ++++++++++++++++++++++++++++
 runqemu   |  2 ++
 2 files changed, 30 insertions(+)

diff --git a/README.md b/README.md
index 7375e25..fa17a2f 100644
--- a/README.md
+++ b/README.md
@@ -265,6 +265,34 @@ and you now control the count.
 
 TODO: if I `-ex lx-symbols` to the `gdb` command, just like done for QEMU `-gdb`, the kernel oops. How to automate this step?
 
+### KDB
+
+If you modify `runqemu` to use:
+
+    -append kgdboc=kbd
+
+instead of `kgdboc=ttyS0,115200`, you enter a different debugging mode called KDB.
+
+Usage: in QEMU:
+
+    [0]kdb> go
+
+Boot finishes, then:
+
+    /kgdb.sh
+
+And you are back in KDB. Now you can:
+
+    [0]kdb> help
+    [0]kdb> bp sys_write
+    [0]kdb> go
+
+And you will break whenever `sys_write` is hit.
+
+The other KDB commands allow you to instruction steps, view memory, registers and some higher level kernel runtime data.
+
+But TODO I don't think you can see where you are in the kernel source code and line step as from GDB, since the kernel source is not available on guest (ah, if only debugging information supported full source: ).
+
 ## Table of contents
 
 1.  [Introduction](introduction.md)
diff --git a/runqemu b/runqemu
index 5bc1913..17aa0fd 100755
--- a/runqemu
+++ b/runqemu
@@ -20,6 +20,8 @@ while getopts a:dkn OPT; do
     k)
       debug=true
       extra_append="$extra_append kgdbwait kgdboc=ttyS0,115200"
+      # For those who want to try KDB.
+      #extra_append="$extra_append kgdbwait kgdboc=kbd"
       extra_flags="$extra_flags -serial tcp::1234,server,nowait"
       ;;
     n)