Debian Packaging Tutorial

Lucas Nussbaum
[email protected]

version 0.15 2014-10-16

Debian Packaging Tutorial

1 / 86

About this tutorial

I

Goal: tell you what you really need to know about Debian packaging
I

Modify existing packages

Create your own packages

Interact with the Debian community

Become a Debian power-user

Covers the most important points, but is not complete

I You will need to read more documentation

Most of the content also applies to Debian derivative distributions

I

That includes Ubuntu

Debian Packaging Tutorial

2 / 86

Outline
1

Introduction

Creating source packages

Building and testing packages

Practical session 1: modifying the grep package

Advanced packaging topics

Maintaining packages in Debian

Conclusions

Practical session 2: packaging GNUjump

Practical session 3: packaging a Java library

10

Practical session 4: packaging a Ruby gem

11

Practical session 5: packaging a Perl module

Debian Packaging Tutorial

3 / 86

Outline
1

Introduction

Creating source packages

Building and testing packages

Practical session 1: modifying the grep package

Advanced packaging topics

Maintaining packages in Debian

Conclusions

Practical session 2: packaging GNUjump

Practical session 3: packaging a Java library

10

Practical session 4: packaging a Ruby gem

11

Practical session 5: packaging a Perl module

Debian Packaging Tutorial

4 / 86

Debian
I

GNU/Linux distribution

1st major distro developed openly in the spirit of GNU

Non-commercial, built collaboratively by over 1,000 volunteers

3 main features:
I Quality culture of technical excellence
We release when its ready

Freedom devs and users bound by the Social Contract

Promoting the culture of Free Software since 1993

Independence no (single) company babysitting Debian

And open decision-making process (do-ocracy + democracy )

Amateur in the best sense: done for the love of it

Debian Packaging Tutorial

5 / 86

Debian packages

.deb files (binary packages)

A very powerful and convenient way to distribute software to users

One of the two most common package formats (with RPM)

Universal:
I 30,000 binary packages in Debian
most of the available free software is packaged in Debian!
I

For 12 ports (architectures), including 2 non-Linux (Hurd; KFreeBSD)

Also used by 120 Debian derivative distributions

Debian Packaging Tutorial

6 / 86

The Deb package format

I

.deb file: an ar archive

$ ar tv wget_1 .12 -2.1 _i386 . deb
rw -r - -r - - 0/0
4 Sep 5 15:43 2010 debian - binary
rw -r - -r - - 0/0
2403 Sep 5 15:43 2010 control . tar . gz
rw -r - -r - - 0/0 751613 Sep 5 15:43 2010 data . tar . gz

debian-binary: version of the deb file format, "2.0\n"

control.tar.gz: metadata about the package

data.tar.gz: data files of the package

control, md5sums, (pre|post)(rm|inst), triggers, shlibs, . . .

You could create your .deb files manually

http://tldp.org/HOWTO/html_single/Debian-Binary-Package-Building-HOWTO/

But most people dont do it that way

This tutorial: create Debian packages, the Debian way

Debian Packaging Tutorial

7 / 86

Tools you will need

I

A Debian (or Ubuntu) system (with root access)

Some packages:
I build-essential: has dependencies on the packages that will be
assumed to be available on the developers machine (no need to
specify them in the Build-Depends: control field of your package)
I includes a dependency on dpkg-dev, which contains basic
Debian-specific tools to create packages
I

devscripts: contains many useful scripts for Debian maintainers

Many other tools will also be mentioned later, such as debhelper, cdbs, quilt,
pbuilder, sbuild, lintian, svn-buildpackage, git-buildpackage, . . .
Install them when you need them.

Debian Packaging Tutorial

8 / 86

General packaging workflow

Debian mirror
apt-get source

Web

upstream source

dget

dh_make

source package

where most of the

manual work is done

debuild (build and test with lintian)

or dpkg-buildpackage
one or several binary packages
upload (dput)

.deb

install (debi)

Debian Packaging Tutorial

9 / 86

Example: rebuilding dash

1

Install packages needed to build dash, and devscripts

sudo apt-get build-dep dash
(requires deb-src lines in /etc/apt/sources.list)
sudo apt-get install --no-install-recommends devscripts
fakeroot

Create a working directory, and get in it:

mkdir /tmp/debian-tutorial ; cd /tmp/debian-tutorial

Grab the dash source package

apt-get source dash
(This needs you to have deb-src lines in your /etc/apt/sources.list)

Build the package

cd dash-*
debuild -us -uc

(-us -uc disables signing the package with GPG)

Check that it worked

I There are some new .deb files in the parent directory

Look at the debian/ directory

I Thats where the packaging work is done
Debian Packaging Tutorial

10 / 86

Outline
1

Introduction

Creating source packages

Building and testing packages

Practical session 1: modifying the grep package

Advanced packaging topics

Maintaining packages in Debian

Conclusions

Practical session 2: packaging GNUjump

Practical session 3: packaging a Java library

10

Practical session 4: packaging a Ruby gem

11

Practical session 5: packaging a Perl module

Debian Packaging Tutorial

11 / 86

Source package
I

One source package can generate several binary packages

e.g. the libtar source generates the libtar0 and libtar-dev binary packages

Two kinds of packages: (if unsure, use non-native)

I
I

Native packages: normally for Debian specific software (dpkg, apt)

Non-native packages: software developed outside Debian

Main file: .dsc (meta-data)

Other files depending on the version of the source format

I 1.0 or 3.0 (native): package_version.tar.gz
I

1.0 (non-native):
I pkg_ver.orig.tar.gz: upstream source
I pkg_debver.diff.gz: patch to add Debian-specific changes

3.0 (quilt):
I pkg_ver.orig.tar.gz: upstream source
I pkg_debver.debian.tar.gz: tarball with the Debian changes

(See dpkg-source(1) for exact details)

Debian Packaging Tutorial

12 / 86

Source package example (wget_1.12-2.1.dsc)

