RFC: suggested changes to the Porter's Handbook

Mark Linimon linimon at lonesome.com
Wed May 14 01:45:40 UTC 2003


I have come up with a large number of suggested revisions to the
Porter's Handbook.  As the diffs are large (>1000 lines (!) ), I have
not included them here, but instead put them up for review on
http://www.lonesome.com/FreeBSD/index.html.

I was told I needed to separate the changes by type, so I did. Each
of the changes would be applied in order:

    * changes to style such as making sure every individual command
is a manpage ref, every instance of a filename is included in a filename
entity, every instance of a command plus arguments is a command
entity, and so forth.
    * changes to whitespace that become needed for readability after
the above changes are applied.
    * changes to content that range from entirely new sections, to 
clarifications of unclear explanations, to creating many more links to 
external and interal projects, to inserting text to say that "something
needs to go here", and so on and so forth.

I am hoping the first two will be fairly non-controversial (if nothing
else, I do not look forward to a merging effort should these changes
themselves wind up being changed). The third will of course be
controversial, but so it goes. I'm hoping the "new text" and
"clarified text" will be less so than the "changed text". I am much
more attached to the "new text" than the other two. There are some
things in that category that IMHO are the main motivation to update
the document.

Note: all of this got started when Eric Anholt sent me some other possible
changes to review. But note that his own changes are not included
in this. This is no slight to him -- I spent the time to carve my own
changes up into the multiple diffs but my motivation has flagged
at the moment to go back and do them to his. Sigh.

So, folks, get your chainsaws out and let's see what happens :-)

Mark Linimon



More information about the freebsd-doc mailing list