pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/doc/guide/files No whitespace directly after to <para>.
details: https://anonhg.NetBSD.org/pkgsrc/rev/99a9b03d15d7
branches: trunk
changeset: 518439:99a9b03d15d7
user: wiz <wiz%pkgsrc.org@localhost>
date: Sat Sep 09 23:40:40 2006 +0000
description:
No whitespace directly after to <para>.
diffstat:
doc/guide/files/binary.xml | 648 ++++++++++++++++++++------------------------
1 files changed, 290 insertions(+), 358 deletions(-)
diffs (truncated from 913 to 300 lines):
diff -r a4d74187fb8e -r 99a9b03d15d7 doc/guide/files/binary.xml
--- a/doc/guide/files/binary.xml Sat Sep 09 23:21:55 2006 +0000
+++ b/doc/guide/files/binary.xml Sat Sep 09 23:40:40 2006 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: binary.xml,v 1.24 2006/03/12 11:34:09 rillig Exp $ -->
+<!-- $NetBSD: binary.xml,v 1.25 2006/09/09 23:40:40 wiz Exp $ -->
<chapter id="binary">
<title>Creating binary packages</title>
@@ -6,37 +6,31 @@
<sect1 id="building-a-single-binary-package">
<title>Building a single binary package</title>
- <para>
- Once you have built and installed a package, you can create a
- <emphasis>binary package</emphasis> which can be installed on
- another system with &man.pkg.add.1;. This saves having to build
- the same package on a group of hosts and wasting CPU time. It
- also provides a simple means for others to install your package,
- should you distribute it.
- </para>
+ <para>Once you have built and installed a package, you can create
+ a <emphasis>binary package</emphasis> which can be installed on
+ another system with &man.pkg.add.1;. This saves having to build
+ the same package on a group of hosts and wasting CPU time. It also
+ provides a simple means for others to install your package, should
+ you distribute it.</para>
- <para>
- To create a binary package, change into the appropriate
- directory in pkgsrc, and run <command>make
- package</command>:
- </para>
+ <para>To create a binary package, change into the appropriate
+ directory in pkgsrc, and run <command>make
+ package</command>:</para>
<screen>&rprompt; <userinput>cd misc/figlet</userinput>
-&rprompt; <userinput>make package</userinput></screen>
+ &rprompt; <userinput>make package</userinput></screen>
- <para>
- This will build and install your package (if not already done),
- and then build a binary package from what was installed. You can
- then use the <command>pkg_*</command> tools to manipulate
- it. Binary packages are created by default in
- <filename>/usr/pkgsrc/packages</filename>, in the form of a
- gzipped tar file. See <xref linkend="logs.package"/> for a
- continuation of the above <filename
- role="pkg">misc/figlet</filename> example.</para>
+ <para>This will build and install your package (if not already done),
+ and then build a binary package from what was installed. You can
+ then use the <command>pkg_*</command> tools to manipulate
+ it. Binary packages are created by default in
+ <filename>/usr/pkgsrc/packages</filename>, in the form of a
+ gzipped tar file. See <xref linkend="logs.package"/> for a
+ continuation of the above <filename
+ role="pkg">misc/figlet</filename> example.</para>
- <para>
- See <xref linkend="submit"/> for information on how to submit
- such a binary package.</para>
+ <para>See <xref linkend="submit"/> for information on how to submit
+ such a binary package.</para>
</sect1>
<sect1 id="settings-for-creationg-of-binary-packages">
@@ -49,17 +43,17 @@
<title>Doing a bulk build of all packages</title>
<para>If you want to get a full set of precompiled binary
- packages, this section describes how to get them. Beware that
- the bulk build will remove all currently installed packages from
- your system!</para>
+ packages, this section describes how to get them. Beware that
+ the bulk build will remove all currently installed packages from
+ your system!</para>
- <para>Having an FTP server configured either on the
- machine doing the bulk builds or on a nearby NFS server can help
- to make the packages available to other machines that can then
- save time by installing only the binary packages. See &man.ftpd.8; for
- more information. If you use a remote NFS server's storage, be
- sure to not actually compile on NFS storage, as this slows
- things down a lot.</para>
+ <para>Having an FTP server configured either on the
+ machine doing the bulk builds or on a nearby NFS server can help
+ to make the packages available to other machines that can then
+ save time by installing only the binary packages. See &man.ftpd.8; for
+ more information. If you use a remote NFS server's storage, be
+ sure to not actually compile on NFS storage, as this slows
+ things down a lot.</para>
<sect2 id="binary.configuration">
<title>Configuration</title>
@@ -67,38 +61,38 @@
<sect3 id="binary.bulk.build.conf">
<title><filename>build.conf</filename></title>
- <para>The <filename>build.conf</filename> file is the main
- configuration file for bulk builds. You can configure how your
- copy of pkgsrc is kept up to date, how the distfiles are
- downloaded, how the packages are built and how the report is
- generated. You can find an annotated example file in
- <filename>pkgsrc/mk/bulk/build.conf-example</filename>. To use
- it, copy <filename>build.conf-example</filename> to
- <filename>build.conf</filename> and edit it, following the
- comments in that file.</para>
+ <para>The <filename>build.conf</filename> file is the main
+ configuration file for bulk builds. You can configure how your
+ copy of pkgsrc is kept up to date, how the distfiles are
+ downloaded, how the packages are built and how the report is
+ generated. You can find an annotated example file in
+ <filename>pkgsrc/mk/bulk/build.conf-example</filename>. To use
+ it, copy <filename>build.conf-example</filename> to
+ <filename>build.conf</filename> and edit it, following the
+ comments in that file.</para>
</sect3>
<sect3 id="binary.mk.conf">
<title>/etc/mk.conf</title>
<para>You may want to set variables in
- <filename>/etc/mk.conf</filename>.
- Look at <filename>pkgsrc/mk/defaults/mk.conf</filename> for
- details of the default settings. You will want to ensure that
- <varname>ACCEPTABLE_LICENSES</varname> meet your local policy.
- As used in this example, <varname>_ACCEPTABLE=yes</varname>
- accepts <emphasis>all</emphasis> licenses.</para>
+ <filename>/etc/mk.conf</filename>.
+ Look at <filename>pkgsrc/mk/defaults/mk.conf</filename> for
+ details of the default settings. You will want to ensure that
+ <varname>ACCEPTABLE_LICENSES</varname> meet your local policy.
+ As used in this example, <varname>_ACCEPTABLE=yes</varname>
+ accepts <emphasis>all</emphasis> licenses.</para>
-<programlisting>
- PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
- WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
- BSDSRCDIR= /usr/src
- BSDXSRCDIR= /usr/xsrc # for x11/xservers
- OBJHOSTNAME?= yes # use work.`hostname`
- FAILOVER_FETCH= yes # insist on the correct checksum
- PKG_DEVELOPER?= yes
- _ACCEPTABLE= yes
-</programlisting>
+ <programlisting>
+ PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
+ WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
+ BSDSRCDIR= /usr/src
+ BSDXSRCDIR= /usr/xsrc # for x11/xservers
+ OBJHOSTNAME?= yes # use work.`hostname`
+ FAILOVER_FETCH= yes # insist on the correct checksum
+ PKG_DEVELOPER?= yes
+ _ACCEPTABLE= yes
+ </programlisting>
<para>Some options that are especially useful for bulk builds
can be found at the top lines of the file
@@ -107,19 +101,19 @@
<itemizedlist>
- <listitem><para>If you are on a slow machine, you may want to
- set <varname>USE_BULK_BROKEN_CHECK</varname> to
- <quote>no</quote>.</para></listitem>
+ <listitem><para>If you are on a slow machine, you may want to
+ set <varname>USE_BULK_BROKEN_CHECK</varname> to
+ <quote>no</quote>.</para></listitem>
- <listitem><para>If you are doing bulk builds from a read-only
- copy of pkgsrc, you have to set <varname>BULKFILESDIR</varname>
- to the directory where all log files are created. Otherwise the
- log files are created in the pkgsrc directory.</para></listitem>
+ <listitem><para>If you are doing bulk builds from a read-only
+ copy of pkgsrc, you have to set <varname>BULKFILESDIR</varname>
+ to the directory where all log files are created. Otherwise the
+ log files are created in the pkgsrc directory.</para></listitem>
- <listitem><para>Another important variable is
- <varname>BULK_PREREQ</varname>, which is a list of packages that
- should be always available while building other
- packages.</para></listitem>
+ <listitem><para>Another important variable is
+ <varname>BULK_PREREQ</varname>, which is a list of packages that
+ should be always available while building other
+ packages.</para></listitem>
</itemizedlist>
@@ -128,25 +122,25 @@
<itemizedlist>
- <listitem><para><varname>ALLOW_VULNERABLE_PACKAGES</varname>
- should be set to <literal>yes</literal>. The purpose of the bulk
- builds is creating binary packages, no matter if they are
- vulnerable or not. When uploading the packages to a public
- server, the vulnerable packages will be put into a directory of
- their own. Leaving this variable unset would prevent the bulk
- build system from even trying to build them, so possible
- building errors would not show up.</para></listitem>
+ <listitem><para><varname>ALLOW_VULNERABLE_PACKAGES</varname>
+ should be set to <literal>yes</literal>. The purpose of the bulk
+ builds is creating binary packages, no matter if they are
+ vulnerable or not. When uploading the packages to a public
+ server, the vulnerable packages will be put into a directory of
+ their own. Leaving this variable unset would prevent the bulk
+ build system from even trying to build them, so possible
+ building errors would not show up.</para></listitem>
- <listitem><para><varname>CHECK_FILES</varname>
- (<filename>pkgsrc/mk/bsd.pkg.check.mk</filename>) can be set to
- <quote>yes</quote> to check that the installed set of files
- matches the <filename>PLIST</filename>.</para></listitem>
+ <listitem><para><varname>CHECK_FILES</varname>
+ (<filename>pkgsrc/mk/bsd.pkg.check.mk</filename>) can be set to
+ <quote>yes</quote> to check that the installed set of files
+ matches the <filename>PLIST</filename>.</para></listitem>
- <listitem><para><varname>CHECK_INTERPRETER</varname>
- (<filename>pkgsrc/mk/bsd.pkg.check.mk</filename>) can be set to
- <quote>yes</quote> to check that the installed
- <quote>#!</quote>-scripts will find their
- interpreter.</para></listitem>
+ <listitem><para><varname>CHECK_INTERPRETER</varname>
+ (<filename>pkgsrc/mk/bsd.pkg.check.mk</filename>) can be set to
+ <quote>yes</quote> to check that the installed
+ <quote>#!</quote>-scripts will find their
+ interpreter.</para></listitem>
</itemizedlist>
@@ -156,19 +150,19 @@
<title><filename>pre-build.local</filename></title>
<para>It is possible to configure the bulk build to perform
- certain site-specific tasks at the end of the pre-build
- stage. If the file
- <filename>pre-build.local</filename> exists in
- <filename>/usr/pkgsrc/mk/bulk</filename>, it will be executed
- (as a &man.sh.1; script) at the end of the usual pre-build
- stage. An example use of
- <filename>pre-build.local</filename> is to have the line:</para>
+ certain site-specific tasks at the end of the pre-build
+ stage. If the file
+ <filename>pre-build.local</filename> exists in
+ <filename>/usr/pkgsrc/mk/bulk</filename>, it will be executed
+ (as a &man.sh.1; script) at the end of the usual pre-build
+ stage. An example use of
+ <filename>pre-build.local</filename> is to have the line:</para>
<screen>echo "I do not have enough disk space to build this pig." \
- > misc/openoffice/$BROKENF</screen>
+ > misc/openoffice/$BROKENF</screen>
<para>to prevent the system from trying to build a particular package
- which requires nearly 3 GB of disk space.</para>
+ which requires nearly 3 GB of disk space.</para>
</sect3>
</sect2>
@@ -176,61 +170,58 @@
<title>Other environmental considerations</title>
<para>As <filename>/usr/pkg</filename> will be completely
- deleted at the start of bulk builds, make sure your login
- shell is placed somewhere else. Either drop it into
- <filename>/usr/local/bin</filename> (and adjust your login
- shell in the passwd file), or (re-)install it via
- &man.pkg.add.1; from <filename>/etc/rc.local</filename>, so
- you can login after a reboot (remember that your current
- process won't die if the package is removed, you just can't
- start any new instances of the shell any more). Also, if you
- use &os; earlier than 1.5, or you still want to use the pkgsrc
- version of ssh for some reason, be sure to install ssh before
- starting it from <filename>rc.local</filename>:</para>
+ deleted at the start of bulk builds, make sure your login
+ shell is placed somewhere else. Either drop it into
+ <filename>/usr/local/bin</filename> (and adjust your login
+ shell in the passwd file), or (re-)install it via
+ &man.pkg.add.1; from <filename>/etc/rc.local</filename>, so
+ you can login after a reboot (remember that your current
+ process won't die if the package is removed, you just can't
+ start any new instances of the shell any more). Also, if you
+ use &os; earlier than 1.5, or you still want to use the pkgsrc
+ version of ssh for some reason, be sure to install ssh before
+ starting it from <filename>rc.local</filename>:</para>
-<programlisting>
- ( cd /usr/pkgsrc/security/ssh ; make bulk-install )
- if [ -f /usr/pkg/etc/rc.d/sshd ]; then
- /usr/pkg/etc/rc.d/sshd
- fi
-</programlisting>
+ <programlisting>
+ ( cd /usr/pkgsrc/security/ssh ; make bulk-install )
+ if [ -f /usr/pkg/etc/rc.d/sshd ]; then
+ /usr/pkg/etc/rc.d/sshd
+ fi
Home |
Main Index |
Thread Index |
Old Index