Difference between revisions of "Creating packages (Italiano)"

From ArchWiki
Jump to: navigation, search
m (removed useless link, a redir to the same page.)
Line 1: Line 1:
 +
[[Category:About Arch (English)]]
 +
[[Category:Package development (English)]]
 +
[[Category:Guidelines (English)]]
 +
{{i18n|Creating Packages}}
 +
{{Article summary start}}
 +
{{Article summary text|A detailed description of the package building process. Covers package creation, testing, and submission to the [[AUR]].}}
 +
{{Article summary heading|Related}}
 +
{{Article summary wiki|Arch Build System}}
 +
{{Article summary wiki|Arch User Repository}}
 +
{{Article summary wiki|Arch Packaging Standards}}
 +
{{Article summary wiki|makepkg}}
 +
{{Article summary wiki|pacman}}
 +
{{Article summary wiki|PKGBUILD}}
 +
{{Article summary wiki|PKGBUILD Tricks}}
 +
{{Article summary wiki|VCS PKGBUILD Guidelines}}
 +
{{Article summary end}}
 +
 +
{{translateme}}
 +
{{note|Questo articolo è in fase di traduzione. Seguite per ora le istruzioni della versione inglese. In calce è presente la vecchia traduzione italiana}}
 +
 +
 +
This article aims to assist users creating their own packages using the Arch Linux "ports-like" build system. It covers creation of a [[PKGBUILD]] – a package build description file sourced by {{Codeline|makepkg}} to create a binary package from source. If already in possession of a {{Filename|PKGBUILD}}, see [[makepkg]].
 +
 +
== Overview ==
 +
 +
Packages in Arch Linux are built using the [[makepkg]] utility and the information stored in a [[PKGBUILD]] file. When {{Codeline|makepkg}} is run, it searches for a {{Filename|PKGBUILD}} in the current directory and follows the instructions therein to either compile or otherwise acquire the required files to be packaged within a package file ({{Filename|pkgname.pkg.tar.xz}}). The resulting package contains binary files and installation instructions; readily installed with [[pacman]].
 +
 +
An Arch package is no more than a tar archive compressed using xz, or 'tarball', which contains:
 +
 +
* The binary files to install
 +
 +
* {{Filename|.PKGINFO}}: contains all the metadata needed by pacman to deal with packages, dependencies, etc.
 +
 +
* {{Filename|.INSTALL}}: an optional file used to execute commands after the install/upgrade/remove stage. (This file is present only if specified in the {{Filename|PKGBUILD}}.)
 +
 +
* {{Filename|.Changelog}}: an optional file kept by the package maintainer documenting the changes of the package. (It is not present in all packages.)
 +
 +
== Preparation ==
 +
 +
===Prerequisite software===
 +
 +
First ensure that the necessary tools are installed. The package group "base-devel" should be sufficient; it includes ''make'' and additional tools needed for compiling from source.
 +
 +
# pacman -S base-devel
 +
 +
One of the key tools for building packages is [[makepkg]] (provided by {{Package Official|pacman}}) which does the following:
 +
#Checks if package dependencies are installed.
 +
#Downloads the source file(s) from the specified server(s).
 +
#Unpacks the source file(s).
 +
#Compiles the software and installs it under a fakeroot environment.
 +
#Strips symbols from binaries and libraries.
 +
#Generates the package meta file which is included with each package.
 +
#Compress the fakeroot environment into a package file.
 +
#Stores the package file in the configured destination directory, which is the present working directory by default.
 +
 +
=== Download and test the installation ===
 +
 +
Download the source tarball of the software you want to package, extract it, and follow the author's steps to install the program.  Make a note of all commands and/or steps needed to compile and install it. You will be repeating those same commands in the ''PKGBUILD'' file.
 +
 +
Most software authors stick to the 3-step build cycle:
 +
 +
./configure
 +
make
 +
make install
 +
 +
This is a good time to make sure the program is working correctly.
 +
 +
== Creating a PKGBUILD ==
 +
 +
