Alpine Linux - User contributions [en]

Release Notes for Alpine 3.18.0

2023-05-09T19:54:27Z

Panekj: add aws-cli note and migration instruction

== Base System ==

=== Linux Kernel ===

{{pkg|linux-lts}} was updated from 5.15 to 6.1. [https://lkml.org/lkml/2022/12/11/206 release notes]

Kernel modules are now signed.

''Note: {{pkg|akms}} (Alpine Kernel Module Support) doesn't support modules signing yet, it will be implemented later.''

=== musl 1.2.4 ===

Support for DNS lookups over TCP. [https://www.openwall.com/lists/musl/2023/05/02/1 release notes]

=== DT_RELR ===

on x86, x86_64, and ppc64le, <code>-Wl,-z,pack-relative-relocs</code> is now added to the base LDFLAGS. this reduces elf (executable/shared-library) size by 10% on average.

however, these binaries are now not portable to other musl-based systems that have a musl older than 1.2.4, because older versions are incapable of loading these binaries.

=== OpenSSL 3.1 ===

[https://www.openssl.org/news/openssl-3.1-notes.html release notes]

=== Experimental headless installer ===

Support for head-less installs with [https://gitlab.alpinelinux.org/alpine/cloud/tiny-cloud tiny-cloud] was added. This is done via a volume with label <code>cidata</code>, similar to cloud-init's [https://cloudinit.readthedocs.io/en/latest/reference/datasources/nocloud.html NoCloud] provider. If this volume is found during boot, the network will be auto configured and provided, a default user named <code>alpine</code> will be created and ssh keys provided in meta-data will be added. This is experimental and may change without prior notice.

=== e2fsprogs 1.47.0 ===

The {{pkg|e2fsprogs}} package shipped with Alpine 3.18 changed the behaviour of <code>mke2fs</code> so that newly created filesystems have two additional features enabled.

From [https://e2fsprogs.sourceforge.net/e2fsprogs-release.html#1.47.0 release notes]:

<blockquote>The mke2fs program (via the mke2fs.conf file) now enables the metadata_csum_seed and orphan_file features by default.</blockquote>

However, whilst the <code>metadata_csum_seed</code> feature is known about by older versions of e2fsck the <code>orphan_file</code> feature was both added to e2fsprogs 1.47.0 '''and''' enabled at the same time. Therefore older versions of e2fsck are unable to fsck a filesystem created by mke2fs 1.47.0.

== Compilers and Runtimes ==


=== LLVM 16 ===

{{pkg|llvm16}} was added. [https://releases.llvm.org/16.0.0/docs/ReleaseNotes.html release notes]

=== Lua ===

{{pkg|luarocks}}, the package manager for Lua, was updated from 2.x to 3x. [https://github.com/luarocks/luarocks/blob/master/CHANGELOG.md#whats-new-in-luarocks-300 release notes]

=== Python ===

{{pkg|python3}} was updated from 3.10 to 3.11. [https://docs.python.org/3/whatsnew/3.11.html release notes]

==== splitting of python pycache .pyc files ====

Most python modules split their <code>__pycache__</code> to a <code>-pyc</code> subpackage, pulled by default. To save space and not pull it (incurring python interpreter startup costs, as it generates it each run), run <code>apk add !python3-pyc</code>

=== Ruby 3.2 ===

{{pkg|ruby}} was updated from 3.1 to 3.2. [https://www.ruby-lang.org/en/news/2022/12/25/ruby-3-2-0-released/ release notes]



=== Crystal 1.8 ===

{{pkg|crystal}} was updated from 1.6 to 1.8. [https://crystal-lang.org/2023/01/09/1.7.0-released/ release notes for 1.7], [https://crystal-lang.org/2023/04/14/1.8.0-released/ release notes for 1.8]

=== Go 1.20 ===

{{pkg|go}} [https://go.dev/blog/go1.20 release notes]

=== PHP 8.2 ===

Added 8.2 packages with a subset of the most common extensions. Version 8.1 still remains the primary provider priority, but some web applications started to use 8.2.

=== R 4.3 ===

{{pkg|R}} was updated from 4.2 to 4.3. [https://www.r-bloggers.com/2023/04/whats-new-in-r-4-3-0/ release notes]

=== Rust 1.69 ===

{{pkg|rust}} was updated from 1.64 to 1.69.

== Desktop ==

=== gdk-pixbuf-loaders ===

A few gdk-pixbuf loaders were added, and they were all added to an <code>install_if</code> metapackage rule. Run <code>apk add gdk-pixbuf-loaders</code> to enable the loaders for the corresponding image libraries you have installed.

=== GNOME 44 ===

[https://release.gnome.org/44/ release notes]

The {{pkg|gnome}} metapackage was reworked and the packages {{pkg|gnome-apps-extra}} and {{pkg|gnome-games-collection}} were removed to avoid opinionated lists in metapackages. It is advised to remove those from <code>/etc/apk/world</code> before performing the upgrade. Additionally, the new subpackage {{pkg|gnome-dev-tools}} was added following the upstream's recommendations.

On related news, to make use of GNOME Software, it is necessary to enable the <code>apk-polkit-server</code> openrc service. More info in the [https://wiki.alpinelinux.org/wiki/Gnome#Enabling_GNOME_Software wiki]

=== Plasma 5.27 ===

{{pkg|plasma}} was updated from 5.26 to 5.27. This includes some new packages like {{pkg|plasma-welcome}} (a welcoming application that shows up on the first boot to configure some initial settings) and {{pkg|flatpak-kcm}} (a configuration page for the system settings to control Flatpak permissions, much like GNOME's Flatseal).
This Plasma release is the last one that will be built on Qt5 and will probably remain in use for Alpine 3.19 as well.

=== Sway 1.8 ===

{{pkg|sway}} was updated from 1.7 to 1.8. [https://github.com/swaywm/sway/releases/tag/1.8 release notes]

== Others ==

=== dbus ===

dbus-activation has been removed from packages {{pkg|openrc-settingsd}} and {{pkg|apk-polkit-rs}}. To make use of their services, make sure to start and enable the <code>openrc-settingsd</code> and <code>apk-polkit-server</code> services, respectively.

=== nginx 1.24 ===

{{pkg|nginx}} was updated to the new stable branch 1.24.x. [https://nginx.org/en/CHANGES-1.24 release notes]

=== Removal of pipewire-media-session ===

{{pkg|pipewire-media-session}} was removed, as upstream explicitly recommends not to use it, and it's completely superceded by wireplumber.
if you used it, make sure you don't have {{pkg|pipewire-media-session}} in <code>/etc/apk/world</code>, and configure any scripts you might've had to launch <code>wireplumber</code> instead.

=== QEMU 8 ===

QEMU was updated from 7.1 to 8.0. [https://www.qemu.org/2023/04/20/qemu-8-0-0/ release notes]

=== Docker 23 ===

The {{pkg|docker}} package shipped with Alpine 3.18 has a dependency on {{pkg|docker-cli-buildx}}, as Docker 23 now uses it for builds.

Also, Docker 23 no longer enables the <code>overlay</code> storage driver, as it has been deprecated for a long time and is nearing removal. if your deployment is still configured to use it, <code>dockerd</code> will fail to start. To fix this, either...

* migrate to <code>overlay2</code> in <code>/etc/docker/daemon.json</code>
* hardcode it to <code>overlay</code> in the same file (instead of blank), though this will eventually break in a future upgrade

For more detailed information about Docker 23, please refer to the [https://docs.docker.com/engine/release-notes/23.0/ release notes].

=== AWS CLI v2 ===

The {{pkg|aws-cli}} package has been upgraded from v1 to v2 which results in changed behaviour in how certain commands behave.

Please follow [https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html this guide] for migrating between versions.

User:Panekj

2022-08-01T20:53:50Z

Panekj: love html

irc: <code>panekj</code> | <code>pj</code>
 matrix: <code>pj</code>

User:Panekj

2022-08-01T20:51:28Z

Panekj: me

irc: panekj | pj
matrix: pj

Creating an Alpine package

2022-04-11T13:29:06Z

Panekj: mention APKBUILD reference wiki page next to manpage

{{TOC right}}

== Requirements ==

To build a package for Alpine Linux you need an Alpine Linux installation. Check the [[Installation]] page to see all available installation options.

== Setup your system and account ==
{{:Include:Setup_your_system_and_account_for_building_packages}}

== Getting some help ==

It might be wise to start by checking what the [[Abuild|abuild]] program can/cannot do.

{{Cmd|abuild -h}}

For real help, you can also go on OFTC's #alpine-devel on IRC.

A reference for APKBUILD files is available as [[APKBUILD Reference]] wiki page or a man page in the 'abuild-doc' package:

{{Cmd|man APKBUILD}}

== Creating an APKBUILD file ==

=== Use a template APKBUILD ===

To create the actual APKBUILD file {{Pkg|newapkbuild}} can serve you a template to start with. It will create a directory with the given package name, place an example/template APKBUILD file to the given directory, and fill some variables if those are provided. Please check the [[Package_policies| package policies]] page about naming details.

If you doubt to which repository your package belongs to you can safely use '''testing'''. Building package in your aports/testing directory is not mandatory but this way the package is already at the right place.

{{:Include:Newapkbuild}}

{{Note|On older Alpine systems, abuild -c -n ''packagename'' was the way to create APKBUILD files. The 'packagename' was a parameter to the -n option so order of -c and -n matters. }}

[[Abuild_and_Helpers#apkbuild-cpan|apkbuild-cpan]] simplifies the creation of perl packages from CPAN and [[Abuild_and_Helpers#apkbuild-pypi|apkbuild-pypi]] ease the generation of APKBUILD files for python packages from PyPi.

If you are creating a daemon package which needs initd scripts you can add the -c making it:

{{Cmd|newapkbuild -c ''packagename''}}

This will copy the sample initd and confd files to the build directory. 
A third file sample.install file will be copied as well (we will discuss this later on).

=== Modify your APKBUILD ===
Edit APKBUILD and fill in the needed info (especially pkgname, pkgver, pkgdesc, url, license, depends and source).

If you are going to use any of the variables for directories like $pkgdir, always make sure they are double quoted like:

"$pkgdir"/somedir

This will prevent issues with spaces/special characters in the future.

{{Note|If you like syntax highlighting we suggest you to install vim. We have setup vim to recognize the APKBUILD file as a bash scripts so its easier to read them.}}

=== APKBUILD variables/functions ===

==== source ====

The source variable is not only used to list the remote source files to fetch, it is also used to list the local files that abuild will need in order to build the apk. Examples of such local files include: init.d files, conf.d files, install files (see [[Creating an Alpine package#install|install variable]]), patches, and all other necessary files.

Here are few things to note:

* When you are finished adding local and/or remote files to ''source'', you can execute the following command to add their checksums to the APKBUILD file:
: {{cmd|abuild checksum}}
: {{Note|When later updating the content of ''source'', or updating a file that is listed in ''source'', you must also update their checksums again with the same command.}}

* When the remote file is hosted at SourceForge, it's best to specify the special mirrors link used by SourceForge:
: <pre>http://downloads.sourceforge.net/$pkgname/$pkgname-$pkgver.tar.gz</pre>
: (or similar depending on the package).

* When the remote filename is not specified in the URI (ie, does not end in '/software-1.0.tar.gz'), such as:
: <pre>http://oss.example.org/?get=software&ver=1.0</pre>
: You must prepend '${pkgname}-${pkgver}.tar.gz::' to the protocol, like so:
: <pre>source="${pkgname}-${pkgver}.tar.gz::http://oss.example.org/?get=software&ver=1.0"</pre>
: This causes the file to be saved as ''software-1.0.tar.gz'' where abuild can use it, instead of ''?get=software&ver=1.0'', where abuild cannot use it.

* Some projects didn't provide a release tarball. Beware that some git services (gitweg, cgit, …?) doesn’t provide ''stable'' tarballs, so when you point source to an tarball like <tt>http://repo.or.cz/w/gitstats.git/snapshot/ad7efbb9399e60cee6cb217c6b47e604174a8093.tar.gz</tt>, then you will run into issues because the checksum changes when downloading on the build system. This is not a problem on GitHub, GitLab and other decent services provides, they provide ''stable'' tarballs.

* abuild currently supports the following protocols for remote file retrieval:
** http
** https
** ftp



* abuild currently supports the following archive types/archive file extensions:
** .tar
** .tar.gz / .tgz
** .tar.bz2
** .tar.lz (only in Alpine >=3.7)
** .tar.lzma
** .tar.xz
** .zip

==== depends & makedepends ====

Depends are the actual running dependencies that a package would need when it is running. Makedepends are only needed when you are building a package. If you set a package in depends, you do not need to add it to makedepends as well. The best way to find out what the depends and makedepends of a package are is to [http://en.wikipedia.org/wiki/Rtfm RTFM].

No kidding, lots of important information can be found in the package INSTALL and README files (or the likes). Another good way is the run <code>./configure --help</code> from the source directory to see which options are needed for configure to finish without errors. If you do not yet have a source directory you can create one with the command:

{{Cmd|abuild unpack}}

Running <code>configure</code> will also show you how you can disable a specific option for this package. For instance, a good example is "--disable-nls" which will disable native language support and thus does not depend on gettext (libiconv, glib, ...).

Alpine likes to keep things small, so we try to disable as much as possible without losing too many features. The exact disable/enable options are decided by the package builder but please try to follow Alpine's design concept as much as possible.

An easy way of quickly finding out the build info for a package is to check Arch Linux (Alpine package management and build scripts are similar) or Gentoo Linux ebuilds (previous versions of Alpine were based on Gentoo).

* [https://gitweb.gentoo.org/repo/gentoo.git/tree/ Gentoo Ebuilds]
* [http://www.archlinux.org/packages/search/ Arch Linux packages] [https://aur.archlinux.org/ Arch Linux User Repository]

==== license ====

The '''license''' tag must reflect the license of the source code. Please check the source tarball for COPYING, LICENSE, or other files with names that indicates that it contains licensing information. Beside the license file most developer include headers in the source code files with licensing details.

If the license is on the [https://spdx.org/licenses/ SPDX License List] or [https://spdx.org/licenses/exceptions-index.html SPDX License Exceptions], use the identifier specified by SPDX.

If a package has a special/custom license or is not listed as [https://opensource.org/licenses/alphabetical OSI approved], use the identifier "custom". We additionally need to provide the license file with the release. Because we want to save space and don't like to have licenses all over our system we have decided to include the license in the doc subpackage. Please follow the following guidelines to add a proper license. Locate the license file inside the source package. Add the doc subpackage to the $subpackages variable as follows:

subpackages="$pkgname-doc"

Add a similar line to the following to your package() function, depending on the license description file:

install -Dm644 COPYING "$pkgdir"/usr/share/licenses/$pkgname/COPYING

If you follow these steps then abuild will automatically add the license to the package-doc apk for you.

{{Warning|It is not acceptable to package software with "unknown" license! If you can't find the license of the source code, please contact the author and ask them to specify the license. }}

==== arch ====

The package architecture(s) to build for. This can be one of: ''x86, x86_64, all,'' or ''noarch'', where ''all'' means all architectures, and ''noarch'' means it's architecture-independent (e.g., a pure-python package).
{{Tip|To determine if your APKBUILD can use ''noarch'', build the package for your architecture and then run "scanelf -R pkg" from the directory that the APKBUILD resides in, in order to scan for ELF files in the ''./pkg'' directory. If you do NOT get output from this, then ''noarch'' can be used.}}

==== url ====

Website address for the program. This is useful later on when either finding documentation or other information about the package.

==== pkgdesc ====

A brief, one line, description of what the package does. Useful for the package management system. It should start with a capital letter and does '''not''' end with a period.

Here is an example from apk_info for the OpenSSH client package:

pkgdesc="Port of OpenBSD's free SSH release - client"

==== pkgver ====

Provide the release number of the package you are building.

==== pkgrel ====

The $pkgrel versioning is made so that if you change something in your APKBUILD file without changing the actual $pkgver, you can increment pkgrel so apk tools will detect it as an update. For instance, if you forget to add a dependency, you can add it afterward and you can +1 pkgver so apk finds this update and adds the missing dependency. When there's an upstream version change, we reset the pkgrel to 0.

==== pkgname ====

The base name of the package you are creating. For Freeswitch 1.0.6, you would use "freeswitch"

==== install ====

There are 6 different kinds of install scripts. Each script is called with the $pkgname.''<action>'' where ''<action>'' is one of the following:

<dl>
<dt>$pkgname.pre-install
<dd>This script is executed before package is installed. Typical use is when package needs a group and a user to be created. For example:
<pre>
#!/bin/sh

addgroup -S clamav 2>/dev/null
adduser -S -D -H -s /bin/false -G clamav -g clamav clamav 2>/dev/null

exit 0
</pre>
Note the ''exit 0'' at the end. If the script exits with failure (if the user already exist), the package will not be installed and <code>apk add</code> will exit with failure.

<dt>$pkgname.post-install
<dd>This script is executed after the package is installed. Can be used to generate font cache and similar.

<dt>$pkgname.pre-upgrade
<dd>Same as pre-install but is executed before upgrading/downgrading/reinstalling an already installed package. Note that exiting with failure will not cause apk to exit with failure, but will mark the package as broken.

<dt>$pkgname.post-upgrade
<dd>Same as post-install but is executed after upgrading/downgrading/reinstalling an already installed package.

<dt>$pkgname.pre-deinstall
<dd>This script is executed before uninstalling a package. If script exits with failure apk will not uninstall the package.

<dt>$pkgname.post-deinstall
<dd>This script is executed after a package have been uninstalled. Can be used to update font caches and restore busybox links. For example:
<pre>
#!/bin/sh
busybox --install -s
</pre>

</dl>

If the package has a pre-install and post-install script the APKBUILD should have the ''install'' variable defined:
<pre>
...
install="$pkgname.pre-install $pkgname.post-install"

...
</pre>

==== subpackages ====

$subpackages are made to split up the normal "make install" into separate packages. The most common subpackages we use are doc and dev. Because we like to keep our target system small we move documentation and development files (only needed when building packages) into separate packages. To use the specific program a user only need to install the base apk without package-doc or package-dev, but if he wants to read the manual he will need to install package-doc.

The easiest way to find out if you need to use -dev and -doc is to first build the package without these options set and wait until the build finishes. When its finished you should have a pkg directory which is the fake root directory. Inside this directory you will see the structure as how it would be installed in / on the target system.

To see if you need the -dev package you can run the following cmd:

{{Cmd|find pkg/usr/ -name '*.[acho]' -o -name '*.la'}}

If this returns any files you need to include the -dev package.

 To see if you need the -doc package you can run the following cmd:

{{Cmd|find pkg/usr/share -name doc -o -name man -o -name info -o -name html -o -name sgml -o -name licenses}}

If this returns any directories you need to include the -doc package.

===== Custom subpackages =====

Some software additionally has non-essential files that do not qualify as either documentation or development content. These files should be placed in their own, specialized subpackage(s). Some packages include large test suites which are only needed in specific circumstances or binaries which have depends which we prefer not to install. To handle those we create our own package/function. In the APKBUILD below the build() function we create another function:

test() {
mkdir -p "$subpkgdir"/usr
mv "$pkgdir"/usr/package-test "$subpkgdir"/usr/
# or amove usr/package-test
}

We also need to add the package info to $subpackages variable:

subpackages="$pkgname-doc $pkgname-dev $pkgname-test"

After we finish building the package you should see another apk called packagename-test.apk which includes the files which we moved to the $subpkgdir dir.

The above mentioned variables can also be used in our custom function. If we want for instance to build the test() function with perl support we would add:

depends="perl"
makedepends="perl-dev"

If we would install the base package it would not install perl, but if we install the package-test package it would.

==== Patches ====

Please make sure you always submit human readable patches. Ways to create them are:

directory compare:

{{Cmd|diff -Nurp original_directory new_directory > filename.patch}}

file compare:

{{Cmd|diff -up original.file new.file > filename.patch}}

If a patch contains a completely new file but not *.rej or *.orig file, you need to add -N option to diff, but you may need to add exclusions with <code>--exclude PATTERN</code> so that you do not inadvertently add files. You may need to manually delete unwanted files inside the patch file.

Because multiple patches can patch the same file, they can change the offsets required by subsequent patches. To make sure we always patch in a specific way, we should number the patches as follows:

10-patch1.patch 20-patch2.patch 30-patch3.patch

This way we are always sure that patch 1 is applied first, and if we want to add additional patches between them we can use appropriate indexes (e.g. 11, 12, 21, 22).

Add the names of the patch files to the ''source'' variable. If you haven't declared a custom ''prepare'' function, no further action is necessary. Otherwise, be sure to call ''default_prepare'' in your ''prepare'' function. For example:

prepare() {
default_prepare

# do your stuff
}

Note: Some older packages contain a ''for'' loop in the ''prepare'' function to apply patches. This is not needed anymore, as patches are handled by ''default_prepare''.

In Alpine >=3.4 you can define patch_args to supply the patch level. This only works if all the patches have the same patch level. If there are a lot of patches from different sources, there is a good chance that you may need to edit them, as discussed below.

To automatically patch the package (available only in Alpine >=3.4) if it uses a patch level (-pX) other than the default (-p1), you need to carefully modify the patch. First, you'll need a text editor that does not automatically convert between Windows and Unix new lines (or, disable this feature) so that it preserves the old code. The next thing you'll need to do is modify the paths on "+++" and "---" lines in the .patch file. You can begin the path with a/ and b/ like shown below. Next, you need to adjust the paths so that the relative base path is from inside $builddir. Anything to the left of $builddir, including $builddir itself, needs to be removed from the path. So, if $builddir is /home/USER/aports/community/chromium/src/chromium-65, you need to erase it on the "+++" and "---" lines. Inside the chromium-65 folder you can see a src folder that has 3rdparty as a descendant. If a patch originally has a deeper patch level, you may need to fill in the missing portion of the path. For example, use the <code>find . -name "Assertions.cpp"</code> command to find the full path to the file relative to the base.

{{Cat|example.patch|<nowiki>
Author: John Doe <johndoe@mail.com>
URL: http://.....
Summary: Fixes musl compatibility
----
--- a/src/3rdparty/chromium/third_party/WebKit/Source/wtf/Assertions.cpp.orig
+++ b/src/3rdparty/chromium/third_party/WebKit/Source/wtf/Assertions.cpp
@@ -142,7 +142,7 @@
};

FrameToNameScope::FrameToNameScope(void* addr) : m_name(0), m_cxaDemangled(0) {
-#if OS(MACOSX) || (OS(LINUX) && !defined(__UCLIBC__))
+#if OS(MACOSX) || (OS(LINUX) && defined(__GLIBC__))
Dl_info info;
if (!dladdr(addr, &info) || !info.dli_sname)
return;
</nowiki>}}

Portions of the patch may be outdated, removed completely as in the source code file completely removed, or moved or renamed files. You need to delete that section of the patch or find where that section of code changed and re-diff it.

It is good etiquette to give credit at the top and the location of where you originally found them with notes.

Excluding patches with global variable resembling patch_opts is not available on Alpine. To exclude patches you need to create your own custom prepare().

If you have a monolithic patch where there are a bunch of patches in one big patch, you could use filterdiff which is available in the patchutils package.

Just do something like:

<pre>
makedepends="patchutils"

prepare() {
...
cd "$builddir"
filterdiff -x '*drivers/video/logo*' "$srcdir"/original.patch > "$builddir"/modified.patch
patch -p1 -i "$builddir"/modified.patch
}
</pre>

You need to put the wildcard pattern in single quotes for it to work.

==== Configure options ====

Alpine has some default configure options we set by default. We use /usr for prefix to make sure everything is installed with /usr in front of it. If you notice that anything is installed in the wrong directory please run {{Cmd|./configure --help}} and see if you can set the correct location.

We are not covering the depend switches here we have discussed this already in the depend section.

==== Make options ====

If you notice weird problems when compiling or installing the package with make/make install you could try to disable [http://www.gnu.org/software/make/manual/make.html#Parallel parallel] building/installing. A normal make line would be:

make

To disable parallel we use:

make -j1

We can use the same for make install.

Because we do not want to install the package in our build environment but we want to install it in a fake root directory we need to tell 'make install' to use another destination directory instead of '/'. We do this by setting a variable when we execute make install as followed:

make DESTDIR="$pkgdir" install

Please note that some Makefiles do not support this variable and will always install software in '/'. To make sure you do not mess up your build system NEVER run your build system as root but always use a custom user and doas when needed. If by accident the Makefile does not support DESTDIR variable it will fail to install in our build system system directories.

==== builddir ====
If you used <tt>newapkbuild</tt> to create your APKBUILD file, you must specify the path to your unpacked sources. Inside the sections during the prepare/build/install process ''builddir'' is used. Most of the time a combination of ''$srcdir'' and ''$pkgname-$pkgver'' will work. When not, check the /src directory or the source tarball for the right string. Especially when you are working with automatically generated tarballs (like from github and gitorious), this needs to be adjusted.

builddir="$srcdir"/$pkgname-$pkgver

==== Additional files ====

If you want/need to install additional files not mentioned above you can use the following cmd (this is an example of a conf file):

install -Dm644 doc/$pkgname.conf "$pkgdir"/etc/$pkgname.conf

== Build the package ==

If you did not already create the checksums as mentioned above you can do so now:

{{Cmd|cd $pkgname
abuild checksum}}

It's about time we build our package. Because a build system should never have all the package installed to prevent linking to packages we don't want it to link we use a abuild recursively with the '''-r''' switch. It will install all dependencies from your repository and builds it, afterwards it will uninstall all those depending packages again.

{{Cmd|abuild -r}}

== Testing the package locally ==

When it completes, your package will be found in a subfolder of <code>~/packages</code>. You may want to test it on your machine but only if the package is not a critical system package like musl or apk-tools package. To avoid borking your system (as in making it impossible to use <code>apk add</code> or to restore back the system and the compiler toolchain) for a critical system package, you should test on a chroot first before using it live.

The best way to test a package locally is to modify your <code>/etc/apk/repositories</code> so that it includes the indexes to your locally built packages - the directories that contain <code>ARCH/APKINDEX.tar.gz</code>. For example the <code>/etc/apk/repositories</code> below includes locally built packages in testing, community and main. To use this example change <code>USER</code> to your login name.

{{Cat|/etc/apk/repositories|/home/USER/packages/testing/
/home/USER/packages/community/
/home/USER/packages/main/
/media/sdc/apks
#http://dl-2.alpinelinux.org/alpine/v3.7/main
#http://dl-2.alpinelinux.org/alpine/v3.7/community
http://dl-2.alpinelinux.org/alpine/edge/main
http://dl-2.alpinelinux.org/alpine/edge/community
http://dl-2.alpinelinux.org/alpine/edge/testing
}}

If you prefer to test a package without changing any other configuration you can use the <code>-X, --repository</code> option to <code>apk</code>:

{{Cmd|doas apk add --repository /home/USER/packages/testing $pkgname}}

== Code review ==

To successfully have your package pass through code reviewers (as of Feb 18, 2018 are nmeum and jirutka on GitHub) and possible increased acceptance, the following conventions need to be followed:

# Custom global variables should be prefixed with underscore (_).
# Compact code as in merged commands, removed unused variables, removal of functions that do the same thing that are automatically handled by abuild.
# Versioning is done properly. For details see [[APKBUILD_Reference#pkgver]].
# Licensing is done properly. Remove unnecessary copying of licensing that is already OSI approved.
# Naming conventions rules for unofficial variables as in _gitrev is preferred over commit.
# Indent with tabs not spaces.
# Removal of explicit return 1. (They are still found the old APKBUILD files if you are learning but are now strongly discouraged.)
# Disabling check() requires either (1) a comment (#) stating next to options="!check" that there is no test suite/unit tests or (2) functioning working check() function.
# Explicit call to subpackages="$pkgname-doc" must be used instead of explicit gzip man page compression.
# Ideally, lines should be no more than 80 columns wide

Additionally, make sure to run the linter on your package:
{{Cmd|doas apk add atools
apkbuild-lint APKBUILD}}

For more information see [[Development using git:Quality assurance]] and [[Package_policies]].

== Commit your work ==

After you successfully build your package and properly followed the conventions and requirements in the code review section, you can submit your APKBUILD to Alpine's git repository.

Update your git repo, before adding new files:

{{Cmd|cd $aportsdir
git pull}}

This should pull all the changes made by others into your local git repo.

When you think you are ready you can add your files to git:

NOTE: when using our Gitlab instance, you can create MR's for each package. Please squash all commits related to the same package into a single one per MR.

{{Cmd|cd $aportsdir
git add testing/$pkgdir (include any other files needed for the build; $pkgname.install...)
git commit}}

Use the following commit message template for new aports (without the comments):

{{Cat|template|testing/$pkgname: new aport # this will be the subject line
# a blank line
$url # project homepage
$pkgdesc # one line description}}

Or you could add the following and <code>chmod +x ports/.git/hooks/prepare-commit-msg</code> to automatically generate commit message which the default aports/.githooks/ does not:

{{Cat|aports/.git/hooks/prepare-commit-msg|<nowiki>#!/bin/sh
case "$2,$3" in
,|template,)
if git diff-index --diff-filter=A --name-only --cached HEAD \
| grep -q '/APKBUILD$'; then
meta() { git diff --staged | grep "^+$1" | sed 's/.*="\?//;s/"$//';}
printf 'testing/%s: new aport\n\n%s\n%s\n' "$(meta pkgname)" \
"$(meta url)" "$(meta pkgdesc)" "$(cat $1)" > "$1"
else
printf '%s\n\n%s' `git diff-index --name-only --cached HEAD \
| sed -n 's/\/APKBUILD$//p;q'` "$(cat $1)" > "$1"
fi;;
esac</nowiki>}}

Now your changes are only available locally in your repository.

Because you do not have push rights to the Alpine aports repository you need to create a merge request to [https://gitlab.alpinelinux.org/alpine/aports Alpine's GitLab instance].

Alternatively you can also create a diff (patch) of the changes you made and send this patch to the
[https://lists.alpinelinux.org/~alpine/aports alpine-aports mailinglist].

To create a diff patch:

{{Cmd|git format-patch HEAD^}}

or if you have sprunge, you can create a link to your patch for convenience

{{Cmd|git format-patch HEAD^ --stdout <nowiki>|</nowiki> sprunge}}

== Send a patch ==

[[Creating_patches#Only_the_last_commit_with_.27git_send-email.27|git send-email]] will do that for you.

== See Also ==
* [[APKBUILD Reference]]
* [[APKBUILD examples]]
* [[Development using git]]
* [[Development using git:Quality assurance]]

[[category: Package Manager]]

Requirements

2022-04-02T21:49:46Z

Panekj: corrected sentences so it sounds like English, removed unnecessary {tables, boldening on text, BIOS enter instructions, arch trivia, text about video games}, corrected lists, removed recommended media for installation,

This page will tell you what requirements you will need to use the Alpine Linux operating system:
__TOC__

== Hardware requirements ==

For installation and usage consider that Alpine can run on several kinds of devices, from the popular PC machine to video game consoles like the Game Boy Advance and the 3DS, and as such you must verify below details:

* CPU architecture
* Memory
* Storage
* Peripherals

=== Architectures ===

CPU architecture is a instruction set design that defines how a processor is used by software. Widely used across desktops and servers are x86 (mostly i386) and x86_64 (also known as amd64). There are other supported computer architectures that are not "x86", like mainframes, servers, and embedded devices (such as routers like Sonicwall and Cisco ones). Below table represents architectures supported by Alpine:

{| class="wikitable"
|-
! Supported architecture !! Available since !! Description
|-
| x86_64 || all || Widely spread AMD64 compatible 64-bit x86 instruction set.
|-
| x86 || all || Another widely used instruction set which is 32-bit.
|-
| ppc64le || v3.6 || For the PowerPC devices with pure little-endian mode, mostly for POWER8 and POWER9
|-
| armhf || v3.0 || ARM instruction set with hard-float point extension.
|-
| armv7 || v3.9 || The 32-bit ARM only execution state of the ARMv7 devices machines.
|-
| aarch64 || v3.5 || The 64-bit ARM only execution state of the ARMv8+ device machines.
|-
| ppc64le || v3.6 || For 64-bit big-endian PowerPC and Power ISA processors like some MAC computers.
|-
| s390x || v3.6 || For the Super powered IBM mainframes, especially IBM Z and IBM LinuxONE servers.
|}

=== Memory ===

Below are shown minimum RAM amounts for various installation types and phases:

{| class="wikitable sortable"
|-
! Target Arch !! Minimum RAM to start !! Minimum RAM to install !! Minimum RAM for GUI desktop !! Enough for GUI work
|-
| x86_64 || 512 Megs || 512 Megs || 2 Gigs || 8 Gigs
|-
| x86_32 || 128 Megs || 256 Megs || 1 Gigs || 3 Gigs
|-
| ppc64le || 128 Megs || 256 Megs || 2 Gigs || 8 Gigs
|-
| armhf || 256 Megs || 512 Megs || 1 Gigs || 6 Gigs
|-
| armv7 || 256 Megs || 512 Megs || 1 Gigs || 6 Gigs
|-
| aarch64 || 256 Megs || 512 Megs || 2 Gigs || 8 Gigs
|-
| ppc64le || 256 Megs || 512 Megs || 1 Gigs || 6 Gigs
|-
| s390x || 128 Megs || 256 Megs || 2 Gigs || N/A
|}

=== Storage ===

Means any external or internal storage device that can be added after or before install to use by the Alpine Linux system. Currently depends of the current linux kernel supported.

All the PATA and SATA hard disk drives are supported, also any USB or SD card that can be detected by USB BUS by the linux kernel subsystem during install.

=== Peripherals ===

Means any external or internal device that can be added after or before install to detectd by the Alpine Linux system. Depends on the current version of Linux kernel.

ISA devices are not supported since 3.8 because they have been dropped from Linux kernel.

Almost any GPU are supported, but certain features and 3D acceleration might depend on MESA drivers:

* Intel: mostly any Intel by one exception, Intel i810/i815 will lack features since it has only 4Mb memory, support for it has been dropped by Mesa and Linux.
* ATI/AMD, only Radeon series with exception of recent last two years, Rage r128/match64 series has limited support.
* Nvidia: support for Nvidia GPUs is limited since their drivers are proprietary and built for GNU libc. Nouveau drivers are available as free alternative.
* Matrox: not all features are supported.
* Sis: limited features are supported, due to limited support from upstream.
* Via: limited features are supported, due to limited support from upstream.

== Software requirements ==

=== Media ===

Alpine boot images are provided on [https://alpinelinux.org/downloads/ downloads page] or on a [https://dl-cdn.alpinelinux.org/alpine/latest-stable/releases/ mirror]

The images should be verified as in [[Installation]], to ensure file wasn't corrupted during transfer.

=== Booting ===

Following table describes supported BIOS types, for more information please check [[Alpine_and_UEFI|Alpine and UEFI]] wiki page.

{| class="wikitable"
|-
! Supported Arch !! Supported BIOS !! Supported Types
|-
| x86_64 || Coreboot, Vendor/OEM || BIOS, UEFI
|-
| x86 || Coreboot, Vendor/OEM || BIOS, UEFI
|-
| ppc64le || Coreboot, Vendor/OEM || BIOS, UEFI
|-
| armhf || Uboot, Vendor/OEM || BIOS, UEFI
|-
| armv7 || Uboot, Vendor/OEM || BIOS, UEFI
|-
| aarch64 || Vendor/OEM || BIOS, UEFI
|-
| s390x || Vendor/OEM || unknown
|}

=== Space ===

A default installation of Alpine requires at least 1GB of free space. You can see various partition configurations and it's sizes on [[Alpine_and_UEFI#Alpine_disk_layout_for_UEFI|Alpine disk layout for UEFI/BIOS at Alpine and UEFI]] wiki page.

= See Also =

# [[Installation]]
# [[Alpine_newbie#Install|Alpine_newbie Install section]]

[[Category:Installation]]

__FORCETOC__