summaryrefslogtreecommitdiff
path: root/doc/guide
diff options
context:
space:
mode:
authorrillig <rillig@pkgsrc.org>2016-07-10 07:43:23 +0000
committerrillig <rillig@pkgsrc.org>2016-07-10 07:43:23 +0000
commitc487fed58e4277a2609b3668e31273ae69566ea1 (patch)
treee039c945930b620c4a0611e56e67c6888b88c76f /doc/guide
parent1f196ce2b1b153828fb4fa61e2e535c7a0fb6e34 (diff)
downloadpkgsrc-c487fed58e4277a2609b3668e31273ae69566ea1.tar.gz
Wording cleanup.
Diffstat (limited to 'doc/guide')
-rw-r--r--doc/guide/files/binary.xml10
-rw-r--r--doc/guide/files/bulk.xml26
-rw-r--r--doc/guide/files/configuring.xml16
3 files changed, 22 insertions, 30 deletions
diff --git a/doc/guide/files/binary.xml b/doc/guide/files/binary.xml
index 9859357649c..cff651bc4a2 100644
--- a/doc/guide/files/binary.xml
+++ b/doc/guide/files/binary.xml
@@ -1,4 +1,4 @@
-<!-- $NetBSD: binary.xml,v 1.34 2007/09/18 08:17:21 rillig Exp $ -->
+<!-- $NetBSD: binary.xml,v 1.35 2016/07/10 07:43:23 rillig Exp $ -->
<chapter id="binary">
<title>Creating binary packages</title>
@@ -17,10 +17,10 @@
directory in pkgsrc, and run <command>make
package</command>:</para>
- <screen>
-&rprompt; <userinput>cd misc/figlet</userinput>
-&rprompt; <userinput>make package</userinput>
- </screen>
+<screen>
+&uprompt; <userinput>cd misc/figlet</userinput>
+&uprompt; <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
diff --git a/doc/guide/files/bulk.xml b/doc/guide/files/bulk.xml
index 0bced7fa2a6..4efe0962e70 100644
--- a/doc/guide/files/bulk.xml
+++ b/doc/guide/files/bulk.xml
@@ -1,4 +1,4 @@
-<!-- $NetBSD: bulk.xml,v 1.21 2014/07/27 08:28:28 wiz Exp $ -->
+<!-- $NetBSD: bulk.xml,v 1.22 2016/07/10 07:43:23 rillig Exp $ -->
<chapter id="bulk">
<title>Creating binary packages for everything in pkgsrc (bulk
@@ -11,9 +11,8 @@ it is wasted time if they all build their packages themselves from source.
Or you may want to build a list of packages you want and check them before
deploying onto production system.
There is a way of getting a set of binary packages:
-The bulk build system, or pbulk ("p" stands for "parallel).
-This chapter describes how to set it up so that the packages
-are most likely to be usable later.</para>
+The bulk build system, or pbulk ("p" stands for "parallel").
+This chapter describes how to set it up.</para>
<sect1 id="bulk.pre">
<title>Preparations</title>
@@ -25,13 +24,13 @@ There exists a number of particularly heavy packages that are not actually
interesting to a wide audience.
<!-- approximate resource consumption for full bulk build is given in section <put a reference here/> -->
For a limited bulk builds you need to make a list of packages you want to build.
-Note, that all their dependencies will be built, so you don't need to track them manually.
+Note that all their dependencies will be built, so you don't need to track them manually.
</para>
<para>During bulk builds various packages are installed and deinstalled
in <filename>/usr/pkg</filename> (or whatever <filename>LOCALBASE</filename> is),
so make sure that you don't need any package during the builds.
-Essentially, you should provide fresh system, either a chroot environment
+Essentially, you should provide a fresh system, either a chroot environment
or something even more restrictive, depending on what the operating system provides,
or dedicate the whole physical machine.
As a useful side effect this makes sure that bulk builds cannot
@@ -87,11 +86,11 @@ unprivileged user doesn't work well at the moment.</para></listitem>
<sect2 id="bulk.pbulk.conf">
<title>Configuration</title>
-<para>To simplify configuration we provide helper script <filename>mk/pbulk/pbulk.sh</filename>.</para>
+<para>To simplify configuration, we provide the helper script <filename>mk/pbulk/pbulk.sh</filename>.</para>
<para>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
Configure network access to fetch distribution files.
-Create user with name "pbulk".</para>
+Create a user with name "pbulk".</para>
<para>Fetch and extract pkgsrc. Use a command like one of these:</para>
@@ -116,23 +115,22 @@ Create user with name "pbulk".</para>
apply to packages you build. For instance,</para>
<programlisting>
-PKG_DEVELOPER= yes # perform more checks
-X11_TYPE= modular # use pkgsrc X11
-SKIP_LICENSE_CHECK= yes # accept all licences (useful when building all packages)
+PKG_DEVELOPER= yes # perform more checks
+X11_TYPE= modular # use pkgsrc X11
+SKIP_LICENSE_CHECK= yes # accept all licences (useful
+ # when building all packages)
</programlisting>
</note>
<!-- Think how to merge this or maintain short reference of useful settings.
<itemizedlist>
-<listitem><para><literal><varname>PKG_DEVELOPER</varname>=yes</literal>, to enable many consistency checks,</para></listitem>
<listitem><para><literal><varname>WRKOBJDIR</varname>=/tmp/pbulk-outer</literal>, to keep <filename>/usr/pkgsrc</filename> free from any modifications,</para></listitem>
<listitem><para><literal><varname>DISTDIR</varname>=/distfiles</literal>, to have only one directory in which all distfiles (for the infrastructure and for the actual packages) are downloaded,</para></listitem>
<listitem><para><literal><varname>ACCEPTABLE_LICENSES</varname>+=...</literal>, to select some licenses additional to the usual Free/Open Source licenses that are acceptable to you,</para></listitem>
-<listitem><para><literal><varname>SKIP_LICENSE_CHECK</varname>=yes</literal>, to bypass the license checks.</para></listitem>
</itemizedlist>
-->
<para>If configured for limited list, replace the list in <filename>/usr/pbulk/etc/pbulk.list</filename>
-with your list of packages one per line without empty lines or comments. E.g.:</para>
+with your list of packages, one per line without empty lines or comments. E.g.:</para>
<programlisting>
www/firefox
diff --git a/doc/guide/files/configuring.xml b/doc/guide/files/configuring.xml
index 129ccf57c38..6bec5880901 100644
--- a/doc/guide/files/configuring.xml
+++ b/doc/guide/files/configuring.xml
@@ -1,4 +1,4 @@
-<!-- $NetBSD: configuring.xml,v 1.49 2016/06/11 14:58:26 rillig Exp $ -->
+<!-- $NetBSD: configuring.xml,v 1.50 2016/07/10 07:43:23 rillig Exp $ -->
<chapter id="configuring">
<title>Configuring pkgsrc</title>
@@ -13,22 +13,16 @@ that file depends on the installation. On NetBSD, when you use
<literal>${PREFIX}/etc/</literal>, depending on where you told the
bootstrap program to install the binary packages.</para>
-<para>During the bootstrap, an example configuration file is created. To
-use that, you have to create the directory
-<filename>${PREFIX}/etc</filename> and copy the example file
-there.</para>
-
<para>The format of the configuration file is that of the usual
BSD-style <filename>Makefile</filename>s. The whole pkgsrc configuration
is done by setting variables in this file. Note that you can define all
kinds of variables, and no special error checking (for example for
-spelling mistakes) takes place, so you have to try it out to see if it
-works.</para>
+spelling mistakes) takes place.</para>
<sect1 id="general-configuration">
<title>General configuration</title>
- <para>In this section, you can find some variables that apply to all
+ <para>The following variables apply to all
pkgsrc packages. A complete list of the variables that can be
configured by the user is available in
<filename>mk/defaults/mk.conf</filename>, together with some
@@ -366,8 +360,8 @@ LDFLAGS+= -your -linkerflags
(normal, default, quiet operation); the value 1 will display
all shell commands before their invocation, and the value 2
will display both the shell commands before their invocation,
- and their actual execution progress with <command>set
- -x</command> will be displayed.</para></listitem>
+ as well as their actual execution progress with <command>set
+ -x</command>.</para></listitem>
</itemizedlist>
</para>
</sect1>