code review 5538050: effective_go: provide reference to runtime.NumCPU()

effective_go: provide reference to runtime.NumCPU()

[dvyukov, 2012-01-12 10:51:32]

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

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

[rh, 2012-01-12 15:14:08]

LGTM fwiw

http://codereview.appspot.com/5538050/diff/1002/doc/effective_go.html
File doc/effective_go.html (right):

http://codereview.appspot.com/5538050/diff/1002/doc/effective_go.html#newcode...
doc/effective_go.html:2627: <code>runtime.GOMAXPROCS(NCPU)</code> (to use all
available cores call
Comma after cores?

[dvyukov, 2012-01-12 15:21:36]

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

Please take another look.

[r, 2012-01-12 15:27:17]

http://codereview.appspot.com/5538050/diff/3006/doc/effective_go.tmpl
File doc/effective_go.tmpl (right):

http://codereview.appspot.com/5538050/diff/3006/doc/effective_go.tmpl#newcode...
doc/effective_go.tmpl:2565: <code>runtime.GOMAXPROCS(runtime.NumCPU())</code>).
i don't think this is right, exactly. if i say 2*runtime.NumCPU() i also use all
the cores.

this info should be in the(default 1) parenthetical:
(default 1; the function runtime.NumCPU() returns the number of cores on the
machine)

except that's pretty clunky.

if you'd prefer, i'd be happy to rearrange this paragraph to make it work
better.

[dvyukov, 2012-01-12 17:21:13]

On 2012/01/12 15:27:17, r wrote:
> http://codereview.appspot.com/5538050/diff/3006/doc/effective_go.tmpl
> File doc/effective_go.tmpl (right):
> 
>
http://codereview.appspot.com/5538050/diff/3006/doc/effective_go.tmpl#newcode...
> doc/effective_go.tmpl:2565:
<code>runtime.GOMAXPROCS(runtime.NumCPU())</code>).
> i don't think this is right, exactly. if i say 2*runtime.NumCPU() i also use
all
> the cores.
> 
> this info should be in the(default 1) parenthetical:
> (default 1; the function runtime.NumCPU() returns the number of cores on the
> machine)
> 
> except that's pretty clunky.
> 
> if you'd prefer, i'd be happy to rearrange this paragraph to make it work
> better.

PTAL
I've removed the (default 1) remark - the previous text clearly says that only 1
CPU is used by default. I've also rephrased NumCPU wording.

[r, 2012-01-12 17:47:15]

LGTM if you like my edits.

http://codereview.appspot.com/5538050/diff/2011/doc/effective_go.tmpl
File doc/effective_go.tmpl (right):

http://codereview.appspot.com/5538050/diff/2011/doc/effective_go.tmpl#newcode...
doc/effective_go.tmpl:2562: variable <code>GOMAXPROCS</code> set to the number
of cores to use;
s/;// (erroneous punctuation in original)

http://codereview.appspot.com/5538050/diff/2011/doc/effective_go.tmpl#newcode...
doc/effective_go.tmpl:2563: or import the <code>runtime</code> package and call
<code>runtime.GOMAXPROCS(NCPU)</code>
s/$/./

http://codereview.appspot.com/5538050/diff/2011/doc/effective_go.tmpl#newcode...
doc/effective_go.tmpl:2564: (<code>runtime.NumCPU()</code> can be used to query
the number of logical CPUs on the local machine).
Change this to

A helpful value might be <code>runtime.NumCPU()</code>, which reports the number
of logical CPUS on the local machine.

[dvyukov, 2012-01-12 17:57:00]

On 2012/01/12 17:47:15, r wrote:
> LGTM if you like my edits.

I like your edits. All done.

> 
> http://codereview.appspot.com/5538050/diff/2011/doc/effective_go.tmpl
> File doc/effective_go.tmpl (right):
> 
>
http://codereview.appspot.com/5538050/diff/2011/doc/effective_go.tmpl#newcode...
> doc/effective_go.tmpl:2562: variable <code>GOMAXPROCS</code> set to the number
> of cores to use;
> s/;// (erroneous punctuation in original)
> 
>
http://codereview.appspot.com/5538050/diff/2011/doc/effective_go.tmpl#newcode...
> doc/effective_go.tmpl:2563: or import the <code>runtime</code> package and
call
> <code>runtime.GOMAXPROCS(NCPU)</code>
> s/$/./
> 
>
http://codereview.appspot.com/5538050/diff/2011/doc/effective_go.tmpl#newcode...
> doc/effective_go.tmpl:2564: (<code>runtime.NumCPU()</code> can be used to
query
> the number of logical CPUs on the local machine).
> Change this to
> 
> A helpful value might be <code>runtime.NumCPU()</code>, which reports the
number
> of logical CPUS on the local machine.

[dvyukov, 2012-01-12 18:06:57]

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

effective_go: provide reference to runtime.NumCPU()

R=golang-dev, robert.hencke, r
CC=golang-dev
http://codereview.appspot.com/5538050