From: Ian Lance Taylor <iant@golang.org>
Date: Mon, 26 Nov 2018 20:11:34 +0000 (-0800)
Subject: runtime: improve godoc formatting of memclrNoHeapPointers comment
X-Git-Tag: go1.12beta1~268
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=9e849dcee4a7049325e483bddef27c22b19dd88b;p=gostls13.git

runtime: improve godoc formatting of memclrNoHeapPointers comment

Fixes #28955

Change-Id: I738ad0c76f7bf8fc504a48cf55d3becd5ed7a9d6
Reviewed-on: https://go-review.googlesource.com/c/151337
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
---

diff --git a/src/runtime/stubs.go b/src/runtime/stubs.go
index bb4fd2cc83..0d5503a6f5 100644
--- a/src/runtime/stubs.go
+++ b/src/runtime/stubs.go
@@ -68,12 +68,12 @@ func badsystemstack() {
 // used only when the caller knows that *ptr contains no heap pointers
 // because either:
 //
-// 1. *ptr is initialized memory and its type is pointer-free.
+// *ptr is initialized memory and its type is pointer-free, or
 //
-// 2. *ptr is uninitialized memory (e.g., memory that's being reused
-//    for a new allocation) and hence contains only "junk".
+// *ptr is uninitialized memory (e.g., memory that's being reused
+// for a new allocation) and hence contains only "junk".
 //
-// in memclr_*.s
+// The (CPU-specific) implementations of this function are in memclr_*.s.
 //go:noescape
 func memclrNoHeapPointers(ptr unsafe.Pointer, n uintptr)