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](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
This commit is contained in:
Wladimir J. van der Laan 2020-12-17 18:45:40 +01:00 committed by PastaPastaPasta
parent 283c5592c8
commit 637cbc6a00

View File

@ -89,44 +89,28 @@ For linux S390X cross compilation:
pkg_add bash gtar pkg_add bash gtar
### 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> - `NO_NATPMP`: Don't download/build/cache packages needed for enabling NAT-PMP
<dd>Don't download/build/cache packages needed for enabling qrencode</dd> - `DEBUG`: Disable some optimizations and enable more runtime checking
<dt>NO_ZMQ</dt> - `HOST_ID_SALT`: Optional salt to use when generating host package ids
<dd>Don't download/build/cache packages needed for enabling zeromq</dd> - `BUILD_ID_SALT`: Optional salt to use when generating build package ids
<dt>NO_WALLET</dt> - `FORCE_USE_SYSTEM_CLANG`: (EXPERTS ONLY) When cross-compiling for macOS, use Clang found in the
<dd>Don't download/build/cache libs needed to enable the wallet</dd> system's `$PATH` rather than the default prebuilt release of Clang
<dt>NO_BDB</dt> from llvm.org. Clang 8 or later is required.
<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>NO_NATPMP</dt>
<dd>Don't download/build/cache packages needed for enabling NAT-PMP</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>
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 Dash Core's configure. In this case, `--disable-wallet`. options will be passed to Dash Core's configure. In this case, `--disable-wallet`.