5.3. Struttura di un pacchetto sorgente

5.3.1. Formato

Un pacchetto sorgente è normalmente composto da tre file, un .dsc, un .orig.tar.gz e un .debian.tar.xz (o .diff.gz). Essi permettono la creazione di pacchetti binari (i file .deb descritti precedentemente) dal loro codice sorgente, scritti in un linguaggio di programmazione.

Il file .dsc (Debian Source Control) è un breve file di testo che contiene un'intestazione RFC 2822 (proprio come il file control esaminato nella Sezione 5.2.1, «Descrizione: il file control») che descrive il pacchetto sorgente e indica quali altri file ne fanno parte. È firmato dal suo manutentore, il che garantisce la sua autenticità. Vedere la Sezione 6.6, «Controllare l'autenticità dei pacchetti» per ulteriori dettagli su questo argomento.

Esempio 5.1. Un file .dsc

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Format: 3.0 (quilt)
Source: zim
Binary: zim
Architecture: all
Version: 0.73.5-1
Maintainer: Zim Package Maintainers <zim@packages.debian.org>
Uploaders: Raphaël Hertzog <hertzog@debian.org>
Homepage: https://zim-wiki.org
Standards-Version: 4.5.1
Vcs-Browser: https://salsa.debian.org/debian/zim
Vcs-Git: https://salsa.debian.org/debian/zim.git
Build-Depends: debhelper-compat (= 13), python3, python3-gi, python3-xdg, gir1.2-gtk-3.0, dh-python
Package-List:
 zim deb x11 optional arch=all
Checksums-Sha1:
 80d43d5c1c6a47c695079eb02bc8ad36b84d6e57 2159901 zim_0.73.5.orig.tar.gz
 b1cd86dc4819a80126efbf6ee6eba17a33f451d3 10124 zim_0.73.5-1.debian.tar.xz
Checksums-Sha256:
 a36f15d92c3994c0d55b07f83253b3d8b826beb3714865edbabc14f1cc91d63a 2159901 zim_0.73.5.orig.tar.gz
 6c2db642d9ac1c2440ed08e0cd584006045b342b255f37ffe42bd5459fb5cb76 10124 zim_0.73.5-1.debian.tar.xz
Files:
 fa76ceb8ac7d7354fb0e2bc5607e9faa 2159901 zim_0.73.5.orig.tar.gz
 a0c824d979efb196cde0176d3cb9c719 10124 zim_0.73.5-1.debian.tar.xz

-----BEGIN PGP SIGNATURE-----
Comment: Signed by Raphael Hertzog

iQEzBAEBCgAdFiEE1823g1EQnhJ1LsbSA4gdq+vCmrkFAmAa3ooACgkQA4gdq+vC
mrkq1gf/cs7irmbCSDrADVqsqYBrFJ1FyprE3jiHLNs0OQLryhFj9tzDuilX35VE
HkCfxSaKkzgvQLYtpuw1VBfhOdngTdHO39U6eljkaScnfLWU8Z5n/q+YeedxItoY
X3TtzMexFmb4WJqlylfjbXeqbLdYvsILQ3NVnE48AzkaBQlCC2d9bqecZhWiKfzq
gNxIDVDDhqCXMPe7QCErCBiFPUVpGN7b+6QWN0RxOTLZdj/slRD73rT++VmY+xN1
L8BSLcjXie+ES11MhQNYaLpCv2vqImlZaxkFWvsKBo9ndRFSbE3/RNK479a4KGve
KrdpGUJXy9uLPuAMyn5WphwXJ7OZXQ==
=YFDk
-----END PGP SIGNATURE-----

Notare che anche il pacchetto sorgente ha delle dipendenze (Build-Depends) completamente distinte da quelle del pacchetto binario, dal momento che indicano gli strumenti richiesti per compilare il software in questione e creare il suo pacchetto binario.

CULTURA Perché dividere in diversi pacchetti

Piuttosto di frequente, un pacchetto sorgente (per un certo applicativo) può generare diversi pacchetti binari. Le ragioni sono molteplici: un programma, o parti di esso, può spesso essere usato in contesti diversi, ad esempio una libreria condivisa può essere installata per far funzionare un'applicazione (per esempio libc6) o può essere installata per sviluppare un nuovo programma (libc6-dev sarà allora il pacchetto corretto). La stessa logica si trova per servizi client/server dove la parte server è installata su una macchina e la parte client su altre (questo è il caso, per esempio, di openssh-server e di openssh-client).

Altrettanto di frequente, la documentazione è fornita in un pacchetto dedicato: l'utente può installarla indipendentemente dal software e può scegliere di rimuoverla in qualsiasi momento per risparmiare spazio su disco. Inoltre, ciò farà risparmiare spazio anche sui mirror di Debian, dal momento che il pacchetto con la documentazione sarà condiviso tra tutte le architetture (invece di duplicarla, all'interno dei pacchetti, per ogni architettura).

IN PROSPETTIVA Differenti formati di pacchetti sorgenti

