Difference between revisions of "Creating packages (Italiano)"

From ArchWiki
Jump to: navigation, search
Line 102: Line 102:
 
==Testare il PKGBUILD==
 
==Testare il PKGBUILD==
  
As you are writing the <code>PKGBUILD</code>'s <code>build()</code> function, you will want to test your changes frequently to ensure there are no bugs. You can do this using the <code>makepkg</code> command in the directory containing the <code>PKGBUILD</code>. With a properly formatted <code>PKGBUILD</code>, this will create a package, but with a broken or unfinished one it will throw an error. Hopefully it will be a descriptive error!
+
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!
  
If running <code>makepkg</code> finished successfully, it will place a shiny new file called $pkgname-$pkgver.pkg.tar.gz in your working directory. This is a pacman package and can be installed with the <code>pacman -U</code> and <code>pacman -A</code> options, or added to a local or web based repository.  Note that just because a package file was built it doesn't mean it works!  It might conceivably contain only the directory structure and no files whatsoever if, for example, you specified a prefix improperly. You can use pacman's query functions to display a list of files contained in the package and the dependencies it requires, and compare those with what you consider as correct. "pacman -Qlp <package file>" and "pacman -Qip <package file>" do the trick.
+
Se il processo <code>makepkg</code> è finito correttamente, metterà un file nuovo 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>, o aggiunto a un repository locale o sul webNotare 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 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, per confrontare con quelle considerate corrette. Si occupano di ciò "pacman -Qlp <nome pacchetto>" e "pacman -Qip <nome pacchetto>".
  
If the package looks sane, that's all you need to do. However, if you plan on releasing the package or PKGBUILD, it is imperative that you check and double check and re-double-check the contents of the depends array. This should contain a list of all packages that need to be installed in order for your package to work. You only need to list first level depends in the depends array. That is, you do not need to list packages that your program depends on if other packages that your program depends on are already listed.
+
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 altri pacchetti già elencati.
  
For example, <code>gtk2</code> depends on <code>glib2</code>. Like most open source C programs, it also requires <code>glibc</code> to be installed. However, <code>glibc</code> does not need to be listed as a dependency for <code>gtk2</code> because it is a dependency for <code>glib2</code>, and <code>glib2</code> is already listed in <code>gtk2</code>.
+
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>.
  
 
There are some tools you can use to check dependencies, including Jason Chu's famous <code>namcap</code> program (<code>pacman -Sy namcap</code>), and the more arcane <code>ldd</code> program.  Check the man pages for these programs and the links at the end of this document for more information.  You should also scour the program's documentation and website (some nice developers have a page called "dependencies" that helps a lot).
 
There are some tools you can use to check dependencies, including Jason Chu's famous <code>namcap</code> program (<code>pacman -Sy namcap</code>), and the more arcane <code>ldd</code> program.  Check the man pages for these programs and the links at the end of this document for more information.  You should also scour the program's documentation and website (some nice developers have a page called "dependencies" that helps a lot).

Revision as of 16:00, 22 May 2008

Tango-preferences-desktop-locale.pngThis article or section needs to be translated.Tango-preferences-desktop-locale.png

Notes: please use the first argument of the template to provide more detailed indications. (Discuss in Talk:Creating packages (Italiano)#)
Template:I18n links start

Template:I18n entry Template:I18n entry Template:I18n entry Template:I18n entry Template:I18n links end

Il documento 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.

Preparazione dei file

Tutte le informazioni per creare un pacchetto sono situate in un file PKGBUILD. Quando si lancia makepkg, esso cercherà un file PKGBUILD nella directory in cui ci si trova e compilerà i sorgenti del software secondo le istruzioni contenute nel file PKGBUILD. 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 nome.pkg.tar.gz che può essere installato con il comando pacman -Up <nome pacchetto>.

Il file PKGBUILD 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). Le variabili qui usate sono descritte nell'articolo ABS, ma le più importanti e quelle che creano più confusione sono comunque ricapitolate qui. Per iniziare con un nuovo pacchetto, si deve prima di tutto creare una directory vuota, preferibilmente di nome /var/abs/local/<PKGNAME>. In questo modo è naturalmente integrata nell'ABS-tree, ma non toccata dal cvsup quando si sincronizzi l'albero. Si deve quindi entrare in questa directory e creare un file PKGBUILD su cui lavorare, copiando il prototipo d'esempio da /usr/share/pacman/PKGBUILD.proto alla directory di lavoro, o copiando il PKGBUILD 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.

