APKBUILD Reference - Revision history

Diestl: Indicate that user defined functions should be defined in a specific order

2025-07-13T19:50:33Z

Indicate that user defined functions should be defined in a specific order

← Older revision		Revision as of 19:50, 13 July 2025
Line 365:		Line 365:

	== User-defined functions ==		== User-defined functions ==
	The following functions should be defined by the user:		The following functions should be defined by the user in the following order:

	==== prepare() ====		==== prepare() ====

Sertonix: /* User-defined variables */ fix sonameprefix example

2025-03-10T12:54:21Z

User-defined variables: fix sonameprefix example

← Older revision		Revision as of 12:54, 10 March 2025
Line 287:		Line 287:

	==== sonameprefix ====		==== sonameprefix ====
	: Prefix all provides derived from parsing shared objects with the value in this variable, example: '''sonameprefix="foo"''' will produce '''so:foo:bar.so.X'''		: Prefix all provides derived from parsing shared objects with the value in this variable, example: '''sonameprefix="foo:"''' will produce '''so:foo:bar.so.X'''

	= Functions =		= Functions =

Sertonix: /* md5sums/sha256sums/sha512sums */ support for md5sums/sha1sums was dropped

2025-03-10T11:30:20Z

md5sums/sha256sums/sha512sums: support for md5sums/sha1sums was dropped

← Older revision		Revision as of 11:30, 10 March 2025
Line 116:		Line 116:
	: Build-time dependency package(s). For cross compiling support, split it into <code>makedepends_build</code> (native system) and <code>makedepends_host</code> (foreign system).		: Build-time dependency package(s). For cross compiling support, split it into <code>makedepends_build</code> (native system) and <code>makedepends_host</code> (foreign system).

	==== ~~md5sums/~~sha256sums/sha512sums ====		==== sha256sums/sha512sums ====
	: Checksums for the files/URLs listed in ''source''. The checksums are normally generated and updated by executing <code>abuild checksum</code> and should be the last item in the APKBUILD.		: Checksums for the files/URLs listed in ''source''. The checksums are normally generated and updated by executing <code>abuild checksum</code> and should be the last item in the APKBUILD.

	New packages should use only sha512sums.		New packages should use only sha512sums. Support for md5sums and sha1sums was dropped.

	==== options ====		==== options ====

Sertonix: /* $pkgname.pre-install */ use -h in adduser example

2025-03-10T11:23:24Z

$pkgname.pre-install: use -h in adduser example

← Older revision		Revision as of 11:23, 10 March 2025
Line 67:		Line 67:

	addgroup -S clamav 2>/dev/null		addgroup -S clamav 2>/dev/null
	adduser -S -D -H -s /sbin/nologin -G clamav -g clamav clamav 2>/dev/null		adduser -S -D -H -h /var/lib/clamav -s /sbin/nologin -G clamav -g clamav clamav 2>/dev/null

	exit 0		exit 0

Sertonix: remove build() function instead of using return 0

2025-03-10T10:47:37Z

remove build() function instead of using return 0

← Older revision		Revision as of 10:47, 10 March 2025
Line 381:		Line 381:

	==== build() ====		==== build() ====
	: '''Required.''' This is the compilation stage. This function will be called as the current user (unless the ''package()'' function is missing - for compatibility reasons). If no compilation is needed, ~~this~~ function ~~can contain a single line: <code>return 0</code>~~		: '''Required.''' This is the compilation stage. This function will be called as the current user (unless the ''package()'' function is missing - for compatibility reasons). If no compilation is needed, the function should be removed.

	: To enable or disable CFLAGS, CXXFLAGS, CMake with option, or configure option per arch, use the CARCH variable:		: To enable or disable CFLAGS, CXXFLAGS, CMake with option, or configure option per arch, use the CARCH variable:

Ollieparanoid: makedepends: add makedepends_build, makedepends_host

2025-03-09T15:03:11Z

makedepends: add makedepends_build, makedepends_host

