summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRob Pike <r@golang.org>2009-05-08 15:55:45 -0700
committerRob Pike <r@golang.org>2009-05-08 15:55:45 -0700
commit52c834fb66c31e5d97f0c5853a671b95b9b137b0 (patch)
tree80f0f929f7b3221c245031b88d3b2ccafeaf5ff7
parenta8e007fd64c2f9de7b8a17840e14641f92274ce8 (diff)
downloadgolang-52c834fb66c31e5d97f0c5853a671b95b9b137b0.tar.gz
Document runtime functions.
R=rsc DELTA=25 (25 added, 0 deleted, 0 changed) OCL=28574 CL=28580
-rw-r--r--src/lib/runtime/runtime.go26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/lib/runtime/runtime.go b/src/lib/runtime/runtime.go
new file mode 100644
index 000000000..e3cf54c7f
--- /dev/null
+++ b/src/lib/runtime/runtime.go
@@ -0,0 +1,26 @@
+// Copyright 2009 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+/*
+ The runtime package contains operations that interact with Go's runtime system,
+ such as functions to control goroutines.
+ */
+package runtime
+
+// Gosched yields the processor, allowing other goroutines to run. It does not
+// suspend the current goroutine, so execution resumes automatically.
+func Gosched()
+
+// Goexit terminates the goroutine that calls it. No other goroutine is affected.
+func Goexit()
+
+// Breakpoint() executes a breakpoint trap.
+func Breakpoint()
+
+// Caller reports file and line number information about function invocations on
+// the calling goroutine's stack. The argument is the number of stack frames to
+// ascend, with 1 identifying the the caller of Caller. The return values report the
+// program counter, file name, and line number within the file of the corresponding
+// call. The boolean ok is false if it was not possible to recover the information.
+func Caller(n int) (pc uint64, file string, line int, ok bool)