doc: Convert depends options list from html to markdown

laanwj commented at 10:53 am on December 17, 2020: member

This makes it easier to read in less, which is important for install instructions.

in depends/README.md:88 in ccf5eff877 outdated

123-system's <code>$PATH</code> rather than the default prebuilt release of Clang
124-from llvm.org. Clang 8 or later is required.</dd>
125-</dl>
126+- `SOURCES_PATH`: downloaded sources will be placed here
127+- `BASE_CACHE`: built packages will be placed here
128+- `SDK_PATH`: Path where sdk's can be found (used by macOS)

jonatack commented at 11:00 am on December 17, 2020:

0- `SDK_PATH`: Path where SDKs can be found (used by macOS)

laanwj commented at 11:17 am on December 17, 2020:

Thanks

in depends/README.md:92 in ccf5eff877 outdated

127+- `BASE_CACHE`: built packages will be placed here
128+- `SDK_PATH`: Path where sdk's can be found (used by macOS)
129+- `FALLBACK_DOWNLOAD_PATH`: If a source file can't be fetched, try here before giving up
130+- `NO_QT`: Don't download/build/cache qt and its dependencies
131+- `NO_QR`: Don't download/build/cache packages needed for enabling qrencode
132+- `NO_ZMQ`: Don't download/build/cache packages needed for enabling zeromq

jonatack commented at 11:00 am on December 17, 2020:

0- `NO_ZMQ`: Don't download/build/cache packages needed for enabling ZeroMQ

hebasto commented at 11:00 am on December 17, 2020: member

Concept ACK. This change effectively reverts https://github.com/bitcoin/bitcoin/commit/fe98999dcf87ac056d0a2c9231fb3160abdf3417

I like the new (old-old) style as it simplifies intra-item formatting (https://github.com/bitcoin/bitcoin/pull/19124#pullrequestreview-466631773).

While this part is already touched, maybe align first letters of sentences, i.e., capitilize all of them or opposite?

in depends/README.md:96 in ccf5eff877 outdated

131+- `NO_QR`: Don't download/build/cache packages needed for enabling qrencode
132+- `NO_ZMQ`: Don't download/build/cache packages needed for enabling zeromq
133+- `NO_WALLET`: Don't download/build/cache libs needed to enable the wallet
134+- `NO_BDB`: Don't download/build/cache BerkeleyDB
135+- `NO_SQLITE`: Don't download/build/cache SQLite
136+- `NO_UPNP`: Don't download/build/cache packages needed for enabling upnp

jonatack commented at 11:01 am on December 17, 2020:

0- `NO_UPNP`: Don't download/build/cache packages needed for enabling UPnP

in depends/README.md:100 in ccf5eff877 outdated

135+- `NO_SQLITE`: Don't download/build/cache SQLite
136+- `NO_UPNP`: Don't download/build/cache packages needed for enabling upnp
137+- `ALLOW_HOST_PACKAGES`: Packages that are missed in dependencies (due to `NO_*` option or
138+  build script logic) are searched for among the host system packages using
139+  `pkg-config`. It allows building with packages of other (newer) versions
140+- `MULTIPROCESS`: build libmultiprocess (experimental, requires cmake)

jonatack commented at 11:02 am on December 17, 2020:

0- `MULTIPROCESS`: build libmultiprocess (experimental, requires CMake)

jonatack commented at 11:03 am on December 17, 2020: member

ACK ccf5eff877ca4770611fb31814300f33c1e89af3 this is much easier to read in my editor as well. Verified the text is unchanged.

Some nits probably not worth bothering with below.

laanwj commented at 11:12 am on December 17, 2020: member

While this part is already touched, maybe align first letters of sentences, i.e., capitilize all of them or opposite?

Sure, sounds good to me.

Concept ACK. This change effectively reverts fe98999 @dongcarl i guess then Note that I made it consistent in style with the architecture list at the top of the document. I thought about making it a table but that is an alignment nightmare.

laanwj force-pushed on Dec 17, 2020

laanwj commented at 11:20 am on December 17, 2020: member

Made capitalization consistent, updated for @jonatack’s comments.

jonatack commented at 11:27 am on December 17, 2020: member

ACK d97042406f9123a295e79893839b03b24d228c95

jonatack commented at 11:31 am on December 17, 2020: member

(Not only is a table a pain to make and maintain, but I think it’s more readable this way.)

in depends/README.md:90 in d97042406f outdated

125-</dl>
126+- `SOURCES_PATH`: Downloaded sources will be placed here
127+- `BASE_CACHE`: Built packages will be placed here
128+- `SDK_PATH`: Path where SDKs can be found (used by macOS)
129+- `FALLBACK_DOWNLOAD_PATH`: If a source file can't be fetched, try here before giving up
130+- `NO_QT`: Don't download/build/cache qt and its dependencies

hebasto commented at 11:41 am on December 17, 2020:

pico-nit:

0- `NO_QT`: Don't download/build/cache Qt and its dependencies

hebasto approved

hebasto commented at 11:41 am on December 17, 2020: member

ACK d97042406f9123a295e79893839b03b24d228c95, I’ve verified that wording remains unchanged.

doc: Convert depends options list from html to markdown

This makes it easier to read in `less`, which is important for install
instructions.

7b6887e75a

laanwj commented at 12:01 pm on December 17, 2020: member

d97042406f9123a295e79893839b03b24d228c95 → 7b6887e75aec7e0d5c25682c26943073b7a728e5 qt → Qt

laanwj force-pushed on Dec 17, 2020

hebasto approved

hebasto commented at 12:59 pm on December 17, 2020: member

re-ACK 7b6887e75aec7e0d5c25682c26943073b7a728e5

jonatack commented at 1:03 pm on December 17, 2020: member

Code review re-ACK 7b6887e75aec7e0d5c25682c26943073b7a728e5 per git diff d970424 7b6887e

Nice touchups.

DrahtBot added the label Build system on Dec 17, 2020

DrahtBot added the label Docs on Dec 17, 2020

dongcarl commented at 5:15 pm on December 17, 2020: member

Concept ACK

Perhaps this will be an AsciiDoc someday, or another format that’s reader-friendly in both plain-text and rendered form.

laanwj merged this on Dec 17, 2020

laanwj closed this on Dec 17, 2020

sidhujag referenced this in commit 4b8f206768 on Dec 17, 2020

DrahtBot locked this on Feb 15, 2022

doc: Convert depends options list from html to markdown #20681