Skip to content

Commit 7b6887e

Browse files
committed
doc: Convert depends options list from html to markdown
This makes it easier to read in `less`, which is important for install instructions.
1 parent 7ef6b1c commit 7b6887e

File tree

1 file changed

+22
-40
lines changed

1 file changed

+22
-40
lines changed

depends/README.md

Lines changed: 22 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -80,48 +80,30 @@ For linux S390X cross compilation:
8080
sudo apt-get install g++-s390x-linux-gnu binutils-s390x-linux-gnu
8181

8282
### Dependency Options
83+
8384
The following can be set when running make: `make FOO=bar`
8485

85-
<dl>
86-
<dt>SOURCES_PATH</dt>
87-
<dd>downloaded sources will be placed here</dd>
88-
<dt>BASE_CACHE</dt>
89-
<dd>built packages will be placed here</dd>
90-
<dt>SDK_PATH</dt>
91-
<dd>Path where sdk's can be found (used by macOS)</dd>
92-
<dt>FALLBACK_DOWNLOAD_PATH</dt>
93-
<dd>If a source file can't be fetched, try here before giving up</dd>
94-
<dt>NO_QT</dt>
95-
<dd>Don't download/build/cache qt and its dependencies</dd>
96-
<dt>NO_QR</dt>
97-
<dd>Don't download/build/cache packages needed for enabling qrencode</dd>
98-
<dt>NO_ZMQ</dt>
99-
<dd>Don't download/build/cache packages needed for enabling zeromq</dd>
100-
<dt>NO_WALLET</dt>
101-
<dd>Don't download/build/cache libs needed to enable the wallet</dd>
102-
<dt>NO_BDB</dt>
103-
<dd>Don't download/build/cache BerkeleyDB</dd>
104-
<dt>NO_SQLITE</dt>
105-
<dd>Don't download/build/cache SQLite</dd>
106-
<dt>NO_UPNP</dt>
107-
<dd>Don't download/build/cache packages needed for enabling upnp</dd>
108-
<dt>ALLOW_HOST_PACKAGES</dt>
109-
<dd>Packages that are missed in dependencies (due to `NO_*` option or
110-
build script logic) are searched for among the host system packages using
111-
`pkg-config`. It allows building with packages of other (newer) versions</dd>
112-
<dt>MULTIPROCESS</dt>
113-
<dd>build libmultiprocess (experimental, requires cmake)</dd>
114-
<dt>DEBUG</dt>
115-
<dd>disable some optimizations and enable more runtime checking</dd>
116-
<dt>HOST_ID_SALT</dt>
117-
<dd>Optional salt to use when generating host package ids</dd>
118-
<dt>BUILD_ID_SALT</dt>
119-
<dd>Optional salt to use when generating build package ids</dd>
120-
<dt>FORCE_USE_SYSTEM_CLANG</dt>
121-
<dd>(EXPERTS ONLY) When cross-compiling for macOS, use Clang found in the
122-
system's <code>$PATH</code> rather than the default prebuilt release of Clang
123-
from llvm.org. Clang 8 or later is required.</dd>
124-
</dl>
86+
- `SOURCES_PATH`: Downloaded sources will be placed here
87+
- `BASE_CACHE`: Built packages will be placed here
88+
- `SDK_PATH`: Path where SDKs can be found (used by macOS)
89+
- `FALLBACK_DOWNLOAD_PATH`: If a source file can't be fetched, try here before giving up
90+
- `NO_QT`: Don't download/build/cache Qt and its dependencies
91+
- `NO_QR`: Don't download/build/cache packages needed for enabling qrencode
92+
- `NO_ZMQ`: Don't download/build/cache packages needed for enabling ZeroMQ
93+
- `NO_WALLET`: Don't download/build/cache libs needed to enable the wallet
94+
- `NO_BDB`: Don't download/build/cache BerkeleyDB
95+
- `NO_SQLITE`: Don't download/build/cache SQLite
96+
- `NO_UPNP`: Don't download/build/cache packages needed for enabling UPnP
97+
- `ALLOW_HOST_PACKAGES`: Packages that are missed in dependencies (due to `NO_*` option or
98+
build script logic) are searched for among the host system packages using
99+
`pkg-config`. It allows building with packages of other (newer) versions
100+
- `MULTIPROCESS`: Build libmultiprocess (experimental, requires CMake)
101+
- `DEBUG`: Disable some optimizations and enable more runtime checking
102+
- `HOST_ID_SALT`: Optional salt to use when generating host package ids
103+
- `BUILD_ID_SALT`: Optional salt to use when generating build package ids
104+
- `FORCE_USE_SYSTEM_CLANG`: (EXPERTS ONLY) When cross-compiling for macOS, use Clang found in the
105+
system's `$PATH` rather than the default prebuilt release of Clang
106+
from llvm.org. Clang 8 or later is required.
125107

126108
If some packages are not built, for example `make NO_WALLET=1`, the appropriate
127109
options will be passed to bitcoin's configure. In this case, `--disable-wallet`.

0 commit comments

Comments
 (0)