Refactor build of tty-clock (#685)
[termux-packages] / README.md
index 9e50328..c1386be 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,28 +5,30 @@ Termux packages
 This project contains scripts and patches to build packages for the
 [Termux](https://termux.com/) Android application.
 
+License
+=======
 The scripts and patches to build each package is licensed under the same license as
 the actual package (so the patches and scripts to build bash are licensed under
 the same license as bash, while the patches and scripts to build python are licensed
 under the same license as python).
 
-Build environment on Ubuntu 16.04
+Build environment on Ubuntu 16.10
 =================================
-Packages are built using Ubuntu 16.04. Perform the following steps to configure a Ubuntu 16.04 installation:
+Packages are normally built using Ubuntu 16.10. Perform the following steps to configure a Ubuntu 16.10 installation:
 
 - Run `scripts/setup-ubuntu.sh` to install required packages and setup the `/data/` folder.
 
 - Run `scripts/setup-android-sdk.sh` to install the Android SDK and NDK at `$HOME/lib/android-{sdk,ndk}`.
 
+There is also a [Vagrantfile](scripts/Vagrantfile) available for setting up an Ubuntu environment using a virtual machine on other operating systems.
+
 Build environment using Docker
 ==============================
-On other Linux distributions than Ubuntu 16.04 (or on other platforms than Linux) the best course
-of action is to use Docker to setup a build environment.
-
-A Docker container for building packages can be setup with:
+On other Linux distributions than Ubuntu 16.10 (or on other platforms than Linux) the best course
+of action is to setup a Docker container for building packages by executing:
 
     ./scripts/run-docker.sh
-    
+
 This will setup a container (from an image created by [scripts/Dockerfile](scripts/Dockerfile))
 suitable for building packages.
 
@@ -42,7 +44,6 @@ will launch the docker container, execute the `./build-package.sh libandroid-sup
 command inside it and afterwards return you to the host prompt, with the newly built
 deb in `debs/` to try out.
 
-
 Building a package
 ==================
 The basic build operation is to run `./build-package.sh $PKG`, which:
@@ -65,7 +66,6 @@ The basic build operation is to run `./build-package.sh $PKG`, which:
 
 Reading [build-package.sh](build-package.sh) is the best way to understand what is going on.
 
-
 Additional utilities
 ====================
 * build-all.sh: used for building all packages in the correct order (using buildorder.py).
@@ -81,9 +81,11 @@ Additional utilities
 * scripts/list-packages.sh: used for listing all packages with a one-line summary.
 
 
-Resources about cross-compiling packages
-========================================
-* [Linux From Scratch](http://www.linuxfromscratch.org/blfs/view/svn/index.html)
+Resources
+=========
+* [Android changes for NDK developers](https://android.googlesource.com/platform/bionic/+/master/android-changes-for-ndk-developers.md)
+
+* [Linux From Scratch](http://www.linuxfromscratch.org/lfs/view/stable/)
 
 * [Beyond Linux From Scratch](http://www.linuxfromscratch.org/blfs/view/stable/)
 
@@ -120,7 +122,6 @@ Common porting problems
 * mempcpy(3) is a GNU extension. We have added it to <string.h> provided TERMUX_EXPOSE_MEMPCPY is defined,
   so use something like CFLAGS+=" -DTERMUX_EXPOSE_MEMPCPY=1" for packages expecting that function to exist.
 
-
 dlopen() and RTLD_* flags
 =================================
 <dlfcn.h> originally declares
@@ -134,7 +135,6 @@ These differs from glibc ones in that
 2. They differ in value from glibc ones, so cannot be hardcoded in files (DLFCN.py in python does this)
 3. They are missing some values (`RTLD_BINDING_MASK`, `RTLD_NOLOAD`, ...)
 
-
 RPATH, RUNPATH AND LD\_LIBRARY\_PATH
 ====================================
 On desktop linux the linker searches for shared libraries in:
@@ -143,18 +143,8 @@ On desktop linux the linker searches for shared libraries in:
 2. `LD_LIBRARY_PATH` - an environment variable which holds a list of directories
 3. `RUNPATH` - same as `RPATH`, but searched after `LD_LIBRARY_PATH`, supported only on most recent UNIX systems
 
-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 with --disable-rpath configure flags. Another option to avoid depending on `LD_LIBRARY_PATH` would be supplying a custom linker - this is not done due to the overhead of maintaining a custom linker.
-
+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.
 
 Warnings about unused DT entries
 ================================
-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 arg ...
-    WARNING: linker: $BINARY: unused DT entry: type 0x6fffffff arg ...
-
-These may come from version scripts in a Makefile such as:
-
-    -Wl,--version-script=$(top_srcdir)/proc/libprocps.sym
-
-The termux-elf-cleaner utilty is run from build-package.sh and should normally take care of that problem.
+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.