[Pbuilder-maint] pbuilder CVS update: pbuilder/Documentation
pbuilder-doc.xml
pbuilder CVS Commit
pbuilder-maint at lists.alioth.debian.org
Wed May 24 09:02:27 UTC 2006
User: dancer
Date: 06/05/24 09:02:27
Modified: Documentation pbuilder-doc.xml
Log:
initial cowbuilder support in pdebuild
pbuilder supports pdebuild/cowbuilder
login/execute/update/create etc. can also be --login/--execute/--update/--create etc.
to cater for cowbuilder
documentation updates / XML typesetting fixes.
manpage fixes / spellchecking
generally what I did while I was on plane trip from Debconf Mexico to Japan.
Revision Changes Path
1.70 +346 -274 pbuilder/Documentation/pbuilder-doc.xml
CVSWEB Options: -------------------
CVSWeb: Annotate this file: http://cvs.alioth.debian.org/cgi-bin/cvsweb.cgi/pbuilder/pbuilder/Documentation/pbuilder-doc.xml?annotate=1.70&cvsroot=
CVSWeb: View this file: http://cvs.alioth.debian.org/cgi-bin/cvsweb.cgi/pbuilder/pbuilder/Documentation/pbuilder-doc.xml?rev=1.70&content-type=text/x-cvsweb-markup&cvsroot=
CVSWeb: Diff to previous version: http://cvs.alioth.debian.org/cgi-bin/cvsweb.cgi/pbuilder/pbuilder/Documentation/pbuilder-doc.xml.diff?r1=1.70&r2=1.69&cvsroot=
-----------------------------------
Index: pbuilder-doc.xml
===================================================================
RCS file: /cvsroot/pbuilder/pbuilder/Documentation/pbuilder-doc.xml,v
retrieving revision 1.69
retrieving revision 1.70
diff -u -r1.69 -r1.70
--- pbuilder-doc.xml 17 May 2006 03:00:51 -0000 1.69
+++ pbuilder-doc.xml 24 May 2006 09:02:26 -0000 1.70
@@ -4,7 +4,7 @@
and the latest version is found in CVS repository. -->
<book xml:lang="en">
<bookinfo>
- <date>2006-3-8</date>
+ <date>2006-5-24</date>
<title>pbuilder User's Manual</title>
<abbrev>pbuilder-doc</abbrev>
<subtitle>Usage and operations</subtitle>
@@ -45,7 +45,7 @@
installed.
</para>
<para>
- The primary aim of pbuilder is different from other
+ The primary aim of <command>pbuilder</command> is different from other
auto-building systems in Debian in that its aim is not
to try to build as many packages as possible.
It does not try to guess
@@ -55,7 +55,7 @@
<para>
In this way, <command>pbuilder</command> tries to ensure
that packages
- tested against pbuilder will build properly in
+ tested against <command>pbuilder</command> will build properly in
most Debian installations, hopefully resulting
in a good overall Debian source-buildability.
</para>
@@ -112,11 +112,11 @@
will update the chroot image.
It will extract the chroot, invoke <command>apt-get update</command>
and <command>apt-get dist-upgrade</command> inside the
- chroot, and then recreate the base tarball.
+ chroot, and then recreate the base tar-ball.
</para>
<para>
It is possible to switch the distribution which the chroot
- tarball is targeted at at this point.
+ tar-ball 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.
<footnote>
@@ -184,9 +184,9 @@
</para>
<para>
There is a slightly different mode of operation available
- in pdebuild since version 0.97. pdebuild usually runs
+ in <command>pdebuild</command> since version 0.97. <command>pdebuild</command> usually runs
<command>debian/rules clean</command> outside of the chroot;
- however, it is possible to change the behavior to run it
+ however, it is possible to change the behaviour to run it
inside the chroot with
the <command><option>--use-pdebuild-internal</option></command>.
It will try to bind mount the working directory inside chroot,
@@ -198,7 +198,7 @@
<listitem>
<para>
Satisfies build-dependency inside the chroot before creating source package.
- (which is a good point that current pdebuild cannot do).
+ (which is a good point that current <command>pdebuild</command> cannot do).
</para>
</listitem>
<listitem>
@@ -206,8 +206,8 @@
from inside the chroot.</para>
</listitem>
<listitem>
- <para>Building with pdebuild does not guarantee
- that it works with pbuilder.</para>
+ <para>Building with <command>pdebuild</command> does not guarantee
+ that it works with <command>pbuilder</command>.</para>
</listitem>
<listitem>
<para>If making the source package fails,
@@ -235,12 +235,12 @@
<para>
<filename>/etc/pbuilderrc</filename> and
<filename>${HOME}/.pbuilderrc</filename>
- are read in when pbuilder is invoked.
+ are read in when <command>pbuilder</command> is invoked.
The possible options are documented in
the pbuilderrc.5 manual page.
</para>
<para>
- It is useful to use --configfile option to load up a pre-set
+ It is useful to use <option>--configfile</option> option to load up a preset
configuration file when switching between configuration files for
different distributions.
</para>
@@ -270,17 +270,17 @@
packages that are being built with
<command>pbuilder</command> to affect the environment outside the chroot.
When BUILDUSERNAME configuration option is also set,
- pbuilder will use the specified user name and fakeroot for building packages,
+ <command>pbuilder</command> will use the specified user name and fakeroot for building packages,
instead of running as root inside chroot.
</para>
<para>
- Even when using the fakerooting method, pbuilder will run with
+ Even when using the fakerooting method, <command>pbuilder</command> will run with
root privilege when it is required.
For example, when installing
- packages to the chroot, pbuilder will run under root privilege.
+ packages to the chroot, <command>pbuilder</command> will run under root privilege.
</para>
<para>
- To be able to invoke pbuilder without being
+ To be able to invoke <command>pbuilder</command> without being
root, you need to use user-mode-linux, as explained
in <xref linkend="pbuilder-uml"/>.
</para>
@@ -288,7 +288,7 @@
<sect1 id="backporting">
<title>Using pbuilder for back-porting</title>
<para>
- pbuilder can be used for back-porting software from
+ <command>pbuilder</command> can be used for back-porting software from
the latest Debian distribution to
the older stable distribution, by using a chroot that contains
an image of the older distribution, and building packages inside the
@@ -317,14 +317,14 @@
<sect1 id="massbuild">
<title>Mass-building packages</title>
<para>
- pbuilder can be automated, because its operations are
+ <command>pbuilder</command> can be automated, because its operations are
non-interactive.
- It is possible to run pbuilder through multiple packages
+ It is possible to run <command>pbuilder</command> through multiple packages
non-interactively.
Several such scripts are known to exist.
Junichi Uekawa has been running such a script since 2001,
and has been filing bugs on packages that fail the
- test of pbuilder. There were several problems with auto-building:
+ test of <command>pbuilder</command>. There were several problems with auto-building:
</para>
<itemizedlist>
<listitem>
@@ -343,18 +343,18 @@
</listitem>
</itemizedlist>
<para>
- Most of the initial bugs have been resolved in the pbuilder
+ Most of the initial bugs have been resolved in the <command>pbuilder</command>
sweep done around 2002, but these transitional problems which
affect a large portion of Debian Archive do arise from time to
time. Regression tests have their values.
</para>
<para>
A script that was used by Junichi Uekawa is now included in
- the pbuilder distribution, as <command>pbuildd.sh</command>.
+ the <command>pbuilder</command> distribution, as <command>pbuildd.sh</command>.
It is available in <filename>/usr/share/doc/pbuilder/examples/pbuildd/</filename>
and its configuration is in <filename>/etc/pbuilder/pbuildd-config.sh</filename>.
It should be easy enough to set up for people who are used to
- pbuilder. It has been running for quite a while, and it should be
+ <command>pbuilder</command>. It has been running for quite a while, and it should be
possible to set the application up on your system also.
However, it is a new introduction, and please file bugs
to the Debian BTS if you know of possible problems,
@@ -373,7 +373,7 @@
</listitem>
<listitem>
<para>Because you are running random build scripts, it is better to use
- the fakeroot option of pbuilder, to avoid running the build
+ the fakeroot option of <command>pbuilder</command>, to avoid running the build
under root privilege.</para>
</listitem>
<listitem>
@@ -393,7 +393,7 @@
<sect1>
<title>Auto-backporting scripts</title>
<para>
- There are some people who use pbuilder to automatically back-port
+ There are some people who use <command>pbuilder</command> to automatically back-port
a subset of packages to the stable distribution.
</para>
<para>
@@ -405,7 +405,7 @@
<sect1 id="autotesting">
<title>Using pbuilder for automated testing of packages</title>
<para>
- pbuilder can be used for automated testing of packages.
+ <command>pbuilder</command> can be used for automated testing of packages.
It has the feature of allowing hooks to be placed,
and these hooks can try to install packages inside
the chroot, or run them, or whatever else that
@@ -413,7 +413,7 @@
</para>
<itemizedlist>
<listitem>
- <para>Automatic install-remove-upgrade-remove-install-purge-upgrade-purge testsuite (distributed as an example, <filename>B91dpkg-i</filename>),
+ <para>Automatic install-remove-upgrade-remove-install-purge-upgrade-purge test-suite (distributed as an example, <filename>B91dpkg-i</filename>),
or just check that everything installs somewhat (<filename>execute_installtest.sh</filename>).</para>
</listitem>
@@ -424,7 +424,7 @@
<listitem>
<para>Automatic debian-test of the package?
The debian-test package has been removed from Debian.
- A pbuilder implementation can be found as
+ A <command>pbuilder</command> implementation can be found as
debian/pbuilder-test directory, implemented through B92pkg-test script.</para>
</listitem>
</itemizedlist>
@@ -462,35 +462,38 @@
<chapter id="pbuilder-uml">
<title>Using User-mode-linux with pbuilder</title>
<para>
- NOTE that since October 2004, pbuilder for user-mode-linux is
- not distributed, since user-mode-linux itself is broken in
- Debian. A functional user-mode-linux will hopefully be fixed
- before Debian etch release, but it is not quite determined yet
- if pbuilder-uml will be ready for etch.
+ NOTE that since October 2004, <command>pbuilder</command> for
+ user-mode-linux is not distributed, since
+ <command>user-mode-linux</command> itself is broken in Debian.
+ A functional <command>user-mode-linux</command> will hopefully
+ be fixed before Debian etch release, but it is not quite
+ determined yet if <command>pbuilder-user-mode-linux</command>
+ will be ready for etch.
</para>
<para>
- It is possible to use user-mode-linux
- by invoking <command>pbuilder-uml</command>
- instead of <command>pbuilder</command>.
- <command>pbuilder-uml</command> doesn't require
- root privileges, and it uses
- the copy-on-write (COW) disk access method of User-mode-linux
- which typically makes it much faster
- than the traditional <command>pbuilder</command>.
+ It is possible to use user-mode-linux by invoking
+ <command>pbuilder-user-mode-linux</command> instead of
+ <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
+ makes it much faster than the traditional
+ <command>pbuilder</command>.
</para>
<para>
- User-mode-linux is a somewhat less proven platform
- than the standard Unix tools which
+ <command>User-mode-linux</command> is a somewhat less proven
+ platform than the standard Unix tools which
<command>pbuilder</command> relies on
- (<command>chroot</command>,
- <command>tar</command>,
- and <command>gzip</command>)
- but mature enough to support <command>pbuilder-uml</command>
- since its version 0.59.
- And since then, pbuilder-uml has seen a rapid evolution.
+ (<command>chroot</command>, <command>tar</command>, and
+ <command>gzip</command>) but mature enough to support
+ <command>pbuilder-user-mode-linux</command> since its version
+ 0.59. And since then,
+ <command>pbuilder-user-mode-linux</command> has seen a rapid
+ evolution.
</para>
<para>
- The configuration of pbuilder-uml goes in three steps:
+ The configuration of <command>pbuilder-user-mode-linux</command>
+ goes in three steps:
<itemizedlist>
<listitem>
<para>Configuration of user-mode-linux</para>
@@ -506,13 +509,14 @@
<sect1 id="user-mode-linux-config">
<title>Configuring user-mode-linux</title>
<para>
- UML isn't completely trivial to set up.
- It would probably be useful to acquaint yourself with it a bit
- before attempting to use rootstrap or pbuilder-uml.
- For details,
- read <filename>/usr/share/doc/uml-utilities/README.Debian</filename>
- and the user-mode-linux documentation.
- (It's in a separate package, user-mode-linux-doc.)
+ user-mode-linux isn't completely trivial to set up. It would
+ probably be useful to acquaint yourself with it a bit before
+ attempting to use <command>rootstrap</command> or
+ <command>pbuilder-user-mode-linux</command>. For details,
+ read
+ <filename>/usr/share/doc/uml-utilities/README.Debian</filename>
+ and the <command>user-mode-linux</command> documentation. (It's in a separate
+ package, user-mode-linux-doc.)
</para>
<para>
<command>user-mode-linux</command> requires
@@ -609,7 +613,7 @@
</para>
</listitem>
<listitem>
- <para>Run <command>pbuilder-user-mode-linux create --distribution sid</command> to create the image.</para>
+ <para>Run <command>pbuilder-user-mode-linux <option>create --distribution sid</option></command> to create the image.</para>
</listitem>
<listitem>
<para>Try running <command>pbuilder-user-mode-linux build</command>.</para>
@@ -618,28 +622,30 @@
</para>
</sect1>
<sect1 id="consideruml">
- <title>Considerations for running pbuilder-uml</title>
+ <title>Considerations for running pbuilder-user-mode-linux</title>
<para>
- pbuilder-user-mode-linux emulates most of pbuilder, but there
+ <command>pbuilder-user-mode-linux</command> emulates most of <command>pbuilder</command>, but there
are some differences.
</para>
<itemizedlist>
<listitem>
<para>
- pbuilder-user-mode-linux does not support all options of pbuilder
+ <command>pbuilder-user-mode-linux</command> does not support all options of <command>pbuilder</command>
properly yet. This is a problem, and will be addressed as
specific areas are discovered.
</para>
</listitem>
<listitem>
<para>
- /tmp is handled differently inside pbuilder-uml.
- In pbuilder-uml, /tmp is mounted as tmpfs inside UML,
- so accessing files under /tmp from outside user-mode-linux
- does not work.
- It affects options like
- <command><option>--configfile</option></command>,
- and when trying to build packages placed under <filename>/tmp</filename>.
+ /tmp is handled differently inside
+ <command>pbuilder-user-mode-linux</command>. In
+ <command>pbuilder-user-mode-linux</command>,
+ <filename>/tmp</filename> is mounted as tmpfs inside UML,
+ so accessing files under <filename>/tmp</filename> from
+ outside user-mode-linux does not work. It affects options
+ like <command><option>--configfile</option></command>, and
+ when trying to build packages placed under
+ <filename>/tmp</filename>.
</para>
</listitem>
</itemizedlist>
@@ -647,8 +653,8 @@
<sect1 id="paralleluml">
<title>Parallel running of pbuilder-user-mode-linux</title>
<para>
- To run pbuilder-uml in parallel on a system, there are a few things
- to bear in mind.
+ To run <command>pbuilder-user-mode-linux</command> in parallel
+ on a system, there are a few things to bear in mind.
</para>
<itemizedlist>
<listitem>
@@ -657,9 +663,9 @@
</listitem>
<listitem>
<para>
- If you are not using slirp, UML processes which are
+ If you are not using slirp, user-mode-linux processes which are
running in parallel need to have different IP addresses.
- Just trying to run the <command>pbuilder-uml</command>
+ Just trying to run the <command>pbuilder-user-mode-linux</command>
several times will result in failure to access the network.
But something like the following will work:
<screen>
@@ -674,28 +680,31 @@
</itemizedlist>
</sect1>
<sect1 id="pbuilderumlwrap">
- <title>Using pbuilder-uml as a wrapper script to start up a virtual machine</title>
+ <title>Using pbuilder-user-mode-linux as a wrapper script to start up a virtual machine</title>
<para>
- It is possible to use pbuilder-uml for other uses than just building Debian
- packages.
- <command>pbuilder-user-mode-linux login</command>
- will let a user use a shell inside the user-mode-linux
- pbuilder base image,
- and <command>pbuilder-user-mode-linux execute</command> will
- allow the user to execute a script inside the image.
+ It is possible to use
+ <command>pbuilder-user-mode-linux</command> for other uses
+ than just building Debian packages.
+ <command>pbuilder-user-mode-linux
+ <option>login</option></command> will let a user use a shell
+ inside the user-mode-linux <command>pbuilder</command> base
+ image, and <command>pbuilder-user-mode-linux
+ <option>execute</option></command> will allow the user to
+ execute a script inside the image.
</para>
<para>
You can use the script to install ssh and add a new user,
- so that it is possible to access inside the UML through ssh.
+ so that it is possible to access inside the user-mode-linux through ssh.
</para>
<para>
Note that it is not possible to use a script from
- <filename>/tmp</filename> due to the way pbuilder-uml mounts
- a tmpfs at <filename>/tmp</filename>.
+ <filename>/tmp</filename> due to the way
+ <command>pbuilder-user-mode-linux</command> mounts a tmpfs at
+ <filename>/tmp</filename>.
</para>
<para>
The following example script may be useful in starting a sshd
- inside uml.
+ inside user-mode-linux.
</para>
<screen>
#!/bin/bash
@@ -724,33 +733,33 @@
<sect1>
<title>pbuilder create fails</title>
<para>
- It often happens that pbuilder cannot create the latest chroot.
- Try upgrading pbuilder and debootstrap.
+ It often happens that <command>pbuilder</command> cannot create the latest chroot.
+ Try upgrading <command>pbuilder</command> and debootstrap.
It is currently only possible to create software that handles the
past. Future prediction is a feature which may be added later after
we have become comfortable with the past.
</para>
<para>
- There are people who occasionally backport debootstrap to stable
+ There are people who occasionally back port debootstrap to stable
versions; hunt for them.
</para>
<para>
When there are errors with the debootstrap phase,
the debootstrap script needs to be fixed.
- pbuilder does not provide a way to work around debootstrap.
+ <command>pbuilder</command> does not provide a way to work around debootstrap.
</para>
</sect1>
<sect1 id="bindmountlimits">
<title>Directories that cannot be bind-mounted</title>
<para>
- Because of the way pbuilder works, there are several directories
- which cannot be bind-mounted when running pbuilder.
- The directories include <filename>/tmp</filename>,
- <filename>/var/cache/pbuilder</filename>,
- and system directories such as <filename>/etc</filename> and
- <filename>/usr</filename>.
- The recommendation is to use directories under the user's home directory
- for bind-mounts.
+ Because of the way <command>pbuilder</command> works, there
+ are several directories which cannot be bind-mounted when
+ running <command>pbuilder</command>. The directories include
+ <filename>/tmp</filename>,
+ <filename>/var/cache/pbuilder</filename>, and system
+ directories such as <filename>/etc</filename> and
+ <filename>/usr</filename>. The recommendation is to use
+ directories under the user's home directory for bind-mounts.
</para>
</sect1>
<sect1 id="modifyupdate">
@@ -769,20 +778,21 @@
$ sudo pbuilder update --hookdir ~/loginhooks/E10shell
</screen>
<para>
- It is also possible to add --save-after-exec
- and/or --save-after-login options
+ It is also possible to add <option>--save-after-exec</option>
+ and/or <option>--save-after-login</option> options
to the <command>pbuilder login</command> session
to accomplish the goal.
- It is possible to add the --uml-login-nocow option
- to <command>pbuilder-user-mode-linux login</command> session
+ It is possible to add the <option>--uml-login-nocow</option> option
+ to <command>pbuilder-user-mode-linux <option>login</option></command> session
as well.
</para>
</sect1>
<sect1 id="BUILDRESULTUID">
<title>Setting BUILDRESULTUID for sudo sessions</title>
<para>
- It is possible to set BUILDRESULTUID=$SUDO_UID in pbuilderrc
- to set the proper BUILDRESULTUID when using sudo.
+ It is possible to set
+ <screen>BUILDRESULTUID=$SUDO_UID</screen> in pbuilderrc to set
+ the proper BUILDRESULTUID when using <command>sudo</command>.
</para>
</sect1>
<sect1 id="tmpdir">
@@ -799,25 +809,25 @@
</para>
<para>
An example script is provided as
- <filename>examples/D10tmp</filename> with pbuilder.
+ <filename>examples/D10tmp</filename> with <command>pbuilder</command>.
</para>
</sect1>
<sect1 id="DISTRIBUTIONSWITCH">
- <title>Creating a shortcut for running pbuilder with a specific distribution</title>
+ <title>Creating a shortcut for running <command>pbuilder</command> with a specific distribution</title>
<para>
- When working with multiple chroots, it would be nice to work with
- scripts that reduce the amount of typing.
- An example script
Reached max line limit 500!
More information about the Pbuilder-maint
mailing list