diff options
author | Russ Cox <rsc@golang.org> | 2009-11-09 11:45:15 -0800 |
---|---|---|
committer | Russ Cox <rsc@golang.org> | 2009-11-09 11:45:15 -0800 |
commit | 18ccbc69f8ba71a396acba50ecfe5a591f687c78 (patch) | |
tree | 6ccb9fc324805c484d6ca526ca484c2dd4470086 | |
parent | 81672e79e4ce6efa60b4d97515d19f2f530c2c43 (diff) | |
download | go-18ccbc69f8ba71a396acba50ecfe5a591f687c78.tar.gz go-18ccbc69f8ba71a396acba50ecfe5a591f687c78.zip |
tweak documentation of commands
so that first sentence is better for cmd page.
live at http://r45:3456/cmd/
R=gri, r
http://go/go-review/1024034
-rw-r--r-- | src/cmd/5a/doc.go | 2 | ||||
-rw-r--r-- | src/cmd/5c/doc.go | 2 | ||||
-rw-r--r-- | src/cmd/5g/doc.go | 4 | ||||
-rw-r--r-- | src/cmd/5l/doc.go | 2 | ||||
-rw-r--r-- | src/cmd/6a/doc.go | 2 | ||||
-rw-r--r-- | src/cmd/6c/doc.go | 2 | ||||
-rw-r--r-- | src/cmd/6g/doc.go | 4 | ||||
-rw-r--r-- | src/cmd/6l/doc.go | 2 | ||||
-rw-r--r-- | src/cmd/8a/doc.go | 2 | ||||
-rw-r--r-- | src/cmd/8c/doc.go | 2 | ||||
-rw-r--r-- | src/cmd/8g/doc.go | 4 | ||||
-rw-r--r-- | src/cmd/8l/doc.go | 2 | ||||
-rw-r--r-- | src/cmd/cc/doc.go | 4 | ||||
-rw-r--r-- | src/cmd/ebnflint/doc.go | 4 | ||||
-rw-r--r-- | src/cmd/gc/doc.go | 2 | ||||
-rw-r--r-- | src/cmd/godoc/doc.go | 2 | ||||
-rw-r--r-- | src/cmd/gofmt/doc.go | 2 | ||||
-rw-r--r-- | src/cmd/gopack/doc.go | 2 | ||||
-rw-r--r-- | src/cmd/gotest/doc.go | 2 | ||||
-rw-r--r-- | src/cmd/goyacc/doc.go | 4 | ||||
-rw-r--r-- | src/cmd/hgpatch/doc.go | 9 | ||||
-rw-r--r-- | src/cmd/ld/doc.go | 4 | ||||
-rw-r--r-- | src/cmd/nm/doc.go | 2 |
23 files changed, 33 insertions, 34 deletions
diff --git a/src/cmd/5a/doc.go b/src/cmd/5a/doc.go index 91a86e9954..a0d2c4c648 100644 --- a/src/cmd/5a/doc.go +++ b/src/cmd/5a/doc.go @@ -4,7 +4,7 @@ /* -5a is a version of the Plan 9 assembler documented at +5a is a version of the Plan 9 assembler. The original is documented at http://plan9.bell-labs.com/magic/man2html/1/2a diff --git a/src/cmd/5c/doc.go b/src/cmd/5c/doc.go index f1b3fa152e..0874293bf4 100644 --- a/src/cmd/5c/doc.go +++ b/src/cmd/5c/doc.go @@ -4,7 +4,7 @@ /* -5c is a version of the Plan 9 C compiler documented at +5c is a version of the Plan 9 C compiler. The original is documented at http://plan9.bell-labs.com/magic/man2html/1/2c diff --git a/src/cmd/5g/doc.go b/src/cmd/5g/doc.go index e45e355689..e86013bdd7 100644 --- a/src/cmd/5g/doc.go +++ b/src/cmd/5g/doc.go @@ -4,8 +4,8 @@ /* -5g is the version of the gc compiler for the ARM, -referred to by these tools as arm. +5g is the version of the gc compiler for the ARM. +The $GOARCH for these tools is arm. It reads .go files and outputs .5 files. The flags are documented in ../gc/doc.go. diff --git a/src/cmd/5l/doc.go b/src/cmd/5l/doc.go index 495f6fa293..be1fddd706 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 linker documented at +5l is a modified version of the Plan 9 linker. The original is documented at http://plan9.bell-labs.com/magic/man2html/1/2l diff --git a/src/cmd/6a/doc.go b/src/cmd/6a/doc.go index 4f372aa653..92fb74de66 100644 --- a/src/cmd/6a/doc.go +++ b/src/cmd/6a/doc.go @@ -4,7 +4,7 @@ /* -6a is a version of the Plan 9 assembler documented at +6a is a version of the Plan 9 assembler. The original is documented at http://plan9.bell-labs.com/magic/man2html/1/2a diff --git a/src/cmd/6c/doc.go b/src/cmd/6c/doc.go index b71aad98ec..249a8ed801 100644 --- a/src/cmd/6c/doc.go +++ b/src/cmd/6c/doc.go @@ -4,7 +4,7 @@ /* -6c is a version of the Plan 9 C compiler documented at +6c is a version of the Plan 9 C compiler. The original is documented at http://plan9.bell-labs.com/magic/man2html/1/2c diff --git a/src/cmd/6g/doc.go b/src/cmd/6g/doc.go index e4964dbd0a..64f1d2ba90 100644 --- a/src/cmd/6g/doc.go +++ b/src/cmd/6g/doc.go @@ -4,8 +4,8 @@ /* -6g is the version of the gc compiler for the x86-64, -referred to by these tools as amd64. +6g is the version of the gc compiler for the x86-64. +The $GOARCH for these tools is amd64. It reads .go files and outputs .6 files. The flags are documented in ../gc/doc.go. diff --git a/src/cmd/6l/doc.go b/src/cmd/6l/doc.go index 2cbadda4db..6a0a735c8e 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 linker documented at +6l is a modified version of the Plan 9 linker. The original is documented at http://plan9.bell-labs.com/magic/man2html/1/2l diff --git a/src/cmd/8a/doc.go b/src/cmd/8a/doc.go index f9970e6398..a43b4461f6 100644 --- a/src/cmd/8a/doc.go +++ b/src/cmd/8a/doc.go @@ -4,7 +4,7 @@ /* -8a is a version of the Plan 9 assembler documented at +8a is a version of the Plan 9 assembler. The original is documented at http://plan9.bell-labs.com/magic/man2html/1/2a diff --git a/src/cmd/8c/doc.go b/src/cmd/8c/doc.go index c16ae4e89d..e3aae857f6 100644 --- a/src/cmd/8c/doc.go +++ b/src/cmd/8c/doc.go @@ -4,7 +4,7 @@ /* -8c is a version of the Plan 9 C compiler documented at +8c is a version of the Plan 9 C compiler. The original is documented at http://plan9.bell-labs.com/magic/man2html/1/2c diff --git a/src/cmd/8g/doc.go b/src/cmd/8g/doc.go index 5b522fd14e..2d9ff9a427 100644 --- a/src/cmd/8g/doc.go +++ b/src/cmd/8g/doc.go @@ -4,8 +4,8 @@ /* -8g is the version of the gc compiler for the x86, -referred to by these tools for historical reasons as 386. +8g is the version of the gc compiler for the x86. +The $GOARCH for these tools is 386. It reads .go files and outputs .8 files. The flags are documented in ../gc/doc.go. diff --git a/src/cmd/8l/doc.go b/src/cmd/8l/doc.go index 79cb83c1f5..0de4dfc1b1 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 linker documented at +8l is a modified version of the Plan 9 linker. The original is 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 index c924495918..51aa8b1923 100644 --- a/src/cmd/cc/doc.go +++ b/src/cmd/cc/doc.go @@ -4,8 +4,8 @@ /* -This directory contains the portable section of the Plan 9 C compilers as -represented here. See ../6c, ../8c, and ../5c for more information. +This directory contains the portable section of the Plan 9 C compilers. +See ../6c, ../8c, and ../5c for more information. */ package documentation diff --git a/src/cmd/ebnflint/doc.go b/src/cmd/ebnflint/doc.go index d395a34683..f35976eea7 100644 --- a/src/cmd/ebnflint/doc.go +++ b/src/cmd/ebnflint/doc.go @@ -4,8 +4,8 @@ /* -The ebnflint program verifies that EBNF productions in an HTML document -such as the Go specification document are consistent and grammatically correct. +Ebnflint verifies that EBNF productions are consistent and gramatically correct. +It reads them from an HTML document such as the Go specification. Grammar productions are grouped in boxes demarcated by the HTML elements <pre class="ebnf"> diff --git a/src/cmd/gc/doc.go b/src/cmd/gc/doc.go index f231132909..5250cfcbe8 100644 --- a/src/cmd/gc/doc.go +++ b/src/cmd/gc/doc.go @@ -4,7 +4,7 @@ /* -The name gc is the generic label given to the family of Go compilers +Gc is the generic label for the family of Go compilers that function as part of the (modified) Plan 9 tool chain. The C compiler documentation at diff --git a/src/cmd/godoc/doc.go b/src/cmd/godoc/doc.go index a116e321fb..0831035e19 100644 --- a/src/cmd/godoc/doc.go +++ b/src/cmd/godoc/doc.go @@ -4,7 +4,7 @@ /* -The godoc program extracts and generates documentation for Go programs. +Godoc extracts and generates documentation for Go programs. It has two modes. diff --git a/src/cmd/gofmt/doc.go b/src/cmd/gofmt/doc.go index a374add4a4..5851fe2d99 100644 --- a/src/cmd/gofmt/doc.go +++ b/src/cmd/gofmt/doc.go @@ -4,7 +4,7 @@ /* -The gofmt program is a formatter for Go programs. +Gofmt formats Go programs. Without an explicit path, it processes the standard input. Given a file, it operates on that file; given a directory, it operates on all .go files in diff --git a/src/cmd/gopack/doc.go b/src/cmd/gopack/doc.go index 241784dc33..0d5ccdb6ce 100644 --- a/src/cmd/gopack/doc.go +++ b/src/cmd/gopack/doc.go @@ -4,7 +4,7 @@ /* -The gopack program is a variant of the Plan 9 ar tool documented at +Gopack program is a variant of the Plan 9 ar tool. The original is documented at http://plan9.bell-labs.com/magic/man2html/1/ar diff --git a/src/cmd/gotest/doc.go b/src/cmd/gotest/doc.go index 43119141d5..e1a87c43cd 100644 --- a/src/cmd/gotest/doc.go +++ b/src/cmd/gotest/doc.go @@ -4,7 +4,7 @@ /* -The gotest program is an automated testing tool for Go packages. +Gotest is an automated testing tool for Go packages. Normally a Go package is compiled without its test files. Gotest is a simple script that recompiles the package along with any files diff --git a/src/cmd/goyacc/doc.go b/src/cmd/goyacc/doc.go index ea5813ebc3..a3cf07533e 100644 --- a/src/cmd/goyacc/doc.go +++ b/src/cmd/goyacc/doc.go @@ -4,8 +4,8 @@ /* -The program goyacc is a version of yacc written in Go and generating -as output a parser also in Go. +Goyacc is a version of yacc for Go. +It is written in Go and generates parsers written in Go. It is largely transliterated from the Inferno version written in Limbo which in turn was largely transliterated from the Plan 9 version diff --git a/src/cmd/hgpatch/doc.go b/src/cmd/hgpatch/doc.go index 5d7674acf6..a3d069faeb 100644 --- a/src/cmd/hgpatch/doc.go +++ b/src/cmd/hgpatch/doc.go @@ -4,11 +4,10 @@ /* -Hgpatch reads a patch, which should have been generated by -a version control system like CVS, GIT, Mercurial, or Subversion, -from a file (or standard input) and applies that patch to the local -Mercurial repository. If successful, it writes a list of affected -files to standard output. +Hgpatch applies a patch to the local Mercurial repository. +The patch should have been been generated by +a version control system like CVS, GIT, Mercurial, or Subversion. +If successful, hgpatch writes a list of affected files to standard output. Hgpatch is meant to be used by the Mercurial codereview extension. diff --git a/src/cmd/ld/doc.go b/src/cmd/ld/doc.go index efdba719fe..972e2a32c9 100644 --- a/src/cmd/ld/doc.go +++ b/src/cmd/ld/doc.go @@ -4,8 +4,8 @@ /* -This directory contains the portable section of the Plan 9 C linkers as -represented here. See ../6l, ../8l, and ../5l for more information. +This directory contains the portable section of the Plan 9 C linkers. +See ../6l, ../8l, and ../5l for more information. */ package documentation diff --git a/src/cmd/nm/doc.go b/src/cmd/nm/doc.go index 60f08f568c..84a91792fb 100644 --- a/src/cmd/nm/doc.go +++ b/src/cmd/nm/doc.go @@ -4,7 +4,7 @@ /* -This nm is a version of the Plan 9 nm command documented at +Nm is a version of the Plan 9 nm command. The original is documented at http://plan9.bell-labs.com/magic/man2html/1/nm |