From: David Crawshaw <crawshaw@golang.org>
Date: Wed, 16 Sep 2015 14:29:53 +0000 (-0400)
Subject: runtime/debug: more explicit Stack docs
X-Git-Tag: go1.6beta1~1055
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=9337dc9b5e4a79a071c8eb4879974955b19e3862;p=gostls13.git

runtime/debug: more explicit Stack docs

Change-Id: I81a7f22be827519b5290b4acbcba357680cad3c4
Reviewed-on: https://go-review.googlesource.com/14605
Reviewed-by: Rob Pike <r@golang.org>
---

diff --git a/src/runtime/debug/stack.go b/src/runtime/debug/stack.go
index 952d834bc4..5d810af540 100644
--- a/src/runtime/debug/stack.go
+++ b/src/runtime/debug/stack.go
@@ -11,15 +11,13 @@ import (
 	"runtime"
 )
 
-// PrintStack prints to standard error the stack trace returned by Stack.
+// PrintStack prints to standard error the stack trace returned by runtime.Stack.
 func PrintStack() {
 	os.Stderr.Write(Stack())
 }
 
 // Stack returns a formatted stack trace of the goroutine that calls it.
-// For each routine, it includes the source line information and PC value,
-// then attempts to discover, for Go functions, the calling function or
-// method.
+// It calls runtime.Stack with a large enough buffer to capture the entire trace.
 func Stack() []byte {
 	buf := make([]byte, 1024)
 	for {