Skip to content

Configurable env.sh variables

Jump to bottom
Jami Kettunen edited this page Dec 28, 2022 · 6 revisions

Mandatory

Variable Meaning Examples
VENDOR Device vendor name oneplus, xiaomi, samsung
VENDOR_PRETTY Device vendor fancy name OnePlus, Xiaomi, Samsung
DEVICE Device board name dumpling, sagit, espressowifi
DEVICE_PRETTY Device board fancy name 5T, Mi 6, Galaxy Tab 2 (Wi-Fi)
PORT_ARCH Architecture to use for userspace, should matches the device's CPU or its 32-bit variant aarch64, armv7hl, i486
PORT_TYPE Distinguish between native Linux and Android HAL based ports, only hybris is tested extensively for now hybris, native
RELEASE Sailfish OS release to build a rootfs for 4.3.0.12, 4.2.0.21
SOC Manufacturer of the SoC (system on a chip) or CPU, unused by sfbootstrap for now qcom, mediatek, other
HYBRIS_VER (For hybris PORT_TYPE's) base LineageOS version number 15.1, 16.0, 17.1

Optional

Variable Meaning Examples
ANDROID_MAJOR_VERSION Major Android HAL version number, defaults to derived value from $HYBRIS_VER 8, 9, 10
HABUILD_DEVICE Device codename during hybris HAL builds, defaults to $DEVICE dumpling, sagit, espressowifi
HOOKS_DEVICE Device dir to use hooks from, defaults to $SFB_DEVICE (which normally is $VENDOR-$DEVICE) cheeseburger
REPO_INIT_URL hybris HAL manifest repo URL to repo init, defaults to https://github.com/mer-hybris/android.git -
HAL_MAKE_TARGETS Which HAL targets to make for hybris ports, defaults to hybris-hal droidmedia hybris-hal droidmedia libbiometry_fp_api hwcrypt
TOOLING_RELEASE Tooling Sailfish OS release to build packages and rootfs with, defaults to $RELEASE; http://releases.sailfishos.org/sdk/targets/ latest, 4.3.0.12, 4.2.0.21
SDK_RELEASE Sailfish OS SDK chroot release, defaults to latest; http://releases.sailfishos.org/sdk/installers/ latest, 3.8.3
REPO_LOCAL_MANIFESTS_URL Repo URL to clone to $ANDROID_ROOT/.repo/local_manifests; the branch cloned is hybris-$HYBRIS_VER, e.g. hybris-12.1 https://github.com/mer-hybris/local_manifests
HYBRIS_PATCHER_SCRIPTS List of patcher scripts to run in HAL build chroot in the following repeated format: <patcher_script_path_with_args> <applied_check_command>; hybris-patches is added by default on Android 9+ ports 'hybris-patches/apply-patches.sh --mb' 'grep -q droid-hybris system/core/init/init.cpp'
HAL_ENV_EXTRA Extra command(s) to run before make in hybris HAL builds export USE_CCACHE=1, export USE_NINJA=false
REPOS List of repositories to clone into $ANDROID_ROOT in the following repeated format: <url> <path> <branch> <shallow_clone>, where <branch> may be an empty string for the default branch and <shallow_clone> being 1 or 0 representing whether to do a --depth 1 clone or not 'https://github.com/mer-hybris/libhybris.git' external/libhybris '' 0
REPO_OVERRIDES List of manifest project names to generate a remove-project entry for; creates a sfbootstrap-overrides.xml local manifest 'mer-hybris/hybris-boot'
LINKS List of labels and links to show in sfbootstrap's status function in the following repeated format: <label> <link>, where <label> may be an empty string 'Sources' 'https://github.com/sailfishos-oneplus5'
Clone this wiki locally