Date: Mon, 24 Dec 2012 09:02:51 +0000 (UTC) From: Hiroki Sato <hrs@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r40465 - head/en_US.ISO8859-1/articles/portbuild Message-ID: <201212240902.qBO92pi2073255@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: hrs Date: Mon Dec 24 09:02:50 2012 New Revision: 40465 URL: http://svnweb.freebsd.org/changeset/doc/40465 Log: DocBook markup fixes: - Replace literal with filename, makevar, option. - Make use of programlisting and screen consistent. - Use <footnote> for footnote and <xref> for internal reference. - Add missing &prompt.root;. - Use <userinput> instead of <command>. 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 Mon Dec 24 00:09:26 2012 (r40464) +++ head/en_US.ISO8859-1/articles/portbuild/article.xml Mon Dec 24 09:02:50 2012 (r40465) @@ -54,7 +54,7 @@ <note> <para>Many of the details in this article will be of interest only to - those on the <ulink url="&url.base/portmgr">Ports Management</ulink> + those on the <ulink url="&url.base;/portmgr/">Ports Management</ulink> team.</para> </note> @@ -81,10 +81,10 @@ </note> <para>The scripts that control all of this live in - <filename class="directory">/var/portbuild/scripts/</filename>. + <filename role="directory">/var/portbuild/scripts/</filename>. These are the checked-out copies from the Subversion repository at <ulink url="http://svnweb.freebsd.org/base/projects/portbuild/scripts/">; - <filename class="directory">base/projects/portbuild/scripts/</filename> + <filename role="directory">base/projects/portbuild/scripts/</filename> </ulink>.</para> <para>Typically, incremental builds are done that use previous @@ -344,7 +344,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 <replaceable>${arch}</replaceable> <replaceable>${branch}</replaceable> <replaceable>${buildid}</replaceable> <literal>[-options]</literal></userinput></screen> + <screen>&prompt.root; <userinput>dopackages.wrapper <replaceable>${arch}</replaceable> <replaceable>${branch}</replaceable> <replaceable>${buildid}</replaceable> <option>[-options]</option></userinput></screen> <para>Most often, you will be using <literal>latest</literal> for the value of <replaceable>buildid</replaceable>.</para> @@ -354,7 +354,7 @@ PKG_BIN=/usr/local/sbin/pkg</programlist <itemizedlist> <listitem> - <para><literal>-keep</literal> - Do not delete this build in the + <para><option>-keep</option> - Do not delete this build in the future, when it would be normally deleted as part of the <literal>latest</literal> - <literal>previous</literal> cycle. Do not forget to clean it up manually when you no longer need it. @@ -362,7 +362,7 @@ PKG_BIN=/usr/local/sbin/pkg</programlist </listitem> <listitem> - <para><literal>-nofinish</literal> - Do not perform + <para><option>-nofinish</option> - Do not perform post-processing once the build is complete. Useful if you expect that the build will need to be restarted once it finishes. If you use this option, do not forget to cleanup @@ -371,20 +371,20 @@ PKG_BIN=/usr/local/sbin/pkg</programlist </listitem> <listitem> - <para><literal>-finish</literal> - Perform + <para><option>-finish</option> - Perform post-processing only. </para> </listitem> <listitem> - <para><literal>-nocleanup</literal> - By default, when the - <literal>-finish</literal> stage of the build is complete, the build + <para><option>-nocleanup</option> - By default, when the + <option>-finish</option> stage of the build is complete, the build data will be deleted from the clients. This option will prevent that.</para> </listitem> <listitem> - <para><literal>-restart</literal> - Restart an interrupted + <para><option>-restart</option> - Restart an interrupted (or non-<literal>finish</literal>ed) build from the beginning. Ports that failed on the previous build will be rebuilt. @@ -392,16 +392,16 @@ PKG_BIN=/usr/local/sbin/pkg</programlist </listitem> <listitem> - <para><literal>-continue</literal> - Restart an interrupted + <para><option>-continue</option> - Restart an interrupted (or non-<literal>finish</literal>ed) build. Will not rebuild ports that failed on the previous build. </para> </listitem> <listitem> - <para><literal>-incremental</literal> - Compare the + <para><option>-incremental</option> - Compare the interesting fields of the new - <literal>INDEX</literal> with the previous one, + <filename>INDEX</filename> with the previous one, remove packages and log files for the old ports that have changed, and rebuild the rest. This cuts down on build times substantially since @@ -410,126 +410,126 @@ PKG_BIN=/usr/local/sbin/pkg</programlist </listitem> <listitem> - <para><literal>-cdrom</literal> - This package build is + <para><option>-cdrom</option> - This package build is intended to end up on a CD-ROM, so - <literal>NO_CDROM</literal> packages and distfiles + <makevar>NO_CDROM</makevar> packages and distfiles should be deleted in post-processing. </para> </listitem> <listitem> - <para><literal>-nobuild</literal> - Perform all + <para><option>-nobuild</option> - Perform all the preprocessing steps, but do not actually do the package build. </para> </listitem> <listitem> - <para><literal>-noindex</literal> - Do not rebuild + <para><option>-noindex</option> - Do not rebuild <filename>INDEX</filename> during preprocessing. </para> </listitem> <listitem> - <para><literal>-noduds</literal> - Do not rebuild the + <para><option>-noduds</option> - Do not rebuild the <filename>duds</filename> file (ports that are never built, e.g., those marked <literal>IGNORE</literal>, - <literal>NO_PACKAGE</literal>, etc.) during + <makevar>NO_PACKAGE</makevar>, etc.) during preprocessing. </para> </listitem> <listitem> - <para><literal>-nochecksubdirs</literal> - Do not check the + <para><option>-nochecksubdirs</option> - Do not check the <makevar>SUBDIRS</makevar> for ports that are not connected to the build. </para> </listitem> <listitem> - <para><literal>-trybroken</literal> - Try to build - <literal>BROKEN</literal> ports (off by default + <para><option>-trybroken</option> - Try to build + <makevar>BROKEN</makevar> ports (off by default because the amd64/&i386; clusters are fast enough now that when doing incremental builds, more time was spent rebuilding things that were going to fail anyway. Conversely, the other clusters are slow enough that it would be a waste of time - to try and build <literal>BROKEN</literal> ports). + to try and build <makevar>BROKEN</makevar> ports). </para> <note> - <para>With <literal>-trybroken</literal>, you probably - also want to use <literal>-fetch-original</literal> + <para>With <option>-trybroken</option>, you probably + also want to use <option>-fetch-original</option> and - <literal>-unlimited-errors</literal>.</para> + <option>-unlimited-errors</option>.</para> </note> </listitem> <listitem> - <para><literal>-nosrc</literal> - Do not update the - <literal>src</literal> tree from the ZFS snapshot, keep the tree from + <para><option>-nosrc</option> - Do not update the + <filename>src</filename> tree from the ZFS snapshot, keep the tree from previous build instead. </para> </listitem> <listitem> - <para><literal>-srcvcs</literal> - Do not update the - <literal>src</literal> tree from the ZFS snapshot, update it with + <para><option>-srcvcs</option> - Do not update the + <filename>src</filename> tree from the ZFS snapshot, update it with a fresh checkout instead. </para> </listitem> <listitem> - <para><literal>-noports</literal> - Do not update the - <literal>ports</literal> tree from the ZFS snapshot, keep the tree from + <para><option>-noports</option> - Do not update the + <filename>ports</filename> tree from the ZFS snapshot, keep the tree from previous build instead. </para> </listitem> <listitem> - <para><literal>-portsvcs</literal> - Do not update the - <literal>ports</literal> tree from the ZFS snapshot, update it with + <para><option>-portsvcs</option> - Do not update the + <filename>ports</filename> tree from the ZFS snapshot, update it with a fresh checkout instead. </para> </listitem> <listitem> - <para><literal>-norestr</literal> - Do not attempt to build - <literal>RESTRICTED</literal> ports. + <para><option>-norestr</option> - Do not attempt to build + <makevar>RESTRICTED</makevar> ports. </para> </listitem> <listitem> - <para><literal>-noplistcheck</literal> - Do not make it fatal for + <para><option>-noplistcheck</option> - Do not make it fatal for ports to leave behind files after deinstallation. </para> </listitem> <listitem> - <para><literal>-nodistfiles</literal> - Do not collect distfiles + <para><option>-nodistfiles</option> - Do not collect distfiles that pass <command>make checksum</command> for later uploading to <hostid>ftp-master</hostid>. </para> </listitem> <listitem> - <para><literal>-fetch-original</literal> - Fetch the - distfile from the original <literal>MASTER_SITES</literal> + <para><option>-fetch-original</option> - Fetch the + distfile from the original <makevar>MASTER_SITES</makevar> rather than any cache such as on <hostid>ftp-master</hostid>. </para> </listitem> <listitem> - <para><literal>-unlimited-errors</literal> + <para><option>-unlimited-errors</option> - defeat the "qmanager threshhold" check for runaway builds. You want this primarily when doing a - <literal>-restart</literal> of a build that you expect to mostly - fail, or perhaps a <literal>-trybroken</literal> run. By default, + <option>-restart</option> of a build that you expect to mostly + fail, or perhaps a <option>-trybroken</option> run. By default, the threshhold check is done.</para> </listitem> </itemizedlist> - <para>Unless you specify <literal>-restart</literal>, - <literal>-continue</literal>, or <literal>-finish</literal>, + <para>Unless you specify <option>-restart</option>, + <option>-continue</option>, or <option>-finish</option>, the symlinks for the existing builds will be rotated. i.e, the existing symlink for <filename>previous</filename> will be deleted; the most recent build will have its symlink changed @@ -539,7 +539,7 @@ PKG_BIN=/usr/local/sbin/pkg</programlist <para>If the last build finished cleanly you do not need to delete anything. If it was interrupted, or you selected - <literal>-nocleanup</literal>, you need to clean up clients by running + <option>-nocleanup</option>, you need to clean up clients by running </para> <para>&prompt.user; <userinput>build cleanup <replaceable>${arch}</replaceable> <replaceable>${branch}</replaceable> <replaceable>${buildid}</replaceable> -full</userinput></para> @@ -554,10 +554,10 @@ PKG_BIN=/usr/local/sbin/pkg</programlist <note> <para><literal>dosetupnodes</literal> is supposed to be run from the <literal>dopackages</literal> script in the - <literal>-restart</literal> case, but it can be a good idea to + <option>-restart</option> case, but it can be a good idea to run it by hand and then verify that the clients all have the expected job load. Sometimes, - <literal>dosetupnode</literal> cannot clean up a build and you + <filename>dosetupnode</filename> cannot clean up a build and you need to do it by hand. (This is a bug.)</para> </note> @@ -581,13 +581,13 @@ PKG_BIN=/usr/local/sbin/pkg</programlist <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/journal</filename>: </para> - <programlisting><literal>don't know how to make dns-all(continuing)</literal></programlisting> + <screen>don't know how to make dns-all(continuing)</screen> <para>To correct this problem, simply comment out or remove - the <literal>SUBDIR</literal> entries that point to empty + the <makevar>SUBDIR</makevar> entries that point to empty subdirectories. After doing this, you can restart the build by running the proper <command>dopackages</command> command - with the <literal>-restart</literal> option. + with the <option>-restart</option> option. </para> <note> @@ -691,77 +691,69 @@ PKG_BIN=/usr/local/sbin/pkg</programlist <orderedlist> <listitem> - <para>An update of the current <literal>ports</literal> - tree from the ZFS snapshot [*] - </para> + <para>An update of the current <filename>ports</filename> + tree from the ZFS snapshot<footnote id="footnote-status1"> + <para>Status of these steps can be found in + <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> <listitem> <para>An update of the running branch's - <literal>src</literal> tree from the ZFS snapshot [*] + <filename>src</filename> tree from the ZFS snapshot<footnoteref linkend='footnote-status1'></footnoteref> </para> </listitem> <listitem> <para>Checks which ports do not have a - <literal>SUBDIR</literal> entry in their respective - category's <filename>Makefile</filename> [*] + <makevar>SUBDIR</makevar> entry in their respective + category's <filename>Makefile</filename><footnoteref linkend='footnote-status1'></footnoteref> </para> </listitem> <listitem> <para>Creates the <filename>duds</filename> file, which - is a list of ports not to build [*] [+] - </para> + is a list of ports not to build<footnoteref linkend='footnote-status1'></footnoteref><footnote id="footnote-buildstop"> + <para>If any of these steps fail, the build will stop + cold in its tracks.</para></footnote></para> </listitem> <listitem> <para>Generates a fresh <filename>INDEX</filename> - file [*] [+] + file<footnoteref linkend='footnote-status1'></footnoteref><footnoteref linkend='footnote-buildstop'></footnoteref> </para> </listitem> <listitem> <para>Sets up the nodes that will be used in the - build [*] [+] + build<footnoteref linkend='footnote-status1'></footnoteref><footnoteref linkend='footnote-buildstop'></footnoteref> </para> </listitem> <listitem> - <para>Builds a list of restricted ports [*] [+]</para> + <para>Builds a list of restricted ports<footnoteref linkend='footnote-status1'></footnoteref><footnoteref linkend='footnote-buildstop'></footnoteref></para> </listitem> <listitem> - <para>Builds packages (phase 1) [++]</para> + <para>Builds packages (phase 1)<footnote id="footnote-status2"><para>Status of these steps can be found in + <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/journal</filename>. + Individual ports will write + their build logs to + <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/logs/</filename> + and their error logs to + <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/errors/</filename>. + </para></footnote></para> </listitem> <listitem> - <para>Performs another node setup [+]</para> + <para>Performs another node setup<footnoteref linkend='footnote-status1'></footnoteref></para> </listitem> <listitem> - <para>Builds packages (phase 2) [++]</para> + <para>Builds packages (phase 2)<footnoteref linkend='footnote-status2'></footnoteref></para> </listitem> </orderedlist> - - <para>[*] Status of these steps can be found in - <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> - - <para>[+] If any of these steps fail, the build will stop - cold in its tracks.</para> - - <para>[++] Status of these steps can be found in - <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/journal</filename> - . - Individual ports will write - their build logs to - <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/logs/</filename> - and their error logs to - <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/errors/</filename>. - </para> - </sect1> <sect1 id="build-maintenance"> @@ -794,11 +786,11 @@ PKG_BIN=/usr/local/sbin/pkg</programlist identify the tty in which it's running (either record the output of &man.tty.1; when you start the build, or use <command>ps x</command> to identify it. You need to make sure that nothing else important - is running in this tty, e.g., <command>ps -t p1</command> or whatever. + is running in this tty, e.g., <userinput>ps -t p1</userinput> or whatever. If there is not, you can just kill off the whole term easily with - <command>pkill -t pts/1</command>; otherwise issue a - <command>kill -HUP</command> in there by, for example, -<command>ps -t pts/1 -o pid= | xargs kill -HUP</command>. Replace + <userinput>pkill -t pts/1</userinput>; otherwise issue a + <userinput>kill -HUP</userinput> in there by, for example, +<userinput>ps -t pts/1 -o pid= | xargs kill -HUP</userinput>. Replace <replaceable>p1</replaceable> by whatever the tty is, of course.</para> <para>The @@ -827,11 +819,11 @@ PKG_BIN=/usr/local/sbin/pkg</programlist new jobs will be dispatched in their place since <hostid>pointyhat</hostid> thinks the job slot is still occupied.</para> - <para>To check, <command>cat ~/loads/*</command> to display the + <para>To check, <userinput>cat ~/loads/*</userinput> to display the status of client machines; the first column is the number of jobs it thinks is running, and this should be roughly concordant with the load average. <literal>loads</literal> is refreshed - every 2 minutes. If you do <command>ps x | grep pdispatch</command> + every 2 minutes. If you do <userinput>ps x | grep pdispatch</userinput> and it is less than the number of jobs that <literal>loads</literal> thinks are in use, you are in trouble.</para> @@ -909,14 +901,14 @@ 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; <command>python <replaceable>path</replaceable>/qmanager/qclient jobs</command> -&prompt.user; <command>python <replaceable>path</replaceable>/qmanager/qclient status</command></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 - <command>scripts/stats <replaceable>${branch}</replaceable></command> + <userinput>scripts/stats <replaceable>${branch}</replaceable></userinput> command shows the number of packages already built.</para> - <para>Running <command>cat /var/portbuild/*/loads/*</command> + <para>Running <userinput>cat /var/portbuild/*/loads/*</userinput> shows the client loads and number of concurrent builds in progress. The files that have been recently updated are the clients that are online; the others are the offline clients.</para> @@ -931,15 +923,15 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 idle node.</para> </note> - <para>Running <command>tail -f <replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/build.log</command> + <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 from the log as to why, you can preserve the - <literal>WRKDIR</literal> for further analysis. To do this, + <makevar>WRKDIR</makevar> for further analysis. To do this, touch a file called <filename>.keep</filename> in the port's directory. The next time the cluster tries to build this port, - it will tar, compress, and copy the <literal>WRKDIR</literal> + it will tar, compress, and copy the <makevar>WRKDIR</makevar> to <filename><replaceable>${arch}</replaceable>/<replaceable>${branch}</replaceable>/wrkdirs/</filename>. </para> @@ -976,7 +968,7 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 </listitem> <listitem> - <para>number of lines in <literal>INDEX</literal></para> + <para>number of lines in <filename>INDEX</filename></para> </listitem> <listitem> @@ -1022,7 +1014,7 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 You can easily bounce the new ones to maintainers.</para> <para>After a port appears broken on every build combination - multiple times, it is time to mark it <literal>BROKEN</literal>. + multiple times, it is time to mark it <makevar>BROKEN</makevar>. Two weeks' notification for the maintainers seems fair.</para> <note> @@ -1039,20 +1031,20 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 <para>When building packages for a release, it may be necessary to manually update the <literal>ports</literal> - and <literal>src</literal> trees to the release tag and use - <literal>-novcs</literal> and - <literal>-noportsvcs</literal>.</para> + and <filename>src</filename> trees to the release tag and use + <option>-novcs</option> and + <option>-noportsvcs</option>.</para> <para>To build package sets intended for use on a CD-ROM, - use the <literal>-cdrom</literal> option to + use the <option>-cdrom</option> option to <command>dopackages</command>.</para> <para>If the disk space is not available on the cluster, use - <literal>-nodistfiles</literal> to avoid collecting distfiles.</para> + <option>-nodistfiles</option> to avoid collecting distfiles.</para> <para>After the initial build completes, restart the build with - <literal>-restart -fetch-original</literal> + <option>-restart -fetch-original</option> to collect updated distfiles as well. Then, once the build is post-processed, take an inventory of the list of files fetched:</para> @@ -1093,11 +1085,11 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 <para>Once a build has completed, packages and/or distfiles can be transferred to <hostid>ftp-master</hostid> for propagation to the FTP mirror network. If the build was - run with <literal>-nofinish</literal>, then make sure to + run with <option>-nofinish</option>, then make sure to follow up with <command>dopackages -finish</command> to post-process the - packages (removes <literal>RESTRICTED</literal> and - <literal>NO_CDROM</literal> packages where appropriate, + packages (removes <makevar>RESTRICTED</makevar> and + <makevar>NO_CDROM</makevar> packages where appropriate, prunes packages not listed in <filename>INDEX</filename>, removes from <filename>INDEX</filename> references to packages not built, and generates a @@ -1105,7 +1097,7 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 summary); and distfiles (moves them from the temporary <filename>distfiles/.pbtmp</filename> directory into <filename>distfiles/</filename> and removes - <literal>RESTRICTED</literal> and <literal>NO_CDROM</literal> + <makevar>RESTRICTED</makevar> and <makevar>NO_CDROM</makevar> distfiles).</para> <para>It is usually a good idea to run the @@ -1118,28 +1110,28 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 the final package set for a release.</para> <para>The package subdirectories are named by whether they are for - <literal>release</literal>, <literal>stable</literal>, or - <literal>current</literal>. Examples:</para> + <filename>release</filename>, <filename>stable</filename>, or + <filename>current</filename>. Examples:</para> <itemizedlist> <listitem> - <para><literal>packages-7.2-release</literal></para> + <para><filename>packages-7.2-release</filename></para> </listitem> <listitem> - <para><literal>packages-7-stable</literal></para> + <para><filename>packages-7-stable</filename></para> </listitem> <listitem> - <para><literal>packages-8-stable</literal></para> + <para><filename>packages-8-stable</filename></para> </listitem> <listitem> - <para><literal>packages-9-stable</literal></para> + <para><filename>packages-9-stable</filename></para> </listitem> <listitem> - <para><literal>packages-10-current</literal></para> + <para><filename>packages-10-current</filename></para> </listitem> </itemizedlist> @@ -1148,11 +1140,11 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 <itemizedlist> <listitem> - <para><literal>packages-stable</literal></para> + <para><filename>packages-stable</filename></para> </listitem> <listitem> - <para><literal>packages-current</literal></para> + <para><filename>packages-current</filename></para> </listitem> </itemizedlist> @@ -1180,10 +1172,10 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 using <command>rsync</command> so we do not put too much strain on the mirrors.</para> - <para><emphasis>ALWAYS</emphasis> use <literal>-n</literal> + <para><emphasis>ALWAYS</emphasis> use <option>-n</option> first with <command>rsync</command> and check the output to make sure it is sane. If it looks good, re-run the - <command>rsync</command> without the <literal>-n</literal> + <command>rsync</command> without the <option>-n</option> option. </para> @@ -1272,8 +1264,8 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 <note><para>If it has been a long time since one of the builds finished, the logs may have been automatically compressed with - bzip2. In that case, you must use <literal>sort | sed - 's,\.bz2,,g'</literal> instead.</para></note> + bzip2. In that case, you must use <userinput>sort | sed + 's,\.bz2,,g'</userinput> instead.</para></note> <screen>&prompt.user; <userinput>comm -3 /tmp/8-errs /tmp/8-exp-errs | less</userinput></screen> @@ -1308,13 +1300,13 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 include:</para> <itemizedlist> - <listitem> - <para>Port was broken by the experimental patches [1]</para> + <listitem id="broken-by-exp-patches" xreflabel="broken by experimental patches"> + <para>Port was broken by the experimental patches</para> </listitem> - <listitem> + <listitem id="broken-by-upgrading" xreflabel="broken by upgrading"> <para>Port was upgraded since the control build and has become - broken [2] + broken </para> </listitem> @@ -1327,7 +1319,7 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 <para>Both columns should be investigated and the reason for the errors understood before committing the experimental patches set. - To differentiate between [1] and [2] above, you can do a rebuild + To differentiate between <xref linkend="broken-by-exp-patches"></xref> and <xref linkend="broken-by-upgrading"></xref> above, you can do a rebuild of the affected packages under the control branch:</para> <screen>&prompt.user; <userinput>cd /var/portbuild/i386/8/ports</userinput></screen> @@ -1336,7 +1328,7 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 <para>The following example is obsolete</para> </note> - <note><para>Be sure to <literal>cvs update</literal> this tree to the same date as + <note><para>Be sure to <userinput>cvs update</userinput> this tree to the same date as the experimental patches tree.</para></note> <!-- XXX MCL fix --> @@ -1362,8 +1354,8 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 <para>The list of packages to build should be a list of package names (including versions) as they appear in - <filename>INDEX</filename>. The <literal>PKGSUFFIX</literal> - (i.e., .tgz or .tbz) is optional.</para></note> + <filename>INDEX</filename>. The <makevar>PKGSUFFIX</makevar> + (i.e., <filename>.tgz</filename> or <filename>.tbz</filename>) is optional.</para></note> <para>This will build only those packages listed as well as all of their dependencies.</para> @@ -1489,7 +1481,7 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 </sect2> <sect2 id="node-src"> - <title>Configuring <literal>src</literal></title> + <title>Configuring <filename>src</filename></title> <procedure> <step> @@ -1503,7 +1495,7 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 </step> <step> - <para>If you are using <literal>pxeboot</literal>: create a + <para>If you are using <filename>pxeboot</filename>: create a directory to contain the install bits. You will probably want to use a subdirectory of <filename>/pxeroot</filename>, e.g., @@ -1513,7 +1505,7 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 <step> <para>If you are cross-building, export - <literal>TARGET_ARCH</literal>=<replaceable>${arch}</replaceable>. + <makevar>TARGET_ARCH</makevar>=<replaceable>${arch}</replaceable>. </para> <note> <para>The procedure for cross-building ports is not yet @@ -1523,8 +1515,8 @@ umount: Cleanup of /x/tmp/8-exp/chroot/5 <step> <para>Generate a kernel config file. Include - <literal>GENERIC</literal> (or, if you are using more than - 3.5G on &i386;, <literal>PAE</literal>). + <filename>GENERIC</filename> (or, if you are using more than + 3.5G on &i386;, <filename>PAE</filename>). </para> <para> Required options:</para> @@ -1544,14 +1536,14 @@ options SEMMNU=120 options ALT_BREAK_TO_DEBUGGER</programlisting> - <para>For <literal>PAE</literal>, it is not currently possible + <para>For <filename>PAE</filename>, it is not currently possible to load modules. Therefore, if you are running an architecture that supports Linux emulation, you will need to add:</para> <programlisting> options COMPAT_LINUX options LINPROCFS</programlisting> - <para>Also for <literal>PAE</literal>, as of 20110912 you need + <para>Also for <filename>PAE</filename>, as of 20110912 you need the following. This needs to be investigated:</para> <programlisting> nooption NFSD # New Network Filesystem Server @@ -1573,9 +1565,9 @@ options NFSSERVER <para>Customize files in <filename>etc/</filename>. Whether you do this on the client itself, or another machine, will depend on whether you are using - <literal>pxeboot</literal>.</para> + <filename>pxeboot</filename>.</para> - <para>If you are using <literal>pxeboot</literal>: create + <para>If you are using <filename>pxeboot</filename>: create a subdirectory of <filename><replaceable>${DESTDIR}</replaceable></filename> called <filename>conf/</filename>. Create one subdirectory @@ -1648,7 +1640,7 @@ ganglia:*:102:102::0:0:User &:/usr/l different, machines, you will need to put those in the override directories.)</para> - <para>Recommended entries for physical nodes:<screen> + <para>Recommended entries for physical nodes:<programlisting> hostname="<replaceable>${hostname}</replaceable>" inetd_enable="YES" linux_enable="YES" @@ -1662,16 +1654,16 @@ gmond_enable="YES" squid_enable="YES" squid_chdir="<filename>/<replaceable>usr2</replaceable>/squid/logs</filename>" squid_pidfile="<filename>/<replaceable>usr2</replaceable>/squid/logs/squid.pid</filename>" -</screen> +</programlisting> </para> - <para>Required entries for VMWare-based nodes:<screen> + <para>Required entries for VMWare-based nodes:<programlisting> vmware_guest_vmmemctl_enable="YES" vmware_guest_guestd_enable="YES" -</screen> +</programlisting> </para> - <para>Recommended entries for VMWare-based nodes:<screen> + <para>Recommended entries for VMWare-based nodes:<programlisting> hostname="" ifconfig_em0="DHCP" fsck_y_enable="YES" @@ -1687,7 +1679,7 @@ gmond_enable="YES" squid_enable="YES" squid_chdir="<filename>/<replaceable>usr2</replaceable>/squid/logs</filename>" squid_pidfile="<filename>/<replaceable>usr2</replaceable>/squid/logs/squid.pid</filename>" -</screen> +</programlisting> </para> <para>&man.ntpd.8; should <emphasis>not</emphasis> @@ -1749,7 +1741,7 @@ squid_pidfile="<filename>/<replaceable>u </sect2> <sect2 id="node-ports"> - <title>Configuring <literal>ports</literal></title> + <title>Configuring <filename>ports</filename></title> <procedure> <step> @@ -1770,7 +1762,7 @@ www/squid (with SQUID_AUFS on)</screen> <para>Customize files in <filename>usr/local/etc/</filename>. Whether you do this on the client itself, or another machine, will depend on whether you are using - <literal>pxeboot</literal>.</para> + <filename>pxeboot</filename>.</para> <note> <para>The trick of using <filename>conf</filename> @@ -1809,7 +1801,7 @@ www/squid (with SQUID_AUFS on)</screen> <para>Create <filename>usr/local/etc/rc.d/portbuild.sh</filename>, using the appropriate value for - <literal>scratchdir</literal>:<screen> + <literal>scratchdir</literal>:<programlisting> #!/bin/sh # # Configure a package build system post-boot @@ -1827,7 +1819,7 @@ for i in */builds/*; do done # Flag that we are ready to accept jobs -touch /tmp/.boot_finished</screen> +touch /tmp/.boot_finished</programlisting> </para> </listitem> @@ -1908,14 +1900,14 @@ ports-<replaceable>${arch}</replaceable> <step> <para>As root:<screen> -<userinput>mkdir portbuild</userinput> -<userinput>chown ports-<replaceable>${arch}</replaceable>:ports-<replaceable>${arch}</replaceable> portbuild</userinput> -<userinput>mkdir pkgbuild</userinput> -<userinput>chown ports-<replaceable>${arch}</replaceable>:ports-<replaceable>${arch}</replaceable> pkgbuild</userinput> -<userinput>mkdir squid</userinput> -<userinput>mkdir squid/cache</userinput> -<userinput>mkdir squid/logs</userinput> -<userinput>chown -R squid:squid squid</userinput></screen> +&prompt.root; <userinput>mkdir portbuild</userinput> +&prompt.root; <userinput>chown ports-<replaceable>${arch}</replaceable>:ports-<replaceable>${arch}</replaceable> portbuild</userinput> +&prompt.root; <userinput>mkdir pkgbuild</userinput> +&prompt.root; <userinput>chown ports-<replaceable>${arch}</replaceable>:ports-<replaceable>${arch}</replaceable> pkgbuild</userinput> +&prompt.root; <userinput>mkdir squid</userinput> +&prompt.root; <userinput>mkdir squid/cache</userinput> +&prompt.root; <userinput>mkdir squid/logs</userinput> +&prompt.root; <userinput>chown -R squid:squid squid</userinput></screen> </para> </step> @@ -1988,14 +1980,14 @@ ports-<replaceable>${arch}</replaceable> of <makevar>MASTER_SITE_BACKUP</makevar> must be common to all nodes, but the first entry in <makevar>MASTER_SITE_OVERRIDE</makevar> should be the - nearest local FTP mirror. Example:<screen><command> + nearest local FTP mirror. Example:<programlisting> .if defined(FETCH_ORIGINAL) MASTER_SITE_BACKUP= .else MASTER_SITE_OVERRIDE= \ ftp://<replaceable>friendly-local-ftp-mirror</replaceable>/pub/FreeBSD/ports/distfiles/${DIST_SUBDIR}/ \ ftp://${BACKUP_FTP_SITE}/pub/FreeBSD/distfiles/${DIST_SUBDIR}/ -.endif</command></screen> +.endif</programlisting> </para> </listitem> <listitem> @@ -2018,7 +2010,7 @@ MASTER_SITE_OVERRIDE= \ file contains overrides to <filename>/var/portbuild/<replaceable>${arch}</replaceable>/portbuild.conf</filename>.</para> - <para>Suggested values:<screen> + <para>Suggested values:<programlisting> disconnected=1 http_proxy="http://localhost:3128/" squid_dir=<filename>/<replaceable>usr2</replaceable>/squid</filename> @@ -2028,16 +2020,16 @@ sudo_cmd="sudo -H" rsync_gzip=-z infoseek_host=localhost -infoseek_port=<replaceable>${tunelled-tcp-port}</replaceable></screen> +infoseek_port=<replaceable>${tunelled-tcp-port}</replaceable></programlisting> </para> - <para>Possible other values:<screen> + <para>Possible other values:<programlisting> use_md_swap=1 md_size=9g use_zfs=1 scp_cmd="/usr/local/bin/scp" ssh_cmd="/usr/local/bin/ssh" -</screen> +</programlisting> </para> </step> </procedure> @@ -2056,9 +2048,8 @@ ssh_cmd="/usr/local/bin/ssh" <step> <para>Add an appropriate <literal>data_source</literal> entry to <filename>/usr/local/etc/gmetad.conf</filename>:</para> - <para> - <literal>data_source "<replaceable>arch</replaceable>/<replaceable>location</replaceable> Package Build Cluster" 30 <replaceable>hostname</replaceable></literal> - </para> + + <programlisting>data_source "<replaceable>arch</replaceable>/<replaceable>location</replaceable> Package Build Cluster" 30 <replaceable>hostname</replaceable></programlisting> <para>You will need to restart <filename>gmetad</filename>. </para> @@ -2078,7 +2069,7 @@ ssh_cmd="/usr/local/bin/ssh" <step> <para>Ensure that <literal>ssh</literal> to the client is working by executing - <command>ssh <replaceable>hostname</replaceable> uname -a</command>. + <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 @@ -2089,14 +2080,14 @@ ssh_cmd="/usr/local/bin/ssh" <step> <para>Populate the client's copy of <filename>/var/portbuild/scripts/</filename> by something like - <command>/var/portbuild/scripts/dosetupnode <replaceable>arch</replaceable> <replaceable>major</replaceable> latest <replaceable>hostname</replaceable></command>. + <userinput>/var/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 - <command>telnet <replaceable>hostname</replaceable> <replaceable>portnumber</replaceable></command>. + <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 @@ -2114,7 +2105,7 @@ ssh_cmd="/usr/local/bin/ssh" <para>Tell <filename>qmanager</filename> about the node. Example: </para> - <para><command>python <replaceable>path</replaceable>/qmanager/qclient add + <para><userinput>python <replaceable>path</replaceable>/qmanager/qclient add name=<replaceable>uniquename</replaceable> arch=<replaceable>arch</replaceable> osversion=<replaceable>osversion</replaceable> @@ -2125,7 +2116,7 @@ ssh_cmd="/usr/local/bin/ssh" primarypool=package pools="package all" maxjobs=1 acl="ports-<replaceable>arch</replaceable>,deny_all" - </command></para> + </userinput></para> </step> </procedure> @@ -2382,15 +2373,15 @@ dopackages</command> without <literal>-n <listitem> <para>Create a new <application>zfs</application> filesystem: - <screen>zfs create -o mountpoint=/a/portbuild/<replaceable>arch</replaceable> a/portbuild/<replaceable>arch</replaceable></screen> + <screen>&prompt.root; zfs create -o mountpoint=/a/portbuild/<replaceable>arch</replaceable> a/portbuild/<replaceable>arch</replaceable></screen> </para> </listitem> <listitem> <screen> -chown ports-<replaceable>arch</replaceable>:portbuild /var/portbuild/<replaceable>arch</replaceable>; -chmod 775 /var/portbuild/<replaceable>arch</replaceable>; -cd /var/portbuild/<replaceable>arch</replaceable></screen> +&prompt.root; chown ports-<replaceable>arch</replaceable>:portbuild /var/portbuild/<replaceable>arch</replaceable>; +&prompt.root; chmod 775 /var/portbuild/<replaceable>arch</replaceable>; +&prompt.root; cd /var/portbuild/<replaceable>arch</replaceable></screen> </listitem> <listitem> @@ -2416,7 +2407,7 @@ cd /var/portbuild/<replaceable>arch</rep <itemizedlist> <listitem> <para>Kick-start the build for the branch with - <screen>build create <replaceable>arch</replaceable> <replaceable>branch</replaceable></screen></para> + <screen>&prompt.root; build create <replaceable>arch</replaceable> <replaceable>branch</replaceable></screen></para> </listitem> </itemizedlist> @@ -2432,8 +2423,8 @@ cd /var/portbuild/<replaceable>arch</rep <example> <title>Creating and linking an external archive directory</title> - <screen>mkdir /dumpster/pointyhat/<replaceable>arch</replaceable>/archive</screen> - <screen>ln -s /dumpster/pointyhat/<replaceable>arch</replaceable>/archive archive</screen> + <screen>&prompt.root; mkdir /dumpster/pointyhat/<replaceable>arch</replaceable>/archive +&prompt.root; ln -s /dumpster/pointyhat/<replaceable>arch</replaceable>/archive archive</screen> </example> <note> @@ -2465,7 +2456,7 @@ cd /var/portbuild/<replaceable>arch</rep </listitem> <listitem> - <para><screen>cd .ssh && ssh-keygen</screen></para> + <screen>&prompt.root; cd .ssh && ssh-keygen</screen> </listitem> <listitem> @@ -2479,9 +2470,9 @@ cd /var/portbuild/<replaceable>arch</rep <procedure> <step> - <para>Make a private configuration directory: - <screen>mkdir /var/portbuild/conf/<replaceable>arch</replaceable></screen> - </para> + <para>Make a private configuration directory:</para> + + <screen>&prompt.root; mkdir /var/portbuild/conf/<replaceable>arch</replaceable></screen> </step> <step> @@ -2585,13 +2576,13 @@ cd /var/portbuild/<replaceable>arch</rep <step> <para>Export that value for a later initialization step: - <programlisting>&prompt.root; export PORTBUILD_USER=<replaceable>portbuild</replaceable></programlisting> + <screen>&prompt.root; export PORTBUILD_USER=<replaceable>portbuild</replaceable></screen> </para> </step> <step> - <para>Add the following to <filename>/boot/loader.conf</filename>:<screen> -console="vidconsole,comconsole"</screen> + <para>Add the following to <filename>/boot/loader.conf</filename>:<programlisting> +console="vidconsole,comconsole"</programlisting> </para> </step> *** DIFF OUTPUT TRUNCATED AT 1000 LINES ***
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201212240902.qBO92pi2073255>