ladybird/Ports
Linus Groh c1b2813ddf Ports: Only do build check for configure, build, and install steps
This was breaking ports linting, which runs the script with the
'showproperty' option. This check is not needed for some other options
as well, so let's do it conditionally.
2021-05-20 20:04:58 +01:00
..
bash Ports: Fix detection for -ldl 2021-04-25 10:14:50 +02:00
bc Ports: Fix 'bc' port 2021-03-14 11:30:38 +01:00
binutils Ports: Update binutils to version 2.36.1 2021-04-29 10:33:44 +02:00
bison Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
brogue Ports: Add port for Brogue (BrogueCE) 2021-05-15 10:13:43 +01:00
byacc Meta: Get building on NixOS (#5005) 2021-01-22 17:44:05 +01:00
bzip2 Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
c-ray Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
carl Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
chester Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
cmake Ports: Remove IPv6 patches for cmake 2021-05-09 21:16:11 +02:00
cmatrix Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
curl Ports: Update build options for curl 2021-05-09 23:47:37 +01:00
dash Ports: Add missing SHA256 hashes to dash and zstd 2021-04-25 23:30:38 +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: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
dropbear Ports: Remove obsolete patch for dropbear 2021-05-09 17:25:41 +01: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
ffmpeg Ports: Add missing .so extension for ffmpeg library SONAMEs 2021-05-09 17:26:50 +01:00
figlet Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
flatbuffers Ports: Remove obsolete patch for flatbuffers 2021-05-10 20:39:19 +02:00
flex Meta: Get building on NixOS (#5005) 2021-01-22 17:44:05 +01:00
freetype Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
frotz Ports: Use a specific version for frotz 2021-04-23 11:33:03 +02:00
gcc Toolchain+Ports: Skip link tests for libstdc++v3 2021-05-09 15:35:01 +02:00
genemu Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
gettext Ports: Add libiconv dependency to gettext 2021-05-15 09:01:55 +02:00
git Ports: Add missing curl dependency for the git port 2021-05-10 17:44:18 +01: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: Fix detection for -ldl 2021-04-25 10:14:50 +02:00
gnuplot Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
grep Ports: Use ftpmirror.gnu.org mirror server for GNU ports 2021-04-15 09:30:42 +02:00
harfbuzz Ports: Add port for harfbuzz 2021-05-08 19:13:42 +02:00
hatari Ports: Fix hatari install step 2021-05-01 23:22:27 +02:00
imgcat Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
indent Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
jot Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
jq Ports: Add auth_type verification to all package.sh files 2021-04-16 21:14:00 +02:00
klong Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +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: Build shared libraries for the GnuPG libraries 2021-05-19 22:45:02 +02:00
libexpat Ports: Fix building the libexpat port 2021-04-11 09:51:20 +02:00
libffi Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
libgcrypt Ports: Build shared libraries for the GnuPG libraries 2021-05-19 22:45:02 +02:00
libgpg-error Ports: Build shared libraries for the GnuPG libraries 2021-05-19 22:45:02 +02:00
libiconv Ports: Build shared libraries with -Wl,-soname 2021-04-25 10:14:50 +02:00
libicu Ports: Fix building the libicu port 2021-05-12 08:37:07 +01:00
libjpeg Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
libksba Ports: Build shared libraries for the GnuPG libraries 2021-05-19 22:45:02 +02:00
libogg Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
libopenal Ports: Add port for libopenal 2021-05-09 17:26:50 +01:00
libphysfs Ports: Add port for libphysfs 2021-05-08 18:11:52 +02:00
libpng Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
libpuffy Ports: Fix building libpuffy 2021-05-01 22:52:15 +02:00
libsodium Ports: Add port for libsodium 2021-05-08 18:12:01 +02:00
libtheora Ports: Add libtheora 2021-04-27 22:31:07 +02:00
libtiff Ports: Link libtiff against libjpeg 2021-05-08 19:14:09 +02:00
libtool Ports: Improve consistency and quality of ports 2021-04-20 18:20:00 +02:00
libvorbis Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
libzip Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
links Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
lua Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +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 Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
milkytracker Ports: Remove SDL Timer replacement in MilkyTracker 2021-04-30 09:26:12 +02:00
mrsh Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +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 WindowServer: Move configuration file to /etc/WindowServer.ini 2021-04-29 22:16:18 +02:00
nesalizer Ports: Fix version numbers for some of the ports 2021-04-23 16:11:48 +02:00
nethack Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
ninja Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
npth Ports: Build shared libraries for the GnuPG libraries 2021-05-19 22:45:02 +02:00
ntbtls Ports: Build shared libraries for the GnuPG libraries 2021-05-19 22:45:02 +02:00
nyancat Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
oksh Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
openssh Ports: Remove dns and getpw pledges for the OpenSSH client 2021-05-18 16:33:48 +02:00
openssl Ports: Fix detection for -ldl 2021-04-25 10:14:50 +02:00
openttd Ports: Add missing dependencies for openttd 2021-05-12 08:37:07 +01:00
openttd-opengfx Ports: Add openttd 2021-04-23 20:15:49 +02:00
openttd-opensfx Ports: Add openttd 2021-04-23 20:15:49 +02:00
patch Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +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: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
printf Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
pt2-clone Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
python3 Ports: Add note about Python webbrowser patch upstreaming 2021-05-09 17:15:15 +01:00
quake Ports: Add launchers for some of the ports 2021-04-23 11:33:57 +02:00
quake2 Ports: QuakeII port 2021-04-30 11:35:17 +02:00
readline Ports: Add readline 2021-04-25 17:29:28 +02:00
rsync Ports: Remove unused signature file for the rsync port 2021-04-29 01:12:55 +02:00
scummvm Ports/scummvm: Add libtheora as a dependency 2021-04-27 22:31:07 +02:00
SDL2 Ports: Fix version numbers for some of the ports 2021-04-23 16:11:48 +02:00
SDL2_gfx Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
SDL2_image Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
SDL2_mixer Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
SDL2_ttf Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
SDL2-GNUBoy Ports: SDL2-GNUBoy shouldn't try to link against host libs 2021-05-08 00:30:30 +01:00
SDLPoP Ports: Add launchers for some of the ports 2021-04-23 11:33:57 +02:00
sed Ports: Use ftpmirror.gnu.org mirror server for GNU ports 2021-04-15 09:30:42 +02:00
sl Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
sqlite Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
stress-ng Ports: Remove obsolete patches for stress-ng 2021-05-09 21:16:11 +02:00
Super-Mario Ports: Make Super Mario work with GCC 11 2021-04-29 10:33:44 +02:00
tcl Ports: Fix path for the tcl port's patch file 2021-04-27 17:59:52 +02:00
termcap Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
tinycc Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
tinyscheme Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
tr Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
vim Ports: Add missing dependency for vim 2021-05-11 13:13:08 +01:00
vitetris Ports: Add launchers for some of the ports 2021-04-23 11:33:57 +02:00
vttest Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
xz Ports: Build shared libraries with -Wl,-soname 2021-04-25 10:14:50 +02:00
yasm Ports: Fix the SHA256 checksum for the yasm port 2021-04-29 09:29:53 +02:00
zlib Ports: Build shared libraries with -Wl,-soname 2021-04-25 10:14:50 +02:00
zstd Ports: Add missing SHA256 hashes to dash and zstd 2021-04-25 23:30:38 +02:00
.gitignore Ports: Build most python3 extension modules statically 2021-02-02 16:53:06 +01:00
.hosted_defs.sh Ports: Use HOST_PATH when updating the PATH variable 2021-04-27 18:01:43 +02:00
.port_include.sh Ports: Only do build check for configure, build, and install steps 2021-05-20 20:04:58 +01:00
AvailablePorts.md Ports: Add port for Brogue (BrogueCE) 2021-05-15 10:13:43 +01:00
build_all.sh Ports: Detect more types of errors in the AvailablePorts.md file 2021-04-23 16:11: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: Update the packages.db directory in README 2021-05-16 22:52:51 +01: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/i686/Root/usr/Ports/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: