mirror of
https://github.com/dashpay/dash.git
synced 2024-12-25 03:52:49 +01:00
637cbc6a00
7b6887e75aec7e0d5c25682c26943073b7a728e5 doc: Convert depends options list from html to markdown (Wladimir J. van der Laan) Pull request description: This makes it easier to read in `less`, which is important for install instructions. Rendered: [before](7ef6b1c51d/depends (dependency-options)) - [after](d97042406f/depends/README.md (dependency-options)) ACKs for top commit: jonatack: Code review re-ACK 7b6887e75aec7e0d5c25682c26943073b7a728e5 per `git diff d970424 7b6887e` hebasto: re-ACK 7b6887e75aec7e0d5c25682c26943073b7a728e5 Tree-SHA512: 02970b2bb97d2e8fb2d66470f6d70662653fda176bf6f4861742823b361fdc7ab6a2b44143480ac1a525b8d7808b6a068e8b3677dbba16cd783b4cab90470af5
142 lines
6.2 KiB
Markdown
142 lines
6.2 KiB
Markdown
### Usage
|
|
|
|
To build dependencies for the current arch+OS:
|
|
|
|
make
|
|
|
|
To build for another arch/OS:
|
|
|
|
make HOST=host-platform-triplet
|
|
|
|
For example:
|
|
|
|
make HOST=x86_64-w64-mingw32 -j4
|
|
|
|
**Dash Core's configure script by default will ignore the depends output.** In
|
|
order for it to pick up libraries, tools, and settings from the depends build,
|
|
you must point it at the appropriate `--prefix` directory generated by the
|
|
build. In the above example, a prefix dir named x86_64-w64-mingw32 will be
|
|
created. To use it for Dash:
|
|
|
|
./configure --prefix=$PWD/depends/x86_64-w64-mingw32
|
|
|
|
Common `host-platform-triplets` for cross compilation are:
|
|
|
|
- `i686-pc-linux-gnu` for Linux 32 bit
|
|
- `x86_64-pc-linux-gnu` for x86 Linux
|
|
- `x86_64-w64-mingw32` for Win64
|
|
- `x86_64-apple-darwin` for macOS
|
|
- `arm64-apple-darwin` for ARM macOS
|
|
- `arm-linux-gnueabihf` for Linux ARM 32 bit
|
|
- `aarch64-linux-gnu` for Linux ARM 64 bit
|
|
- `powerpc64-linux-gnu` for Linux POWER 64-bit (big endian)
|
|
- `powerpc64le-linux-gnu` for Linux POWER 64-bit (little endian)
|
|
- `riscv32-linux-gnu` for Linux RISC-V 32 bit
|
|
- `riscv64-linux-gnu` for Linux RISC-V 64 bit
|
|
- `s390x-linux-gnu` for Linux S390X
|
|
- `armv7a-linux-android` for Android ARM 32 bit
|
|
- `aarch64-linux-android` for Android ARM 64 bit
|
|
- `x86_64-linux-android` for Android x86 64 bit
|
|
|
|
The paths are automatically configured and no other options are needed unless targeting [Android](#Android).
|
|
|
|
### Install the required dependencies: Ubuntu & Debian
|
|
|
|
#### For macOS cross compilation
|
|
|
|
sudo apt-get install curl bsdmainutils cmake libcap-dev libz-dev libbz2-dev python3-setuptools libtinfo5 xorriso
|
|
|
|
Note: You must obtain the macOS SDK before proceeding with a cross-compile.
|
|
Under the depends directory, create a subdirectory named `SDKs`.
|
|
Then, place the extracted SDK under this new directory.
|
|
For more information, see [SDK Extraction](../contrib/macdeploy/README.md#sdk-extraction).
|
|
|
|
#### For Win64 cross compilation
|
|
|
|
- see [build-windows.md](../doc/build-windows.md#cross-compilation-for-ubuntu-and-windows-subsystem-for-linux)
|
|
|
|
#### For linux (including i386, ARM) cross compilation
|
|
|
|
Common linux dependencies:
|
|
|
|
sudo apt-get install make automake curl g++-multilib libtool binutils-gold bsdmainutils pkg-config python3 patch bison
|
|
|
|
For linux ARM cross compilation:
|
|
|
|
sudo apt-get install g++-arm-linux-gnueabihf binutils-arm-linux-gnueabihf
|
|
|
|
For linux AARCH64 cross compilation:
|
|
|
|
sudo apt-get install g++-aarch64-linux-gnu binutils-aarch64-linux-gnu
|
|
|
|
For linux POWER 64-bit cross compilation (there are no packages for 32-bit):
|
|
|
|
sudo apt-get install g++-powerpc64-linux-gnu binutils-powerpc64-linux-gnu g++-powerpc64le-linux-gnu binutils-powerpc64le-linux-gnu
|
|
|
|
For linux RISC-V 64-bit cross compilation (there are no packages for 32-bit):
|
|
|
|
sudo apt-get install g++-riscv64-linux-gnu binutils-riscv64-linux-gnu
|
|
|
|
RISC-V known issue: gcc-7.3.0 and gcc-7.3.1 result in a broken `test_dash` executable (see https://github.com/bitcoin/bitcoin/pull/13543),
|
|
this is apparently fixed in gcc-8.1.0.
|
|
|
|
For linux S390X cross compilation:
|
|
|
|
sudo apt-get install g++-s390x-linux-gnu binutils-s390x-linux-gnu
|
|
|
|
### Install the required dependencies: OpenBSD
|
|
|
|
pkg_add bash gtar
|
|
|
|
### Dependency Options
|
|
|
|
The following can be set when running make: `make FOO=bar`
|
|
|
|
- `SOURCES_PATH`: Downloaded sources will be placed here
|
|
- `BASE_CACHE`: Built packages will be placed here
|
|
- `SDK_PATH`: Path where SDKs can be found (used by macOS)
|
|
- `FALLBACK_DOWNLOAD_PATH`: If a source file can't be fetched, try here before giving up
|
|
- `NO_QT`: Don't download/build/cache Qt and its dependencies
|
|
- `NO_QR`: Don't download/build/cache packages needed for enabling qrencode
|
|
- `NO_ZMQ`: Don't download/build/cache packages needed for enabling ZeroMQ
|
|
- `NO_WALLET`: Don't download/build/cache libs needed to enable the wallet
|
|
- `NO_BDB`: Don't download/build/cache BerkeleyDB
|
|
- `NO_SQLITE`: Don't download/build/cache SQLite
|
|
- `NO_UPNP`: Don't download/build/cache packages needed for enabling UPnP
|
|
- `NO_NATPMP`: Don't download/build/cache packages needed for enabling NAT-PMP
|
|
- `DEBUG`: Disable some optimizations and enable more runtime checking
|
|
- `HOST_ID_SALT`: Optional salt to use when generating host package ids
|
|
- `BUILD_ID_SALT`: Optional salt to use when generating build package ids
|
|
- `FORCE_USE_SYSTEM_CLANG`: (EXPERTS ONLY) When cross-compiling for macOS, use Clang found in the
|
|
system's `$PATH` rather than the default prebuilt release of Clang
|
|
from llvm.org. Clang 8 or later is required.
|
|
|
|
If some packages are not built, for example `make NO_WALLET=1`, the appropriate
|
|
options will be passed to Dash Core's configure. In this case, `--disable-wallet`.
|
|
|
|
### Additional targets
|
|
|
|
download: run 'make download' to fetch all sources without building them
|
|
download-osx: run 'make download-osx' to fetch all sources needed for macOS builds
|
|
download-win: run 'make download-win' to fetch all sources needed for win builds
|
|
download-linux: run 'make download-linux' to fetch all sources needed for linux builds
|
|
|
|
|
|
### Android
|
|
|
|
Before proceeding with an Android build one needs to get the [Android SDK](https://developer.android.com/studio) and use the "SDK Manager" tool to download the NDK and one or more "Platform packages" (these are Android versions and have a corresponding API level).
|
|
In order to build `ANDROID_API_LEVEL` (API level corresponding to the Android version targeted, e.g. Android 9.0 Pie is 28 and its "Platform package" needs to be available) and `ANDROID_TOOLCHAIN_BIN` (path to toolchain binaries depending on the platform the build is being performed on) need to be set.
|
|
|
|
API levels from 24 to 29 have been tested to work.
|
|
|
|
If the build includes Qt, environment variables `ANDROID_SDK` and `ANDROID_NDK` need to be set as well but can otherwise be omitted.
|
|
This is an example command for a default build with no disabled dependencies:
|
|
|
|
ANDROID_SDK=/home/user/Android/Sdk ANDROID_NDK=/home/user/Android/Sdk/ndk-bundle make HOST=aarch64-linux-android ANDROID_API_LEVEL=28 ANDROID_TOOLCHAIN_BIN=/home/user/Android/Sdk/ndk-bundle/toolchains/llvm/prebuilt/linux-x86_64/bin
|
|
|
|
### Other documentation
|
|
|
|
- [description.md](description.md): General description of the depends system
|
|
- [packages.md](packages.md): Steps for adding packages
|
|
|