Sortix cross-nightly manual

This manual documents Sortix cross-nightly. You can instead view this document in the latest official manual.

NAME

cross-development — operating system development from another operating system

DESCRIPTION

The development(7) manual page describes the primary way of building the operating system, which is under itself. The secondary way is to cross-compile it from a sufficiently similar operating system such as Linux with the GNU tools installed. The build system assumes the presence of some GNU extensions in the standard command line tools. This document will detail the process of bootstrapping a Sortix system from another operating system.

Be sure you are reading the latest version of this document, rather than an old copy installed on the system or on an online manual page viewer, if you want to build the latest development code rather than the stable release. To view the instructions for the latest source code using the command line:

    cd /latest/source/code && 
    man share/man/man7/cross-development.7

Overview

To build Sortix you need to get these programs from your operating system vendor or compile them yourself:

GRUB (for iso creation)
xorriso (for iso creation)
mtools (for iso creation) (if on UEFI systems)
mandoc (for html manuals if building a release directory)

GRUB with BIOS support is required. If you are on an UEFI system, you may need to install further files to get BIOS support. For instance, on an apt-based system you might install the grub-pc-bin package.

The overall process is:

Retrieving the source code.
Installing the build tools.
Creating a cross-compiler.
Cross-compiling the operating system.

Source Code

You can find the latest Sortix source code at https://sortix.org/source/

The source code for the ports are in the ports subdirectory as URLs to the upstream tarball, alongside any patches to the upstream release, which are downloaded when each port is built.

Variables

This document will use meta-syntactic shell variables to denote where you have choice. These are simply convenient shorthands that lets this document refer to your choices. You shouldn't use real shell variables but just textually replace them with your choices when you run commands.

The following sections describe these variables in detail.

Sortix Directory

You can put the Sortix source code wherever you'd like. It is typically git cloned from your home directory and the source code will appear in ~/sortix. This place will contain the operating system code. We'll refer to that location as $SORTIX.

Don't make a sortix directory and git clone inside it, you redundantly get a ~/sortix/sortix directory instead.

Target Platform

You need to decide what the platform your final Sortix system will run on. You can currently decide between i686-sortix and x86_64-sortix. In this guide we will refer to that platform triplet as $SORTIX_PLATFORM. If you want to build another platform afterwards, then repeat the steps with the other platform.

Cross-Prefix

You should install your cross-toolchain into a useful and isolated directory such as $HOME/opt/sortix-toolchain. This allows you to easily dispose of the directory and keeps it isolated from the rest of the system. We'll refer to that location as $CROSS_PREFIX.

PATH

You need to add $CROSS_PREFIX/bin and $CROSS_PREFIX/sbin to your PATH variable:

    export PATH="$CROSS_PREFIX/sbin:$CROSS_PREFIX/bin:$PATH"

This will modify the PATH variable in this particular shell session. You can make this permanent by adding that line to your ~/.profile or the applicable file for your shell and system. Consult your shell documentation. Otherwise type it in all Sortix-related shells before doing anything.

Cross-toolchain Dependencies

You need to install these libraries (and the development packages) before building binutils and gcc:

bison
flex
libgmp
libmpfr
libmpc

Consult the official binutils and gcc documentation for the exact dependencies.

Cross-toolchain

You can build the full cross-toolchain containing the build tools and the cross-compiler (binutils and gcc) by running:

    cd "$SORTIX" && 
    make clean-cross-toolchain && 
    make PREFIX="$CROSS_PREFIX" TARGET=$SORTIX_PLATFORM install-cross-toolchain

This command builds and installs the build tools and the cross-compiler. The build downloads the source code for binutils and gcc modified with support for this operating system.

If you want to build a toolchain for every architecture at once, use the install-cross-toolchain-all-archs makefile target instead and omit the TARGET variable.

following-development(7) gains a notice whenever the build tools or cross-compiler must be upgraded.

Build Tools

The above install-cross-toolchain command already built the build tools needed to bootstrap the operating system.

However, whenever they change you can reinstall the build utilities only by running:

    cd "$SORTIX" && 
    make clean-build-tools && 
    make PREFIX="$CROSS_PREFIX" install-build-tools

following-development(7) gains a notice whenever the build tools must be upgraded, as they must match the source code being built.

Building Sortix

With the build tools and cross-compiler in the PATH is it now possible to build the operating system as described in development(7) by setting HOST to your value of $SORTIX_PLATFORM. This tells the build system you are cross-compiling and it will run the appropriate cross-compiler. For instance, to build an bootable cdrom image using a x86_64-sortix cross-compiler you can run:

    cd "$SORTIX" && 
    make HOST=x86_64-sortix sortix.iso

This creates a bootable sortix.iso including all ports of third party software. To build only the minimal set of ports required for installation, set the PACKAGES environment variable to minimal! or set it to the empty string to only build the base system. Cross-compiling the ports requires installing additional dependencies locally in order to bootstrap the cross-compilation of some ports.

Additional Required Reading

The development(7) manual page documents how to develop Sortix and how to use the build system. This manual page only documents how to set up a cross-development environment and is not sufficient to develop Sortix.

The following-development(7) manual page documents what needs to be done to stay updated with the latest developments. You will need to read the new version of that document whenever you update the source code.

Troubleshooting

If producing a bootable cdrom with grub-mkrescue(1) gives the error

xorriso: FAILURE: Cannot find path '/efi.img' in loaded ISO image

then your GRUB installation is defective. You need to install mformat(1) to use grub-mkrescue(1) in your case.