Page MenuHomeFreeBSD

Document USES=ghostscript.
ClosedPublic

Authored by mat on Jul 17 2015, 12:50 PM.
Tags
None
Referenced Files
Unknown Object (File)
Wed, Apr 23, 9:31 AM
Unknown Object (File)
Wed, Apr 23, 8:12 AM
Unknown Object (File)
Wed, Apr 23, 7:54 AM
Unknown Object (File)
Wed, Apr 23, 7:46 AM
Unknown Object (File)
Wed, Apr 23, 6:57 AM
Unknown Object (File)
Wed, Apr 23, 6:50 AM
Unknown Object (File)
Wed, Apr 23, 6:48 AM
Unknown Object (File)
Wed, Apr 23, 6:46 AM
Subscribers
None

Diff Detail

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

Event Timeline

mat retitled this revision from to Document USES=ghostscript..
mat updated this object.
mat edited the test plan for this revision. (Show Details)
mat added reviewers: wblock, gjb.
en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml
543 ↗(On Diff #7043)

Didn't we have a replaceable literal before? The two are kind of opposite. So I'd say just use <replaceable>X</replaceable>, and use <literal> on the actual possible values.

544 ↗(On Diff #7043)

Comma splice! (Sounds like a supervillain name--take that, Comma Splice!)

Break sentence at "used".

551 ↗(On Diff #7043)

"build and run" are one thing (singular), so the verb is "add". The "respectively" would only be needed if there was any question about what each option would do, like "fred and barney add, respectively, a build and run time dependency."

Finally, this sentence has also been influenced by Comma Splice. Suggestion (without markup):

build and run add build- and run-time dependencies on this port.

553 ↗(On Diff #7043)

It's not clear what the setting would be for this. Kind of implies that it could be

USES= ghostscript
USE_ghostscript= build and run

which might work, come to think of it, "and" would just not do anything. But we want to be clear and show the right way.

Important: the USES= table really needs an introduction at the start that shows how to set options. It does not say now, and searching through the book shows

USES= xfce:gtk3
or
USES= xfce
USES_XFCE= gtk3

The right way to do that needs to be shown at the start of the USES= section.

mat marked 4 inline comments as done.Jul 20 2015, 1:53 PM
mat added inline comments.
en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml
553 ↗(On Diff #7043)

Yeah, thing is, this table is getting bigger and bigger and harder to read, I'd like to explode it into subsections, with an introductions.

mat marked an inline comment as done.

Update.

en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml
554 ↗(On Diff #7097)

I think we should have

is <literal>build</literal> and <literal>run</literal>.</entry>

Or maybe

is <literal>build run</literal>.</entry>

en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml
554 ↗(On Diff #7097)

Mmmm, depends on wether we're talking about the default value, or the default behavior, I was writing that the default behavior is build- and run-time dependency, maybe I should write that, let's try.

Rewrite a bit, and update with the changes from the file.

mat marked 2 inline comments as done.Jul 21 2015, 10:04 AM
en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml
543 ↗(On Diff #7126)

This should still just be <replaceable>X</replaceable> (no literal tags). It would be like a variable constant.

546 ↗(On Diff #7126)

Maybe just include the default with the entry?

<literal>8</literal>, <literal>9</literal> (default), and
<literal>agpl</literal>.

549 ↗(On Diff #7126)

Just "add", not "add a" (which is singular).

551 ↗(On Diff #7126)

Use a separate sentence for the last part:

build- and run-time dependencies on
<application>Ghostscript</application>. The default is to include both

en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml
543 ↗(On Diff #7126)

Ah, yes, missed this one.

546 ↗(On Diff #7126)

Mmm, good point.

mat marked 6 inline comments as done.Jul 21 2015, 2:28 PM
wblock edited edge metadata.

Please build-test before commit. Thanks!

This revision is now accepted and ready to land.Jul 21 2015, 3:41 PM
This revision was automatically updated to reflect the committed changes.