GeezerVison

makepkg is a script to automate the building of packages. The requirements for using the script are a build-capable Unix platform and a PKGBUILD.

makepkg is provided by the pacman package.

The system configuration is available in /etc/makepkg.conf, but user-specific changes can be made in $XDG_CONFIG_HOME/pacman/makepkg.conf or ~/.makepkg.conf. Also, system wide changes can be made with a drop-in file /etc/makepkg.conf.d/makepkg.conf. It is recommended to review the configuration prior to building packages.

See makepkg.conf(5) for more information.

Each package is tagged with metadata identifying amongst others also the packager. By default, user-compiled packages are marked with Unknown Packager. If multiple users will be compiling packages on a system, or if one is otherwise distributing packages to other users, it is convenient to provide real contact. This can be done by setting the PACKAGER variable in makepkg.conf.

To check this on an installed package:

$ pacman -Qi package

...
Packager       : John Doe <[email protected]>
...

To automatically produce signed packages, also set the GPGKEY variable in makepkg.conf.

By default, makepkg creates the package tarballs in the working directory and downloads source data directly to the src/ directory. Custom paths can be configured, for example to keep all built packages in ~/build/packages/ and all sources in ~/build/sources/.

Configure the following makepkg.conf variables if needed:

• PKGDEST — directory for storing resulting packages
• SRCDEST — directory for storing source data (symbolic links will be placed to src/ if it points elsewhere)
• SRCPKGDEST — directory for storing resulting source packages (built with makepkg -S)

You can also use relative paths inside each package directory.

If a signature file in the form of .sig or .asc is part of the PKGBUILD source array, makepkg automatically attempts to verify it. In case the user's keyring does not contain the needed public key for signature verification, makepkg will abort the installation with a message that the PGP key could not be verified.

If a needed public key for a package is missing, the PKGBUILD will most likely contain a validpgpkeys entry with the required key IDs and provide it under the keys/pgp/ subdirectory. Import it manually, or find it on a keyserver and import it from there. To temporarily disable signature checking, run makepkg with the --skippgpcheck option.

Before continuing, install the base-devel meta package. Dependencies of this package are not required to be listed as build-time dependencies (makedepends) in PKGBUILD files.

To build a package, one must first create a PKGBUILD, or build script, as described in Creating packages. Existing scripts are available from the Arch build system (ABS) tree or the AUR. Once in possession of a PKGBUILD, change to the directory where it is saved and run the following command to build the package:

$ makepkg

If required dependencies are missing, makepkg will issue a warning before failing. To build the package and install needed dependencies, add the flag -s/--syncdeps:

$ makepkg --syncdeps

Adding the -r/--rmdeps flag causes makepkg to remove the make dependencies later, which are no longer needed. If constantly building packages, consider using Pacman/Tips and tricks#Removing unused packages (orphans) once in a while instead.

Once all dependencies are satisfied and the package builds successfully, a package file (pkgname-pkgver.pkg.tar.zst) will be created in the working directory. To install, use -i/--install (same as pacman -U pkgname-pkgver.pkg.tar.zst):

$ makepkg --install

To clean up leftover files and directories, such as files extracted to the $srcdir, add the option -c/--clean. This is useful for multiple builds of the same package or updating the package version, while using the same build directory. It prevents obsolete and remnant files from carrying over to the new builds:

$ makepkg --clean

For more, see makepkg(8).

The default options match the options devtools uses to build packages for the official repositories.[4] As such, end users may realize more or less significant gains by tweaking the following options to match their local environment.

A performance improvement of the packaged software can be achieved by enabling compiler optimizations for the host machine. The downside is that binaries compiled for a specific processor architecture will not run correctly on other machines. On x86_64 machines, there are rarely significant enough real world performance gains that would warrant investing the time to rebuild official packages.

However, it is very easy to reduce performance by using "non-standard" compiler flags. Many compiler optimizations are only useful in certain situations and should not be indiscriminately applied to every package. Unless benchmark data are available to prove that something is faster, there is a very good chance it is not! The Gentoo GCC optimization and Safe CFLAGS wiki articles provide more in-depth information about compiler optimization.

The options passed to a C/C++ compiler (e.g. gcc or clang) are controlled by the CFLAGS, CXXFLAGS, and CPPFLAGS environment variables. For use in the Arch build system, makepkg exposes these environment variables as configuration options in makepkg.conf. The default values are configured to produce generic binaries that can be installed on a wide range of machines.

