Page MenuHomeFreeBSD

Catch up with recent work in ports, and restructurate a bit.
ClosedPublic

Authored by mat on Oct 1 2015, 10:03 AM.
Tags
None
Referenced Files
Unknown Object (File)
Dec 20 2023, 12:34 AM
Unknown Object (File)
Nov 14 2023, 10:38 PM
Unknown Object (File)
Nov 10 2023, 1:07 PM
Unknown Object (File)
Nov 7 2023, 11:32 PM
Unknown Object (File)
Nov 6 2023, 3:13 AM
Unknown Object (File)
Oct 9 2023, 11:53 AM
Unknown Object (File)
Oct 6 2023, 10:14 PM
Unknown Object (File)
Oct 4 2023, 10:13 PM
Subscribers

Details

Summary
  • Add @{pre,post}{,un}exec and deprecate @{,un}exec.
  • Update the way @sample works.
  • Move all the deprecated entries at the end.
  • Add the arguments section.
  • Switch the big "New Keywords" varlistentry into sect3s.
  • Update the @sample example to catch up with reality.

Diff Detail

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

Event Timeline

mat retitled this revision from to Catch up with recent work in ports, and restructurate a bit..
mat updated this object.
mat edited the test plan for this revision. (Show Details)

Note that this does a lot of things, each of which will have its own commit.

brd added a reviewer: brd.
brd added a subscriber: brd.

Looks good.

This revision is now accepted and ready to land.Oct 1 2015, 11:18 AM
en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml
403 ↗(On Diff #8999)

It's not clear what <quote>real</quote> means here. Maybe it should just be existing without the quote?

404 ↗(On Diff #8999)

s/file/filename/

406 ↗(On Diff #8999)

s/real/existing/

464 ↗(On Diff #8999)

s|installation/deinstallation|installation or deinstallation|

635 ↗(On Diff #8999)

s|installation/deinstallation|installation or deinstallation|

670 ↗(On Diff #8999)

<listitem> should be on its own line:

<listitem>
  <para><literal>attributes</literal></para>
</listitem>

(Also applies to following lines.)

803 ↗(On Diff #8999)

This sentence is a little confusing. Maybe "If set to true, changes how arguments are handled, splitting %1 and %2 into multiple arguments."

806 ↗(On Diff #8999)

Break sentence: s/works, as/works. When/

807 ↗(On Diff #8999)

Break sentence: s/specified, for/specified. For/

832 ↗(On Diff #8999)

I think this can be "Custom Keyword Examples", with the final plural meaning multiple examples and multiple keywords.

854 ↗(On Diff #8999)

Split sentence: s/things, it/things. It/

mat edited edge metadata.
mat marked 10 inline comments as done.

update.

This revision now requires review to proceed.Oct 1 2015, 12:43 PM
mat marked an inline comment as done.Oct 1 2015, 12:44 PM
en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml
404 ↗(On Diff #9003)

This first usage of "actual" should explain what it means.

The <quote>actual</quote>, non-sample file...
819 ↗(On Diff #9003)

Better, but still combines a lot of things into one sentence. Maybe:

Set to <literal>true</literal> to enable argument handling.
The whole <literal>%@</literal> line is split into numbered arguments,
<literal>%1</literal>, <literal>%2</literal>, and so on.  For example...
821 ↗(On Diff #9003)

"if enabled" is not needed, that is already the context for this paragraph.

822 ↗(On Diff #9003)

<quote> is not needed. here or in the rest of the paragraph. The <literal> shows the content. If the concern is that punctuation might be confused, maybe put the output into <programlisting> elements.

829 ↗(On Diff #9003)

I don't think the ", respectively" part is needed.

mat marked 5 inline comments as done.Oct 1 2015, 2:26 PM
This revision was automatically updated to reflect the committed changes.