doc: Convert depends options list from html to markdown

This makes it easier to read in `less`, which is important for install
instructions.
This commit is contained in:
Wladimir J. van der Laan
2020-12-17 11:46:01 +01:00
parent 7ef6b1c51d
commit 7b6887e75a

View File

@@ -80,48 +80,30 @@ For linux S390X cross compilation:
sudo apt-get install g++-s390x-linux-gnu binutils-s390x-linux-gnu sudo apt-get install g++-s390x-linux-gnu binutils-s390x-linux-gnu
### Dependency Options ### Dependency Options
The following can be set when running make: `make FOO=bar` The following can be set when running make: `make FOO=bar`
<dl> - `SOURCES_PATH`: Downloaded sources will be placed here
<dt>SOURCES_PATH</dt> - `BASE_CACHE`: Built packages will be placed here
<dd>downloaded sources will be placed here</dd> - `SDK_PATH`: Path where SDKs can be found (used by macOS)
<dt>BASE_CACHE</dt> - `FALLBACK_DOWNLOAD_PATH`: If a source file can't be fetched, try here before giving up
<dd>built packages will be placed here</dd> - `NO_QT`: Don't download/build/cache Qt and its dependencies
<dt>SDK_PATH</dt> - `NO_QR`: Don't download/build/cache packages needed for enabling qrencode
<dd>Path where sdk's can be found (used by macOS)</dd> - `NO_ZMQ`: Don't download/build/cache packages needed for enabling ZeroMQ
<dt>FALLBACK_DOWNLOAD_PATH</dt> - `NO_WALLET`: Don't download/build/cache libs needed to enable the wallet
<dd>If a source file can't be fetched, try here before giving up</dd> - `NO_BDB`: Don't download/build/cache BerkeleyDB
<dt>NO_QT</dt> - `NO_SQLITE`: Don't download/build/cache SQLite
<dd>Don't download/build/cache qt and its dependencies</dd> - `NO_UPNP`: Don't download/build/cache packages needed for enabling UPnP
<dt>NO_QR</dt> - `ALLOW_HOST_PACKAGES`: Packages that are missed in dependencies (due to `NO_*` option or
<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 build script logic) are searched for among the host system packages using
`pkg-config`. It allows building with packages of other (newer) versions</dd> `pkg-config`. It allows building with packages of other (newer) versions
<dt>MULTIPROCESS</dt> - `MULTIPROCESS`: Build libmultiprocess (experimental, requires CMake)
<dd>build libmultiprocess (experimental, requires cmake)</dd> - `DEBUG`: Disable some optimizations and enable more runtime checking
<dt>DEBUG</dt> - `HOST_ID_SALT`: Optional salt to use when generating host package ids
<dd>disable some optimizations and enable more runtime checking</dd> - `BUILD_ID_SALT`: Optional salt to use when generating build package ids
<dt>HOST_ID_SALT</dt> - `FORCE_USE_SYSTEM_CLANG`: (EXPERTS ONLY) When cross-compiling for macOS, use Clang found in the
<dd>Optional salt to use when generating host package ids</dd> system's `$PATH` rather than the default prebuilt release of Clang
<dt>BUILD_ID_SALT</dt> from llvm.org. Clang 8 or later is required.
<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>
If some packages are not built, for example `make NO_WALLET=1`, the appropriate 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`. options will be passed to bitcoin's configure. In this case, `--disable-wallet`.