1
0
mirror of https://github.com/golang/go synced 2024-11-19 00:44:40 -07:00

gob: clarify the comments about installing the debug/dumper.

R=rsc
CC=golang-dev
https://golang.org/cl/2789043
This commit is contained in:
Rob Pike 2010-10-29 15:52:25 -07:00
parent 96b9efe8a9
commit c490bb6f81
2 changed files with 5 additions and 3 deletions

View File

@ -1,6 +1,7 @@
package gob
// This file is not normally included in the gob package. Used only for debugging the package itself.
// Add debug.go to the files listed in the Makefile to add Debug to the gob package.
import (
"bytes"
@ -14,7 +15,7 @@ import (
var dump = false // If true, print the remaining bytes in the input buffer at each item.
// Init installs the debugging facility. If this file is not compiled in the
// package, Debug will be a no-op.
// package, the test in codec_test.go is a no-op.
func init() {
debugFunc = Debug
}

View File

@ -153,6 +153,7 @@ func (dec *Decoder) DecodeValue(value reflect.Value) os.Error {
return dec.err
}
// If enabled, Debug prints a human-readable representation of the gob data read from r.
// If debug.go is compiled into the program it will override this link.
// If debug.go is compiled into the program , debugFunc prints a human-readable
// representation of the gob data read from r by calling that file's Debug function.
// Otherwise it is nil.
var debugFunc func(io.Reader)