Skip to content

Commit fe98999

Browse files
committed
depends: Reformat make options as definition list
1 parent 60c55b1 commit fe98999

File tree

1 file changed

+30
-15
lines changed

1 file changed

+30
-15
lines changed

depends/README.md

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

8282
### Dependency Options
83-
The following can be set when running make: make FOO=bar
84-
85-
SOURCES_PATH: downloaded sources will be placed here
86-
BASE_CACHE: built packages will be placed here
87-
SDK_PATH: Path where sdk's can be found (used by macOS)
88-
FALLBACK_DOWNLOAD_PATH: If a source file can't be fetched, try here before giving up
89-
NO_QT: Don't download/build/cache qt and its dependencies
90-
NO_QR: Don't download/build/cache packages needed for enabling qrencode
91-
NO_ZMQ: Don't download/build/cache packages needed for enabling zeromq
92-
NO_WALLET: Don't download/build/cache libs needed to enable the wallet
93-
NO_UPNP: Don't download/build/cache packages needed for enabling upnp
94-
MULTIPROCESS: build libmultiprocess (experimental, requires cmake)
95-
DEBUG: disable some optimizations and enable more runtime checking
96-
HOST_ID_SALT: Optional salt to use when generating host package ids
97-
BUILD_ID_SALT: Optional salt to use when generating build package ids
83+
The following can be set when running make: `make FOO=bar`
84+
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_UPNP</dt>
103+
<dd>Don't download/build/cache packages needed for enabling upnp</dd>
104+
<dt>MULTIPROCESS</dt>
105+
<dd>build libmultiprocess (experimental, requires cmake)</dd>
106+
<dt>DEBUG</dt>
107+
<dd>disable some optimizations and enable more runtime checking</dd>
108+
<dt>HOST_ID_SALT</dt>
109+
<dd>Optional salt to use when generating host package ids</dd>
110+
<dt>BUILD_ID_SALT</dt>
111+
<dd>Optional salt to use when generating build package ids</dd>
112+
</dl>
98113

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

0 commit comments

Comments
 (0)