When you run {{Codeline|makepkg}}, it will look for a {{Filename|PKGBUILD}} file in the present working directory. If a {{Filename|PKGBUILD}} file is found it will download the software's source code and compile it according to the instructions specified in the {{Filename|PKGBUILD}} file. The instructions must be fully interpretable by the [[Wikipedia:Bash|Bash]] shell. After successful completion, the resulting binaries and metadata of the package, i.e.  package version and dependencies, are packed in a {{Filename|pkgname.pkg.tar.xz}} package file that can be installed with {{Codeline|pacman -U [package file]}}.
 +
 +
To begin with a new package, you should first create an empty working directory, (preferably {{Filename|~/abs/'''pkgname'''}}), change into that directory, and create a {{Filename|PKGBUILD}} file.  You can either copy the prototype PKGBUILD {{Filename|/usr/share/pacman/PKGBUILD.proto}} to your working directory or copy a {{Filename|PKGBUILD}} from a similar package. The latter may be useful if you only need to change a few options.
 +
 +
=== Defining PKGBUILD variables ===
 +
 +
The {{Filename|PKGBUILD}} file contains metadata about a package. It is a plain text file. The following is a prototype {{Filename|PKGBUILD}}.  It can be found in {{Filename|/usr/share/pacman}} along with other templates.
 +
 +
{{File
 +
|name=/usr/share/pacman/PKGBUILD.proto
 +
|content=<nowiki>
 +
# This is an example PKGBUILD file. Use this as a start to creating your own,
 +
# and remove these comments. For more information, see 'man PKGBUILD'.
 +
# NOTE: Please fill out the license field for your package! If it is unknown,
 +
# then please put 'unknown'.
 +
 +
# Contributor: Your Name <youremail@domain.com>
 +
pkgname=NAME
 +
pkgver=VERSION
 +
pkgrel=1
 +
pkgdesc=""
 +
arch=()
 +
url=""
 +
license=('GPL')
 +
groups=()
 +
depends=()
 +
makedepends=()
 +
optdepends=()
 +
provides=()
 +
conflicts=()
 +
replaces=()
 +
backup=()
 +
options=()
 +
install=
 +
source=($pkgname-$pkgver.tar.gz)
 +
noextract=()
 +
md5sums=() #generate with 'makepkg -g'
 +
 +
build() {
 +
  cd "$srcdir/$pkgname-$pkgver"
 +
 +
  ./configure --prefix=/usr                                                             
 +
  make || return 1                                                                       
 +
  make DESTDIR="$pkgdir/" install
 +
}
 +
</nowiki>}}
 +
 +
An explanation of possible {{Filename|PKGBUILD}} variables can be found in the [[PKGBUILD]] article.
 +
 +
=== The {{Codeline|build()}} function ===
 +
 +
