Michal Čihař - Balíčky pro Debian - 1. Úvod

Balíčky pro Debian - 1. Úvod

Pokud používáte Debian (nebo některou z jeho odvozenin jako například Ubuntu) a chcete si pro tento systém vytvářet balíčky, tak vítejte u tohoto seriálu. Během následujících dvanácti dílů se dozvíte vše co potřebujete k vytvoření balíčku pro Debian.

Seriál začneme obecným úvodem o tom jak vlastně takový balíček vypadá, budeme pokračovat přes popis důležitých souborů až k nástrojům, které pro vytváření balíčku potřebujeme. V závěru popíšu několik speciálních případů balíčků a připojím několik tipů jak se s balíčky nejlépe vypořádat.

Vše co je v tomto seriálu popsáno se týká přímo Debianu a je možné, že v Ubuntu jsou některé drobnosti řešené jinak. Pokud o těchto odlišnostech vím, upozorním na ně, ale protože balíčky přímo pro Ubuntu nevytvářím, nejspíš zde v tomto ohledu bude něco chybět a budu rád pokud na tyto odlišnosti upozorníte v diskuzi.

Jak vypadá binární balíček

Protože chceme vytvářet balíčky, měli bychom vědět, jak takový výsledný binární balíček vlastně vypadá. Na rozdíl od RPM není problém Debian balíček vytvořit bez použití speciálních nástrojů. Jediné co potřebujeme jsou nástroje ar a tar.

Když se podíváme na nějaký existující Debianí balíček (pro ukázky v tomto a následujících kapitolách jsem ze svých balíčků vybral ten nejjednodušší a to jest photo-uploader), zjistíme, že se vlastně jedná o ar archív se třemi soubory:

$ ar tv photo-uploader_0.5-1_all.deb 
rw-r--r-- 0/0      4 Dec 11 12:49 2007 debian-binary
rw-r--r-- 0/0   1632 Dec 11 12:49 2007 control.tar.gz
rw-r--r-- 0/0  11332 Dec 11 12:49 2007 data.tar.gz

To, že se jedná o binární balíček pro Debian poznáme podle existence souboru debian-binary. Tento soubor obsahuje verzi binárního balíčku (všechny balíčky, se kterými se dnes setkáte jsou ve verzi 2.0):

$ ar p photo-uploader_0.5-1_all.deb debian-binary
2.0

Dále archív obsahuje soubory control.tar.gz a data.tar.gz, které obsahují vlastní data balíčku. Pro kompresi se kvůli kompatibilitě se staršími verzemi stále používá gzip, přestože jsou podporovány i bzip2 a lzma.

Soubor data.tar.gz je při instalaci rozbalen do kořenového adresáře systému, takže jeho obsah je celkem zřejmý.

V souboru control.tar.gz jsou veškeré informace pro balíčkovací systém:

$ ar p photo-uploader_0.5-1_all.deb control.tar.gz | tar tfz -
./
./md5sums
./postinst
./prerm
./control

Jak možná uhodnete z názvu, soubor control obsahuje informace o balíčku, postinst a prerm jsou skriptíky pouštěné při instalaci nebo odinstalování a md5sums obsahuje kontrolní součty souborů v data.tar.gz. Souborů může být mnohem více, ale pro první seznámení si vystačíme s těmito.

Podrobnosti o tom, co všechno mohou obsahovat tyto soubory se postupně dozvíte v průběhu seriálu, ale je dobré vědět, jak vlastně binární balíček vevnitř vypadá.

Jak vypadá zdrojový balíček

Zdrojový balíček se oproti tomu skládá ze dvou nebo tří souborů. V případě výše použitého balíčku pro lazygal to budou tyto soubory:

$ ll
celkem 28
-rw-r--r-- 1 nijel nijel   844 11. pro 13.02 photo-uploader_0.5-1.dsc
-rw-r--r-- 1 nijel nijel 17796 11. pro 13.02 photo-uploader_0.5.orig.tar.gz
-rw-r--r-- 1 nijel nijel  1846 11. pro 13.02 photo-uploader_0.5-1.diff.gz

