summaryrefslogtreecommitdiff
path: root/src/pkg/malloc/malloc.go
diff options
context:
space:
mode:
authorRob Pike <r@golang.org>2009-11-08 15:57:25 -0800
committerRob Pike <r@golang.org>2009-11-08 15:57:25 -0800
commit572de8502823471bd43eb7e4f7e419b9d3007677 (patch)
treeaccef69637850fbdddcf0cd11750299d641341ee /src/pkg/malloc/malloc.go
parent4b6683284c7c74500e7784df7e27d37d7f218609 (diff)
downloadgolang-572de8502823471bd43eb7e4f7e419b9d3007677.tar.gz
add top-level package comments for net, reflect, malloc.
reflect is a little more detailed than some because it affords an opportunity to explain how to approach the library. R=gri, rsc CC=go-dev http://go/go-review/1026026
Diffstat (limited to 'src/pkg/malloc/malloc.go')
-rw-r--r--src/pkg/malloc/malloc.go3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/pkg/malloc/malloc.go b/src/pkg/malloc/malloc.go
index 838b92f5f..66708a680 100644
--- a/src/pkg/malloc/malloc.go
+++ b/src/pkg/malloc/malloc.go
@@ -6,6 +6,9 @@
// The actual functions are written in C
// and part of the runtime library.
+// The malloc package exposes statistics and other low-level details about
+// the run-time memory allocator and collector. It is intended for debugging
+// purposes only; other uses are discouraged.
package malloc
type Stats struct {