Page MenuHomeFreeBSD

Various updates, portlint, and shar.
ClosedPublic

Authored by mat on Jun 28 2016, 1:08 PM.
Tags
None
Referenced Files
Unknown Object (File)
Dec 23 2023, 1:53 AM
Unknown Object (File)
Dec 17 2023, 4:33 PM
Unknown Object (File)
Nov 8 2023, 1:27 AM
Unknown Object (File)
Nov 7 2023, 7:28 AM
Unknown Object (File)
Oct 7 2023, 12:23 AM
Unknown Object (File)
Oct 6 2023, 6:23 AM
Unknown Object (File)
Sep 27 2023, 8:36 AM
Unknown Object (File)
Sep 14 2023, 2:17 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 Various updates, portlint, and shar..
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/quick-porting/chapter.xml
338 ↗(On Diff #17972)

Split this into two simpler sentences:

Do not blindly follow the output of portlint.  It is a static lint tool and sometimes gets things wrong.
366 ↗(On Diff #17972)

Reorganize this to avoid the halting if/then arrangement:

A diff created from a Subversion checkout of the ports tree is also acceptable.

Note: "diff" here refers to a type of file, not the diff(1) program, so don't use the &man.diff.1 entity.

369 ↗(On Diff #17972)

"that" is not needed, and please don't use 'ed to verbify things. Suggestion:

Add all the files with <command>svn add</command>.
<command>cd</command> to the base of the ports tree so full paths to the changed files
are included in the diff, then generate the diff with <command>svn diff</command>.  For example...
375 ↗(On Diff #17972)

Modify this sentence to avoid the pause (comma) in the middle:

Submit <filename>oneko.shar</filename> or
<filename>oneko.diff</filename> with the <link
xlink:href="https://bugs.freebsd.org/submit/">bug submission
form</link>.
380 ↗(On Diff #17972)

Telling the reader these specific details (green text on the right) seems prone to breakage. It might not be green on their screen, for example. Maybe just "and follow the guidelines shown there."?

384 ↗(On Diff #17972)

Use a positive conditional to avoid a "not":

s/do not forget/remember/

en_US.ISO8859-1/books/porters-handbook/upgrading/chapter.xml
153 ↗(On Diff #17972)

Probably should say "please use &man.diff.1; or <command>svn diff</command>" here.

157 ↗(On Diff #17972)

This whole note seems a bit unclear. The problem (I think) is that shar files do not show changes, they are the whole contents. Let's try to tell the user what to use, and explain why other options are not preferred:

Please use &man.diff.1; or <command>svn diff</command> to create updates to existing ports.
Other formats include the whole file and make it difficult to see just what has changed.
When diffs are not included, the entire update might be ignored.
mat marked 7 inline comments as done.Jun 28 2016, 4:01 PM
This revision was automatically updated to reflect the committed changes.
This revision was automatically updated to reflect the committed changes.