code review 3152041: Documentation: how to write Makefiles for commands.

Documentation: how to write Makefiles for commands.

Fixes issue 1282.

[nictuku, 2010-11-17 01:51:44]

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

I'd like you to review this change.

[anschelsc, 2010-11-17 03:19:47]

On 2010/11/17 01:51:44, nictuku wrote:
> Hello adg (cc: mailto:golang-dev@googlegroups.com),
> 
> I'd like you to review this change.

This is a good thing to include in the documentation (I learned from it), but I
think it repeats unnecessarily some of the information from the previous
section. Maybe the two should be combined?

[nictuku, 2010-11-17 03:33:10]

Thank you for the review. Reply inline:

On Wed, Nov 17, 2010 at 4:19 AM, <Anschelsc@gmail.com> wrote:
>
> On 2010/11/17 01:51:44, nictuku wrote:
>>
>> Hello adg (cc: mailto:golang-dev@googlegroups.com),
>
>> I'd like you to review this change.
>
> This is a good thing to include in the documentation (I learned from
> it), but I think it repeats unnecessarily some of the information from
> the previous section. Maybe the two should be combined?
>
> http://codereview.appspot.com/3152041/

I wanted the new section to be self contained and easy to understand,
while at trying to be consistent in style with the rest of the
document, so it may seem familiar.

But I don't see which information is repeated. The part explaining the
semantics of "gomake build" and "gomake install" look similar in style
to others, but the meaning is very different. Feel free to point in
the changelist review tool which specific lines are showing repeated
information.

--
Yves Junqueira <http://cetico.org/about>

[adg, 2010-11-18 23:54:03]

http://codereview.appspot.com/3152041/diff/6001/doc/code.html
File doc/code.html (right):

http://codereview.appspot.com/3152041/diff/6001/doc/code.html#newcode180
doc/code.html:180: <h2 id="New_command">Creating commands</h2>
s/Creating commands/Building programs/

http://codereview.appspot.com/3152041/diff/6001/doc/code.html#newcode181
doc/code.html:181: <p>The example above shows how to write a Makefile to create
libraries. To
Replace this paragraph with this:

To build a Go program with gomake, create a Makefile alongside your program's
source files. It should be similar to the example above, but includes
<code>Make.cmd</code> instead of <code>Make.pkg</code>:

http://codereview.appspot.com/3152041/diff/6001/doc/code.html#newcode198
doc/code.html:198: from the current directory and produce an executable command
file named
s/from the current directory //
s/command file //

http://codereview.appspot.com/3152041/diff/6001/doc/code.html#newcode203
doc/code.html:203: Running <code>gomake install</code> will build
<code>helloworld</code> if needed
s/needed/necessary/

http://codereview.appspot.com/3152041/diff/6001/doc/code.html#newcode204
doc/code.html:204: and copy it to the <code>$(GOROOT)/bin/</code> directory.
s_$(GOROOT)/bin/_$GOBIN_
s_directory_directory (<code>$GOROOT/bin/</code> is the default)_

[nictuku, 2010-11-19 19:08:57]

Thanks for the review. PTAL.

http://codereview.appspot.com/3152041/diff/6001/doc/code.html
File doc/code.html (right):

http://codereview.appspot.com/3152041/diff/6001/doc/code.html#newcode180
doc/code.html:180: <h2 id="New_command">Creating commands</h2>
On 2010/11/18 23:54:03, adg wrote:
> s/Creating commands/Building programs/

Done.

http://codereview.appspot.com/3152041/diff/6001/doc/code.html#newcode181
doc/code.html:181: <p>The example above shows how to write a Makefile to create
libraries. To
On 2010/11/18 23:54:03, adg wrote:
> Replace this paragraph with this:
> 
> To build a Go program with gomake, create a Makefile alongside your program's
> source files. It should be similar to the example above, but includes
> <code>Make.cmd</code> instead of <code>Make.pkg</code>:

Done.

http://codereview.appspot.com/3152041/diff/6001/doc/code.html#newcode198
doc/code.html:198: from the current directory and produce an executable command
file named
On 2010/11/18 23:54:03, adg wrote:
> s/from the current directory //
> s/command file //

Done.

http://codereview.appspot.com/3152041/diff/6001/doc/code.html#newcode203
doc/code.html:203: Running <code>gomake install</code> will build
<code>helloworld</code> if needed
On 2010/11/18 23:54:03, adg wrote:
> s/needed/necessary/

Done.

http://codereview.appspot.com/3152041/diff/6001/doc/code.html#newcode204
doc/code.html:204: and copy it to the <code>$(GOROOT)/bin/</code> directory.
On 2010/11/18 23:54:03, adg wrote:
> s_$(GOROOT)/bin/_$GOBIN_
> s_directory_directory (<code>$GOROOT/bin/</code> is the default)_

Done.

[adg, 2010-11-22 23:42:12]

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

Documentation: how to write Makefiles for commands.

Fixes issue 1282.

R=adg
CC=golang-dev
http://codereview.appspot.com/3152041

Committer: Andrew Gerrand <adg@golang.org>