summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorRob Pike <r@golang.org>2009-11-03 17:46:35 -0800
committerRob Pike <r@golang.org>2009-11-03 17:46:35 -0800
commit3b396c123dcf8d6fa1d7ea7abc52fa23b6f306f4 (patch)
tree2815419c34fcdcb08c15ffc5c302c17ad4a5b424 /src
parentce554686b73e3fe9fabc40c4fd0bbc452f2e338d (diff)
downloadgo-3b396c123dcf8d6fa1d7ea7abc52fa23b6f306f4.tar.gz
more command documentation, including nm and prof
R=rsc http://go/go-review/1017022
Diffstat (limited to 'src')
-rw-r--r--src/cmd/5l/doc.go2
-rw-r--r--src/cmd/6l/doc.go2
-rw-r--r--src/cmd/8l/doc.go2
-rw-r--r--src/cmd/cc/doc.go11
-rw-r--r--src/cmd/ld/doc.go11
-rw-r--r--src/cmd/nm/doc.go18
-rw-r--r--src/cmd/prof/doc.go43
7 files changed, 86 insertions, 3 deletions
diff --git a/src/cmd/5l/doc.go b/src/cmd/5l/doc.go
index 1d22e3907..17200d57c 100644
--- a/src/cmd/5l/doc.go
+++ b/src/cmd/5l/doc.go
@@ -4,7 +4,7 @@
/*
-5l is a modified version of the Plan 9 loader documented at
+5l is a modified version of the Plan 9 linker documented at
http://plan9.bell-labs.com/magic/man2html/1/2l
diff --git a/src/cmd/6l/doc.go b/src/cmd/6l/doc.go
index 331d0c1d9..8d87f820e 100644
--- a/src/cmd/6l/doc.go
+++ b/src/cmd/6l/doc.go
@@ -4,7 +4,7 @@
/*
-6l is a modified version of the Plan 9 loader documented at
+6l is a modified version of the Plan 9 linker documented at
http://plan9.bell-labs.com/magic/man2html/1/2l
diff --git a/src/cmd/8l/doc.go b/src/cmd/8l/doc.go
index 82796d26f..36628045c 100644
--- a/src/cmd/8l/doc.go
+++ b/src/cmd/8l/doc.go
@@ -4,7 +4,7 @@
/*
-8l is a modified version of the Plan 9 loader documented at
+8l is a modified version of the Plan 9 linker documented at
http://plan9.bell-labs.com/magic/man2html/1/2l
diff --git a/src/cmd/cc/doc.go b/src/cmd/cc/doc.go
new file mode 100644
index 000000000..c92449591
--- /dev/null
+++ b/src/cmd/cc/doc.go
@@ -0,0 +1,11 @@
+// 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.
+
+/*
+
+This directory contains the portable section of the Plan 9 C compilers as
+represented here. See ../6c, ../8c, and ../5c for more information.
+
+*/
+package documentation
diff --git a/src/cmd/ld/doc.go b/src/cmd/ld/doc.go
new file mode 100644
index 000000000..efdba719f
--- /dev/null
+++ b/src/cmd/ld/doc.go
@@ -0,0 +1,11 @@
+// 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.
+
+/*
+
+This directory contains the portable section of the Plan 9 C linkers as
+represented here. See ../6l, ../8l, and ../5l for more information.
+
+*/
+package documentation
diff --git a/src/cmd/nm/doc.go b/src/cmd/nm/doc.go
new file mode 100644
index 000000000..5c171797b
--- /dev/null
+++ b/src/cmd/nm/doc.go
@@ -0,0 +1,18 @@
+// 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.
+
+/*
+
+nm is a version of the Plan 9 nm command documented at
+
+ http://plan9.bell-labs.com/magic/man2html/1/nm
+
+It prints the name list (symbol table) for programs compiled by gc as well as the
+Plan 9 C compiler.
+
+For reasons of disambiguation it is installed as 6nm although it also serves
+as an 8nm and a 5nm.
+
+*/
+package documentation
diff --git a/src/cmd/prof/doc.go b/src/cmd/prof/doc.go
new file mode 100644
index 000000000..8b2732ab3
--- /dev/null
+++ b/src/cmd/prof/doc.go
@@ -0,0 +1,43 @@
+// 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.
+
+/*
+
+prof is a rudimentary real-time profiler.
+
+Given a command to run or the process id (pid) of a command already
+running, it samples the program's state at regular intervals and reports
+on its behavior. With no options, it prints a histogram of the locations
+in the code that were sampled during execution.
+
+Since it is a real-time profiler, unlike a traditional profiler it samples
+the program's state even when it is not running, such as when it is
+asleep or waiting for I/O. Each thread contributes equally to the
+statistics.
+
+
+Usage: prof -p pid [-t total_secs] [-d delta_msec] [6.out args ...]
+
+The formats (default -h) are:
+
+ -h: histograms
+ How many times a sample occurred at each location
+ -f: dynamic functions
+ At each sample period, print the name of the executing function.
+ -l: dynamic file and line numbers
+ At each sample period, print the file and line number of the executing instruction.
+ -r: dynamic registers
+ At each sample period, print the register contents.
+ -s: dynamic function stack traces
+ At each sample period, print the symbolic stack trace.
+
+Flag -t sets the maximum real time to sample, in seconds, and -d
+sets the sampling interval in milliseconds. The default is to sample
+every 100ms until the program completes.
+
+For reasons of disambiguation it is installed as 6prof although it also serves
+as an 8prof and a 5prof.
+
+*/
+package documentation