Product SiteDocumentation Site

15.2. Creant el primer paquet

15.2.1. Metapaquets o paquets falsos

Els paquets falsos, o «fake packages»i els metapaquets són similars, ja que són capes buides que només existeixen per als efectes que les seves metadades tenen a la pila de manipulació de paquets.
El propòsit d'un paquet fals és enganyar dpkg i apt perquè creguin que algun paquet està instal·lat encara que només sigui una consola buida. Això permet satisfer les dependències d'un paquet quan el programari corresponent s'ha instal·lat fora de l'àmbit del sistema de paquets. Aquest mètode funciona, però ha d'evitar-se sempre que sigui possible, ja que no hi ha cap garantia que el programari instal·lat manualment es comporti exactament com ho faria el paquet corresponent i altres paquets depenent d'ell no funcionarien correctament.
D'altra banda, un metapaquet existeix principalment com una col·lecció de dependències, de manera que la instal·lació del metapaquet realment estirarà un conjunt d'altres paquets d'un sol cop.
Both these kinds of packages can be created by the equivs-control and equivs-build commands in the equivs package. The equivs-control file command creates a Debian package header file that should be edited to contain the name of the expected package, its version number, the name of the maintainer, its dependencies, and its description. Other fields without a default value are optional and can be deleted. The Copyright, Changelog, Readme and Extra-Files fields are not standard fields in Debian packages; they only make sense within the scope of equivs-build, and they will not be kept in the headers of the generated package.

Exemple 15.2. Fitxer de capçalera del paquet fals libxml-libxml-perl

Section: perl
Priority: optional
Standards-Version: 4.6.2

Package: libxml-libxml-perl
Version: 2.0207-1
Maintainer: Raphael Hertzog <hertzog@debian.org>
Depends: libxml2 (>= 2.9.10)
Architecture: all
Description: Fake package - module manually installed in site_perl
 This is a fake package to let the packaging system
 believe that this Debian package is installed.
 .
 In fact, the package is not installed since a newer version
 of the module has been manually compiled & installed in the
 site_perl directory.
El següent pas és generar el paquet Debian amb l'ordre equivs-build fitxer. Voilà: el paquet es crea al directori actual i es pot gestionar com qualsevol altre paquet de Debian. 
$ equivs-build file
dpkg-buildpackage: info: source package libxml-libxml-perl
dpkg-buildpackage: info: source version 2.0207-1
dpkg-buildpackage: info: source distribution unstable
dpkg-buildpackage: info: source changed by Raphael Hertzog <hertzog@debian.org>
dpkg-buildpackage: info: host architecture amd64
 dpkg-source --before-build .
 debian/rules clean
dh clean
   dh_clean
 debian/rules binary
dh binary
   dh_update_autotools_config
   dh_autoreconf
   create-stamp debian/debhelper-build-stamp
   dh_prep
   dh_auto_install --destdir=debian/libxml-libxml-perl/
   dh_install
   dh_installdocs
   dh_installchangelogs
   dh_perl
   dh_link
   dh_strip_nondeterminism
   dh_compress
   dh_fixperms
   dh_missing
   dh_installdeb
   dh_gencontrol
   dh_md5sums
   dh_builddeb
dpkg-deb: building package 'libxml-libxml-perl' in '../libxml-libxml-perl_2.0207-1_all.deb'.
 dpkg-genbuildinfo --build=binary -O../libxml-libxml-perl_2.0207-1_amd64.buildinfo
 dpkg-genchanges --build=binary -O../libxml-libxml-perl_2.0207-1_amd64.changes
dpkg-genchanges: info: binary-only upload (no source code included)
 dpkg-source --after-build .
dpkg-buildpackage: info: binary-only upload (no source included)

The package has been created.
Attention, the package has been created in the current directory,
not in ".." as indicated by the message above!

15.2.2. Simple arxiu de fitxers