← Older revision		Revision as of 15:03, 9 March 2025
Line 114:		Line 114:

	==== makedepends ====		==== makedepends ====
	: Build-time dependency package(s).		: Build-time dependency package(s). For cross compiling support, split it into <code>makedepends_build</code> (native system) and <code>makedepends_host</code> (foreign system).

	==== md5sums/sha256sums/sha512sums ====		==== md5sums/sha256sums/sha512sums ====
	: Checksums for the files/URLs listed in ''source''. The checksums are normally generated and updated by executing <code>abuild checksum</code> and should be the last item in the APKBUILD.		: Checksums for the files/URLs listed in ''source''. The checksums are normally generated and updated by executing <code>abuild checksum</code> and should be the last item in the APKBUILD.

WhyNotHugo: /* Maintainer */ Update format to maintainer=

2024-10-17T05:09:39Z

Maintainer: Update format to maintainer=

← Older revision		Revision as of 05:09, 17 October 2024
Line 22:		Line 22:
	== User-defined variables ==		== User-defined variables ==
	The following variables should be defined by the user:		The following variables should be defined by the user:
	==== ~~Maintainer~~ ====		==== maintainer ====
	: Name and email address of the maintainer of the ~~project (not your~~ package).		: Name and email address of the maintainer of the package.
	: A well-formatted example is <code>~~# Maintainer:~~ John Snow <john_snow@thewall.net></code>		: A well-formatted example is <code>maintainer="John Snow <john_snow@thewall.net>"</code>

	==== arch ====		==== arch ====

WhyNotHugo: /* Variables */ De-duplicate variable definition (these are well covered in the man page)

2024-07-13T11:12:28Z

Variables: De-duplicate variable definition (these are well covered in the man page)

← Older revision		Revision as of 11:12, 13 July 2024
Line 19:		Line 19:

	These variables are all well documented in <code>man 5 APKBUILD</code> ([https://gitlab.alpinelinux.org/alpine/abuild/-/blob/master/APKBUILD.5.scd man page source]).		These variables are all well documented in <code>man 5 APKBUILD</code> ([https://gitlab.alpinelinux.org/alpine/abuild/-/blob/master/APKBUILD.5.scd man page source]).

	~~== abuild-defined variables ==~~
	~~The following variables are defined by abuild:~~

	~~==== startdir ====~~
	~~: The directory where the APKBUILD script is.~~
	~~==== srcdir ====~~
	~~: The directory where sources, from the ''source'' variable, are downloaded to and unpacked to.~~
	~~==== pkgdir ====~~
	: This directory should receive the files for the main package. For example, a normal [https://en.wikipedia.org/wiki/GNU_Autotools autotools] package would have <code>make DESTDIR="$pkgdir" install</code> in the ''package()'' function.
	~~==== subpkgdir ====~~
	~~: This directory should receive the files for a subpackage. This variable should only be used from subpackage functions.~~
	~~==== builddir ====~~
	: This variable should point to the directory inside the ''srcdir'' where the main package source is unpacked. This is typically ''$srcdir/$pkgname-$pkgver''. It’s used by the default ''prepare()'' function as a working directory when applying patches.


	== User-defined variables ==		== User-defined variables ==

WhyNotHugo: /* Variables */ Add link to online man page

2024-07-13T11:11:05Z

Variables: Add link to online man page

← Older revision		Revision as of 11:11, 13 July 2024
Line 18:		Line 18:
	{{Note\|All arbitrary variable and function names should be prefixed with an underscore character ( _ ) to avoid name clashes with the internals of abuild (for example, ''_luaversions'').}}		{{Note\|All arbitrary variable and function names should be prefixed with an underscore character ( _ ) to avoid name clashes with the internals of abuild (for example, ''_luaversions'').}}

	These variables are all well documented in <code>man 5 APKBUILD</code>.		These variables are all well documented in <code>man 5 APKBUILD</code> ([https://gitlab.alpinelinux.org/alpine/abuild/-/blob/master/APKBUILD.5.scd man page source]).

	== abuild-defined variables ==		== abuild-defined variables ==

Zcrayfish: Fixed wikilink.

2023-11-19T18:50:56Z

Fixed wikilink.

← Older revision		Revision as of 18:50, 19 November 2023
Line 1:		Line 1:
	APKBUILDs are the scripts that are created in order to build Alpine packages using the [[abuild]] tool.		APKBUILDs are the scripts that are created in order to build Alpine packages using the [[Abuild and Helpers\|abuild]] tool.

	See [[aports]] for details on Alpine's official ports repository.		See [[aports]] for details on Alpine's official ports repository.