Format : 3.0 ( quilt )
Source : wget
Binary : wget
Architecture : any
Version : 1.12 -2.1
Maintainer : Noel Kothe < noel@debian . org >
Homepage : http :// www . gnu . org / software / wget /
Standards - Version : 3.8.4
Build - Depends : debhelper ( > > 5.0.0) , gettext , texinfo ,
libssl - dev ( >= 0.9.8) , dpatch , info2man
Checksums - Sha1 :
50 d4ed2441e67 [..]1 ee0e94248 2464747 wget_1 .12. orig . tar . gz
d4c1c8bbe431d [..] dd7cef3611 48308 wget_1 .12 -2.1. debian . tar . gz
Checksums - Sha256 :
7578 ed0974e12 [..] dcba65b572 2464747 wget_1 .12. orig . tar . gz
1 e9b0c4c00eae [..]89 c402ad78 48308 wget_1 .12 -2.1. debian . tar . gz
Files :
141461 b9c04e4 [..]9 d1f2abf83 2464747 wget_1 .12. orig . tar . gz
e93123c934e3c [..]2 f380278c2 48308 wget_1 .12 -2.1. debian . tar . gz

Debian Packaging Tutorial

13 / 86

Retrieving an existing source package

I

From the Debian archive:

I apt-get source package
I apt-get source package=version
I apt-get source package/release
(You need deb-src lines in sources.list)

From the Internet:

I dget url-to.dsc
I dget http://snapshot.debian.org/archive/debian-archive/
20090802T004153Z/debian/dists/bo/main/source/web/
wget_1.4.4-6.dsc
(snapshot.d.o provides all packages from Debian since 2005)

From the (declared) version control system:

I debcheckout package

Once downloaded, extract with dpkg-source -x file.dsc

Debian Packaging Tutorial

14 / 86

Creating a basic source package

I

Download the upstream source

(upstream source = the one from the softwares original developers)

Rename to <source_package >_<upstream_version >.orig.tar.gz

(example: simgrid_3.6.orig.tar.gz)

Untar it

Rename the directory to <source_package >-<upstream_version >

(example: simgrid-3.6)

cd <source_package >-<upstream_version > && dh_make

(from the dh-make package)

There are some alternatives to dh_make for specific sets of packages:

dh-make-perl, dh-make-php, . . .

debian/ directory created, with a lot of files in it

Debian Packaging Tutorial

15 / 86

Files in debian/
All the packaging work should be made by modifying files in debian/
I

Main files:
I control meta-data about the package (dependencies, etc.)
I rules specifies how to build the package
I copyright copyright information for the package
I changelog history of the Debian package

Other files:
I compat
I watch
I dh_install* targets
*.dirs, *.docs, *.manpages, . . .
I

maintainer scripts
*.postinst, *.prerm, . . .

I
I

source/format
patches/ if you need to modify the upstream sources

Several files use a format based on RFC 822 (mail headers)

Debian Packaging Tutorial

16 / 86

debian/changelog
I
I

Lists the Debian packaging changes

Gives the current version of the package

1.2.1.1-5
Upstream Debian
version revision
I

Edited manually or with dch

I Create a changelog entry for a new release: dch -i
Special format to automatically close Debian or Ubuntu bugs
Debian: Closes: #595268; Ubuntu: LP: #616929
Installed as /usr/share/doc/package /changelog.Debian.gz

mpich2 (1.2.1.1 -5) unstable ; urgency = low

* Use / usr / bin / python instead of / usr / bin / python2 .5. Allow
to drop dependency on python2 .5. Closes : #595268
* Make / usr / bin / mpdroot setuid . This is the default after
the installation of mpich2 from source , too . LP : #616929
+ Add corresponding lintian override .
-- Lucas Nussbaum < lucas@debian . org >

Wed , 15 Sep 2010 18:13:44 +0200

Debian Packaging Tutorial

17 / 86

debian/control
I

Package metadata
I For the source package itself
I For each binary package built from this source

Package name, section, priority, maintainer, uploaders,

build-dependencies, dependencies, description, homepage, . . .

Documentation: Debian Policy chapter 5

http://www.debian.org/doc/debian-policy/ch-controlfields

Source : wget
Section : web
Priority : important
Maintainer : Noel Kothe < noel@debian . org >
Build - Depends : debhelper ( > > 5.0.0) , gettext , texinfo ,
libssl - dev ( >= 0.9.8) , dpatch , info2man
Standards - Version : 3.8.4
Homepage : http :// www . gnu . org / software / wget /
Package : wget
Architecture : any
Depends : $ { shlibs : Depends } , $ { misc : Depends }
Description : retrieves files from the web
Wget is a network utility to retrieve files from the Web
Debian Packaging Tutorial

18 / 86

Architecture: all or any

Two kinds of binary packages:
I

Packages with different contents on each Debian architecture

I Example: C program
I Architecture: any in debian/control
I Or, if it only works on a subset of architectures:
Architecture: amd64 i386 ia64 hurd-i386
I buildd.debian.org: builds all the other architectures for you on upload
I Named package _version _architecture.deb

Packages with the same content on all architectures

I Example: Perl library
I Architecture: all in debian/control
I Named package _version _all.deb

A source package can generate a mix of Architecture: any and

Architecture: all binary packages
Debian Packaging Tutorial

19 / 86

debian/rules
I

Makefile

Interface used to build Debian packages

Documented in Debian Policy, chapter 4.8

http://www.debian.org/doc/debian-policy/ch-source#s-debianrules

Required targets:
I build, build-arch, build-indep: should perform all the
configuration and compilation
I

binary, binary-arch, binary-indep: build the binary packages

I dpkg-buildpackage will call binary to build all the packages, or
binary-arch to build only the Architecture: any packages

clean: clean up the source directory

Debian Packaging Tutorial

20 / 86

Packaging helpers debhelper

I

You could write shell code in debian/rules directly

I See the adduser package for example

Better practice (used by most packages): use a Packaging helper

Most popular one: debhelper (used by 98% of packages)

Goals:
I Factor the common tasks in standard tools used by all packages
I Fix some packaging bugs once for all packages
dh_installdirs, dh_installchangelogs, dh_installdocs, dh_installexamples, dh_install,
dh_installdebconf, dh_installinit, dh_link, dh_strip, dh_compress, dh_fixperms, dh_perl,
dh_makeshlibs, dh_installdeb, dh_shlibdeps, dh_gencontrol, dh_md5sums, dh_builddeb, . . .
I
I