All major compilers can automatically detect and enable safe architecture-specific optimizations. To use this feature, replace any -march and -mtune flags with -march=native. For example:

/etc/makepkg.conf

CFLAGS="-march=native -O2 -pipe ..."
CXXFLAGS="${CFLAGS} ..."

To see what flags this enables, run:

$ gcc -march=native -v -Q --help=target

Further optimization of binaries can be achieved by enabling optimizations that are considered expensive in terms of memory usage and compile time. This can be achieved by changing the optimization level flag from -O2 to -O3. Using this flag will in most cases improve performance of the binary, although this is not guaranteed and in some cases can prove counter-productive. See Gentoo:GCC optimization#-O and GCC optimization options page for details.

Makepkg also includes overrides for the RUSTFLAGS environment variable, but setting additional optimization-related options this way is not recommended as they are applied unconditionally and can break compilation of some crates [6] or cause other misbehavior. A default override of these variables is shipped under /etc/makepkg.conf.d/rust.conf [7].

Rust upstream recommends using Cargo environment variables for the release profile instead. Some notable ones are:

• CARGO_PROFILE_RELEASE_OPT_LEVEL=n controls optimization level. Higher optimization levels may produce faster runtime code at the expense of longer compiler times. The value n can be set from 0 to 3, s, or z. The default value is 3.
• CARGO_PROFILE_RELEASE_LTO=n controls Link Time Optimization. LTO can produce better optimized code, using whole-program analysis, at the cost of longer linking time. The value n can be set to true (alias fat), thin, false and off. The default value is false.
• CARGO_PROFILE_RELEASE_CODEGEN_UNITS=n controls how many "code generation units" a crate will be split into. More code generation units allows more of a crate to be processed in parallel possibly reducing compile time, but may produce slower code. The default value is 16.

See Cargo profile settings for details.

There are some optimizations that can only be done via RUSTFLAGS:

• -C target-cpu=native enables architecture-specific optimizations. Note that applications built with this flag may fail to run on other machines.
• -C link-arg=-z -C link-arg=pack-relative-relocs reduces the size of the binary.

See Rust codegen options for details.

The make build system uses the MAKEFLAGS environment variable to specify additional options for make. The variable can also be set in the makepkg.conf file.

Users with multi-core/multi-processor systems can specify the number of jobs to run simultaneously. This can be accomplished with the use of nproc(1) to determine the number of available processors, e.g. MAKEFLAGS="--jobs=$(nproc)".

Some PKGBUILDs specifically override this with -j1, because of race conditions in certain versions or simply because it is not supported in the first place. Packages that fail to build because of this should be reported on the bug tracker (or in the case of AUR packages, to the package maintainer) after making sure that the error is indeed being caused by MAKEFLAGS.

See make(1) for a complete list of available options.

As compiling requires many I/O operations and handling of small files, moving the working directory to a tmpfs may bring improvements in build times.

The BUILDDIR variable can be temporarily exported to makepkg to set the build directory to an existing tmpfs. For example:

$ BUILDDIR=/tmp/makepkg makepkg

Persistent configuration can be done in makepkg.conf by uncommenting the BUILDDIR option, which is found at the end of the BUILD ENVIRONMENT section in the default /etc/makepkg.conf file. Setting its value to e.g. BUILDDIR=/tmp/makepkg will make use of the Arch's default /tmp temporary file system.

The use of ccache can improve build times by caching the results of compilations for successive use.

mold is a drop-in replacement for ld/lld linkers, which claims to be significantly faster.

To use mold, append -fuse-ld=mold to LDFLAGS. For example:

/etc/makepkg.conf

LDFLAGS="... -fuse-ld=mold"

To pass extra options to mold, additionally add those to LDFLAGS. For example:

/etc/makepkg.conf

LDFLAGS="... -fuse-ld=mold -Wl,--separate-debug-file"

To use mold for Rust packages, append -C link-arg=-fuse-ld=mold to RUSTFLAGS. For example:

/etc/makepkg.conf.d/rust.conf

RUSTFLAGS="... -C link-arg=-fuse-ld=mold"

Makepkg configuration shipped by pacman enables the debug and lto options by default [8].

Building debug packages enables the official repositories to provide more tools to troubleshoot issues for users [9], but it is not required when building packages on your own and slows down the build process [10].

Link-time optimization produces more optimized binaries but greatly lengthens the build process [11], which might not be a desired tradeoff.

To disable those options, add a ! character directly in front of them in the OPTIONS=() array, e.g. OPTIONS=(...!debug !lto...).

