ladybird/Ports
Jelle Raaijmakers 28e0aa59a8 Ports: Register all dependencies of ports
Previously, only `manual` installs would register dependencies of an
installed port package. Since in the future we might want to check all
dependents, not only those for manually installed packages, we should
take care to register dependencies for `auto` installs as well.

Additionally, this surpresses some unnecessary verbose output from the
package management and fixes warnings when the package DB directory did
not yet exist.
2021-10-21 14:48:21 +01:00
..
angband Ports: Add an Angband port :^) 2021-10-17 12:40:48 +01:00
Another-World Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
bash Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
bass Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
bc Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
binutils Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
bison Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
brogue Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
byacc Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
bzip2 Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
c-ray Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
carl Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
chester Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
cmake Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
cmatrix Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
composer Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
curl Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
dash Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
dialog Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
diffutils Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
dmidecode Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
doom Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
dosbox-staging Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
drascula Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
dreamweb Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
dropbear Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
dungeonrush Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
ed Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
emu2 Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
epsilon Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
ffmpeg Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
figlet Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
flatbuffers Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
flex Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
fotaq Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
freeciv Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
freetype Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
frotz Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
gawk Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
gcc Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
genemu Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
gettext Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
git Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
glib Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
gmp Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
gnucobol Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
gnupg Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
gnuplot Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
grep Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
griffon Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
gsl Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
harfbuzz Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
hatari Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
imgcat Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
indent Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
jot Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
jq Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
klong Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
less Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libarchive Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libassuan Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libatomic_ops Ports: Add libatomic_ops 2021-08-21 13:16:51 +01:00
libexpat Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libffi Ports: Bump libffi from version 3.3 to 3.4.2 2021-07-19 10:45:47 +02:00
libgcrypt Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libgpg-error Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libiconv Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libicu Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libjpeg Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libksba Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libmodplug Ports: Fix issues with the libmodplug and SDL_sound ports 2021-10-10 19:11:02 -07:00
libogg Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libopenal Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libphysfs Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libpng Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libpuffy Ports: Fix building libpuffy 2021-05-01 22:52:15 +02:00
libsixel Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libsodium Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libtheora Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libtiff Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libtool Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libuuid Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libuv Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libvorbis Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libxml2 Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
libzip Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
links Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
llvm Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
lua Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
lure Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
m4 Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
make Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
mandoc Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
mawk Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
mbedtls Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
milkytracker Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
mpc Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
mpfr Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
mrsh Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
mruby Ports: Add port for mruby 2021-08-25 02:22:01 +02:00
mysthous Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
nano Ports: Fix nano authentication options splitting 2021-10-11 00:37:02 +01:00
nasm Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
ncdu Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
ncurses Ports: Provide designated wide-char versions of ncurses 2021-10-17 12:40:48 +01:00
neofetch Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
nesalizer Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
nethack Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
ninja Ports: Remove obsolete patches for ninja 2021-07-04 00:35:35 +02:00
nippon Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
npth Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
ntbtls Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
nyancat Ports: Use "launcher_run_in_terminal=true" instead of "Terminal -e ..." 2021-07-20 00:58:26 +01:00
oksh Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
openssh Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
openssl Ports: Compile OpenSSL with threads and as a shared library 2021-10-05 15:35:48 +01:00
openttd Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02: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
opentyrian Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
opentyrian-data Ports: Add opentyrian and opentyrian-data 2021-05-31 19:01:49 +01:00
p7zip Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
patch Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
pcre Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
pcre2 Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
php Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
pkgconf Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
printf Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
pt2-clone Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
python3 Ports: Patch Python to deal with Serenity's strftime 2021-10-06 13:57:52 +01:00
quake Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
quake2 Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
r0 Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
radare2 Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
readline Ports: Use sha256 sig check for readline 2021-07-29 15:58:38 +02:00
rsync Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
ruby Ports: Use ruby irb legacy mode 2021-10-15 21:56:06 -07:00
sam Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
scummvm Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
SDL2 Ports: Fix dependencies for SDL2 2021-10-16 15:36:04 -07:00
SDL2_gfx Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
SDL2_image Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
SDL2_mixer Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
SDL2_net Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
SDL2_ttf Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
SDL2-GNUBoy Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
SDL_sound Ports: Fix issues with the libmodplug and SDL_sound ports 2021-10-10 19:11:02 -07:00
SDLPoP Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
sed Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
sfinx Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
sl Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
soltys Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
sqlite Ports: Build an .so file for SQLite 2021-06-09 20:04:25 +02:00
stpuzzles Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
stress-ng Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
Super-Mario Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
tcl Ports: Fix path for the tcl port's patch file 2021-04-27 17:59:52 +02:00
termcap Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
tinycc Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
tinyscheme Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
tr Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
vim Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
vitetris Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
vlang Ports: Bump vlang version to weekly.2021.31 2021-08-14 20:28:55 +02:00
vttest Ports: Update checksums to use the SHA256 algorithm 2021-04-25 13:30:18 +02:00
wget Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
xz Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
yasm Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
zlib Ports: Make array-like settings actual arrays 2021-10-05 02:13:08 +02:00
zsh Ports: Add ZSH port 2021-06-09 19:41:23 +01: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: Make it possible to build (some) ports with Clang 2021-10-17 17:09:58 +01:00
.port_include.sh Ports: Register all dependencies of ports 2021-10-21 14:48:21 +01:00
AvailablePorts.md Ports: Add an Angband port :^) 2021-10-17 12:40:48 +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: Add overridable pre_fetch method in .port_include.sh 2021-07-22 22:30:55 +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/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.

shell

Open a shell in the $workdir with the build environment set.

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.

icon_file

The file to use for the port launcher icon. The icon file is assumed to have a 16x16 as well as a 32x32 layer.

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:

  • pre_fetch
  • 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: