diff options
| author | cui fliter <imcusg@gmail.com> | 2023-11-07 17:35:46 +0800 |
|---|---|---|
| committer | Gopher Robot <gobot@golang.org> | 2023-11-08 16:59:11 +0000 |
| commit | 6a1bbca2b3129b18f7d7e63b51536da2e9afe9e2 (patch) | |
| tree | e7a99852f607ed39fa16619d28633f5a089a9526 /src/runtime/pprof | |
| parent | fa903593fb7c40a5745817b68d9a71ab6b934009 (diff) | |
| download | go-6a1bbca2b3129b18f7d7e63b51536da2e9afe9e2.tar.xz | |
runtime: add available godoc link
Change-Id: Ifb4844efddcb0369b0302eeab72394eeaf5c8072
Reviewed-on: https://go-review.googlesource.com/c/go/+/540022
Reviewed-by: Michael Knyszek <mknyszek@google.com>
Auto-Submit: Michael Knyszek <mknyszek@google.com>
Reviewed-by: Heschi Kreinick <heschi@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Run-TryBot: shuang cui <imcusg@gmail.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Diffstat (limited to 'src/runtime/pprof')
| -rw-r--r-- | src/runtime/pprof/label.go | 4 | ||||
| -rw-r--r-- | src/runtime/pprof/pprof.go | 16 | ||||
| -rw-r--r-- | src/runtime/pprof/runtime.go | 2 |
3 files changed, 11 insertions, 11 deletions
diff --git a/src/runtime/pprof/label.go b/src/runtime/pprof/label.go index d39e0ad58e..3684ae34e5 100644 --- a/src/runtime/pprof/label.go +++ b/src/runtime/pprof/label.go @@ -54,7 +54,7 @@ func (l *labelMap) String() string { return "{" + strings.Join(keyVals, ", ") + "}" } -// WithLabels returns a new context.Context with the given labels added. +// WithLabels returns a new [context.Context] with the given labels added. // A label overwrites a prior label with the same key. func WithLabels(ctx context.Context, labels LabelSet) context.Context { parentLabels := labelValue(ctx) @@ -72,7 +72,7 @@ func WithLabels(ctx context.Context, labels LabelSet) context.Context { } // Labels takes an even number of strings representing key-value pairs -// and makes a LabelSet containing them. +// and makes a [LabelSet] containing them. // A label overwrites a prior label with the same key. // Currently only the CPU and goroutine profiles utilize any labels // information. diff --git a/src/runtime/pprof/pprof.go b/src/runtime/pprof/pprof.go index 17a490efed..d3a3c788b1 100644 --- a/src/runtime/pprof/pprof.go +++ b/src/runtime/pprof/pprof.go @@ -107,7 +107,7 @@ import ( // mutex - stack traces of holders of contended mutexes // // These predefined profiles maintain themselves and panic on an explicit -// Add or Remove method call. +// [Profile.Add] or [Profile.Remove] method call. // // The heap profile reports statistics as of the most recently completed // garbage collection; it elides more recent allocation to avoid skewing @@ -127,7 +127,7 @@ import ( // the program began (including garbage-collected bytes). // // The CPU profile is not available as a Profile. It has a special API, -// the StartCPUProfile and StopCPUProfile functions, because it streams +// the [StartCPUProfile] and [StopCPUProfile] functions, because it streams // output to a writer during profiling. type Profile struct { name string @@ -242,7 +242,7 @@ func Profiles() []*Profile { return all } -// Name returns this profile's name, which can be passed to Lookup to reobtain the profile. +// Name returns this profile's name, which can be passed to [Lookup] to reobtain the profile. func (p *Profile) Name() string { return p.name } @@ -260,9 +260,9 @@ func (p *Profile) Count() int { // Add adds the current execution stack to the profile, associated with value. // Add stores value in an internal map, so value must be suitable for use as // a map key and will not be garbage collected until the corresponding -// call to Remove. Add panics if the profile already contains a stack for value. +// call to [Profile.Remove]. Add panics if the profile already contains a stack for value. // -// The skip parameter has the same meaning as runtime.Caller's skip +// The skip parameter has the same meaning as [runtime.Caller]'s skip // and controls where the stack trace begins. Passing skip=0 begins the // trace in the function calling Add. For example, given this // execution stack: @@ -515,7 +515,7 @@ func printStackRecord(w io.Writer, stk []uintptr, allFrames bool) { // Interface to system profiles. -// WriteHeapProfile is shorthand for Lookup("heap").WriteTo(w, 0). +// WriteHeapProfile is shorthand for [Lookup]("heap").WriteTo(w, 0). // It is preserved for backwards compatibility. func WriteHeapProfile(w io.Writer) error { return writeHeap(w, 0) @@ -765,8 +765,8 @@ var cpu struct { // Go code built with -buildmode=c-archive or -buildmode=c-shared. // StartCPUProfile relies on the SIGPROF signal, but that signal will // be delivered to the main program's SIGPROF signal handler (if any) -// not to the one used by Go. To make it work, call os/signal.Notify -// for syscall.SIGPROF, but note that doing so may break any profiling +// not to the one used by Go. To make it work, call [os/signal.Notify] +// for [syscall.SIGPROF], but note that doing so may break any profiling // being done by the main program. func StartCPUProfile(w io.Writer) error { // The runtime routines allow a variable profiling rate, diff --git a/src/runtime/pprof/runtime.go b/src/runtime/pprof/runtime.go index 71f89ca680..8d37c7d3ad 100644 --- a/src/runtime/pprof/runtime.go +++ b/src/runtime/pprof/runtime.go @@ -31,7 +31,7 @@ func runtime_getProfLabel() unsafe.Pointer // SetGoroutineLabels sets the current goroutine's labels to match ctx. // A new goroutine inherits the labels of the goroutine that created it. -// This is a lower-level API than Do, which should be used instead when possible. +// This is a lower-level API than [Do], which should be used instead when possible. func SetGoroutineLabels(ctx context.Context) { ctxLabels, _ := ctx.Value(labelContextKey{}).(*labelMap) runtime_setProfLabel(unsafe.Pointer(ctxLabels)) |