První soubor je vlastně jakýsi popis zdrojového balíčku, najdeme v něm informace o balíčku (správce, verze, závislosti pro kompilaci apod.) a seznam souborů, ze kterých se zdrojový balíček skládá (tedy orig.tar.gz a diff.gz spolu s jejich kontrolními součty. Tento soubor by také měl být podepsán PGP a tím si můžete ověřit původ zdrojového balíčku.

Druhým souborem je původní tarball tak, jak jsme ho získali od autora software. Pokud to není nezbytně nutné, neměl by být nijak změněn a přesně odpovídat tomu, který autor nabízí na svých stránkách. Ne vždy je to však možné, nejčastěji z důvodů problematické licence některých částí nebo kvůli zabalení gzipem (zde opět platí výše uvedené, že dpkg podporuje i bzip2 a lzma, ale z důvodů kompatibility se staršími verzemi se nadále používá gzip).

Poslední soubor obsahuje změny potřebné pro vytvoření Debian balíčku. Minimálně tedy přidává skripty potřebné pro kompilaci balíčku, ale může i upravovat soubory v tarballu. Tento soubor se změnami nenaleznete u takzvaných nativních balíčků. Jedná se o programy psané přímo pro Debian a kde nemá smysl rozlišovat mezi verzí balíčku a verzí programu. Pokud však takovýto balíček bez souboru diff.gz vytvoříte vy, obvykle se jedná o chybu.

Adresář debian a co vše musí obsahovat

Pro práci se zdrojovými balíčky používáme nástroj dpkg-source. Přepínačem -x si zdrojový balíček rozbalíme a podíváme se dovnitř:

$ dpkg-source -x photo-uploader_0.5-1.dsc
dpkg-source: extracting photo-uploader in photo-uploader-0.5
dpkg-source: unpacking photo-uploader_0.5.orig.tar.gz
dpkg-source: applying ./photo-uploader_0.5-1.diff.gz
$ ll photo-uploader-0.5/
celkem 72
-rw-r--r-- 1 nijel nijel    32 25. zář 15.46 AUTHORS
-rw-r--r-- 1 nijel nijel 17987 25. zář 14.55 COPYING
drwxr-xr-x 2 nijel nijel  4096  4. úno 21.44 debian
-rw-r--r-- 1 nijel nijel   240 25. zář 15.40 INSTALL
-rw-r--r-- 1 nijel nijel   690 11. pro 12.40 NEWS
-rwxr-xr-x 1 nijel nijel  5289 29. lis 22.59 photo-upload.py
-rw-r--r-- 1 nijel nijel   223  5. říj 12.39 photo-uploadrc
-rw-r--r-- 1 nijel nijel  2641 11. pro 12.44 photo-upload.1
drwxr-xr-x 3 nijel nijel  4096 11. pro 12.48 phoupl
-rw-r--r-- 1 nijel nijel  1038 11. pro 12.48 PKG-INFO
-rw-r--r-- 1 nijel nijel  1490 26. zář 15.52 README
-rwxr-xr-x 1 nijel nijel  6238 26. zář 11.35 setup.py

Jak jistě vidíte, kromě věcí, které vypadají jako zdrojové kódy nějaké aplikace, se vytvořil adresář debian, který obsahuje veškeré věci týkající se vytváření balíčku. Obsah tohoto adresáře je obvykle právě vytvořen souborem diff.gz. V případě námi zkoumaného balíčku tento adresář obsahuje sedm souborů:

$ ll photo-uploader-0.5/debian/
celkem 28
-rw-r--r-- 1 nijel nijel    2  4. úno 21.44 compat
-rw-r--r-- 1 nijel nijel  894  4. úno 21.44 control
-rw-r--r-- 1 nijel nijel 1162  4. úno 21.44 copyright
-rw-r--r-- 1 nijel nijel   12  4. úno 21.44 docs
-rw-r--r-- 1 nijel nijel  873  4. úno 21.44 changelog
-rwxr-xr-x 1 nijel nijel  730  4. úno 21.44 rules
-rw-r--r-- 1 nijel nijel   80  4. úno 21.44 watch

U komplikovanějších balíčků naleznete mnohem více souborů, ale nemusíme hned začínat tím nejtěžším. Dnes se pro vytváření téměř všech balíčků používá debhelper, který usnadňuje mnoho kroků nutných pro jejich vytvoření. V celém seriálu předpokládám jeho použití a pokud někdo z nějakých obskurních důvodů potřebuje používat něco jiného, má smůlu :-).

Stručný popis, co jednotlivé soubory obsahují najdete ve zbývající části článku, všechny však budou postupně podrobněji popsány v dalších dílech seriálu. Všechny soubory by měly být v UTF-8, takže můžete bez obav používat nabodeníčka ve svých jménech.

debian/compat

Povinný soubor určující verzi nástroje debhelper, se kterým byl balíček otestován. Stejně jako vše ostatní se i debhelper vyvíjí a tímto souborem je zajištěna zpětná kompatibilita - při zpracování balíčku se debhelper automaticky přepíná do režimu kompatibilním s verzí uvedenou v tomto souboru.

debian/control

Povinný textový soubor obsahující informace zdrojovém balíčku a binárních balíčcích, které vzniknou při jeho kompilaci. Obsahuje jak popis balíčků tak i informace o závislostech, odkaz na domovskou stránku programu a další informace.

debian/copyright

Povinný textový soubor s informacemi o licenci balíčku. Debian je poměrně přísný na posuzování licencí a proto pokud chcete balíček dostat do distribuce, dejte si na tomto souboru záležet.

debian/docs

Nepovinný soubor, který obsahuje seznam dokumentace, kterou má debhelper nainstalovat.

debian/changelog

Povinný soubor popisující seznam změn mezi revizemi balíčku.

debian/rules

Pravidla pro make, pomocí kterých je možné zkompilovat balíček.

debian/watch

Nepovinný soubor obsahující skript pro program uscan, který umožňuje kontrolu aktuálnosti verze programu a případně stažení aktuálního tarballu od autora.

Závěr

Nyní již tušíte jak takový balíček pro Debian vypadá a v dalším díle se již budeme věnovat jejich vytváření.

Odkazy