Els administradors de Falcot Corp han de crear un paquet de Debian per facilitar el desplegament d'un conjunt de documents en un gran nombre de màquines. L'administrador encarregat d'aquesta tasca primer llegeix la "Guia del nou mantenidor", i després comença a treballar en el seu primer paquet.
→ https://www.debian.org/doc/manuals/maint-guide/
The first step is creating a falcot-data-1.0 directory to contain the target source package. The package will, logically, be named falcot-data and bear the 1.0 version number. The administrator then places the document files in a data subdirectory. Then they invoke the dh_make command (from the dh-make package) to add files required by the package generation process, which will all be stored in a debian subdirectory: 
$ cd falcot-data-1.0
$ dh_make --native

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

Maintainer Name     : Raphael Hertzog
Email-Address       : hertzog@debian.org
Date                : Sun, 26 May 2024 21:48:41 +0100
Package Name        : falcot-data
Version             : 1.0
License             : gpl3
Package Type        : indep
Are the details correct? [Y/n/q]
Currently there is not top level Makefile. This may require additional tuning
Done. Please edit the files in the debian/ subdirectory now.

$
El tipus de paquet seleccionat (indep) indica que aquest paquet font generarà un únic paquet binari que es pot compartir en totes les arquitectures (Architecture: all a debian/control). single actua com a contrapartida, i duu a un únic paquet binari que depèn de l'arquitectura de destinació (Architecture: any). En aquest cas, l'opció primera és més rellevant, ja que el paquet només conté documents i no hi ha programes binaris, de manera que es pot utilitzar de manera similar en ordinadors de totes les arquitectures.
El tipus «library» o “biblioteca” correspon a un paquet font que genera diversos paquets binaris. És útil per a les biblioteques compartides, ja que han de seguir normes estrictes d'empaquetament.

SUGGERIMENT Nom i adreça de correu electrònic del mantenidor

La majoria dels programes implicats en el manteniment de paquets buscaran el vostre nom i adreça de correu electrònic a les variables d'entorn DEBFULLNAME i DEBEMAIL o EMAIL . Definir-les una vegada us evitarà haver d'escriure-les diverses vegades. Si el vostre intèrpret d'ordres habitual és bash, és una simple qüestió d'afegir les dues línies següents al vostre fitxer ~/.bashrc (òbviament substituireu els valors per altres més rellevants!): 
export EMAIL="hertzog@debian.org"
export DEBFULLNAME="Raphael Hertzog"
The dh_make command created a debian subdirectory with many files. Some are required, in particular rules, control, changelog and copyright. Files with the .ex extension are example files that can be used by modifying them (and removing the extension) when appropriate. When they are not needed, removing them is recommended. The compat file is not used nor created anymore. Instead of defining the debhelper compatibility level as a number in this file, it is now defined as a build-dependency on the debhelper-compat virtual package in the Build-Depends field in debian/control.
El fitxer copyright ha de contenir informació sobre els autors dels documents inclosos al paquet, i els drets d'autor i llicència relacionats. En el nostre cas, es tracta de documents interns i el seu ús es limita a l'empresa Falcot Corp. El format predeterminat utilitzat per a aquest fitxer es defineix al camp Format.
→ https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
El fitxer changelog és generalment apropiat; substituir l'«Initial release» (o “versió inicial”) per una explicació més detallada, i canviar la distribució de UNRELEASED o Unstable pel nom la versió de destinació és suficient.
El fitxer control també s'ha d'actualitzar: el camp Section es pot canviar per misc i els camps Homepage, Vcs-Git i Vcs-Browser van ser eliminats. Els camps Depends es van completar amb firefox-esr | www-browser per assegurar la disponibilitat d'un navegador web capaç de mostrar els documents del paquet. Si el paquet no requereix executar cap ordre com a superusuari (vegeu EINA fakeroot), el camp Rules-Requires-Root es pot deixar com està.

Exemple 15.3. El fitxer control

