Ero sivun ”Deb-paketin tekeminen” versioiden välillä

Linux.fista
Siirry navigaatioon Siirry hakuun
p (→‎Tehdään paketti!: käytetään ennemmin debuildia)
 
(45 välissä olevaa versiota 10 käyttäjän tekeminä ei näytetä)
Rivi 1: Rivi 1:
[[Debian]]issa ja siihen pohjautuvissa jakeluissa (esim. [[Knoppix]]issa, [[MEPIS]]issä, [[PCLinuxOS]]issa ja [[Ubuntu]]ssa) käytetään [[Dpkg]]-paketinhallintajärjestelmää. Dpkg:ssa paketit ovat .deb-tiedostoja, jotka sisältävät itse ohjelman lisäksi mm. tiedot paketin riippuvuuksista ja siitä, mihin ohjelma asennetaan. Deb-pakettien tekeminen ei ole mitenkään ylivoimainen tehtävä, kunhan perusasiat ovat hallussa.
[[Debian]]issa ja siihen pohjautuvissa jakeluissa (esim. [[Ubuntu]]ssa ja [[Linux Mint]]issä) käytetään [[Dpkg]]-paketinhallintajärjestelmää. Dpkg:ssa paketit ovat <tt>.deb</tt>-tiedostoja, jotka sisältävät itse ohjelman lisäksi mm. tiedot paketin riippuvuuksista ja siitä, mihin ohjelma asennetaan. Deb-pakettien tekeminen ei ole mitenkään ylivoimainen tehtävä, kunhan perusasiat ja mm. [[komentorivi|komentorivin käyttö]] ovat hallussa.


