From: Rob Pike <r@golang.org>
Date: Fri, 17 Jul 2015 21:37:51 +0000 (+1000)
Subject: runtime: document that GC blocks the whole program
X-Git-Tag: go1.5beta3~164
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=ed9a4c91c2e82aabe8ef4a6391d9d3306eff63bc;p=gostls13.git

runtime: document that GC blocks the whole program

No code changes. Just make it clear that runtime.GC is not concurrent.

Change-Id: I00a99ebd26402817c665c9a128978cef19f037be
Reviewed-on: https://go-review.googlesource.com/12345
Reviewed-by: Dave Cheney <dave@cheney.net>
Reviewed-by: Ian Lance Taylor <iant@golang.org>
---

diff --git a/src/runtime/mgc.go b/src/runtime/mgc.go
index 4eff8fc59b..5bd6242932 100644
--- a/src/runtime/mgc.go
+++ b/src/runtime/mgc.go
@@ -770,7 +770,7 @@ var work struct {
 	initialHeapLive uint64
 }
 
-// GC runs a garbage collection and blocks until the garbage
+// GC runs a garbage collection and blocks the entire program until the
 // collection is complete.
 func GC() {
 	startGC(gcForceBlockMode)