Differences between revisions 8 and 9
Revision 8 as of 2006-05-04 21:10:04
Size: 6218
Editor: EddyPetrisor
Comment: typos; debianzation info; why chroots are good
Revision 9 as of 2006-05-04 21:32:48
Size: 6210
Editor: EddyPetrisor
Comment: parse error
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
'''This page is intended to gather a pragmatic and simplistic guide HowTo into creating a simple Debian package.''' '''This page is intended to gather a pragmatic and simplistic guide to creating a simple Debian package.'''

Introduction

This page is intended to gather a pragmatic and simplistic guide to creating a simple Debian package.

This ?HowTo It is also 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?

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 the people that prefer a more pragmatic approach to problems, this ?HowTo will focus on a pragmatic approach on learning how to create Debian packages.

Creating the package

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

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

Initial compilation

Steps:

  • try compile the package (do not run install) - can be done on your system, but is preferably done in a chroot
    • write down every package you had to install so the package compiled (will be added to build dependency)
    • write down quirks and tricks needed for the package to compile (files missing, file modifications, etc.)
    • if you think you need something not packages, make sure that:

Note: It is best to create a chroot in which the application shall be build. This could avoid various security and system corruption problems.

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, unfortunetely, very much present and you don't want yet to run a test installation.

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 is 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).

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.

Make sure that in 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 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 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 FTBFS critical bugs
  • the chroot system is surely a pure debian system belonging to one suite only (if the chroot was build 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

  • is there a man page for every executable file in the package? (in some rare cases it makes sense to have one man page for all the binaries in a package)
  • does it have a Debian menu entry? (daemons usualy don't need this) does it have a .desktop file?
  • if there are architecture independent things in the package and if they are big enough, are those packaged in a package with [http://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Architecture arch all]?

  • does the package compile cleanly? (this does not mean that you should redirect the errors to /dev/null and doing so will bring problems)

  • doesn't lintian scream when checking the .changes file?
  • what about linda?
  • what does piuparts have to say about the .debs?

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

Notes: [20060410] EddyPetrisor is working on this; an initial complete page should be ready asap.