Called from debian/rules

Configurable using command parameters or files in debian/

package.docs, package.examples, package.install, package.manpages, ...

I

Third-party helpers for sets of packages: python-support, dh_ocaml, . . .

Gotcha: debian/compat: Debhelper compatibility version (use "7")

Debian Packaging Tutorial

21 / 86

debian/rules using debhelper (1/2)

#!/ usr / bin / make -f
# Uncomment this to turn on verbose mode .
# export DH_VERBOSE =1
build :
$ ( MAKE )
# docbook - to - man debian / packagename . sgml > packagename .1
clean :
dh_testdir
dh_testroot
rm -f build - stamp configure - stamp
$ ( MAKE ) clean
dh_clean

install : build
dh_testdir
dh_testroot
dh_clean -k
dh_installdirs
# Add here commands to install the package into debian / package
$ ( MAKE ) DESTDIR = $ ( CURDIR )/ debian / packagename install
Debian Packaging Tutorial

22 / 86

debian/rules using debhelper (2/2)

# Build architecture - independent files here .
binary - indep : build install
# Build architecture - dependent files here .
binary - arch : build install
dh_testdir
dh_testroot
dh_installchangelogs
dh_installdocs
dh_installexamples
dh_install
dh_installman
dh_link
dh_strip
dh_compress
dh_fixperms
dh_installdeb
dh_shlibdeps
dh_gencontrol
dh_md5sums
dh_builddeb
binary : binary - indep binary - arch
. PHONY : build clean binary - indep binary - arch binary install configure
Debian Packaging Tutorial

23 / 86

CDBS
I

With debhelper, still a lot of redundancy between packages

Second-level helpers that factor common functionality

I E.g. building with ./configure && make && make install or
CMake

CDBS:
I Introduced in 2005, based on advanced GNU make magic
I Documentation: /usr/share/doc/cdbs/
I Support for Perl, Python, Ruby, GNOME, KDE, Java, Haskell, . . .
I But some people hate it:
I Sometimes difficult to customize package builds:
"twisty maze of makefiles and environment variables"
I Slower than plain debhelper (many useless calls to dh_*)

#!/ usr / bin / make -f

include / usr / share / cdbs /1/ rules / debhelper . mk
include / usr / share / cdbs /1/ class / autotools . mk
# add an action after the build
build / mypackage ::
/ bin / bash debian / scripts / foo . sh
Debian Packaging Tutorial

24 / 86

Dh (aka Debhelper 7, or dh7)

I

Introduced in 2008 as a CDBS killer

dh command that calls dh_*

Simple debian/rules, listing only overrides

Easier to customize than CDBS

Doc: manpages (debhelper(7), dh(1)) + slides from DebConf9 talk

http://kitenet.net/~joey/talks/debhelper/debhelper-slides.pdf

#!/ usr / bin / make -f

%:
dh $@
override_dh_auto_configure :
d h _ a u t o _ c o n f i g u r e -- -- with - kitchen - sink
override_dh_auto_build :
make world

Debian Packaging Tutorial

25 / 86

Classic debhelper vs CDBS vs dh

I

Mind shares:
Classic debhelper: 27%

CDBS: 18%

dh: 54%

Which one should I learn?

I Probably a bit of all of them
I You need to know debhelper to use dh and CDBS
I You might have to modify CDBS packages

Which one should I use for a new package?

I dh (only solution with an increasing mind share)
Market share (%)

debhelper
dh
CDBS

60

40

20

02/2010

06/2011

11/2012

Time
Debian Packaging Tutorial

26 / 86

Outline
1

Introduction

Creating source packages

Building and testing packages

Practical session 1: modifying the grep package

Advanced packaging topics

Maintaining packages in Debian

Conclusions

Practical session 2: packaging GNUjump

Practical session 3: packaging a Java library

10

Practical session 4: packaging a Ruby gem

11

Practical session 5: packaging a Perl module

Debian Packaging Tutorial

27 / 86

Building packages
I

apt-get build-dep mypackage

Installs the build-dependencies (for a package already in Debian)
Or mk-build-deps -ir (for a package not uploaded yet)

debuild: build, test with lintian, sign with GPG

Also possible to call dpkg-buildpackage directly

I Usually with dpkg-buildpackage -us -uc

It is better to build packages in a clean & minimal environment

I pbuilder helper to build packages in a chroot
Good documentation: https://wiki.ubuntu.com/PbuilderHowto
(optimization: cowbuilder ccache distcc)
I

schroot and sbuild: used on the Debian build daemons

(not as simple as pbuilder, but allows LVM snapshots
see: https://help.ubuntu.com/community/SbuildLVMHowto )

Generates .deb files and a .changes file

I .changes: describes what was built; used to upload the package
Debian Packaging Tutorial

28 / 86

Installing and testing packages

I

Install the package locally: debi (will use .changes to know what to install)

List the content of the package: debc ../mypackage<TAB>.changes

Compare the package with a previous version:

debdiff ../mypackage_1_*.changes ../mypackage_2_*.changes
or to compare the sources:
debdiff ../mypackage_1_*.dsc ../mypackage_2_*.dsc

Check the package with lintian (static analyzer):

lintian ../mypackage<TAB>.changes
lintian -i: gives more information about the errors
lintian -EviIL +pedantic: shows more problems

Upload the package to Debian (dput) (needs configuration)

Manage a private Debian archive with reprepro

Documentation: http://mirrorer.alioth.debian.org/

Debian Packaging Tutorial

29 / 86

Outline
1

Introduction

Creating source packages

Building and testing packages

Practical session 1: modifying the grep package

Advanced packaging topics

Maintaining packages in Debian

Conclusions

Practical session 2: packaging GNUjump

Practical session 3: packaging a Java library

10

Practical session 4: packaging a Ruby gem

11

Practical session 5: packaging a Perl module

Debian Packaging Tutorial

30 / 86

Practical session 1: modifying the grep package

1

Go to http://ftp.debian.org/debian/pool/main/g/grep/ and
download version 2.6.3-3 of the package (if you use Ubuntu 11.10 or later,
or Debian testing or unstable, use version 2.9-1 or 2.9-2 instead)
I If the source package is not unpacked automatically, unpack it with
dpkg-source -x grep_*.dsc
Look at the files in debian/.
I How many binary packages are generated by this source package?
I Which packaging helper does this package use?

Build the package

We are now going to modify the package. Add a changelog entry and
increase the version number.

Now disable perl-regexp support (it is a ./configure option)

Rebuild the package

Compare the original and the new package with debdiff

Install the newly built package

Cry if you messed up ;)