Inizialmente c'era un solo formato per i pacchetti sorgenti. Questo succedeva nel formato 1.0 che associa un archivio .orig.tar.gz a una patch .diff.gz di "debianizzazione" (c'è anche una variante che consiste di un singolo archivio .tar.gz che è usato automaticamente se non c'è alcun .orig.tar.gz disponibile).

A partire da Debian 6 Squeeze, gli sviluppatori Debian hanno l'opzione di usare dei nuovi formati che correggono molti problemi del formato storico. Il formato 3.0 (quilt) può unire più archivi a monte in uno stesso pacchetto sorgente: in aggiunta al solito .orig.tar.gz, possono essere inclusi archivi supplementari .orig-componente.tar.gz. Ciò è utile con software che è distribuito in diversi componenti a monte ma per il quale si desidera un singolo pacchetto sorgente. Questi archivi possono anche essere compressi con xz piuttosto che con gzip), il che risparmia spazio su disco e risorse di rete. Infine, la patch monolitica, .diff.gz, è stata sostituita dall'archivio .debian.tar.xz che contiene le istruzioni di compilazione e un insieme di patch ai sorgenti a monte create dal manutentore del pacchetto. Queste ultime sono registrate in un formato compatibile con quilt — uno strumento che facilita la gestione di una serie di patch.

Il file .orig.tar.gz è un archivio che contiene il codice sorgente del programma come fornito dallo sviluppatore originale. Ai manutentori dei pacchetti Debian viene chiesto di non modificare questo archivio in modo da poter facilmente verificare la fonte e l'integrità del file (con un semplice confronto con una somma di controllo) e per rispettare i desideri di alcuni autori.

L'archivio .debian.tar.xz contiene tutte le modifiche fatte dal manutentore Debian, specialmente l'aggiunta della directory debian contenente le istruzioni da eseguire per creare uno o più pacchetti binari Debian.

STRUMENTO Decomprimere un pacchetto sorgente

Avendo un pacchetto sorgente, si può usare il comando dpkg-source (dal pacchetto dpkg-dev) per decomprimerlo:

$ dpkg-source -x zim_0.73.5-1.dsc
dpkg-source: info: extracting zim in zim-0.73.5
dpkg-source: info: unpacking zim_0.73.5.orig.tar.gz
dpkg-source: info: unpacking zim_0.73.5-1.debian.tar.xz

Si può anche usare apt per scaricare un pacchetto sorgente e scompattarlo immediatamente. È richiesto che le appropriate linee deb-src siano presenti nel file /etc/apt/sources.list (per ulteriori dettagli, vedere la Sezione 6.1, «Compilazione del file sources.list»). Esse sono usate per elencare le "fonti" dei pacchetti sorgente (intendendo i server sui quali è ospitato un gruppo di pacchetti sorgente).

$ apt source package

Reading package lists... Done
NOTICE: 'zim' packaging is maintained in the 'Git' version control system at:
https://salsa.debian.org/debian/zim.git
Please use:
git clone https://salsa.debian.org/debian/zim.git
to retrieve the latest (possibly unreleased) updates to the package.
Need to get 2,172 kB of source archives.
Get:1 https://deb.debian.org/debian bullseye/main zim 0.73.5-1 (dsc) [1,580 B]
Get:2 https://deb.debian.org/debian bullseye/main zim 0.73.5-1 (tar) [2,160 kB]
Get:3 https://deb.debian.org/debian bullseye/main zim 0.73.5-1 (diff) [10.1 kB]
Fetched 2,172 kB in 0s (7,176 kB/s)
dpkg-source: info: extracting zim in zim-0.73.5
dpkg-source: info: unpacking zim_0.73.5.orig.tar.gz
dpkg-source: info: unpacking zim_0.73.5-1.debian.tar.xz

5.3.2. Uso con Debian

Il pacchetto sorgente è alla base di tutto in Debian. Tutti i pacchetti provengono da un pacchetto sorgente e ogni modifica in un pacchetto Debian è la conseguenza di una modifica apportata al pacchetto sorgente. I manutentori Debian lavorano con il pacchetto sorgente, consapevoli delle conseguenze delle loro azioni sui pacchetti binari. Il frutto del loro lavoro si trova quindi nei pacchetti sorgenti disponibili in Debian: si può facilmente risalire ad essi e tutto deriva da essi. Capitolo 15, Creazione di un pacchetto Debian contiene alcuni esempi.

Quando una nuova versione di un pacchetto sorgente arriva sul server Debian, viene utilizzata da una rete di macchine con architetture diverse per la compilazione sulle varie architetture supportate da Debian.

→ https://buildd.debian.org/

APPROFONDIMENTO Caricamento dei soli sorgenti da parte dei manutentori

Subito dopo il rilascio di Debian 10 Buster il Team di Rilascio ha annunciato che i caricamenti binari dei manutentori non saranno più accettati per main e che tutti i pacchetti binari di questa sezione dovranno essere creati automaticamente caricando obbligatoriamente i soli sorgenti. I caricamenti binari sono ancora consentiti per le sezioni contrib e non-free, ma non ci concentreremo su questa possibilità perché dovrebbe essere solo un'eccezione.