From: Costin Chirvasuta <ctin@google.com>
Date: Fri, 7 Jul 2017 20:26:45 +0000 (+0100)
Subject: runtime: simplify description of FuncForPC behavior in case of inlining
X-Git-Tag: go1.9rc1~81
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=58ae050055ef00b97f1119e042fe7b459b20e839;p=gostls13.git

runtime: simplify description of FuncForPC behavior in case of inlining

The current description refers to the outermost "frame" which can be
misleading. A user reading it can think it means a stack frame.

Change-Id: Ie2c7cb4b4db8f41572df206478ce3b46a0245a5d
Reviewed-on: https://go-review.googlesource.com/47850
Reviewed-by: Austin Clements <austin@google.com>
---

diff --git a/src/runtime/symtab.go b/src/runtime/symtab.go
index ced42dad61..3bba87db5a 100644
--- a/src/runtime/symtab.go
+++ b/src/runtime/symtab.go
@@ -575,7 +575,7 @@ func moduledataverify1(datap *moduledata) {
 // given program counter address, or else nil.
 //
 // If pc represents multiple functions because of inlining, it returns
-// the *Func describing the outermost frame at pc.
+// the *Func describing the outermost function.
 func FuncForPC(pc uintptr) *Func {
 	return findfunc(pc)._Func()
 }