[pbuilder] 01/01: Fix errors in the user's manual
Matt Kraai
kraai at moszumanska.debian.org
Mon Jul 17 13:09:17 UTC 2017
This is an automated email from the git hooks/post-receive script.
kraai pushed a commit to branch master
in repository pbuilder.
commit 8b082f13f2ff8296c3b0eb695e56dda5fdbc5649
Author: Paul Hardy <unifoundry at unifoundry.com>
Date: Mon Jul 17 06:07:35 2017 -0700
Fix errors in the user's manual
---
Documentation/pbuilder-doc.xml | 261 ++++++++++++++++++++---------------------
1 file changed, 130 insertions(+), 131 deletions(-)
diff --git a/Documentation/pbuilder-doc.xml b/Documentation/pbuilder-doc.xml
index 6a76bc3..0787b69 100644
--- a/Documentation/pbuilder-doc.xml
+++ b/Documentation/pbuilder-doc.xml
@@ -8,7 +8,7 @@
<title>pbuilder User's Manual</title>
<abbrev>pbuilder-doc</abbrev>
<subtitle>Usage and operations</subtitle>
- <releaseinfo>This documentation is work in progress, it might be incomplete and outdated</releaseinfo>
+ <releaseinfo>This documentation is a work in progress; it might be incomplete and outdated.</releaseinfo>
<authorgroup>
<author>
<firstname>Junichi</firstname>
@@ -27,7 +27,7 @@
Personal Builder, and it is an automatic Debian Package Building system
for personal development workstation environments.
<command>pbuilder</command> aims to be an
- easy-to-setup system
+ easy-to-set-up system
for auto-building Debian packages inside a clean-room
environment, so that it is possible to verify that
a package can be built on most Debian installations.
@@ -63,7 +63,7 @@
The goal of making Debian buildable from source is somewhat
accomplished, and has seen good progress. In the past age of
Debian 3.0, there were many problems when building from
- source. More recent versions of Debian is much better.
+ source. More recent versions of Debian are much better.
</para>
</sect1>
</chapter>
@@ -81,7 +81,7 @@
<para>
<command>pbuilder create</command>
will create a base chroot image tar-ball (base.tgz).
- All other commands will operate on the resulting base.tgz
+ All other commands will operate on the resulting base.tgz.
If the Debian release to be created within chroot is not going
to be "sid" (which is the default), the distribution code-name
@@ -96,12 +96,12 @@
is used to create
the bare minimum Debian installation,
and then build-essential packages are installed on top
- of the minimum installation using <command>apt-get</command>
+ of the minimum installation using the <command>apt-get</command>
inside the chroot.
</para>
<para>
- For fuller documentation of command-line options, see
- the pbuilder.8 manual page.
+ For more thorough documentation of command-line options, see
+ the pbuilder(8) manual page.
Some configuration will be required for <filename>/etc/pbuilderrc</filename>
for the mirror site
<footnote>
@@ -115,7 +115,7 @@
</footnote>
to use, and proxy configuration may be required to allow access
through HTTP.
- See the pbuilderrc.5 manual page for details.
+ See the pbuilderrc(5) manual page for details.
</para>
</sect1>
<sect1 id="basechroot">
@@ -127,7 +127,7 @@
chroot, and then recreate the base.tgz (the base tar-ball).
</para>
<para>
- It is possible to switch the distribution which the
+ It is possible to switch the distribution for which the
base.tgz is targeted at at this point.
Specify <command><option>--distribution <parameter>sid</parameter></option> <option>--override-config</option></command> to change the distribution
to sid.
@@ -137,8 +137,8 @@
</footnote>
</para>
<para>
- For fuller documentation of command-line options, see
- the pbuilder.8 manual page
+ For more thorough documentation of command-line options, see
+ the pbuilder(8) manual page.
</para>
</sect1>
<sect1 id="buildpackagechroot">
@@ -162,26 +162,26 @@
</para>
<para>
<command>pbuilder</command> will extract a fresh base chroot
- image from base.tgz. (base.tgz is created with
- <command>pbuilder create</command>, and updated with
+ image from base.tgz. (base.tgz is created with the
+ <command>pbuilder create</command>, and updated with the
<command>pbuilder update</command>). The chroot is populated
with build-dependencies by parsing debian/control and invoking
<command>apt-get</command>.
</para>
<para>
- For fuller documentation of command-line options, see
- the pbuilder.8 manual page
+ For more thorough documentation of command-line options, see
+ the pbuilder(8) manual page
</para>
</sect1>
<sect1 id="pdebuild">
- <title>Facilitating Debian Developers' typing, pdebuild</title>
+ <title>Facilitating Debian Developers' typing: pdebuild</title>
<para>
<command>pdebuild</command> is a little wrapper
script that does the most frequent of all tasks.
- A Debian Developer may try to do <command>debuild</command>, and
- build a package, inside a Debian source directory.
+ A Debian Developer may try to run <command>debuild</command>, and
+ build a package inside a Debian source directory.
<command>pdebuild</command> will allow similar
- control, and allow package to be built inside the chroot,
+ control, and allow the package to be built inside the chroot,
to check that the current source tree will build happily
inside the chroot.
</para>
@@ -194,7 +194,7 @@
directory.
</para>
<para>
- See the pdebuild.1 manual page for more details.
+ See the pdebuild(1) manual page for more details.
</para>
<para>
There is a slightly different mode of operation available
@@ -211,7 +211,7 @@
<itemizedlist>
<listitem>
<para>
- Satisfies build-dependency inside the chroot before creating source package.
+ Satisfies build-dependency inside the chroot before creating source package
(which is a good point that default <command>pdebuild</command> could not do).
</para>
</listitem>
@@ -234,7 +234,7 @@
does not have any effect.</para>
</listitem>
<listitem>
- <para>The build inside chroot is ran with the current user outside chroot.
+ <para>The build inside chroot is run with the current user outside chroot.
</para>
</listitem>
</itemizedlist>
@@ -251,16 +251,16 @@
<filename>${HOME}/.pbuilderrc</filename>
are read in when <command>pbuilder</command> is invoked.
The possible options are documented in
- the pbuilderrc.5 manual page.
+ the pbuilderrc(5) manual page.
</para>
<para>
- It is useful to use <option>--configfile</option> option to load up a preset
+ It is useful to use the <option>--configfile</option> option to load up a preset
configuration file when switching between configuration files for
different distributions.
</para>
<para>
- Please note <filename>${HOME}/.pbuilderrc</filename> supersede
- system settings. Caveats is that if you have some
+ Please note that <filename>${HOME}/.pbuilderrc</filename> supersedes
+ system settings. A caveat is that if you have some
configuration, you may need to tweak the configuration to work
with new versions of pbuilder when upgrading.
</para>
@@ -270,18 +270,18 @@
<para>
<command>pbuilder</command> requires full root privilege
when it is satisfying the build-dependencies, but most packages do not
- need root privilege to build, or even refused to build when they are built as root.
+ need root privilege to build, or even refuse to build when they are built as root.
<command>pbuilder</command> can create a user which is only used
inside <command>pbuilder</command> and use that user id when
building, and use the <command>fakeroot</command> command
when root privilege is required.
</para>
<para>
- BUILDUSERID configuration option should be set to a value for a user id that
+ The BUILDUSERID configuration option should be set to a value for a user id that
does not already exist on the system, so that it is more difficult for
packages that are being built with
<command>pbuilder</command> to affect the environment outside the chroot.
- When BUILDUSERNAME configuration option is also set,
+ When the BUILDUSERNAME configuration option is also set,
<command>pbuilder</command> will use the specified user name and fakeroot for building packages,
instead of running as root inside chroot.
</para>
@@ -347,7 +347,7 @@
<listitem>
<para>When a library package breaks, or gcc/gcj/g++ breaks,
or even bison, a large number of build failures are reported.
- (gcj-3.0 which had no "javac", bison which got more strict, etc.)
+ (gcj-3.0 had no "javac", bison got more strict, etc.)
</para>
</listitem>
<listitem>
@@ -379,7 +379,7 @@
</listitem>
<listitem>
<para>It will try building anything, even packages
- which are not aimed for your architecture.</para>
+ that are not intended for your architecture.</para>
</listitem>
<listitem>
<para>Because you are running random build scripts, it is better to use
@@ -393,7 +393,7 @@
</listitem>
<listitem>
<para>
- Some packages require a lot of disk space,
+ Some packages require a lot of disk space;
around 2GB seems to be sufficient for the largest packages for the time being.
If you find otherwise, please inform the maintainer of this documentation.
</para>
@@ -407,9 +407,9 @@
a subset of packages to the stable distribution.
</para>
<para>
- I would like some information on how people are doing it,
+ I would like some information on how people are doing it.
I would appreciate any feedback or information on
- how you are doing, or any examples.
+ how you are doing it, or any examples.
</para>
</sect1>
<sect1 id="autotesting">
@@ -435,29 +435,29 @@
<para>Automatic debian-test of the package?
The debian-test package has been removed from Debian.
A <command>pbuilder</command> implementation can be found as
- debian/pbuilder-test directory, implemented through B92test-pkg script.</para>
+ debian/pbuilder-test directory, implemented through the B92test-pkg script.</para>
</listitem>
</itemizedlist>
<para>
- To use B92test-pkg script, first, add it to your hook directory.
+ To use the B92test-pkg script, first, add it to your hook directory.
<footnote>
- <para>It is possible to specify <command>--hookdir
+ <para>It is possible to specify a <command>--hookdir
/usr/share/doc/pbuilder/examples</command> command-line
option to include all example hooks as
well.</para></footnote>.
The test files are shell scripts
placed in
<filename>debian/pbuilder-test/NN_name</filename> (where
- NN is a number) following run-parts standard<footnote>
+ NN is a number) following the run-parts standard<footnote>
<para> See run-parts(8). For example, no '.' in file
names!
</para>
</footnote>
for file names. After a successful build, packages are first
- tested for installation and removal, and then each test is ran
+ tested for installation and removal, and then each test is run
inside the chroot. The current directory is the top directory
of the source-code. This means you can expect to be able to
- use ./debian/ directory from inside your scripts.
+ use the ./debian/ directory from inside your scripts.
</para>
<para>
Example scripts for use with pbuilder-test can be found in
@@ -469,7 +469,7 @@
<para>
Most packages are compiled with <command>gcc</command>
or <command>g++</command>
- and using the default compiler version, which was gcc 2.95 for Debian GNU/Linux 3.0 (i386).
+ and use the default compiler version, which was gcc 2.95 for Debian GNU/Linux 3.0 (i386).
However, Debian 3.0 was distributed with other compilers, under package names
such as <command>gcc-3.2</command> for gcc compiler
version 3.2.
@@ -477,7 +477,7 @@
compiler versions.
<command>pentium-builder</command> provides an infrastructure for
using a different compiler for building packages than the default gcc, by
- providing a wrapper script called gcc which calls the real gcc.
+ providing a wrapper script called gcc that calls the real gcc.
To use <command>pentium-builder</command> in <command>pbuilder</command>, it is possible to set up the
following in the configuration:
<screen>
@@ -501,13 +501,13 @@ export DEBIAN_BUILDGCCVER=3.2</screen>
<command>pbuilder</command>.
<command>pbuilder-user-mode-linux</command> doesn't require root
privileges, and it uses the copy-on-write (COW) disk access
- method of <command>User-mode-linux</command> which typically
+ method of <command>User-mode-linux</command>, which typically
makes it much faster than the traditional
<command>pbuilder</command>.
</para>
<para>
<command>User-mode-linux</command> is a somewhat less proven
- platform than the standard Unix tools which
+ platform than the standard Unix tools that
<command>pbuilder</command> relies on
(<command>chroot</command>, <command>tar</command>, and
<command>gzip</command>) but mature enough to support
@@ -582,7 +582,7 @@ export DEBIAN_BUILDGCCVER=3.2</screen>
<listitem>
<para>Set up <filename>/etc/rootstrap/rootstrap.conf</filename>.
For example,
- if the current host is 192.168.1.2, changing following
+ if the current host is 192.168.1.2, changing the following
entries to something like this seems to work.
<screen>
transport=tuntap
@@ -685,7 +685,7 @@ PBUILDER_UML_IMAGE="/home/dancer/uml-image"</screen>
</listitem>
<listitem>
<para>
- If you are not using slirp, user-mode-linux processes which are
+ If you are not using slirp, user-mode-linux processes that are
running in parallel need to have different IP addresses.
Just trying to run the <command>pbuilder-user-mode-linux</command>
several times will result in failure to access the network.
@@ -773,7 +773,7 @@ read</screen>
<title>Directories that cannot be bind-mounted</title>
<para>
Because of the way <command>pbuilder</command> works, there
- are several directories which cannot be bind-mounted when
+ are several directories that cannot be bind-mounted when
running <command>pbuilder</command>. The directories include
<filename>/tmp</filename>,
<filename>/var/cache/pbuilder</filename>, and system
@@ -788,8 +788,8 @@ read</screen>
It is possible to invoke a shell session after a build
failure. Example hook scripts are provided as
<filename>C10shell</filename> and
- <filename>C11screen</filename> scripts. C10shell script will
- start bash inside chroot, and C11screen script will start GNU
+ <filename>C11screen</filename> scripts. The C10shell script will
+ start bash inside chroot, and the C11screen script will start a GNU
screen inside the chroot.
</para>
</sect1>
@@ -832,7 +832,7 @@ $ sudo pbuilder update --hookdir ~/loginhooks/E10shell</screen>
<filename>/tmp</filename>, you will find that some errors may occur inside the chroot,
such as <command>dpkg-source</command> failing.
</para>
- <para>There are two options, you may install a hook to create that
+ <para>There are two options: you may install a hook to create that
directory, or set
<screen>export TMPDIR=/tmp</screen>
in pbuilderrc. Take your pick.
@@ -847,7 +847,7 @@ $ sudo pbuilder update --hookdir ~/loginhooks/E10shell</screen>
<para>
When working with multiple chroots, it would be nice to work
with scripts that reduce the amount of typing. An example
- script <filename>pbuilder-distribution.sh</filename> is
+ script, <filename>pbuilder-distribution.sh</filename>, is
provided as an example. Invoking the script as
<filename>pbuilder-squeeze</filename> will invoke
<command>pbuilder</command> with a squeeze chroot.
@@ -855,20 +855,20 @@ $ sudo pbuilder update --hookdir ~/loginhooks/E10shell</screen>
</sect1>
<sect1 id="ENVVARDISTRIBUTIONSWITCH">
<title>Using environmental variables for running <command>pbuilder</command>
- for specific distribution
+ for a specific distribution
</title>
<para> This section<footnote>
- <para>This part of the documentation contributed by Andres Mejia</para>
+ <para>This part of the documentation contributed by Andres Mejia.</para>
<para>
This example was taken from a wiki (<ulink url="https://wiki.ubuntu.com/PbuilderHowto">https://wiki.ubuntu.com/PbuilderHowto</ulink>).
</para>
</footnote>
- describes briefly a way to setup and use multiple pbuilder setups
+ describes briefly a way to set up and use multiple pbuilder setups
by creating a pbuilderrc configuration in your home path (<filename>$HOME/.pbuilderrc</filename>)
and using the variable "DIST" when running pbuilder or pdebuild.
</para>
- <para> First, setup <filename>$HOME/.pbuilderrc</filename> to look like:</para>
+ <para> First, set up <filename>$HOME/.pbuilderrc</filename> to look like:</para>
<para>
<screen>
if [ -n "${DIST}" ]; then
@@ -880,11 +880,11 @@ fi
</screen></para>
<para>Then, whenever you wish to use pbuilder for a particular distro, assign a value
to "DIST" that is one of the distros available for Debian or any Debian based
-distro you happen to be running (i.e. whatever is found under
+distro you happen to be running (i.e., whatever is found under
/usr/lib/debootstrap/scripts).
</para>
- <para>Here's some examples on running pbuilder or pdebuild:
+ <para>Here are some examples for running pbuilder or pdebuild:
</para>
<para><screen>
DIST=gutsy sudo pbuilder create
@@ -909,7 +909,7 @@ DIST=gutsy pdebuild
<para>
If you have some very specialized requirements on your
apt setup inside <command>pbuilder</command>,
- it is possible to specify that through
+ it is possible to specify them through
the <command><option>--othermirror</option></command>
option.
Try something like:
@@ -944,7 +944,7 @@ cd /var/cache/pbuilder/result/
This way, you can use <filename>deb file:/var/cache/pbuilder/result</filename>
</para>
<para>
- To add new apt-key inside chroot:
+ To add a new apt-key inside chroot:
<!-- from http://ubuntuforums.org/archive/index.php/t-696820.html -->
</para>
<para>
@@ -957,7 +957,7 @@ EOF
</screen></para>
</sect1>
<sect1 id="apt-getupdateonbuild-depend">
- <title>How to get pbuilder to run apt-get update before trying to satisfy build-dependency</title>
+ <title>How to get pbuilder to run apt-get update before trying to satisfy build-dependencies</title>
<para>
You can use hook scripts for this.
D scripts are run before satisfying build-dependency.
@@ -982,14 +982,14 @@ EOF
is included in the value of PS1 (the Bash prompt)
inside the chroot.
In prior versions of bash,<footnote>
- <para>Versions of bash from and before Debian 3.0</para>
+ <para>Versions of bash from and before Debian 3.0.</para>
</footnote>
setting PS1 in pbuilderrc worked.
</para>
- <para>example of debian_chroot</para>
+ <para>Example of debian_chroot:</para>
<screen>
export debian_chroot="pbuild$$"</screen>
- <para>example of PS1</para>
+ <para>Example of PS1:</para>
<screen>
export PS1="pbuild chroot 32165 # "</screen>
</sect1>
@@ -1027,7 +1027,7 @@ EOF
<sect1 id="stablebackport">
<title>pbuilder back ported to stable Debian releases</title>
<para>
- Currently stable back port of pbuilder is available at backports.org.
+ Currently, a stable back port of pbuilder is available at backports.org.
</para>
</sect1>
<sect1 id="LOGNAME">
@@ -1068,8 +1068,8 @@ EOF
thus this error will occur, depending on your set up. If this
happens, set <screen>APTCACHEHARDLINK=no</screen> in your
pbuilderrc file. Note that packages in
- <command>APTCACHE</command> will be copied into chroot local
- cache, so plan for enough space on
+ <command>APTCACHE</command> will be copied into the chroot local
+ cache, so plan for enough space on the
<command>BUILDPLACE</command> device.
</para>
</sect1>
@@ -1082,7 +1082,7 @@ EOF
<command>fakechroot</command> overrides library loads and
tries to override default libc functions when providing the
functionality of virtual <command>chroot</command>. However,
- some binaries do no use libc to function, or override the
+ some binaries do not use libc to function, or override the
overriding provided by <command>fakechroot</command>. One
example is <command>ldd</command>. Inside
<command>fakechroot</command>, <command>ldd</command> will
@@ -1138,7 +1138,7 @@ EOF
<command>pbuilder</command> is extracting the tar.gz every
time <command>pbuilder</command> is invoked. That can be
avoided by using <command>pbuilder-user-mode-linux</command>.
- <command>pbuilder-user-mode-linux</command> uses COW file
+ <command>pbuilder-user-mode-linux</command> uses the COW file
system, and thus does not need to clean up and recreate the
root file system.
</para>
@@ -1150,13 +1150,13 @@ EOF
</para>
<para>
<command>pbuilder</command> with cowdancer is also an
- alternative that improves speed of pbuilder startup.
+ alternative that improves the speed of pbuilder startup.
</para>
</sect1>
<sect1 id="sponsor">
<title>Using pdebuild to sponsor package</title>
<para>
- To sign a package marking for sponsorship, it is possible to
+ To sign a package marking it for sponsorship, it is possible to
use<command><option> --auto-debsign</option></command> and
<command><option>--debsign-k</option></command> options of
<command>pdebuild</command>.
@@ -1169,7 +1169,7 @@ EOF
<para>
When running <command>pdebuild</command>, <command>pbuilder</command> will run dpkg-buildpackage to create a
Debian source package to pass it on to <command>pbuilder</command>.
- File named XXXX_YYY_source.changes is what remains from that process.
+ A file named XXXX_YYY_source.changes is what remains from that process.
It is harmless unless you try to upload it to the Debian archive.
</para>
<para>
@@ -1181,7 +1181,7 @@ EOF
<para>
amd64 architectures are capable of running binaries in i386
mode. It is possible to use <command>pbuilder</command> to
- run packages, using <command>linux32</command> and
+ run packages, using <command>linux32</command> and the
<command>debootstrap <option>--arch</option></command> option.
Specifically, a command-line option like the following will
work.
@@ -1197,7 +1197,7 @@ EOF
<title>Using tmpfs for buildplace</title>
<para>
To improve speed of operation, it is possible to use tmpfs for
- pbuilder build location. Mount tmpfs to
+ the pbuilder build location. Mount tmpfs to
<filename>/var/cache/pbuilder/build</filename>, and set
<screen>APTCACHEHARDLINK=no</screen>.
</para>
@@ -1205,8 +1205,8 @@ EOF
<sect1>
<title id="svnbuildpackage">Using svn-buildpackage together with pbuilder</title>
<para>
- pdebuild command can be used with svn-buildpackage
- --svn-builder command-line option.
+ The pdebuild command can be used with the svn-buildpackage
+ --svn-builder command-line option:
<footnote>
<para><ulink url="http://upsilon.cc/~zack/blog/posts/2007/09/svn-cowbuilder/">
Zack has posted an example on his blog.
@@ -1229,7 +1229,7 @@ alias svn-cowbuilder="svn-buildpackage --svn-builder='pdebuild --pbuilder cowbui
going wrong. Most of the time, adding a
<command><option>--debug</option></command> option and
re-running the session should do the trick. Please send the
- log of such session along with your problem to ease the
+ log of such a session along with your problem to ease the
debugging process.
</para>
</sect1>
@@ -1238,7 +1238,7 @@ alias svn-cowbuilder="svn-buildpackage --svn-builder='pdebuild --pbuilder cowbui
<para>
There is a mailing list for <command>pbuilder</command> on
alioth (pbuilder-maint at lists.alioth.debian.org). You can
- subscribe through the alioth web interface.
+ subscribe through the alioth web interface:
<ulink url="http://alioth.debian.org/mail/?group_id=30778">
http://alioth.debian.org/mail/?group_id=30778</ulink>.
</para>
@@ -1265,11 +1265,11 @@ alias svn-cowbuilder="svn-buildpackage --svn-builder='pdebuild --pbuilder cowbui
There is an Alioth project page at
<ulink url="http://alioth.debian.org/projects/pbuilder">
http://alioth.debian.org/projects/pbuilder</ulink>.
- Home page is also available,
+ A home page is also available,
at <ulink url="http://pbuilder.alioth.debian.org/">
- http://alioth.debian.org/projects/pbuilder</ulink>
+ http://alioth.debian.org/projects/pbuilder</ulink>,
which shows this text.
- git repository is available through http, git, or (if you have an
+ A git repository is available through http, git, or (if you have an
account on alioth, ) ssh.
</para>
<screen>
@@ -1277,7 +1277,7 @@ git-clone git://git.debian.org/git/pbuilder/pbuilder.git
git-clone http://git.debian.org/git/pbuilder/pbuilder.git
git-clone ssh://git.debian.org/git/pbuilder/pbuilder.git</screen>
<para>
- Git commit message should have the first one line describing
+ Git commit message should have the first line describing
what the commit does, formatted in the way debian/changelog is
formatted because it is copied verbatim to changelog via
git-dch. The second line is empty, and the rest should
@@ -1285,13 +1285,13 @@ git-clone ssh://git.debian.org/git/pbuilder/pbuilder.git</screen>
implementation of the commit.
</para>
<para>
- Test-suites are available in <filename>./testsuite/</filename> directory.
+ Test-suites are available in the <filename>./testsuite/</filename> directory.
Changes are expected not to break the test-suites.
<filename>./run-test.sh</filename> is a basic test-suite, which puts a summary in
<filename>run-test.log</filename>, and <filename>run-test-cdebootstrap.log</filename>.
<filename>./run-test-regression.sh</filename> is a regression test-suite,
which puts the result in <filename>run-test-regression.log</filename>.
- Currently, run-test.sh is ran automatically daily to ensure that pbuilder is working.
+ Currently, run-test.sh is run automatically daily to ensure that pbuilder is working.
</para>
<table id="dirtestsuites">
<title>Directory structure of the testsuite</title>
@@ -1307,7 +1307,7 @@ git-clone ssh://git.debian.org/git/pbuilder/pbuilder.git</screen>
<tbody>
<row>
<entry><filename>./testsuite/</filename></entry>
- <entry>Directory for testsuite</entry>
+ <entry>Directory for testsuite.</entry>
</row>
<row>
<entry><filename>./testsuite/run-test.sh</filename></entry>
@@ -1315,27 +1315,27 @@ git-clone ssh://git.debian.org/git/pbuilder/pbuilder.git</screen>
</row>
<row>
<entry><filename>./testsuite/run-test.log</filename></entry>
- <entry>A summary of testsuite</entry>
+ <entry>A summary of testsuite.</entry>
</row>
<row>
<entry><filename>./testsuite/normal/</filename></entry>
- <entry>Directory for testsuite results of running pbuilder with debootstrap</entry>
+ <entry>Directory for testsuite results of running pbuilder with debootstrap.</entry>
</row>
<row>
<entry><filename>./testsuite/cdebootstrap/</filename></entry>
- <entry>Directory for testsuite results of running pbuilder with cdebootstrap</entry>
+ <entry>Directory for testsuite results of running pbuilder with cdebootstrap.</entry>
</row>
<row>
<entry><filename>./testsuite/run-regression.sh</filename></entry>
- <entry>Regression testsuite, ran every time change is made to pbuilder to make sure there is no regression.</entry>
+ <entry>Regression testsuite, run every time change is made to pbuilder to make sure there is no regression.</entry>
</row>
<row>
<entry><filename>./testsuite/run-regression.log</filename></entry>
- <entry>Summary of test result</entry>
+ <entry>Summary of test result.</entry>
</row>
<row>
<entry><filename>./testsuite/regression/BugID-*.sh</filename></entry>
- <entry>Regression tests, exit 0 for success, exit 1 for failure</entry>
+ <entry>Regression tests, exit 0 for success, exit 1 for failure.</entry>
</row>
<row>
<entry><filename>./testsuite/regression/BugID-*</filename></entry>
@@ -1343,30 +1343,30 @@ git-clone ssh://git.debian.org/git/pbuilder/pbuilder.git</screen>
</row>
<row>
<entry><filename>./testsuite/regression/log/BugID-*.sh.log</filename></entry>
- <entry>Output of the regression test, output from the script is redirected by run-regression.sh</entry>
+ <entry>Output of the regression test; output from the script is redirected by run-regression.sh.</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
- When making changes, changes should be documented in the Git
+ When making changes, they should be documented in the Git
commit log. git-dch will generate debian/changelog from the
commit log. Make the first line of your commit log meaningful,
and add any bug-closing information available.
- debian/changelog should not be edited directly unless when
+ debian/changelog should not be edited directly except when
releasing a new version.
</para>
<para>
A TODO file is available in <filename>debian/TODO</filename>.
It's mostly not well-maintained, but hopefully it will be more
- up-to-date when people start using it. emacs todoo-mode is
+ up-to-date when people start using it. Emacs todoo-mode is
used in editing the file.
</para>
<para>
When releasing a new version of <command>pbuilder</command>,
the version is tagged with the git tag
X.XXX (version number).
- This is done with <command>./git-tag.sh</command> script available in the source tree.
+ This is done with the <command>./git-tag.sh</command> script, available in the source tree.
</para>
</sect1>
</chapter>
@@ -1375,7 +1375,7 @@ git-clone ssh://git.debian.org/git/pbuilder/pbuilder.git</screen>
<sect1 id="chroot">
<title>Using pbuilder for small experiments</title>
<para>
- There are cases when some small experimenting is required, and
+ There are cases when some small amount of experimenting is required, and
you do not want to damage the main system,
like when installing experimental library packages,
or compiling with experimental compilers.
@@ -1417,7 +1417,7 @@ git-clone ssh://git.debian.org/git/pbuilder/pbuilder.git</screen>
LVM2 has a useful snapshot function that features Copy-on-write images.
That could be used for <command>pbuilder</command> just as it can be used for
the user-mode-linux <command>pbuilder</command> port.
- lvmpbuilder script in the examples directory implements such port.
+ The lvmpbuilder script in the examples directory implements such a port.
The scripts and documentation can be found under
<filename>/usr/share/doc/pbuilder/examples/lvmpbuilder/</filename>.
</para>
@@ -1426,17 +1426,17 @@ git-clone ssh://git.debian.org/git/pbuilder/pbuilder.git</screen>
<title>Using cowdancer</title>
<para>
<command>cowdancer</command> allows copy-on-write semantics on
- file system using hard links and hard-link-breaking-on-write
+ a file system using hard links and hard-link-breaking-on-write
tricks. <command>pbuilder</command> using
<command>cowdancer</command> seems to be much faster and it is
one ideal point for improvement.
<command>cowbuilder</command>, a wrapper for
- <command>pbuilder</command> for using
- <command>cowdancer</command> is available from
- <command>cowdancer</command> package since 0.14
+ <command>pbuilder</command> that uses
+ <command>cowdancer</command>, is available from the
+ <command>cowdancer</command> package since version 0.14.
</para>
<para>
- Example command-lines for cowbuilder look like the following.
+ Example command-lines for cowbuilder look like the following:
</para>
<para>
<screen>
@@ -1445,9 +1445,9 @@ git-clone ssh://git.debian.org/git/pbuilder/pbuilder.git</screen>
# cowbuilder --build XXX.dsc</screen>
</para>
<para>
- It is also possible to use cowdancer with pdebuild command.
- Specify with command-line option <option>--pbuilder</option>
- or set it in PDEBUILD_PBUILDER configuration option.
+ It is also possible to use cowdancer with the pdebuild command.
+ Specify this with command-line option <option>--pbuilder</option>
+ or set it in the PDEBUILD_PBUILDER configuration option.
</para>
<para>
<screen>
@@ -1460,7 +1460,7 @@ $ pdebuild --pbuilder cowbuilder</screen>
The <command><option>--no-targz</option></command>
option of <command>pbuilder</command>
will allow usage of <command>pbuilder</command> in a different way
- from conventional usage.
+ than conventional usage.
It will try to use an existing chroot,
and will not try to clean up after
working on it.
@@ -1492,7 +1492,7 @@ $ pdebuild --pbuilder cowbuilder</screen>
<sect1 id="ccache">
<title>Usage of ccache</title>
<para>
- It is possible to use C compiler cache
+ It is possible to use the C compiler cache
<command>ccache</command> to speed up repeated builds of the same
package (or packages that compile the same files multiple times for some
reason). Using <command>ccache</command> can speed up repeated building
@@ -1506,7 +1506,7 @@ $ pdebuild --pbuilder cowbuilder</screen>
</para>
<para>
Current implementation of ccache support has several bugs,
- that CCACHEDIR must be owned by the pbuilder build user, and
+ such that CCACHEDIR must be owned by the pbuilder build user, and
parallel runs of pbuilder are not supported. Therefore it is
not enabled by default.
</para>
@@ -1530,11 +1530,11 @@ $ pdebuild --pbuilder cowbuilder</screen>
<tbody>
<row>
<entry><filename>/etc/pbuilderrc</filename></entry>
- <entry>configuration file</entry>
+ <entry>Configuration file.</entry>
</row>
<row>
<entry><filename>/usr/share/pbuilder/pbuilderrc</filename></entry>
- <entry>Default configuration</entry>
+ <entry>Default configuration.</entry>
</row>
<row>
<entry><filename>/var/cache/pbuilder/base.tgz</filename></entry>
@@ -1544,7 +1544,7 @@ $ pdebuild --pbuilder cowbuilder</screen>
</row>
<row>
<entry><filename>/var/cache/pbuilder/build/PID/</filename></entry>
- <entry>Default location pbuilder uses for chroot</entry>
+ <entry>Default location pbuilder uses for chroot.</entry>
</row>
<row>
<entry><filename>/var/cache/pbuilder/aptcache</filename></entry>
@@ -1553,15 +1553,15 @@ $ pdebuild --pbuilder cowbuilder</screen>
<row>
<entry><filename>/var/cache/pbuilder/ccache</filename></entry>
<entry>Default location <command>pbuilder</command> will use as
-cache location</entry>
+cache location.</entry>
</row>
<row>
<entry><filename>/var/cache/pbuilder/result</filename></entry>
- <entry>Default location <command>pbuilder</command> puts the deb files and other files created after build</entry>
+ <entry>Default location where <command>pbuilder</command> puts the deb files and other files created after build.</entry>
</row>
<row>
<entry><filename>/var/cache/pbuilder/pbuilder-umlresult</filename></entry>
- <entry>Default location <command>pbuilder-user-mode-linux</command> puts the deb files and other files created after build </entry>
+ <entry>Default location where <command>pbuilder-user-mode-linux</command> puts the deb files and other files created after build.</entry>
</row>
<row>
<entry><filename>/var/cache/pbuilder/pbuilder-mnt</filename></entry>
@@ -1573,11 +1573,11 @@ cache location</entry>
</row>
<row>
<entry><filename>${HOME}/tmp/PID.cow</filename></entry>
- <entry><command>pbuilder-user-mode-linux</command> use this directory for location of COW file system.</entry>
+ <entry><command>pbuilder-user-mode-linux</command> uses this directory for location of COW file system.</entry>
</row>
<row>
<entry><filename>${HOME}/uml-image</filename></entry>
- <entry><command>pbuilder-user-mode-linux</command> use this directory for user-mode-linux full disk image.</entry>
+ <entry><command>pbuilder-user-mode-linux</command> uses this directory for user-mode-linux full disk image.</entry>
</row>
</tbody>
</tgroup>
@@ -1600,7 +1600,7 @@ cache location</entry>
<row>
<entry><filename>/etc/mtab</filename></entry>
<entry>
- symlink to <filename>/proc/mounts</filename>.
+ Symlink to <filename>/proc/mounts</filename>.
</entry>
</row>
<row>
@@ -1631,7 +1631,7 @@ cache location</entry>
<entry><filename>/var/cache/apt/archives</filename></entry>
<entry>
<command>pbuilder</command> copies the content of this directory to and from
- the aptcache directory of outside chroot.
+ the aptcache directory located outside chroot.
</entry>
</row>
<row>
@@ -1645,7 +1645,7 @@ cache location</entry>
<entry><filename>/tmp/XXXX</filename></entry>
<entry><command>pbuilder-user-mode-linux</command> uses
a script in <filename>/tmp</filename> to bootstrap into
- user-mode-linux</entry>
+ user-mode-linux.</entry>
</row>
</tbody>
</tgroup>
@@ -1669,8 +1669,7 @@ cache location</entry>
<ulink url="http://pbuilder.alioth.debian.org/pbuilder-doc.pdf">There is also a PDF version</ulink>.
The homepage for <command>pbuilder</command> is
<ulink url="http://pbuilder.alioth.debian.org/">
- http://pbuilder.alioth.debian.org/
- </ulink> hosted by alioth project.
+ http://pbuilder.alioth.debian.org/</ulink>, hosted by the alioth project.
</para>
<para>
Documentation is written using DocBook XML,
@@ -1694,11 +1693,11 @@ cache location</entry>
Debian packages from source. Lars Wirzenius wrote that
script, and it was good, short, and simple (probably).
There was nothing like build-depends then (I think), and it was simple.
- It could have been improved, I could only find references and no actual source.
+ It might have been improved; I could only find references and no actual source.
</para>
<para>
- debbuild was probably written by James Troup. I don't know it
- because I have never seen the actual code, I could only find some
+ debbuild was probably written by James Troup. I don't know
+ because I have never seen the actual code; I could only find some
references to it on the net, and mailing list logs.
</para>
<para>
@@ -1707,7 +1706,7 @@ cache location</entry>
and has a lot of hacks to actually get things building,
including a table of what package to use when virtual packages are
specified (does it do that still?).
- It supports the use of a local database for packages which do not
+ It supports the use of a local database for packages that do not
have build-dependencies. It was written by Ronan Hodek,
and I think it was patched and fixed and extended by
several people. It is part of wanna-build, and used extensively
@@ -1731,7 +1730,7 @@ cache location</entry>
but soon, it was decided that that's too slow.
</para>
<para>
- Yes, and it took almost an year to get things somewhat
+ Yes, and it took almost a year to get things somewhat
right, and in the middle of the process, Debian 3.0
was released. Yay.
Debian 3.0 wasn't completely buildable with <command>pbuilder</command>,
@@ -1748,7 +1747,7 @@ cache location</entry>
<command>pbuilder-user-mode-linux</command>.
<command>pbuilder-user-mode-linux</command> has not stayed
functional as much as I would have liked, and bootstrapping
- <command>user-mode-linux</command> environment has been
+ the <command>user-mode-linux</command> environment has been
pretty hard, due to the quality of user-mode-linux code or
packaging at that time, which kept on breaking network
support in one way or the other.
@@ -1757,18 +1756,18 @@ cache location</entry>
<sect2 id="fifthyear">
<title>Fifth year of pbuilder</title>
<para>
- <command>pbuilder</command> is now widely adopted as a 'almost standard' tool
+ <command>pbuilder</command> is now widely adopted as an 'almost standard' tool
for testing packages, and building packages in a pristine
- environment. There are other similar tools that do similar
+ environment. There are other, similar tools that do similar
tasks, but they do not share the exact same goal. To
- commemorate this fact, <command>pbuilder</command> is now co-maintained with
+ commemorate this fact, <command>pbuilder</command> is now co-maintained by
several people.
</para>
<para>
<command>sbuild</command> is now a well-maintained Debian package within
Debian, and with <command>pbuilder</command> being such a slow monster, some
people prefer the approach of sbuild. Development to use
- LVM-snapshots, cowloop, or cowdancer is hoped to improve the
+ LVM-snapshots, cowloop, or cowdancer are hoped to improve the
situation somewhat.
</para>
</sect2>
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pbuilder/pbuilder.git
More information about the Pbuilder-maint
mailing list