Skip to content

Commit

Permalink
Improve documentation of features. (#272)
Browse files Browse the repository at this point in the history
* Improve documentation of nightly features

* Document undocumented features
  • Loading branch information
thomcc authored Sep 6, 2024
1 parent 860c391 commit bb36879
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,16 @@ exclude = ["/pedantic.bat"]

[features]
# In v2 we'll fix these names to be more "normal".

# Enable deriving the various `bytemuck` traits.
derive = ["bytemuck_derive"]
# Enable features requiring items from `extern crate alloc`.
extern_crate_alloc = []
# Enable features requiring items from `extern crate std`.
extern_crate_std = ["extern_crate_alloc"]
# Implement `Zeroable` for `MaybeUninit`.
zeroable_maybe_uninit = []
# Implement `Zeroable` for `std::sync::atomic` types.
zeroable_atomics = []

# All MSRV notes below are GUIDELINES and future versions may require even more
Expand Down Expand Up @@ -56,8 +62,11 @@ latest_stable_rust = [
"zeroable_maybe_uninit",
]

# NOT SEMVER SUPPORTED! TEMPORARY ONLY!
# ALL FEATURES BELOW THIS ARE NOT SEMVER SUPPORTED! TEMPORARY ONLY!

# Enable support for `std::simd` types.
nightly_portable_simd = []
# Enable support for unstable `std::arch` types (such as the AVX512 types).
nightly_stdsimd = []
# Enable `f16` and `f128`
nightly_float = []
Expand Down

0 comments on commit bb36879

Please sign in to comment.