Debian Packaging Tutorial

31 / 86

Outline
1

Introduction

Creating source packages

Building and testing packages

Practical session 1: modifying the grep package

Advanced packaging topics

Maintaining packages in Debian

Conclusions

Practical session 2: packaging GNUjump

Practical session 3: packaging a Java library

10

Practical session 4: packaging a Ruby gem

11

Practical session 5: packaging a Perl module

Debian Packaging Tutorial

32 / 86

debian/copyright
I

Copyright and license information for the source and the packaging

Traditionally written as a text file

New machine-readable format:

http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/

Format : http :// www . debian . org / doc / packaging - manuals / copyright - format /1.0/
Upstream - Name : X Solitaire
Source : ftp :// ftp . example . com / pub / games
Files : *
Copyright : Copyright 1998 John Doe < jdoe@example . com >
License : GPL -2+
This program is free software ; you can redistribute it
[...]
.
On Debian systems , the full text of the GNU General Public
License version 2 can be found in the file
/ usr / share / common - licenses / GPL -2 .
Files : debian /*
Copyright : Copyright 1998 Jane Smith < jsmith@example . net >
License :
[ LICENSE TEXT ]

Debian Packaging Tutorial

33 / 86

Modifying the upstream source

Often needed:
I

Fix bugs or add customizations that are specific to Debian

Backport fixes from a newer upstream release

Several methods to do it:

I

Modifying the files directly

I Simple
I But no way to track and document the changes

Using patch systems

I Eases contributing your changes to upstream
I Helps sharing the fixes with derivatives
I Gives more exposure to the changes
http://patch-tracker.debian.org/

Debian Packaging Tutorial

34 / 86

Patch systems
I

Principle: changes are stored as patches in debian/patches/

Applied and unapplied during build

Past: several implementations simple-patchsys (cdbs), dpatch, quilt

I Each supports two debian/rules targets:
I debian/rules patch: apply all patches
I debian/rules unpatch: de-apply all patches
I

More documentation: http://wiki.debian.org/debian/patches

New source package format with built-in patch system: 3.0 (quilt)
I Recommended solution
I

You need to learn quilt

http://pkg-perl.alioth.debian.org/howto/quilt.html

Patch-system-agnostic tool in devscripts: edit-patch

Debian Packaging Tutorial

35 / 86

Documentation of patches
I

Standard headers at the beginning of the patch

Documented in DEP-3 - Patch Tagging Guidelines

http://dep.debian.net/deps/dep3/

Description : Fix widget frobnication speeds

Frobnicating widgets too quickly tended to cause explosions .
Forwarded : http :// lists . example . com /2010/03/1234. html
Author : John Doe < johndoe - guest@users . alioth . debian . org >
Applied - Upstream : 1.2 , http :// bzr . foo . com / frobnicator / revision /123
Last - Update : 2010 -03 -29
--- a / src / widgets . c
+++ b / src / widgets . c
@@ -101 ,9 +101 ,6 @@ struct {

Debian Packaging Tutorial

36 / 86

Doing things during installation and removal

I

Decompressing the package is sometimes not enough

Create/remove system users, start/stop services, manage alternatives

Done in maintainer scripts

preinst, postinst, prerm, postrm
I Snippets for common actions can be generated by debhelper

Documentation:
I Debian Policy Manual, chapter 6
http://www.debian.org/doc/debian-policy/ch-maintainerscripts
I

Debian Developers Reference, chapter 6.4

http://www.debian.org/doc/developers-reference/best-pkging-practices.html

http://people.debian.org/~srivasta/MaintainerScripts.html

Prompting the user

I Must be done with debconf
I

Documentation: debconf-devel(7) (debconf-doc package)

Debian Packaging Tutorial

37 / 86

Monitoring upstream versions

I

Specify where to look in debian/watch (see uscan(1))

version =3
http :// tmrc . mit . edu / mirror / twisted / Twisted /(\ d \.\ d )/ \
Twisted -([\ d \.]*)\. tar \. bz2

Debian infrastructure that makes use of debian/watch:

Debian External Health Status
http://dehs.alioth.debian.org/

Maintainer warned by emails sent to the Package Tracking System

http://packages.qa.debian.org/

uscan: run a manual check

uupdate: try to update your package to the latest upstream version

Debian Packaging Tutorial

38 / 86

Packaging with a Version Control System

I

Several tools to help manage branches and tags for your packaging work:
svn-buildpackage, git-buildpackage

Example: git-buildpackage
I upstream branch to track upstream with upstream/version tags
I master branch tracks the Debian package
I debian/version tags for each upload
I pristine-tar branch to be able to rebuild the upstream tarball

Vcs-* fields in debian/control to locate the repository

I http://wiki.debian.org/Alioth/Git
I http://wiki.debian.org/Alioth/Svn

Vcs - Browser : http :// anonscm . debian . org / gitweb /? p = collab - maint / devscripts . git
Vcs - Git : git :// anonscm . debian . org / collab - maint / devscripts . git
Vcs - Browser : http :// svn . debian . org / viewsvn / pkg - perl / trunk / libwww - perl /
Vcs - Svn : svn :// svn . debian . org / pkg - perl / trunk / libwww - perl
I

VCS-agnostic interface: debcheckout, debcommit, debrelease

I

debcheckout grep checks out the source package from Git

Debian Packaging Tutorial

39 / 86

Backporting packages

Goal: use a newer version of a package on an older system

e.g. use mutt from Debian unstable on Debian stable

General idea:
I Take the source package from Debian unstable
I

Modify it so that it builds and works fine on Debian stable

I Sometimes trivial (no changes needed)
I Sometimes difficult
I Sometimes impossible (many unavailable dependencies)

Some backports are provided and supported by the Debian project

http://backports.debian.org/

Debian Packaging Tutorial

40 / 86

Outline
1

Introduction

Creating source packages

Building and testing packages

Practical session 1: modifying the grep package

Advanced packaging topics

Maintaining packages in Debian

Conclusions

Practical session 2: packaging GNUjump

Practical session 3: packaging a Java library

10

Practical session 4: packaging a Ruby gem

11

Practical session 5: packaging a Perl module

Debian Packaging Tutorial

41 / 86

Several ways to contribute to Debian

I

Worst way to contribute:

1 Package your own application
2 Get it into Debian
3 Disappear

Better ways to contribute:

I Get involved in packaging teams
I Many teams that focus on set of packages, and need help
I List available at http://wiki.debian.org/Teams
I An excellent way to learn from more experienced contributors
I

Adopt existing unmaintained packages (orphaned packages)

Bring new software to Debian

I Only if its interesting/useful enough, please
I Are there alternatives already packaged in Debian?

Debian Packaging Tutorial

42 / 86

Adopting orphaned packages

I

Many unmaintained packages in Debian

Full list + process: http://www.debian.org/devel/wnpp/

Installed on your machine: wnpp-alert

Different states:
I

Orphaned: the package is unmaintained

Feel free to adopt it

RFA: Request For Adopter

Maintainer looking for adopter, but continues work in the meantime
Feel free to adopt it. A mail to the current maintainer is polite

ITA: Intent To Adopt

Someone intends to adopt the package
You could propose your help!

RFH: Request For Help

The maintainer is looking for help

Some unmaintained packages not detected not orphaned yet

When in doubt, ask [email protected]

or #debian-qa on irc.debian.org
Debian Packaging Tutorial

43 / 86

Adopting a package: example

From : You < you@yourdomain >
To : 640454 @bugs . debian . org , control@bugs . debian . org
Cc : Francois Marier < fran coi s@de bian . org >
Subject : ITA : verbiste -- French conjugator
retitle 640454 ITA : verbiste -- French conjugator
owner 640454 !
thanks
Hi ,
I am using verbiste and I am willing to take care of the package .
Cheers ,
You
I

Polite to contact the previous maintainer (especially if the package was

RFAed, not orphaned)

Very good idea to contact the upstream project

Debian Packaging Tutorial

44 / 86

Getting your package in Debian

You do not need any official status to get your package into Debian
1 Submit an ITP bug (Intend To Package) using reportbug wnpp
2

Prepare a source package

Find a Debian Developer that will sponsor your package

Official status (when you are an experienced package maintainer):

I Debian Maintainer (DM):
Permission to upload your own packages
See http://wiki.debian.org/DebianMaintainer
I

Debian Developer (DD):

Debian project member; can vote and upload any package

Debian Packaging Tutorial

45 / 86

Things to check before asking for sponsorship

I

Debian puts a lot of focus on quality

Generally, sponsors are hard to find and busy

I Make sure your package is ready before asking for sponsorship

Things to check:
I Avoid missing build-dependencies: make sure that your package
build fine in a clean sid chroot
I Using pbuilder is recommended

Run lintian -EviIL +pedantic on your package

I Errors must be fixed, all other problems should be fixed

Do extensive testing of your package, of course

In doubt, ask for help

Debian Packaging Tutorial

46 / 86

Where to find help?

Help you will need:
I Advice and answers to your questions, code reviews
I Sponsorship for your uploads, once your package is ready
You can get help from:
I Other members of a packaging team
I List of teams: http://wiki.debian.org/Teams
I

The Debian Mentors group (if your package does not fit in a team)
I http://wiki.debian.org/DebianMentorsFaq
I Mailing list: [email protected]
(also a good way to learn by accident)
I
I
I

IRC: #debian-mentors on irc.debian.org

http://mentors.debian.net/
Documentation: http://mentors.debian.net/intro-maintainers

Localized mailing lists (get help in your language)

I debian-devel-{french,italian,portuguese,spanish}@lists.d.o
I Full list: https://lists.debian.org/devel.html
I Or users lists: https://lists.debian.org/users.html
Debian Packaging Tutorial

47 / 86

More documentation
I

Debian Developers Corner

http://www.debian.org/devel/
Links to many resources about Debian development

Debian New Maintainers Guide

http://www.debian.org/doc/maint-guide/
An introduction to Debian packaging, but could use an update

Debian Developers Reference

http://www.debian.org/doc/developers-reference/
Mostly about Debian procedures, but also some best packaging practices (part 6)

Debian Policy
http://www.debian.org/doc/debian-policy/
I
I

All the requirements that every package must satisfy

Specific policies for Perl, Java, Python, . . .

Ubuntu Packaging Guide

http://developer.ubuntu.com/resources/tools/packaging/

Debian Packaging Tutorial

48 / 86

Debian dashboards for maintainers

Source package centric: Package Tracking System (PTS)

http://packages.qa.debian.org/dpkg

Maintainer/team centric: Developers Packages Overview (DDPO)

http://qa.debian.org/developer.php?login=
[email protected]

TODO-list oriented: Debian Maintainer Dashboard (DMD)

http://udd.debian.org/dmd.cgi

Debian Packaging Tutorial

49 / 86

Using the Debian Bug Tracking System (BTS)

I

A quite unique way to manage bugs

I Web interface to view bugs
I Email interface to make changes to bugs

Adding information to bugs:

I Write to [email protected] (does not include the submitter,
you need to add [email protected])

Changing bug status:

I Send commands to [email protected]
I Command-line interface: bts command in devscripts
I Documentation: http://www.debian.org/Bugs/server-control

Reporting bugs: use reportbug

I Normally used with a local mail server: install ssmtp or nullmailer
I Or use reportbug --template, then send (manually) to
[email protected]

Debian Packaging Tutorial

50 / 86

Using the BTS: examples

I

Sending an email to the bug and the submitter:

http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=680822#10

Tagging and changing the severity:

http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=680227#10

Reassigning, changing the severity, retitling . . . :

http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=680822#93
I notfound, found, notfixed, fixed are for version-tracking
See https://wiki.debian.org/HowtoUseBTS#Version_tracking

Using usertags:
http://bugs.debian.org/cgi-bin/bugreport.cgi?msg=42;bug=642267
See https://wiki.debian.org/bugs.debian.org/usertags

BTS Documentation:
I http://www.debian.org/Bugs/
I https://wiki.debian.org/HowtoUseBTS

Debian Packaging Tutorial

51 / 86

More interested in Ubuntu?

I

Ubuntu mainly manages the divergence with Debian

No real focus on specific packages

Instead, collaboration with Debian teams

Usually recommend uploading new packages to Debian first

https://wiki.ubuntu.com/UbuntuDevelopment/NewPackages

Possibly a better plan:

I Get involved in a Debian team and act as a bridge with Ubuntu
I

Help reduce divergence, triage bugs in Launchpad

Many Debian tools can help:

I Ubuntu column on the Developers packages overview
I Ubuntu box on the Package Tracking System
I Receive launchpad bugmail via the PTS

Debian Packaging Tutorial

52 / 86

Outline
1

Introduction

Creating source packages

Building and testing packages

Practical session 1: modifying the grep package

Advanced packaging topics

Maintaining packages in Debian

Conclusions

Practical session 2: packaging GNUjump

Practical session 3: packaging a Java library

10

Practical session 4: packaging a Ruby gem

11

Practical session 5: packaging a Perl module

Debian Packaging Tutorial

53 / 86

Conclusions
I

You now have a full overview of Debian packaging

But you will need to read more documentation

Best practices have evolved over the years

I If not sure, use the dh packaging helper, and the 3.0 (quilt) format

Things that were not covered in this tutorial:

I UCF manage user changes to configuration files when upgrading
I

dpkg triggers group similar maintainer scripts actions together

Debian development organization:

I Suites: stable, testing, unstable, experimental, security,
*-updates, backports, . . .
I Debian Blends subsets of Debian targeting specific groups

Feedback: [email protected]
Debian Packaging Tutorial

54 / 86

Legal stuff

c
Copyright 20112013
Lucas Nussbaum [email protected]
This document is free software: you can redistribute it and/or modify it under either
(at your option):
I

The terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later version.
http://www.gnu.org/licenses/gpl.html

The terms of the Creative Commons Attribution-ShareAlike 3.0 Unported License.

http://creativecommons.org/licenses/by-sa/3.0/

Debian Packaging Tutorial

55 / 86

Contribute to this tutorial

I

Contribute:
I

apt-get source packaging-tutorial

debcheckout packaging-tutorial

git clone
git://git.debian.org/collab-maint/packaging-tutorial.git

http://git.debian.org/?p=collab-maint/packaging-tutorial.git

Open bugs: bugs.debian.org/src:packaging-tutorial

Provide feedback:
I mailto:[email protected]
I
I

What should be added to this tutorial?

What should be improved?

reportbug packaging-tutorial

Debian Packaging Tutorial

56 / 86

Outline
1

Introduction

Creating source packages

Building and testing packages

Practical session 1: modifying the grep package

Advanced packaging topics

Maintaining packages in Debian

Conclusions

Practical session 2: packaging GNUjump

Practical session 3: packaging a Java library

10

Practical session 4: packaging a Ruby gem

11

Practical session 5: packaging a Perl module

Debian Packaging Tutorial

57 / 86

Practical session 2: packaging GNUjump

1

Download GNUjump 1.0.8 from

http://ftp.gnu.org/gnu/gnujump/gnujump-1.0.8.tar.gz

Create a Debian package for it

I Install build-dependencies so that you can build the package
I Get a basic working package
I Finish filling debian/control and other files

Enjoy

Debian Packaging Tutorial

58 / 86

Outline
1

Introduction

Creating source packages

Building and testing packages

Practical session 1: modifying the grep package

Advanced packaging topics

Maintaining packages in Debian

Conclusions

Practical session 2: packaging GNUjump

Practical session 3: packaging a Java library

10

Practical session 4: packaging a Ruby gem

11

Practical session 5: packaging a Perl module

Debian Packaging Tutorial

59 / 86

Practical session 3: packaging a Java library

1

Take a quick look at some documentation about Java packaging:

I

http://wiki.debian.org/Java

http://wiki.debian.org/Java/Packaging

http://www.debian.org/doc/packaging-manuals/java-policy/

http://pkg-java.alioth.debian.org/docs/tutorial.html

Paper and slides from a Debconf10 talk about javahelper:

http://pkg-java.alioth.debian.org/docs/debconf10-javahelper-paper.pdf
http://pkg-java.alioth.debian.org/docs/debconf10-javahelper-slides.pdf

Download IRClib from http://moepii.sourceforge.net/

Package it

Debian Packaging Tutorial

60 / 86

Outline
1

Introduction

Creating source packages

Building and testing packages

Practical session 1: modifying the grep package

Advanced packaging topics

Maintaining packages in Debian

Conclusions

Practical session 2: packaging GNUjump

Practical session 3: packaging a Java library

10

Practical session 4: packaging a Ruby gem

11

Practical session 5: packaging a Perl module

Debian Packaging Tutorial

61 / 86

Practical session 4: packaging a Ruby gem

Take a quick look at some documentation about Ruby packaging:

I

http://wiki.debian.org/Ruby

http://wiki.debian.org/Teams/Ruby

http://wiki.debian.org/Teams/Ruby/Packaging

gem2deb(1), dh_ruby(1) (in the gem2deb package)

Create a basic Debian source package from the net-ssh gem:

gem2deb net-ssh

Improve it so that it becomes a proper Debian package

Debian Packaging Tutorial

62 / 86

Outline
1

Introduction

Creating source packages

Building and testing packages

Practical session 1: modifying the grep package

Advanced packaging topics

Maintaining packages in Debian

Conclusions

Practical session 2: packaging GNUjump

Practical session 3: packaging a Java library

10

Practical session 4: packaging a Ruby gem

11

Practical session 5: packaging a Perl module

Debian Packaging Tutorial

63 / 86

Practical session 5: packaging a Perl module

Take a quick look at some documentation about Perl packaging:

I

http://pkg-perl.alioth.debian.org/

http://wiki.debian.org/Teams/DebianPerlGroup

dh-make-perl(1), dpt(1) (in the pkg-perl-tools package)

Create a basic Debian source package from the Acme CPAN distribution:
dh-make-perl --cpan Acme

Improve it so that it becomes a proper Debian package

Debian Packaging Tutorial

64 / 86

Outline
1

Introduction

Creating source packages

Building and testing packages

Practical session 1: modifying the grep package

Advanced packaging topics

Maintaining packages in Debian

Conclusions

Practical session 2: packaging GNUjump

Practical session 3: packaging a Java library

10

Practical session 4: packaging a Ruby gem

11

Practical session 5: packaging a Perl module

Debian Packaging Tutorial

65 / 86

Answers to
practical sessions

Debian Packaging Tutorial

66 / 86

Practical session 1: modifying the grep package

1

Go to http://ftp.debian.org/debian/pool/main/g/grep/ and
download version 2.6.3-3 of the package (if you use Ubuntu 11.10 or later,
or Debian testing or unstable, use version 2.9-1 or 2.9-2 instead)

Look at the files in debian/.

I How many binary packages are generated by this source package?
I Which packaging helper does this package use?

Build the package

We are now going to modify the package. Add a changelog entry and
increase the version number.

Now disable perl-regexp support (it is a ./configure option)

Rebuild the package

Compare the original and the new package with debdiff

Install the newly built package

Cry if you messed up ;)

Debian Packaging Tutorial

67 / 86

Fetching the source

1

Go to http://ftp.debian.org/debian/pool/main/g/grep/ and
download version 2.6.3-3 of the package

Use dget to download the .dsc file:

dget http://cdn.debian.net/debian/pool/main/g/grep/grep_2.6.3-3.dsc

According to http://packages.qa.debian.org/grep, grep version

2.6.3-3 is currently in stable (squeeze). If you have deb-src lines for
squeeze in your /etc/apt/sources.list, you can use:
apt-get source grep=2.6.3-3
or apt-get source grep/stable
or, if you feel lucky: apt-get source grep

The grep source package is composed of three files:

I grep_2.6.3-3.dsc
I grep_2.6.3-3.debian.tar.bz2
I grep_2.6.3.orig.tar.bz2
This is typical of the "3.0 (quilt)" format.

If needed, uncompress the source with

dpkg-source -x grep_2.6.3-3.dsc
Debian Packaging Tutorial

68 / 86

Looking around and building the package

2

Look at the files in debian/.

I How many binary packages are generated by this source package?
I Which packaging helper does this package use?

According to debian/control, this package only generates one binary

package, named grep.

According to debian/rules, this package is typical of classic debhelper

packaging, without using CDBS or dh. One can see the various calls to
dh_* commands in debian/rules.

Build the package

Use apt-get build-dep grep to fetch the build-dependencies

Then debuild or dpkg-buildpackage -us -uc (Takes about 1 min)

Debian Packaging Tutorial

69 / 86

Editing the changelog

We are now going to modify the package. Add a changelog entry and
increase the version number.

debian/changelog is a text file. You could edit it and add a new entry
manually.

Or you can use dch -i, which will add an entry and open the editor

The name and email can be defined using the DEBFULLNAME and DEBEMAIL
environment variables

After that, rebuild the package: a new version of the package is built

Package versioning is detailed in section 5.6.12 of the Debian policy

http://www.debian.org/doc/debian-policy/ch-controlfields

Debian Packaging Tutorial

70 / 86

Disabling Perl regexp support and rebuilding

Now disable perl-regexp support (it is a ./configure option)

Rebuild the package

Check with ./configure --help: the option to disable Perl regexp is

--disable-perl-regexp

Edit debian/rules and find the ./configure line

Add --disable-perl-regexp

Rebuild with debuild or dpkg-buildpackage -us -uc

Debian Packaging Tutorial

71 / 86

Comparing and testing the packages

7

Compare the original and the new package with debdiff

Install the newly built package

Compare the binary packages: debdiff ../*changes

Compare the source packages: debdiff ../*dsc

Install the newly built package: debi

Or dpkg -i ../grep_<TAB>

grep -P foo no longer works!

Cry if you messed up ;)

Or not: reinstall the previous version of the package:

I apt-get install --reinstall grep=2.6.3-3 (= previous version)

Debian Packaging Tutorial

72 / 86

Practical session 2: packaging GNUjump

1

Download GNUjump 1.0.8 from

http://ftp.gnu.org/gnu/gnujump/gnujump-1.0.8.tar.gz

Create a Debian package for it

I Install build-dependencies so that you can build the package
I Get a basic working package
I Finish filling debian/control and other files

Enjoy

Debian Packaging Tutorial

73 / 86

Step by step. . .
I

wget http://ftp.gnu.org/gnu/gnujump/gnujump-1.0.8.tar.gz

mv gnujump-1.0.8.tar.gz gnujump_1.0.8.orig.tar.gz

tar xf gnujump_1.0.8.orig.tar.gz

cd gnujump-1.0.8/

dh_make
I

Type of package: single binary (for now)

gnujump -1.0.8 $ ls debian /

changelog
gnujump . default . ex
compat
gnujump . doc - base . EX
control
init . d . ex
copyright
manpage .1. ex
docs
manpage . sgml . ex
emacsen - install . ex manpage . xml . ex
emacsen - remove . ex
menu . ex
emacsen - startup . ex postinst . ex
gnujump . cron . d . ex
postrm . ex

preinst . ex
prerm . ex
README . Debian
README . source
rules
source
watch . ex

Debian Packaging Tutorial

74 / 86

Step by step. . . (2)

I

Look at debian/changelog, debian/rules, debian/control

(auto-filled by dh_make)

In debian/control:
Build-Depends: debhelper (>= 7.0.50 ), autotools-dev
Lists the build-dependencies = packages needed to build the package

Try to build the package as-is (thanks to dh magic)

I And add build-dependencies, until it builds
I Hint: use apt-cache search and apt-file to find the packages
I Example:
checking for sdl - config ... no
checking for SDL - version >= 1.2.0... no
[...]
configure : error : *** SDL version 1.2.0 not found !

Add libsdl1.2-dev to Build-Depends and install it.

I

Better: use pbuilder to build in a clean environment

Debian Packaging Tutorial

75 / 86

Step by step. . . (3)

I

After installing libsdl1.2-dev, libsdl-image1.2-dev,

libsdl-mixer1.2-dev, the package builds fine.

Use debc to list the content of the generated package.

Use debi to install it and test it.

Test the package with lintian

I While not a strict requirement, it is recommended that packages
uploaded to Debian are lintian-clean
I

More problems can be listed using lintian -EviIL +pedantic

Some hints:
I Remove the files that you dont need in debian/
I

Fill in debian/control

Install the executable to /usr/games by overriding

dh_auto_configure

Use hardening compiler flags to increase security.

See http://wiki.debian.org/Hardening
Debian Packaging Tutorial

76 / 86

Step by step. . . (4)

Compare your package with the one already packaged in Debian:

I It splits the data files to a second package, that is the same across all
architectures ( saves space in the Debian archive)
I

It installs a .desktop file (for the GNOME/KDE menus) and also

integrates into the Debian menu

It fixes a few minor problems using patches

Debian Packaging Tutorial

77 / 86

Practical session 3: packaging a Java library

1

Take a quick look at some documentation about Java packaging:

I

http://wiki.debian.org/Java

http://wiki.debian.org/Java/Packaging

http://www.debian.org/doc/packaging-manuals/java-policy/

http://pkg-java.alioth.debian.org/docs/tutorial.html

Paper and slides from a Debconf10 talk about javahelper:

http://pkg-java.alioth.debian.org/docs/debconf10-javahelper-paper.pdf
http://pkg-java.alioth.debian.org/docs/debconf10-javahelper-slides.pdf

Download IRClib from http://moepii.sourceforge.net/

Package it

Debian Packaging Tutorial

78 / 86

Step by step. . .

apt-get install javahelper

Create a basic source package: jh_makepkg

I Library
I None
I Default Free compiler/runtime

Look at and fix debian/*

dpkg-buildpackage -us -uc or debuild

lintian, debc, etc.

Compare your result with the libirclib-java source package

Debian Packaging Tutorial

79 / 86

Practical session 4: packaging a Ruby gem

Take a quick look at some documentation about Ruby packaging:

I

http://wiki.debian.org/Ruby

http://wiki.debian.org/Teams/Ruby

http://wiki.debian.org/Teams/Ruby/Packaging

gem2deb(1), dh_ruby(1) (in the gem2deb package)

Create a basic Debian source package from the net-ssh gem:

gem2deb net-ssh

Improve it so that it becomes a proper Debian package

Debian Packaging Tutorial

80 / 86

Step by step. . .
gem2deb net-ssh:
I

Downloads the gem from rubygems.org

Creates a suitable .orig.tar.gz archive, and untar it

Initializes a Debian source package based on the gems metadata

I Named ruby-gemname

Tries to build the Debian binary package (this might fail)

dh_ruby (included in gem2deb) does the Ruby-specific tasks:

I

Build C extensions for each Ruby version

Copy files to their destination directory

Update shebangs in executable scripts

Run tests defined in debian/ruby-tests.rb or

debian/ruby-test-files.yaml, as well as various other checks

Debian Packaging Tutorial

81 / 86

Step by step. . . (2)

Improve the generated package:

I

Run debclean to clean the source tree. Look at debian/.

changelog and compat should be correct

Edit debian/control: uncomment Homepage, improve Description

Write a proper copyright file based on the upstream files

ruby-net-ssh.docs: install README.rdoc

ruby-tests.rb: run the tests. In that case, it is enough to do:

$: << test << lib << .
require test/test_all.rb

Debian Packaging Tutorial

82 / 86

Step by step. . . (3)

Build the package. It fails to build. There are two problems:
I

You need to disable the gem call in the test suite.

In test/common.rb, remove the gem "test-unit" line:
I edit-patch disable-gem.patch
I Edit test/common.rb, remove the gem line. Exit the sub-shell
I Describe the changes in debian/changelog
I Document the patch in debian/patches/disable-gem.patch

The package lacks a build-dependency on ruby-mocha, which is used by

the test suite (you might need to build your package in a clean
environment, using pbuilder, to reproduce that problem)
I
I

Add ruby-mocha to the packages Build-Depends

gem2deb copies the dependencies documented in the gem as
comments in debian/control, but mocha is not listed as a
development dependency by the gem (thats a bug in the gem)

Compare your package with the ruby-net-ssh package in the Debian archive

Debian Packaging Tutorial

83 / 86

Practical session 5: packaging a Perl module

Take a quick look at some documentation about Perl packaging:

I

http://pkg-perl.alioth.debian.org/

http://wiki.debian.org/Teams/DebianPerlGroup

dh-make-perl(1), dpt(1) (in the pkg-perl-tools package)

Create a basic Debian source package from the Acme CPAN distribution:
dh-make-perl --cpan Acme

Improve it so that it becomes a proper Debian package

Debian Packaging Tutorial

84 / 86

Step by step. . .

dh-make-perl --cpan Acme:

I

Downloads the tarball from the CPAN

Creates a suitable .orig.tar.gz archive, and untars it

Initializes a Debian source package based on the distributions metadata

I Named libdistname -perl

Debian Packaging Tutorial

85 / 86

Step by step. . . (2)

Improve the generated package:

I

debian/changelog, debian/compat, debian/libacme-perl.docs, and

debian/watch should be correct

Edit debian/control: improve Description, and remove boilerplate at

the bottom

Edit debian/copyright: remove boilerplate paragraph at the top, add

years of copyright to the Files: * stanza

Debian Packaging Tutorial

86 / 86