]> Cypherpunks repositories - gostls13.git/commitdiff
tweak documentation of commands
authorRuss Cox <rsc@golang.org>
Mon, 9 Nov 2009 19:45:15 +0000 (11:45 -0800)
committerRuss Cox <rsc@golang.org>
Mon, 9 Nov 2009 19:45:15 +0000 (11:45 -0800)
so that first sentence is better for cmd page.

live at http://r45:3456/cmd/

R=gri, r
http://go/go-review/1024034

23 files changed:
src/cmd/5a/doc.go
src/cmd/5c/doc.go
src/cmd/5g/doc.go
src/cmd/5l/doc.go
src/cmd/6a/doc.go
src/cmd/6c/doc.go
src/cmd/6g/doc.go
src/cmd/6l/doc.go
src/cmd/8a/doc.go
src/cmd/8c/doc.go
src/cmd/8g/doc.go
src/cmd/8l/doc.go
src/cmd/cc/doc.go
src/cmd/ebnflint/doc.go
src/cmd/gc/doc.go
src/cmd/godoc/doc.go
src/cmd/gofmt/doc.go
src/cmd/gopack/doc.go
src/cmd/gotest/doc.go
src/cmd/goyacc/doc.go
src/cmd/hgpatch/doc.go
src/cmd/ld/doc.go
src/cmd/nm/doc.go

index 91a86e9954f1aa84f6b2b60e40c6de95b286afa6..a0d2c4c648f445008f63ebcecc557c52b50b9eef 100644 (file)
@@ -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
 
index f1b3fa152eebb596f916500c38660e39b0c2be02..0874293bf40a32ba4eec24886de69996ca98d8a4 100644 (file)
@@ -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
 
index e45e355689214154403878445b2b2aa4333772e2..e86013bdd7801c1519beccbbf2e507abb79dcf5f 100644 (file)
@@ -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.
 
index 495f6fa29368a56b99062ef8c59ff2bc1255b7f0..be1fddd706fef3f182095a774805c0910d116b3f 100644 (file)
@@ -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
 
index 4f372aa653ee4e587a5cc510488b6ceb0c5f63f6..92fb74de663c5fb99c05bd980735bc35d6acb4e0 100644 (file)
@@ -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
 
index b71aad98ecc0f700d6ed228c5360255b7036793f..249a8ed801e3f746f5cd6cfca59d8b3265326e96 100644 (file)
@@ -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
 
index e4964dbd0a34ead579c7fca1c1f383d10fec453f..64f1d2ba903543cb766e1e79a27f517828193b6a 100644 (file)
@@ -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.
 
index 2cbadda4db7f23718b885868f4f6456c2650099f..6a0a735c8e50c2a1ca80f87ade69263459369a3e 100644 (file)
@@ -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
 
index f9970e6398ab583e49621468a101014112aa6a7d..a43b4461f6bf662340bf65b0424c0154a39acf7b 100644 (file)
@@ -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
 
index c16ae4e89d4427305db0542c212c2dcc1c633769..e3aae857f6af02501bf163a2116518f9ce6bfb0c 100644 (file)
@@ -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
 
index 5b522fd14ed8ffd676c0ccd546bcd7904c88a998..2d9ff9a4273f46f036dcbfa47ca51fc536fc2507 100644 (file)
@@ -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.
 
index 79cb83c1f5ecca51ef32986f583c12d73cae5349..0de4dfc1b161eddd180d2eccd86127e4ffa9bb24 100644 (file)
@@ -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
 
index c9244959187041aaee3fb4549aecb6ea4deba4e4..51aa8b19238fee8edd2eeba9da4453ae8d4a6a16 100644 (file)
@@ -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
index d395a346835b3d36c204fce5078d8adfe772bd46..f35976eea73012d27788d20e5bf837dab342814f 100644 (file)
@@ -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">
index f231132909ba50f08bd5e87709c88c1fe7dde40e..5250cfcbe869ef39dc196eba586ef67898de5b07 100644 (file)
@@ -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
 
index a116e321fb7ee4ed744a554546f9a8d68fad3a87..0831035e196d098421650f9bad1060587d5ab0df 100644 (file)
@@ -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.
 
index a374add4a4af9435ca15cd485e690df2bd65b2b7..5851fe2d99bb7bddba97499fe21981a6b2670b46 100644 (file)
@@ -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
index 241784dc3392166d81778b8658c5e2abfd537cca..0d5ccdb6cedc288f68d5af94b35e55d204f6bc7d 100644 (file)
@@ -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
 
index 43119141d5c8fe07351ddcbfe6241dd0556aa985..e1a87c43cd1dc34c5acb8e12a9d343ba0760723b 100644 (file)
@@ -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
index ea5813ebc30f70c223deb9577cb0d744429443d3..a3cf07533e7dc2e7fe050acd635475c91221dcfd 100644 (file)
@@ -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
index 5d7674acf64fb4cc94428ddbac5dc13f8465b9b5..a3d069faeb57c0d7c0c3b37a15bcd55b59178ac7 100644 (file)
@@ -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.
 
index efdba719fee8c41d079b0a36b0263d11f79321ae..972e2a32c951171ad90cd94241d3f9d07a1d47b8 100644 (file)
@@ -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
index 60f08f568c3d48547803f7ad386bc551e8114ffa..84a91792fbf0541e0d5d23be9a31f0adc9078818 100644 (file)
@@ -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