To speed up both packaging and installation, with the tradeoff of having larger package archives, change PKGEXT.

For example, the following skips compression of the package file, which will in turn have no need to be decompressed on install:

$ PKGEXT='.pkg.tar' makepkg

As another example, the following uses the LZ4 algorithm, which is focused on speed:

$ PKGEXT='.pkg.tar.lz4' makepkg

To make one of these settings permanent, set PKGEXT in /etc/makepkg.conf.

zstd supports symmetric multiprocessing (SMP) via the -T/--threads flag to speed up compression. The -T0 flag is included by default in the COMPRESSZST array in /etc/makepkg.conf, which lets zstd use as many threads as there are physical CPU cores to compress packages. The number of used threads can be further increased by instructing zstd to base it on the logical CPU count using the --auto-threads=logical flag:

COMPRESSZST=(zstd -c -T0 --auto-threads=logical -)

lz4 and xz are multithreaded by default, so nothing needs to be changed in /etc/makepkg.conf.

pigz is a drop-in, parallel implementation for gzip which by default uses all available CPU cores (the -p/--processes flag can be used to employ less cores):

COMPRESSGZ=(pigz -c -f -n)

pbzip2 is a drop-in, parallel implementation for bzip2 which also uses all available CPU cores by default. The -p# flag can be used to employ less cores (note: no space between the -p and number of cores).

COMPRESSBZ2=(pbzip2 -c -f)

lbzip2 is another drop-in, parallel implementation for bzip2 which also uses all available CPU cores by default. The -n flag can be used to employ less cores.

COMPRESSBZ2=(lbzip2 -c -f)

plzip^AUR is a multithreaded implementation for lzip which also uses all available CPU cores by default. The -n/--threads flag can be used to employ less cores.

COMPRESSLZ=(plzip -c -f)

Several compression algorithms (including zstd and xz) support setting a compression level which defines a tradeoff between speed, memory and compression efficiency.

Make use of SRCDEST, especially when building VCS packages, to save time acquiring and unpacking sources in subsequent rebuilds.

You can use a downloader supporting parallel downloading, e.g. axel:

/etc/makepkg.conf

DLAGENTS=('file::/bin/curl -gqC - -o %o %u'
          'ftp::/bin/axel -n 2 -o %o %u'
          'http::/bin/axel -n 2 -o %o %u'
          'https::/bin/axel -n 2 -o %o %u')

See also Nonfree applications package guidelines#Custom DLAGENTS.

Install pacman-contrib and run the following command in the same directory as the PKGBUILD file to generate new checksums:

$ updpkgsums

updpkgsums uses makepkg --geninteg to generate the checksums. See this forum discussion for more details.

The checksums can also be obtained with e.g sha256sum and added to the sha256sums array by hand.

If you want to make changes to the source code you can download the source code without building the package by using the -o, --nobuild Download and extract files only option.

$ makepkg -o

You can now make changes to the sources and then build the package by using the -e, --noextract Do not extract source files (use existing $srcdir/ dir) option. Use the -f option to overwrite already built and existing packages.

$ makepkg -ef

expac is a pacman database extraction utility. This command shows all packages installed on the system with the packager named packagername:

$ expac "%n %p" | grep "packagername" | column -t

This shows all packages installed on the system with the packager set in the /etc/makepkg variable PACKAGER. This shows only packages that are in a repository defined in /etc/pacman.conf.

$ . /etc/makepkg.conf; grep -xvFf <(pacman -Qqm) <(expac "%n\t%p" | grep "$PACKAGER$" | cut -f1)

See 32-bit package guidelines.

A person may not be available to provide the passphrase for the gpg private key used to sign with in automated build environments such as Jenkins. It is ill-advised to store a private gpg key on a system without a passphrase.

A resulting zst package made with makepkg can still be signed after creation:

$ gpg --detach-sign --pinentry-mode loopback --passphrase --passphrase-fd 0 --output NewlyBuilt.pkg.tar.zst.sig --sign NewlyBuilt.pkg.tar.zst 

where the GPG passphrase is securely provided and obscured by your automation suite of choice.

The resulting zst and sig file can be referenced by pacman clients expecting a valid signature and repositories created with repo-add --sign when hosting your own repo.

