Merge branch 'master' of flubber:~hurd-web/hurd-web

2 files changed, 33 insertions, 12 deletions

diff --git a/microkernel/mach/gnumach/building.mdwn b/microkernel/mach/gnumach/building.mdwn
index 24a73608..afcfac74 100644
--- a/microkernel/mach/gnumach/building.mdwn
+++ b/microkernel/mach/gnumach/building.mdwn
@@ -1,3 +1,14 @@
+[[!meta copyright="Copyright © 2006, 2007, 2008, 2011 Free Software Foundation,
+Inc."]]
+
+[[!meta license="""[[!toggle id="license" text="GFDL 1.2+"]][[!toggleable
+id="license" text="Permission is granted to copy, distribute and/or modify this
+document under the terms of the GNU Free Documentation License, Version 1.2 or
+any later version published by the Free Software Foundation; with no Invariant
+Sections, no Front-Cover Texts, and no Back-Cover Texts.  A copy of the license
+is included in the section entitled [[GNU Free Documentation
+License|/fdl]]."]]"""]]
+
 # Building [[GNU_Mach|gnumach]] from Source
 
 If you want to build the [[GNU_Mach|gnumach]] kernel yourself instead of just using a
diff --git a/microkernel/mach/gnumach/debugging.mdwn b/microkernel/mach/gnumach/debugging.mdwn
index 596e4da0..f657e7cc 100644
--- a/microkernel/mach/gnumach/debugging.mdwn
+++ b/microkernel/mach/gnumach/debugging.mdwn
@@ -9,7 +9,12 @@ Sections, no Front-Cover Texts, and no Back-Cover Texts.  A copy of the license
 is included in the section entitled [[GNU Free Documentation
 License|/fdl]]."]]"""]]
 
-Here are some hints to debug with GNU Mach
+Here are some hints to debug with GNU Mach.
+
+[[!toc levels=2]]
+
+
+# Kernel Debugger
 
 Mach has a built-in kernel debugger.
 [Manual](http://www.gnu.org/software/hurd/gnumach-doc/Kernel-Debugger.html).
@@ -20,27 +25,25 @@ Then, reproduce the issue again. If something like a kernel trap happens, you wi
 
 If you are running in kvm or qemu, it is convenient to use the curses frontend to be able to copy/paste.
 
-The debugger has an extensive documentation on http://www.gnu.org/software/hurd/gnumach-doc/Kernel-Debugger.html , but a quick start is the following.
-
 To get the register values, type
 
-show registers
+    show registers
 
 To get a backtrace, type trace, which will print both function return addresses and function parameters, such as
 
-0x107cf1(8088488,5e,40000008,2aa008,0)
-0x1071bc(0,0,0,0,0)
-0x106831(24fe00,2000,b,800,0)
+    0x107cf1(8088488,5e,40000008,2aa008,0)
+    0x1071bc(0,0,0,0,0)
+    0x106831(24fe00,2000,b,800,0)
 
 Run the addr2line tool on the return addresses:
 
-addr2line -i -f -e /boot/gnumach 0x107cf1 0x1071bc 0x106831
+    $ addr2line -i -f -e /boot/gnumach 0x107cf1 0x1071bc 0x106831
 
 This will print the source code lines of the backtrace.
 
 To examine the backtrace of some given thread, use
 
-show all thread/u
+    show all thread/u
 
 to get the whole listing of all tasks and threads. You can then use trace/t to trace a specific thread.
 
@@ -48,25 +51,28 @@ Unfortunately, userland and kernelland use the same range of addresses, so one c
 
 To examine a variable, use nm /boot/gnumach to get the address of the variable (e.g. 0x123400), and use
 
-x 0x123400
+    x 0x123400
 
 to read it. One can also write to it by using
 
-w 0x123400
+    w 0x123400
 
 Another interesting feature is watching a variable, by using
 
-watch 0x123400
+    watch 0x123400
 
 and then type continue, to let Mach continue execution. The debugger will be entered again on any change in that variable. The watch is implemented in hardware, so it does not disturb or slow down execution at all.
 
 
+# GDB in QEMU
 
 When you're [[running_a_system_in_QEMU|hurd/running/qemu]] you can directly
 [use GDB on the running
 kernel](http://www.nongnu.org/qemu/qemu-doc.html#SEC48).
 
 
+# Code Inside the Kernel
+
 Alternatively you can use an approach like this one: add the following code
 snippet to `device/ds_routines.c`'s `ds_device_open` function, right at the top
 of the function, and modify the code as needed.
@@ -105,6 +111,8 @@ This is especially useful if you need to manually trigger some stuff inside the
 running kernel, as with the *D1* example.
 
 
+## Writing to the Screen Buffer
+
 If you're doing real low level debugging, you might want to put variations of
 the following snipped into the code, this code will write a `#` character at
 line `[LINE]`, column `[COLUMN]` on the screen:
@@ -118,6 +126,8 @@ some place when running the kernel inside QEMU, as QEMU somehow decides not to
 update its display buffer anymore under certain conditions.
 
 
+# Halting the CPU and Examining Registers
+
 IRC, freenode, #hurd, 2011-07-14:
 
     <braunr> one ugly trick i use when printf isn't available is to halt the