Page MenuHomeFreeBSD

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

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

Diff Detail

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

Event Timeline

mat updated this revision to Diff 1173.Aug 20 2014, 3:06 PM
mat retitled this revision from to [porting-dads] igor -Ry and some other rewording and fixes..
mat updated this object.
mat edited the test plan for this revision. (Show Details)
antoine added inline comments.
en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml
527 ↗(On Diff #1173)

the strings?

wblock added a subscriber: wblock.Aug 20 2014, 3:52 PM
wblock added inline comments.
en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml
527 ↗(On Diff #1173)

It's a little ambiguous. Maybe "any of these strings".

Also, s/note/not/

528 ↗(On Diff #1173)

"should be" is okay here, it is making a recommendation. But this sentence is vague. It's hard to tell what it is saying. The string should be different... from what? I think it is saying that the wording of the message depends on which variable is used. The example shows that BROKEN and IGNORE are worded differently.

mat updated this revision to Diff 1229.Aug 22 2014, 5:02 PM

Rewords a bit after antoine and wblock's comments

wblock added inline comments.Aug 30 2014, 6:16 PM
en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml
38 ↗(On Diff #1250)

The <filename>pkg-<replaceable>*</replaceable></filename> files can be modified by <link linkend="pkg-names">redefining a variable</link> rather than overwriting the file.

67 ↗(On Diff #1250)

Some code needs modifications or

192 ↗(On Diff #1250)

The rest of the sentence starting with "and" seems unnecessary here.

Also, if we must include smileys, they should probably be &#x263A;.

220 ↗(On Diff #1250)

s/resaonnable/reasonable/

221 ↗(On Diff #1250)

s/,//

284 ↗(On Diff #1250)

Break sentence at semicolon.

311 ↗(On Diff #1250)

s/System/The system/

347 ↗(On Diff #1250)

Do send applicable changes and patches to the upstream

348 ↗(On Diff #1250)

maintainer for inclusion in the next release of the code.

349 ↗(On Diff #1250)

This makes the next release that much easier.

380 ↗(On Diff #1250)

s/cases/cases,/

381 ↗(On Diff #1250)

There are several variables that can be used in a port's <filename>Makefile</filename> to tell the user that the port cannot be installed.

384 ↗(On Diff #1250)

<command>make</command> is not really needed here.

385 ↗(On Diff #1250)

s/given back/shown/

386 ↗(On Diff #1250)

Remove <command>make</command>.

387 ↗(On Diff #1250)

variable. Each variable conveys radically different

388 ↗(On Diff #1250)

meanings, both to users and to automated systems that depend on

389 ↗(On Diff #1250)

"the" is not needed here.

524 ↗(On Diff #1250)

"it will be checked" is ambiguous.

If this variable is set, <filename>/usr/lib32</filename> must be present for IA32 versions of libraries and the kernel must support IA32 compatibility.

538 ↗(On Diff #1250)

Due to the way the information is shown to the user, the wording of messages for each variable differ:</para>

637 ↗(On Diff #1250)

s/Check/Verify/

650 ↗(On Diff #1250)

s/Maybe also contact/Contact/

658 ↗(On Diff #1250)

Break sentence after "information".

661 ↗(On Diff #1250)

The quotes seem unnecessary.

to get the executable name.

663 ↗(On Diff #1250)

s/behaviour/behavior/

709 ↗(On Diff #1250)

Break sentence after "way".

wblock added inline comments.Sep 15 2014, 10:05 PM
en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml
219 ↗(On Diff #1552)

Spelling: s/reasonnable/reasonable/

mat closed this revision.Sep 16 2014, 12:41 PM
mat updated this revision to Diff 1641.

Closed by commit rD45618 (authored by @mat).