Support for magnet URIs resources (with magnet:// prefix) in the source field can be added using the transmission-dlagent^AUR download agent.

If the package you are building takes too many resources to build with your default make flags, which are otherwise set properly for most packages, you can try running it in its own control group. makepkg-cg^AUR is a wrapper for makepkg that achieved this via systemd control groups (see systemd.resource-control(5)).

Package build process can lead to high CPU utilization, especially in case of #Parallel compilation. Under heavy CPU load, the system can issue a significant slowdown up to becoming unusable, even with the highest nice(1) value. User interface and foreground applications may stutter or even became unresponsive.

This can be worked around by changing the scheduling policy to SCHED_IDLE before running makepkg. It ensures that package building process does not interfere with regular tasks and only utilizes remaining unused CPU time.

From sched(7) § SCHED_IDLE: Scheduling very low priority jobs:

This policy is intended for running jobs at extremely low priority (lower even than a +19 nice value with the SCHED_OTHER or SCHED_BATCH policies).

The SCHED_IDLE policy can be set by running chrt(1) command with the -i flag, specifying priority 0 (the only valid option for SCHED_IDLE) and specifying the PID of the current shell.

For most shells:

$ chrt -iap 0 $$

For the fish shell, where $$ is not set:

$ chrt -iap 0 %self

Instead of using absolute paths for the package output options, you can also configure relative paths inside each package directory.

For example, you can define target paths in your makepkg.conf file as follows. The $startdir variable refers to the directory where a PKGBUILD is located when you build a package.

PKGDEST="$startdir/build/packages/"
SRCDEST="$startdir/build/sources/"
SRCPKGDEST="$startdir/build/srcpackages/"
LOGDEST="$startdir/logs/"

This will result in:

• Built packages will be stored in: "package directory"/build/packages/
• All downloaded source files will be stored in: "package directory"/build/sources/
• Built source packages will be stored in: "package directory"/build/srcpackages/
• All logs will be stored in: "package directory"/logs/

makepkg will still create src/ and pkg/ directories as usual, so this is expected behaviour.

The makefile generated by qmake uses the environment variable INSTALL_ROOT to specify where the program should be installed. Thus this package function should work:

PKGBUILD

...
package() {
	cd "$srcdir/${pkgname%-git}"
	make INSTALL_ROOT="$pkgdir" install
}
...

Note, that qmake also has to be configured appropriately. For example put this in the corresponding .pro file:

YourProject.pro

...
target.path = /usr/local/bin
INSTALLS += target
...

Somehow, the literal strings contained in the variables $srcdir or $pkgdir ended up in one of the installed files in the package. [12]

To identify which files, run the following from the makepkg build directory:

$ grep -R "$PWD/src" pkg/

One possible cause would be from the usage of __FILE__ macro in C/C++ code with full path passed to compiler.

Dotnet binaries also sometimes contain full paths to the .pdb files in the default config.

When makepkg calls dependencies, it calls pacman to install the packages, which requires administrative privileges via sudo. However, sudo does not pass any environment variables to the privileged environment, and includes the proxy-related variables ftp_proxy, http_proxy, https_proxy, and no_proxy.

In order to have makepkg working behind a proxy, invoke one of the following methods.

The XferCommand can be set to use the desired proxy URL in /etc/pacman.conf. Add or uncomment the following line in pacman.conf:

/etc/pacman.conf

...
XferCommand = /usr/bin/curl --proxy http://username:[email protected]:80 --location --continue-at - --fail --output %o %u
...

Alternatively, one may want to use sudoer's env_keep option, which enables preserving given variables the privileged environment. See Pacman#pacman does not honor proxy settings for more details.

If something successfully compiles using make, but fails through makepkg, it is almost certainly because /etc/makepkg.conf sets an incompatible compilation variable. Try adding these flags to the PKGBUILD options array:

!buildflags, to prevent its default CPPFLAGS, CFLAGS, CXXFLAGS, and LDFLAGS.

!makeflags, to prevent its default MAKEFLAGS.

!debug, to prevent its default DEBUG_CFLAGS, and DEBUG_CXXFLAGS, in case the PKGBUILD is a debug build.

If any of these fix the problem, this could warrant an upstream bug report assuming the offending flag has been identified.

• makepkg(8)
• makepkg.conf(5)
• A Brief Tour of the Makepkg Process
• makepkg source code

Retrieved from "https://wiki.archlinux.org/index.php?title=Makepkg&oldid=886871"

Categories:

• Package development
• About Arch
• Commands
• OpenPGP

Hidden categories:

• Pages or sections flagged with Template:Merge
• Pages or sections flagged with Template:Expansion