code review 4431055: gofix, gofmt: update documentation

gofix, gofmt: update documentation

gofmt: also fix a typo in gofmt.go

[gri, 2011-04-20 17:33:14]

Hello rsc (cc: golang-dev@googlegroups.com),

I'd like you to review this change to
https://go.googlecode.com/hg/

[r, 2011-04-20 17:35:40]

http://codereview.appspot.com/4431055/diff/5001/src/cmd/gofix/doc.go
File src/cmd/gofix/doc.go (right):

http://codereview.appspot.com/4431055/diff/5001/src/cmd/gofix/doc.go#newcode21
src/cmd/gofix/doc.go:21: If the -diff flag is set, no rewrites are written but
instead the
no files are rewritten. Instead gofix prints the differences a rewrite would
introduce.

http://codereview.appspot.com/4431055/diff/5001/src/cmd/gofix/doc.go#newcode38
src/cmd/gofix/doc.go:38: // BUG: -diff only works if a diff program is found.
delete.

same in other places

http://codereview.appspot.com/4431055/diff/5001/src/cmd/gofmt/doc.go
File src/cmd/gofmt/doc.go (right):

http://codereview.appspot.com/4431055/diff/5001/src/cmd/gofmt/doc.go#newcode65
src/cmd/gofmt/doc.go:65: // BUG: -diff only works if a diff program is found.
delete but anyway there is no -diff.

[gri, 2011-04-20 17:41:43]

PTAL

http://codereview.appspot.com/4431055/diff/5001/src/cmd/gofix/doc.go
File src/cmd/gofix/doc.go (right):

http://codereview.appspot.com/4431055/diff/5001/src/cmd/gofix/doc.go#newcode21
src/cmd/gofix/doc.go:21: If the -diff flag is set, no rewrites are written but
instead the
On 2011/04/20 17:35:40, r wrote:
> no files are rewritten. Instead gofix prints the differences a rewrite would
> introduce.

Done.

http://codereview.appspot.com/4431055/diff/5001/src/cmd/gofix/doc.go#newcode38
src/cmd/gofix/doc.go:38: // BUG: -diff only works if a diff program is found.
On 2011/04/20 17:35:40, r wrote:
> delete.
> 
> same in other places

Done.

http://codereview.appspot.com/4431055/diff/5001/src/cmd/gofmt/doc.go
File src/cmd/gofmt/doc.go (right):

http://codereview.appspot.com/4431055/diff/5001/src/cmd/gofmt/doc.go#newcode65
src/cmd/gofmt/doc.go:65: // BUG: -diff only works if a diff program is found.
On 2011/04/20 17:35:40, r wrote:
> delete but anyway there is no -diff.

Done.

[rsc, 2011-04-20 17:45:26]

LGTM

possible cleanup below.
either way

http://codereview.appspot.com/4431055/diff/7003/src/cmd/gofmt/doc.go
File src/cmd/gofmt/doc.go (right):

http://codereview.appspot.com/4431055/diff/7003/src/cmd/gofmt/doc.go#newcode10
src/cmd/gofmt/doc.go:10: that directory, recursively.  (Files starting with a
period are ignored.)
add
By default, gofmt prints the reformatted sources to standard output.

http://codereview.appspot.com/4431055/diff/7003/src/cmd/gofmt/doc.go#newcode18
src/cmd/gofmt/doc.go:18: just print the diffs of files whose formatting differs
from gofmt's;
Do not print reformatted sources to standard output.
If a file's formatting is different than gofmt's, print diffs to standard
output.

http://codereview.appspot.com/4431055/diff/7003/src/cmd/gofmt/doc.go#newcode21
src/cmd/gofmt/doc.go:21: just list files whose formatting differs from gofmt's;
Do not print reformatted sources to standard output.
If a file's formatting is different from gofmt's, print its name to standard
output.

http://codereview.appspot.com/4431055/diff/7003/src/cmd/gofmt/doc.go#newcode28
src/cmd/gofmt/doc.go:28: if set, overwrite each input file with its output.
Do not print reformatted sources to standard output.
If a file's formatting is different from gofmt's, overwrite it with gofmt's
version.

[r, 2011-04-20 17:47:59]

i like rsc's versions.

[gri, 2011-04-20 18:00:58]

done and submitting

http://codereview.appspot.com/4431055/diff/7003/src/cmd/gofmt/doc.go
File src/cmd/gofmt/doc.go (right):

http://codereview.appspot.com/4431055/diff/7003/src/cmd/gofmt/doc.go#newcode10
src/cmd/gofmt/doc.go:10: that directory, recursively.  (Files starting with a
period are ignored.)
On 2011/04/20 17:45:26, rsc wrote:
> add
> By default, gofmt prints the reformatted sources to standard output.

Done.

http://codereview.appspot.com/4431055/diff/7003/src/cmd/gofmt/doc.go#newcode18
src/cmd/gofmt/doc.go:18: just print the diffs of files whose formatting differs
from gofmt's;
On 2011/04/20 17:45:26, rsc wrote:
> Do not print reformatted sources to standard output.
> If a file's formatting is different than gofmt's, print diffs to standard
> output.

Done.

http://codereview.appspot.com/4431055/diff/7003/src/cmd/gofmt/doc.go#newcode21
src/cmd/gofmt/doc.go:21: just list files whose formatting differs from gofmt's;
On 2011/04/20 17:45:26, rsc wrote:
> Do not print reformatted sources to standard output.
> If a file's formatting is different from gofmt's, print its name to standard
> output.

Done.

http://codereview.appspot.com/4431055/diff/7003/src/cmd/gofmt/doc.go#newcode28
src/cmd/gofmt/doc.go:28: if set, overwrite each input file with its output.
On 2011/04/20 17:45:26, rsc wrote:
> Do not print reformatted sources to standard output.
> If a file's formatting is different from gofmt's, overwrite it with gofmt's
> version.

Done.

[gri, 2011-04-20 18:01:28]

*** Submitted as http://code.google.com/p/go/source/detail?r=9c0e844716a6 ***

gofix, gofmt: update documentation

gofmt: also fix a typo in gofmt.go

R=rsc, r
CC=golang-dev
http://codereview.appspot.com/4431055