CFD: update to Porter's Handbook to document build Makevars

Simon L. Nielsen simon at FreeBSD.org
Sun Dec 12 23:58:54 UTC 2004


On 2004.12.12 16:49:06 -0600, Mark Linimon wrote:

> I plan to commit it unless someone points out any markup bugs.

If few nits below, otherwise it looks good.

> Index: book.sgml
> ===================================================================
> RCS file: /home/FreeBSD/dcvs/doc/en_US.ISO8859-1/books/porters-handbook/book.sgml,v
> retrieving revision 1.500
> diff -u -r1.500 book.sgml
> --- book.sgml	12 Dec 2004 14:15:09 -0000	1.500
> +++ book.sgml	12 Dec 2004 21:26:58 -0000
> @@ -3484,6 +3484,12 @@
>  	  package itself, or else forcing its installation with
>  	  <makevar>FORCE_PKG_REGISTER</makevar> will no longer work.
>         </para>
> +
> +      <note>
> +	<para><makevar>CONFLICTS</makevar> automatically sets
> +	  <makevar>IGNORE</makevar>, which is more fully documented
> +	  <link linkend="dads-noinstall">here.</link></para>

Links which says "here" is generally a bad idea, they will not really
make sense in a printed version..

I would suggest:

	  in <xref linkend="dads-noinstall">.</para>

[...]
> +	    <para>If a port sould be marked <makevar>IGNORE</makevar>
> +	      only on certain architectures, there are two other
> +	      convenience variables that will automatically set
> +	      <makevar>IGNORE</makevar> for you:
> +	      <makevar>ONLY_FOR_ARCHS</makevar> and
> +	      <makevar>NOT_FOR_ARCHS</makevar>.  Examples:</para>
> +
> +	    <programlisting>ONLY_FOR_ARCHS = i386 amd64</programlisting>
> +
> +	    <programlisting>NOT_FOR_ARCHS = alpha ia64 sparc64</programlisting>

Isn't there normally no space between the variable name and the equal
character in the ports Makefiles?

> @@ -8285,7 +8346,7 @@
>        <para>The &os; Ports Collection is constantly changing.  Here is
>  	some information on how to keep up.</para>
>  
> -      <sect1>
> +      <sect1 id="FreshPorts">

Was it intetionally that you used capital letters here?

>  	<title>FreshPorts</title>
>  
>  	<para>One of the easiest ways to learn about updates that have
> @@ -8345,8 +8406,8 @@
>  
>        </sect1>
>  
> -      <sect1>
> -	<title>The &os; Port Building Cluster</title>
> +      <sect1 id="build-cluster">
> +	<title>The &os; Port Building Cluster on pointyhat</title>

I would suggest:

	<title>The &os; Port Building Cluster on
	  <hostid role="hostname">pointyhat</hostid></title>

-- 
Simon L. Nielsen
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-doc/attachments/20041213/a0689189/attachment.sig>


More information about the freebsd-doc mailing list