Commit | Line | Data |
---|---|---|
4edf9992 FF |
1 | Termux packages |
2 | =============== | |
006983b2 | 3 | [![Join the chat at https://gitter.im/termux/termux](https://badges.gitter.im/termux/termux.svg)](https://gitter.im/termux/termux) |
5b9b57e3 | 4 | |
6dd45156 FF |
5 | This project contains scripts and patches to build packages for the |
6 | [Termux](https://termux.com/) Android application. | |
798619b9 | 7 | |
1a8d12c2 FF |
8 | License |
9 | ======= | |
a7dfa85f FF |
10 | The scripts and patches to build each package is licensed under the same license as |
11 | the actual package (so the patches and scripts to build bash are licensed under | |
12 | the same license as bash, while the patches and scripts to build python are licensed | |
6dd45156 | 13 | under the same license as python). |
88183689 FF |
14 | |
15 | Build environment on Ubuntu 16.04 | |
16 | ================================= | |
6dd45156 | 17 | Packages are built using Ubuntu 16.04. Perform the following steps to configure a Ubuntu 16.04 installation: |
1773070c | 18 | |
6dd45156 | 19 | - Run `scripts/setup-ubuntu.sh` to install required packages and setup the `/data/` folder. |
1773070c | 20 | |
6dd45156 | 21 | - Run `scripts/setup-android-sdk.sh` to install the Android SDK and NDK at `$HOME/lib/android-{sdk,ndk}`. |
1773070c | 22 | |
88183689 FF |
23 | Build environment using Docker |
24 | ============================== | |
6dd45156 | 25 | On other Linux distributions than Ubuntu 16.04 (or on other platforms than Linux) the best course |
1a8d12c2 | 26 | of action is to setup a Docker container for building packages by executing: |
1773070c | 27 | |
88183689 | 28 | ./scripts/run-docker.sh |
1a8d12c2 | 29 | |
6dd45156 FF |
30 | This will setup a container (from an image created by [scripts/Dockerfile](scripts/Dockerfile)) |
31 | suitable for building packages. | |
5e8045c9 | 32 | |
6dd45156 FF |
33 | This source folder is mounted as the /root/termux-packages data volume, so changes are kept |
34 | in sync between the host and the container when trying things out before committing, and built | |
35 | deb files will be available on the host in the `debs/` directory just as when building on the host. | |
5e8045c9 | 36 | |
a0057943 FF |
37 | Build commands can be given to be executed in the docker container directly: |
38 | ||
39 | ./scripts/run-docker.sh ./build-package.sh libandroid-support | |
40 | ||
41 | will launch the docker container, execute the `./build-package.sh libandroid-support` | |
42 | command inside it and afterwards return you to the host prompt, with the newly built | |
43 | deb in `debs/` to try out. | |
5e8045c9 | 44 | |
9ecaa95d FF |
45 | Building a package |
46 | ================== | |
88183689 | 47 | The basic build operation is to run `./build-package.sh $PKG`, which: |
798619b9 | 48 | |
6dd45156 | 49 | 1. Sets up a patched stand-alone Android NDK toolchain if necessary. |
9ecaa95d | 50 | |
6dd45156 | 51 | 2. Reads `packages/$PKG/build.sh` to find out where to find the source code of the package and how to build it. |
a0057943 | 52 | |
6dd45156 | 53 | 3. Extracts the source in `$HOME/.termux-build/$PKG/src`. |
9ecaa95d | 54 | |
6dd45156 | 55 | 4. Applies all patches in packages/$PKG/\*.patch. |
9ecaa95d | 56 | |
6dd45156 | 57 | 5. Builds the package under `$HOME/.termux-build/$PKG/` (either in the build/ directory there or in the |
a0057943 FF |
58 | src/ directory if the package is specified to build in the src dir) and installs it to `$PREFIX`. |
59 | ||
6dd45156 | 60 | 6. Extracts modified files in `$PREFIX` into `$HOME/.termux-build/$PKG/massage` and massages the |
a0057943 | 61 | files there for distribution (removes some files, splits it up in sub-packages, modifies elf files). |
9ecaa95d | 62 | |
6dd45156 | 63 | 7. Creates a deb package file for distribution in `debs/`. |
1773070c | 64 | |
6dd45156 | 65 | Reading [build-package.sh](build-package.sh) is the best way to understand what is going on. |
798619b9 | 66 | |
9ecaa95d FF |
67 | Additional utilities |
68 | ==================== | |
88183689 | 69 | * build-all.sh: used for building all packages in the correct order (using buildorder.py). |
9ecaa95d | 70 | |
88183689 | 71 | * clean-rebuild-all.sh: used for doing a clean rebuild of all packages. |
9ecaa95d | 72 | |
88183689 | 73 | * scripts/check-pie.sh: Used for verifying that all binaries are using PIE, which is required for Android 5+. |
9ecaa95d | 74 | |
88183689 | 75 | * scripts/detect-hardlinks.sh: Used for finding if any packages uses hardlinks, which does not work on Android M. |
9ecaa95d | 76 | |
88183689 | 77 | * scripts/check-versions.sh: used for checking for package updates. |
9ecaa95d | 78 | |
88183689 | 79 | * scripts/list-packages.sh: used for listing all packages with a one-line summary. |
798619b9 FF |
80 | |
81 | ||
1a8d12c2 FF |
82 | Resources |
83 | ========= | |
84 | * [Android changes for NDK developers](https://android.googlesource.com/platform/bionic/+/master/android-changes-for-ndk-developers.md) | |
85 | ||
40dcead0 | 86 | * [Linux From Scratch](http://www.linuxfromscratch.org/lfs/view/stable/) |
798619b9 | 87 | |
88183689 | 88 | * [Beyond Linux From Scratch](http://www.linuxfromscratch.org/blfs/view/stable/) |
798619b9 | 89 | |
88183689 | 90 | * [Cross-Compiled Linux From Scratch](http://www.clfs.org/view/CLFS-3.0.0-SYSVINIT/mips64-64/) |
798619b9 | 91 | |
88183689 | 92 | * [OpenWrt](https://openwrt.org/) as an embedded Linx distribution contains [patches and build scripts](https://dev.openwrt.org/browser/packages) |
798619b9 | 93 | |
88183689 | 94 | * http://dan.drown.org/android contains [patches for cross-compiling to Android](http://dan.drown.org/android/src/) as well as [work notes](http://dan.drown.org/android/worknotes.html), including a modified dynamic linker to avoid messing with `LD_LIBRARY_PATH`. |
798619b9 | 95 | |
88183689 | 96 | * [Kivy recipes](https://github.com/kivy/python-for-android/tree/master/pythonforandroid/recipes) contains recipes for building packages for Android. |
798619b9 FF |
97 | |
98 | ||
99 | Common porting problems | |
100 | ======================= | |
6dd45156 | 101 | * The Android bionic libc does not have iconv and gettext/libintl functionality built in. A package from the NDK, libandroid-support, contains these and may be used by all packages. |
798619b9 FF |
102 | |
103 | * "error: z: no archive symbol table (run ranlib)" usually means that the build machines libz is used instead of the one for cross compilation, due to the builder library -L path being setup incorrectly | |
104 | ||
105 | * rindex(3) is defined in <strings.h> but does not exist in NDK, but strrchr(3) from <string.h> is preferred anyway | |
106 | ||
107 | * <sys/termios.h> does not exist, but <termios.h> is the standard location. | |
108 | ||
109 | * <sys/fcntl.h> does not exist, but <fcntl.h> is the standard location. | |
110 | ||
3b8f4313 | 111 | * glob(3) system function (glob.h) - not in bionic, but use the `libandroid-glob` package |
798619b9 | 112 | |
88183689 FF |
113 | * [Cmake and cross compiling](http://www.cmake.org/Wiki/CMake_Cross_Compiling). |
114 | `CMAKE_FIND_ROOT_PATH=$TERMUX_PREFIX` to search there. | |
115 | `CMAKE_FIND_ROOT_PATH_MODE_LIBRARY=ONLY` and `CMAKE_FIND_ROOT_PATH_MODE_INCLUDE=ONLY` | |
798619b9 FF |
116 | for only searching there and don't fall back to build machines |
117 | ||
118 | * Android is removing sys/timeb.h because it was removed in POSIX 2008, but ftime(3) can be replaced with gettimeofday(2) | |
119 | ||
120 | * mempcpy(3) is a GNU extension. We have added it to <string.h> provided TERMUX_EXPOSE_MEMPCPY is defined, | |
121 | so use something like CFLAGS+=" -DTERMUX_EXPOSE_MEMPCPY=1" for packages expecting that function to exist. | |
122 | ||
798619b9 FF |
123 | dlopen() and RTLD_* flags |
124 | ================================= | |
29db5b35 | 125 | <dlfcn.h> originally declares |
798619b9 | 126 | |
9ecaa95d FF |
127 | enum { RTLD_NOW=0, RTLD_LAZY=1, RTLD_LOCAL=0, RTLD_GLOBAL=2, RTLD_NOLOAD=4}; // 32-bit |
128 | enum { RTLD_NOW=2, RTLD_LAZY=1, RTLD_LOCAL=0, RTLD_GLOBAL=0x00100, RTLD_NOLOAD=4}; // 64-bit | |
798619b9 FF |
129 | |
130 | These differs from glibc ones in that | |
131 | ||
88183689 | 132 | 1. They are not preprocessor #define:s so cannot be checked for with `#ifdef RTLD_GLOBAL`. Termux patches this to #define values for compatibility with several packages. |
798619b9 | 133 | 2. They differ in value from glibc ones, so cannot be hardcoded in files (DLFCN.py in python does this) |
29db5b35 | 134 | 3. They are missing some values (`RTLD_BINDING_MASK`, `RTLD_NOLOAD`, ...) |
798619b9 | 135 | |
88183689 FF |
136 | RPATH, RUNPATH AND LD\_LIBRARY\_PATH |
137 | ==================================== | |
798619b9 | 138 | On desktop linux the linker searches for shared libraries in: |
1ddf1728 | 139 | |
88183689 FF |
140 | 1. `RPATH` - a list of directories which is linked into the executable, supported on most UNIX systems. It is ignored if `RUNPATH` is present. |
141 | 2. `LD_LIBRARY_PATH` - an environment variable which holds a list of directories | |
142 | 3. `RUNPATH` - same as `RPATH`, but searched after `LD_LIBRARY_PATH`, supported only on most recent UNIX systems | |
1ddf1728 | 143 | |
1a8d12c2 | 144 | The Android linker, /system/bin/linker, does not support RPATH or RUNPATH, so we set `LD_LIBRARY_PATH=$PREFIX/lib` and try to avoid building useless rpath entries (which the linker warns about) with --disable-rpath configure flags. NOTE: Starting from Android 7.0 RUNPATH (but not RPATH) is supported. |
798619b9 FF |
145 | |
146 | Warnings about unused DT entries | |
147 | ================================ | |
1a8d12c2 | 148 | Starting from 5.1 the Android linker warns about VERNEED (0x6FFFFFFE) and VERNEEDNUM (0x6FFFFFFF) ELF dynamic sections (WARNING: linker: $BINARY: unused DT entry: type 0x6ffffffe/0x6fffffff). These may come from version scripts (`-Wl,--version-script=`). The termux-elf-cleaner utilty is run from build-package.sh and should normally take care of that problem. NOTE: Starting from Android 6.0 symbol versioning is supported. |