Source: falcot-data
Section: misc
Priority: optional
Maintainer: Raphael Hertzog <hertzog@debian.org>
Build-Depends: debhelper-compat (= 13)
Standards-Version: 4.6.2
Rules-Requires-Root: no

Package: falcot-data
Architecture: all
Depends: firefox-esr | www-browser, ${misc:Depends}
Description: Internal Falcot Corp Documentation
 This package provides several documents describing the internal
 structure at Falcot Corp.  This includes:
  - organization diagram
  - contacts for each department.
 .
 These documents MUST NOT leave the company.
 Their use is INTERNAL ONLY.

Exemple 15.4. El fitxer changelog

falcot-data (1.0) bookworm; urgency=low

  * Initial Release.
  * Let's start with few documents:
    - internal company structure;
    - contacts for each department.

 -- Raphael Hertzog <hertzog@debian.org>  Sun, 26 May 2024 21:48:41 +0100

Exemple 15.5. El fitxer copyright

Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: falcot-data

Files: *
Copyright: 2004-2024 Falcot Corp
License:
 All rights reserved.

TORNAR A LES BASES El fitxer Makefile

Un fitxer Makefile és un script utilitzat pel programa make; descriu les regles sobre com construir un conjunt de fitxers entre si en un arbre de dependències (per exemple, un programa es pot construir a partir d'un conjunt de fitxers font). El fitxer Makefile descriu aquestes regles en el format següent: 
target: source1 source2 ...
        command1
        command2
La interpretació bàsica d'una regla d'aquesta mena és la següent: si un dels fitxers source* és més recent que el fitxer target, llavors cal generar l'objectiu utilitzant command1 i command2.
Tingueu en compte que les línies d'ordres han de començar amb un caràcter de tabulació; també cal tenir en compte que quan una línia d'ordres comença amb un caràcter de guió (-), la fallada de l'ordre no interromp tot el procés.
El fitxer rules normalment conté un conjunt de regles utilitzades per configurar, compilar i instal·lar el programari en un subdirectori dedicat (anomenat com el paquet binari generat). El contingut d'aquest subdirectori s'arxiva després dins del paquet Debian com si fos l'arrel del sistema de fitxers. En el nostre cas, els fitxers s'instal·laran al subdirectori debian/falcot-data/usr/share/falcot-data/, de manera que instal·lant el paquet generat es desplegaran els fitxers sota /usr/share/falcot-data/. El fitxer rules s'utilitza com a Makefile, amb alguns «targets» o “objectius” estàndard (incloent-hi clean i binary, utilitzats respectivament per netejar el directori d'origen i generar el paquet binari).
Encara que aquest fitxer és el cor del procés, cada cop més conté només el mínim per executar un conjunt estàndard d'ordres proporcionat per l'eina debhelper. Aquest és el cas dels fitxers generats per dh_make. Per instal·lar els nostres fitxers, simplement es configura el comportament de l'ordre dh_install creant el següent fitxer debian/falcot-data.install: 
data/* usr/share/falcot-data/
En aquest punt ja es pot crear el paquet. No obstant això, hi afegirem una capa de pintura. Atès que els administradors volen que els documents siguin fàcilment accessibles des dels menús dels entorns gràfics d'escriptori, s'afegeix un fitxer falcot-data.desktop i s'instal·la a /usr/share/applications afegint una segona línia a debian/falcot-data.install.

Exemple 15.6. El fitxer falcot-data.desktop

[Desktop Entry]
Name=Internal Falcot Corp Documentation
Comment=Starts a browser to read the documentation
Exec=x-www-browser /usr/share/falcot-data/index.html
Terminal=false
Type=Application
Categories=Documentation;
L'actualització de debian/falcot-data.install queda així: 
data/* usr/share/falcot-data/
falcot-data.desktop usr/share/applications/
El nostre paquet font ja està llest. Tot el que queda per fer és generar el paquet binari, amb el mateix mètode utilitzat anteriorment per reconstruir paquets: executem l'ordre dpkg-buildpackage -us -uc des del directori falcot-data-1.0.