aboutsummaryrefslogtreecommitdiff
path: root/src/pkg/debug/dwarf
diff options
context:
space:
mode:
authorRob Pike <r@golang.org>2012-02-17 12:47:56 +1100
committerRob Pike <r@golang.org>2012-02-17 12:47:56 +1100
commita15f59ef1da4c3ac23e46eef2fa679e0f41205bb (patch)
treefcb4a67bcd75268b02d7cc5cc57df1a36093a38b /src/pkg/debug/dwarf
parent91672686da0af0d2e21b022c36b9977a78ec490f (diff)
downloadgo-a15f59ef1da4c3ac23e46eef2fa679e0f41205bb.tar.xz
debug/dwarf: address TODO in doc comment for New
Fixes #2844. R=golang-dev, dsymonds CC=golang-dev https://golang.org/cl/5675072
Diffstat (limited to 'src/pkg/debug/dwarf')
-rw-r--r--src/pkg/debug/dwarf/open.go5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/pkg/debug/dwarf/open.go b/src/pkg/debug/dwarf/open.go
index 9543297e18..37a518b6d3 100644
--- a/src/pkg/debug/dwarf/open.go
+++ b/src/pkg/debug/dwarf/open.go
@@ -31,8 +31,9 @@ type Data struct {
}
// New returns a new Data object initialized from the given parameters.
-// Clients should typically use [TODO(rsc): method to be named later] instead of calling
-// New directly.
+// Rather than calling this function directly, clients should typically use
+// the DWARF method of the File type of the appropriate package debug/elf,
+// debug/macho, or debug/pe.
//
// The []byte arguments are the data from the corresponding debug section
// in the object file; for example, for an ELF object, abbrev is the contents of