summaryrefslogtreecommitdiff
path: root/doc/debugging_with_gdb.html
diff options
context:
space:
mode:
authorRob Pike <r@golang.org>2014-04-26 10:18:17 -0600
committerRob Pike <r@golang.org>2014-04-26 10:18:17 -0600
commitb496b507b5c99517224e59ae3ad2b445f739c92b (patch)
treea64c4fef786c80af5f2dadf82e9abee1996df6c6 /doc/debugging_with_gdb.html
parentd5e158c2e09158fd4141a1544fc41c54d6242f3d (diff)
downloadgo-b496b507b5c99517224e59ae3ad2b445f739c92b.tar.gz
doc/debugging_with_gdb.html: add introductory disclaimer
The instructions in this document are useful but not reliable. Explain the situation up top. Fixes issue 7471. LGTM=josharian, iant R=golang-codereviews, josharian, iant CC=golang-codereviews https://codereview.appspot.com/96830045
Diffstat (limited to 'doc/debugging_with_gdb.html')
-rw-r--r--doc/debugging_with_gdb.html17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/debugging_with_gdb.html b/doc/debugging_with_gdb.html
index 3d2e4af07..afaedf74c 100644
--- a/doc/debugging_with_gdb.html
+++ b/doc/debugging_with_gdb.html
@@ -9,6 +9,23 @@ Besides this overview you might want to consult the
<a href="http://sourceware.org/gdb/current/onlinedocs/gdb/">GDB manual</a>.
</i></p>
+<p>
+GDB does not understand Go programs well.
+The stack management, threading, and runtime contain aspects that differ
+enough from the execution model GDB expects that they can confuse
+the debugger, even when the program is compiled with gccgo.
+As a consequence, although GDB can be useful in some situations, it is
+not a reliable debugger for Go programs, particularly heavily concurrent ones.
+Moreover, it is not a priority for the Go project to address these issues, which
+are difficult.
+In short, the instructions below should be taken only as a guide to how
+to use GDB when it works, not as a guarantee of success.
+</p>
+
+<p>
+In time, a more Go-centric debugging architecture may be required.
+</p>
+
<h2 id="Introduction">Introduction</h2>
<p>