Comunque si decida di procedere, si ha bisogno di un file PKGBUILD su cui lavorare.

Modificare le variabili

Ora bisogna aprirlo ed impostare i valori di ogni variabile secondo il pacchetto che si sta costruendo:

  • pkgname: Impostarla con un nome per il pacchetto. Convenzione vuole che si usino tutte lettere minuscole per il nome del pacchetto. La scelta è arbitraria, ma è d'aiuto avere il nome di un pacchetto uguale al nome della directory in cui ci si trova ed anche 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.date, ecc..) che usa il programma che si sta impacchettando. Di nuovo, nella maggior parte dei casi bisognerebbe attenersi alla versione che è parte 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')
  • 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 pkgrel di modo che pacman sappia che il pacchetto dev'essere reinstallato. Quando viene rilasciata una nuova versione del pacchetto, si reimposti la variabile pkgrel a 1.
  • pkgdesc: Qui si dovrebbe inserire una breve (normalmente, meno di 76 caratteri) descrizione del pacchetto. Di solito non è necessario usare il nome del programma. Server X accelerato con OpenGL è meglio di xgl è un server X....
  • arch: Questa dovrebbe contenere un array delle architetture, normalmente 'i686', sulle quali il file PKGBUILD può essere usato. Si può accedere a questo valore con la variabile $arch durante la compilazione.
  • url: Qui dovrebbe essere inserito l'indirizzo del sito ufficiale del programma, dove chi è interessato possa trovare maggiori informazioni.
  • license: Il tipo di licenza, se non la si conosce scrivere 'unknown'.
  • 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 e 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" ed racchiudere l'intero costrutto tra virgolette. Di seguito un esempio per aggiungere una dipendenza dal pacchetto glibc e dalla libreria slang, versione minima 1.8.0: depends=('glibc' 'slang>=1.8.0')
  • makedepends: Questa dovrebbe contenere un array di nomi di pacchetti necessari solo durante la compilazione, ma non necessarie per *usare* il pacchetto dopo l'installazione. Esempio: unarj, usato in una compilazione per decomprimere alcune patch.
  • 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.
    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: provides=('qt=3.3.8'). Scrivere provides=('qt') provocherà un fallimento delle dipendenze che richiedono una versione specifica di 'qt'. Ad ogni modo, se nessun pacchetto richiedeva una versione specifica di qt, sarebbe sufficiente.
    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: provides=('perl-foo=5.2.1' 'perl-bar=2.5').
  • 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.
  • replaces: Questa dovrebbe essere un array di nomi di pacchetti obsoleti che sono rimpiazzati da quello descritto.
  • 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 virgolette (doppi apici). Il prototipo di PKGBUILD mostra come si possono effettivamente usare le variabili precedentemente impostate per nome del pacchetto e versione in questa variabile. Se si scopre di aver bisogno di fornire file non scaricabili "al volo", ad esempio patch create personalmente, mettere semplicemente quei file nella stessa directory dove si trova il PKGBUILD e aggiungere il nome del file a questo array source. Qualunque percorso (path) sia aggiunto qui è risolto relativamente alla directory dove si trova il PKGBUILD. Prima dell'effettivo inizio del processo di compilazione, tutti i file indicati qui sono scaricati o ne è verificata l'esistenza e makepkg non procederà se ne manca qualcuno.
  • 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à comparato con i valori di questo array, 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 dei md5sum, poiché makepkg non indovinerà quale md5sum appartenga a ciascun file sorgente e inizierà a restituire errori se non corrispondono, per prevenire errori in download e manipolazioni. Si può generare l'array md5sums rapidamente e facilmente con il comando makepkg -g (dopo che l'array source è stato propriamente costruito) nella directory che contiene il PKGBUILD. makepkg -g >>PKGBUILD genererà le stringhe md5 e le aggiungerà alla fine del PKGBUILD, da dove si potranno spostare le righe nella corretta posizione del file.

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.

