Difference between revisions of "Creating packages (Italiano)"

From ArchWiki
Jump to: navigation, search
m (moved Creare pacchetti in Arch - linee guida (Italiano) to Building Packages (Italiano): International naming standardization: Title in English (Lingua): User:Pointone/i18n)
(use https for links to archlinux.org)
(18 intermediate revisions by 12 users not shown)
Line 1: Line 1:
[[Category:Development (Italiano)]]
+
[[Category:About Arch (Italiano)]]
[[Category:HOWTOs (Italiano)]]
+
[[Category:Package development (Italiano)]]
[[Category:Package management (Italiano)]]
+
[[cs:Creating Packages]]
{{i18n_links_start}}
+
[[en:Creating Packages]]
{{i18n_entry|English|The_Arch_package_making_HOW-TO_-_with_guidelines}}
+
[[es:Creating Packages]]
{{i18n_entry|Русский|The_Arch_package_making_HOW-TO_-_with_guidelines(russian)}}
+
[[ja:Creating Packages]]
{{i18n_entry|正體中文|Arch 安裝包製作指南}}
+
[[ru:Creating Packages]]
{{i18n_entry|简体中文|Arch 安装包制作指南}}
+
[[sk:Creating Packages]]
{{i18n_entry|Italiano|Creare_pacchetti_in_Arch_-_linee_guida_(Italiano)}}
+
[[tr:Paket_oluşturma]]
{{i18n_links_end}}
+
[[zh-CN:Creating Packages]]
 +
{{Article summary start}}
 +
{{Article summary text|Una descrizione dettagliata del processo di compilazione del pacchetto, includendo la creazione, il controllo e la presentazione su [[AUR]].}}
 +
{{Article summary heading|Related}}
 +
{{Article summary wiki|Arch Build System (Italiano)}}
 +
{{Article summary wiki|Arch User Repository (Italiano)}}
 +
{{Article summary wiki|Arch Packaging Standards (Italiano)}}
 +
{{Article summary wiki|makepkg (Italiano)}}
 +
{{Article summary wiki|pacman (Italiano)}}
 +
{{Article summary wiki|PKGBUILD (Italiano)}}
 +
{{Article summary wiki|VCS PKGBUILD Guidelines}}
 +
{{Article summary end}}
  
Il documento [[ABS_-_Il_Sistema_Di_Compilazione_di_Arch_(Italiano) | ABS - Il Sistema Di Compilazione di Arch]] fornisce una buona panoramica degli strumenti e dei file necessari a creare o modificare pacchetti per Arch Linux. Non è necessario sapere altro, se ciò che si vuole è solo personalizzare o ricompilare pacchetti esistenti. Comunque, se si ha bisogno di creare un pacchetto nuovo, ci sono alcune linee guida aggiuntive da conoscere.  Questo documento presuppone la lettura e la comprensione della descrizione di ABS.
+
Questo articolo si propone di assistere gli utenti nella creazione dei propri pacchetti con il sistema di compilazione "ports-like" di Arch Linux. riguarda la creazione di un [[PKGBUILD (Italiano)|PKGBUILD]], un pacchetto con la descrizione dei file sorgente utilizzato da {{Ic|makepkg}} per creare un pacchetto binario dal codice sorgente. Se si è già in possesso di un {{ic|PKGBUILD}}, vedere [[makepkg (Italiano)|makepkg]].
  
==Preparazione dei file==
+
== Introduzione ==  
Tutte le informazioni per creare un pacchetto sono situate in un file <code>PKGBUILD</code>. Quando si lancia <code>makepkg</code>, esso cercherà un file <code>PKGBUILD</code> nella directory in cui ci si trova e compilerà i sorgenti del software secondo le istruzioni contenute nel file <code>PKGBUILD</code>. Una volta terminata con successo la compilazione, i binari risultanti, insieme a tutte le meta-informazioni disponibili quali versione e dipendenze, sono immagazzinati nel pacchetto <code>nome.pkg.tar.gz</code> che può essere installato con il comando <code>pacman -Up <nome pacchetto></code>.
+
  
Il file <code>PKGBUILD</code> contiene '''tutte''' le istruzioni per creare il pacchetto, in una forma direttamente interpretabile da bash (non c'è da preoccuparsi se questa breve indicazione non è d'aiuto). Per iniziare con un nuovo pacchetto, si deve prima di tutto creare una directory vuota, preferibilmente di nome <code>/var/abs/local/<nome pacchetto></code>. In questo modo è naturalmente integrata nell'albero di ABS, ma non toccata dal cvsup quando lo si sincronizzi. Si deve quindi entrare in tale directory e creare un file <code>PKGBUILD</code> su cui lavorare, copiando il prototipo d'esempio da <code>/usr/share/pacman/PKGBUILD.proto</code> alla directory di lavoro, o copiando il <code>PKGBUILD</code> da un altro pacchetto. Quest'ultima scelta è molto utile se si vuole soltanto modificare le opzioni di compilazione di un pacchetto, invece di crearne uno completamente nuovo.
+
I pacchetti in Arch Linux sono compilati utilizzando l'utilità [[makepkg (Italiano)|makepkg]] e le informazioni memorizzate in un file [[PKGBUILD (Italiano)|PKGBUILD]]. Quando avviato, {{Ic|makepkg}} va alla ricerca di un {{ic|PKGBUILD}} nella presente directory e segue le istruzioni per o compilare, o acquisire i file necessari ad essere impacchettati all'interno di un file pacchetto ({{ic|pkgname.pkg.tar.xz}}). Il pacchetto risultante contiene i file binari e le istruzioni di installazione, facilmente installabili con [[pacman (Italiano)|pacman]].
  
Comunque si decida di procedere, si ha bisogno di un file <code>PKGBUILD</code> su cui lavorare.
+
Un pacchetto di Arch non è altro che un archivio tar compresso utilizzando "xz", o "tarball", che contiene:
  
==Modificare le variabili==
+
* I file binari per l'installazione
  
Ora bisogna aprire tale file ed impostare i valori di ogni variabile secondo il pacchetto che si sta costruendo:
+
* {{ic|.PKGINFO}}: contiene tutti i metadati necessari a pacman per gestire i pacchetti, le dipendenze, ecc.
<br /><br />
+
*'''pkgname:''' Impostarla con un nome per il pacchetto. Convenzione vuole che si usino tutte lettere minuscole per il nome del pacchetto. E' una scelta arbitraria, ma è d'aiuto che il nome di un pacchetto sia uguale al nome della directory in cui ci si trova ed al nome del file .tar.gz che contiene i sorgenti del programma che si vuole scaricare.
+
  
*'''pkgver:''' Impostare la versione del pacchetto. Questa può contenere lettere, numeri e periodi, ma NON può contenere trattini. Dipende dal sistema di numerazione di versione (major.minor.bugfix, major.data, ecc..) che usa il programma che si sta impacchettando. Di nuovo, nella maggior parte dei casi bisognerebbe attenersi alla versione del file contenente i sorgenti, per rendere i passi successivi più facili e flessibili. N.B: se il creatore del pacchetto usa un trattino nello schema di numerazione delle versioni, rimpiazzarlo con un underscore. ('0.99-10'  =>  '0.99_10')
+
* {{ic|.INSTALL}}: un file opzionale utilizzato per eseguire comandi dopo l'installazione, aggiornamento o rimozione degli stage. (Questo file è presente solo se specificato nel {{ic|PKGBUILD}})
  
