Page MenuHomeFreeBSD

build(7) instructions for alternate dir should be clearer
ClosedPublic

Authored by sd_beastie.io on Apr 26 2016, 4:38 AM.

Details

Summary

buildworld and buildkernel should be clearer about how to use alternate directories for building. Would be nice to point out to set MAKEOBJDIRPREFIX like installworld and installkernel does.

Test Plan
  • igor validation
  • man output

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

sd_beastie.io retitled this revision from to build(7) instructions for alternate dir should be clearer.
sd_beastie.io updated this object.
sd_beastie.io edited the test plan for this revision. (Show Details)
sd_beastie.io added reviewers: wblock, brd.
sd_beastie.io set the repository for this revision to rS FreeBSD src repository - subversion.

Update .Dd at the top of the file as well.

build.7
198 ↗(On Diff #15611)

You need to keep the "The" at the start of the sentence.

202 ↗(On Diff #15611)

Man page style has the new sentence start on a new line.

202 ↗(On Diff #15611)

It is probably more technically correct to say that MAKEOBJDIRPREFIX is set in make's environment; just setting an unexported shell variable would be local to the shell; setting it on the make command line works for make but is treated slightly differently than inheriting it from the shell environment.
(The same discussion applies to the next chunk.)

285 ↗(On Diff #15611)

Start this sentence with "The" as well.
Also, "build location" is not exactly a well-defined concept; it may be better to use more words and say that "the location of the object files generated by this build can be changed from the default..."

sd_beastie.io added inline comments.
build.7
202 ↗(On Diff #15611)

I wanted to quickly remind users that the variable can be set to change the build output directory, similar to installworld and installkernel does. This acts as a quick reminder in case people are jumping straight to these sections instead of reading the whole man page. Yes RTFM is a separate discussion :) There is already text in the beginning of the man page and in the environment section that talks more in detail about all the variables.

I did change it to make variable as the rest of the text references. And changed build location to object directory.

285 ↗(On Diff #15611)

See reply above.

sd_beastie.io edited edge metadata.
sd_beastie.io marked 2 inline comments as done.

Updated based on review comments.

build.7
200 ↗(On Diff #15627)

"directory" is redundant here.

202 ↗(On Diff #15627)

.Xr make 1
variable.

288 ↗(On Diff #15627)

"directory" is redundant here, too.

290 ↗(On Diff #15627)

.Xr make 1
variable.

sd_beastie.io edited edge metadata.
sd_beastie.io marked 4 inline comments as done.

Updated based on wblock's review comments

wblock edited edge metadata.

Looks okay to me.

This revision is now accepted and ready to land.Apr 27 2016, 10:13 PM
This revision was automatically updated to reflect the committed changes.