diff options
author | Wladimir J. van der Laan <laanwj@protonmail.com> | 2020-12-17 18:45:40 +0100 |
---|---|---|
committer | Wladimir J. van der Laan <laanwj@protonmail.com> | 2020-12-17 18:49:26 +0100 |
commit | 190d3d8a75d2c9d3dfe54eaff5aaf69a44d55e26 (patch) | |
tree | a64a71f1b872bb196eebb63622a66b9e78a08397 | |
parent | 143bd108ed6626405b0361c9939a8e1bf6cfc3d2 (diff) | |
parent | 7b6887e75aec7e0d5c25682c26943073b7a728e5 (diff) | |
download | bitcoin-190d3d8a75d2c9d3dfe54eaff5aaf69a44d55e26.tar.xz |
Merge #20681: doc: Convert depends options list from html to markdown
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](https://github.com/bitcoin/bitcoin/tree/7ef6b1c51d4a00511a74f6d08abb942a7e433f0b/depends#dependency-options) - [after](https://github.com/bitcoin/bitcoin/blob/d97042406f9123a295e79893839b03b24d228c95/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
-rw-r--r-- | depends/README.md | 62 |
1 files changed, 22 insertions, 40 deletions
diff --git a/depends/README.md b/depends/README.md index bf8f829848..085e0e6054 100644 --- a/depends/README.md +++ b/depends/README.md @@ -80,48 +80,30 @@ For linux S390X cross compilation: sudo apt-get install g++-s390x-linux-gnu binutils-s390x-linux-gnu ### Dependency Options + The following can be set when running make: `make FOO=bar` -<dl> -<dt>SOURCES_PATH</dt> -<dd>downloaded sources will be placed here</dd> -<dt>BASE_CACHE</dt> -<dd>built packages will be placed here</dd> -<dt>SDK_PATH</dt> -<dd>Path where sdk's can be found (used by macOS)</dd> -<dt>FALLBACK_DOWNLOAD_PATH</dt> -<dd>If a source file can't be fetched, try here before giving up</dd> -<dt>NO_QT</dt> -<dd>Don't download/build/cache qt and its dependencies</dd> -<dt>NO_QR</dt> -<dd>Don't download/build/cache packages needed for enabling qrencode</dd> -<dt>NO_ZMQ</dt> -<dd>Don't download/build/cache packages needed for enabling zeromq</dd> -<dt>NO_WALLET</dt> -<dd>Don't download/build/cache libs needed to enable the wallet</dd> -<dt>NO_BDB</dt> -<dd>Don't download/build/cache BerkeleyDB</dd> -<dt>NO_SQLITE</dt> -<dd>Don't download/build/cache SQLite</dd> -<dt>NO_UPNP</dt> -<dd>Don't download/build/cache packages needed for enabling upnp</dd> -<dt>ALLOW_HOST_PACKAGES</dt> -<dd>Packages that are missed in dependencies (due to `NO_*` option or -build script logic) are searched for among the host system packages using -`pkg-config`. It allows building with packages of other (newer) versions</dd> -<dt>MULTIPROCESS</dt> -<dd>build libmultiprocess (experimental, requires cmake)</dd> -<dt>DEBUG</dt> -<dd>disable some optimizations and enable more runtime checking</dd> -<dt>HOST_ID_SALT</dt> -<dd>Optional salt to use when generating host package ids</dd> -<dt>BUILD_ID_SALT</dt> -<dd>Optional salt to use when generating build package ids</dd> -<dt>FORCE_USE_SYSTEM_CLANG</dt> -<dd>(EXPERTS ONLY) When cross-compiling for macOS, use Clang found in the -system's <code>$PATH</code> rather than the default prebuilt release of Clang -from llvm.org. Clang 8 or later is required.</dd> -</dl> +- `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 +- `ALLOW_HOST_PACKAGES`: Packages that are missed in dependencies (due to `NO_*` option or + build script logic) are searched for among the host system packages using + `pkg-config`. It allows building with packages of other (newer) versions +- `MULTIPROCESS`: Build libmultiprocess (experimental, requires CMake) +- `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 bitcoin's configure. In this case, `--disable-wallet`. |