diff options
author | Andrew Gallant <jamslam@gmail.com> | 2019-01-24 06:58:28 -0500 |
---|---|---|
committer | Andrew Gallant <jamslam@gmail.com> | 2019-01-24 07:00:53 -0500 |
commit | 9a9f54d44ce45c6c3c5bfa31ad1a08fda57cdad7 (patch) | |
tree | d538ec445c9317d56e17afa1dbb01910405a8227 /README.md | |
parent | 47833b9ce740529ebff7d99a6e156be60b277c5d (diff) |
readme: encoding_rs's SIMD support is broken
Add a note about it to the README.
Also, remove mention of the avx-accel feature since it no longer exists.
(bytecount now uses runtime detection to enable SIMD support.)
Fixes #1175
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 24 |
1 files changed, 12 insertions, 12 deletions
@@ -383,19 +383,19 @@ $ ./target/release/rg --version If you have a Rust nightly compiler and a recent Intel CPU, then you can enable additional optional SIMD acceleration like so: +**WARNING**: Building with the `simd-accel` feature on the latest Rust nightly +does not work because the [`encoding_rs`](https://crates.io/crates/encoding_rs) +crate hasn't yet migrated to the new SIMD infrastructure, and the old SIMD +infrastructure no longer works on the latest nightly version of Rust. + ``` -RUSTFLAGS="-C target-cpu=native" cargo build --release --features 'simd-accel avx-accel' +RUSTFLAGS="-C target-cpu=native" cargo build --release --features 'simd-accel' ``` -If your machine doesn't support AVX instructions, then simply remove -`avx-accel` from the features list. Similarly for SIMD (which corresponds -roughly to SSE instructions). - -The `simd-accel` and `avx-accel` features enable SIMD support in certain -ripgrep dependencies (responsible for counting lines and transcoding). They -are not necessary to get SIMD optimizations for search; those are enabled -automatically. Hopefully, some day, the `simd-accel` and `avx-accel` features -will similarly become unnecessary. +The `simd-accel` feature enables SIMD support in certain ripgrep dependencies +(responsible for transcoding). They are not necessary to get SIMD optimizations +for search; those are enabled automatically. Hopefully, some day, the +`simd-accel` feature will similarly become unnecessary. Finally, optional PCRE2 support can be built with ripgrep by enabling the `pcre2` feature: @@ -404,8 +404,8 @@ Finally, optional PCRE2 support can be built with ripgrep by enabling the $ cargo build --release --features 'pcre2' ``` -(Tip: use `--features 'pcre2 simd-accel avx-accel'` to also include compile -time SIMD optimizations, which will only work with a nightly compiler.) +(Tip: use `--features 'pcre2 simd-accel'` to also include compile time SIMD +optimizations, which will only work with a nightly compiler.) Enabling the PCRE2 feature works with a stable Rust compiler and will attempt to automatically find and link with your system's PCRE2 library via |