Tässä oppaassa luodaan aluksi malliksi yksinkertainen paketti [http://www.gnu.org/software/hello/ GNU Hello] -ohjelmasta, joka on [[GNU]]-projektin esimerkkiohjelma. Ohjelman lähdekoodipaketin voi ladata [http://ftp.gnu.org/gnu/hello/ GNU:n palvelimelta]. Paketin luomisessa käytetään tässä apuna Debhelper-apuohjelmaa. Tämä ei ole yksinkertaisin tapa paketoida ohjelma, mutta ennen helpottaviin tekniikoihin tutustumista on hyvä käydä asiat yksityiskohtaisemmin läpi.
Tässä oppaassa luodaan aluksi malliksi yksinkertainen paketti [http://www.gnu.org/software/hello/ GNU Hello] -ohjelmasta, joka on [[GNU]]-projektin esimerkkiohjelma. Ohjelman lähdekoodipaketin voi ladata [http://ftp.gnu.org/gnu/hello/ GNU:n palvelimelta]. Paketin luomisessa käytetään tässä apuna Debhelper-apuohjelmaa (<tt>dh</tt>).


Kun perusteet on hallussa, tutustumme artikkelin loppupuolella mm. CDBS:ään, joka helpottaa huomattavasti monia paketointiin liittyviä rutiinitehtäviä.
Debianin eri versiosta löytyvän paketin voi kääntää käytetylle versiolle sopivaksi tai pakettiin tehdä pieniä muutoksia huomattavasti helpommin kuin tätä ohjetta seuraamalla, komennoilla <tt>apt-get build-dep paketti</tt>, <tt>apt-get source paketti</tt> ja <tt>dpkg-deb -build pakettihakemisto</tt>, jolloin muutokset tehdään viimeksi mainittujen välissä (varsinainen muutos + uusi kohta tiedostoon <tt>debian/changelog</tt>). Jos paketti tehdään valmiista Debianin lähdekoodipaketista, kääntämisen binääripaketiksi voi hoitaa paketin hakemisen yhteydessä komennolla <tt>apt-get --compile source paketti</tt>. Lisätietoja näistä komennoista löytyy artikkeleista [[apt-get]] ja [[dpkg]].


== Valmistelut ==
== Valmistelut ==
Aluksi on asennettava muutamia perustyökaluja, jotka löytyvät seuraavista paketeista
Aluksi on hyvä asentaa muutamia perustyökaluja, jotka sisältävät paketointityössä tarvittavia tai valinnaisia apuohjelmia. Asenna siis seuraavat paketit (<tt>[[APT#apt|apt]] install <i>paketit</i></tt>):
*dpkg-dev
dpkg-dev autoconf dh-make devscripts [[fakeroot]] [[Gpg|gnupg]] build-essential lintian libtool automake pbuilder
*autoconf
*dh-make
*devscripts
*[[fakeroot]]
*[[Gpg|gnupg]]
*build-essential
*lintian
*linda


Kun tarvittavat paketit on asennettu, lataa Hello-ohjelman lähdekoodi ja [[tar|pura]] se työhakemistoosi. Nyt sinulla pitäisi olla työhakemistossasi tiedosto <tt>hello-2.2.tar.gz</tt> ja hakemisto <tt>hello-2.2</tt>.
Kun paketit on asennettu, lataa Hello-ohjelman lähdekoodi ja [[tar|pura]] se työhakemistoosi (<code>tar xzvf ''tiedosto''</code>). Nyt sinulla pitäisi olla työhakemistossasi tiedosto <tt>hello-2.10.tar.gz</tt> ja hakemisto <tt>hello-2.10</tt>.


== Valmistelu ==
== Paketoinnin aloitus ==
Aluksi kannattaa kokeilla, että saat ohjelman [[Kääntäminen|käännettyä]] ja ajettua. Sinun pitäisi osata tehdä tämä, jos luet tätä opasta, mutta lyhykäisyydessään voit asentaa Hellon hakemistoon ~/hello seuraavasti:
Aluksi kannattaa kokeilla, että saat ohjelman [[Kääntäminen|käännettyä]] ja ajettua. Sinun pitäisi jo osata tehdä tämä, jos luet tätä opasta, mutta lyhykäisyydessään voit asentaa Hellon hakemistoon <tt>~/hello</tt> seuraavasti:
  ./configure --prefix=/home/käyttäjä/hello
  ./configure --prefix=/home/käyttäjä/hello
  [[make]]
  [[make]]
Rivi 31: Rivi 23:


=== Pohja ===
=== Pohja ===
Siirry ohjelman hakemistoon (hello-2.2) ja aja komento
Siirry ohjelman hakemistoon (hello-2.10) ja aja komento
  dh_make -e sinun@sähköpostiosoitteesi -f ../hello-2.2.tar.gz
  dh_make -e sinun@sähköpostiosoitteesi -f ../hello-2.10.tar.gz
Toinen parametri on siis paketin tekijän sähköpostiosoite ja neljäs alkuperäinen lähdekooditiedosto. Kysyy aluksi, minkätyyppistä pakettia olemme luomassa:
Toinen parametri on siis paketin tekijän sähköpostiosoite ja neljäs alkuperäinen lähdekooditiedosto. Ohjelma kysyy aluksi, minkätyyppistä pakettia olemme luomassa:
  Type of package: single binary, multiple binary, library, kernel module or cdbs?
  Type of package: (single, indep, library, python)
  [s/m/l/k/b]
  [s/i/l/p]?
Vastaa tähän s (''single binary''), sillä olemme luomassa yksinkertaista yhden ohjelman käsittävää pakettia. Tämän jälkeen vahvista tiedot entterillä, jonka jälkeen dh_make luo hakemistoon <tt>debian</tt>-alihakemiston, joka sisältää tiedostot, joiden perusteella varsinainen paketti luodaan. Se myös luo ylähakemistoon tiedoston <tt>paketti_versio.orig.tar.gz</tt>, tässä tapauksessa siis <tt>hello_2.2.orig.tar.gz</tt> joka sisältää alkuperäisen lähdekoodipaketin.
Vastaa tähän s (''single binary''), sillä olemme luomassa yksinkertaista yhden ohjelman käsittävää pakettia. Tämän jälkeen vahvista tiedot enterillä, jonka jälkeen dh_make luo hakemistoon <tt>debian</tt>-alihakemiston, joka sisältää tiedostot, joiden perusteella varsinainen paketti luodaan. Se myös luo ylähakemistoon tiedoston <tt>paketti_versio.orig.tar.gz</tt>, tässä tapauksessa siis <tt>hello_2.10.orig.tar.gz</tt>, joka sisältää alkuperäisen lähdekoodipaketin.


Huomaa, että <tt>dh_make</tt> kuuluu ajaa vain kerran! Tulevien muutosten jälkeen sitä ei tarvitse (eikä saa) ajaa.
Huomaa, että <tt>dh_make</tt> kuuluu ajaa vain kerran! Tulevien muutosten pohjalla käytetään paketin olemassa olevaa <tt>debian</tt>-kansiota, eikä dh_makea siis tarvitse ajaa uudelleen.


== Asennushakemisto ==
== Asennushakemisto ==
Paketin luova työkalu päättelee paketin tiedostot siten, että ohjelma asennetaan sen valvonnassa väliaikaiseen alihakemistoon. Yleensä tämä alihakemisto on <tt>debian/paketin_nimi</tt>, jonne paketti asennetaan aivan normaalisti: esimerkiksi Hellon binääri menisi hakemistoon <tt>debian/hello-2.2/usr/bin/hello</tt>.
Paketin luova työkalu päättelee paketin tiedostot siten, että ohjelma asennetaan sen valvonnassa väliaikaiseen alihakemistoon. Yleensä tämä alihakemisto on <tt>debian/paketin_nimi</tt>, jonne paketti asennetaan aivan normaalisti: esimerkiksi Hellon binääri menisi hakemistoon <tt>debian/hello/usr/bin/hello</tt>.


[[Autoconf]]ia käyttävien pakettien kanssa (pääasiassa ohjelmat, jotka asennetaan komennolla <tt>./configure && make && make install</tt>) paketin luoma työkalu osaa hoitaa tämän automaattisesti, eikä sinun tarvitse tässä vaiheessa tehdä mitään. Kuten huomasit asentaessamme ohjelmaa oppaan alussa, annoimme configure-skriptille parametrin <tt>--prefix=/hakemisto/jonne/ohjelma/asennetaan</tt>. Paketoija antaa configurelle samalla tavalla sopivan parametrin, jolloin ohjelma asentuu oikeaan paikkaan.
Muiden muassa [[Autoconf]]ia, [[CMake]]a ja [[QMake]]a käyttävien pakettien kanssa paketin luoma työkalu osaa hoitaa tämän automaattisesti, eikä sinun tarvitse tässä vaiheessa tehdä mitään. Kuten huomasit asentaessamme ohjelmaa oppaan alussa, annoimme configure-skriptille parametrin <tt>--prefix=/hakemisto/jonne/ohjelma/asennetaan</tt>. Paketointiapuohjelma antaa configurelle samalla tavalla sopivan parametrin, jolloin ohjelma asentuu oikeaan paikkaan.


Jos ohjelma ei käytä autoconfia, on asennushakemistosta huolehdittava itse. Tämä tulee eteen kun myöhemmin muokkaamme tiedostoa <tt>debian/rules</tt>.
Joskus, kun ohjelman kääntäminen ei suju Debhelperiltä automaattisesti, asennushakemistosta on huolehdittava itse. Tämä tulee eteen kun myöhemmin muokkaamme tiedostoa <tt>debian/rules</tt>.


== Asetustiedostot ==
== Asetustiedostot ==
Dh_make loi <tt>debian</tt>-hakemiston, joka sisältää monia tiedostoja, joiden perusteella itse paketti luodaan. Tässä vaiheessa on käytävä ne läpi ja muokattava sopiviksi.
<tt>dh_make</tt> loi <tt>debian</tt>-hakemiston, joka sisältää monia tiedostoja, joiden perusteella itse paketti luodaan. Tässä vaiheessa on käytävä ne läpi ja muokattava sopiviksi.


=== control ===
=== control ===
Tiedostossa <tt>debian/control</tt> kerrotaan perustiedot paketista ja sen riippuvuuksista. Meidän tapauksessamme dh_make loi seuraavanlaisen pohjan (rivinumerot lisätty):
Tiedostossa <tt>debian/control</tt> kerrotaan perustiedot paketista ja sen riippuvuuksista. Meidän tapauksessamme dh_make loi seuraavanlaisen pohjan:
<pre>
<source lang="debcontrol" line>
1  Source: hello
Source: hello
2  Section: unknown
Section: unknown
3  Priority: extra
Priority: optional
4  Maintainer: Paketin Tekijä <foo@bar.com>
Maintainer: Paketin Tekijä <foo@bar.com>
5  Build-Depends: debhelper (>= 5), autotools-dev
Build-Depends: debhelper (>= 9), autotools-dev
6  Standards-Version: 3.7.2
Standards-Version: 3.9.8
7
Homepage: <insert the upstream URL, if relevant>
8  Package: hello
Vcs-Git: git://anonscm.debian.org/collab-maint/hello.git
9  Architecture: any
Vcs-Browser: https://anonscm.debian.org/cgit/collab-maint/hello.git
10 Depends: ${shlibs:Depends}, ${misc:Depends}
 
11 Description: <insert up to 60 chars description>
Package: hello
12 <insert long description, indented with spaces>
Architecture: any
</pre>
Depends: ${shlibs:Depends}, ${misc:Depends}
Riveillä 1-6 on ''lähdekoodipaketin'' (engl. ''source'') perustiedot:
Description: <insert up to 60 chars description>
*Rivillä 1 on lähdekoodipaketin nimi
<insert long description, indented with spaces>
*Rivillä 2 kerrotaan, mihin osioon paketti kuuluu. Debianissa paketit osioihin, joita ovat mm. ''main'' (vapaat ohjelmat), ''non-free'' (ohjelmat, jotka eivät ole vapaita) ja ''contrib'' (ohjelmat, jotka riippuvat vapaista ohjelmista). Nämä ohjelmat on yhä jaettu pienempiin osioihin, kuten ''devel'' (kehitystyökalut) ja ''mail'' (sähköpostiohjelmat). Hellolle sopiva osio voisi olla ''text''. Osiot on listattu [http://www.debian.org/doc/debian-policy/ch-archive.html#s-subsections Debian policyssä].
</source>
*Kolmannella rivillä kerrotaan, kuinka tärkeää käyttäjälle on asentaa tämä paketti. Vaikka "Terve maailma!" -viestin tulostava ohjelma voi tuntua tärkeältä, ehkäpä se ei kuitenkaan ole yhtä tärkeä kuin vaikka ydin, joten jätetään sen tärkeysasteeksi ''extra''.
Riveillä 1–9 on ''lähdekoodipaketin'' (engl. ''source'') perustiedot:
*Neljännellä rivillä on paketin tekijän nimi ja sähköpostiosoite
* Rivillä 1 on lähdekoodipaketin nimi
*Rivillä 5 listataan pilkulla erotettuna paketit, jotka tarvitaan tämän paketin kääntämiseen. Jos ohjelmasta on oltava tietty versio, haluttu versio voidaan ilmoittaa sulkeissa (esimerkissä tarvitaan ''debhelper''-paketin versio 5 tai uudempi). Käytännössä aina tarvittavia paketteja (esim. gcc ja make) ei tarvitse luetella, sillä ne otetaan mukaan automaattisesti. Kuitenkin kaikki muut kääntämisessä tarvittavat vähänkin harvinaisemmat paketit on lueteltava. Tässä vaiheessa voitaisiin myös samalla tavalla luetella paketit, jotka estävät kääntämisen (''Build-Conflicts: paketti1, paketti2''). Hello on sen verran helppo kääntää, ettei meidän tarvitse nyt lisätä tähän mitään ylimääräisiä paketteja.
* Rivillä 2 kerrotaan, mihin osioon paketti kuuluu. Debianissa paketit osioihin, joita ovat mm. ''main'' (vapaat ohjelmat), ''non-free'' (ohjelmat, jotka eivät ole vapaita) ja ''contrib'' (ohjelmat, jotka riippuvat vapaista ohjelmista). Nämä ohjelmat on yhä jaettu pienempiin osioihin, kuten ''devel'' (kehitystyökalut) ja ''mail'' (sähköpostiohjelmat). Hellolle sopiva osio voisi olla ''text''. Osiot on listattu [http://www.debian.org/doc/debian-policy/ch-archive.html#s-subsections Debian policyssä].
*Rivillä 6 kerrotaan, minkä ''Debian Policy'' -standardin version mukainen paketti on. Tähän ei tarvitse koskea.
* Kolmannella rivillä kerrotaan, kuinka tärkeää käyttäjälle on asentaa tämä paketti. Vaikka "Terve maailma!" -viestin tulostava ohjelma voi tuntua tärkeältä, ehkäpä se ei kuitenkaan ole yhtä tärkeä kuin vaikka ydin, joten asetetaan sen tärkeysasteeksi ''optional'', jota käytetään useimmille paketeille.
*Rivillä 8 on varsinaisen binääripaketin nimi. Yleensä se on sama kuin lähdekoodipaketin nimi.
* Neljännellä rivillä on paketin tekijän nimi ja sähköpostiosoite
*Rivillä 9 kerrotaan, millä arkkitehtuurilla paketti toimii. Jätetään tämä arvoon "any", jolloin paketin tekevä työkalu huolehtii arkkitehtuurista. Jos paketti toimii kaikilla arkkitehtuureilla (esim. se on ohjepaketti tai [[Perl]]-skripti), arkkitehtuuriksi laitetaan "all".
* Rivillä 5 listataan pilkulla erotettuna paketit, jotka tarvitaan tämän paketin kääntämiseen. Jos ohjelmasta on oltava tietty versio, haluttu versio voidaan ilmoittaa sulkeissa (esimerkissä tarvitaan ''debhelper''-paketin versio 9 tai uudempi). Käytännössä aina tarvittavia paketteja (esim. gcc ja make) ei tarvitse luetella, sillä ne otetaan mukaan automaattisesti. Kuitenkin kaikki muut kääntämisessä tarvittavat vähänkin harvinaisemmat paketit on lueteltava. Tässä vaiheessa voitaisiin myös samalla tavalla luetella paketit, jotka estävät kääntämisen (''Build-Conflicts: paketti1, paketti2''). Hello on sen verran helppo kääntää, ettei meidän tarvitse nyt lisätä tähän mitään ylimääräisiä paketteja.
*Rivillä 10 listataan paketit, jotka ovat binääripaketin riippuvuuksia. Koska Hello ei tarvitse mitään erityisiä paketteja, jätetään tämä tyhjäksi. "''${shllibs:Debends}''" huolehtii siitä, että kriittisimmät paketit, kuten libc, ovat asennettuina.  
* Rivillä 6 kerrotaan, minkä ''Debian Policy'' -standardin version mukainen paketti on. Tähän ei tarvitse koskea.
*Lopuksi paketille annetaan vielä lyhyt (suositus noin 60 merkkiä) ja pitkä kuvaus. Pitkä kuvaus kirjoitetaan tiedoston loppuun siten, että jokaisen rivin alussa on välilyönti. Näin lopullinen <tt>control</tt>-tiedosto voisi näyttää tältä:
* Riville 7 kirjoitetaan ohjelman kotisivu.
<pre>
* Riveillä 8 ja 9 voidaan kertoa, missä [[versionhallintajärjestelmä]]ssä debian-pakettia ylläpidetään. Me voimme poistaa nämä rivit, koska emme tässä käytä versionhallintaa.
 
Riveillä 11–15 on ''binääripaketin'' tiedot:
* Rivillä 11 on varsinaisen binääripaketin nimi. Yleensä se on sama kuin lähdekoodipaketin nimi.
* Rivillä 12 kerrotaan, millä arkkitehtuurilla paketti toimii. Jätetään tämä arvoon "any", jolloin paketin tekevä työkalu huolehtii arkkitehtuurista. Jos paketti toimii kaikilla arkkitehtuureilla (esim. jos se on ohjepaketti tai [[Perl]]- tai [[Python]]-skripti), arkkitehtuuriksi laitetaan "all".
* Rivillä 13 listataan paketit, jotka ovat binääripaketin riippuvuuksia. Koska Hello ei tarvitse mitään erityisiä paketteja, jätetään tämä tyhjäksi. "''${shlibs:Depends}''" aiheuttaa sen, että pakettia luotaessa pyritään riippuvuuksiksi lisäämään automaattisesti ne paketit, joiden tiedostoja vasten tämän paketin konekieliset tiedostot on linkitetty.
* Lopuksi paketille annetaan vielä lyhyt (suositus noin 60 merkkiä) ja pitkä kuvaus. Pitkä kuvaus kirjoitetaan tiedoston loppuun siten, että jokaisen rivin alussa on välilyönti. Tyhjiä rivejä voidaan tehdä laittamalla riville pelkästään piste. Näin lopullinen <tt>control</tt>-tiedosto voisi näyttää tältä:
<source lang="debcontrol" line>
Source: hello
Source: hello
Section: text
Section: text
Priority: extra
Priority: optional
Maintainer: Tekijä <foo@bar.com>
Maintainer: Paketin Tekijä <foo@bar.com>
Build-Depends: debhelper (>= 5), autotools-dev
Build-Depends: debhelper (>= 9), autotools-dev
Standards-Version: 3.7.2
Standards-Version: 3.9.8
Homepage: https://www.gnu.org/software/hello/


Package: hello
Package: hello
Rivi 91: Rivi 91:
  Klassinen Hello world -ohjelma, jonka avulla opettelemme  
  Klassinen Hello world -ohjelma, jonka avulla opettelemme  
  deb-pakettien tekemistä.
  deb-pakettien tekemistä.
</pre>
</source>


=== Suositeltavat paketit, konfliktit ja muut suhteet toisiin paketteihin ===
==== Suositeltavat paketit, ristiriidat ja muut suhteet toisiin paketteihin ====
Riippuvuuksien lisäksi paketti voi myös suositella jonkun toisen paketin asentamista, tai se voi myös kieltäytyä asentumasta samaan järjestelmään jonkin toisen paketin kanssa (konfliktit). Tällaiset paketit esitellään <tt>control</tt>-tiedostossa samaan tapaan kuin riippuvuudet.  
Riippuvuuksien lisäksi paketti voi myös suositella jonkin toisen paketin asentamista, tai se voi myös kieltäytyä asentumasta samaan järjestelmään jonkin toisen paketin kanssa (ristiriita toisen paketin kanssa, engl. ''conflict''). Tällaiset paketit esitellään <tt>control</tt>-tiedostossa samaan tapaan kuin riippuvuudet.  


Riippuvuuksien lisäksi apt tukee seuraavia suhteita pakettien välillä:
Riippuvuuksien lisäksi apt tukee seuraavia suhteita pakettien välillä:
Rivi 100: Rivi 100:
*<tt>Suggests</tt>: Muita tämän paketin kanssa hyviä paketteja. Monet apt:n edustaohjelmat (kuten aptitude) näyttävät tämän listan, apt ei.
*<tt>Suggests</tt>: Muita tämän paketin kanssa hyviä paketteja. Monet apt:n edustaohjelmat (kuten aptitude) näyttävät tämän listan, apt ei.
*<tt>Pre-Depends</tt>: Vahvempi kuin Depends. Vaatii, että paketit on asennettu ja otettu käyttöön ennen kuin suostuu asentamaan tämän paketin. Käytetään erittäin harvoin.
*<tt>Pre-Depends</tt>: Vahvempi kuin Depends. Vaatii, että paketit on asennettu ja otettu käyttöön ennen kuin suostuu asentamaan tämän paketin. Käytetään erittäin harvoin.
*<tt>Conflicts</tt>: Paketit, joiden kanssa tätä pakettia ei voida asentaa.
*<tt>Conflicts</tt>: Paketit, joiden kanssa samaan järjestelmään tätä pakettia ei voida asentaa.
*<tt>Provides</tt>: Mitkä virtuaaliset paketit tämä paketti toteuttaa.
*<tt>Provides</tt>: Mitkä virtuaaliset paketit tämä paketti toteuttaa.
*<tt>Replaces</tt>: Paketit, jotka tämä paketti korvaa.
*<tt>Replaces</tt>: Paketit, jotka tämä paketti korvaa.


Jos esimerkiksi pakettimme nyt vaatisi paketin ''foo'' version 2.3 tai uudemman, paketti ''bar'' olisi myös kiva sen kanssa, ja pakettimme ei toimisi yhdessä ''libfoo'':n kanssa, voisimme lisätä seuraavat rivit:
Jos esimerkiksi pakettimme nyt vaatisi paketin ''foo'' version 2.3 tai uudemman, paketti ''bar'' olisi myös kiva sen kanssa, ja pakettimme ei toimisi yhdessä ''libfoo'':n kanssa, voisimme lisätä seuraavat rivit:
Depends: ${shlibs:Depends}, ${misc:Depends}, foo (>=2.3)
<source lang="debcontrol">
Recommends: bar
Depends: ${shlibs:Depends}, ${misc:Depends}, foo (>= 2.3)
Conflicts: libfoo
Recommends: bar
Conflicts: libfoo
</source>


Vastaavasti on mahdollista asettaa myös lähdekoodipaketille ''Build-Conflicts'' ja muut vastaavat suhteet.
Vastaavasti on mahdollista asettaa myös lähdekoodipaketille ''Build-Conflicts'' ja muut vastaavat suhteet.


=== copyright ===
=== copyright ===
Paketin tekijänoikeuksista kerrotaan tiedostossa <tt>debian/copyright</tt>. Tämän tiedoston muoto on periaatteessa vapaa, mutta hyvän tiedoston saa muokkaamalla dh_maken luomaa. Tässä tiedostosta tulee käydä ilmi paketin luoja, alkuperäinen tekijä ja ohjelman tekijänoikeustiedot (esim. GPL-lisenssin alainen).
Paketin tekijänoikeuksista kerrotaan tiedostossa <tt>debian/copyright</tt>. Tämän tiedoston muoto on periaatteessa vapaa, mutta kannattaa seurata [https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ Machine-readable debian/copyright file] -standardia. Hyvän tiedoston saa muokkaamalla dh_maken luomaa. Tässä tiedostosta tulee käydä ilmi paketin luoja, alkuperäinen tekijä ja ohjelman tekijänoikeustiedot (esim. [[GPL]]-lisenssin version 3 tai myöhemmän alainen).
 


=== changelog ===
=== changelog ===
dh_make luo seuraavanlaisen pohjan <tt>debian/changelog</tt>-tiedostolle: (rivinumerot lisätty)
dh_make luo seuraavanlaisen pohjan <tt>debian/changelog</tt>-tiedostolle: (rivinumerot lisätty)
<pre>
<pre>
1 hello (2.2-1) unstable; urgency=low
1 hello (2.10-1) unstable; urgency=medium
2
2
3  * Initial release (Closes: #nnnn)  <nnnn is the bug number of your ITP>
3  * Initial release (Closes: #nnnn)  <nnnn is the bug number of your ITP>
3
3
4  -- Tekijän Nimi <sähköposti@osoite.com>  Sat, 21 Apr 2007 23:59:27 +0300
4  -- Paketin Tekijä <foo@bar.com>  Fri, 29 Jul 2016 11:42:23 +0300
</pre>
</pre>
Rivillä 1 on aluksi paketin nimi (hello) ja versionumero (2.2-1). Seuraavana on jakelun nimi, johon paketti kuuluu (Debianilla on stable, testing ja unstable -jakelut). Unstable on yleensä hyvä. Viimeisenä on tieto paketin kiireellisyydestä (urgency), yleensä "low" on sille oikea arvo.  
Rivillä 1 on aluksi lähdekoodipaketin nimi (hello) ja versionumero (2.10-1). Seuraavana on jakelun nimi, johon paketti kuuluu (Debianilla on stable, testing ja unstable -jakelut). Yleensä uudet paketit ja päivitykset vanhoihin paketteihin lisätään ensin kehitysversioon, joka Debianilla on unstable. Viimeisenä on tieto paketin kiireellisyydestä (''urgency''), yleensä "medium" on sille oikea arvo.


Tämän jälkeen seuraavilla riveillä on itse muutosloki (engl. ''changelog''). Rivin alussa on kaksi välilyöntiä ja tähti (*). Viimeisenä (rivillä 4) on tieto paketin tekijästä ja tekoajankohdasta (esimerkin mukaisessa muodossa). Tämän rivin alussa on yksi välilyönti.
Tämän jälkeen seuraavilla riveillä on itse muutosloki (engl. ''changelog''). Rivin alussa on kaksi välilyöntiä ja tähti (*). Viimeisenä (rivillä 4) on tieto paketin tekijästä ja tekoajankohdasta (esimerkin mukaisessa muodossa). Tämän rivin alussa on yksi välilyönti.
Yleensä paketteihin tehdyt muutokset korjaavat joitain vianhallintajärjestelmään ilmoitettuja vikoja (bugeja). Jos paketti korjaa jonkin ilmoitetun vian, se ilmoitetaan muutoslokissa. Jos paketti esimerkiksi korjaa Debianin vianseurantajärjestelmän bugin numero 123456, tulee muutoslokissa esiintyä merkkijono <tt>Closes: #123456</tt>.
Muutoslokia pystyy muokkaamaan joko muokkaamalla tekstitiedostoa suoraan tai käyttämällä [[dch]]-komentoa (tai sen pidempää muotoa, komentoa <tt>debchange</tt>). Sopivan pohjan uudelle muutokselle saa luotua komennolla <tt>dch -i</tt>. Tämä avaa muutoslokin <tt>EDITOR</tt>-[[ympäristömuuttuja]]ssa asetettuun tekstieditoriin. Muutoksen tekijän nimi haetaan ympäristömuuttujasta <tt>DEBFULLNAME</tt> tai <tt>NAME</tt> ja sähköpostiosoite ympäristömuuttujasta <tt>DEBEMAIL</tt> tai <tt>EMAIL</tt>.


=== rules ===
=== rules ===
Rivi 132: Rivi 137:


Koska Hello käyttää autoconfia, osaa paketin luova työkalu tehdä tarvittavat asetukset itse, eikä meidän periaatteessa tarvitse edes koskea <tt>rules</tt>-tiedostoon. Katsotaan nyt kuitenkin sitä malliksi, sillä vähänkin monimutkaisempien pakettien kohdalla sitä on muokattava. Dh_maken luoma malli on seuraava: (rivinumerot lisätty)
Koska Hello käyttää autoconfia, osaa paketin luova työkalu tehdä tarvittavat asetukset itse, eikä meidän periaatteessa tarvitse edes koskea <tt>rules</tt>-tiedostoon. Katsotaan nyt kuitenkin sitä malliksi, sillä vähänkin monimutkaisempien pakettien kohdalla sitä on muokattava. Dh_maken luoma malli on seuraava: (rivinumerot lisätty)
<pre>
<source lang="make" line>
1  #!/usr/bin/make -f
#!/usr/bin/make -f
2  # -*- makefile -*-
# See debhelper(7) (uncomment to enable)
3  # Sample debian/rules that uses debhelper.
# output every command that modifies files on the build system.
4  # This file was originally written by Joey Hess and Craig Small.
#export DH_VERBOSE = 1
5  # As a special exception, when this file is copied by dh-make into a
 
6  # dh-make output file, you may use that output file without restriction.
# see FEATURE AREAS in dpkg-buildflags(1)
7  # This special exception was added by Craig Small in version 0.37 of dh-make.
#export DEB_BUILD_MAINT_OPTIONS = hardening=+all
8
 
9  # Uncomment this to turn on verbose mode.
# see ENVIRONMENT in dpkg-buildflags(1)
10 #export DH_VERBOSE=1
# package maintainers to append CFLAGS
11
#export DEB_CFLAGS_MAINT_APPEND  = -Wall -pedantic
12
# package maintainers to append LDFLAGS
13 # These are used for cross-compiling and for saving the configure script
#export DEB_LDFLAGS_MAINT_APPEND = -Wl,--as-needed
14 # from having to guess our platform (since we know it already)
 
15 DEB_HOST_GNU_TYPE  ?= $(shell dpkg-architecture -qDEB_HOST_GNU_TYPE)
%:
16 DEB_BUILD_GNU_TYPE  ?= $(shell dpkg-architecture -qDEB_BUILD_GNU_TYPE)
dh $@ --with autotools_dev
17
 
18
# dh_make generated override targets
19 CFLAGS = -Wall -g
# This is example for Cmake (See https://bugs.debian.org/641051 )
20
#override_dh_auto_configure:
21 ifneq (,$(findstring noopt,$(DEB_BUILD_OPTIONS)))
# dh_auto_configure -- # -DCMAKE_LIBRARY_PATH=$(DEB_HOST_MULTIARCH)
22        CFLAGS += -O0
</source>
23 else
 
24        CFLAGS += -O2
Jos tiedoston syntaksi on epäselvä, katso artikkeli [[Makefile]]. Suurin osa tiedoston sisällöstä on #-merkillä alkavia kommentteja, poikkeuksena kuitenkin ensimmäinen rivi, joka on erityinen [[wikipedia:en:Shebang (Unix)|#!-rivi]].
25 endif
 
26
Rivien 6–7 "hardening" viittaa [https://wiki.debian.org/Hardening#Environment_variables Debianin käyttöön ottamiin GCC-valitsimiin], joiden avulla voitaisiin estää mm. tietyntyyppisiä tietomurtoja.
27 config.status: configure
28        dh_testdir
29        # Add here commands to configure the package.
30        ./configure --host=$(DEB_HOST_GNU_TYPE) --build=$(DEB_BUILD_GNU_TYPE) --prefix=/usr \
31 --mandir=\$${prefix}/share/man --infodir=\$${prefix}/share/info CFLAGS="$(CFLAGS)" LDFLAGS="-Wl,-z,defs"
32
33
34 build: build-stamp
35
36 build-stamp: config.status
37        dh_testdir
38
39        # Add here commands to compile the package.
40        $(MAKE)
41        #docbook-to-man debian/hello.sgml > hello.1
42
43        touch $@
44
45 clean:
46        dh_testdir
47        dh_testroot
48        rm -f build-stamp
49
50        # Add here commands to clean up after the build process.
51        -$(MAKE) distclean
52 ifneq "$(wildcard /usr/share/misc/config.sub)" ""
53        cp -f /usr/share/misc/config.sub config.sub
54 endif
55 ifneq "$(wildcard /usr/share/misc/config.guess)" ""
56        cp -f /usr/share/misc/config.guess config.guess
57 endif
58
59
60        dh_clean
61
62 install: build
63        dh_testdir
64        dh_testroot
65        dh_clean -k
66        dh_installdirs
67
68        # Add here commands to install the package into debian/hello.
69        $(MAKE) DESTDIR=$(CURDIR)/debian/hello install
70
71
72 # Build architecture-independent files here.
73 binary-indep: build install
74 # We have nothing to do by default.
75
76 # Build architecture-dependent files here.
77 binary-arch: build install
78        dh_testdir
79        dh_testroot
80        dh_installchangelogs ChangeLog
81        dh_installdocs
82        dh_installexamples
83 #      dh_install
84 #      dh_installmenu
85 #      dh_installdebconf
86 #      dh_installlogrotate
87 #      dh_installemacsen
88 #      dh_installpam
89 #      dh_installmime
90 #      dh_python
91 #      dh_installinit
92 #      dh_installcron
93 #      dh_installinfo
94        dh_installman
95        dh_link
96        dh_strip
97        dh_compress
98        dh_fixperms
99  #      dh_perl
100 #      dh_makeshlibs
101        dh_installdeb
102        dh_shlibdeps
103        dh_gencontrol
104        dh_md5sums
105        dh_builddeb
106
107 binary: binary-indep binary-arch
108 .PHONY: build clean binary-indep binary-arch binary install
</pre>
Tiedoston alussa annetaan käännösoptiot, esimerkiksi [[gcc|C-kääntäjän]] käännösparametrit laitetaan muuttujaan CFLAGS. Tämä tehdään riveillä 19-25.


Riveillä 27-31 ajetaan paketin <tt>configure</tt>-skripti. Koska Hello käyttää autoconfia ja siten <tt>configure</tt>-skriptiä, voimme välittää tässä vaiheessa tarvittavat parametrit. Saatat ihmetellä, miksi tässä annetaan parametrit <tt>--prefix=/usr</tt>, vaikka juuri todettiin, että ohjelma on asennettava <tt>debian/hello</tt>-alihakemistoon. Rivillä 69, kun ajetaan paketin asennuskomento, kuitenkin asetetaan kohdehakemistoksi <tt>debian/hello</tt>, jolloin paketti asentuu polkuun <tt>debian/hello/usr</tt>.
Riveillä 9–13 asetetaan käännösoptiot, jos niitä tarvitsee erikseen määritellä. Esimerkiksi [[gcc|C-kääntäjän]] käännösparametrit laitetaan muuttujaan DEB_CFLAGS_MAINT_APPEND, C++-kääntäjän muuttujaan DEB_CXXFLAGS_MAINT_APPEND ja linkittäjän ([[ld]]) muuttujaan DEB_LDFLAGS_MAINT_APPEND.


Jos tiedoston syntaksi on epäselvä, katso artikkeli [[Makefile]]. Paketti asennetaan monessa vaiheessa, aluksi riviltä 27 lähtien ajetaan <tt>configure</tt>-skripti <tt>config.status</tt>-osiossa. Tämän jälkeen ohjelma käännetään <tt>build</tt>-osiossa riviltä 34 eteenpäin.  
Rivillä 15 oleva Makefilen jokerimerkki (engl. ''wildcard'') '''%''' tarkoittaa, että kun kutsutaan <tt>debian/rules ''build''</tt> tai <tt>debian/rules ''binary''</tt>, make suorittaa rivin 16 mukaan komennon <tt>dh ''build'' --with autotools_dev</tt> tai <tt>dh ''binary'' --with autotools_dev</tt>. Komento <tt>dh build</tt> taas puolestaan suorittaa pitkän listan erilaisia dh-alkuisia ohjelmia, jotka ovat debhelperin funktiokutsuja, jotka tekevät erilaisia pieniä operaatioita rakentaen pakettia. Mm. seuraavia funktioita on tarjolla:


<tt>build-indep</tt>-osiossa käännetään tai luodaan alustariippumattomat tiedostot. Hellon tapauksessa niitä ei ole. Riviltä 77 eteenpäin rakennetaan varsinaista alustariippuvaista binääripakettia. "dh_"-alkuiset rivit ovat debhelperin funktiokutsuja, jotka tekevät erilaisia pieniä operaatioita rakentaen pakettia. Mm. seuraavia funktioita on tarjolla:
{| border=1 class="mw-collapsible mw-collapsed"
{| border=1
|'''Komento'''
|'''Komento'''
|'''Kuvaus'''
|'''Kuvaus'''
Rivi 258: Rivi 178:
|<tt>dh_testroot</tt>
|<tt>dh_testroot</tt>
|Tarkistaa, että meillä on pääkäyttäjän oikeudet kun niitä tarvitaan
|Tarkistaa, että meillä on pääkäyttäjän oikeudet kun niitä tarvitaan
|-
|<tt>dh_auto_configure</tt>
|Suorittaa ./configure:n tai vastaavan vaiheen
|-
|<tt>dh_auto_build</tt>
|Kääntää paketin
|-
|<tt>dh_auto_install</tt>
|Suorittaa make installin tai vastaavan asentamisvaiheen
|-
|-
|<tt>dh_strip</tt>
|<tt>dh_strip</tt>
Rivi 284: Rivi 213:
|}
|}


Jos paketti ei käytä autoconfia, on <tt>rules</tt> muokattava sellaiseksi, että ohjelma kääntyy ja asentuu polkuun <tt>debian/''paketinnimi''</tt>. Se, miten kääntäminen tapahtuu, riippuu ohjelmasta. Funktion <tt>dh_install</tt> avulla asennetaan tiedostot oikeisiin hakemistoihin lopullisessa binaaripaketissa.
Taulukossa on vain osa dh-funktioista, loput ovat man-sivulla debhelper(7). Rules-tiedostossamme viimeisenä on esimerkki ''override targetista'', jollainen ajetaan vastaavan dh-ohjelman sijasta.


=== dirs ===
Jos paketti ei jotain yleisistä käännösjärjestelmistä (kuten Ant, GNU Autotools, CMake, QMake tai tavallinen Makefile), on <tt>rules</tt> muokattava sellaiseksi, että ohjelma kääntyy ja asentuu polkuun <tt>debian/''paketinnimi''</tt>. Se, miten kääntäminen tapahtuu, riippuu ohjelmasta. Funktion <tt>dh_install</tt> avulla asennetaan tiedostot oikeisiin hakemistoihin lopullisessa binääripaketissa.
Tiedostossa <tt>debian/dirs</tt> luetellaan hakemistot, joiden pitää olla olemassa kun ohjelmaa asennetaan mutta joita ohjelma ei normaalin asennusprosessin aikana luo. Esimerkiksi <tt>/usr/bin</tt> on monesti tällainen.


<tt>dirs</tt>-tiedostossa hakemistot luetellaan omilla riveillään, ja ensimmäinen kauttaviiva jätetään pois. Hellon tapauksessa meille riittää kirjoittaa tähän tiedostoon rivi
=== compat ===
  usr/bin
Tässä tiedostossa ilmoitamme, mitä versiota debhelperistä paketista käytetään. Kirjoitushetkellä viimeisin vakaa versio on 9.
 
=== source/format ===
Tätä tiedostoa ei tarvitse muuttaa. Sen sisältö on:
  3.0 (quilt)
Quilt viittaa [[#Patchit|patchien hallintaan]] käyttämäämme ohjelmaan. 3.0:n merkityksestä voi lukea tarkemmin Debian Wikin artikkelista [https://wiki.debian.org/Projects/DebSrc3.0 DebSrc3.0].


=== .ex-päätteiset tiedostot ===
=== .ex-päätteiset tiedostot ===
Rivi 308: Rivi 241:
Ohjelman [[man]]-sivu. Pisteen jälkeen oleva numero kertoo, mihin kategoriaan man-sivu asennetaan (kategoriat on listattu artikkelissa [[man]]). Man-sivu asennetaan paikoilleen <tt>rules</tt>-tiedostossa olevalla komennolla <tt>dh_installman debian/mansivu.1</tt>. Tiedoston nimi on yleensä muotoa <tt>paketinnimi.numero</tt>.
Ohjelman [[man]]-sivu. Pisteen jälkeen oleva numero kertoo, mihin kategoriaan man-sivu asennetaan (kategoriat on listattu artikkelissa [[man]]). Man-sivu asennetaan paikoilleen <tt>rules</tt>-tiedostossa olevalla komennolla <tt>dh_installman debian/mansivu.1</tt>. Tiedoston nimi on yleensä muotoa <tt>paketinnimi.numero</tt>.


==== manpage.sgml ====
==== watch ====
SGML-muodossa kirjoitettu man-sivu. Pakettia käännettäessä (<tt>rules</tt>-tiedoston <tt>build</tt>-osiossa) se on käännettävä komennolla <tt>docbook-to-man debian/manpage.xml > debian/paketti.1</tt>. Käännösaikaisiksi riippuvuudeksi on lisättävä paketti <tt>docbook-to-man</tt>. Man-sivu asennetaan paikoilleen <tt>dh_installman</tt>-komennolla kuten edellä.
Kertoo <tt>uscan</tt>-ohjelmalle, miten paketin uudet versiot voi ladata internetistä. Lisätietoja tiedostomuodosta: <code>man 1 uscan</code> ja [https://wiki.debian.org/debian/watch Debian Wiki]. Watch-tiedosto mahdollistaa lähdekoodipaketin helpon päivittämisen aina uusimpaan versioon.
 
[[GNU]]:n projekteille, jollainen Hellokin on, toimii seuraavanlainen watch-tiedosto:
version=4
<nowiki>http://ftp.gnu.org/gnu/@PACKAGE@/</nowiki> \
    @PACKAGE@@ANY_VERSION@@ARCHIVE_EXT@ debian uupdate


== Tehdään paketti! ==
== Tehdään paketti! ==
Nyt kun tarvittavat tiedostot on lopulta muokattu sopiviksi, on aika luoda varsinainen paketti. Siirry ohjelman päähakemistoon (<tt>hello-2.2</tt>) ja aja komento
Nyt kun tarvittavat tiedostot on lopulta muokattu sopiviksi, on aika luoda varsinainen paketti. Siirry ohjelman päähakemistoon (<tt>hello-2.10</tt>) ja aja komento
  debuild
  debuild
joka tekee seuraavat asiat:
joka tekee seuraavat asiat:
Rivi 320: Rivi 258:
*Allekirjoittaa .dsc-tiedoston [[gpg|gnupgllä]]
*Allekirjoittaa .dsc-tiedoston [[gpg|gnupgllä]]
*Luo ja allekirjoittaa .changes-tiedoston
*Luo ja allekirjoittaa .changes-tiedoston
*Käyttää [[fakeroot]]tia, jolloin pääkäyttäjän oikeuksia ei tarvita
*Käyttää [[fakeroot]]ia, jolloin pääkäyttäjän oikeuksia ei tarvita
Allekirjoitus vaatii, että olet luonut [[gpg]]:llä itsellesi avaimen. Tällöin sinulta kysytään avaimesi salasanaa.
Allekirjoitus vaatii, että olet luonut [[gpg]]:llä itsellesi avaimen. Tällöin sinulta kysytään avaimesi salasanaa.


Tämän jälkeen, jos kaikki sujui ilman virheitä, ylähakemistosta pitäisi löytyä seuraavat tiedostot:
Tämän jälkeen, jos kaikki sujui ilman virheitä, ylähakemistosta pitäisi löytyä seuraavat tiedostot:
*<tt>hello_2.2.orig.tar.gz</tt> - alkuperäinen lähdekoodi
*<tt>hello_2.10-1_amd64.build</tt> – kääntämisloki (''build log'')
*<tt>hello_2.2-1.dsc</tt> - [[gpg]]:llä allekirjoitettu <tt>control</tt>-tiedoston kaltainen tiedosto, jossa on listattu lähdekooditiedoston ja diff-tiedoston [[md5]]-summat
*<tt>hello_2.10-1_amd64.changes</tt> – [[gpg]]:llä allekirjoitettu tiedosto, joka sisältää paketin muutoslokin (<tt>debian/changelog</tt>) ja pakettiin liittyvien tiedostojen [[SHA]]1- ja SHA256-summat
*<tt>hello_2.2-1.diff.gz</tt> - [[gzip]]-pakattu [[diff]]-tiedosto lähdekoodiin tehdyistä muutoksista
*<tt>hello_2.10-1_amd64.deb</tt> – lopullinen deb-paketti!
*<tt>hello_2.2-1_i386.deb</tt> - lopullinen deb-paketti!
*<tt>hello_2.10-1.debian.tar.xz</tt> – <tt>debian-hakemiston</tt> sisältö [[xz]]-pakattuna tar-arkistona
*<tt>hello_2.2-1_i386.changes</tt> - [[gpg]]:llä allekirjoitettu tiedosto, joka sisältää paketin muutoslokin (<tt>debian/changelog</tt>) ja pakettiin liittyvien tiedostojen md5-summat
*<tt>hello_2.10-1.dsc</tt> – [[gpg]]:llä allekirjoitettu <tt>control</tt>-tiedoston kaltainen tiedosto, jossa on listattu lähdekooditiedoston ja diff-tiedoston SHA1- ja SHA256-summat
*<tt>hello_2.10.orig.tar.gz</tt> – alkuperäinen lähdekoodi


Nyt lopullinen paketti voidaan asentaa [[dpkg]]:llä:
Nyt lopullinen paketti voidaan asentaa [[dpkg]]:llä:
  dpkg -i hello_2.2-1_i386.deb
  dpkg -i hello_2.10-1_amd64.deb


Kun myöhemmin teet muutoksia pakettiin, voit luoda uuden paketin nopeasti komennolla
Kun myöhemmin teet muutoksia pakettiin, voit luoda uuden paketin nopeasti komennolla
Rivi 338: Rivi 277:


=== Lähdekoodipaketti ===
=== Lähdekoodipaketti ===
Edellä teimme tavallisen ns. ''binääripaketin'', joka sisältää valmiiksi käännetyn ohjelman. Monesti on tarpeen tehdä myös lähdekoodipaketti, joka sisältää pakettiin ja sen kääntämiseen ja asentamiseen liittyvät tiedot (<tt>debian</tt>-hakemisto) ja ohjelman lähdekoodin. Tällöin paketti on mahdollista kääntää ja asentaa jokaiselle sopivalle alustalle kun taas käännetty <tt>.deb</tt>-paketti toimii vain yhdellä alustalla (esim. x86).
Edellä teimme tavallisen ns. ''binääripaketin'', joka sisältää valmiiksi käännetyn ohjelman. Monesti on tarpeen tehdä myös lähdekoodipaketti, joka sisältää pakettiin ja sen kääntämiseen ja asentamiseen liittyvät tiedot (<tt>debian</tt>-hakemisto) ja ohjelman lähdekoodin. Tällöin paketti on mahdollista kääntää ja asentaa jokaiselle sopivalle alustalle kun taas käännetty <tt>.deb</tt>-paketti toimii vain yhdellä alustalla (esim. amd64, i386 tai armhf).


Lähdekoodipaketteja käytetään etenkin kun paketti julkaistaan esimerkiksi lisäämällä se jonkin jakelun virallisiin pakettilähteisiin. Tällöin kehittäjä yleensä vain lähettää palvelimelle lähdekoodipaketin, jonka palvelin sitten kääntää useille eri arkkitehtuureille.
Lähdekoodipaketteja käytetään etenkin kun paketti julkaistaan esimerkiksi lisäämällä se jonkin jakelun virallisiin pakettilähteisiin. Tällöin kehittäjä yleensä vain lähettää palvelimelle lähdekoodipaketin, jonka palvelin sitten kääntää useille eri arkkitehtuureille.
Rivi 346: Rivi 285:
Missä valitsin <tt>-S</tt> tarkoittaa, että luodaan lähdekoodipaketti ja <tt>-sa</tt> sisällyttää pakettiin mukaan alkuperäisen lähdekooditiedoston (<tt>.orig.tar.gz</tt>). Tällöin ylähakemistoon pitäisi ilmestyä samanlaisten tiedostojen kuin luotaessa binääripakettia, paitsi että varsinaista <tt>.deb</tt>-pakettia ei ilmesty.  
Missä valitsin <tt>-S</tt> tarkoittaa, että luodaan lähdekoodipaketti ja <tt>-sa</tt> sisällyttää pakettiin mukaan alkuperäisen lähdekooditiedoston (<tt>.orig.tar.gz</tt>). Tällöin ylähakemistoon pitäisi ilmestyä samanlaisten tiedostojen kuin luotaessa binääripakettia, paitsi että varsinaista <tt>.deb</tt>-pakettia ei ilmesty.  


Nyt lähdekoodipaketti koostuu näistä tiedostoista (<tt>paketti.dsc</tt>, <tt>paketti.orig.tar.gz</tt> ja <tt>paketti.diff.gz</tt>), ja sitä voidaan hallita esimerkiksi <tt>dpkg-source</tt>-ohjelmalla. Jos esimerkiksi olet saanut jostain lähdekoodipaketin, voit purkaa ja kääntää seuraavasti
Nyt lähdekoodipaketti koostuu näistä tiedostoista (<tt>paketti.dsc</tt>, <tt>paketti.orig.tar.gz</tt> ja <tt>paketti.debian.tar.xz</tt>), ja sitä voidaan hallita esimerkiksi <tt>dpkg-source</tt>-ohjelmalla. Jos esimerkiksi olet saanut jostain lähdekoodipaketin, voit purkaa ja kääntää seuraavasti
  dpkg-source -x paketti.dsc
  dpkg-source -x paketti.dsc
  cd paketti
  cd paketti
  debuild
  debuild


Ilman <tt>debuildin</tt> <tt>-sa</tt>-valitsinta voi luoda paketin, joka ei sisällä alkuperäistä lähdekoodia. Tälle on käyttöä silloin, kun paketteja pidetään ulkopuolisessa pakettivarastossa ja uusi versio voidaan julkaista vain lähettämällä palvelimelle uusi lähdekoodipaketti ilman alkuperäistä lähdekoodia (kunhan alkuperäinen lähdekooditiedosto <tt>.orig.tar.gz</tt> ei ole muuttunut).
Ilman <tt>debuildin</tt> <tt>-sa</tt>-valitsinta voi luoda paketin, joka ei sisällä alkuperäistä lähdekoodia. Tälle on käyttöä silloin, kun paketteja pidetään ulkopuolisessa pakettivarastossa ja uusi versio voidaan julkaista vain lähettämällä palvelimelle uusi lähdekoodipaketti ilman alkuperäistä lähdekoodia. Tällainen tilanne tulee eteen, kun paketista tehdään uusi versio joka ei muuta itse ohjelman lähdekoodia tai muuttaa sitä erillisellä <tt>patch</tt>-tiedostolla (eli ohjelman tekijä ei ole julkaissut uutta versiota, mutta paketin tekijä tekee muutoksia joko itse ohjelmaan tai paketointiin).


== Lintian ja linda: onnistuiko paketti? ==
== Lintian: onnistuiko paketti? ==
Lintian ja linda ovat ohjelmia, jotka tarkistavat tekemäsi paketin laadun. Molemmille ohjelmille annetaan parametrina pakettia luotaessa syntynyt <tt>.changes</tt>-päätteinen tiedosto. Yleensä kannattaa antaa niille myös valitsin -i:
Lintian on ohjelma, joka tarkistaa tekemäsi paketin laadun. Sille annetaan parametrina pakettia luotaessa syntynyt <tt>.changes</tt>-päätteinen tiedosto. Yleensä kannattaa antaa myös valitsimet -E, -v, -i ja -I (iso ''i''), jolloin lintian kertoo tarkemmin, mikä paketissa on vialla:
  lintian -i hello_2.2-1_i386.changes
  lintian -EviI hello_2.10-1_amd64.changes
linda -i hello_2.2-1_i386.changes
Tulosteessa E:-alkavat rivit tarkoittavat virhettä, W:-alkavat varoituksia ja N:-alkavat huomautuksia.
Tulosteessa E:-alkavat rivit tarkoittavat virhettä, W:-alkavat varoituksia ja N:-alkavat huomautuksia.


Jos esimerkiksi et poistanut <tt>debian</tt>-hakemistosta <tt>.ex</tt>-päätteisiä tiedostoja, lintian ja linda varoittavat niistä. Yleensä paketin tulisi olla sellainen, etteivät lintian ja linda löydä niistä mitään valitettavaa.
Jos esimerkiksi et poistanut <tt>debian</tt>-hakemistosta <tt>.ex</tt>-päätteisiä tiedostoja, lintian varoittaa niistä. Yleensä paketin tulisi olla sellainen, ettei lintian löydä siitä mitään valitettavaa.


== Patchit ==
== Patchit ==
Joskus pakettia tehtäessä on tehtävä muutoksia myös itse ohjelman lähdekoodiin. Tällöin on siistiä pitää muutokset erillään [[patch]]-tiedostoissa. Kun binääripaketti sitten tehdään, otetaan patchit käyttöön ennen kääntämistä.
Joskus pakettia tehtäessä on tehtävä muutoksia myös itse ohjelman lähdekoodiin. Tällöin on siistiä pitää muutokset erillään [[patch]]-tiedostoissa. Kun binääripaketti sitten tehdään, otetaan patchit käyttöön ennen kääntämistä.
(Huomio! Debianin kehittäjien keskuudessa on keskusteltu patch-järjestelmien yhdenmukaistamisesta Debianin lähdekoodipaketeissa. Tässä artikkelissa esitetty tapa ei välttämättä ole suositeltava käytäntö, vaikka se sinänsä toimiikin. Aika paljon kannatusta on saanut esimerkiksi [[quilt]]-niminen patch-järjestelmä.)
Patchien hallintaan on monia aputyökaluja, mutta yksinkertaisimmillaan se hoituu näin:
*Pura alkuperäinen lähdekoodipaketti polkuihin <tt>/tmp/new</tt> ja <tt>/tmp/old</tt>
*Tee muutokset hakemistoon <tt>/tmp/new</tt>
*Aja hakemistossa <tt>tmp</tt> komento
[[diff]] -Nurp old new > 01_patchin-nimi
:Joka luo patchin tiedostoon <tt>01_patchin-nimi</tt> (yleensä patchien edessä on numero, ja patchit otetaan käyttöön numerojärjestyksessä). Optiot -Nurp aiheuttavat sen, että diff ottaa huomioon myös uudet tiedostot (-N) ja käy hakemistot läpi rekursiivisesti (-r)
*Luo paketin <tt>debian</tt>-hakemistoon alihakemisto <tt>patches</tt> ja kopioi äsken luomasi patchi sinne (<tt>cp /tmp/01_patchin-nimi debian/patches/</tt>)
*Lisää <tt>debian/rules</tt>-tiedostoon seuraavat kohdat, jotka ottavat patchit käyttöön ennen ohjelman kääntämistä ja poistavat ne käytöstä hakemistoa "siivottaessa":
patch: patch-stamp
<pre>
patch-stamp:
dh_testdir  # Oikea hakemisto
        # Kaikille .patch-päätteisille tiedostoille patches-hakemistossa
@patches=debian/patches/*.patch; for patch in $$patches; do \ 
test -f $$patch || continue; \
echo "Applying $$patch"; \
patch -stuN -p1 < $$patch || exit 1; \  # Otetaan pathci käyttöön
done
touch $@
# Patchien poistaminen (ajettaessa make clean), palauttaa lähdekoodin alkuperäiseksi
unpatch:
dh_testdir
@if test -f patch-stamp; then \
patches=debian/patches/*.patch; \
for patch in $$patches; do \  # Kerätään kaikki patchit
reversepatches="$$patch $$reversepatches"; \
done; \
for patch in $$reversepatches; do \
test -f $$patch || continue; \
echo "Reversing $$patch"; \
patch -suRf -p1 < $$patch || exit 1; \  # Poistetaan patchi
done; \
rm -f patch-stamp; \
fi
</pre>
*Huolehdi siitä, että patch: ja unpatch: -kohdat ajetaan oikeaan aikaan: muuta rivi
build: build-stamp
:muotoon
build: patch-stamp build-stamp
Ja rivi
clean:
muotoon
clean: unpatch
== Pbuilder ==
Pbuilder on järjestelmä, joka kääntää ja rakentaa paketit omassa pienessä [[chroot]]-järjestelmässä. Pbuilderia käytettäessä saavutetaan mm. seuraavat edut:
#Käännösaikaiset riippuvuudet (''build-depends'') asennetaan automaattisesti
#Paketti käännetään puhtaassa ja mahdollisimman yksinkertaisessa ympäristössä, johon ei ole asennettu mitään ylimääräistä. Näin varmistetaan, että paketin kääntäminen onnistuu kaikissa järjestelmissä ja että käännösaikaiset riippuvuudet ovat riittävät.
#Paketin voi kääntää eri jakeluille ja jopa eri arkkitehtuurille
Pbuilderin käyttö aloitetaan luomalla käännösympäristö komennolla (pääkäyttäjän oikeuksin)
pbuilder create
Komento luo tiedoston <tt>/var/cache/pbuilder/base.tgz</tt>, joka sisältää pakatun chroot-ympäristön. Ympäristön luominen kestää jonkin aikaa, sillä se lataa tarvittavat paketit palvelimelta, asentaa ne chroot-järjestelmään ja lopuksi pakkaa luodun järjestelmän.
Tämän jälkeen Pbuilderin vaatimat valmistelut on tehty ja paketit voidaan kääntää siinä ajamalla paketin hakemistossa komento <tt>pdebuild</tt>. Käännetty paketti löytyy hakemistosta <tt>/var/cache/pbuilder/result</tt>.
=== Pintaa syvemmälle ===
Monesti Pbuilderia halutaan käyttää luomaan paketteja muille jakeluille tai arkkitehtuureille (esimerkiksi 64-bittisessä [[Debian]]issa luodaan Pbuilderilla paketti 32-bittiselle [[Ubuntu]]lle). Tätä varten on luotava chroot-ympäristöt kaikille näille jakeluille ja tehtävä muutamia asetuksia.
Tehdään seuraavaksi sellaiset asetukset, että voimme luoda paketteja sekä Debianin että Ubuntun eri versioille. Muut Debian-pohjaiset jakelut on mahdollista ottaa käyttöön samalla tavalla. Tehdään Pbuilderin asetukset lisäämällä tiedostoon <tt>~/.pbuilderrc</tt> seuraavat rivit:
<pre>
#Tarvittavia muuttujia
: ${DIST:=$(lsb_release --short --codename)}
: ${ARCH:=$(dpkg --print-architecture)}
NAME="$DIST-$ARCH"
DISTRIBUTION="$DIST"
DEBOOTSTRAPOPTS=("--arch" "$ARCH" "${DEBOOTSTRAPOPTS[@]}")
BASETGZ="`dirname $BASETGZ`/$NAME-base.tgz"
BUILDRESULT="/var/cache/pbuilder/$NAME/result/" # Hakemisto luotaville paketeille
APTCACHE="/var/cache/pbuilder/$NAME/aptcache/"
case "$DIST" in
    intrepid|hardy|gutsy) # Ubuntu
        MIRRORSITE="http://fi.archive.ubuntu.com/ubuntu/"
        COMPONENTS="main restricted universe multiverse"
        ;;
    sid|lenny|etch) # Debian
        MIRRORSITE="http://ftp.fi.debian.org/debian/"
        COMPONENTS="main contrib non-free"
        ;;
    *)
        echo "Unknown distribution: $DIST"
        exit 1
        ;;
esac
</pre>
Jolloin Pbuilder tunnistaa käytettävän jakelun <tt>DIST</tt>-[[ympäristömuuttuja]]sta ja arkkitehtuurin <tt>ARCH</tt>-ympäristömuuttujasta. Jos ympäristömuuttujille ei erikseen anneta arvoja, käytetään nykyisen järjestelmän tietoja.
Nyt voimme luoda chroot-ympäristöt eri jakeluille määrittelemällä tarvittavat ympäristömuuttujat, esimerkiksi 32-bittiselle Debian Sidille (Debianin kehitysversio) luodaan ympäristö komennolla (pääkäyttäjänä)
DIST=sid ARCH=i386 pbuilder create
Kun halutut ympäristöt on luotu, voidaan paketit kääntää tässä ympäristössä käyttäen samoja ympäristömuuttujia, esimerkkitapauksessamme
DIST=sid ARCH=i386 pdebuild
Luotu paketti löytyy hakemistosta <tt>/var/cache/pbuilder/sid-i386/</tt>.


== Muut pakettityypit ==
== Muut pakettityypit ==
Rivi 469: Rivi 309:


Debhelper mahdollistaa useampien pakettien luomisen yhdestä lähdekoodipaketista varsin yksinkertaisesti. Ensinnäkin jokaiselle paketille kirjoitetaan oma osio <tt>debian/control</tt>-tiedostoon. Tiedostoon tulee aluksi normaalisti lähdekoodipaketin tiedot, ja tämän jälkeen luotavien binääripakettien tiedot peräkkäin. Esimerkki:
Debhelper mahdollistaa useampien pakettien luomisen yhdestä lähdekoodipaketista varsin yksinkertaisesti. Ensinnäkin jokaiselle paketille kirjoitetaan oma osio <tt>debian/control</tt>-tiedostoon. Tiedostoon tulee aluksi normaalisti lähdekoodipaketin tiedot, ja tämän jälkeen luotavien binääripakettien tiedot peräkkäin. Esimerkki:
<pre>
<source lang="debcontrol">
Source: hello
Source: hello
Section: unknown
Section: unknown
Priority: extra
Priority: extra
Maintainer: Ylläpitäjä <sähkö@ơsti>
Maintainer: Paketin Tekijä <foo@bar.com>
Build-Depends: debhelper (>= 5), autotools-dev
Build-Depends: debhelper (>= 9), autotools-dev
Standards-Version: 3.7.3
Standards-Version: 3.9.8


Package: hello
Package: hello
Rivi 490: Rivi 330:
Description: Hellon ohjeet
Description: Hellon ohjeet
  Monipuoliset käyttöohjeet hello world -sovelluksen käyttöön.
  Monipuoliset käyttöohjeet hello world -sovelluksen käyttöön.
</pre>
</source>
 
Tämän jälkeen muutetaan paketin asentamista (<tt>debian/install</tt>) siten, että esimerkiksi pakettiin <tt>hello</tt> kuuluvat tiedostot asennettaisiin hakemistoon <tt>debian/hello/</tt> ja paketin <tt>hello-doc</tt>-tiedostot hakemistoon <tt>debian/hello-doc</tt>. Näihin hakemistoihin tiedostot asennetaan kuten normaalisti luotaessa vain yhtä pakettia, eli esimerkiksi ajettavat ohjelmat voitaisiin sijoittaa polkuun <tt>debian/hello/usr/bin/</tt>.
 
Jos jokin Debhelperin komento (muotoa <tt>dh_jotain</tt>) halutaan <tt>rules</tt>-tiedostossa ajaa vain tietylle paketille, voidaan käyttää valitsinta <tt>--package</tt> eli lyhyemmin <tt>-p</tt>, esimerkiksi komennolla
<source lang="makefile">
override_dh_installinfo:
dh_installinfo -phello
</source>
asennettaisiin [[info]]-tiedostot vain <tt>hello</tt>-pakettia luotaessa.
 
== Pbuilder ==
Pbuilder on järjestelmä, joka kääntää ja rakentaa paketit omassa pienessä [[chroot]]-järjestelmässä. Pbuilderia käytettäessä saavutetaan mm. seuraavat edut:
#Käännösaikaiset riippuvuudet (''build-depends'') asennetaan automaattisesti
#Paketti käännetään puhtaassa ja mahdollisimman yksinkertaisessa ympäristössä, johon ei ole asennettu mitään ylimääräistä. Näin varmistetaan, että paketin kääntäminen onnistuu kaikissa järjestelmissä ja että käännösaikaiset riippuvuudet ovat riittävät.
#Paketin voi kääntää eri jakeluille ja jopa eri arkkitehtuurille


Tämän jälkeen muutetaan paketin asentamista (<tt>debian/rules</tt>) siten, että esimerkiksi pakettiin <tt>hello</tt> kuuluvat tiedostot asennettaisiin hakemistoon <tt>debian/hello/</tt> ja paketin <tt>hello-doc</tt>-tiedostot hakemistoon <tt>debian/hello-doc</tt>. Näihin hakemistoihin tiedostot asennetaan kuten normaalisti luotaessa vain yhtä pakettia, eli esimerkiksi ajettavat ohjelmat voitaisiin sijoittaa polkuun <tt>debian/hello/usr/bin/</tt>.
Lisätietoja Pbuilderin käytöstä löytyy artikkelista [[Pbuilder]].


Tällaisessa tilanteessa ei yleensä ole järkevää käyttää <tt>dirs</tt>-tiedostoa luomaan samat hakemistot molempiin paketteihin, koska luultavasti samoihin hakemistoihin ei sijoiteta tiedostoja eri paketeissa. Sen sijaan voidaan käyttää pakettikohtaisia tiedostoja, esimerkiksi <tt>hello.dirs</tt> ja <tt>hello-doc.dirs</tt>.
== Paketin päivittäminen ja muokkaaminen ==
Edellä käsiteltiin uuden paketin tekemistä. Monesti eteen tulee kuitenkin myös tilanteita, joissa jo olemassa olevaa pakettia tulee muuttaa tai päivittää. Päivittämiselle tulee tarve kun paketoidusta ohjelmasta julkaistaan uusi versio tai vaikkapa silloin, kun ohjelmassa oleva ohjelmavirhe (bugi) korjataan ''patch''-tiedostolla.


Jos jokin Debhelperin komento (muotoa <tt>dh_jotain</tt>) halutaan <tt>rules</tt>-tiedostossa ajaa vain tietylle paketille, voidaan käyttää valitsinta <tt>--package</tt>, esimerkiksi komennolla
Muokkauksen tekeminen alkaa hakemalla lähdekoodipaketti. Tämä onnistuu kätevästi komennolla <tt>[[apt-get]] source paketti</tt>. Tällöin <tt>apt</tt> hakee nykyiseen hakemistoon paketin <tt>.dsc</tt>-tiedoston, muutokset sisältävän <tt>.diff.gz</tt>-tiedoston ja alkuperäisen ohjelman sisältävän <tt>.tar.gz</tt>-paketin. Lisäksi hakemistoon syntyy <tt>ohjelmannimi-versio</tt>-hakemisto, jonka sisältä löytyy sekä itse ohjelma että siihen tehdyt muutokset (mm. <tt>debian</tt>)-hakemisto.
dh_installinfo --package=hello
asennettaisiin [[info]]-tiedostot vain <tt>hello</tt>-pakettia luotaessa.


== CDBS ==
Jos nyt halutaan esimerkiksi korjata ohjelmassa oleva bugi, voidaan edellä neuvotulla tavalla lisätä pakettiin uusi <tt>patch</tt>-tiedosto. Tämän lisäksi on aina muistettava kirjata tiedot muutoksesta <tt>debian/changelog</tt>-tiedostoon. Tämä onnistuu helpoiten komennolla <tt>dch -i</tt>. Muutoslokin on tarkoitus tarkkaan kertoa, mitä muutoksia on tehty. Yleensä muutos korjaa jonkun vianhallintajärjestelmässä olevan ilmoitetun bugin, jolloin muutoslokissa mainitaan tämän bugin numero (Debianin vianseurantajärjestelmän kanssa käytetään syntaksia <tt>Closes: #numero</tt> ja Ubuntun Launchpad-järjestelmässä ilmoitettujen bugien kanssa syntaksia LP: #numero).
Edellä tehtiin paketti käyttäen Debhelperiä, jolloin <tt>rules</tt>-tiedoston kirjoittaminen oli hyvinkin työlästä. CDBS (''Common Debian Build System'') on toinen lähestymistapa pakettien luomiseen: sitä käytettäessä [[Autotools]]ia käyttävän paketin <tt>rules</tt>-tiedosto vaatii vain 4 riviä!


CDBS on modulaarinen apuohjelma paketin tekemiseen. Sitä käytettäessä <tt>rules</tt>-tiedostossa sisällytetään halutut moduulit, jotka hoitavat esimerkiksi pakettin kääntämisestä ja patchien käyttöönotosta. Ideana on, että monissa paketeissa samoina toistuvat osiot (esim. paketin kääntäminen ja patchien käsittely) on siirretty yhteen paikkaan, eikä niitä tarvitse aina kirjoittaa uudestaan.
Jos paketoidusta ohjelmasta on ilmestynyt uusi versio, täytyy toimia hieman eri tavalla. Ensimmäinen tehtävä on ladata uuden ohjelman lähdekoodipaketti ja tutustua uuden version mukana tuomiin muutoksiin (<tt>NEWS</tt>- tai <tt>CHANGELOG</tt>-tiedosto). Tämän jälkeen puretaan paketti tiedostoon <tt>ohjelmannimi-versio</tt> ja uudelleennimetään lähdekoodipakettitiedosto nimelle <tt>ohjelman_versio.orig.tar.gz</tt>. Eli aivan kuin olisimme paketoimassa uutta ohjelmaa.  


CDBS:ää käytettäessä paketin käännösaikaisiin riippuvuuksiin on lisättävä <tt>cdbs</tt>.
Tämän jälkeen voidaan kopioida vanha ''debianisointi'' eli <tt>debian</tt>-hakemisto vanhasta paketista uuteen pakettiin. Helpoimmissa tapauksissa tämä riittää, mutta etenkin käytettävien patchien toimiminen ja tarpeellisuus uuden version kanssa on todella tärkeä selvittää. Lisäksi ohjelman kääntäminen ja asentaminen saattaa uuden version kanssa tapahtua eri tavalla. Tällaisessa tapauksessa muutoslokiin kirjataan maininta uudesta versiosta ("New upstream release") ja kerrotaan myös, mitä muita muutoksia pakettiin tehtiin (esimerkiksi jätettiin pois tarpeettomaksi käynyt patchi.


Esimerkiksi edellä paketoimamme <tt>hello</tt>-ohjelman <tt>rules</tt>-tiedostona riittäisi seuraava:
Uuden version numero riippuu siitä, paketoitiinko uusi versio vai korjattiinko vain vanhassa versiossa oleva ongelma. Jos itse ohjelman versio ei muuttunut, kasvatetaan paketin "revision"-numeroa yhdellä, esimerkiksi versio "0.4.1-2" muuttuisi versioksi "0.4.1-3". Jos taas ohjelman versio muuttui, asetetaan paketin versioksi uuden version numero ja "revisioniksi" asetetaan 1: "0.4.1-2" -> "0.4.2-1".
<pre>
#!/usr/bin/make -f
                               
include /usr/share/cdbs/1/rules/debhelper.mk
include /usr/share/cdbs/1/class/autotools.mk
</pre>
Kuten huomaat, CDBS:ää käytetään sisällyttämällä <tt>.mk</tt>-päätteisiä Makefile-tiedostoja. Näitä tiedostoja tulee CDBS:n mukana useita ja niitä voi asentaa myös muista paketeista lisää (jolloin kyseinen paketti on lisättävä käännösaikaiseksi riippuvuudeksi).


Eräitä CDBS:n <tt>.mk</tt>-tiedostoja ovat:
Näiden toimenpiteiden jälkeen voidaan paketti luoda kuten normaalistikin <tt>debuild</tt>- ja <tt>pdebuild</tt>-komennoilla.
{| border=1
|'''Tiedosto'''
|'''Kuvaus'''
|-
|<tt>rules/debhelper.mk</tt>
|Käyttää Debhelperiä tarvittavissa kohdissa
|-
|<tt>rules/dpatch.mk</tt><br><tt>rules/simple-patchsys.mk</tt>
|Patch-järjestelmiä
|-
|<tt>class/autotools.mk</tt>
|Käyttää Autotoolsia tarvittavissa kohdissa
|-
|<tt>class/gnome.mk</tt>
|Rakentaa paketin [[GNOME]]-ohjelmalle
|-
|<tt>class/kde.mk</tt>
|Rakentaa paketin [[KDE]]-ohjelmalle
|-
|<tt>class/python-distutils.mk</tt>
|[[Python]]-ohjelmien paketointiin
|}


CDBS:n kanssa ei kuitenkaan tarvitse rajoittua vain <tt>.mk</tt>-tiedostoihin. Jos vaikkapa asennuksen aikana on tehtävä joitain harvinaisempia toimenpiteitä, ne voidaan lisätä <tt>rules</tt>-tiedostoon hieman samaan tyyliin kuin käytettäessä debhelperiä. Esimerkiksi jos paketin <tt>hello</tt> asennuksen yhteydessä on muutettava jonkin tiedoston oikeuksia, se onnistuu lisäämällä <tt>rules</tt>-tiedostoon kohta
===Debdiff===
binary-install/hello::
Debdiff on [[diff]]in kaltainen ohjelma, joka vertailee kahta deb-pakettia. Sitä käytetään mm. silloin, kun lähetetään itse tehty korjaus ohjelman alkuperäiselle paketoijalle tai vianseurantajärjestelmään. Yleensä näin toimitaan silloin, kun muutoksen tekijällä ei ole oikeutta lähettää korjauksiaan suoraan virallisiin pakettivarastoihin.
    chmod o+x /usr/bin/hello
Mahdollisia kohtia ovat mm.
{| border=1
|'''Toiminto'''
|'''Suoritus'''
|-
|<tt>binary-install/paketti::</tt>
|Paketin luomisen yhteydessä
|-
|<tt>build/paketti::</tt>
|Kääntämisen yhteydessä
|-
|<tt>clean::</tt>
|Siivottaessa käännöshakemistoa
|}


===Patchit===
Debdiffille annetaan kahden lähdekoodipaketin <tt>.dsc</tt>-tiedostot:
Kuten edellä jo mainittiin, CDBS helpottaa myös patchien käyttöä. Sen mukana tulee useita erilaisia <tt>.mk</tt>-tiedostoja, jotka toteuttavat hieman erilaiset patch-järjestelmät.
debdiff vanha.dsc uusi.dsc
Jolloin ohjelma tulostaa erot ruudulle. Yleensä erot kannattaa [[Komentorivin perusteet#putkitus|putkittaa]] tiedostoon:
debdiff vanha.dsc uusi.dsc > erot.debdiff


''Simple patchsys'' on nimensä mukaisesti yksinkertainen patch-järjestelmä. Sitä käytettäessä ennen lähdekoodin kääntämistä otetaan käyttöön hakemistossa <tt>debian/patches</tt> olevat patchit aakkosjärjestyksessä (yleensä tiedostot ovat nimeltään muotoa <tt>numero-nimi.patch</tt>, esim. <tt>10-korjaa_makefile.patch</tt>, jolloin ne otetaan käyttöön numerojärjestyksessä). Myöskään sillä ei ole väliä, kuinka monta polkua patchin tiedostopoluista on jätettävä huomiotta (<tt>[[patch]]in</tt> valitsin <tt>-p</tt>), sillä simple patchsys yrittää eri tasoja, kunnes patchin käyttöönotto onnistuu. Myös patchien poistaminen lähdekoodista siivouksen (''clean'') yhteydessä tapahtuu automaattisesti.
== Pakettini on valmis, miten saan sen jakeluni pakettilähteisiin ==
Paketin saaminen jakelun virallisiin pakettilähteisiin on jakelun käytännöistä riippuen enemmän tai vähemmän työläs prosessi, johtuen muun muassa laadunvarmistuksesta. Teknisellä tasolla paketit viedään jakeluihin [[dput]]- tai [[dupload]]-työkaluilla. Katso lisää näiden työkalujen käytöstä näiden omilta sivuilta.


Simple patchsys otetaan käyttöön lisäämällä <tt>rules</tt>-tiedostoon rivi
Debianilla on käytössä [http://mentors.debian.net mentors.debian.net]-palvelu, jonne kaikki voivat lähettää omia pakettejaan tarjolle lähdekoodimuodossa. Tämän jälkeen paketille hankitaan/pyydetään halukas "sponsori", joka on kokenut Debian-kehittäjä jolla on oikeudet lisätä paketteja virallisiin pakettilähteisiin. Sponsoreita haetaan yleensä lähettämällä viesti <tt>debian-mentors</tt>-sähköpostilistalle sivustolta löytyvien ohjeiden mukaan. Tämän jälkeen joku paketista kiinnostunut kehittäjä tarkistaa sen ja antaa yleensä korjausehdotuksia. Kun paketti on hänen mielestään riittävän laadukas, hän lisää sen pakettilähteisiin. Prosessi voi paketin laadusta ja sponsoroijasta riippuen kestää pitkäänkin, ja vapaaehtoisuuteen perustamalla saattaa vaatia omaa aktiivisuutta ja kohteliasta ajoittaista tiediustelua.
include /usr/share/cdbs/1/rules/simple-patchsys.mk


Järjestelmään kuuluu myös <tt>cdbs-edit-patch</tt>-työkalu, joka mahdollistaa patchien luomisen ja muokkaamisen interaktiivisesti. Esimerkiksi jos haluamme luoda uuden patchin tai muokata vanhaa, jonka nimi on <tt>10-korjaa_makefile.patch</tt>, se onnistuu seuraavasti:
Virallisten pakettilähteiden lisäksi voit myös ylläpitää omaa. Paketteja voi myös jakaa helposti esimerkiksi [[Launchpad | Launchpadin]] tarjoaman [[PPA]]-ominaisuuden avulla. PPA automatisoi paketin kääntämistä ja julkaisua. Halutessasi voit myös vain yksinkertaisesti jakaa tekemääsi deb-tiedostoa millä tahansa tiedostonjakotekniikalla.
#Ajetaan komento <tt>cdbs-edit-patch 10-korjaa_makefile.patch</tt>, jolloin CDBS luo projektihakemistosta väliaikaisen kopion, johon ottaa käyttöön kaikki luotavaa patchia aiemmin käyttöön otettavat patchit (joiden numero on pienempi kuin 10). Jos tällä nimellä on jo patchi olemassa, otetaan myös se käyttöön.
#CDBS siirtää komentorivin tähän väliaikaiseen hakemistoon, jonka tiedostoja voidaan nyt muokata aivan normaalisti esimerkiksi [[vim]]illä. Tehdään tässä tilassa halutut muutokset.
#Poistutaan väliaikaisesta työskentelytilasta näppäinyhdistelmällä ''Ctrl+D''. CDBS luo uuden patchin <tt>debian/patches</tt>-hakemistoon (tai päivittää vanhaa, jos muokkasimme jo olemassa olevaa patchia) ja palaa takaisin projektihakemistoon.
#Nyt luotu patchi on normaalisti käytössä kun pakettia käännetään.


===Lisätietoja===
==Katso myös==
*[https://perso.duckcorp.org/duck/cdbs-doc/cdbs-doc.xhtml CDBS:n dokumentaatio]
*[[CDBS]]


==Aiheesta muualla==
==Aiheesta muualla==
*[http://www.debian.org/doc/maint-guide/index.en.html#contents Debian New Maintainers' Guide]
*[http://www.debian.org/doc/maint-guide/index.en.html#contents Debian New Maintainers' Guide]
*[http://www.debian.org/doc/debian-policy/ Debian policy] - Debianin käytäntöjä ja sääntöjä
*[http://www.debian.org/doc/debian-policy/ Debian policy] - Debianin käytäntöjä ja sääntöjä
* Ubuntun [https://wiki.ubuntu.com/MOTU/School/PackagingBasics PackagingBasics]-opas
*Ubuntun [https://wiki.ubuntu.com/PackagingGuide PackagingGuide]-opas
*[http://doc.ubuntu.com/ubuntu/packagingguide/C/index.html Ubuntu Packaging Guide]
*[http://wiki.ubuntu.com/PackagingGuide Packaging guide - Ubuntu Wiki]
* [http://www.debian-administration.org/articles/286 Setting up your own APT reposity]
*[https://debian-administration.org/article/286/Setting_up_your_own_APT_repository_with_upload_support Setting up your own APT repository with upload support]
*Vincent Bernat: [https://vincent.bernat.im/en/blog/2016-pragmatic-debian-packaging.html Pragmatic Debian packaging]


[[Luokka:Ohjeet]]
[[Luokka:Ohjeet]]
[[Luokka:Paketinhallinta]]
[[Luokka:Paketinhallinta]]
[[Luokka:Debian GNU/Linux]]

Nykyinen versio 23. helmikuuta 2017 kello 16.36

Debianissa ja siihen pohjautuvissa jakeluissa (esim. Ubuntussa ja Linux Mintissä) käytetään Dpkg-paketinhallintajärjestelmää. Dpkg:ssa paketit ovat .deb-tiedostoja, jotka sisältävät itse ohjelman lisäksi mm. tiedot paketin riippuvuuksista ja siitä, mihin ohjelma asennetaan. Deb-pakettien tekeminen ei ole mitenkään ylivoimainen tehtävä, kunhan perusasiat ja mm. komentorivin käyttö ovat hallussa.

Tässä oppaassa luodaan aluksi malliksi yksinkertainen paketti GNU Hello -ohjelmasta, joka on GNU-projektin esimerkkiohjelma. Ohjelman lähdekoodipaketin voi ladata GNU:n palvelimelta. Paketin luomisessa käytetään tässä apuna Debhelper-apuohjelmaa (dh).

Debianin eri versiosta löytyvän paketin voi kääntää käytetylle versiolle sopivaksi tai pakettiin tehdä pieniä muutoksia huomattavasti helpommin kuin tätä ohjetta seuraamalla, komennoilla apt-get build-dep paketti, apt-get source paketti ja dpkg-deb -build pakettihakemisto, jolloin muutokset tehdään viimeksi mainittujen välissä (varsinainen muutos + uusi kohta tiedostoon debian/changelog). Jos paketti tehdään valmiista Debianin lähdekoodipaketista, kääntämisen binääripaketiksi voi hoitaa paketin hakemisen yhteydessä komennolla apt-get --compile source paketti. Lisätietoja näistä komennoista löytyy artikkeleista apt-get ja dpkg.

Valmistelut[muokkaa]

Aluksi on hyvä asentaa muutamia perustyökaluja, jotka sisältävät paketointityössä tarvittavia tai valinnaisia apuohjelmia. Asenna siis seuraavat paketit (apt install paketit): 

dpkg-dev autoconf dh-make devscripts fakeroot gnupg build-essential lintian libtool automake pbuilder

Kun paketit on asennettu, lataa Hello-ohjelman lähdekoodi ja pura se työhakemistoosi (tar xzvf tiedosto). Nyt sinulla pitäisi olla työhakemistossasi tiedosto hello-2.10.tar.gz ja hakemisto hello-2.10.

Paketoinnin aloitus[muokkaa]

Aluksi kannattaa kokeilla, että saat ohjelman käännettyä ja ajettua. Sinun pitäisi jo osata tehdä tämä, jos luet tätä opasta, mutta lyhykäisyydessään voit asentaa Hellon hakemistoon ~/hello seuraavasti: 

./configure --prefix=/home/käyttäjä/hello
make
make install

Nyt hakemistosta ~/hello pitäisi löytyä alihakemistot bin ja share, joissa Hellon tiedostot ovat.

Putsaa nyt hakemisto, jossa käänsit Hellon komennolla 

make distclean

Nyt jos ohjelma kääntyi oikein, voimme aloittaa itse paketin tekemisen.

Pohja[muokkaa]

Siirry ohjelman hakemistoon (hello-2.10) ja aja komento 

dh_make -e sinun@sähköpostiosoitteesi -f ../hello-2.10.tar.gz

Toinen parametri on siis paketin tekijän sähköpostiosoite ja neljäs alkuperäinen lähdekooditiedosto. Ohjelma kysyy aluksi, minkätyyppistä pakettia olemme luomassa: 

Type of package: (single, indep, library, python)
[s/i/l/p]?

Vastaa tähän s (single binary), sillä olemme luomassa yksinkertaista yhden ohjelman käsittävää pakettia. Tämän jälkeen vahvista tiedot enterillä, jonka jälkeen dh_make luo hakemistoon debian-alihakemiston, joka sisältää tiedostot, joiden perusteella varsinainen paketti luodaan. Se myös luo ylähakemistoon tiedoston paketti_versio.orig.tar.gz, tässä tapauksessa siis hello_2.10.orig.tar.gz, joka sisältää alkuperäisen lähdekoodipaketin.

Huomaa, että dh_make kuuluu ajaa vain kerran! Tulevien muutosten pohjalla käytetään paketin olemassa olevaa debian-kansiota, eikä dh_makea siis tarvitse ajaa uudelleen.

Asennushakemisto[muokkaa]

Paketin luova työkalu päättelee paketin tiedostot siten, että ohjelma asennetaan sen valvonnassa väliaikaiseen alihakemistoon. Yleensä tämä alihakemisto on debian/paketin_nimi, jonne paketti asennetaan aivan normaalisti: esimerkiksi Hellon binääri menisi hakemistoon debian/hello/usr/bin/hello.

Muiden muassa Autoconfia, CMakea ja QMakea käyttävien pakettien kanssa paketin luoma työkalu osaa hoitaa tämän automaattisesti, eikä sinun tarvitse tässä vaiheessa tehdä mitään. Kuten huomasit asentaessamme ohjelmaa oppaan alussa, annoimme configure-skriptille parametrin --prefix=/hakemisto/jonne/ohjelma/asennetaan. Paketointiapuohjelma antaa configurelle samalla tavalla sopivan parametrin, jolloin ohjelma asentuu oikeaan paikkaan.

Joskus, kun ohjelman kääntäminen ei suju Debhelperiltä automaattisesti, asennushakemistosta on huolehdittava itse. Tämä tulee eteen kun myöhemmin muokkaamme tiedostoa debian/rules.

Asetustiedostot[muokkaa]

dh_make loi debian-hakemiston, joka sisältää monia tiedostoja, joiden perusteella itse paketti luodaan. Tässä vaiheessa on käytävä ne läpi ja muokattava sopiviksi.

control[muokkaa]

Tiedostossa debian/control kerrotaan perustiedot paketista ja sen riippuvuuksista. Meidän tapauksessamme dh_make loi seuraavanlaisen pohjan: 

Source: hello
Section: unknown
Priority: optional
Maintainer: Paketin Tekijä <foo@bar.com>
Build-Depends: debhelper (>= 9), autotools-dev
Standards-Version: 3.9.8
Homepage: <insert the upstream URL, if relevant>
Vcs-Git: git://anonscm.debian.org/collab-maint/hello.git
Vcs-Browser: https://anonscm.debian.org/cgit/collab-maint/hello.git

Package: hello
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Description: <insert up to 60 chars description>
 <insert long description, indented with spaces>

Riveillä 1–9 on lähdekoodipaketin (engl. source) perustiedot:

  • Rivillä 1 on lähdekoodipaketin nimi
  • Rivillä 2 kerrotaan, mihin osioon paketti kuuluu. Debianissa paketit osioihin, joita ovat mm. main (vapaat ohjelmat), non-free (ohjelmat, jotka eivät ole vapaita) ja contrib (ohjelmat, jotka riippuvat vapaista ohjelmista). Nämä ohjelmat on yhä jaettu pienempiin osioihin, kuten devel (kehitystyökalut) ja mail (sähköpostiohjelmat). Hellolle sopiva osio voisi olla text. Osiot on listattu Debian policyssä.
  • Kolmannella rivillä kerrotaan, kuinka tärkeää käyttäjälle on asentaa tämä paketti. Vaikka "Terve maailma!" -viestin tulostava ohjelma voi tuntua tärkeältä, ehkäpä se ei kuitenkaan ole yhtä tärkeä kuin vaikka ydin, joten asetetaan sen tärkeysasteeksi optional, jota käytetään useimmille paketeille.
  • Neljännellä rivillä on paketin tekijän nimi ja sähköpostiosoite
  • Rivillä 5 listataan pilkulla erotettuna paketit, jotka tarvitaan tämän paketin kääntämiseen. Jos ohjelmasta on oltava tietty versio, haluttu versio voidaan ilmoittaa sulkeissa (esimerkissä tarvitaan debhelper-paketin versio 9 tai uudempi). Käytännössä aina tarvittavia paketteja (esim. gcc ja make) ei tarvitse luetella, sillä ne otetaan mukaan automaattisesti. Kuitenkin kaikki muut kääntämisessä tarvittavat vähänkin harvinaisemmat paketit on lueteltava. Tässä vaiheessa voitaisiin myös samalla tavalla luetella paketit, jotka estävät kääntämisen (Build-Conflicts: paketti1, paketti2). Hello on sen verran helppo kääntää, ettei meidän tarvitse nyt lisätä tähän mitään ylimääräisiä paketteja.
  • Rivillä 6 kerrotaan, minkä Debian Policy -standardin version mukainen paketti on. Tähän ei tarvitse koskea.
  • Riville 7 kirjoitetaan ohjelman kotisivu.
  • Riveillä 8 ja 9 voidaan kertoa, missä versionhallintajärjestelmässä debian-pakettia ylläpidetään. Me voimme poistaa nämä rivit, koska emme tässä käytä versionhallintaa.

Riveillä 11–15 on binääripaketin tiedot:

  • Rivillä 11 on varsinaisen binääripaketin nimi. Yleensä se on sama kuin lähdekoodipaketin nimi.
  • Rivillä 12 kerrotaan, millä arkkitehtuurilla paketti toimii. Jätetään tämä arvoon "any", jolloin paketin tekevä työkalu huolehtii arkkitehtuurista. Jos paketti toimii kaikilla arkkitehtuureilla (esim. jos se on ohjepaketti tai Perl- tai Python-skripti), arkkitehtuuriksi laitetaan "all".
  • Rivillä 13 listataan paketit, jotka ovat binääripaketin riippuvuuksia. Koska Hello ei tarvitse mitään erityisiä paketteja, jätetään tämä tyhjäksi. "${shlibs:Depends}" aiheuttaa sen, että pakettia luotaessa pyritään riippuvuuksiksi lisäämään automaattisesti ne paketit, joiden tiedostoja vasten tämän paketin konekieliset tiedostot on linkitetty.
  • Lopuksi paketille annetaan vielä lyhyt (suositus noin 60 merkkiä) ja pitkä kuvaus. Pitkä kuvaus kirjoitetaan tiedoston loppuun siten, että jokaisen rivin alussa on välilyönti. Tyhjiä rivejä voidaan tehdä laittamalla riville pelkästään piste. Näin lopullinen control-tiedosto voisi näyttää tältä:
Source: hello
Section: text
Priority: optional
Maintainer: Paketin Tekijä <foo@bar.com>
Build-Depends: debhelper (>= 9), autotools-dev
Standards-Version: 3.9.8
Homepage: https://www.gnu.org/software/hello/

Package: hello
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Description: Hello world -ohjelma
 Klassinen Hello world -ohjelma, jonka avulla opettelemme 
 deb-pakettien tekemistä.

Suositeltavat paketit, ristiriidat ja muut suhteet toisiin paketteihin[muokkaa]

Riippuvuuksien lisäksi paketti voi myös suositella jonkin toisen paketin asentamista, tai se voi myös kieltäytyä asentumasta samaan järjestelmään jonkin toisen paketin kanssa (ristiriita toisen paketin kanssa, engl. conflict). Tällaiset paketit esitellään control-tiedostossa samaan tapaan kuin riippuvuudet.

Riippuvuuksien lisäksi apt tukee seuraavia suhteita pakettien välillä:

  • Recommends: Suositeltavat paketit. Yleensä paketteja, joita käytetään käytännössä aina tämän paketin kanssa. Esim. aptitude asentaa nämä automaattisesti, apt vain suosittelee.
  • Suggests: Muita tämän paketin kanssa hyviä paketteja. Monet apt:n edustaohjelmat (kuten aptitude) näyttävät tämän listan, apt ei.
  • Pre-Depends: Vahvempi kuin Depends. Vaatii, että paketit on asennettu ja otettu käyttöön ennen kuin suostuu asentamaan tämän paketin. Käytetään erittäin harvoin.
  • Conflicts: Paketit, joiden kanssa samaan järjestelmään tätä pakettia ei voida asentaa.
  • Provides: Mitkä virtuaaliset paketit tämä paketti toteuttaa.
  • Replaces: Paketit, jotka tämä paketti korvaa.

Jos esimerkiksi pakettimme nyt vaatisi paketin foo version 2.3 tai uudemman, paketti bar olisi myös kiva sen kanssa, ja pakettimme ei toimisi yhdessä libfoo:n kanssa, voisimme lisätä seuraavat rivit: 

Depends: ${shlibs:Depends}, ${misc:Depends}, foo (>= 2.3)
Recommends: bar
Conflicts: libfoo

Vastaavasti on mahdollista asettaa myös lähdekoodipaketille Build-Conflicts ja muut vastaavat suhteet.

copyright[muokkaa]

Paketin tekijänoikeuksista kerrotaan tiedostossa debian/copyright. Tämän tiedoston muoto on periaatteessa vapaa, mutta kannattaa seurata Machine-readable debian/copyright file -standardia. Hyvän tiedoston saa muokkaamalla dh_maken luomaa. Tässä tiedostosta tulee käydä ilmi paketin luoja, alkuperäinen tekijä ja ohjelman tekijänoikeustiedot (esim. GPL-lisenssin version 3 tai myöhemmän alainen).

changelog[muokkaa]

dh_make luo seuraavanlaisen pohjan debian/changelog-tiedostolle: (rivinumerot lisätty) 

1 hello (2.10-1) unstable; urgency=medium
2
3   * Initial release (Closes: #nnnn)  <nnnn is the bug number of your ITP>
3
4  -- Paketin Tekijä <foo@bar.com>  Fri, 29 Jul 2016 11:42:23 +0300

Rivillä 1 on aluksi lähdekoodipaketin nimi (hello) ja versionumero (2.10-1). Seuraavana on jakelun nimi, johon paketti kuuluu (Debianilla on stable, testing ja unstable -jakelut). Yleensä uudet paketit ja päivitykset vanhoihin paketteihin lisätään ensin kehitysversioon, joka Debianilla on unstable. Viimeisenä on tieto paketin kiireellisyydestä (urgency), yleensä "medium" on sille oikea arvo.

Tämän jälkeen seuraavilla riveillä on itse muutosloki (engl. changelog). Rivin alussa on kaksi välilyöntiä ja tähti (*). Viimeisenä (rivillä 4) on tieto paketin tekijästä ja tekoajankohdasta (esimerkin mukaisessa muodossa). Tämän rivin alussa on yksi välilyönti.

Yleensä paketteihin tehdyt muutokset korjaavat joitain vianhallintajärjestelmään ilmoitettuja vikoja (bugeja). Jos paketti korjaa jonkin ilmoitetun vian, se ilmoitetaan muutoslokissa. Jos paketti esimerkiksi korjaa Debianin vianseurantajärjestelmän bugin numero 123456, tulee muutoslokissa esiintyä merkkijono Closes: #123456.

Muutoslokia pystyy muokkaamaan joko muokkaamalla tekstitiedostoa suoraan tai käyttämällä dch-komentoa (tai sen pidempää muotoa, komentoa debchange). Sopivan pohjan uudelle muutokselle saa luotua komennolla dch -i. Tämä avaa muutoslokin EDITOR-ympäristömuuttujassa asetettuun tekstieditoriin. Muutoksen tekijän nimi haetaan ympäristömuuttujasta DEBFULLNAME tai NAME ja sähköpostiosoite ympäristömuuttujasta DEBEMAIL tai EMAIL.

rules[muokkaa]

Tiedosto debian/rules on Makefilen tapainen tiedosto, jonka perusteella varsinainen paketti luodaan. Tämän tiedoston perusteella ohjelma käännetään ja asennetaan hakemistoon debian/paketin_nimi, tässä tapauksessa debian/hello. Tähän hakemistoon asentuvien tiedostojen perusteella luodaan varsinainen paketti.

Koska Hello käyttää autoconfia, osaa paketin luova työkalu tehdä tarvittavat asetukset itse, eikä meidän periaatteessa tarvitse edes koskea rules-tiedostoon. Katsotaan nyt kuitenkin sitä malliksi, sillä vähänkin monimutkaisempien pakettien kohdalla sitä on muokattava. Dh_maken luoma malli on seuraava: (rivinumerot lisätty) 

#!/usr/bin/make -f
# See debhelper(7) (uncomment to enable)
# output every command that modifies files on the build system.
#export DH_VERBOSE = 1

# see FEATURE AREAS in dpkg-buildflags(1)
#export DEB_BUILD_MAINT_OPTIONS = hardening=+all

# see ENVIRONMENT in dpkg-buildflags(1)
# package maintainers to append CFLAGS
#export DEB_CFLAGS_MAINT_APPEND  = -Wall -pedantic
# package maintainers to append LDFLAGS
#export DEB_LDFLAGS_MAINT_APPEND = -Wl,--as-needed

%:
	dh $@ --with autotools_dev

# dh_make generated override targets
# This is example for Cmake (See https://bugs.debian.org/641051 )
#override_dh_auto_configure:
#	dh_auto_configure -- #	-DCMAKE_LIBRARY_PATH=$(DEB_HOST_MULTIARCH)

Jos tiedoston syntaksi on epäselvä, katso artikkeli Makefile. Suurin osa tiedoston sisällöstä on #-merkillä alkavia kommentteja, poikkeuksena kuitenkin ensimmäinen rivi, joka on erityinen #!-rivi.

Rivien 6–7 "hardening" viittaa Debianin käyttöön ottamiin GCC-valitsimiin, joiden avulla voitaisiin estää mm. tietyntyyppisiä tietomurtoja.

Riveillä 9–13 asetetaan käännösoptiot, jos niitä tarvitsee erikseen määritellä. Esimerkiksi C-kääntäjän käännösparametrit laitetaan muuttujaan DEB_CFLAGS_MAINT_APPEND, C++-kääntäjän muuttujaan DEB_CXXFLAGS_MAINT_APPEND ja linkittäjän (ld) muuttujaan DEB_LDFLAGS_MAINT_APPEND.

Rivillä 15 oleva Makefilen jokerimerkki (engl. wildcard) % tarkoittaa, että kun kutsutaan debian/rules build tai debian/rules binary, make suorittaa rivin 16 mukaan komennon dh build --with autotools_dev tai dh binary --with autotools_dev. Komento dh build taas puolestaan suorittaa pitkän listan erilaisia dh-alkuisia ohjelmia, jotka ovat debhelperin funktiokutsuja, jotka tekevät erilaisia pieniä operaatioita rakentaen pakettia. Mm. seuraavia funktioita on tarjolla:

Komento Kuvaus
dh_testdir Tarkistaa, että ollaan oikeassa hakemistossa
dh_testroot Tarkistaa, että meillä on pääkäyttäjän oikeudet kun niitä tarvitaan
dh_auto_configure Suorittaa ./configure:n tai vastaavan vaiheen
dh_auto_build Kääntää paketin
dh_auto_install Suorittaa make installin tai vastaavan asentamisvaiheen
dh_strip Ajaa strip-komennon suoritettaville tiedostoille, jolloin niiden koko pienenee
dh_compress Pakkaa gzipillä man-sivut ja ohjetiedostot, joiden koko ylittää 4kt
dh_gencontrol Luo binääripaketille control-tiedoston ja kopioi sen hakemistoon debian/hello/DEBIAN
dh_md5sums Laskee MD5-tarkistussummat paketin tiedostoille
dh_install Jos ohjelma ei asenna kaikkia tarpeellisia tiedostoja oikeisiin hakemistoihin autoconfin avulla (esim. komennolla make install), voi käyttää tätä apufunktiota, jolle kerrotaan asennettavat tiedostot ja hakemistot debian/paketinnimi.install-tiedostossa
dh_installchangelog Asentaa muutoslokin polkuun /usr/share/doc/package/changelog. Jos komennolle annetaan parametrina paketin mukana tulevan muutoslokin tiedostonimi, asennetaan myös se.
dh_shlibdeps Määrittää paketin riippuvuuksia binääritiedostoihin linkitettyjen kirjastotiedostojen perusteella
dh_installdocs Asentaa debian/docs-tiedostossa listatut tiedostot ja mm. debian/README.debian ja debian/copyright-tiedostot polkuun /usr/share/doc/paketti.

Taulukossa on vain osa dh-funktioista, loput ovat man-sivulla debhelper(7). Rules-tiedostossamme viimeisenä on esimerkki override targetista, jollainen ajetaan vastaavan dh-ohjelman sijasta.

Jos paketti ei jotain yleisistä käännösjärjestelmistä (kuten Ant, GNU Autotools, CMake, QMake tai tavallinen Makefile), on rules muokattava sellaiseksi, että ohjelma kääntyy ja asentuu polkuun debian/paketinnimi. Se, miten kääntäminen tapahtuu, riippuu ohjelmasta. Funktion dh_install avulla asennetaan tiedostot oikeisiin hakemistoihin lopullisessa binääripaketissa.

compat[muokkaa]

Tässä tiedostossa ilmoitamme, mitä versiota debhelperistä paketista käytetään. Kirjoitushetkellä viimeisin vakaa versio on 9.

source/format[muokkaa]

Tätä tiedostoa ei tarvitse muuttaa. Sen sisältö on: 

3.0 (quilt)

Quilt viittaa patchien hallintaan käyttämäämme ohjelmaan. 3.0:n merkityksestä voi lukea tarkemmin Debian Wikin artikkelista DebSrc3.0.

.ex-päätteiset tiedostot[muokkaa]

dh_make luo debian-hakemistoon monia .ex-päätteisiä tiedostoja. Näitä tiedostoja muokkaamalla on mahdollista esimerkiksi saada paketti lisäämään tehtäviä cronille ja kuvakkeen työpöytäympäristön valikkoon.

Oletuksena .ex-päätteisiä tiedostoja ei huomioida. Jos haluat käyttää niitä, muokkaa tiedosto ensin sopivaksi ja poista tiedostonimestä tämän jälkeen .ex-pääte. Lisäksi tarkista, että sopivaa funktiota kutsutaan rules-tiedostossa.

Poista ne .ex-tiedostot, joita et tarvitse. Hellon tapauksessa emme tarvitse näitä. Seuraavassa esitellään kuitenkin muutamia yleisimmin käytettyjä tiedostoja joita luultavasti tulet joskus tarvitsemaan:

cron.d[muokkaa]

Tiedostoon cron.d kirjoitetaan rivit, jotka halutaan lisätä cron-järjestelmään. Rivit kirjoitetaan samassa muodossa kuin missä cronille annetaan suoritettavia tehtäviä. Katso lisätietoja artikkelista cron.

init.d[muokkaa]

init-skripti, joka asennetaan polkuun /etc/init.d rules-tiedoston komennolla dh_installinit.

manpage.1[muokkaa]

Ohjelman man-sivu. Pisteen jälkeen oleva numero kertoo, mihin kategoriaan man-sivu asennetaan (kategoriat on listattu artikkelissa man). Man-sivu asennetaan paikoilleen rules-tiedostossa olevalla komennolla dh_installman debian/mansivu.1. Tiedoston nimi on yleensä muotoa paketinnimi.numero.

watch[muokkaa]

Kertoo uscan-ohjelmalle, miten paketin uudet versiot voi ladata internetistä. Lisätietoja tiedostomuodosta: man 1 uscan ja Debian Wiki. Watch-tiedosto mahdollistaa lähdekoodipaketin helpon päivittämisen aina uusimpaan versioon.

GNU:n projekteille, jollainen Hellokin on, toimii seuraavanlainen watch-tiedosto: 

version=4
http://ftp.gnu.org/gnu/@PACKAGE@/ \
   @PACKAGE@@ANY_VERSION@@ARCHIVE_EXT@ debian uupdate

Tehdään paketti![muokkaa]

Nyt kun tarvittavat tiedostot on lopulta muokattu sopiviksi, on aika luoda varsinainen paketti. Siirry ohjelman päähakemistoon (hello-2.10) ja aja komento 

debuild

joka tekee seuraavat asiat:

  • Siistii paketin (ajaa makella komennon debian/rules clean)
  • Kääntää ohjelman (debian/rules build)
  • Luo binääripaketin (debian/rules binary)
  • Allekirjoittaa .dsc-tiedoston gnupgllä
  • Luo ja allekirjoittaa .changes-tiedoston
  • Käyttää fakerootia, jolloin pääkäyttäjän oikeuksia ei tarvita

Allekirjoitus vaatii, että olet luonut gpg:llä itsellesi avaimen. Tällöin sinulta kysytään avaimesi salasanaa.

Tämän jälkeen, jos kaikki sujui ilman virheitä, ylähakemistosta pitäisi löytyä seuraavat tiedostot:

  • hello_2.10-1_amd64.build – kääntämisloki (build log)
  • hello_2.10-1_amd64.changes – gpg:llä allekirjoitettu tiedosto, joka sisältää paketin muutoslokin (debian/changelog) ja pakettiin liittyvien tiedostojen SHA1- ja SHA256-summat
  • hello_2.10-1_amd64.deb – lopullinen deb-paketti!
  • hello_2.10-1.debian.tar.xz – debian-hakemiston sisältö xz-pakattuna tar-arkistona
  • hello_2.10-1.dsc – gpg:llä allekirjoitettu control-tiedoston kaltainen tiedosto, jossa on listattu lähdekooditiedoston ja diff-tiedoston SHA1- ja SHA256-summat
  • hello_2.10.orig.tar.gz – alkuperäinen lähdekoodi

Nyt lopullinen paketti voidaan asentaa dpkg:llä: 

dpkg -i hello_2.10-1_amd64.deb

Kun myöhemmin teet muutoksia pakettiin, voit luoda uuden paketin nopeasti komennolla 

fakeroot debian/rules binary

joka ei kuitenkaan käännä ohjelmaa alusta lähtien (tärkeää huomata, jos muutat lähdekoodia).

Lähdekoodipaketti[muokkaa]

Edellä teimme tavallisen ns. binääripaketin, joka sisältää valmiiksi käännetyn ohjelman. Monesti on tarpeen tehdä myös lähdekoodipaketti, joka sisältää pakettiin ja sen kääntämiseen ja asentamiseen liittyvät tiedot (debian-hakemisto) ja ohjelman lähdekoodin. Tällöin paketti on mahdollista kääntää ja asentaa jokaiselle sopivalle alustalle kun taas käännetty .deb-paketti toimii vain yhdellä alustalla (esim. amd64, i386 tai armhf).

Lähdekoodipaketteja käytetään etenkin kun paketti julkaistaan esimerkiksi lisäämällä se jonkin jakelun virallisiin pakettilähteisiin. Tällöin kehittäjä yleensä vain lähettää palvelimelle lähdekoodipaketin, jonka palvelin sitten kääntää useille eri arkkitehtuureille.

Lähdekoodipaketti luodaan ajamalla paketin päähakemistossa komento 

debuild -S -sa

Missä valitsin -S tarkoittaa, että luodaan lähdekoodipaketti ja -sa sisällyttää pakettiin mukaan alkuperäisen lähdekooditiedoston (.orig.tar.gz). Tällöin ylähakemistoon pitäisi ilmestyä samanlaisten tiedostojen kuin luotaessa binääripakettia, paitsi että varsinaista .deb-pakettia ei ilmesty.

Nyt lähdekoodipaketti koostuu näistä tiedostoista (paketti.dsc, paketti.orig.tar.gz ja paketti.debian.tar.xz), ja sitä voidaan hallita esimerkiksi dpkg-source-ohjelmalla. Jos esimerkiksi olet saanut jostain lähdekoodipaketin, voit purkaa ja kääntää seuraavasti 

dpkg-source -x paketti.dsc
cd paketti
debuild

Ilman debuildin -sa-valitsinta voi luoda paketin, joka ei sisällä alkuperäistä lähdekoodia. Tälle on käyttöä silloin, kun paketteja pidetään ulkopuolisessa pakettivarastossa ja uusi versio voidaan julkaista vain lähettämällä palvelimelle uusi lähdekoodipaketti ilman alkuperäistä lähdekoodia. Tällainen tilanne tulee eteen, kun paketista tehdään uusi versio joka ei muuta itse ohjelman lähdekoodia tai muuttaa sitä erillisellä patch-tiedostolla (eli ohjelman tekijä ei ole julkaissut uutta versiota, mutta paketin tekijä tekee muutoksia joko itse ohjelmaan tai paketointiin).

Lintian: onnistuiko paketti?[muokkaa]

Lintian on ohjelma, joka tarkistaa tekemäsi paketin laadun. Sille annetaan parametrina pakettia luotaessa syntynyt .changes-päätteinen tiedosto. Yleensä kannattaa antaa myös valitsimet -E, -v, -i ja -I (iso i), jolloin lintian kertoo tarkemmin, mikä paketissa on vialla: 

lintian -EviI hello_2.10-1_amd64.changes

Tulosteessa E:-alkavat rivit tarkoittavat virhettä, W:-alkavat varoituksia ja N:-alkavat huomautuksia.

Jos esimerkiksi et poistanut debian-hakemistosta .ex-päätteisiä tiedostoja, lintian varoittaa niistä. Yleensä paketin tulisi olla sellainen, ettei lintian löydä siitä mitään valitettavaa.

Patchit[muokkaa]

Joskus pakettia tehtäessä on tehtävä muutoksia myös itse ohjelman lähdekoodiin. Tällöin on siistiä pitää muutokset erillään patch-tiedostoissa. Kun binääripaketti sitten tehdään, otetaan patchit käyttöön ennen kääntämistä.

Muut pakettityypit[muokkaa]

Multi-binary: Monta pakettia yhdestä lähdekoodipaketista[muokkaa]

Joskus tulee eteen tilanne, jossa yksi ohjelma on jaettava useampaan eri pakettiin. Tällainen tilanne tulee eteen mm. silloin, kun paketoidaan suurta peliä: yleensä peleissä itse käännetty ohjelma vie murto-osan siitä tilasta, jonka pelin datatiedostot vievät. Jos koko ohjelma laitettaisiin yhteen pakettiin, käytettäisiin turhaan palvelimen levytilaa ja resursseja, kun samat alustariippumattomat datatiedostot kopioitaisiin jokaiselle arkkitehtuurille tehtyyn pakettiin.

Toinen esimerkki tilanteesta, jossa ohjelman jakaminen moneen pakettiin on järkevää on ohjelma, jonka mukana tulee paljon (esimerkiksi jopa kymmeniä megatavuja) dokumentaatiota ja ohjeita.

Debhelper mahdollistaa useampien pakettien luomisen yhdestä lähdekoodipaketista varsin yksinkertaisesti. Ensinnäkin jokaiselle paketille kirjoitetaan oma osio debian/control-tiedostoon. Tiedostoon tulee aluksi normaalisti lähdekoodipaketin tiedot, ja tämän jälkeen luotavien binääripakettien tiedot peräkkäin. Esimerkki: 

Source: hello
Section: unknown
Priority: extra
Maintainer: Paketin Tekijä <foo@bar.com>
Build-Depends: debhelper (>= 9), autotools-dev
Standards-Version: 3.9.8

Package: hello
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Recommends: hello-doc
Description: Hello-ohjelma
 Klassinen hello-ohjelma, joka tulostaa tekstin
 hello world.

Package: hello-doc
Architecture: all
Depends: hello
Description: Hellon ohjeet
 Monipuoliset käyttöohjeet hello world -sovelluksen käyttöön.

Tämän jälkeen muutetaan paketin asentamista (debian/install) siten, että esimerkiksi pakettiin hello kuuluvat tiedostot asennettaisiin hakemistoon debian/hello/ ja paketin hello-doc-tiedostot hakemistoon debian/hello-doc. Näihin hakemistoihin tiedostot asennetaan kuten normaalisti luotaessa vain yhtä pakettia, eli esimerkiksi ajettavat ohjelmat voitaisiin sijoittaa polkuun debian/hello/usr/bin/.

Jos jokin Debhelperin komento (muotoa dh_jotain) halutaan rules-tiedostossa ajaa vain tietylle paketille, voidaan käyttää valitsinta --package eli lyhyemmin -p, esimerkiksi komennolla 

override_dh_installinfo:
	dh_installinfo -phello

asennettaisiin info-tiedostot vain hello-pakettia luotaessa.

Pbuilder[muokkaa]

Pbuilder on järjestelmä, joka kääntää ja rakentaa paketit omassa pienessä chroot-järjestelmässä. Pbuilderia käytettäessä saavutetaan mm. seuraavat edut:

  1. Käännösaikaiset riippuvuudet (build-depends) asennetaan automaattisesti
  2. Paketti käännetään puhtaassa ja mahdollisimman yksinkertaisessa ympäristössä, johon ei ole asennettu mitään ylimääräistä. Näin varmistetaan, että paketin kääntäminen onnistuu kaikissa järjestelmissä ja että käännösaikaiset riippuvuudet ovat riittävät.
  3. Paketin voi kääntää eri jakeluille ja jopa eri arkkitehtuurille

Lisätietoja Pbuilderin käytöstä löytyy artikkelista Pbuilder.

Paketin päivittäminen ja muokkaaminen[muokkaa]

Edellä käsiteltiin uuden paketin tekemistä. Monesti eteen tulee kuitenkin myös tilanteita, joissa jo olemassa olevaa pakettia tulee muuttaa tai päivittää. Päivittämiselle tulee tarve kun paketoidusta ohjelmasta julkaistaan uusi versio tai vaikkapa silloin, kun ohjelmassa oleva ohjelmavirhe (bugi) korjataan patch-tiedostolla.

Muokkauksen tekeminen alkaa hakemalla lähdekoodipaketti. Tämä onnistuu kätevästi komennolla apt-get source paketti. Tällöin apt hakee nykyiseen hakemistoon paketin .dsc-tiedoston, muutokset sisältävän .diff.gz-tiedoston ja alkuperäisen ohjelman sisältävän .tar.gz-paketin. Lisäksi hakemistoon syntyy ohjelmannimi-versio-hakemisto, jonka sisältä löytyy sekä itse ohjelma että siihen tehdyt muutokset (mm. debian)-hakemisto.

Jos nyt halutaan esimerkiksi korjata ohjelmassa oleva bugi, voidaan edellä neuvotulla tavalla lisätä pakettiin uusi patch-tiedosto. Tämän lisäksi on aina muistettava kirjata tiedot muutoksesta debian/changelog-tiedostoon. Tämä onnistuu helpoiten komennolla dch -i. Muutoslokin on tarkoitus tarkkaan kertoa, mitä muutoksia on tehty. Yleensä muutos korjaa jonkun vianhallintajärjestelmässä olevan ilmoitetun bugin, jolloin muutoslokissa mainitaan tämän bugin numero (Debianin vianseurantajärjestelmän kanssa käytetään syntaksia Closes: #numero ja Ubuntun Launchpad-järjestelmässä ilmoitettujen bugien kanssa syntaksia LP: #numero).

Jos paketoidusta ohjelmasta on ilmestynyt uusi versio, täytyy toimia hieman eri tavalla. Ensimmäinen tehtävä on ladata uuden ohjelman lähdekoodipaketti ja tutustua uuden version mukana tuomiin muutoksiin (NEWS- tai CHANGELOG-tiedosto). Tämän jälkeen puretaan paketti tiedostoon ohjelmannimi-versio ja uudelleennimetään lähdekoodipakettitiedosto nimelle ohjelman_versio.orig.tar.gz. Eli aivan kuin olisimme paketoimassa uutta ohjelmaa.

Tämän jälkeen voidaan kopioida vanha debianisointi eli debian-hakemisto vanhasta paketista uuteen pakettiin. Helpoimmissa tapauksissa tämä riittää, mutta etenkin käytettävien patchien toimiminen ja tarpeellisuus uuden version kanssa on todella tärkeä selvittää. Lisäksi ohjelman kääntäminen ja asentaminen saattaa uuden version kanssa tapahtua eri tavalla. Tällaisessa tapauksessa muutoslokiin kirjataan maininta uudesta versiosta ("New upstream release") ja kerrotaan myös, mitä muita muutoksia pakettiin tehtiin (esimerkiksi jätettiin pois tarpeettomaksi käynyt patchi.

Uuden version numero riippuu siitä, paketoitiinko uusi versio vai korjattiinko vain vanhassa versiossa oleva ongelma. Jos itse ohjelman versio ei muuttunut, kasvatetaan paketin "revision"-numeroa yhdellä, esimerkiksi versio "0.4.1-2" muuttuisi versioksi "0.4.1-3". Jos taas ohjelman versio muuttui, asetetaan paketin versioksi uuden version numero ja "revisioniksi" asetetaan 1: "0.4.1-2" -> "0.4.2-1".

Näiden toimenpiteiden jälkeen voidaan paketti luoda kuten normaalistikin debuild- ja pdebuild-komennoilla.

Debdiff[muokkaa]

Debdiff on diffin kaltainen ohjelma, joka vertailee kahta deb-pakettia. Sitä käytetään mm. silloin, kun lähetetään itse tehty korjaus ohjelman alkuperäiselle paketoijalle tai vianseurantajärjestelmään. Yleensä näin toimitaan silloin, kun muutoksen tekijällä ei ole oikeutta lähettää korjauksiaan suoraan virallisiin pakettivarastoihin.

Debdiffille annetaan kahden lähdekoodipaketin .dsc-tiedostot: 

debdiff vanha.dsc uusi.dsc

Jolloin ohjelma tulostaa erot ruudulle. Yleensä erot kannattaa putkittaa tiedostoon: 

debdiff vanha.dsc uusi.dsc > erot.debdiff

Pakettini on valmis, miten saan sen jakeluni pakettilähteisiin[muokkaa]

Paketin saaminen jakelun virallisiin pakettilähteisiin on jakelun käytännöistä riippuen enemmän tai vähemmän työläs prosessi, johtuen muun muassa laadunvarmistuksesta. Teknisellä tasolla paketit viedään jakeluihin dput- tai dupload-työkaluilla. Katso lisää näiden työkalujen käytöstä näiden omilta sivuilta.

Debianilla on käytössä mentors.debian.net-palvelu, jonne kaikki voivat lähettää omia pakettejaan tarjolle lähdekoodimuodossa. Tämän jälkeen paketille hankitaan/pyydetään halukas "sponsori", joka on kokenut Debian-kehittäjä jolla on oikeudet lisätä paketteja virallisiin pakettilähteisiin. Sponsoreita haetaan yleensä lähettämällä viesti debian-mentors-sähköpostilistalle sivustolta löytyvien ohjeiden mukaan. Tämän jälkeen joku paketista kiinnostunut kehittäjä tarkistaa sen ja antaa yleensä korjausehdotuksia. Kun paketti on hänen mielestään riittävän laadukas, hän lisää sen pakettilähteisiin. Prosessi voi paketin laadusta ja sponsoroijasta riippuen kestää pitkäänkin, ja vapaaehtoisuuteen perustamalla saattaa vaatia omaa aktiivisuutta ja kohteliasta ajoittaista tiediustelua.

Virallisten pakettilähteiden lisäksi voit myös ylläpitää omaa. Paketteja voi myös jakaa helposti esimerkiksi Launchpadin tarjoaman PPA-ominaisuuden avulla. PPA automatisoi paketin kääntämistä ja julkaisua. Halutessasi voit myös vain yksinkertaisesti jakaa tekemääsi deb-tiedostoa millä tahansa tiedostonjakotekniikalla.

Katso myös[muokkaa]

Aiheesta muualla[muokkaa]

Noudettu kohteesta ”https://www.linux.fi/w/index.php?title=Deb-paketin_tekeminen&oldid=47571”