Differences between revisions 32 and 33
Revision 32 as of 2007-03-25 00:51:37
Size: 8252
Editor: EddyPetrisor
Comment: Please don't break the flow, it was supposed to be a PRAGMATIC guide
Revision 33 as of 2007-03-25 00:58:31
Size: 8560
Editor: EddyPetrisor
Comment: Please, don't do this! it breaks the information flow! linked page has NO +info
Deletions are marked like this. Additions are marked like this.
Line 28: Line 28:
Line 67: Line 66:
[PkgDevRules] Create a rules file for the new package. File debian/rules: If any quirking was done then:
 * automate the quirking and the changes needed to be done in the debian/rules file under a patch target
 * make sure there will be an unpatch target that reverses all the changes done in the patch target
 * Make the clean target depend on the unpatch target
 * make the build target depend on the patch target

Introduction

A pragmatic guide to creating a simple Debian package.

This ?HowTo is intended to show that Debian packaging is not that hard. Since Debian packaging is not that hard, why shouldn't plain beginners understand and do it, too?

As a teaser, here's a short list of some reasons to package a program:

  • Obviously, you'll need a package if you want the program to be included in Debian.
  • The packaging system takes care of the old version, so if a file is moved in the source, uninstall still works properly (unlike when you use make uninstall with the new Makefile)
  • A package is an easy format to move programs between computers.

Contents

?TableOfContents([1])

Why does this page even exist?

Since the [http://www.debian.org/doc/debian-policy/ Debian Policy] and [http://www.debian.org/doc/manuals/maint-guide/index.en.html the Debian New Maintainers' Guide] sometimes are too big to read for people who prefer a more pragmatic approach to problems, this ?HowTo will focus on a pragmatic approach to learning how to create Debian packages.

The Debian package management chapter of the Debian Reference contains lots of useful information for handling all kinds of problems one runs into with apt and dpkg.

Creating the package

If the information below doesn't answer your questions, please look in the [http://www.debian.org/doc/maint-guide/ New Maintainer's Guide] and in [http://www.debian.org/doc/debian-policy/ Debian Policy]

If you want to create an official debian package, make sure it's not already packaged. If [http://www.us.debian.org/devel/wnpp/being_packaged somebody is working on the package], you should contact them if you intend to make an official package together. More info is in the [http://www.debian.org/doc/maint-guide/ New Maintainer's Guide].

[?PkgDevDir] Create a development directory for the new package.

[?PkgDevTree] Create the development subdirectories for the new package]

[?PkgDevSrc] Create the source files for the new package

Initial compilation

Steps:

  • try to compile the package (do not install) - can be done on your system, but is preferably done in a chroot (e.g., pbuilder or sbuild)
    • make a note of every package you had to install for compilation, including packages that were already installed on your system (will be added to build dependency; note that objdump -p | grep NEEDED will show exactly the needed libs the package should depend on all of packages of those libraries)
    • note quirks and tricks needed for the package to compile (missing files, file modifications, etc.)
  • if you think you need specific software not already packaged, make sure that:

Note: It is best to create a chroot in which the application will be built. This helps avoid various security and system corruption problems. Additionally, it ensures that any local changes to your machine will not interfere with the build.

If the package compiles, then it means you might have figured out all the dependencies. Don't worry, this will be checked later in a chroot environment. Try the application in a chroot environment (some things might be needed in the chroot - proc to be mounted, sys to be mounted).

DO NOT run make install, unless you are absolutely sure. Broken installation scripts are, unfortunately, very common and you probably don't want to run a test installation yet.

Note: running make on a system can sometimes be a security risk! It is a good idea to check that the Makefile does not contain funny stuff. Obscure applications might rarely fall into this case.

''Debianization''

After the first compilation, it's time to create the Debian specific part of the package.

[http://www.debian.org/doc/maint-guide/ch-first.en.html#s-dh_make Debianize] the package by using [http://packages.debian.org/dh-make dh_make].

File debian/control: Add to the Build-Depends (sometimes even Build-Depends-Indep) the list of packages needed to be installed for the application to compile (remember the list done previousely). You should leave out any packages that are listed in /usr/share/build-essential/essential-packages-list or /usr/share/build-essential/list and also leave out any packages that listed as dependencies by any of those packages. More detailed information cane be found on the page about [wiki:?PkgDevCtrl control file creation for the new package].

File debian/rules: If any quirking was done then:

  • automate the quirking and the changes needed to be done in the debian/rules file under a patch target
  • make sure there will be an unpatch target that reverses all the changes done in the patch target
  • Make the clean target depend on the unpatch target
  • make the build target depend on the patch target

Delete all the unneeded templates. Don't worry, copies are present on the system and can be copied and modified at any time later.

Make sure that all the directories you will place files in are listed in the debian/dirs file without a leading slash (/).

Make sure that the files are installed in the proper place (under a directory, not on the root system). Take care at the install target from the application makefile.

Note: very often the upstream package will be installed under /usr/local. DO NOT INSTALL ANY FILES IN THERE.

Initial compilation of the package

TODO: add notes

All tests in chroot

Why is it a good idea to use a chroot?

  • security
  • testing
  • no risk to break the developer's system
  • wrongly installed packages can be identified easily (ls -lR in the root of the chroot before and after the build; diff -u before.list after.list)
  • missing build dependecies are identified easier, thus avoiding serious [http://en.wikipedia.org/wiki/FTBFS FTBFS] (Fails To Build From Source) bugs

  • the chroot system is a pure Debian system belonging to one suite only (e.g., Sarge, Etch or Sid if the chroot was built properly with debootstrap or cdebootstrap)

Testing the package

TODO: add notes

Linda

Test all the packages with [http://packages.debian.org/linda linda].

linda package-version.changes

Lintian

Test all the packages with [http://packages.debian.org/lintian lintian].

lintian package-version.changes

Piuparts

Test all the .deb packages with [http://packages.debian.org/piuparts piuparts].

piuparts binpackage-version.deb

Check points for any package

This page is still incomplete; please help by adding information to it. Do not forget that the information here should be in a concise form.

Advanced Packaging Procedures

  • ["Renaming a Package"]
  • ["BzrBuildpackage/DesignIdeas"]

  • ["?KernelModulesPackaging"]

  • ["PackagingWithDarcs"]

  • ["PbuilderTricks"]

  • [wiki:?PkgDummy Creating a dummy package]

  • [wiki:?PkgSplit How to split a package into smaller packages]

  • [wiki:?RPMConvert Converting from RPM into a Debian] - generally leads to bad results

  • [wiki:?AltCC Using an alternative C compiler]