runtime/pprof: document OS X being broken

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/5307078

diff --git a/src/pkg/runtime/pprof/pprof.go b/src/pkg/runtime/pprof/pprof.go
index fdeceb4e8dc6747e612615f92c38cceccc188b8b..702289645450d512c5d14804e88c0f962270abfb 100644 (file)
--- a/src/pkg/runtime/pprof/pprof.go
+++ b/src/pkg/runtime/pprof/pprof.go
@@ -17,6 +17,9 @@ import (
        "sync"
 )
 
+// BUG(rsc): CPU profiling is broken on OS X, due to an Apple kernel bug.
+// For details, see http://code.google.com/p/go/source/detail?r=35b716c94225.
+
 // WriteHeapProfile writes a pprof-formatted heap profile to w.
 // If a write to w returns an error, WriteHeapProfile returns that error.
 // Otherwise, WriteHeapProfile returns nil.