Replace depreciated atomic-polyfill crate with portable-atomic #9
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
Dirbaio
reviewed
Sep 12, 2024
Dirbaio
reviewed
Sep 12, 2024
Cargo.toml
Outdated
| @@ -1,21 +1,16 @@ | |||
| [package] | |||
| name = "atomic-pool" | |||
| version = "1.0.1" | |||
| version = "1.0.2" | |||
There was a problem hiding this comment.
this should be 2.0.0, since this is a breaking change.
Dirbaio
reviewed
Sep 12, 2024
Cargo.toml
Outdated
| as-slice-01 = { package = "as-slice", version = "0.1.5" } | ||
| as-slice-02 = { package = "as-slice", version = "0.2.1" } | ||
| portable-atomic = { version = "1.7.0", features = ["critical-section"] } |
There was a problem hiding this comment.
do not unconditionally enable critical-section, the user might want to use unsafe-assume-single-core instead which is slightly faster in single-core chips.
I'd add two features that forward to portable-atomic:
[features]
portable-atomic-critical-section = ["portable-atomic/critical-section"]
portable-atomic-unsafe-assume-single-core = ["portable-atomic/unsafe-assume-single-core"]
Co-authored-by: Dario Nieuwenhuis <[email protected]>
Dirbaio
reviewed
Sep 15, 2024
| categories = ["embedded", "no-std", "concurrency", "memory-management"] | ||
|
|
||
| [features] | ||
| default = ["portable-atomic-critical-section"] |
There was a problem hiding this comment.
don't make this default. all it takes is one lib using atomic-pool and forgetting default-features=false and the user can't use unsafe-assume-single-core anymore.
There was a problem hiding this comment.
The library doesn't compile without at least one of those enabled. Should I default to the other one or inject a compilation error if none are enabled?
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.
atomic-polyfillhas been depreciated and is causing problems in my ESP32-S3 build system.portable-atomicis the widely-accepted replacement and I have updated the library to use it.