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

[Mark Linimon]

Author: linimon
Date: Thu Nov 22 02:29:55 2012
New Revision: 40123
URL: http://svnweb.freebsd.org/changeset/doc/40123

Log:
  Document more automation just added to the scripts.  Demote the hard-coded
  advice associated with it down to just being 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	Thu Nov 22 01:35:43 2012	(r40122)
+++ head/en_US.ISO8859-1/articles/portbuild/article.xml	Thu Nov 22 02:29:55 2012	(r40123)
@@ -2562,27 +2562,33 @@ cd /var/portbuild/<replaceable>arch</rep
       </listitem>
 
       <listitem>
-	<para>Create a directory for buildlogs and errorlogs:
-	  (XXX MCL specific to pointyhat; fix this!)
+	<para>Create an archive directory for buildlogs and errorlogs.</para>
+
+	<para>If you are going to store your historical buildlogs and
+	  errorlogs on your head node's hard drive, you may skip this step.
+	  Otherwise:</para>
+
+	<para>Create an external directory and link to it:</para>
+
+	<example>
+	  <title>Creating and linking an external archive directory</title>
+
 	  <screen>mkdir /dumpster/pointyhat/<replaceable>arch</replaceable>/archive</screen>
-	</para>
+	  <screen>ln -s /dumpster/pointyhat/<replaceable>arch</replaceable>/archive archive</screen>
+	</example>
 
 	<note>
+	  <para>(Historical note that only applied to the original
+	    <hostid>pointyhat.FreeBSD.org</hostid> installation)</para>
+
 	  <para>It is possible that <filename>/dumpster/pointyhat</filename>
 	    will not have enough space.  In that case, create the archive
 	    directory as
 	    <filename>/dumpster/pointyhat/<replaceable>arch</replaceable>/archive</filename>
-	    and symlink to that.  (This needs to be sorted out.)
+	    and symlink to that.
 	  </para>
 	</note>
       </listitem>
-
-      <listitem>
-	<para>Create a link to the above for the webserver:
-	  (XXX MCL specific to pointyhat; fix this!)
-	  <screen>ln -s /dumpster/pointyhat/<replaceable>arch</replaceable>/archive archive</screen>
-	</para>
-      </listitem>
     </itemizedlist>
 
     <note>
@@ -2644,19 +2650,26 @@ cd /var/portbuild/<replaceable>arch</rep
       </listitem>
 
       <listitem>
-	<para>Edit the <filename>.ssh/config</filename> file for
+	<para>If desired,
+	  edit the <filename>.ssh/config</filename> file for
 	  convenience in using <application>ssh</application>.</para>
       </listitem>
 
       <listitem>
-	<para>If needed, make the private configuration directory:
+	<para>If you need to create any tunnels:</para>
+
+	<procedure>
+	  <step>
+	    <para>Make a private configuration directory:
 	  <screen>mkdir /var/portbuild/conf/<replaceable>arch</replaceable></screen>
-	</para>
-      </listitem>
+	    </para>
+	  </step>
 
-      <listitem>
+	  <step>
 	<para>In that directory: create any <filename>dotunnel.*</filename>
 	  scripts needed.</para>
+	  </step>
+	</procedure>
       </listitem>
     </itemizedlist>
 
@@ -2697,7 +2710,7 @@ ln -s ../<replaceable>arch</replaceable>
       </listitem>
 
       <listitem>
-        <para>
+        <para>(Only necessary for old codebase):
 	  In the <filename>/var/portbuild/errorlogs/</filename>
 	  directory, create two more links for the webserver:<screen>
 ln -s ../<replaceable>arch</replaceable>/archive/buildlogs <replaceable>arch</replaceable>-buildlogs