ladybird/Ports
Gunnar Beutner 4115fcc933 Ports: Build ports only once when running build_all.sh
Previously we'd end up building some ports multiple times, e.g.
as a dependency for another port. This changes the build_all.sh
script so that it builds ports only once.
2021-04-21 23:41:48 +02:00
..
bash Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
bc Ports: Fix 'bc' port 2021-03-14 11:30:38 +01:00
binutils Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
bison Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
byacc Meta: Get building on NixOS (#5005) 2021-01-22 17:44:05 +01:00
bzip2 Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
c-ray Ports: Consistently indent with four spaces 2021-04-20 18:38:13 +02:00
carl Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
chester Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
cmake Everywhere: Replace SERENITY_ROOT with SERENITY_SOURCE_DIR 2021-04-20 15:27:52 +02:00
cmatrix Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
curl Ports: Link curl against openssl and disable non-blocking I/O 2021-04-12 22:44:49 +02:00
dash Ports: Consistently indent with four spaces 2021-04-20 18:38:13 +02:00
dialog Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
diffutils Ports: Use ftpmirror.gnu.org mirror server for GNU ports 2021-04-15 09:30:42 +02:00
dmidecode Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
doom Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
dropbear Ports: Fix building the dropbear port 2021-04-11 09:51:20 +02:00
ed Ports: Consistently indent with four spaces 2021-04-20 18:38:13 +02:00
emu2 Ports: emu2: Bump version to 2021.01 2021-04-21 15:14:10 +02:00
figlet Ports: Fix ports when building with ccache 2021-04-19 18:27:09 +02:00
flatbuffers Everywhere: Replace SERENITY_ROOT with SERENITY_SOURCE_DIR 2021-04-20 15:27:52 +02:00
flex Meta: Get building on NixOS (#5005) 2021-01-22 17:44:05 +01:00
freetype Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
frotz Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
gcc Toolchain+Ports: Enable threads for gcc 2021-04-20 21:08:17 +02:00
genemu Everywhere: Replace SERENITY_ROOT with SERENITY_SOURCE_DIR 2021-04-20 15:27:52 +02:00
git Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
gmp Ports: Use ftpmirror.gnu.org mirror server for GNU ports 2021-04-15 09:30:42 +02:00
gnucobol Ports: Use ftpmirror.gnu.org mirror server for GNU ports 2021-04-15 09:30:42 +02:00
gnupg Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
gnuplot Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
grep Ports: Use ftpmirror.gnu.org mirror server for GNU ports 2021-04-15 09:30:42 +02:00
hatari Ports: Consistently indent with four spaces 2021-04-20 18:38:13 +02:00
imgcat Ports: Fix up imgcat 2021-04-20 17:32:10 +02:00
indent Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
jot Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
jq Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
klong Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
less Ports: Use ftpmirror.gnu.org mirror server for GNU ports 2021-04-15 09:30:42 +02:00
libarchive Ports: Link libarchive against pcre because the system's libregex doesn't support re_nsub 2021-04-14 21:46:20 +02:00
libassuan Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
libexpat Ports: Fix building the libexpat port 2021-04-11 09:51:20 +02:00
libffi Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
libgcrypt Ports: Add missing dependency for libgcrypt 2021-04-21 23:41:48 +02:00
libgpg-error Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
libiconv Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
libicu Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
libjpeg Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
libksba Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
libogg Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
libpng Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
libpuffy Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
libtiff Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
libtool Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
libvorbis Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
libzip Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
links Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
lua Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
m4 Ports: Use ftpmirror.gnu.org mirror server for GNU ports 2021-04-15 09:30:42 +02:00
make Ports: Use ftpmirror.gnu.org mirror server for GNU ports 2021-04-15 09:30:42 +02:00
mandoc Meta: Get building on NixOS (#5005) 2021-01-22 17:44:05 +01:00
mawk Meta: Get building on NixOS (#5005) 2021-01-22 17:44:05 +01:00
mbedtls Meta: Get building on NixOS (#5005) 2021-01-22 17:44:05 +01:00
mrsh Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
nano Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
nasm Ports: Fix the tarball hash for nasm 2021-04-18 16:35:00 +02:00
ncurses Ports: Fix ports when building with ccache 2021-04-19 18:27:09 +02:00
neofetch Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
nesalizer Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
nethack Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
ninja Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
npth Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
ntbtls Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
nyancat Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
oksh Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
openssh Ports: Consistently indent with four spaces 2021-04-20 18:38:13 +02:00
openssl Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
patch Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
pcre Ports: Add port for pcre 2021-04-14 21:46:20 +02:00
pcre2 Meta: Get building on NixOS (#5005) 2021-01-22 17:44:05 +01:00
pkgconf Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
printf Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
pt2-clone Everywhere: Replace SERENITY_ROOT with SERENITY_SOURCE_DIR 2021-04-20 15:27:52 +02:00
python3 Ports: Fix Python _crypt module linkage error 2021-04-21 23:35:35 +02:00
quake Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
rsync Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
scummvm Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
SDL2 Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
SDL2_gfx Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
SDL2_image Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
SDL2_mixer Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
SDL2_ttf Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
SDLPoP Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
sed Ports: Use ftpmirror.gnu.org mirror server for GNU ports 2021-04-15 09:30:42 +02:00
sl Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
sqlite Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
stress-ng Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
Super-Mario Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
termcap Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
tinycc Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
tinyscheme Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
tr Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
vim Ports: vim: Pin version to latest release rather than use master branch 2021-04-17 18:29:50 +02:00
vitetris Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
vttest Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
xz Ports: Build shared library for xz with -pthread 2021-04-20 21:08:17 +02:00
yasm Ports: patch config.sub instead of the configure script in the yasm port 2021-04-13 21:47:11 +02:00
zlib Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
zstd Meta: Get building on NixOS (#5005) 2021-01-22 17:44:05 +01:00
.gitignore Ports: Build most python3 extension modules statically 2021-02-02 16:53:06 +01:00
.hosted_defs.sh Everywhere: Replace SERENITY_ROOT with SERENITY_SOURCE_DIR 2021-04-20 15:27:52 +02:00
.port_include.sh Ports: Build ports only once when running build_all.sh 2021-04-21 23:41:48 +02:00
AvailablePorts.md Ports: emu2: Bump version to 2021.01 2021-04-21 15:14:10 +02:00
build_all.sh Ports: Build ports only once when running build_all.sh 2021-04-21 23:41:48 +02:00
build_installed.sh Ports: Replace hardcoded Build/ paths with SERENITY_BUILD_DIR 2021-03-11 21:01:29 +01:00
README.md Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00

Ports for SerenityOS

What's this?

Serenity has software patched to run on it. These shell scripts will allow you to build that sort of software, easily. Note that you must have already built Serenity, and be in a Serenity build environment.

Available ports

A list of all available ports can be found here.

Using ports scripts

Each port has a script called package.sh which defines a name and version, its dependencies, the required files that will be downloaded as well as configuration/compilation options, and some other things (see Writing ports scripts for details).

  • To install a certain port, cd into its directory and run ./package.sh
  • To install all available ports, run the build_all.sh script in this directory. Pass clean as first argument to remove old build files beforehand.
  • To reinstall all currently installed ports, run the build_installed.sh script in this directory. This is sometimes required when LibC changes, for example. Pass clean as first argument to remove old build files beforehand.

Installed ports are being tracked in Build/packages.db (a simple text file). You can delete this file at any time, in fact it must be edited or removed when clearing the build directory as port dependencies may not be installed again otherwise.

Not giving an option is equivalent to installdepends, fetch, patch, configure, build and install, in that order. This is recommended for a regular install.

Options

The following options are available:

fetch

By default, download, verify, and extract the port's files.

patch

Apply the port's patches (patches/*.patch). A file .foo_applied is created in workdir upon success to ensure a certain patch is only applied once.

configure

By default, run the port's configscript (usually configure) with configopts.

build

By default, run make with the port's makeopts.

install

By default, run make install with the port's installopts.

installdepends

Install all ports from the port's depends list.

clean

By default, remove all .out files from the port's workdir.

clean_dist

By default, remove everything that's been downloaded from the port's files list.

clean_all

By default, clean and clean_dist combined.

uninstall

Remove the port's files from the Serenity build directory, if it has a plist file.

--auto

Same as no option, but mark the port as having been installed automatically. This is used for dependencies.

Writing ports scripts

The package.sh file is a simple Bash script that's required for each port. Patches and other files are optional. The most basic version of such a port script simply defines some well-known variables and looks like this:

#!/usr/bin/env -S bash ../.port_include.sh

port="foo"
version="1.2.3"
useconfigure="true"
files="https://example.com/foo-${version}.tar.gz foo-${version}.tar.gz"
depends="bar baz"

The script in the shebang, .port_include.sh, is where all the magic happens.

Variables

The following variables have special functionality:

auth_import_key

PGP key to import (from keyserver.ubuntu.com) when auth_type is sig.

auth_opts

Options passed to gpg --verify when auth_type is sig.

Usually used like this:

auth_opts="foo-${version}.tar.xz.asc foo-${version}.tar.xz"

auth_type

The type of file validation to use, can be one of:

  • md5: Use MD5 hashes defined in files
  • sha256: Use SHA256 hashes defined in files
  • sha1: Use SHA1 hashes defined in files
  • sig: Use PGP signatures (see auth_opts)

Defaults to md5, most ports use sig though as .asc files are widely available.

configopts

Options passed to the port's configscript in the default configure function.

--host=i686-pc-serenity is always passed, override the configure function if that's undesirable.

configscript

Name of the script that will be run in the default configure function when useconfigure is true.

Defaults to configure.

depends

A space-separated list of other SerenityOS ports the port depends on and which will be installed during the installdepends step.

files

A list of external files required by the port, one per line. The format of each line is as follows:

URL NAME HASH

Where URL is the URL from where the file will be downloaded (using curl), NAME is the output name of the downloaded file, and HASH is an optional MD5, SHA1, or SHA256 hash that will be used for verification when auth_type is set to either of those hash functions.

For example:

files="https://example.com/foo-${version}.tar.xz foo-${version}.tar.xz
https://example.com/foo-${version}.tar.xz.asc foo-${version}.tar.xz.asc"

If a file is a compressed tar archive, a gzip compressed file or a zip compressed file, it will be extracted.

If a file is an .asc file (PGP signature) it will be imported into gpg's keyring and can later be used for verification using auth_opts.

installopts

Options passed to make install in the default install function.

DESTDIR="${SERENITY_INSTALL_ROOT}" ("${SERENITY_SOURCE_DIR}/Build/${SERENITY_ARCH}/Root") is always passed, override the install function if that's undesirable.

makeopts

Options passed to make in the default build function.

Defaults to -j$(nproc).

patchlevel

The value for patch's -p / --strip option, see man patch for details.

Defaults to 1.

port

The "package name" of the port, usually the same as the directory this script is placed in.

prefix

The location of the ports directory, only used for the package.db file for now. Don't override this in ports contributed to Serenity.

Defaults to $SERENITY_SOURCE_DIR/Ports.

useconfigure

The configure step will run pre_configure and configure when this is set to true, and simply skip them otherwise.

Defaults to false.

version

The version of the port. Written to package.db, and usually used with variable interpolation in files where the version is part of the filename.

workdir

The working directory used for executing other commands via run as well as cleanup. Usually the directory name of the upacked source archive.

Defaults to $port-$version.

Functions

The various steps of the port installation process are split into individual Bash functions, some of which can be overridden to provide custom behaviour, like this:

build() {
    run mybuildtool --foo --bar
}

The following can be overridden, the names should be self-explanatory as they mostly match the available options:

  • post_fetch
  • pre_configure
  • configure.
  • build
  • install
  • post_install
  • clean
  • clean_dist
  • clean_all

A few (non-overridable) util functions are available as well:

run

Log the command and run it in the port's workdir.

run_nocd

Log the command and run it in the current working directory (i.e. Ports/$port).

run_replace_in_file

Replace something in a file (using a Perl regular expression), like this:

run_replace_in_file "s/define FOO 1/undef FOO/" config.h

How do I contribute?

You can either:

  • Add new ports - just get the software to build and add the necessary patches and package.sh script
  • Update an existing port: bumping its version, getting functionality to work that wasn't available so far etc. Make sure to update the patches accordingly.

Some videos of Andreas adding new ports can be found on YouTube, they might help you understand how this usually works: