Product SiteDocumentation Site

15.2. Creare il primo pacchetto

15.2.1. Meta-pacchetti o pacchetti finti

I pacchetti finti e i meta-pacchetti sono simili, entrambi non hanno contenuti, hanno però dei meta-dati che agiscono sullo stack di gestione dei pacchetti.
Lo scopo dei pacchetti finti è quello di far credere a dpkg e apt che un determinato pacchetto è installato anche se è soltanto un guscio vuoto. Questo permette di soddisfare le dipendenze di un pacchetto quando il software corrispondente è installato al di là delle scopo del sistema di pacchettizzazione. Questo sistema funziona, ma dovrebbe comunque essere evitato quando possibile, dato che non c'è alcuna garanzia che il software installato manualmente si comporti esattamente come il pacchetto corrispondente e i pacchetti che dipendono da esso potrebbero non funzionare correttamente.
D'altra parte, lo scopo principale di un meta-pacchetto è quello di raggruppare una serie di dipendenze, in modo che con il meta-pacchetto si installino una serie di altri pacchetti in un unico passaggio.
Entrambi i tipi di pacchetti possono essere creati dai comandi equivs-control e equivs-build (nel pacchetto equivs). Il comando equivs-control file crea un file d'intestazione del pacchetto Debian che dovrebbe essere modificato per contenere il nome del pacchetto, il numero di versione, il nome del manutentore, le dipendenze e la descrizione. Gli altri campi senza un valore predefinito sono opzionali e possono essere eliminati. I campi Copyright, Changelog, Readme e Extra-Files non sono campi standard nei pacchetti Debian, hanno senso solo nell'ambito di equivs-build e non saranno conservati nelle intestazioni del pacchetto generato.

Esempio 15.2. File d'intestazione del pacchetto finto libxml-libxml-perl

Section: perl
Priority: optional
Standards-Version: 4.5.1

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 &amp; installed in the
 site_perl directory.
Il passo successivo è quello di generare il pacchetto Debian con il comando equivs-build file. Voilà: il pacchetto viene creato nella directory corrente e può essere gestito come qualsiasi altro pacchetto Debian. 
$ equivs-build file
equivs-build control 
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_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
 dpkg-genchanges --build=binary >../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 messaige above!

15.2.2. Semplice file di archivio

Gli amministratori della Falcot Corp hanno bisogno di creare un pacchetto Debian per facilitare la distribuzione di una serie di documenti su un gran numero di macchine. L'amministratore incaricato di questo compito prima legge la "Guida al nuovo Maintainer", quindi inizia a lavorare sul pacchetto.
→ https://www.debian.org/doc/manuals/maint-guide/
Il primo passo è la creazione della directory falcot-data-1.0 che conterrà il sorgente del pacchetto interessato. Il nome del pacchetto sarà logicamente falcot-data con il numero di versione 1.0. L'amministratore mette i file dei documenti nella sotto-directory data. Dopo viene eseguito il comando dh_make (dal pacchetto dh-make) per aggiungere i file necessari per il processo di generazione del pacchetto, che saranno memorizzati nella sotto-directory debian: 
$ 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                : Sat, 26 Feb 2021 13:02:06 +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.

$
The selected type of package (indep) indicates that this source package will generate a single binary package that can be shared across all architectures (Architecture: all in debian/control). single acts as a counterpart, and leads to a single binary package that is dependent on the target architecture (Architecture: any). In this case, the former choice is more relevant since the package only contains documents and no binary programs, so it can be used similarly on computers of all architectures.
Il tipo libreria corrisponde ad un pacchetto sorgente che porta a diversi pacchetti binari. È utile per le librerie condivise, poiché devono seguire rigide regole di pacchettizzazione.

SUGGERIMENTO Nome ed indirizzo email del maintainer

