Skip to content

Commit 1aaecb0

Browse files
committed
node: Fix manifest comments
The comments are stale, fix them to correctly explain how the features work in this crate.
1 parent bc81023 commit 1aaecb0

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

node/Cargo.toml

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,13 @@ tar = { version = "0.4", optional = true }
3131
minreq = { version = "2.9.1", default-features = false, features = ["https"], optional = true }
3232
zip = { version = "0.6", optional = true }
3333

34-
# Please note, in this crate the version features are mutally exclusive.
34+
# Please note, it is expected that a single version feature will be enabled however if you enable
35+
# multiple the highest version number will take precedence.
3536
#
36-
# - `cargo test --features=27_2,download` to download Bitcoin Core binary v27.
37-
# - `cargo test --all-features` is the same as `cargo test --features=download,v28_0`
38-
# - `cargo test --features=28_0` to use `bitcoind`.
39-
#
40-
# If you do not enable `download` then you must configure the bitcoind binary by `bitcoind` in your
41-
# path or using `BITCOIND_EXE=/path/to/bitcoind`. Note also that the feature enabled should match
42-
# the version from `bitcoind --version`.
37+
# - `cargo test --features=27_2,download` to download Bitcoin Core binary `v27.2`.
38+
# - `cargo test --features=28_0` to use `bitcoind` from the host environment.
39+
# - `cargo test --all-features`: Same as using latest version e.g., `cargo test --features=20_0,download`
40+
# - `cargo test`: Does not work, you MUST enable a version feature.
4341
[features]
4442
download = ["anyhow", "bitcoin_hashes", "flate2", "tar", "minreq", "zip"]
4543

0 commit comments

Comments
 (0)