Page MenuHomeFreeBSD

Catch up with options changes.
ClosedPublic

Authored by mat on Jan 22 2015, 1:07 PM.
Tags
None
Referenced Files
F81591868: D1599.diff
Thu, Apr 18, 3:28 PM
Unknown Object (File)
Tue, Apr 16, 12:14 PM
Unknown Object (File)
Mar 15 2024, 7:14 AM
Unknown Object (File)
Mar 15 2024, 6:57 AM
Unknown Object (File)
Mar 6 2024, 1:00 AM
Unknown Object (File)
Feb 9 2024, 9:29 PM
Unknown Object (File)
Dec 19 2023, 11:41 PM
Unknown Object (File)
Nov 14 2023, 1:15 PM
Subscribers

Details

Reviewers
wblock

Diff Detail

Repository
rD FreeBSD doc repository - subversion
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

mat retitled this revision from to Catch up with options changes..
mat updated this object.
mat edited the test plan for this revision. (Show Details)
mat added a reviewer: Doc Committers.
mat added a subscriber: portmgr.

Consider rearranging the sentences that say "If value is set, when option blah is selected, the value is..." to simplify:

When option OPT is selected, the value of OPT_ABOVEVARIABLE, if defined, is appended to ABOVEVARIABLE.

The markup on many of these is weird. It makes no sense to have both literal and replaceable tags around something. Literal is actually the opposite of replaceable. Use <literal> for literal strings, and <replaceable> for strings the user will change.

en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
3863

Needs a comma:
<varname><replaceable>OPT</replaceable>_USE</varname>, the

3865

s/will be set to/is set to/

3868

s/commas,/commas and/

3893

Needs a comma after </varname>.

3896

s/will be set to/is set to/

3899

s/commas,/commas and/

3922

s/set/set,/

4003–4004

is set, its value is appended to

4006

selected. For example:

4027–4028

is set, its value is appended to

4030

selected. For example:

4051–4052

is set, its value is appended to

4054

selected. For example:

4075–4076

is set, its value is appended to

4078

selected. For example:

4100

is set, its value is appended to

4103

selected. For example:

4124

is set, its value is appended to

4127

selected. For example:

4183

is defined, its value is appended to

4187

selected. For example:

4209

is defined, its value is appended to

4364

is defined, its value is appended to

4368

selected. For example:

4392–4393

This sentence seems incomplete.

In D1599#4, @wblock wrote:

Consider rearranging the sentences that say "If value is set, when option blah is selected, the value is..." to simplify:

When option OPT is selected, the value of OPT_ABOVEVARIABLE, if defined, is appended to ABOVEVARIABLE.

I was tempted to do that, but I tried to keep the changes to a minimum.

The markup on many of these is weird. It makes no sense to have both literal and replaceable tags around something. Literal is actually the opposite of replaceable. Use <literal> for literal strings, and <replaceable> for strings the user will change.

I don't quite know why I did that, all the other <replaceable> were inside <varname>, I thought I had to put them in something, will remove the <literal>.

Take care of comments. Remove unneeded <literal>.

Reword all "When option OPT is (not) selected, the value of OPT_FOO, if defined, is appended to FOO."

Fix a typo while I'm there.

wblock added a reviewer: wblock.

Please remember to build-test.

This revision is now accepted and ready to land.Jan 30 2015, 2:37 AM