svn commit: r44708 - head/en_US.ISO8859-1/articles/portbuild
Warren Block
wblock at FreeBSD.org
Tue Apr 29 21:38:02 UTC 2014
Author: wblock
Date: Tue Apr 29 21:38:01 2014
New Revision: 44708
URL: http://svnweb.freebsd.org/changeset/doc/44708
Log:
Restore lost <replaceable> tags. 100 of them.
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 Tue Apr 29 21:16:47 2014 (r44707)
+++ head/en_US.ISO8859-1/articles/portbuild/article.xml Tue Apr 29 21:38:01 2014 (r44708)
@@ -236,29 +236,29 @@
<para>Package builds are performed by the clients in a
<literal>jail</literal> populated by the
<filename>portbuild</filename> script using the
- <filename>${arch}/${branch}/builds/${buildid}/bindist.tar</filename>
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/builds/<replaceable>${buildid}</replaceable>/bindist.tar</filename>
file.</para>
<para>On the server, use the
<command>makeworld</command> command to build a world from the
- <filename>${arch}/${branch}/builds/${buildid}/src/</filename>
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/builds/<replaceable>${buildid}</replaceable>/src/</filename>
tree and install it into
- <filename>${arch}/${branch}/builds/${buildid}/bindist.tar</filename>.
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/builds/<replaceable>${buildid}</replaceable>/bindist.tar</filename>.
The tree will
be updated first unless <literal>-novcs</literal> is
specified.</para>
- <screen>&prompt.root; <userinput>/a/portbuild/admin/scripts/makeworld ${arch} ${branch} ${buildid} [-novcs]</userinput></screen>
+ <screen>&prompt.root; <userinput>/a/portbuild/admin/scripts/makeworld <replaceable>${arch}</replaceable> <replaceable>${branch}</replaceable> <replaceable>${buildid}</replaceable> [-novcs]</userinput></screen>
<para>Similiarly on the server, the
<filename>bindist.tar</filename> tarball is created from the
previously installed world by the <command>mkbindist</command>
script.</para>
- <screen>&prompt.root; <userinput>/a/portbuild/admin/scripts/mkbindist ${arch} ${branch} ${buildid}</userinput></screen>
+ <screen>&prompt.root; <userinput>/a/portbuild/admin/scripts/mkbindist <replaceable>${arch}</replaceable> <replaceable>${branch}</replaceable> <replaceable>${buildid}</replaceable></userinput></screen>
<para>The per-machine tarballs are located on the server in
- <filename>${arch}/clients</filename>.</para>
+ <filename><replaceable>${arch}</replaceable>/clients</filename>.</para>
<para>The <filename>bindist.tar</filename> file is extracted
onto each client at client boot time, and at the start of
@@ -287,37 +287,37 @@
<filename>make.conf</filename> and/or
<filename>src.conf</filename>,
named
- <filename>${arch}/${branch}/builds/${buildid}/make.conf.server</filename>
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/builds/<replaceable>${buildid}</replaceable>/make.conf.server</filename>
and
- <filename>${arch}/${branch}/builds/${buildid}/src.conf.server</filename>,
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/builds/<replaceable>${buildid}</replaceable>/src.conf.server</filename>,
respectively. These will be used in lieu of the default-named
files on the server side.</para>
<para>Similarly, if you wish to also affect the <emphasis>client-side</emphasis>
<filename>make.conf</filename>, you may use
- <filename>${arch}/${branch}/builds/${buildid}/make.conf.client</filename>.
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/builds/<replaceable>${buildid}</replaceable>/make.conf.client</filename>.
</para>
<note>
<para>Due to the fact that individual clients may each have
their own per-host <filename>make.conf</filename>, the
contents of
- <filename>${arch}/${branch}/builds/${buildid}/make.conf.client</filename>
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/builds/<replaceable>${buildid}</replaceable>/make.conf.client</filename>
will be <emphasis>appended</emphasis> to that
<filename>make.conf</filename>, not supplant it, as is done
for
- <filename>${arch}/${branch}/builds/${buildid}/make.conf.server</filename>.</para>
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/builds/<replaceable>${buildid}</replaceable>/make.conf.server</filename>.</para>
</note>
<note>
<para>There is no similar functionality for
- <filename>${arch}/${branch}/builds/${buildid}/src.conf.client</filename>
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/builds/<replaceable>${buildid}</replaceable>/src.conf.client</filename>
(what effect would it have?).</para>
</note>
<example>
<title>Sample
- <filename>make.conf.target</filename>
+ <filename>make.conf.<replaceable>target</replaceable></filename>
to test new default <application>ruby</application>
version</title>
@@ -329,7 +329,7 @@
<example>
<title>Sample
- <filename>make.conf.target</filename>
+ <filename>make.conf.<replaceable>target</replaceable></filename>
for <application>clang</application> builds</title>
<para>(For this case, the contents are also identical for both
@@ -378,7 +378,7 @@ PKG_BIN=/usr/local/sbin/pkg</programlist
<para>Separate builds for various combinations of architecture and branch
are supported. All data private to a build (ports tree, src tree,
packages, distfiles, log files, bindist, Makefile, etc) are located under the
- <filename>${arch}/${branch}/builds/${buildid}/</filename>
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/builds/<replaceable>${buildid}</replaceable>/</filename>
directory.
The most recently created build can be alternatively referenced using buildid
<literal>latest</literal>, and the one before using
@@ -393,7 +393,7 @@ PKG_BIN=/usr/local/sbin/pkg</programlist
<para>The <filename>scripts/dopackages.wrapper</filename> script
is used to perform the builds.</para>
- <screen>&prompt.root; <userinput>dopackages.wrapper ${arch} ${branch} ${buildid} [-options]</userinput></screen>
+ <screen>&prompt.root; <userinput>dopackages.wrapper <replaceable>${arch}</replaceable> <replaceable>${branch}</replaceable> <replaceable>${buildid}</replaceable> [-options]</userinput></screen>
<para>Most often, you will be using <literal>latest</literal> for
the value of <replaceable>buildid</replaceable>.</para>
@@ -570,7 +570,7 @@ PKG_BIN=/usr/local/sbin/pkg</programlist
anything. If it was interrupted, or you selected
<option>-nocleanup</option>, you need to clean up clients by running</para>
- <screen>&prompt.user; <userinput>build cleanup ${arch} ${branch} ${buildid} -full</userinput></screen>
+ <screen>&prompt.user; <userinput>build cleanup <replaceable>${arch}</replaceable> <replaceable>${branch}</replaceable> <replaceable>${buildid}</replaceable> -full</userinput></screen>
<para>When a new build is created, the directories <filename>errors/</filename>,
<filename>logs/</filename>, <filename>packages/</filename>, and so
@@ -608,7 +608,7 @@ PKG_BIN=/usr/local/sbin/pkg</programlist
process encounters an empty subdirectory, both package build
phases will stop short, and an error similar to the following
will be written to
- <filename>${arch}/${branch}/journal</filename>:</para>
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/journal</filename>:</para>
<screen>don't know how to make dns-all(continuing)</screen>
@@ -656,34 +656,34 @@ PKG_BIN=/usr/local/sbin/pkg</programlist
<itemizedlist>
<listitem>
- <para><literal>build create arch
- branch
- [newid]</literal> - Creates
+ <para><literal>build create <replaceable>arch</replaceable>
+ <replaceable>branch</replaceable>
+ [<replaceable>newid</replaceable>]</literal> - Creates
<replaceable>newid</replaceable> (or a datestamp if not specified).
Only needed when bringing up a new branch or a new architecture.</para>
</listitem>
<listitem>
- <para><literal>build clone arch
- branch oldid
- [newid]</literal> - Clones
+ <para><literal>build clone <replaceable>arch</replaceable>
+ <replaceable>branch</replaceable> <replaceable>oldid</replaceable>
+ [<replaceable>newid</replaceable>]</literal> - Clones
<replaceable>oldid</replaceable> to
<replaceable>newid</replaceable> (or a datestamp if not specified).</para>
</listitem>
<listitem>
- <para><literal>build srcupdate arch
- branch
- buildid</literal> - Replaces the src
+ <para><literal>build srcupdate <replaceable>arch</replaceable>
+ <replaceable>branch</replaceable>
+ <replaceable>buildid</replaceable></literal> - Replaces the src
tree with a new ZFS snapshot. Do not forget to use
<literal>-nosrc</literal> flag to <command>dopackages</command>
later!</para>
</listitem>
<listitem>
- <para><literal>build portsupdate arch
- branch
- buildid</literal> - Replaces the ports
+ <para><literal>build portsupdate <replaceable>arch</replaceable>
+ <replaceable>branch</replaceable>
+ <replaceable>buildid</replaceable></literal> - Replaces the ports
tree with a new ZFS snapshot. Do not forget to use
<literal>-noports</literal> flag to <command>dopackages</command>
later!</para>
@@ -698,7 +698,7 @@ PKG_BIN=/usr/local/sbin/pkg</programlist
package set. This can be accomplished with the following
invocation:</para>
- <screen>&prompt.root; <command>path/qmanager/packagebuild amd64 7-exp 20080904212103 aclock-0.2.3_2.tbz</command></screen>
+ <screen>&prompt.root; <command><replaceable>path</replaceable>/qmanager/packagebuild <replaceable>amd64</replaceable> <replaceable>7-exp</replaceable> <replaceable>20080904212103</replaceable> <replaceable>aclock-0.2.3_2.tbz</replaceable></command></screen>
</sect2>
</sect1>
@@ -714,7 +714,7 @@ PKG_BIN=/usr/local/sbin/pkg</programlist
<para>An update of the current <filename>ports</filename>
tree from the ZFS snapshot<footnote xml:id="footnote-status1">
<para>Status of these steps can be found in
- <filename>${arch}/${branch}/build.log</filename>
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/build.log</filename>
as well as on stderr of the tty running the
<command>dopackages</command> command.</para></footnote></para>
</listitem>
@@ -753,12 +753,12 @@ PKG_BIN=/usr/local/sbin/pkg</programlist
<listitem>
<para>Builds packages (phase 1)<footnote xml:id="footnote-status2"><para>Status of these steps can be found in
- <filename>${arch}/${branch}/journal</filename>.
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/journal</filename>.
Individual ports will write
their build logs to
- <filename>${arch}/${branch}/logs/</filename>
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/logs/</filename>
and their error logs to
- <filename>${arch}/${branch}/errors/</filename>.
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/errors/</filename>.
</para></footnote></para>
</listitem>
@@ -882,7 +882,7 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5
</note>
<para>After you have done all the above, remove the
- <filename>${arch}/lock</filename>
+ <filename><replaceable>${arch}</replaceable>/lock</filename>
file before trying to restart the build. If you do not,
<filename>dopackages</filename> will simply exit.</para>
@@ -900,14 +900,14 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5
<itemizedlist>
<listitem>
- <para><literal>build destroy arch
- branch</literal> - Destroy the
+ <para><literal>build destroy <replaceable>arch</replaceable>
+ <replaceable>branch</replaceable></literal> - Destroy the
build id.</para>
</listitem>
<listitem>
- <para><literal>build list arch
- branch</literal> - Shows the current set
+ <para><literal>build list <replaceable>arch</replaceable>
+ <replaceable>branch</replaceable></literal> - Shows the current set
of build ids.</para>
</listitem>
</itemizedlist>
@@ -920,11 +920,11 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5
<para>You can use <command>qclient</command> command to monitor the status
of build nodes, and to list the currently scheduled jobs:</para>
- <screen>&prompt.user; <userinput>python path/qmanager/qclient jobs</userinput>
-&prompt.user; <userinput>python path/qmanager/qclient status</userinput></screen>
+ <screen>&prompt.user; <userinput>python <replaceable>path</replaceable>/qmanager/qclient jobs</userinput>
+&prompt.user; <userinput>python <replaceable>path</replaceable>/qmanager/qclient status</userinput></screen>
<para>The
- <userinput>scripts/stats ${branch}</userinput>
+ <userinput>scripts/stats <replaceable>${branch}</replaceable></userinput>
command shows the number of packages already built.</para>
<para>Running <userinput>cat /a/portbuild/*/loads/*</userinput>
@@ -942,7 +942,7 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5
idle node.</para>
</note>
- <para>Running <userinput>tail -f ${arch}/${branch}/build.log</userinput>
+ <para>Running <userinput>tail -f <replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/build.log</userinput>
shows the overall build progress.</para>
<para>If a port build is failing, and it is not immediately obvious
@@ -952,7 +952,7 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5
directory. The next time the cluster tries to build this port,
it will tar, compress, and copy the <varname>WRKDIR</varname>
to
- <filename>${arch}/${branch}/wrkdirs/</filename>.</para>
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/wrkdirs/</filename>.</para>
<para>If you find that the system is looping trying to build the
same package over and over again, you may be able to fix the
@@ -1027,7 +1027,7 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5
the emailed logs and sort them to a folder, so you can maintain a
running list of current failures and detect new ones easily.
To do this, add an email address to
- <filename>${branch}/portbuild.conf</filename>.
+ <filename><replaceable>${branch}</replaceable>/portbuild.conf</filename>.
You can easily bounce the new ones to maintainers.</para>
<para>After a port appears broken on every build combination
@@ -1066,8 +1066,8 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5
build is post-processed, take an inventory of the list
of files fetched:</para>
- <screen>&prompt.user; <userinput>cd ${arch}/${branch}</userinput>
-&prompt.user; <userinput>find distfiles > distfiles-${release}</userinput></screen>
+ <screen>&prompt.user; <userinput>cd <replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable></userinput>
+&prompt.user; <userinput>find distfiles > distfiles-<replaceable>${release}</replaceable></userinput></screen>
<para>You should use that output to periodically clean out
the distfiles from <systemitem>ftp-master</systemitem>. When space
@@ -1077,12 +1077,12 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5
<para>Once the distfiles have been uploaded (see below),
the final release package set must be created. Just to be
on the safe side, run the
- <filename>${arch}/${branch}/cdrom.sh</filename>
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/cdrom.sh</filename>
script by hand to make sure all the CD-ROM restricted packages
and distfiles have been pruned. Then, copy the
- <filename>${arch}/${branch}/packages</filename>
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/packages</filename>
directory to
- <filename>${arch}/${branch}/packages-${release}</filename>.
+ <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/packages-<replaceable>${release}</replaceable></filename>.
Once the packages are safely moved off, contact the &a.re;
and inform them of the release package location.</para>
@@ -1180,13 +1180,13 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5
a new release), copy packages to the staging area on
<systemitem>ftp-master</systemitem> with something like the following:</para>
- <screen>&prompt.root; <userinput>cd /a/portbuild/${arch}/${branch}</userinput>
-&prompt.root; <userinput>tar cfv - packages/ | ssh portmgr at ftp-master tar xfC - w/ports/${arch}/tmp/${subdir}</userinput></screen>
+ <screen>&prompt.root; <userinput>cd /a/portbuild/<replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable></userinput>
+&prompt.root; <userinput>tar cfv - packages/ | ssh portmgr at ftp-master tar xfC - w/ports/<replaceable>${arch}</replaceable>/tmp/<replaceable>${subdir}</replaceable></userinput></screen>
<para>Then log into <systemitem>ftp-master</systemitem>, verify that
the package set was transferred successfully, remove the
package set that the new package set is to replace (in
- <filename>~/w/ports/${arch}</filename>),
+ <filename>~/w/ports/<replaceable>${arch}</replaceable></filename>),
and move the new set into place. (<filename>w/</filename> is
merely a shortcut.)</para>
@@ -1203,12 +1203,12 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5
<para>Example <command>rsync</command> command for incremental
package upload:</para>
- <screen>&prompt.root; <userinput>rsync -n -r -v -l -t -p --delete packages/ portmgr at ftp-master:w/ports/${arch}/${subdir}/ | tee log</userinput></screen>
+ <screen>&prompt.root; <userinput>rsync -n -r -v -l -t -p --delete packages/ portmgr at ftp-master:w/ports/<replaceable>${arch}</replaceable>/<replaceable>${subdir}</replaceable>/ | tee log</userinput></screen>
<para>Distfiles should be transferred with the
<command>cpdistfiles</command> script:</para>
- <screen>&prompt.root; <userinput>/a/portbuild/scripts/cpdistfiles ${arch} ${branch} ${buildid} [-yesreally] | tee log2</userinput></screen>
+ <screen>&prompt.root; <userinput>/a/portbuild/scripts/cpdistfiles <replaceable>${arch}</replaceable> <replaceable>${branch}</replaceable> <replaceable>${buildid}</replaceable> [-yesreally] | tee log2</userinput></screen>
<para>Doing it by hand is deprecated.</para>
</sect1>
@@ -1523,7 +1523,7 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5
directory to contain the install bits. You will probably
want to use a subdirectory of <filename>/pxeroot</filename>,
e.g.,
- <filename>/pxeroot/${arch}-${branch}</filename>.
+ <filename>/pxeroot/<replaceable>${arch}</replaceable>-<replaceable>${branch}</replaceable></filename>.
Export that as <varname>DESTDIR</varname>.</para>
</step>
@@ -1584,8 +1584,8 @@ options NFSSERVER
<para>As root, do the usual build steps, e.g.:</para>
<screen>&prompt.root; <userinput>make -j4 buildworld</userinput>
-&prompt.root; <userinput>make buildkernel KERNCONF=${kernconf}</userinput>
-&prompt.root; <userinput>make installkernel KERNCONF=${kernconf}</userinput>
+&prompt.root; <userinput>make buildkernel KERNCONF=<replaceable>${kernconf}</replaceable></userinput>
+&prompt.root; <userinput>make installkernel KERNCONF=<replaceable>${kernconf}</replaceable></userinput>
&prompt.root; <userinput>make installworld</userinput></screen>
<para>The install steps use <varname>DESTDIR</varname>.</para>
@@ -1599,15 +1599,15 @@ options NFSSERVER
<para>If you are using <filename>pxeboot</filename>: create
a subdirectory of
- <filename>${DESTDIR}</filename>
+ <filename><replaceable>${DESTDIR}</replaceable></filename>
called <filename>conf/</filename>. Create one subdirectory
<filename>default/etc/</filename>, and (if your site will host
multiple nodes), subdirectories
- <filename>${ip-address}/etc/</filename>
+ <filename><replaceable>${ip-address}</replaceable>/etc/</filename>
to contain override files for individual hosts. (You may find
it handy to symlink each of those directories to a hostname.)
Copy the entire contents of
- <filename>${DESTDIR}/etc/</filename>
+ <filename><replaceable>${DESTDIR}</replaceable>/etc/</filename>
to <filename>default/etc/</filename>; that is where you will
edit your files. The by-ip-address
<filename>etc/</filename> directories will probably only need
@@ -1702,8 +1702,8 @@ sshd_program="/usr/local/sbin/sshd"</pro
cache on the client, add the following</para>
<programlisting>squid_enable="YES"
-squid_chdir="<filename>/a/squid/logs</filename>"
-squid_pidfile="<filename>/a/squid/logs/squid.pid</filename>"</programlisting>
+squid_chdir="/<replaceable>a</replaceable>/squid/logs"
+squid_pidfile="/<replaceable>a</replaceable>/squid/logs/squid.pid"</programlisting>
<para>Required entries for VMWare-based nodes:</para>
<programlisting>vmware_guest_vmmemctl_enable="YES"
@@ -1724,8 +1724,8 @@ sshd_program="/usr/local/sbin/sshd"
gmond_enable="YES"
squid_enable="YES"
-squid_chdir="<filename>/a/squid/logs</filename>"
-squid_pidfile="<filename>/a/squid/logs/squid.pid</filename>"</programlisting>
+squid_chdir="/<replaceable>a</replaceable>/squid/logs"
+squid_pidfile="/<replaceable>a</replaceable>/squid/logs/squid.pid"</programlisting>
<para>&man.ntpd.8; should <emphasis>not</emphasis>
be enabled for VMWare instances.</para>
@@ -1733,7 +1733,7 @@ squid_pidfile="<filename>/a/squid/logs/s
<para>Also, it may be possible to leave
<application>squid</application> disabled by default
so as to not have
- <filename>/a</filename>
+ <filename>/<replaceable>a</replaceable></filename>
persistent (which should save instantiation time.)
Work is still ongoing.
</para>
@@ -1748,7 +1748,7 @@ squid_pidfile="<filename>/a/squid/logs/s
<para>Modify <filename>etc/sysctl.conf</filename>:</para>
<screen>9a10,30
-> kern.corefile=<filename>/a/%N.core</filename>
+> kern.corefile=/<replaceable>a</replaceable>/%N.core
> kern.sugid_coredump=1
> #debug.witness_ddb=0
> #debug.witness_watch=0
@@ -1856,7 +1856,7 @@ security/sudo</programlisting>
#
# Configure a package build system post-boot
-scratchdir=<filename>/a</filename>
+scratchdir=/<replaceable>a</replaceable>
ln -sf ${scratchdir}/portbuild /var/
@@ -1895,7 +1895,7 @@ touch /tmp/.boot_finished</programlistin
> negative_ttl 0 minutes</screen>
<para>Also, change <filename>usr/local</filename>
- to <filename>usr2</filename> in
+ to <filename><replaceable>usr2</replaceable></filename> in
<literal>cache_dir</literal>,
<literal>access_log</literal>,
<literal>cache_log</literal>,
@@ -1940,7 +1940,7 @@ portbuild ALL=(ALL) NOPASSWD: ALL</p
<step>
<para>Change into the port/package directory you picked
above, e.g.,
- <command>cd /usr2</command>.</para>
+ <command>cd <replaceable>/usr2</replaceable></command>.</para>
</step>
<step>
@@ -2010,7 +2010,7 @@ portbuild ALL=(ALL) NOPASSWD: ALL</p
<step>
<para>Create
- <filename>/a/portbuild/${arch}/clients/bindist-${hostname}.tar</filename>.</para>
+ <filename>/a/portbuild/<replaceable>${arch}</replaceable>/clients/bindist-<replaceable>${hostname}</replaceable>.tar</filename>.</para>
<itemizedlist>
<listitem>
@@ -2055,15 +2055,15 @@ MASTER_SITE_OVERRIDE= \
<step>
<para>Create
-<filename>/a/portbuild/${arch}/portbuild-${hostname}</filename>
+<filename>/a/portbuild/<replaceable>${arch}</replaceable>/portbuild-<replaceable>${hostname}</replaceable></filename>
using one of the existing ones as a guide. This
file contains overrides to
-<filename>/a/portbuild/${arch}/portbuild.conf</filename>.</para>
+<filename>/a/portbuild/<replaceable>${arch}</replaceable>/portbuild.conf</filename>.</para>
<para>Suggested values:</para>
<programlisting>disconnected=1
-scratchdir=<filename>/usr2/pkgbuild</filename>
+scratchdir=<replaceable>/usr2</replaceable>/pkgbuild
client_user=portbuild
sudo_cmd="sudo -H"
rsync_gzip=-z
@@ -2075,7 +2075,7 @@ infoseek_port=<replaceable>${tunelled-tc
on the client:</para>
<programlisting>http_proxy="http://localhost:3128/"
-squid_dir=<filename>/usr2/squid</filename></programlisting>
+squid_dir=<replaceable>/usr2</replaceable>/squid</programlisting>
<para>If, instead, you will be using <application>squid</application>
on the server:</para>
@@ -2125,7 +2125,7 @@ ssh_cmd="/usr/local/bin/ssh"</programlis
<step>
<para>Ensure that <literal>ssh</literal> to the client
is working by executing
- <userinput>ssh hostname uname -a</userinput>.
+ <userinput>ssh <replaceable>hostname</replaceable> uname -a</userinput>.
The actual command is not important; what is important is to
confirm the setup, and also add an entry into
<filename>known_hosts</filename>, once you have confirmed the
@@ -2135,13 +2135,13 @@ ssh_cmd="/usr/local/bin/ssh"</programlis
<step>
<para>Populate the client's copy of
<filename>/var/portbuild/scripts/</filename> by something like
- <userinput>/a/portbuild/scripts/dosetupnode arch major latest hostname</userinput>.
+ <userinput>/a/portbuild/scripts/dosetupnode <replaceable>arch</replaceable> <replaceable>major</replaceable> latest <replaceable>hostname</replaceable></userinput>.
Verify that you now have files in that directory.</para>
</step>
<step>
<para>Test the other TCP ports by executing
- <userinput>telnet hostname portnumber</userinput>.
+ <userinput>telnet <replaceable>hostname</replaceable> <replaceable>portnumber</replaceable></userinput>.
<literal>414</literal> (or its tunnel) should give you a few lines of status
information including <literal>arch</literal> and
<literal>osversion</literal>; <literal>8649</literal> should
@@ -2157,17 +2157,17 @@ ssh_cmd="/usr/local/bin/ssh"</programlis
<step>
<para>Tell <filename>qmanager</filename> about the node. Example:</para>
- <para><userinput>python path/qmanager/qclient add
- name=uniquename
- arch=arch
- osversion=osversion
- numcpus=number
+ <para><userinput>python <replaceable>path</replaceable>/qmanager/qclient add
+ name=<replaceable>uniquename</replaceable>
+ arch=<replaceable>arch</replaceable>
+ osversion=<replaceable>osversion</replaceable>
+ numcpus=<replaceable>number</replaceable>
haszfs=0
online=1
- domain=domain
+ domain=<replaceable>domain</replaceable>
primarypool=package
pools="package all" maxjobs=1
- acl="ports-arch,deny_all"
+ acl="ports-<replaceable>arch</replaceable>,deny_all"
</userinput></para>
</step>
</procedure>
@@ -2180,7 +2180,7 @@ ssh_cmd="/usr/local/bin/ssh"</programlis
<para>Once you are sure that the client is working, tell
<application>pollmachine</application> about it by adding
it to
- <filename>/a/portbuild/${arch}/mlist</filename>.</para>
+ <filename>/a/portbuild/<replaceable>${arch}</replaceable>/mlist</filename>.</para>
</step>
</procedure>
</sect2>
@@ -2216,7 +2216,7 @@ ssh_cmd="/usr/local/bin/ssh"</programlis
<listitem>
<para>For what was previously head, change
<varname>SRC_BRANCH_<replaceable>branch</replaceable>_SUBDIR</varname> to
- <literal>releng/branch.0</literal>
+ <literal>releng/<replaceable>branch</replaceable>.0</literal>
(literal zero).</para>
</listitem>
@@ -2301,22 +2301,22 @@ zfs destroy -r a/snap/src-<replaceable>o
<itemizedlist>
<listitem>
<para>Files named
- <filename>*-old_branch-failure.html</filename></para>
+ <filename>*-<replaceable>old_branch</replaceable>-failure.html</filename></para>
</listitem>
<listitem>
<para>Files named
- <filename>buildlogs_*-old_branch-*-logs.txt</filename></para>
+ <filename>buildlogs_*-<replaceable>old_branch</replaceable>-*-logs.txt</filename></para>
</listitem>
<listitem>
<para>Symlinks named
- <filename>*-old_branch-previous*</filename></para>
+ <filename>*-<replaceable>old_branch</replaceable>-previous*</filename></para>
</listitem>
<listitem>
<para>Symlinks named
- <filename>*-old_branch-latest*</filename></para>
+ <filename>*-<replaceable>old_branch</replaceable>-latest*</filename></para>
</listitem>
</itemizedlist>
</listitem>
@@ -2430,7 +2430,7 @@ zfs destroy -r a/snap/src-<replaceable>o
<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/arch/archive</filename>
+ <filename>/dumpster/pointyhat/<replaceable>arch</replaceable>/archive</filename>
and symlink to that.</para>
</note>
</listitem>
@@ -2448,7 +2448,7 @@ zfs destroy -r a/snap/src-<replaceable>o
<listitem>
<para>Create customized
- <filename>portbuild.machinename.conf</filename>
+ <filename>portbuild.<replaceable>machinename</replaceable>.conf</filename>
files as appropriate.</para>
</listitem>
@@ -2763,7 +2763,7 @@ sh -x ./tmp/mkportbuild
<step>
<para>Pick a mountpoint and export it. We have used
- <filename>/a</filename> so far to date.</para>
+ <filename>/<replaceable>a</replaceable></filename> so far to date.</para>
<screen>&prompt.root; export ZFS_MOUNTPOINT=/<replaceable>a</replaceable></screen>
</step>
@@ -2859,7 +2859,7 @@ sh -x ./tmp/mkportbuild
<procedure>
<step>
<para>Configure the server by making the following changes to
- <filename>/a/portbuild/admin/conf/admin.conf</filename>:</para>
+ <filename>/<replaceable>a</replaceable>/portbuild/admin/conf/admin.conf</filename>:</para>
<itemizedlist>
<listitem>
@@ -2906,7 +2906,7 @@ sh -x ./tmp/mkportbuild
<step>
<para>Configure how build slaves will talk to your server
by making the following changes to
- <filename>/a/portbuild/conf/client.conf</filename>:</para>
+ <filename>/<replaceable>a</replaceable>/portbuild/conf/client.conf</filename>:</para>
<itemizedlist>
<listitem>
@@ -2932,14 +2932,14 @@ sh -x ./tmp/mkportbuild
<step>
<para>Most of the default values in
- <filename>/a/portbuild/conf/common.conf</filename>
+ <filename>/<replaceable>a</replaceable>/portbuild/conf/common.conf</filename>
should be fine. This file holds definitions used by
both the server and all its clients.</para>
</step>
<step>
<para>Configure the server by making the following changes to
- <filename>/a/portbuild/conf/server.conf</filename>:</para>
+ <filename>/<replaceable>a</replaceable>/portbuild/conf/server.conf</filename>:</para>
<itemizedlist>
<!--
@@ -3138,7 +3138,7 @@ qmanager</programlisting>
<listitem>
<para>Note the time and failure mode (e.g., paste in the
relevant console output) in
- <filename>/a/portbuild/${arch}/reboots</filename></para>
+ <filename>/a/portbuild/<replaceable>${arch}</replaceable>/reboots</filename></para>
</listitem>
<listitem>
More information about the svn-doc-head
mailing list