aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJack O'Connor <[email protected]>2021-10-23 13:09:52 -0400
committerJack O'Connor <[email protected]>2021-10-23 13:09:52 -0400
commit1f2010d79e8aab541c665a5b3e3dd2814648d68e (patch)
treec26d22f1cf0d2a4909e277939e9c44020b5655c2 /src
parent197ad572619a2ec4049fb3a5bb8d4d7a271a01c4 (diff)
update NEON docs in lib.rs
Diffstat (limited to 'src')
-rw-r--r--src/lib.rs16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 31e5cd6..6cd2f6a 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -34,19 +34,19 @@
//!
//! The `std` feature (the only feature enabled by default) is required for
//! implementations of the [`Write`] and [`Seek`] traits, and also for runtime
-//! CPU feature detection. If this feature is disabled, the only way to use the
-//! SIMD implementations in this crate is to enable the corresponding
-//! instruction sets globally, with e.g. `RUSTFLAGS="-C target-cpu=native"`. The
-//! resulting binary will not be portable to other machines.
+//! CPU feature detection on x86. If this feature is disabled, the only way to
+//! use the x86 SIMD implementations is to enable the corresponding instruction
+//! sets globally, with e.g. `RUSTFLAGS="-C target-cpu=native"`. The resulting
+//! binary will not be portable to other machines.
//!
//! The `rayon` feature (disabled by default, but enabled for [docs.rs]) adds
//! the [`Hasher::update_rayon`] method, for multithreaded hashing. However,
//! even if this feature is enabled, all other APIs remain single-threaded.
//!
-//! The `neon` feature enables ARM NEON support. Currently there is no runtime
-//! CPU feature detection for NEON, so you must only enable this feature for
-//! targets that are known to have NEON support. In particular, some ARMv7
-//! targets support NEON, and some don't.
+//! The NEON implementation is enabled by default for AArch64 but requires the
+//! `neon` feature for other ARM targets. Not all ARMv7 CPUs support NEON, and
+//! enabling this feature will produce a binary that's not portable to CPUs
+//! without NEON support.
//!
//! The `traits-preview` feature enables implementations of traits from the
//! RustCrypto [`digest`] and [`crypto-mac`] crates, and re-exports those crates