Skip to content

Commit

Permalink
Add a comment on default-features=false requirement
Browse files Browse the repository at this point in the history
This is documented, but having it here as well can be useful.

Having "optimal" as a default feature is a workaround for Cargo's
inability to select dependencies by feature. For that workaround
to be less annoying to use, the "pure-rust" and "optimal" targets
should be mutually exclusive. The ability for Cargo to do that
was asked in 2016 but, just like the ability to select dependencies
by feature, the issue is still open today.
  • Loading branch information
jedisct1 committed Dec 21, 2023
1 parent 81a0f64 commit 95eac51
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ benchmark-simple = "0.1.8"
default = ["optimal"]
cwt = ["ciborium"]
optimal = ["boring"]
# Note: to emulate boringssl, "default-features = false" is required in addition to "pure-rust".
pure-rust = ["superboring"]

[[bench]]
name = "benchmark"
harness = false
Expand Down

0 comments on commit 95eac51

Please # to comment.