Page MenuHomeFreeBSD

[special] igor -Ry and some other rewording and fixes.
ClosedPublic

Authored by mat on Aug 20 2014, 3:08 PM.

Diff Detail

Repository
rD FreeBSD doc repository - subversion
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

mat retitled this revision from to [special] igor -Ry and some other rewording and fixes..
mat updated this object.
mat edited the test plan for this revision. (Show Details)
wblock added inline comments.
en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
13 ↗(On Diff #1223)

<para>This section explains the most common things to consider when creating a port.</para>

45 ↗(On Diff #1223)

s/mostly/mostly be/

70 ↗(On Diff #1223)

This one actually needs "should". It's a recommendation on when to create directories.

75 ↗(On Diff #1223)

s/has to be/is/

223 ↗(On Diff #1223)

s/upstream/the upstream/

251 ↗(On Diff #1223)

setting <varname>USE_LDCONFIG</varname> to a list of

253 ↗(On Diff #1223)

s/example/example,/

255 ↗(On Diff #1223)

<filename>PREFIX/lib/bar</filename>,

321 ↗(On Diff #1223)

s/has to/must/

324 ↗(On Diff #1223)

s/in to/into/

328 ↗(On Diff #1223)

s/cannot not be/cannot be/

377 ↗(On Diff #1223)

<varname>RESTRICTED</varname>, since the latter variable

502 ↗(On Diff #1223)

s/else/other/

504 ↗(On Diff #1223)

s/Same/The same/

669 ↗(On Diff #1223)

s/if port/if the port/

883 ↗(On Diff #1223)

s/^/an /

949 ↗(On Diff #1223)

Break sentence at NLS. Also use <acronym> tags on NLS.

955 ↗(On Diff #1223)

s/on//

1006 ↗(On Diff #1223)

In high complexity cases, more advanced techniques

1007 ↗(On Diff #1223)

may be needed, such as

1060 ↗(On Diff #1223)

s/like/as/

1336 ↗(On Diff #1223)

I think this is one where "should" is correct.

2044 ↗(On Diff #1223)

s/so that/for/

2075 ↗(On Diff #1223)

When set, add the selected JDK port to the build dependencies.

2083 ↗(On Diff #1223)

When set, add the selected JDK port to the run dependencies.

2090 ↗(On Diff #1223)

When set, add the selected JDK port to the extract dependencies.

2114 ↗(On Diff #1223)

Should this have the single quotes?

2259 ↗(On Diff #1223)

"forecited" is a word, but a rare one. "previously listed variables" is better.

2285 ↗(On Diff #1223)

s/is/are/

2342 ↗(On Diff #1223)

s/use/uses/

2374 ↗(On Diff #1223)

s/the//

2375 ↗(On Diff #1223)

s/must/is/

2576 ↗(On Diff #1223)

mygroup</literal> if the port needs different values. This

2577 ↗(On Diff #1223)

allows the user to override them easily.</para>

2580 ↗(On Diff #1223)

s/the/a/

2719 ↗(On Diff #1223)

s/must make sure to/must/

2970 ↗(On Diff #1223)

Do not redefine these variables in the port.

3161 ↗(On Diff #1223)

s/entries using/entries for/

3593 ↗(On Diff #1223)

s/default define/default, define/

3601 ↗(On Diff #1223)

s/version define/version, define/

4365 ↗(On Diff #1223)

This is a recommendation:

earlier, all ports scripts should use</para>

4409 ↗(On Diff #1223)

s/have/have a/

4410 ↗(On Diff #1223)

s/If so that/If so, that/

4493 ↗(On Diff #1223)

"Should" is a recommendation here, and correct.

en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
1336 ↗(On Diff #1223)

I don't think so, if it has those files, they must be listed in the plist, and be installed in the directory below. Maybe i should have used "must" and not "have to" ?

2075 ↗(On Diff #1223)

Should I add <acronym> around JDK too ? should I do this everywhere ?

2114 ↗(On Diff #1223)

nope.

Update with comments from wblock

en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
1336 ↗(On Diff #1223)

Yes, "must" is more definite than "have to".

2075 ↗(On Diff #1223)

Yes. Anything that is an acronym should have <acronym> tags.

wblock added a reviewer: wblock.

Please build-test, then commit.

This revision is now accepted and ready to land.Sep 15 2014, 9:39 PM
mat updated this revision to Diff 1638.

Closed by commit rD45616 (authored by @mat).