2004-07-14 pbuilder-doc Usage and operations documentation in progress Junichi Uekawa pbuilder stands for Personal Builder, and it is a automatic Debian Package Building system for personal environments. pbuilder aims to be an easy-to-setup 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. Clean-room environment is achieved through use of a chroot image, so that only minimal packages will be installed inside the chroot. Debian distribution consists of free software accompanied with source. The source code within Debian "main" section must build within Debian "main", with only the explicitly specified build-dependencies installed. The primary aim of pbuilder is different from other auto-building systems in Debian by the fact that its aim is not in trying to build as many packages. It does not try to guess what a package needs, and in most cases it tries the worst choice of all if there was a choice to be made. In this way, pbuilder tries to ensure that packages tested against pbuilder will build properly in most Debian installations, hopefully resulting in a good overall Debian source-buildability. The goal of making Debian buildable from source is somewhat achieved, and has seen a good progress. It is known that Debian 3.0 is not quite buildable from source, but the next version should be better, and the version after. pbuilder create will create base chroot image. Distribution code-name needs to be specified with --distribution command-line option. Usually, "sid" is used. debootstrap is used to create the bare minimum Debian installation, and then build-essential packages are installed on top of the minimum installation using apt-get inside the chroot. For fuller documentation of command-line options, see pbuilder.8 manual page. Some configuration will be required for /etc/pbuilderrc for the mirror site The mirror site should preferably a local mirror or a cache server, to not to overload the public mirrors with a lot of access. Use of tools such as apt-proxy would be advisable. to use, and proxy configuration may be required to allow access through HTTP. See pbuilderrc.5 manual page for details. pbuilder update will update the chroot image. It will extract the chroot, invoke apt-get update and apt-get dist-upgrade inside the chroot, and then recreate the base tarball. It is possible to switch the distribution which the chroot tarball is targeted at at this point. Specify --distribution sid --override-config to change the distribution to sid. Only upgrading is supported. For fuller documentation of command-line options, see pbuilder.8 manual page To build a package inside the chroot, invoke pbuilder build whatever.dsc. pbuilder will extract chroot image to a temporal working directory, and satisfy the build-dependency inside the chroot, and build the package. The built packages will be moved to a directory specified with --buildresult command-line option. --basetgz option can be used to specify which chroot image to use. pbuilder will extract a fresh chroot image created with pbuilder build and updated with pbuilder update, and populate the chroot with build-dependency by parsing debian/control and invoking apt-get. For fuller documentation of command-line options, see pbuilder.8 manual page pdebuild is a little wrapper script that does the most frequent of all tasks. A Debian Developer may try to do debuild, and build a package, inside a Debian source directory. pdebuild will allow similar control, and allow package to be built inside the chroot, to check that the current source tree will build happily inside the chroot. pdebuild calls dpkg-source to build the source packages, and then invoke pbuilder on the resulting source package. However, unlike debuild, the resulting deb files will be found somewhere in BUILDRESULT directory. See pdebuild.1 manual page for more details. There is a slightly different mode of operation available in pdebuild since version 0.97. pdebuild usually runs debian/rules clean outside of chroot, however, it is possible to change the behavior to run it inside chroot with --use-pdebuild-internal. It will try to bind mount the working directory inside chroot, and run dpkg-buildpackage inside. It has the following characteristics, and thus cannot be made default. The working directory is modified from inside chroot. Building with pdebuild does not guarantee that it works with pbuilder If making source package fails, the session using the chroot is wasted (chroot creation is takes a bit of time). Does not work in the same manner as it used to, such as --buildresult does not have an effect It is possible to specify all settings by command-line option. However, for typing convenience it is possible to use a configuration file. /etc/pbuilderrc and ${HOME}/.pbuilderrc are read in when pbuilder is invoked. The possible options are documented in pbuilderrc.5 manual page. It is useful when switching between configuration files for different distributions. pbuilder requires full root privilege when it is satisfying the build-dependency but most packages do not need root privilege, or fail to build when they are root. pbuilder can create a user which is only used inside pbuilder and use that user id when building, and use fakeroot command when root privilege is required. BUILDUSERID 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 pbuilder to affect the environment outside the chroot. When BUILDUSERNAME is also set, pbuilder will use that user id and fakeroot for building packages. Using the fakerooting method, pbuilder will run with root privilege when it is required, when installing packages to the chroot. To be able to invoke pbuilder without being root, you need to use user-mode-linux, as explained in . pbuilder can be used for back-porting software from the latest Debian distribution to older stable distribution, by using a chroot that contains image of older distribution, and building packages inside the chroot. There are several points to consider, and due to the following reasons, automatic back-porting is usually not possible, and manual interaction is required: Build-Dependency in stable may not be enough to build a package in unstable distribution, so package may need more than what exists in stable Stable distribution may have bugs that have been fixed in unstable that needs to be worked around. Package in unstable distribution may have problem building even for unstable. pbuilder can be automated, because its operations are non-interactive. It is possible to run pbuilder through multiple packages non-interactively. There are several such scripts known to exist. Junichi Uekawa has been running such script since 2001, and has been filing bugs on packages that fail the test of pbuilder. There were several problems with auto-building: Build-Dependency needs to install non-interactively, but some packages are so broken that they cannot install without interaction (like postgresql) When a library package breaks, or gcc/gcj/g++ breaks, or even bison, a large number of build failure are reported. (gcj-3.0 which had no "javac", bison which got more strict, etc.) Some people were quite hostile against build failure reports. But most of these problems are now getting solved. Only about 10% of Debian now fail to build from source (29 Dec 2002). A script that was used by Junichi Uekawa is now included in pbuilder distribution, as pbuildd.sh. It is available in /usr/share/doc/pbuilder/examples/pbuildd/ and its configuration is in /etc/pbuilder/pbuildd-config.sh. 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 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, or improved on the script considerably. To set up pbuildd, there are some points to be aware of. A file ./avoidlist needs to be available with the list of packages to avoid building. It will try building anything, even packages that are not aimed for your architecture Because you are running random build scripts, it is better to use fakeroot option of pbuilder, to avoid running build in root privilege Because not all builds are guaranteed to finish in a finite time, setting timeout is probably necessary, or build may stall with a bad build 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 it otherwise, please inform the maintainer of this documentation. There are some people who use pbuilder to automatically back-port a subset of packages to the stable distribution. 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. pbuilder 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 can be done. Some known tests and ideas: Automatic install-remove-upgrade-remove-install-purge-upgrade-purge testsuite (distributed as an example, B91dpkg-i), or just check that everything installs somewhat (execute_installtest.sh) Automatically running lintian/linda (distributed as an example in /usr/share/doc/pbuilder/examples/B90linda) Automatic debian-test of the package? debian-test package has been removed from Debian. Most packages are compiled with gcc or g++ and using 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 gcc-3.2 for gcc compiler version 3.2. It was therefore possible to try compiling packages against different compiler versions. pentium-builder provides an infrastructure for using different compiler for building packages than the default gcc, by becoming a wrapper script called gcc, that calls the real gcc. To use pentium-builder in pbuilder, it is possible to set up the following in the configuration: EXTRAPACKAGES="pentium-builder gcc-3.2 g++-3.2" export DEBIAN_BUILDARCH=athlon export DEBIAN_BUILDGCCVER=3.2 It will instruct pbuilder to install pentium-builder package and also the GCC 3.2 compiler packages inside the chroot, and set the environment variables required for pentium-builder to function. pbuilder-uml exists. Invoking that command instead of pbuilder it is possible to use user-mode-linux. The advantage of using user-mode-linux is that it does not require root privilege to run, and it does Copy-on-write, which is probably much faster than conventional pbuilder method. The problem is that this relies on User-mode-linux which is a relatively new project, and has not quite matured, as opposed to conventional pbuilder which rely on chroot and tar and gzip, which are known to work on most Unix systems. However, pbuilder-uml uses COW method for file access, and it is so much more faster than pbuilder when building most packages. It has been verified that pbuilder-uml works, as of version 0.59. And since then, pbuilder-uml has seen a rapid evolution. The configuration of pbuilder-uml goes in three steps: Configuration of user-mode-linux Configuration of rootstrap Configuration of pbuilder-uml user-mode-linux requires the user to be in uml-net group in order to configure the network unless you are using slirp. Read /usr/share/doc/uml-utilities/README.Debian for details. rootstrap is a program that is a wrapper to debootstrap, creating a Debian disk image inside UML. To configure rootstrap, there are several requirements. install rootstrap package TUN/TAP only: add the user to uml-net group to allow access to network adduser dancer uml-net TUN/TAP only: Check that compile supports tun/tap interface, and recompile the kernel if necessary Set up /etc/rootstrap/rootstrap.conf, for example, if the current host is 192.168.1.2, changing following entries to something like this seems to work. transport=tuntap interface=eth0 gateway=192.168.1.1 mirror=http://192.168.1.2:8081/debian host=192.168.1.198 uml=192.168.1.199 netmask=255.255.255.0 Some experimentation with configuration and running rootstrap ~/test.uml to actually test it would be handy. Using slirp requires less configuration. The default configuration comes with a working example. The following needs to happen: install pbuilder-uml package Set configuration file /etc/pbuilder/pbuilder-uml.conf in the following manner. It will be different for slirp. MY_ETH0=tuntap,,,192.168.1.198 UML_IP=192.168.1.199 UML_NETMASK=255.255.255.0 UML_NETWORK=192.168.1.0 UML_BROADCAST=255.255.255.255 UML_GATEWAY=192.168.1.1 PBUILDER_UML_IMAGE="/home/dancer/uml-image" and it needs to match rootstrap configuration. Make sure BUILDPLACE is writable by the user. Change BUILDPLACE in the configuration file to a place where the user can access. Run pbuilder-user-mode-linux create --distribution sid to create the image Try running pbuilder-user-mode-linux build pbuilder-user-mode-linux emulates most of pbuilder, but there are some differences. pbuilder-user-mode-linux does not support all options of pbuilder properly yet. This is a problem, and will be addressed as specific areas are discovered. /tmp is handled differently inside pbuilder-uml. In pbuilder-uml, /tmp is mounted as tmpfs inside UML, so accessing files under /tmp from outside the user-mode-linux does not work. It affects options like --configfile, and when trying to build packages placed under /tmp. To run pbuilder-uml parallel on a system, there are a few things to bear in mind. create and update methods must not be ran when build is in progress, or COW file will be invalid If you are not using slirp, UML processes that are running in parallel needs to have different IP addresses. So, something like the following will work, for IP in 102 103 104 105; do xterm -e pbuilder-user-mode-linux build --uml-ip 192.168.0.$IP 20030107/whizzytex_1.1.1-1.dsc& done but just trying to run pbuilder-uml several times will result in failure to access the network. When using slirp, this problem does not exist. It is possible to use pbuilder-uml for other uses than just building Debian packages. pbuilder-user-mode-linux login will let a user use a shell inside the user-mode-linux using the pbuilder base image, and pbuilder-user-mode-linux execute will allow the user to execute a script inside the chroot. 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. Note that it is not possible to use a script from /tmp due to the way pbuilder-uml mounts tmpfs at /tmp. The following is an example script that may be useful in starting a sshd inside uml. #!/bin/bash apt-get install -y ssh xbase-clients xterm echo "enter root password" passwd cp /etc/ssh/sshd_config{,-} cat /etc/ssh/sshd_config- | sed 's/X11Forwarding.*/X11Forwarding yes/' > /etc/ssh/sshd_config /etc/init.d/ssh restart ifconfig echo "Hit enter to finish" read Here, known problems and frequently asked questions are documented. This portion was initially available in README.Debian file, but moved into here. It often happens that pbuilder cannot create latest chroot. Try upgrading pbuilder 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. There are people who occasionally backport debootstrap to stable versions, hunt for them. When there are errors with debootstrap phase, debootstrap script needs to be fixed. pbuilder does not provide a way to work around debootstrap. Because of the way pbuilder works, there are several directories that pbuilder will not function properly if they are bind-mounted. The directories include /tmp, /var/cache/pbuilder, and system directories such as /etc and /usr. The recommendation is to use directories from under user home directory for bind-mounts. It is sometimes necessary to modify the chroot environment. login will remove the contents of the chroot after logout. It is possible to invoke shell using hook scripts. pbuilder update executes 'E' scripts, and a sample for invoking shell is provided as C10shell. $ mkdir ~/loginhooks $ cp C10shell ~/loginhooks/E10shell $ sudo pbuilder update --hookdir ~/loginhooks/E10shell It is also possible to add --save-after-exec, --save-after-login option to pbuilder login session to achieve the goal. Also, it is possible to add --uml-login-nocow option to pbuilder-user-mode-linux login session. It is possible to set BUILDRESULTUID=$SUDO_UID in pbuilderrc to set the proper BUILDRESULTUID when using sudo. If you are setting $TMPDIR to an unusual value, of other than /tmp, you will find that some errors may occur inside the chroot, such as dpkg-source failing. There are two options, you may install a hook to create that directory, or set export TMPDIR=/tmp in pbuilderrc. Take your pick. An example script is provided as examples/D10tmp with pbuilder. When working with multiple chroots, it would be nice to work with scripts that facilitate the amount of typing. An example script pbuilder-distribution.sh is provided as an example. Invoking the script as pbuilder-woody will invoke pbuilder for woody chroot. If you have some very specialized requirements on your apt setup inside pbuilder, it is possible to specify that through --othermirror option. Try something like: --othermirror "deb http://local/mirror stable main|deb-src http://local/source/repository ./" To use the local filesystem instead of http, it is necessary to do bind-mounting. --bindmounts is a command-line option useful for such cases. You can use hook scripts for this. D scripts are run before satisfying build-dependency. To make distinguishing bash prompts inside pbuilder easier, it is possible to set environmental variables such as PS1 inside pbuilderrc With versions of bash more recent than 2.05b-2-15, debian_chroot variable can be set to specify the name of chroot which is incorporated to create PS1. On prior versions of bash Versions of bash from and before Debian 3.0 it setting PS1 in pbuilderrc worked. example of debian_chroot export debian_chroot="pbuild$$" example os PS1 export PS1="pbuild chroot 32165 # " For the help of low-bandwidth systems, it is possible to use /var/cache/apt/archives as the package cache. Just specify it instead of the default /var/cache/pbuilder/aptcache. It is however not possible to do so currently with user-mode-linux version of pbuilder, because /var/cache/apt/archives is usually only writable as root. Use of dedicated tools such as apt-proxy is recommended, since caching of packages would benefit the system outside the scope of pbuilder. It is known that Brian May does a backport of pbuilder, available at: deb http://www.microcomaustralia.com.au/debian/ woody main You might see a lot of warning messages when running pbuilder. dpkg-genchanges: warning: no utmp entry available and LOGNAME not defined; using uid of process (1234) It is currently safe to ignore this warning message. Please report back if you find any problem with having LOGNAME unset. Setting LOGNAME caused a few problems when invoking chroot. pbuilder does not currently allow Build-Conflicts against essential packages. It should be obvious that essential packages should not be removed from a working Debian system, and a source package should not try to force removal of such packages to people building the package. By default, pbuilder uses hard links to manage pbuilder package cache. It is not possible to make hard links across different devices; and thus this error will occur, depending on your set up. If this happens, set APTCACHEHARDLINK=no in your pbuilderrc file. It is possible to use fakechroot instead of being root to run pbuilder; however, several things make this impractical. fakechroot overrides library loads and tries to override default libc functions when providing the functionality of virtual chroot. However, some binaries do no use libc to function, or override the overriding provided by fakechroot. One example is ldd. ldd outout inside fakechroot will check the library dependency outside of chroot; which is not the expected behavior. To work around the problem fakechroot provides a patch for debootstrap. Use that, so that ldd and ldconfig are overridden. Make sure you have set your path correctly, as described in /usr/share/doc/fakechroot/README.Debian To use debconf inside pbuilder, setting DEBIAN_FRONTEND to readline in pbuilderrc should work. Setting it to dialog should also work, but make sure whiptail or dialog is installed inside the chroot. If you see messages such as this in building chroot, you are mounting the filesystem with nodev option. /var/lib/dpkg/info/base-files.postinst: /dev/null: Permission denied You will also have problems if you mount the filesystem with noexec option, or nosuid. Make sure you do not have these flags set when mounting the filesystem for /var/cache/pbuilder; or $BUILDPLACE. This is not a problem on User-mode-linux. pbuilder is often slow. The slowest part of pbuilder is extracting of tar.gz every time pbuilder is invoked. That can be avoided by using pbuilder-user-mode-linux. pbuilder-user-mode-linux uses COW filesystem, and thus does not need to clean up and recreate the root filesystem. pbuilder-user-mode-linux is slower in executing the actual build system, due to the usual user-mode-linux overhead for system calls. It is more friendly to the hard drive. You may want a sign that you are inside a chroot, when working with chroot. Check out examples/F90chrootmemo hook script. It will create a file called /CHROOT inside your chroot. There are cases when some small experimenting is required, and do not want to damage the main system, like installing experimental library packages, or compiling with experimental compilers. For such cases, pbuilder login command is available. pbuilder login is a debugging feature for pbuilder itself, but it also allows users to have a temporal chroot. Note that chroot is cleaned after logging out of the shell, and mounting file systems inside it is considered harmful. To facilitate using pbuilder for other uses, pbuilder execute is available. pbuilder execute will take a script specified in the command-line argument, and invoke the script inside the chroot. The script can be useful for sequence of operations such as installing ssh and adding a new user inside the chroot. There are some advanced features, above that of the basic feature of pbuilder, for some specific purposes. LVM has snapshot function that features Copy-on-write images. That could be used for pbuilder just it can be used for user-mode-linux pbuilder port. It may prove to be faster, but it is not implemented yet, and so no measurement has been made, yet. Since user-mode-linux port seems to be more interesting, this is abandoned. --no-targz option of pbuilder will allow usage of pbuilder in a different way to conventional usage. It will try to use existing chroot, and will not try to clean up after working on it. It is an operation mode more like sbuild. It should be possible to create chroot images for dchroot with following commands: # pbuilder create --distribution potato --no-targz --basetgz /chroot/potato # pbuilder create --distribution woody --no-targz --basetgz /chroot/woody # pbuilder create --distribution sid --no-targz --basetgz /chroot/sid This document is started on 28 Dec 2002 by Junichi Uekawa, trying to document what is known about pbuilder. This documentation is available from pbuilder source tarball, and from CVS repository of pbuilder (a web-based acces is possible). A copy of this documentation can be found in Netfort page for pbuilder. The homepage for pbuilder is http://www.netfort.gr.jp/~dancer/software/pbuilder.html The following is most possibly inaccurate account of how pbuilder happened to come, and other attempts to make something like pbuilder to happen. This part of document was originally in AUTHORS file, to give credit to those who existed before pbuilder. There were dbuild, which was a shell script to build 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. 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 references to it on the net, and mailing list logs. sbuild is a perl script to build Debian package from source. It parses Build-Dependency, and performs other misc checks, 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 use of local database for packages which do not have build-dependency. 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 in Debian buildd system. I think it was maintained mostly by Ryan Murray. wanna-build (sbuild) was (at the time of year 2001) quite difficult to set up, and it was never a Debian package. dbuild was something that predated Build-Depends. Building package from source using Build-Depends information within a chroot sounded trivial; and pbuilder was born. It was initially a shell script with only a few lines, which called debootstrap and chroot and dpkg-buildpackage in the same run, but soon, it was decided that's too slow. Yes, and it took almost an 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 pbuilder, but the amount of packages which are not buildable are steadily decreasing. (I hope) And someone wanted pbuilder to run as not root, and User-mode-linux has become more useful as time passed, I've started experimenting with pbuilder-uml. pbuilder-uml has not been able to run as often as it should, and bootstrapping user-mode-linux environment has been pretty hard. The third year is already there. pbuilder is widely adopted, and activity is focused on fixing minor problems. Some features are added, but most was filling the missing portions for user-mode-linux port.