Usare i sorgenti

Ora si devono scaricare i tarball sorgenti, estrarli ed annotare tutti i comandi necessari a compilarli ed installarli. I contenuti della funzione build() nel proprio PKGBUILD 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 build() nel PKGBUILD. Questa funzione usa comuni comandi shell in sintassi bash. L'obiettivo basilare di questa funzione è di compilare automaticamente i programmi e creare una directory pkg dove installare il programma, permettendo a makepkg di impacchettare tutto facilmente senza dover prelevare tutti file interessati dal proprio filesystem.

La funzione build()

Normalmente il primo passo nella funzione build è entrare in una delle directory create con la decompressione dei file sorgenti. Per fare ciò si può usare la variabile $startdir (si riferisce alla directory che contiene il PKGBUILD). E' anche possibile usare le variabili $pkgname e $pkgver impostate precedentemente. Per esempio, secondo il nome della directory decompressa da makepkg, il primo comando nella propria funzione build potrebbe essere cd $startdir/src/$pkgname-$pkgver, che è un caso molto comune a meno che l'autore del programma sia una persona molto, molto malvagia.

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.

Ora che ci si trova nella sopraddetta directory, bisogna trascrivere qualunque comando necessario a compilare i file. Nei casi semplici, può bastare usare ./configure; make, anche se esistono decine di variazioni, compreso ant build o ricavare gli effettivi comandi gcc per compilare i pacchetti.

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 /usr/local, ma Arch Linux preferisce usare solo /usr, probabilmente si vorrà aggiungere un parametro allo script configure o al comando make per occuparsene. Il prototipo di PKGBUILD serve da esempio per questo. Potrebbe doversi risolvere diversamente, comunque: di nuovo, non ci sono procedimenti uniformi per tutto.

  • E' buona pratica usare --prefix=/usr/local solo quando si compilano i sorgenti manualmente, compresi quelli compilati con ABS/makepkg, e riservare /usr per i pacchetti gestiti da pacman - questo risparmierà dei mal di testa da pacchetti conflittuali.

Il passo seguente nella funzione build() è di mettere i file compilati in un posto dove makepkg li possa raccogliere per creare un pacchetto. Questo luogo è la directory pkg. Questa dovrebbe imitare la directory root del proprio filesystem per la procedura di installazione del programma. Qualunque file debba essere installato in una directory nella root del proprio filesystem, dovrebbe andare nella directory pkg sotto la stessa struttura di directory (per esempio se si vuole installare il file myprog in /usr/bin, dovrebbe essere messo in $startdir/pkg/usr/bin). 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 $startdir/pkg/ ! Altrimenti si terminerà con un file di pacchetto vuoto e i binari del programma, "correttamente" installato, già inseriti nel proprio sistema. Il più delle volte si dovrà aggiungere il parametro prefix alla chiamata "make install" come mostrato nel prototipo, ma è altresì possibile che il programma che si sta impacchettando richieda un approccio completamente differente. Di seguito, allora, alcuni suggerimenti:

  • A volte lo script configure accetta una proprietà prefix che comunica dove dovrebbero essere installati i file. Si potrebbe, per esempio, usare ./configure --prefix=$startdir/pkg/usr in tale configurazione. E' necessario accertare che questa sia la directory corretta, in quanto a volte la directory decompressa potrebbe essere nominata diversamente:
tar -xf foo-0.99.tar.gz

ed un ls potrebbe restituire:

  .
  ..
  foo-0.99.tar.gz
  foo/

e non:

  .
  ..
  foo-0.99.tar.gz
  foo-0.99/
  • A volte c'è un'opzione PREFIX da aggiungere al comando make install. Questa è impostata talvolta come una variabile, talvolta nel comando. Nei casi peggiori è necessario modificare il/i Makefile (oppure i file di compilazione o proprietà di ant, se il progetto sfrutta ant) con sed o con una patch da crearsi.
  • Ci potrebbero essere altri tipi di script d'installazione che permettono di specificare dove installare il programma.
  • In alcuni casi, il programma si attende di essere lanciato da una singola directory. E' spesso saggio copiarla in $startdir/pkg/opt.