La maggior parte dei programmi coinvolti nella manutenzione dei pacchetti cercherà il nome del maintainer nelle variabili d'ambiente DEBFULLNAME e DEBEMAIL o EMAIL. Definire questi valori eviterà di doverli digitare più volte. Se la shell utilizzata abitualmente è la bash, si possono semplicemente aggiungere le due righe seguenti nei file ~/.bashrc (ovviamente bisogna sostituire i valori con quelli più adeguati!): 
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 file in debian/control.
The copyright file must contain information about the authors of the documents included in the package, and the related copyright and license. In our case, these are internal documents and their use is restricted to within the Falcot Corp company. The default format used for this file is defined in the Format field.
→ https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
The default changelog file is generally appropriate; replacing the “Initial release” with a more verbose explanation and changing the distribution from UNRELEASED or unstable to the target release name is enough.
The control file must also be updated: the Section field can be changed to misc and the Homepage, Vcs-Git and Vcs-Browser fields were removed. The Depends fields was completed with firefox-esr | www-browser so as to ensure the availability of a web browser able to display the documents in the package. If the package does not require to run any commands as root (see STRUMENTO fakeroot), the Rules-Requires-Root field can be left as is.

Esempio 15.3. Il file control

Source: falcot-data
Section: misc
Priority: optional
Maintainer: Raphael Hertzog <hertzog@debian.org>
Build-Depends: debhelper-compat (= 13)
Standards-Version: 4.5.1
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.

Esempio 15.4. Il file changelog

falcot-data (1.0) bullseye; urgency=low

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

 -- Raphael Hertzog <hertzog@debian.org>  Sat, 26 Feb 2022 15:12:06 +0100

Esempio 15.5. Il file copyright

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

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

FONDAMENTALI Il file Makefile

Il file Makefile è uno script utilizzato dal programma make, e descrive le regole su come generare un insieme di file da un altro, utilizzando le dipendenze ad albero (ad esempio, un programma può essere costruito da un insieme di file sorgenti). Il file Makefile descrive queste regole nel seguente formato: 
target: source1 source2 ...
        command1
        command2
The basic interpretation of such a rule is as follows: if one of the source* files is more recent than the target file, then the target needs to be generated, using command1 and command2.
Si noti che le righe di comando devono iniziare con un carattere di tabulazione; si noti pure che quando una riga di comando inizia con il carattere trattino (-), il fallimento del comando non interrompe l'intero processo.
Il file rules di solito contiene un insieme di regole utilizzate per configurare, compilare e installare il software in una sotto-directory dedicata (con il nome del pacchetto binario generato). Il contenuto di questa sotto-directory viene archiviato all'interno del pacchetto Debian, come se fosse la radice del file system. In questo caso, i file verranno installati netta sotto-directory debian/falcot-data/usr/share/falcot-data/, in modo che l'installazione del pacchetto generato metta i file in /usr/share/falcot-data/. Il file rules viene utilizzato come un Makefile, con alcuni obbiettivi predefiniti (compresi clean e binary, utilizzati rispettivamente per pulire la directory dei sorgenti e per generare il pacchetto binario).
Anche se questo file è il cuore di tutto il processo, contiene solo il minimo indispensabile per l'esecuzione di un insieme predefinito di comandi forniti dal programma debhelper. Questo è il caso per i file generati da dh_make. Per installare i file interessati, bisogna semplicemente configurare il comportamento del comando dh_install creando il seguente file debian/falcot-data.install: 
data/* usr/share/falcot-data/
A questo punto, il pacchetto può essere creato. Verrà, comunque, apportata una miglioria. Dal momento che gli amministratori vogliono che i documenti siano facilmente accessibili dal menu dell'ambiente grafico, si aggiunge un file falcot-data.desktop e lo si installa in /usr/share/applications aggiungendo una seconda riga a debian/falcot-data.install.

Esempio 15.6. Il file 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;
La versione aggiornata di debian/falcot-data.install è simile a questa: 
data/* usr/share/falcot-data/
falcot-data.desktop usr/share/applications/
Ora il nostro pacchetto sorgente è pronto. Tutto quello che resta da fare è generare il pacchetto binario, con lo stesso metodo usato in precedenza per la rigenerazione dei pacchetti: si esegue il comando dpkg-buildpackage -us -uc all'interno della directory falcot-data-1.0.