gob: explain that Debug isn't useful unless it's compiled in.

R=golang-dev, rsc
CC=golang-dev
https://golang.org/cl/4930044

diff --git a/src/pkg/gob/debug.go b/src/pkg/gob/debug.go
index ce8a6ff5e5ff8b3f060065af9b9838039fb3c52a..16c2194ebaaffdc1b036f898da5596c480ddf13e 100644 (file)
--- a/src/pkg/gob/debug.go
+++ b/src/pkg/gob/debug.go
@@ -154,6 +154,7 @@ func (deb *debugger) dump(format string, args ...interface{}) {
 }
 
 // Debug prints a human-readable representation of the gob data read from r.
+// It is a no-op unless debugging was enabled when the package was built.
 func Debug(r io.Reader) {
        err := debug(r)
        if err != nil {