Come si può capire, questa è la parte dove l'effettiva conoscenza ed esperienza diventa necessità. Aiuta molto osservare i file PKGBUILD nell'albero ABS, poichè questi sono testati e contengono qualche trucco che potrebbe risultare utile.

Spesso, inoltre, il processo di installazione del programma avrà cura di creare qualunque sottodirectory dentro la directory pkg/. 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 mkdir nella funzione build() 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 /etc o in /usr, mentre altri potrebbero dover usare /bin oppure /opt. La maggior parte dovrà creare parecchie directory. Si può fare tutto ciò con il comando mkdir -p $startdir/pkg/ALTRE/DIRECTORY/NECESSARIE, dove ALTRE/DIRECTORY/NECESSARIE rappresenta le directory nel filesystem root.

Testare il PKGBUILD

Mentre si scrive la funzione build() del PKGBUILD, 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, questo creerà un pacchetto; ma con uno errato o non finito, restituirà un errore. Con un po' di fortuna sarà un errore descrittivo!

Se il processo makepkg è finito correttamente, metterà un file nuovo chiamato $pkgname-$pkgver.pkg.tar.gz nella directory attuale. Questo è un pacchetto di pacman e può essere installato con le opzioni pacman -U e pacman -A, o aggiunto a 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 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, per confrontare con quelle considerate corrette. Si occupano di ciò "pacman -Qlp <nome pacchetto>" e "pacman -Qip <nome pacchetto>".

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 altri pacchetti già elencati.

Per esempio, gtk2 dipende da glib2. Come molti programmi open source scritti in C, richiede anche che sia installato glibc. Comunque, glibc non ha bisogno di essere elencato come dipendenza per gtk2, perché è una dipendenza di glib2, e glib2 è già elencato nelle dipendenze di gtk2.

There are some tools you can use to check dependencies, including Jason Chu's famous namcap program (pacman -Sy namcap), and the more arcane ldd program. Check the man pages for these programs and the links at the end of this document for more information. You should also scour the program's documentation and website (some nice developers have a page called "dependencies" that helps a lot).

Testing the package

Also make sure that the package binaries actually run flawlessly! It's really annoying to release a package that contains all necessary files, but dumps core because of some obscure configuration option that doesn't quite work well with the rest of the system. If you're only going to compile packages for your own system, though, you don't need to worry too much about this quality assurance step, as you're the only person suffering from mistakes after all.

To sum it all up

  • Download the source tarball of the program you want to package up
  • Try compiling the package and installing it into an arbitrary directory
  • Copy over the prototype /usr/share/pacman/PKGBUILD.proto and rename it to PKGBUILD in a temporary working directory
  • Edit the PKGBUILD according to the needs of your package
  • Run makepkg and see whether the resulting package is built correctly
  • If not, repeat the last two steps

Useful links

Warnings

  • Before you can automate the package building process, you should have done it manually at least once unless you know exactly what you're doing in advance, in which case you would not be reading this in the first place. Unfortunately, although a good bunch of program authors stick to the 3-step build cycle of "./configure; make; make install", this is not always the case, and things can get real ugly if you have to apply patches to make everything work at all. Rule of thumb: If you can't get the program to compile from the source tarball, and make it install itself to a defined, temporary subdirectory, you don't even need to try packaging it. There isn't any magic pixie dust in makepkg that makes source problems go away.
  • In a few cases, the packages are not even available as source and you have to use something like sh installer.run to get it to work. You will have to do quite a bit of research (read READMEs, INSTALL instructions, man pages, perhaps ebuilds from gentoo or other package installers, possibly even the MAKEFILEs or source code) to get it working. In some really bad cases, you have to edit the source files to get it to work at all. However, makepkg needs to be completely autonomous, with no user input. Therefore if you need to edit the Makefiles, you may have to bundle a custom patch with the PKGBUILD and install it from inside the build() function, or you might have to issue some sed commands from inside the build() function.
  • Note that just because a package file was built it doesn't mean it works! It might conceivably contain only the directory structure and no files whatsoever if, for example, you specified a prefix improperly. You can use pacman's query functions to display a list of files contained in the package and the dependencies it requires, and compare those with what you consider as correct. "pacman -Qlp <package file>" and "pacman -Qip <package file>" do the trick.