Skip to content

Commit 98f3c6a

Browse files
committed
Update README
1 parent 598edc8 commit 98f3c6a

File tree

1 file changed

+11
-19
lines changed

1 file changed

+11
-19
lines changed

README.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -167,13 +167,15 @@ There are currently these optional cargo features:
167167

168168
### `simd-accel`
169169

170-
Enables SIMD acceleration using the nightly-dependent `packed_simd` crate.
170+
Enables SIMD acceleration using the nightly-dependent `portable_simd` standard
171+
library feature.
171172

172173
This is an opt-in feature, because enabling this feature _opts out_ of Rust's
173174
guarantees of future compilers compiling old code (aka. "stability story").
174175

175176
Currently, this has not been tested to be an improvement except for these
176-
targets:
177+
targets and enabling the `simd-accel` feature is expected to break the build
178+
on other targets:
177179

178180
* x86_64
179181
* i686
@@ -185,22 +187,6 @@ above, and you are prepared _to have to revise your configuration when updating
185187
Rust_, you should enable this feature. Otherwise, please _do not_ enable this
186188
feature.
187189

188-
_Note!_ If you are compiling for a target that does not have 128-bit SIMD
189-
enabled as part of the target definition and you are enabling 128-bit SIMD
190-
using `-C target_feature`, you need to enable the `core_arch` Cargo feature
191-
for `packed_simd` to compile a crates.io snapshot of `core_arch` instead of
192-
using the standard-library copy of `core::arch`, because the `core::arch`
193-
module of the pre-compiled standard library has been compiled with the
194-
assumption that the CPU doesn't have 128-bit SIMD. At present this applies
195-
mainly to 32-bit ARM targets whose first component does not include the
196-
substring `neon`.
197-
198-
The encoding_rs side of things has not been properly set up for POWER,
199-
PowerPC, MIPS, etc., SIMD at this time, so even if you were to follow
200-
the advice from the previous paragraph, you probably shouldn't use
201-
the `simd-accel` option on the less mainstream architectures at this
202-
time.
203-
204190
Used by Firefox.
205191

206192
### `serde`
@@ -446,10 +432,16 @@ To regenerate the generated code:
446432
- [x] Add actually fast CJK encode options.
447433
- [ ] ~Investigate [Bob Steagall's lookup table acceleration for UTF-8](https://github.com/BobSteagall/CppNow2018/blob/master/FastConversionFromUTF-8/Fast%20Conversion%20From%20UTF-8%20with%20C%2B%2B%2C%20DFAs%2C%20and%20SSE%20Intrinsics%20-%20Bob%20Steagall%20-%20C%2B%2BNow%202018.pdf).~
448434
- [x] Provide a build mode that works without `alloc` (with lesser API surface).
449-
- [ ] Migrate to `std::simd` once it is stable and declare 1.0.
435+
- [x] Migrate to `std::simd` ~once it is stable and declare 1.0.~
436+
- [ ] Migrate `unsafe` slice access by larger types than `u8`/`u16` to `align_to`.
450437

451438
## Release Notes
452439

440+
### 0.8.34
441+
442+
* Use the `portable_simd` nightly feature of the standard library instead of the `packed_simd` crate. Only affects the `simd-accel` optional nightly feature.
443+
* Internal documentation improvements and minor code improvements around `unsafe`.
444+
453445
### 0.8.33
454446

455447
* Use `packed_simd` instead of `packed_simd_2` again now that updates are back under the `packed_simd` name. Only affects the `simd-accel` optional nightly feature.

0 commit comments

Comments
 (0)