code review 5674067: doc: provide example filepath.Walk for go1

doc: provide example filepath.Walk for go1

[Mike.Rosset, 2012-02-16 05:27:11]

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

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

[r2, 2012-02-16 07:44:52]

Examples should be executable where possible, and I think that's easy here.
Have a look at the {{code}} entries in go1.tmpl for a guide. The snippets go
into progs/go1.go.

-rob

[Mike.Rosset, 2012-02-16 08:28:03]

On 2012/02/16 07:44:52, r2 wrote:
> Examples should be executable where possible, and I think that's easy here.
> Have a look at the {{code}} entries in go1.tmpl for a guide. The snippets go
> into progs/go1.go.
> 
> -rob

ah nice feature sorry I over looked it. I'll fix it to use progs/go1.go

[Mike.Rosset, 2012-02-16 08:29:05]

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

Please take another look.

[Mike.Rosset, 2012-02-16 08:37:37]

On 2012/02/16 08:29:05, Mike.Rosset wrote:
> Hello mailto:golang-dev@googlegroups.com, mailto:r@google.com (cc:
> mailto:golang-dev@googlegroups.com),
> 
> Please take another look.

/usr/share is probably not the most portable example. But I cant really think of
one that would cover everything especially windows.

Also progs/run is using gomake, so I could not test it. Should I make CL?

[r2, 2012-02-16 09:29:15]

On 16/02/2012, at 7:37 PM, Mike.Rosset@gmail.com wrote:

> On 2012/02/16 08:29:05, Mike.Rosset wrote:
>> Hello mailto:golang-dev@googlegroups.com, mailto:r@google.com (cc:
>> mailto:golang-dev@googlegroups.com),
> 
>> Please take another look.
> 
> /usr/share is probably not the most portable example. But I cant really
> think of one that would cover everything especially windows.
> 
> Also progs/run is using gomake, so I could not test it. Should I make
> CL?
> 
> http://codereview.appspot.com/5674067/

hg file 5674067 progs/go1.go

and no, don't update run yet. to test your changes for now, just run
	go run go1.go
in the progs directory.

the example can just run in the doc directory. don't use /usr/share.

-rob

[Mike.Rosset, 2012-02-16 15:47:16]

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

Please take another look.

[Mike.Rosset, 2012-02-16 15:52:36]

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

Please take another look.

[Mike.Rosset, 2012-02-16 15:53:09]

On 2012/02/16 15:52:36, Mike.Rosset wrote:
> Hello mailto:golang-dev@googlegroups.com, mailto:r@google.com (cc:
> mailto:golang-dev@googlegroups.com),
> 
> Please take another look.

sorry for the noise forgot to add go1.go. should be ok now

[r, 2012-02-16 20:09:17]

http://codereview.appspot.com/5674067/diff/4003/doc/go1.tmpl
File doc/go1.tmpl (right):

http://codereview.appspot.com/5674067/diff/4003/doc/go1.tmpl#newcode1427
doc/go1.tmpl:1427: the function should return the value <code>SkipDir</code>.
filepath.SkipDir and link it

http://codereview.appspot.com/5674067/diff/4003/doc/go1.tmpl#newcode1432
doc/go1.tmpl:1432: </p>
delete this paragraph. it's obviously an example.

http://codereview.appspot.com/5674067/diff/4003/doc/progs/go1.go
File doc/progs/go1.go (right):

http://codereview.appspot.com/5674067/diff/4003/doc/progs/go1.go#newcode196
doc/progs/go1.go:196: err := filepath.Walk("/usr/share", markFn)
as i said before, /usr/share won't exist on many machines, and this will break
the example.
if you can't find a reliable path in the go tree, i suggest making the test
compile but not run, but putting the call in an if statement in another function
(so it's not indented here)

[Mike.Rosset, 2012-02-17 00:13:59]

Hello golang-dev@googlegroups.com, r@google.com, r@golang.org (cc:
golang-dev@googlegroups.com),

Please take another look.

[Mike.Rosset, 2012-02-17 00:18:23]

On 2012/02/16 20:09:17, r wrote:
> http://codereview.appspot.com/5674067/diff/4003/doc/go1.tmpl
> File doc/go1.tmpl (right):
> 
> http://codereview.appspot.com/5674067/diff/4003/doc/go1.tmpl#newcode1427
> doc/go1.tmpl:1427: the function should return the value <code>SkipDir</code>.
> filepath.SkipDir and link it
Done
> http://codereview.appspot.com/5674067/diff/4003/doc/go1.tmpl#newcode1432
> doc/go1.tmpl:1432: </p>
> delete this paragraph. it's obviously an example.
> 
> http://codereview.appspot.com/5674067/diff/4003/doc/progs/go1.go
> File doc/progs/go1.go (right):
> 
> http://codereview.appspot.com/5674067/diff/4003/doc/progs/go1.go#newcode196
> doc/progs/go1.go:196: err := filepath.Walk("/usr/share", markFn)
> as i said before, /usr/share won't exist on many machines, and this will break
> the example.
> if you can't find a reliable path in the go tree, i suggest making the test
> compile but not run, but putting the call in an if statement in another
function
> (so it's not indented here)

I opted to use the current dir as in "." since go run only works from the dir
the file is in. Also tested on windows works. if you feel that "." will break
I'll change it to the function if statement you suggested.

I also expanded the example to include filepath.SkipDir which makes the example
more complete please check it.

[r, 2012-02-17 00:34:05]

LGTM
thanks

[r, 2012-02-17 00:34:50]

please hg sync, update, and remail. files changed underfoot

[Mike.Rosset, 2012-02-17 01:17:38]

Hello golang-dev@googlegroups.com, r@google.com, r@golang.org (cc:
golang-dev@googlegroups.com),

Please take another look.

[Mike.Rosset, 2012-02-17 01:18:53]

On 2012/02/17 00:34:50, r wrote:
> please hg sync, update, and remail. files changed underfoot

Done.

Had to merge by hand, seemed like simple change but please check.

[r, 2012-02-17 01:46:01]

*** Submitted as 238b181febf2 ***

doc: provide example filepath.Walk for go1

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

Committer: Rob Pike <r@golang.org>