Page MenuHomeFreeBSD

Add a bit of documentation about the upcoming GH_TUPLE.
ClosedPublic

Authored by mat on Mar 1 2016, 3:18 PM.

Diff Detail

Repository
rD FreeBSD doc 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

mat retitled this revision from to Add a bit of documentation about the upcoming GH_TUPLE..
mat updated this object.
mat edited the test plan for this revision. (Show Details)
mat added a reviewer: wblock.
en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
1986 ↗(On Diff #13940)

Split the sentence rather than use a comma:

...into one variable.  The format is
1988 ↗(On Diff #13940)

This should use <replaceable> on the non-literal parts. There is an <optional> tag for optional components. So (untested):

<replaceable>account</replaceable><literal>:</literal><replaceable>project</replaceable><literal>:</literal><replaceable>tagname</replaceable><optional><literal>:</literal><replaceable>group</replaceable></optional>

This really could use an example. Two, maybe, one with the optional group.

1989 ↗(On Diff #13940)

s/are/is/

1990 ↗(On Diff #13940)

Purists would suggest "from which to fetch."

2091 ↗(On Diff #13940)

No comma needed.

2092 ↗(On Diff #13940)

Split the sentence here, and "all" is not needed:

are a lot of distribution files.  It helps keep the
2164 ↗(On Diff #13940)

Not quite clear what this means. Is it "This is the same as the previous example, but```?

2180 ↗(On Diff #13940)

This sentence is also a little confusing. Maybe:

Grouping was used in the previous example with <literal>bar:icons,contrib</literal>.
Some redundant information is present with <varname>GH_TUPLE</varname> because
grouping is not possible.
mat marked 8 inline comments as done.Mar 1 2016, 8:21 PM
mat added inline comments.
en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
1988 ↗(On Diff #13940)

That gets:

element optional: validity error : Element literal is not declared in optional list of possible children

If I wrap all inside a <literal>, I get:

element literal: validity error : Element optional is not declared in literal list of possible children

I will drop the optional part and make it not optional, as we don't want people using it without the :group. bit.

This revision was automatically updated to reflect the committed changes.
mat marked an inline comment as done.