State of the Porters' Handbook

[Eitan Adler]

On Tue, Oct 29, 2013 at 5:02 PM, Gabor Pali <pgj at freebsd.org> wrote:
> On Mon, Oct 28, 2013 at 4:11 PM, Baptiste Daroussin <bapt at freebsd.org> wrote:
>> I do buy this argument :) and I'll see want I can do for that in the next couple
>> of days.
>
> Please find a patch [1] (and see [2] for the HTML preview) for the
> porters-handbook document to address this problem.  Note that some of
> the contents have been already updated by Eitan Adler, this is just a
> continuation of the work.
>
> [1] http://people.freebsd.org/~pgj/patches/2013/10/29/porters-handbook.staging.diff
> [2] http://people.freebsd.org/~pgj/patches/2013/10/29/porters-handbook-staging/

Hi, nice work.

Very quick review:

  <step>
-  <para><command>make reinstall</command></para>
- </step>
+  <para><command>pkg_add
<replaceable>package-name</replaceable></command></para>

- <step>
-  <para><command>make package</command></para>
+  <para>Or, in case of <emphasis>pkgng</emphasis>:</para>
+
+  <para><command>pkg add
<replaceable>package-name</replaceable></command></para>
  </step>

We generally don't refer to pkgng in the docs: please use "pkg".
Further, I'd put the pkg cases first as the pkg_ tools are deprecated.

+ <application>poudriere</application>.  These maintain

Thanks for adding this.

+      <para>For ports that install kernel modules, the

This should be in a different section specifically about kernel modules.

+ staging) but it is broken (Mailman up to 2.1.16, for instance).

I would not mention specific ports here.  Examples get old quick.

This looks good overall and thanks for working on it.








-- 
Eitan Adler