*'''pkgrel:''' Questa variabile andrebbe incrementata ogni volta che si rilascia un pacchetto, a partire da 1. Il suo obiettivo è di differenziare compilazioni consecutive della stessa versione di un pacchetto. A volte il primo rilascio di un pacchetto contiene un problema o una "disfunzione". Quando si completa il secondo rilascio, si incrementa la variabile <code>pkgrel</code> di modo che pacman sappia che il pacchetto dev'essere reinstallato. Quando viene rilasciata una nuova '''versione''' del pacchetto, si reimposti la variabile <code>pkgrel</code> a 1.
+
* {{ic|.Changelog}}: un file opzionale conservato dal manutentore del pacchetto che documenta i cambiamenti dello stesso. (Non è presente in tutti i pacchetti)
  
*'''pkgdesc:''' Qui si dovrebbe inserire una breve (normalmente, meno di 76 caratteri) descrizione del pacchetto. Di solito non è necessario usare il nome del programma. <code>Server X accelerato con OpenGL</code> è meglio di <code>xgl è un server X...</code>.
+
== Preparazione ==
  
*'''url:''' Qui dovrebbe essere inserito l'indirizzo del sito ufficiale del programma, dove chi è interessato possa trovare maggiori informazioni.
+
===Prerequisiti software===
  
*'''arch:''' Questa dovrebbe contenere un array delle architetture, normalmente 'i686' e/o 'x86_64', sulle quali il file PKGBUILD può essere usato. Si può accedere a questo valore con la variabile <code>$arch</code> durante la compilazione.
+
Prima di tutto assicurarsi che gli strumenti necessari siano installati. I pacchetti del gruppo  "base-devel" dovrebbero essere sufficienti, in quanto includono ''make'' e gli strumenti aggiuntivi necessari per la compilazione da sorgenti.
  
*'''license:''' Il tipo di licenza, se non la si conosce scrivere 'unknown'.
+
# pacman -S base-devel
  
*'''depends:''' Questa dovrebbe contenere un array di nomi di pacchetti, separati da spazi, che devono essere installati prima che il programma possa essere eseguito. I nomi possono facoltativamente essere chiusi in singoli apici (apostrofi) per prevenire eventuali problemi di citazione della shell; l'array dev'essere chiuso tra parentesi. A volte un programma richiede una versione minima di una dipendenza: in tal caso, si può usare l'operatore matematico "maggiore o uguale di" e racchiudere l'intero costrutto tra apici singoli. Di seguito un esempio per aggiungere una dipendenza dal pacchetto glibc e dalla libreria slang, versione minima 1.8.0: '''<code>depends=('glibc' 'slang>=1.8.0')</code>'''
+
Uno degli strumenti chiave per la creazione dei pacchetti è [[makepkg (Italiano)|makepkg]] (fornito da {{Pkg|pacman}}) che esegue le seguenti operazioni:
 +
#Controlla se le dipendenze dei pacchetti sono installate.
 +
#Scarica i file sorgente dai server specificati.
 +
#Scompatta il file sorgente.
 +
#Compila il software e lo installa in un ambiente fakeroot.
 +
#Identifica simboli da binari e librerie.
 +
#Genera il file meta pacchetto, che è incluso in ogni pacchetto.
 +
#Comprime l'ambiente fakeroot in un file pacchetto.
 +
#Memorizza il file pacchetto nella directory di destinazione configurata, che è la directory di lavoro di default.
  
*'''makedepends:''' Questa dovrebbe contenere un array di nomi di pacchetti necessari solo durante la compilazione, ma non necessari per ''usare'' il pacchetto dopo l'installazione. Esempio: <code>unarj</code>, usato in una compilazione per decomprimere alcune patch.
+
=== Scaricamento e test dell'installazione ===
  
*'''optdepends:''' Questa dovrebbe contenere un array di pacchetti opzionali (accompagnati da motivazioni) non essenziali per il pacchetto, ma che offrirebbero ulteriori funzionalitá o altre caratteristiche, una volta installati. Gli "optdepends" servono attualmente solo per fini informativi e non sono utilizzati da pacman durante la risoluzione delle dipendenze. Il formato dovrebbe essere simile al seguente: '''<code>optdepends=('fakeroot: for makepkg usage as normal user')</code>'''
+
Scaricare il tarball sorgente del software desiderato, estrarlo, e seguire la procedura dell'autore per installare il programma.  Prendere nota di tutti i comandi e/o passaggi necessari per la compilazione e l'installazione. Quegli stessi comandi verranno ripetuti nel file ''PKGBUILD''.
  
*'''provides:''' Questa dovrebbe contenere un array di nomi di pacchetti di cui questo pacchetto fornisce le caratteristiche (o un pacchetto virtuale come 'cron' o 'sh'). Se si usa questa variabile, bisognerebbe aggiungere la versione (pkgver e magari pkgrel) che questo pacchetto fornirà, se le dipendenze possono esserne influenzate. <br/>'''Esempio:''' Se si offre un pacchetto qt modificato, di nome qt-foo versione 3.3.8, che fornisce qt, allora ''provides'' dovrebbe somigliare a quanto segue: '''<code>provides=('qt=3.3.8')</code>'''. Scrivere '''<code>provides=('qt')</code>''' provocherà un fallimento delle dipendenze che richiedono una versione specifica di 'qt'. Ad ogni modo, se nessun pacchetto richiedeva una versione specifica di qt, questa indicazione sarebbe sufficiente. <br/>'''Esempio 2:''' Se il pacchetto perl-5.10.0 offre anche i moduli perl-foo versione 5.2.1 e perl-bar versione 2.5, allora provides è simile a: '''<code>provides=('perl-foo=5.2.1' 'perl-bar=2.5')</code>'''.
+
La maggior parte degli autori di software aderisce al ciclo dei 3 passi di compilazione:
  
*'''conflicts:''' Questa dovrebbe essere un array di nomi di pacchetti che se installati insieme a quello descritto creeranno problemi. Si può anche specificare le "proprietà di versione" del pacchetto in conflitto con lo stesso formato di ''depends''.
+
./configure
 +
make
 +
make install
  
*'''replaces:''' Questa dovrebbe essere un array di nomi di pacchetti obsoleti che sono rimpiazzati da quello descritto.
+
Questo è un buon momento per assicurarsi che il programma funzioni correttamente.
  
*'''source:''' Questo dev'essere un array di file necessari a compilare il pacchetto, contenenti perlomeno la locazione dei sorgenti del programma, che è nella maggioranza dei casi un URL HTTP o FTP completo racchiuso tra doppi apici (virgolette). Il prototipo di <code>PKGBUILD</code> mostra come si possono effettivamente usare le variabili precedentemente impostate per nome del pacchetto e versione all'interno di questa variabile. Se si scopre di aver bisogno di fornire file non scaricabili "al volo", ad esempio patch create personalmente, mettere semplicemente tali file nella stessa directory dove si trova il <code>PKGBUILD</code> e aggiungere il nome del file al presente array ''source''. Qualunque percorso ("path") sia aggiunto qui è risolto relativamente alla directory dove si trova il <code>PKGBUILD</code>. Prima dell'effettivo inizio del processo di compilazione, tutti i file indicati qui sono scaricati o ne è verificata l'esistenza e <code>makepkg</code> non procederà se ne manca qualcuno.
+
== Creazione di un PKGBUILD ==
  
*'''md5sums:''' Un array di checksum md5 per i file sorgenti, separati da spazi e racchiusi tra singoli apici. Una volta che tutti i file nell'array ''source'' sono disponibili, sarà automaticamente generato un hash md5 di ogni file e sarà confrontato con i valori dell'array presente, '''nello stesso ordine con cui appaiono nell'array ''source'''''. Benché l'ordine dei file sorgenti in sé non abbia importanza, è importante che sia coerente con l'ordine degli md5sum, poiché <code>makepkg</code> non indovinerà quale md5sum appartenga a ciascun file sorgente e inizierà a restituire errori se non corrispondono, per prevenire problemi di download e manipolazioni. Una volta costruito propriamente l'array ''source'', si può generare l'array degli md5sum rapidamente e facilmente con il comando <code>makepkg -g</code>, eseguito nella directory che contiene il <code>PKGBUILD</code>. Il comando <code>makepkg -g >> PKGBUILD</code> genererà invece le stringhe md5 e le aggiungerà alla fine del <code>PKGBUILD</code>, da dove si potranno spostare le righe nella corretta posizione del file.
+
Quando {{Ic|makepkg}} viene eseguito, cercherà un file {{ic|PKGBUILD}} nella directory di lavoro attuale. Se viene trovato un {{ic|PKGBUILD}} verrà scaricato il codice sorgente del software e compilato seguendo le istruzioni specificate nel {{ic|PKGBUILD}}. Le istruzioni devono essere interamente interpretabili dalla shell [[Wikipedia:Bash|Bash]]. Dopo l'avvenuto completamento, i binari risultanti e metadati del pacchetto, ad esempio la versione del pacchetto e le dipendenze, verranno impacchettate in un file {{ic|pkgname.pkg.tar.xz}} che può essere installato con {{Ic|pacman -U [nome_pacchetto]}}.
  
Finora sono state impostate solamente le meta-informazioni sul pacchetto: dove recuperare i sorgenti, il nome del pacchetto, ecc.. Il prossimo passo è di aggiungere istruzioni su come effettivamente ''compilare ed installare'' il programma che si intende impacchettare.
+
Per iniziare con un nuovo pacchetto, si deve prima creare una directory di lavoro vuota, (preferibilmente {{ic|~/abs/'''pkgname'''}}), spostarsi in quella directory, e creare un file {{ic|PKGBUILD}}.  È possibile anche copiare il prototipo di PKGBUILD {{ic|/usr/share/pacman/PKGBUILD.proto}} nella directory di lavoro o copiare un {{ic|PKGBUILD}} da un pacchetto simile. Quest'ultimo può essere utile avendo solo bisogno di cambiare alcune opzioni.
  
==Usare i sorgenti==
+
=== Definizione delle variabili PKGBUILD ===
Ora si devono scaricare i tarball sorgenti, estrarli ed annotare tutti i comandi necessari a compilarli ed installarli. I contenuti della funzione <code>build()</code> nel proprio <code>PKGBUILD</code> non faranno nient'altro che eseguire esattamente questi comandi di nuovo, con un po' di colla per impacchettare tutto una volta che la compilazione sia completata.
+
  
Ora probabilmente si deve modificare il contenuto della funzione <code>build()</code> nel <code>PKGBUILD</code>.  Questa funzione usa comuni comandi shell in sintassi bash.  L'obiettivo basilare di questa funzione è di compilare automaticamente i programmi e creare una directory <code>pkg</code> dove installare il programma, permettendo a <code>makepkg</code> di impacchettare tutto facilmente senza dover prelevare tutti file interessati dal proprio filesystem.
+
Il file {{ic|PKGBUILD}} contiene i metadati relativi a un pacchetto. Si tratta di un file di testo. Il seguente è un prototipo di {{ic|PKGBUILD}}. È possibile trovarlo in {{ic|/usr/share/pacman}} insieme ad altri modelli.
===La funzione build()===
+
Normalmente il primo passo nella funzione <code>build</code> è entrare in una delle directory create dalla decompressione dei file sorgenti. Per fare ciò si può usare la variabile <code>"$startdir"</code> (le virgolette evitano grattacapi nel caso il nome della directory contenga spazi), che si riferisce alla directory contenente il <code>PKGBUILD</code>. E' anche possibile usare le variabili $pkgname e $pkgver impostate precedentemente. Per esempio, a seconda del nome della directory decompressa da makepkg, il primo comando nella propria funzione build potrebbe essere <code>cd "${srcdir}/$pkgname-$pkgver"</code>, che è un caso molto comune a meno che l'autore del programma non sia una persona molto, molto malvagia. Se il numero di versione reale conteneva dei trattini, è necessario usare <code>"${pkgver//_/-}"</code> invece di <code>$pkgver</code>, di modo che bash rimpiazzi gli underscore con i trattini originali.
+
  
Compilare i programmi è la parte più difficile. Si assumerà qui che il lettore sia stato in grado di compilare il programma "a mano" con successo, poiché tutti i passi immaginabili per farlo non possono essere qui esposti. Dopotutto è per questo che è previsto che l'autore del programma scriva i file README e INSTALL.
+
{{Hc|/usr/share/pacman/PKGBUILD.proto|<nowiki>
 +
# Questo è un esempio di file PKGBUILD. Utilizzare questo come un inizio di creare i propri,
 +
#  rimuovere questi commenti. Per ulteriori informazioni, consultare 'man PKGBUILD'.
 +
# NOTE: Si prega di compilare il campo licenza per il proprio pacchetto! Se è sconosciuto,
 +
# si prega di mettere "sconosciuto".
  
Ora che ci si trova nella sopraddetta directory, bisogna trascrivere qualunque comando necessario a compilare i file. Nei casi semplici, può bastare usare <code>./configure; make</code>, anche se esistono decine di variazioni, compreso <code>ant build</code> o ricavare gli effettivi comandi <code>gcc</code> per compilare i pacchetti.
+
# Maintainer: Your Name <youremail@domain.com>
 +
pkgname=NAME
 +
pkgver=VERSION
 +
pkgrel=1
 +
epoch=
 +
pkgdesc=""
 +
arch=()
 +
url=""
 +
license=('GPL')
 +
groups=()
 +
depends=()
 +
makedepends=()
 +
checkdepends=()
 +
optdepends=()
 +
provides=()
 +
conflicts=()
 +
replaces=()
 +
backup=()
 +
options=()
 +
install=
 +
changelog=
 +
source=($pkgname-$pkgver.tar.gz)
 +
noextract=()
 +
md5sums=() #generate with 'makepkg -g'
  
Il lato positivo è che, se si è già riusciti a compilare manualmente il pacchetto, bisogna solo elencare qui i comandi usati e tutto dovrebbe funzionare bene. Dato che molti pacchetti amano installare i propri file nella directory <code>/usr/local</code>, ma Arch Linux preferisce usare solo <code>/usr</code>, probabilmente si vorrà aggiungere un parametro allo script configure o al comando make per occuparsene. Il prototipo di <code>PKGBUILD</code> serve da esempio per questo. Potrebbe doversi risolvere diversamente, comunque: di nuovo, non ci sono procedimenti uniformi per tutto.
+
build() {
 +
  cd "$srcdir/$pkgname-$pkgver"
 +
  ./configure --prefix=/usr
 +
  make
 +
}
  
*''E' buona pratica usare <code>--prefix=/usr/local</code> solo quando si compilano i sorgenti manualmente, compresi quelli compilati con ABS/makepkg, e riservare <code>/usr</code> per i pacchetti gestiti da pacman. Questo risparmierà dei mal di testa provocati da pacchetti conflittuali.''
+
check() {
 +
  cd "$srcdir/$pkgname-$pkgver"
 +
  make -k check
 +
}
  
Il passo seguente nella funzione <code>build()</code> è di mettere i file compilati in un posto dove <code>makepkg</code> li possa raccogliere per creare un pacchetto. Questo luogo è la directory <code>pkg</code>. E' semplicemente un ambiente di fakeroot. Essa dovrebbe rappresentare ed imitare la radice del proprio filesystem per la procedura di installazione del programma. Qualunque file debba essere installato in una directory nella radice del proprio filesystem, dovrebbe andare nella directory <code>pkg</code> sotto la stessa struttura di directory (per esempio se si vuole installare il file <code>myprog</code> in <code>/usr/bin</code>, dovrebbe essere messo in <code>${pkgdir}/usr/bin</code>). Fortunatamente, solo pochi programmi richiedono all’utente di copiare decine di file manualmente, fornendo invece un qualche tipo di installazione mirata  a farlo in automatico, spesso invocata dal comando "make install". E’ '''fondamentale''', comunque, scoprire come obbligare questa procedura di installazione a stipare tutti i suoi file '''non''' nella propria / , ma piuttosto in <code>${pkgdir}/</code> ! Altrimenti si terminerà con un file di pacchetto vuoto e i binari del programma installato "correttamente" aggiunti al proprio sistema. Il più delle volte si dovrà apporre il parametro <code>prefix</code> alla chiamata <code>make install</code>,  come mostrato nel prototipo, ma è altresì possibile che il programma che si sta impacchettando richieda un approccio completamente differente. Di seguito, allora, alcuni suggerimenti:
+
package() {
 +
  cd "$srcdir/$pkgname-$pkgver"
 +
  make DESTDIR="$pkgdir/" install
 +
}
 +
</nowiki>}}
  
* A volte lo script <code>configure</code> accetta una proprietà <code>prefix</code> che comunica dove dovrebbero essere installati i file. Si potrebbe, per esempio, usare <code>./configure --prefix=${pkgdir}/usr</code> in tale configurazione. E' necessario accertare che questa sia la directory corretta, in quanto a volte la directory decompressa potrebbe avere un nome differente:
+
''makepkg'' definisce tre variabili che si dovrebbe usare come parte del processo di installazione e di compilazione:
 +
; {{Ic|startdir}}: Contiene il percorso assoluto della directory in cui è contenuto il file {{ic|PKGBUILD}}. Questa variabile esiste per essere usata in combinazione con {{ic|/src}} o i postfix {{ic|/pkg}}, ma l'uso delle variabili {{Ic|srcdir}} e {{Ic|pkgdir}} è il metodo moderno. {{Ic|$startdir/src}} '''non''' è garantito per essere lo stesso di {{Ic|$srcdir}}, e così pure per {{Ic|$pkgdir}}. L'uso di questa variabile è obsoleto e fortemente scoraggiato.
 +
; {{Ic|srcdir}}: Questo punta alla directory in cui ''makepkg'' estrae o copia tutti i file sorgente.
 +
; {{Ic|pkgdir}}: Questo punta alla directory in cui ''makepkg'' sistema il pacchetto installato, che diventa la directory radice del pacchetto compilato.
  
  <pre>tar -xf foo-0.99.tar.gz</pre>
+
{{Note|''makepkg'', e quindi le funzioni {{Ic|build()}} e {{Ic|package()}}, sono destinate ad essere non-interattive.  Le utilità interattive o gli script richiamati in tali funzioni possono danneggiare ''makepkg'', soprattutto se richiamate con il build-logging attivo ({{Ic|-l}}). (Consultare [https://bugs.archlinux.org/task/13214 Arch Linux Bug #13214])}}
  
ed <code>ls</code> potrebbe restituire:
+
Note: a parte il pacchetto maintainer attuale, vi possono essere precedenti manutentori sopra elencati come contributori.
  
  <pre>
+
Una spiegazione delle variabili {{ic|PKGBUILD}} possibili può essere trovata nell'articolo [[PKGBUILD (Italiano)|PKGBUILD]].
  .
+
  ..
+
  foo-0.99.tar.gz
+
  foo/</pre>
+
  
e non:
+
=== La funzione {{Ic|build()}} ===
  
  <pre>
+
Ora è necessario implementare la funzione {{Ic|build()}} nel file {{ic|PKGBUILD}}. Questa funzione utilizza i comandi di shell comuni nella sintassi [http://en.wikipedia.org/wiki/Bash_%28Unix_shell%29 Bash] per compilare automaticamente il software e creare una directory {{ic|pkg}} per installare il software. Questo permette a ''makepkg'' di impacchettare i file senza dover passare al setaccio il filesystem.
  .
+
  ..
+
  foo-0.99.tar.gz
+
  foo-0.99/</pre>
+
  
* A volte c'è un'opzione <code>PREFIX</code> da aggiungere al comando <code>make install</code>. Questa è impostata talvolta come una variabile, talvolta nel comando stesso. Nei casi peggiori è necessario modificare il/i Makefile (oppure i file di compilazione o di proprietà di ant, se il progetto sfrutta ant) con <code>sed</code> o con una patch da crearsi.
+
Il primo passo della funzione {{Ic|build()}} è quello di spostarsi nella directory creata durante la decompressione dei sorgenti. Nella maggior parte dei casi il primo comando sarà simile a questo:
  
* Ci potrebbero essere altri tipi di script d'installazione che permettono di specificare dove installare il programma.
+
cd $srcdir/$pkgname-$pkgver
  
* In alcuni casi, il programma si attende di essere lanciato da una singola directory. E' spesso saggio copiare questa in <code>${pkgdir}/opt</code>.
+
Ora sarà necessario elencare gli stessi comandi usati durante la compilazione manuale del software.  La funzione {{Ic|build()}} in sostanza, consente di automatizzare tutto ciò che si è fatto a mano e compila il software nell'ambiente fakeroot di compilazione.  Se il software che si è impacchettato usa uno script di configurazione, è buona norma usare {{Ic|1=--prefix=/usr}} quando si compilano i pacchetti per ''pacman''. Moltissimi software installano i file relativi alla directory {{ic|/usr/local}}, cosa che dovrebbe essere fatta solo avendo compilato manualmente dai sorgenti. Tutti i pacchetti Arch Linux dovrebbe usare la directory {{ic|/usr}}.  Come si vede nel file {{ic|/usr/share/pacman/PKGBUILD.proto}}, le successive due righe sono spesso simili a questa:
  
Come si può capire, questa è la parte dove l'effettiva conoscenza e l'esperienza diventano necessità. Aiuta molto osservare i file <code>PKGBUILD</code> nell'albero di ABS, poiché questi sono testati e contengono qualche trucco che potrebbe risultare utile.
+
./configure --prefix=/usr
 +
make
  
Spesso, inoltre, il processo di installazione del programma avrà cura di creare, dentro la directory <code>pkg/</code>, qualunque sottodirectory . Se questo non succede, comunque, si riceveranno molti errori durante l'installazione, perché i file sono copiati in sottodirectory inesistenti. In tal caso si dovranno creare le sottodirectory necessarie aggiungendo gli adeguati comandi <code>mkdir</code> nella funzione <code>build()</code> prima di avviare la procedura d'installazione. L'effettiva struttura di directory dipende dal pacchetto, naturalmente; alcuni programmi hanno bisogno di collocare dei file in  <code>/etc</code> o in <code>/usr</code>, mentre altri potrebbero dover usare <code>/bin</code> oppure <code>/opt</code>.  La maggior parte dovrà creare parecchie directory.  Si può fare tutto ciò con il comando <code>mkdir -p ${pkgdir}/ALTRE/DIRECTORY/NECESSARIE</code>, dove ALTRE/DIRECTORY/NECESSARIE rappresentano le directory nel filesystem root.
+
=== La funzione {{Ic|package()}} ===
  
==Il file '''.install''': per azioni durante l'installazione==
+
Il passo finale è quello di mettere i file compilati in una directory in cui ''makepkg'' sia in grado di recuperarli per creare un pacchetto. Questa, per impostazione predefinita è la directory {{ic|pkg}}, un semplice ambiente fakeroot.  La directory {{ic|pkg}} replica la gerarchia del file system root nel percorso del software installato.  Dovendo spostare manualmente i file sotto la root del filesystem, si dovrebbe installarli nella directory {{ic|pkg}} sotto la stessa struttura della directory. Ad esempio, se si desidera installare un file in {{ic|/usr/bin}}, dovrebbe invece essere messo in {{ic|$pkgdir/usr/bin}}.  Solo alcune procedure d'installazione richiedono all'utente di copiare decine di file manualmente. Al contrario, per la maggior parte del software, invocando {{Ic|make install}} verrà eseguito così.  L'ultima riga dovrebbe essere simile alla seguente per installare correttamente il software nella directory {{ic|pkg}}:
  
Se sono necessari delle operazioni dopo l'installazione per il funzionamento, o per messaggi in output all'utente, si dovrà usare un file '''.install'''.
+
make DESTDIR=$pkgdir install
  
Specificare il file '''.install''' includendo la riga seguente nel proprio PKGBUILD:
+
{{Note|A volte capita che {{Ic|DESTDIR}} non è utilizzato nel {{ic|Makefile}}; potrebbe invece essere necessario utilizzare il {{Ic|prefix}}. Se il pacchetto è compilato con ''autoconf''/''automake'', utilizzare {{Ic|DESTDIR}}; questo è ciò che è [http://sources.redhat.com/automake/automake.html#Install documentato] nei manuali. Se {{Ic|DESTDIR}} non funziona, provare a compilare con {{Ic|1=make prefix="$pkgdir/usr/" install}}. Se questo non funziona, si dovranno fare degli approfondimenti per i comandi di installazione che vengono eseguiti da "{{Ic|make <...> install}}".}}
<code>install=${pkgname}.install</code>
+
  
Quindi, creare un file <code>(pkgname).install</code>. Un prototipo di '''.install''' è presente in <code>/usr/share/pacman/proto.install</code> per un aiuto per l'inizio:
+
In alcuni rari casi, il software si aspetta di essere eseguito da una singola directory. In tali casi, è bene copiare semplicemente questi in {{ic|$pkgdir/opt}}.
  
  # This is a default template for a post-install scriptlet.
+
Molto spesso, il processo di installazione del software creerà una sottodirectory in {{ic|pkg}}. Se così non fosse però, ''makepkg'' genererà un sacco di errori e sarà necessario creare manualmente le sottodirectory aggiungendo gli appropriati comandi {{Ic|mkdir -p}} nella funzione {{Ic|build()}} prima che venga eseguita la procedura di installazione.
  # Uncomment only required functions and remove any functions
+
  # you don't need (and this header).
+
  
  ## arg 1:  the new package version
+
Nei pacchetti datati, non vi era alcuna funzione {{Ic|package()}}, e così, sistemare i file compilati veniva fatto alla fine della funzione {{Ic|build()}}. Se {{Ic|package()}} non è presente, eseguire {{Ic|build()}} tramite ''fakeroot''. Se invece {{Ic|package()}} è presente, eseguire {{Ic|build()}} da utente con ''makepkg'', {{Ic|package()}} tramite ''fakeroot''.
  #pre_install() {
+
    # do something here
+
  #}
+
  
  ## arg 1:  the new package version
+
{{Ic|makepkg --repackage}} esegue solo la funzione {{Ic|package()}}, così crea un file {{Ic|*.pkg.*}} senza compilare il pacchetto. Questo può risparmiare tempo, ad esempio avendo appena cambiato la variabile {{Ic|depends}} del pacchetto.
  #post_install() {
+
    # do something here
+
  #}
+
  
  ## arg 1:  the new package version
+
=== Informazioni aggiuntive ===
  ## arg 2:  the old package version
+
  #pre_upgrade() {
+
    # do something here
+
  #}
+
  
  ## arg 1:  the new package version
+
Si prega di leggere [[Arch Packaging Standards (Italiano)|Arch Packaging Standards]] per approfondimenti e considerazioni aggiuntive.
  ## arg 2:  the old package version
+
  #post_upgrade() {
+
    # do something here
+
  #}
+
  
  ## arg 1:  the old package version
+
==Testare il PKGBUILD==
  #pre_remove() {
+
    # do something here
+
  #}
+
  
  ## arg 1:  the old package version
+
Mentre si scrive la funzione {{Ic|build()}}, si vorrà collaudare frequentemente i cambiamenti, per essere sicuri che non ci siano bug. Questo si può fare usando il comando {{Ic|makepkg}} nella directory contenente il {{ic|PKGBUILD}}. Con un {{ic|PKGBUILD}}, propriamente formattato, makepkg creerà un pacchetto; ma con uno errato o non finito, restituirà un errore.
  #post_remove() {
+
    # do something here
+
  #}
+
  
  # vim:set ts=2 sw=2 et:
+
Se il processo di makepkg è finito correttamente, creerà un nuovo file chiamato {{ic|pkgname-pkgver.pkg.tar.xz}} nella directory di lavoro. Questo è un pacchetto di pacman e può essere installato con {{Ic|pacman -U}}. Notare che il fatto che il pacchetto sia stato compilato non significa che funzioni! È plausibile che contenga solo la directory e nessun file se, per esempio, un {{ic|prefix}} è stato specificato impropriamente. Si possono usare le funzioni di ricerca di pacman per visualizzare una lista di file contenuti nel pacchetto e le dipendenze da esso richieste con {{Ic|pacman -Qlp [package file]}} e {{Ic|pacman -Qip [package file]}}.
  
==Testare il PKGBUILD==
+
Se il pacchetto sembra essere valido, è tutto. Comunque, se si pensa di rilasciare il {{ic|PKGBUILD}}, è obbligatorio controllare e ricontrollare e ricontrollare ancora i contenuti dell'array {{Ic|depends}}.
  
Mentre si scrive la funzione <code>build()</code> del <code>PKGBUILD</code>, si vorrà collaudare frequentemente i cambiamenti, per essere sicuri che non ci siano bug. Questo si può fare usando il comando <code>makepkg</code> nella directory contenente il <code>PKGBUILD</code>. Con un <code>PKGBUILD</code> propriamente formattato, questo creerà un pacchetto; ma con uno errato o non finito, restituirà un errore. Con un po' di fortuna sarà un errore descrittivo!
+
Assicurarsi inoltre che i pacchetti binari ''funzionino'' effettivamente senza problemi È fastidioso rilasciare un pacchetto che contiene tutti i file necessari, ma si blocca a causa di qualche opzione di configurazione che non funziona bene con il resto del sistema. Se si sta compilando dei pacchetti per il proprio sistema, però, non c'è bisogno di preoccuparsi troppo di questo passaggio di controllo della qualità, essendo in questo caso, il creatore, l'unico a riportare tali errori.
  
Se il processo di <code>makepkg</code> è finito correttamente, creerà un nuovo file chiamato $pkgname-$pkgver.pkg.tar.gz nella directory attuale. Questo è un pacchetto di pacman e può essere installato con le opzioni <code>pacman -U</code> e <code>pacman -A</code>, oppure aggiunto ad un repository locale o sul web.  Notare che il fatto che il pacchetto sia stato costruito non significa che funzioni! E' plausibile che contenga solo la struttura di directory e nessun file se, per esempio, un <code>prefix</code> è stato specificato impropriamente. Si possono usare le funzioni di ricerca di pacman per visualizzare una lista di file contenuti nel pacchetto e le dipendenze da esso richieste, per confrontarle con quelle considerate corrette. Si occupano di ciò <code>pacman -Qlp <nome pacchetto></code> e <code>pacman -Qip <nome pacchetto></code>.
+
=== {{Ic|ldd}} e {{Ic|namcap}} ===
  
Se il pacchetto sembra valido, è tutto. Comunque, se si pensa di rilasciare il pacchetto o il PKGBUILD, è obbligatorio controllare e ricontrollare e ricontrollare ancora i contenuti dell'array ''depends''. Questo dovrebbe contenere una lista di tutti i pacchetti che devono essere installati affinché il proprio pacchetto funzioni. Bisogna elencare solo le dipendenze di primo livello nell'array ''depends''. Questo significa che non bisogna elencare pacchetti da cui il proprio programma dipende, se da questi dipendono anche altri pacchetti già elencati.
+
Le dipendenze sono l'errore più comune riguardo l'impacchettamento. Ci sono due ottimi strumenti che è possibile utilizzare per controllare le dipendenze. Il primo è ''ldd'', che mostrerà le dipendenze delle librerie condivise dei file dinamici eseguibili:
 +
$ ldd gcc
 +
linux-gate.so.1 =>  (0xb7f33000)
 +
libc.so.6 => /lib/libc.so.6 (0xb7de0000)
 +
/lib/ld-linux.so.2 (0xb7f34000)
  
Per esempio, <code>gtk2</code> dipende da <code>glib2</code>. Come molti programmi open source scritti in C, richiede anche che sia installato <code>glibc</code>. Comunque, <code>glibc</code> non ha bisogno di essere elencato come dipendenza per <code>gtk2</code>, perché è una dipendenza di <code>glib2</code>, e <code>glib2</code> è già elencato nelle dipendenze di <code>gtk2</code>.
+
L'altro strumento è [[namcap (Italiano)|namcap]], che non solo controlla le dipendenze ma l'integrità complessiva del pacchetto. Si prega di leggere l'articolo [[namcap (Italiano)|namcap]] per una descrizione dettagliata.
 +
 
 +
== Invio di pacchetti di AUR ==
 +
 
 +
Si prega di leggere [https://wiki.archlinux.org/index.php/Arch_User_Repository_%28Italiano%29#Condividere_i_PKGBUILD_su_UNSUPPORTED AUR User Guidelines#SCondividere i PKGBUILD su UNSUPPORTED] per una descrizione dettagliata del processo di invio.
  
Esistono alcuni strumenti che si possono usare per controllare le dipendenze, compreso il famoso programma di Jason Chu <code>namcap</code> (<code>pacman -Sy namcap</code>) e il più antico <code>ldd</code>.  Controllare le pagine man di questi programmi ed i link alla fine di questo documento per maggiori informazioni. Si dovrebbero anche scorrere la documentazione e il sito web del programma (alcuni simpatici sviluppatori hanno una pagina chiamata "dipendenze" che aiuta molto).
 
==Testare il pacchetto==
 
Assicurarsi anche che i binari del pacchetto si ''eseguano'' bene! E' fastidioso rilasciare un pacchetto che contiene tutti i file necessari, ma fa un core dump a causa di qualche oscura opzione di configurazione che non funziona bene con il resto del sistema. Se si compilano pacchetti solo per il proprio sistema, tuttavia, non c'è bisogno di preoccuparsi troppo di questo passo della "assicurazione di qualità". Il sistema affetto da problemi, dopo tutto, sarà solo il proprio.
 
 
==Per ricapitolare==
 
==Per ricapitolare==
* Scaricare i tarball sorgenti del programma che si vuole impacchettare
 
* Provare a compilare il pacchetto e installarlo in una directory arbitraria
 
* Copiare il prototipo <code>/usr/share/pacman/PKGBUILD.proto</code> e rinominarlo in <code>PKGBUILD</code> in una directory di lavoro temporanea
 
* Modificare il PKGBUILD secondo le necessità del proprio pacchetto
 
* Lanciare <code>makepkg</code> e vedere se il pacchetto risultante è costruito correttamente
 
* In caso contrario, ripetere gli ultimi due passi
 
  
==Link utili==
+
#Scaricare i tarball sorgenti del programma che si vuole impacchettare.
* [[ABS_-_Il_Sistema_Di_Compilazione_di_Arch_(Italiano) | ABS - Il Sistema Di Compilazione di Arch]]
+
#Provare a compilare il pacchetto e installarlo in una directory arbitraria.
* [http://www.archlinux.org/pacman/makepkg.8.html Pagina man per makepkg]
+
#Copiare il prototipo {{ic|/usr/share/pacman/PKGBUILD.proto}} e rinominarlo in {{ic|PKGBUILD}} in una directory di lavoro temporanea, preferibilmente {{ic|~/abs/}}.
* [http://bbs.archlinux.org/viewtopic.php?t=4 Discussione sul forum internazionale a proposito di dipendenze]
+
#Modificare il {{ic|PKGBUILD}} secondo le necessità del proprio pacchetto.
* [[Makepkg (Italiano)|Tutorial di makepkg]]
+
#Lanciare {{Ic|makepkg}} e vedere se il pacchetto risultante è complilato correttamente.
* [[ABS PKGBUILD Explained]]
+
#In caso contrario, ripetere gli ultimi due passi.
* [[Arch CVS & SVN PKGBUILD guidelines]]
+
 
 +
=== Avvertenze ===
 +
 
 +
* Prima di poter automatizzare il processo di compilazione di un pacchetto, bisognerebbe averlo fatto manualmente almeno una volta a meno di non conoscere ''esattamente'' cosa si sta facendo ''a priori'', nel qual caso non si starebbe leggendo questo articolo come primo passo. Sfortunatamente, nonostante un buon gruppo di programmatori si attengano al ciclo di compilazione in tre passi di "{{Ic|./configure}}; {{Ic|make}}; {{Ic|make install}}", questo non accade sempre, e le cose possono diventare davvero pessime se bisogna applicare patch per far funzionare tutto. Regola empirica: se non si riesce a compilare il programma dal tarball sorgente e farlo installare da sè in una sottodirectory temporanea definita, non bisogna neanche provare a impacchettarlo. Non c'è nessuna polvere magica in {{Ic|makepkg}} che risolva i problemi dei sorgenti.
 +
* In qualche caso, i pacchetti non sono nemmeno disponibili come sorgenti e bisogna usare qualcosa come {{Ic|sh installer.run}} per farli funzionare. Si dovrà fare un po' di lavoro di ricerca (leggere i README, le istruzioni di INSTALL, pagine man, magari ebuild da Gentoo o altri gestori di pacchetti, eventualmente persino i MAKEFILE o il codice sorgente) per metterli a posto. In certi casi, davvero spiacevoli, bisogna modificare i file sorgenti per far funzionare tutto bene. Comunque, {{Ic|makepkg}} deve essere completamente autonomo, senza alcun input da utente. Perciò se si devono modificare i Makefile, si potrebbe dover creare una patch personalizzata con il {{ic|PKGBUILD}} ed installarla da dentro la funzione {{Ic|build()}}, o si potrebbe dover inserire alcuni comandi {{Ic|sed}} da dentro la stessa funzione.
  
==Avvertenze==
+
==Consultare inoltre==
* Prima di poter automatizzare il processo di compilazione di un pacchetto, bisognerebbe averlo fatto manualmente almeno una volta a meno di non conoscere ''esattamente'' cosa si sta facendo ''a priori'', nel qual caso non si starebbe leggendo questo articolo come primo. Sfortunatamente, nonostante un buon gruppo di programmatori si attengano al ciclo di compilazione in tre passi di <code>./configure; make; make install</code>, questo non accade sempre, e le cose possono diventare davvero pessime se bisogna applicare patch per far funzionare tutto. Regola empirica: se non si riesce a compilare il programma dal tarball sorgente e farlo installare da sè in una sottodirectory temporanea definita, non bisogna neanche provare a impacchettarlo. Non c'è nessuna polvere magica in <code>makepkg</code> che risolva i problemi dei sorgenti.
+
* [https://bbs.archlinux.org/viewtopic.php?id=91408 How to correctly create a patch file].
* In qualche caso, i pacchetti non sono nemmeno disponibili come sorgenti e bisogna usare qualcosa come <code>sh installer.run</code> per farli funzionare. Si dovrà fare un po' di lavoro di ricerca (leggere i README, le istruzioni di INSTALL, pagine man, magari ebuild da Gentoo o altri gestori di pacchetti, eventualmente persino i MAKEFILE o il codice sorgente) per metterli a posto. In certi casi davvero brutti, bisogna modificare i file sorgenti per far funzionare tutto bene. Comunque, <code>makepkg</code> deve essere completamente autonomo, senza alcun input da utente. Perciò se si devono modificare i Makefile, si potrebbe dover creare una patch personalizzata con il <code>PKGBUILD</code> ed installarla da dentro la funzione <code>build()</code>, o si potrebbe dover inserire alcuni comandi <code>sed</code> da dentro la stessa funzione.
+

Revision as of 23:40, 5 December 2012

Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary wiki Template:Article summary wiki Template:Article summary wiki Template:Article summary wiki Template:Article summary wiki Template:Article summary wiki Template:Article summary wiki Template:Article summary end

Questo articolo si propone di assistere gli utenti nella creazione dei propri pacchetti con il sistema di compilazione "ports-like" di Arch Linux. riguarda la creazione di un PKGBUILD, un pacchetto con la descrizione dei file sorgente utilizzato da makepkg per creare un pacchetto binario dal codice sorgente. Se si è già in possesso di un PKGBUILD, vedere makepkg.

Introduzione

I pacchetti in Arch Linux sono compilati utilizzando l'utilità makepkg e le informazioni memorizzate in un file PKGBUILD. Quando avviato, makepkg va alla ricerca di un PKGBUILD nella presente directory e segue le istruzioni per o compilare, o acquisire i file necessari ad essere impacchettati all'interno di un file pacchetto (pkgname.pkg.tar.xz). Il pacchetto risultante contiene i file binari e le istruzioni di installazione, facilmente installabili con pacman.

Un pacchetto di Arch non è altro che un archivio tar compresso utilizzando "xz", o "tarball", che contiene:

  • I file binari per l'installazione
  • .PKGINFO: contiene tutti i metadati necessari a pacman per gestire i pacchetti, le dipendenze, ecc.
  • .INSTALL: un file opzionale utilizzato per eseguire comandi dopo l'installazione, aggiornamento o rimozione degli stage. (Questo file è presente solo se specificato nel PKGBUILD)
  • .Changelog: un file opzionale conservato dal manutentore del pacchetto che documenta i cambiamenti dello stesso. (Non è presente in tutti i pacchetti)

Preparazione

Prerequisiti software

Prima di tutto assicurarsi che gli strumenti necessari siano installati. I pacchetti del gruppo "base-devel" dovrebbero essere sufficienti, in quanto includono make e gli strumenti aggiuntivi necessari per la compilazione da sorgenti.

# pacman -S base-devel

Uno degli strumenti chiave per la creazione dei pacchetti è makepkg (fornito da pacman) che esegue le seguenti operazioni:

  1. Controlla se le dipendenze dei pacchetti sono installate.
  2. Scarica i file sorgente dai server specificati.
  3. Scompatta il file sorgente.
  4. Compila il software e lo installa in un ambiente fakeroot.
  5. Identifica simboli da binari e librerie.
  6. Genera il file meta pacchetto, che è incluso in ogni pacchetto.
  7. Comprime l'ambiente fakeroot in un file pacchetto.
  8. Memorizza il file pacchetto nella directory di destinazione configurata, che è la directory di lavoro di default.

Scaricamento e test dell'installazione

Scaricare il tarball sorgente del software desiderato, estrarlo, e seguire la procedura dell'autore per installare il programma. Prendere nota di tutti i comandi e/o passaggi necessari per la compilazione e l'installazione. Quegli stessi comandi verranno ripetuti nel file PKGBUILD.

La maggior parte degli autori di software aderisce al ciclo dei 3 passi di compilazione:

./configure
make
make install

Questo è un buon momento per assicurarsi che il programma funzioni correttamente.

Creazione di un PKGBUILD

Quando makepkg viene eseguito, cercherà un file PKGBUILD nella directory di lavoro attuale. Se viene trovato un PKGBUILD verrà scaricato il codice sorgente del software e compilato seguendo le istruzioni specificate nel PKGBUILD. Le istruzioni devono essere interamente interpretabili dalla shell Bash. Dopo l'avvenuto completamento, i binari risultanti e metadati del pacchetto, ad esempio la versione del pacchetto e le dipendenze, verranno impacchettate in un file pkgname.pkg.tar.xz che può essere installato con pacman -U [nome_pacchetto].

Per iniziare con un nuovo pacchetto, si deve prima creare una directory di lavoro vuota, (preferibilmente ~/abs/pkgname), spostarsi in quella directory, e creare un file PKGBUILD. È possibile anche copiare il prototipo di PKGBUILD /usr/share/pacman/PKGBUILD.proto nella directory di lavoro o copiare un PKGBUILD da un pacchetto simile. Quest'ultimo può essere utile avendo solo bisogno di cambiare alcune opzioni.

Definizione delle variabili PKGBUILD

Il file PKGBUILD contiene i metadati relativi a un pacchetto. Si tratta di un file di testo. Il seguente è un prototipo di PKGBUILD. È possibile trovarlo in /usr/share/pacman insieme ad altri modelli.

/usr/share/pacman/PKGBUILD.proto
# Questo è un esempio di file PKGBUILD. Utilizzare questo come un inizio di creare i propri,
#  rimuovere questi commenti. Per ulteriori informazioni, consultare 'man PKGBUILD'.
# NOTE: Si prega di compilare il campo licenza per il proprio pacchetto! Se è sconosciuto,
# si prega di mettere "sconosciuto".

# Maintainer: Your Name <youremail@domain.com>
pkgname=NAME
pkgver=VERSION
pkgrel=1
epoch=
pkgdesc=""
arch=()
url=""
license=('GPL')
groups=()
depends=()
makedepends=()
checkdepends=()
optdepends=()
provides=()
conflicts=()
replaces=()
backup=()
options=()
install=
changelog=
source=($pkgname-$pkgver.tar.gz)
noextract=()
md5sums=() #generate with 'makepkg -g'

build() {
  cd "$srcdir/$pkgname-$pkgver"
  ./configure --prefix=/usr
  make
}

check() {
  cd "$srcdir/$pkgname-$pkgver"
  make -k check
}

package() {
  cd "$srcdir/$pkgname-$pkgver"
  make DESTDIR="$pkgdir/" install
}

makepkg definisce tre variabili che si dovrebbe usare come parte del processo di installazione e di compilazione:

startdir
Contiene il percorso assoluto della directory in cui è contenuto il file PKGBUILD. Questa variabile esiste per essere usata in combinazione con /src o i postfix /pkg, ma l'uso delle variabili srcdir e pkgdir è il metodo moderno. $startdir/src non è garantito per essere lo stesso di $srcdir, e così pure per $pkgdir. L'uso di questa variabile è obsoleto e fortemente scoraggiato.
srcdir
Questo punta alla directory in cui makepkg estrae o copia tutti i file sorgente.
pkgdir
Questo punta alla directory in cui makepkg sistema il pacchetto installato, che diventa la directory radice del pacchetto compilato.
Note: makepkg, e quindi le funzioni build() e package(), sono destinate ad essere non-interattive. Le utilità interattive o gli script richiamati in tali funzioni possono danneggiare makepkg, soprattutto se richiamate con il build-logging attivo (-l). (Consultare Arch Linux Bug #13214)

Note: a parte il pacchetto maintainer attuale, vi possono essere precedenti manutentori sopra elencati come contributori.

Una spiegazione delle variabili PKGBUILD possibili può essere trovata nell'articolo PKGBUILD.

La funzione build()

Ora è necessario implementare la funzione build() nel file PKGBUILD. Questa funzione utilizza i comandi di shell comuni nella sintassi Bash per compilare automaticamente il software e creare una directory pkg per installare il software. Questo permette a makepkg di impacchettare i file senza dover passare al setaccio il filesystem.

Il primo passo della funzione build() è quello di spostarsi nella directory creata durante la decompressione dei sorgenti. Nella maggior parte dei casi il primo comando sarà simile a questo:

cd $srcdir/$pkgname-$pkgver

Ora sarà necessario elencare gli stessi comandi usati durante la compilazione manuale del software. La funzione build() in sostanza, consente di automatizzare tutto ciò che si è fatto a mano e compila il software nell'ambiente fakeroot di compilazione. Se il software che si è impacchettato usa uno script di configurazione, è buona norma usare --prefix=/usr quando si compilano i pacchetti per pacman. Moltissimi software installano i file relativi alla directory /usr/local, cosa che dovrebbe essere fatta solo avendo compilato manualmente dai sorgenti. Tutti i pacchetti Arch Linux dovrebbe usare la directory /usr. Come si vede nel file /usr/share/pacman/PKGBUILD.proto, le successive due righe sono spesso simili a questa:

./configure --prefix=/usr
make

La funzione package()

Il passo finale è quello di mettere i file compilati in una directory in cui makepkg sia in grado di recuperarli per creare un pacchetto. Questa, per impostazione predefinita è la directory pkg, un semplice ambiente fakeroot. La directory pkg replica la gerarchia del file system root nel percorso del software installato. Dovendo spostare manualmente i file sotto la root del filesystem, si dovrebbe installarli nella directory pkg sotto la stessa struttura della directory. Ad esempio, se si desidera installare un file in /usr/bin, dovrebbe invece essere messo in $pkgdir/usr/bin. Solo alcune procedure d'installazione richiedono all'utente di copiare decine di file manualmente. Al contrario, per la maggior parte del software, invocando make install verrà eseguito così. L'ultima riga dovrebbe essere simile alla seguente per installare correttamente il software nella directory pkg:

make DESTDIR=$pkgdir install
Note: A volte capita che DESTDIR non è utilizzato nel Makefile; potrebbe invece essere necessario utilizzare il prefix. Se il pacchetto è compilato con autoconf/automake, utilizzare DESTDIR; questo è ciò che è documentato nei manuali. Se DESTDIR non funziona, provare a compilare con make prefix="$pkgdir/usr/" install. Se questo non funziona, si dovranno fare degli approfondimenti per i comandi di installazione che vengono eseguiti da "make <...> install".

In alcuni rari casi, il software si aspetta di essere eseguito da una singola directory. In tali casi, è bene copiare semplicemente questi in $pkgdir/opt.

Molto spesso, il processo di installazione del software creerà una sottodirectory in pkg. Se così non fosse però, makepkg genererà un sacco di errori e sarà necessario creare manualmente le sottodirectory aggiungendo gli appropriati comandi mkdir -p nella funzione build() prima che venga eseguita la procedura di installazione.

Nei pacchetti datati, non vi era alcuna funzione package(), e così, sistemare i file compilati veniva fatto alla fine della funzione build(). Se package() non è presente, eseguire build() tramite fakeroot. Se invece package() è presente, eseguire build() da utente con makepkg, package() tramite fakeroot.

makepkg --repackage esegue solo la funzione package(), così crea un file *.pkg.* senza compilare il pacchetto. Questo può risparmiare tempo, ad esempio avendo appena cambiato la variabile depends del pacchetto.

Informazioni aggiuntive

Si prega di leggere Arch Packaging Standards per approfondimenti e considerazioni aggiuntive.

Testare il PKGBUILD

Mentre si scrive la funzione build(), si vorrà collaudare frequentemente i cambiamenti, per essere sicuri che non ci siano bug. Questo si può fare usando il comando makepkg nella directory contenente il PKGBUILD. Con un PKGBUILD, propriamente formattato, makepkg creerà un pacchetto; ma con uno errato o non finito, restituirà un errore.

Se il processo di makepkg è finito correttamente, creerà un nuovo file chiamato pkgname-pkgver.pkg.tar.xz nella directory di lavoro. Questo è un pacchetto di pacman e può essere installato con pacman -U. Notare che il fatto che il pacchetto sia stato compilato non significa che funzioni! È plausibile che contenga solo la directory e nessun file se, per esempio, un prefix è stato specificato impropriamente. Si possono usare le funzioni di ricerca di pacman per visualizzare una lista di file contenuti nel pacchetto e le dipendenze da esso richieste con pacman -Qlp [package file] e pacman -Qip [package file].

Se il pacchetto sembra essere valido, è tutto. Comunque, se si pensa di rilasciare il PKGBUILD, è obbligatorio controllare e ricontrollare e ricontrollare ancora i contenuti dell'array depends.

Assicurarsi inoltre che i pacchetti binari funzionino effettivamente senza problemi È fastidioso rilasciare un pacchetto che contiene tutti i file necessari, ma si blocca a causa di qualche opzione di configurazione che non funziona bene con il resto del sistema. Se si sta compilando dei pacchetti per il proprio sistema, però, non c'è bisogno di preoccuparsi troppo di questo passaggio di controllo della qualità, essendo in questo caso, il creatore, l'unico a riportare tali errori.

ldd e namcap

Le dipendenze sono l'errore più comune riguardo l'impacchettamento. Ci sono due ottimi strumenti che è possibile utilizzare per controllare le dipendenze. Il primo è ldd, che mostrerà le dipendenze delle librerie condivise dei file dinamici eseguibili:

$ ldd gcc
linux-gate.so.1 =>  (0xb7f33000)
libc.so.6 => /lib/libc.so.6 (0xb7de0000)
/lib/ld-linux.so.2 (0xb7f34000)

L'altro strumento è namcap, che non solo controlla le dipendenze ma l'integrità complessiva del pacchetto. Si prega di leggere l'articolo namcap per una descrizione dettagliata.

Invio di pacchetti di AUR

Si prega di leggere AUR User Guidelines#SCondividere i PKGBUILD su UNSUPPORTED per una descrizione dettagliata del processo di invio.

Per ricapitolare

  1. Scaricare i tarball sorgenti del programma che si vuole impacchettare.
  2. Provare a compilare il pacchetto e installarlo in una directory arbitraria.
  3. Copiare il prototipo /usr/share/pacman/PKGBUILD.proto e rinominarlo in PKGBUILD in una directory di lavoro temporanea, preferibilmente ~/abs/.
  4. Modificare il PKGBUILD secondo le necessità del proprio pacchetto.
  5. Lanciare makepkg e vedere se il pacchetto risultante è complilato correttamente.
  6. In caso contrario, ripetere gli ultimi due passi.

Avvertenze

  • Prima di poter automatizzare il processo di compilazione di un pacchetto, bisognerebbe averlo fatto manualmente almeno una volta a meno di non conoscere esattamente cosa si sta facendo a priori, nel qual caso non si starebbe leggendo questo articolo come primo passo. Sfortunatamente, nonostante un buon gruppo di programmatori si attengano al ciclo di compilazione in tre passi di "./configure; make; make install", questo non accade sempre, e le cose possono diventare davvero pessime se bisogna applicare patch per far funzionare tutto. Regola empirica: se non si riesce a compilare il programma dal tarball sorgente e farlo installare da sè in una sottodirectory temporanea definita, non bisogna neanche provare a impacchettarlo. Non c'è nessuna polvere magica in makepkg che risolva i problemi dei sorgenti.
  • In qualche caso, i pacchetti non sono nemmeno disponibili come sorgenti e bisogna usare qualcosa come sh installer.run per farli funzionare. Si dovrà fare un po' di lavoro di ricerca (leggere i README, le istruzioni di INSTALL, pagine man, magari ebuild da Gentoo o altri gestori di pacchetti, eventualmente persino i MAKEFILE o il codice sorgente) per metterli a posto. In certi casi, davvero spiacevoli, bisogna modificare i file sorgenti per far funzionare tutto bene. Comunque, makepkg deve essere completamente autonomo, senza alcun input da utente. Perciò se si devono modificare i Makefile, si potrebbe dover creare una patch personalizzata con il PKGBUILD ed installarla da dentro la funzione build(), o si potrebbe dover inserire alcuni comandi sed da dentro la stessa funzione.

Consultare inoltre