Page MenuHomeFreeBSD

Add a section about the order the variables must come in a Makefile.
ClosedPublic

Authored by mat on Mar 31 2017, 2:56 PM.
Tags
None
Referenced Files
Unknown Object (File)
Jan 25 2025, 7:42 PM
Unknown Object (File)
Jan 25 2025, 7:38 PM
Unknown Object (File)
Jan 25 2025, 7:21 PM
Unknown Object (File)
Jan 7 2025, 8:34 AM
Unknown Object (File)
Dec 6 2024, 8:54 PM
Unknown Object (File)
Nov 30 2024, 8:38 AM
Unknown Object (File)
Nov 23 2024, 2:43 PM
Unknown Object (File)
Nov 21 2024, 11:23 PM
Subscribers

Diff Detail

Repository
rD FreeBSD doc repository - subversion
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

en_US.ISO8859-1/books/porters-handbook/porting-samplem/chapter.xml
103 ↗(On Diff #26882)

s/Ports/Port/

105 ↗(On Diff #26882)
The first sections of the <filename>Makefile</filename>
106 ↗(On Diff #26882)
This standard makes it so everyone
107 ↗(On Diff #26882)
can easily read any port without having to search for variables in a random order.
110 ↗(On Diff #26882)
<para>The first line of a <filename>Makefile</filename> is always
112 ↗(On Diff #26882)

s/RCS ID/VCS ID/

actually, `version control ID``` is probably clearer.

s/will look/looks/

119 ↗(On Diff #26882)

has expanded it to look like this:</para>

125 ↗(On Diff #26882)

s/only//

126 ↗(On Diff #26882)

s/normal/ordinary/

134 ↗(On Diff #26882)
In the following blocks, only set the variables that are required
by the port.  Define these variables in the order they are shown here.</para>
142 ↗(On Diff #26882)

Comma splice.

<para>This block is the most important.  It defines the port
143 ↗(On Diff #26882)
name, version, distribution file location, and category.  The
144 ↗(On Diff #26882)
variables must be in this order:</para>
266 ↗(On Diff #26882)

Better off without a count of variables to get out of sync:

<para>This block is mandatory. The variables are:</para>
284 ↗(On Diff #26882)

s/thought/although it is/

343 ↗(On Diff #26882)

s/by/variables by/

397 ↗(On Diff #26882)

"Always" is not necessary, make it imperative:

<para>Keep related variables close together.  For example,
433 ↗(On Diff #26882)
the same order as the different stages run:</para>
mat marked 18 inline comments as done.Apr 3 2017, 12:09 PM
bcr added a subscriber: bcr.

Looks good to me.

This revision is now accepted and ready to land.Apr 18 2017, 1:07 PM
mat added a parent revision: Restricted Differential Revision.Apr 18 2017, 4:18 PM
This revision was automatically updated to reflect the committed changes.