Add README docs for proper use of std and no-std features #1711
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Kixunil
requested changes
Mar 16, 2023
|
Looking at it now, I think you meant to submit the compile error to |
notmandatory
force-pushed
the
features_build_error
branch
from
9f711a5
to
1cc7376
Compare
Yes it first came up in the discussion about |
notmandatory
changed the title
apoelstra
reviewed
Mar 16, 2023
README.md
Outdated
| @@ -93,6 +93,10 @@ versions than the current stable one (see MSRV section). | |||
|
|
|||
| ## Building | |||
|
|
|||
| The cargo feature `std` is enabled by default. At least one of the features `std` or `no-std` or both must be enabled. | |||
|
|
|||
| Enabling the `no-std` feature does not disable `std`, to disable the `std` feature you must disable default features. The `no-std` feature only enables additional features required for this crate to be usable without `std` and both can be enabled without conflict. | |||
There was a problem hiding this comment.
Grammar nit. I'd break this into multiple sentences:
Enabling the `no-std` feature does not disable `std`.
To disable the `std` feature you must disable default features. The `no-std` feature only enables additional features required for this crate to be usable without `std`.
Both can be enabled without conflict.
This is identical to your text, I just split it into 3 sentences.
There was a problem hiding this comment.
I agree that does read more clearly. I've updated as your suggested.
notmandatory
force-pushed
the
features_build_error
branch
from
1cc7376
to
33ee7a5
Compare
tcharding
approved these changes
Mar 17, 2023
Kixunil
approved these changes
Mar 17, 2023
apoelstra
approved these changes
Mar 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Building this crate requires the
stdand/orno-stdfeatures be enabled. This PR documents this build constraint in the READMEand gives an error is anyone tries to build without enabling one or both of these features.See discussion in rust-bitcoin/rust-miniscript#533.