Now you need to implement the {{Codeline|build()}} function in the {{Filename|PKGBUILD}} file.  This function uses common shell commands in [http://en.wikipedia.org/wiki/Bash Bash] syntax to automatically compile software and create a {{Filename|pkg}} directory to install the software to.  This allows ''makepkg'' to package files without having to sift through your filesystem.
 +
 +
The first step in the {{Codeline|build()}} function is to change into the directory created by uncompressing the source tarball.  In most common cases the first command will look like this:
 +
 +
cd $srcdir/$pkgname-$pkgver
 +
 +
Now, you need to list the same commands you used when you manually compiled the software.  The {{Codeline|build()}} function in essence automates everything you did by hand and compiles the software in the fakeroot build environment.  If the software you are packaging uses a configure script, it is good practice to use {{Codeline|1=--prefix=/usr}} when building packages for ''pacman''. A lot of software installs files relative to the {{Filename|/usr/local}} directory, which should only be done if you are manually building from source.  All Arch Linux packages should use the {{Filename|/usr}} directory.  As seen in the {{Filename|/usr/share/pacman/PKGBUILD.proto}} file, the next two lines often look like this:
 +
 +
./configure --prefix=/usr
 +
make || return 1
 +
 +
The final step in the {{Codeline|build()}} function is to put the compiled files in a directory where ''makepkg'' can retrieve them to create a package.  This by default is the {{Filename|pkg}} directory - a simple fakeroot environment.  The {{Filename|pkg}} directory replicates the hierarchy of the root file system of the software's installation paths.  If you have to manually place files under the root of your filesystem, you should install them in the {{Filename|pkg}} directory under the same directory structure.  For example, if you want to install a file to {{Filename|/usr/bin}}, it should instead be placed under {{Filename|$pkgdir/usr/bin}}.  Very few install procedures require the user to copy dozens of files manually.  Instead, for most software, calling {{Codeline|make install}} will do so.  The final line should look like the following in order to correctly install the software in the {{Filename|pkg}} directory:
 +
 +
make DESTDIR=$pkgdir install || return 1
 +
 +
{{Note|It is sometimes the case where {{Codeline|DESTDIR}} is not used in the {{Filename|Makefile}}; you may need to use {{Codeline|prefix}} instead. If the package is built with ''autoconf''/''automake'', use {{Codeline|DESTDIR}}; this is what is [http://sources.redhat.com/automake/automake.html#Install documented] in the manuals. If {{Codeline|DESTDIR}} does not work, try building with {{Codeline|1=make prefix="$pkgdir/usr/" install}}. If that does not work, you'll have to look further into the install commands that are executed by "{{Codeline|make <...> install}}".}}
 +
 +
In some odd cases, the software expects to be run from a single directory. In such cases, it is wise to simply copy these to {{Filename|$pkgdir/opt}}.
 +
 +
More often than not, the installation process of the software will create any subdirectories below the {{Filename|pkg}} directory. If it does not, however, ''makepkg'' will generate a lot of errors and you will need to manually create subdirectories by adding the appropriate {{Codeline|mkdir -p}} commands in the {{Codeline|build()}} function before the installation procedure is run.
 +
 +
Also, ''makepkg'' defines three variables that you should use as part of the build and install process:
 +
; {{Codeline|startdir}}: This contains the absolute path to the directory where the {{Filename|PKGBUILD}} file is located. This variable used to be used in combination with {{Filename|/src}} or {{Filename|/pkg}} postfixes, but the use of {{Codeline|srcdir}} and {{Codeline|pkgdir}} variables is the modern method. {{Codeline|$startdir/src}} is '''not''' guaranteed to be the same as {{Codeline|$srcdir}}, and likewise for {{Codeline|$pkgdir}}. Use of this variable is deprecated and strongly discouraged.
 +
; {{Codeline|srcdir}}: This points to the directory where ''makepkg'' extracts or copies all source files.
 +
; {{Codeline|pkgdir}}: This points to the directory where ''makepkg'' bundles the installed package, which becomes the root directory of your built package.
 +
 +
{{Note|''makepkg'', and thus the {{Codeline|build()}} function, is intended to be non-interactive.  Interactive utilities or scripts called in the {{Codeline|build()}} function may break ''makepkg'', particularly if it is invoked with build-logging enabled ({{Codeline|-l}}). (See [http://bugs.archlinux.org/task/13214 Arch Linux Bug #13214].)}}
 +
 +
=== Additional guidelines ===
 +
 +
Please read [[Arch Packaging Standards]] thoroughly for best practices and additional considerations.
 +
 +
== Testing the PKGBUILD and package ==
 +
 +
As you are writing the {{Codeline|build()}} function, you will want to test your changes frequently to ensure there are no bugs. You can do this using the {{Codeline|makepkg}} command in the directory containing the {{Filename|PKGBUILD}} file. With a properly formatted {{Filename|PKGBUILD}}, makepkg will create a package; with a broken or unfinished {{Filename|PKGBUILD}}, it will raise an error.
 +
 +
If makepkg finishes successfully, it will place a file named {{Filename|pkgname-pkgver.pkg.tar.xz}} in your working directory. This package can be installed with the {{Codeline|pacman -U}} command. However, just because a package file was built does not imply that it is fully functional. It might conceivably contain only the directory and no files whatsoever if, for example, a prefix was specified improperly. You can use pacman's query functions to display a list of files contained in the package and the dependencies it requires with {{Codeline|pacman -Qlp [package file]}} and {{Codeline|pacman -Qip [package file]}} respectively.
 +
 +
If the package looks sane, then you are done! However, if you plan on releasing the {{Filename|PKGBUILD}} file, it is imperative that you check and double-check the contents of the {{Codeline|depends}} array.
 +
 +
Also ensure that the package binaries actually ''run'' flawlessly! It is annoying to release a package that contains all necessary files, but crashes 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.
 +
 +
=== {{Codeline|ldd}} and {{Codeline|namcap}} ===
 +
 +
Dependencies are the most common packaging error. There are two excellent tools you can use to check dependencies. The first one is ''ldd'', which will show you the shared library dependencies of dynamic executables:
 +
$ ldd gcc
 +
linux-gate.so.1 =>  (0xb7f33000)
 +
libc.so.6 => /lib/libc.so.6 (0xb7de0000)
 +
/lib/ld-linux.so.2 (0xb7f34000)
 +
 +
The other tool is [[namcap]], which not only checks for dependencies but the overall sanity of your package. Please read the [[namcap]] article for a detailed description.
 +
 +
== Submitting packages to the AUR ==
 +
 +
Please read [[AUR User Guidelines#Submitting Packages to UNSUPPORTED]] for a detailed description of the submission process.
 +
 +
== Summary ==
 +
 +
#Download the source tarball of the software you want to package.
 +
#Try compiling the package and installing it into an arbitrary directory.
 +
#Copy over the prototype {{Filename|/usr/share/pacman/PKGBUILD.proto}} and rename it to {{Filename|PKGBUILD}} in a temporary working directory -- preferably {{Filename|~/abs/}}.
 +
#Edit the {{Filename|PKGBUILD}} according to the needs of your package.
 +
#Run {{Codeline|makepkg}} and see whether the resulting package is built correctly.
 +
#If not, repeat the last two steps.
 +
 +
=== 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 "{{Codeline|./configure}}; {{Codeline|make}}; {{Codeline|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 {{Codeline|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 {{Codeline|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, {{Codeline|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 {{Filename|PKGBUILD}} and install it from inside the {{Codeline|build()}} function, or you might have to issue some {{Codeline|sed}} commands from inside the {{Codeline|build()}} function.
 +
 +
 +
 +
 +
 +
 +
 +
 
[[Category:Development (Italiano)]]
 
[[Category:Development (Italiano)]]
 
[[Category:HOWTOs (Italiano)]]
 
[[Category:HOWTOs (Italiano)]]

Revision as of 16:39, 1 June 2010

This template has only maintenance purposes. For linking to local translations please use interlanguage links, see Help:i18n#Interlanguage links.


Local languages: Català – Dansk – English – Español – Esperanto – Hrvatski – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Norsk Bokmål – Polski – Português – Slovenský – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – العربية – ไทย – 日本語 – 正體中文 – 简体中文 – 한국어


External languages (all articles in these languages should be moved to the external wiki): Deutsch – Français – Română – Suomi – Svenska – Tiếng Việt – Türkçe – فارسی

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 wiki Template:Article summary end

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)#)
Note: Questo articolo è in fase di traduzione. Seguite per ora le istruzioni della versione inglese. In calce è presente la vecchia traduzione italiana


This article aims to assist users creating their own packages using the Arch Linux "ports-like" build system. It covers creation of a PKGBUILD – a package build description file sourced by Template:Codeline to create a binary package from source. If already in possession of a Template:Filename, see makepkg.

Overview

Packages in Arch Linux are built using the makepkg utility and the information stored in a PKGBUILD file. When Template:Codeline is run, it searches for a Template:Filename in the current directory and follows the instructions therein to either compile or otherwise acquire the required files to be packaged within a package file (Template:Filename). The resulting package contains binary files and installation instructions; readily installed with pacman.

An Arch package is no more than a tar archive compressed using xz, or 'tarball', which contains:

  • The binary files to install
  • Template:Filename: contains all the metadata needed by pacman to deal with packages, dependencies, etc.
  • Template:Filename: an optional file kept by the package maintainer documenting the changes of the package. (It is not present in all packages.)

Preparation

Prerequisite software

First ensure that the necessary tools are installed. The package group "base-devel" should be sufficient; it includes make and additional tools needed for compiling from source.

# pacman -S base-devel

One of the key tools for building packages is makepkg (provided by Template:Package Official) which does the following:

  1. Checks if package dependencies are installed.
  2. Downloads the source file(s) from the specified server(s).
  3. Unpacks the source file(s).
  4. Compiles the software and installs it under a fakeroot environment.
  5. Strips symbols from binaries and libraries.
  6. Generates the package meta file which is included with each package.
  7. Compress the fakeroot environment into a package file.
  8. Stores the package file in the configured destination directory, which is the present working directory by default.

Download and test the installation

Download the source tarball of the software you want to package, extract it, and follow the author's steps to install the program. Make a note of all commands and/or steps needed to compile and install it. You will be repeating those same commands in the PKGBUILD file.

Most software authors stick to the 3-step build cycle:

./configure
make
make install

This is a good time to make sure the program is working correctly.

Creating a PKGBUILD

When you run Template:Codeline, it will look for a Template:Filename file in the present working directory. If a Template:Filename file is found it will download the software's source code and compile it according to the instructions specified in the Template:Filename file. The instructions must be fully interpretable by the Bash shell. After successful completion, the resulting binaries and metadata of the package, i.e. package version and dependencies, are packed in a Template:Filename package file that can be installed with Template:Codeline.

To begin with a new package, you should first create an empty working directory, (preferably Template:Filename), change into that directory, and create a Template:Filename file. You can either copy the prototype PKGBUILD Template:Filename to your working directory or copy a Template:Filename from a similar package. The latter may be useful if you only need to change a few options.

Defining PKGBUILD variables

The Template:Filename file contains metadata about a package. It is a plain text file. The following is a prototype Template:Filename. It can be found in Template:Filename along with other templates.

Template:File

An explanation of possible Template:Filename variables can be found in the PKGBUILD article.

The Template:Codeline function

Now you need to implement the Template:Codeline function in the Template:Filename file. This function uses common shell commands in Bash syntax to automatically compile software and create a Template:Filename directory to install the software to. This allows makepkg to package files without having to sift through your filesystem.

The first step in the Template:Codeline function is to change into the directory created by uncompressing the source tarball. In most common cases the first command will look like this:

cd $srcdir/$pkgname-$pkgver

Now, you need to list the same commands you used when you manually compiled the software. The Template:Codeline function in essence automates everything you did by hand and compiles the software in the fakeroot build environment. If the software you are packaging uses a configure script, it is good practice to use Template:Codeline when building packages for pacman. A lot of software installs files relative to the Template:Filename directory, which should only be done if you are manually building from source. All Arch Linux packages should use the Template:Filename directory. As seen in the Template:Filename file, the next two lines often look like this:

./configure --prefix=/usr
make || return 1

The final step in the Template:Codeline function is to put the compiled files in a directory where makepkg can retrieve them to create a package. This by default is the Template:Filename directory - a simple fakeroot environment. The Template:Filename directory replicates the hierarchy of the root file system of the software's installation paths. If you have to manually place files under the root of your filesystem, you should install them in the Template:Filename directory under the same directory structure. For example, if you want to install a file to Template:Filename, it should instead be placed under Template:Filename. Very few install procedures require the user to copy dozens of files manually. Instead, for most software, calling Template:Codeline will do so. The final line should look like the following in order to correctly install the software in the Template:Filename directory:

make DESTDIR=$pkgdir install || return 1
Note: It is sometimes the case where Template:Codeline is not used in the Template:Filename; you may need to use Template:Codeline instead. If the package is built with autoconf/automake, use Template:Codeline; this is what is documented in the manuals. If Template:Codeline does not work, try building with Template:Codeline. If that does not work, you'll have to look further into the install commands that are executed by "Template:Codeline".

In some odd cases, the software expects to be run from a single directory. In such cases, it is wise to simply copy these to Template:Filename.

More often than not, the installation process of the software will create any subdirectories below the Template:Filename directory. If it does not, however, makepkg will generate a lot of errors and you will need to manually create subdirectories by adding the appropriate Template:Codeline commands in the Template:Codeline function before the installation procedure is run.

Also, makepkg defines three variables that you should use as part of the build and install process:

Template:Codeline
This contains the absolute path to the directory where the Template:Filename file is located. This variable used to be used in combination with Template:Filename or Template:Filename postfixes, but the use of Template:Codeline and Template:Codeline variables is the modern method. Template:Codeline is not guaranteed to be the same as Template:Codeline, and likewise for Template:Codeline. Use of this variable is deprecated and strongly discouraged.
Template:Codeline
This points to the directory where makepkg extracts or copies all source files.
Template:Codeline
This points to the directory where makepkg bundles the installed package, which becomes the root directory of your built package.
Note: makepkg, and thus the Template:Codeline function, is intended to be non-interactive. Interactive utilities or scripts called in the Template:Codeline function may break makepkg, particularly if it is invoked with build-logging enabled (Template:Codeline). (See Arch Linux Bug #13214.)

Additional guidelines

Please read Arch Packaging Standards thoroughly for best practices and additional considerations.

Testing the PKGBUILD and package

As you are writing the Template:Codeline function, you will want to test your changes frequently to ensure there are no bugs. You can do this using the Template:Codeline command in the directory containing the Template:Filename file. With a properly formatted Template:Filename, makepkg will create a package; with a broken or unfinished Template:Filename, it will raise an error.

If makepkg finishes successfully, it will place a file named Template:Filename in your working directory. This package can be installed with the Template:Codeline command. However, just because a package file was built does not imply that it is fully functional. It might conceivably contain only the directory and no files whatsoever if, for example, a prefix was specified improperly. You can use pacman's query functions to display a list of files contained in the package and the dependencies it requires with Template:Codeline and Template:Codeline respectively.

If the package looks sane, then you are done! However, if you plan on releasing the Template:Filename file, it is imperative that you check and double-check the contents of the Template:Codeline array.

Also ensure that the package binaries actually run flawlessly! It is annoying to release a package that contains all necessary files, but crashes 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.

Template:Codeline and Template:Codeline

Dependencies are the most common packaging error. There are two excellent tools you can use to check dependencies. The first one is ldd, which will show you the shared library dependencies of dynamic executables:

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

The other tool is namcap, which not only checks for dependencies but the overall sanity of your package. Please read the namcap article for a detailed description.

Submitting packages to the AUR

Please read AUR User Guidelines#Submitting Packages to UNSUPPORTED for a detailed description of the submission process.

Summary

  1. Download the source tarball of the software you want to package.
  2. Try compiling the package and installing it into an arbitrary directory.
  3. Copy over the prototype Template:Filename and rename it to Template:Filename in a temporary working directory -- preferably Template:Filename.
  4. Edit the Template:Filename according to the needs of your package.
  5. Run Template:Codeline and see whether the resulting package is built correctly.
  6. If not, repeat the last two steps.

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 "Template:Codeline; Template:Codeline; Template:Codeline", 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 Template:Codeline 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 Template:Codeline 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, Template:Codeline 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 Template:Filename and install it from inside the Template:Codeline function, or you might have to issue some Template:Codeline commands from inside the Template:Codeline function.

This template has only maintenance purposes. For linking to local translations please use interlanguage links, see Help:i18n#Interlanguage links.


Local languages: Català – Dansk – English – Español – Esperanto – Hrvatski – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Norsk Bokmål – Polski – Português – Slovenský – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – العربية – ไทย – 日本語 – 正體中文 – 简体中文 – 한국어


External languages (all articles in these languages should be moved to the external wiki): Deutsch – Français – Română – Suomi – Svenska – Tiếng Việt – Türkçe – فارسی

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). Per iniziare con un nuovo pacchetto, si deve prima di tutto creare una directory vuota, preferibilmente di nome /var/abs/local/<nome pacchetto>. 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 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 aprire tale file 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. 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')
  • 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....
  • url: Qui dovrebbe essere inserito l'indirizzo del sito ufficiale del programma, dove chi è interessato possa trovare maggiori informazioni.
  • 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 $arch durante la compilazione.
  • 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; 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: depends=('glibc' 'slang>=1.8.0')
  • 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: unarj, usato in una compilazione per decomprimere alcune patch.
  • 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: optdepends=('fakeroot: for makepkg usage as normal user')
  • 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, questa indicazione 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 doppi apici (virgolette). Il prototipo di PKGBUILD 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 PKGBUILD e aggiungere il nome del file al presente 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à 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é makepkg 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 makepkg -g, eseguito nella directory che contiene il PKGBUILD. Il comando makepkg -g >> PKGBUILD genererà invece 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 dalla decompressione dei file sorgenti. Per fare ciò si può usare la variabile "$startdir" (le virgolette evitano grattacapi nel caso il nome della directory contenga spazi), che si riferisce alla directory contenente il PKGBUILD. 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 cd "${srcdir}/$pkgname-$pkgver", 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 "${pkgver//_/-}" invece di $pkgver, 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.

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 provocati 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. 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 pkg sotto la stessa struttura di directory (per esempio se si vuole installare il file myprog in /usr/bin, dovrebbe essere messo in ${pkgdir}/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 ${pkgdir}/ ! 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 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=${pkgdir}/usr in tale configurazione. E' necessario accertare che questa sia la directory corretta, in quanto a volte la directory decompressa potrebbe avere un nome differente:
tar -xf foo-0.99.tar.gz

ed 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 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 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 copiare questa in ${pkgdir}/opt.

Come si può capire, questa è la parte dove l'effettiva conoscenza e l'esperienza diventano necessità. Aiuta molto osservare i file PKGBUILD nell'albero di 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, dentro la directory pkg/, 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 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 ${pkgdir}/ALTRE/DIRECTORY/NECESSARIE, dove ALTRE/DIRECTORY/NECESSARIE rappresentano le directory nel filesystem root.

Il file .install: per azioni durante l'installazione

Se sono necessari delle operazioni dopo l'installazione per il funzionamento, o per messaggi in output all'utente, si dovrà usare un file .install.

Specificare il file .install includendo la riga seguente nel proprio PKGBUILD:

install=${pkgname}.install

Quindi, creare un file (pkgname).install. Un prototipo di .install è presente in /usr/share/pacman/proto.install per un aiuto per l'inizio:

 # This is a default template for a post-install scriptlet.
 # Uncomment only required functions and remove any functions
 # you don't need (and this header).
 ## arg 1:  the new package version
 #pre_install() {
   # do something here
 #}
 ## arg 1:  the new package version
 #post_install() {
   # do something here
 #}
 ## arg 1:  the new package version
 ## arg 2:  the old package version
 #pre_upgrade() {
   # do something here
 #}
 ## arg 1:  the new package version
 ## arg 2:  the old package version
 #post_upgrade() {
   # do something here
 #}
 ## arg 1:  the old package version
 #pre_remove() {
   # do something here
 #}
 ## arg 1:  the old package version
 #post_remove() {
   # do something here
 #}
 # vim:set ts=2 sw=2 et:

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 di makepkg è 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 pacman -U e pacman -A, 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 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 confrontarle 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 anche 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.

Esistono alcuni strumenti che si possono usare per controllare le dipendenze, compreso il famoso programma di Jason Chu namcap (pacman -S namcap) e il più antico ldd. 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

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

Link utili

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. 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 brutti, 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.