mirror of
https://github.com/golang/go.git
synced 2025-12-08 06:10:04 +00:00
runtime: remove "hall of shame" comment from public documentation
The updated comment uses the same format as bytes.Repeat and math.Float32bits.
This commit is contained in:
parent
bc0406333f
commit
00fa155c75
1 changed files with 11 additions and 9 deletions
|
|
@ -695,22 +695,24 @@ func (md *moduledata) funcName(nameOff int32) string {
|
||||||
return gostringnocopy(&md.funcnametab[nameOff])
|
return gostringnocopy(&md.funcnametab[nameOff])
|
||||||
}
|
}
|
||||||
|
|
||||||
// FuncForPC returns a *[Func] describing the function that contains the
|
// Despite being an exported symbol,
|
||||||
// given program counter address, or else nil.
|
// FuncForPC is linknamed by widely used packages.
|
||||||
//
|
|
||||||
// If pc represents multiple functions because of inlining, it returns
|
|
||||||
// the *Func describing the innermost function, but with an entry of
|
|
||||||
// the outermost function.
|
|
||||||
//
|
|
||||||
// For completely unclear reasons, even though they can import runtime,
|
|
||||||
// some widely used packages access this using linkname.
|
|
||||||
// Notable members of the hall of shame include:
|
// Notable members of the hall of shame include:
|
||||||
// - gitee.com/quant1x/gox
|
// - gitee.com/quant1x/gox
|
||||||
//
|
//
|
||||||
// Do not remove or change the type signature.
|
// Do not remove or change the type signature.
|
||||||
// See go.dev/issue/67401.
|
// See go.dev/issue/67401.
|
||||||
//
|
//
|
||||||
|
// Note that this comment is not part of the doc comment.
|
||||||
|
//
|
||||||
//go:linkname FuncForPC
|
//go:linkname FuncForPC
|
||||||
|
|
||||||
|
// FuncForPC returns a *[Func] describing the function that contains the
|
||||||
|
// given program counter address, or else nil.
|
||||||
|
//
|
||||||
|
// If pc represents multiple functions because of inlining, it returns
|
||||||
|
// the *Func describing the innermost function, but with an entry of
|
||||||
|
// the outermost function.
|
||||||
func FuncForPC(pc uintptr) *Func {
|
func FuncForPC(pc uintptr) *Func {
|
||||||
f := findfunc(pc)
|
f := findfunc(pc)
|
||||||
if !f.valid() {
|
if !f.valid() {
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue