svn commit: r40136 - head/en_US.ISO8859-1/articles/portbuild

[Mark Linimon]

Author: linimon
Date: Fri Nov 23 04:26:02 2012
New Revision: 40136
URL: http://svnweb.freebsd.org/changeset/doc/40136

Log:
  Canonicalize directory names and tighten up examples.  While here,
  fix the markup on one of the examples.

Modified:
  head/en_US.ISO8859-1/articles/portbuild/article.xml

Modified: head/en_US.ISO8859-1/articles/portbuild/article.xml
==============================================================================
--- head/en_US.ISO8859-1/articles/portbuild/article.xml	Fri Nov 23 04:11:19 2012	(r40135)
+++ head/en_US.ISO8859-1/articles/portbuild/article.xml	Fri Nov 23 04:26:02 2012	(r40136)
@@ -1725,9 +1725,9 @@ ganglia:*:102:102::0:0:User &:/usr/l
 	    </listitem>
 
 	    <listitem>
-	      <para>We run the cluster on UTC.  If you have not set the clock
+	      <para>You should run the cluster on UTC.  If you have not set the clock
 		to UTC:
-		<programlisting>&prompt.root; cp /usr/share/zoneinfo/Etc/UTC etc/localtime</programlisting>
+		<programlisting>&prompt.root; cp -p /usr/share/zoneinfo/Etc/UTC etc/localtime</programlisting>
 	      </para>
 	    </listitem>
 
@@ -2819,15 +2819,15 @@ console="vidconsole,comconsole"</screen>
 	</step>
 
 	<step>
-	  <para>We run the cluster on UTC.  If you have not set the clock
+	  <para>You should run the cluster on UTC.  If you have not set the clock
 	    to UTC:
-	    <screen>cp /usr/share/zoneinfo/Etc/UTC etc/localtime</screen>
+	    <programlisting>&prompt.root; cp -p /usr/share/zoneinfo/Etc/UTC /etc/localtime</programlisting>
 	  </para>
 	</step>
 
 	<step>
 	  <para>Create the appropriate
-	    <filename>etc/rc.conf</filename>.</para>
+	    <filename>/etc/rc.conf</filename>.</para>
 
 	  <para>Required entries:</para><screen>
 hostname="<replaceable>${hostname}</replaceable>"
@@ -2864,7 +2864,7 @@ smartd_enable="YES"
 	</step>
 
 	<step>
-	  <para>Create <filename>etc/resolv.conf</filename>, if
+	  <para>Create <filename>/etc/resolv.conf</filename>, if
 	    necessary.</para>
 	</step>
 
@@ -2973,13 +2973,17 @@ ganglia:*:102:102::0:0:User &:/usr/l
 	<step>
 	  <para>Create a <application>zfs</application> volume named
 	    <filename>a</filename> and mount it on
-	    <filename>/a</filename>.  An example:<screen>
-&prompt.root; zpool create a mirror da1 da2 mirror da3 da4 mirror da5 da6 mirror da7 da8</screen>
-	  </para>
+	    <filename>/a</filename>.<para>
+
+	  <example>
+	    <title>Creating a <application>zfs</application> volume for portbuild</title>
+
+<screen>&prompt.root; zpool create a mirror da1 da2 mirror da3 da4 mirror da5 da6 mirror da7 da8</screen>
+	  </example>
 	</step>
 
 	<step>
-	  <para>Create the portbuild directory:<screen>
+	  <para>Create the <filename>portbuild</filename> directory:<screen>
 &prompt.root; mkdir -p /a/portbuild
 </screen>
 	  </para>
@@ -2993,13 +2997,18 @@ ganglia:*:102:102::0:0:User &:/usr/l
 	</step>
 
 	<step>
-	  <para>Set up the portbuild directory:<screen>
+	  <para>Set up the directory:<screen>
 &prompt.root; cd /a/portbuild
 &prompt.root; chown portmgr:portmgr .
 &prompt.root; chmod 775 .
 &prompt.root; ln -sf /a/portbuild /var/portbuild
 </screen>
 	  </para>
+
+	  <note>
+	    <para>The <command>ln</command> is necessary due to a number
+	      of hardcoded paths.  This is a bug.</para>
+	  </note>
 	</step>
 
       </procedure>
@@ -3123,8 +3132,8 @@ ganglia:*:102:102::0:0:User &:/usr/l
 
 	<step>
 	  <para>Copy the following files from
-	    <filename>/var/portbuild/conf/etc/rc.d</filename> to
-	    <filename>/usr/local/etc/rc.d</filename>:<screen>
+	    <filename>/var/portbuild/conf/etc/rc.d/</filename> to
+	    <filename>/usr/local/etc/rc.d/</filename>:<screen>
 buildproxy.sh
 pollmachine.sh
 qmanager.sh</screen>
@@ -3181,7 +3190,7 @@ qmanager.sh</screen>
 
 	<step>
 	  <para>Copy <filename>/var/portbuild/conf/apache.conf</filename>
-	    to the appropriate <filename>Includes</filename> subdirectory, e.g.,
+	    to the appropriate <filename>Includes/</filename> subdirectory, e.g.,
 	    <filename>/usr/local/etc/apache22/Includes/apache.conf</filename>.
 	    Configure it as appropriate for your site.</para>
 	</step>