diff options
author | Andrew Gallant <jamslam@gmail.com> | 2018-08-23 09:55:31 -0400 |
---|---|---|
committer | Andrew Gallant <jamslam@gmail.com> | 2018-08-23 09:56:37 -0400 |
commit | 1bb8b7170f4e35da87cd73efdf1e4d3a5c3a416c (patch) | |
tree | ef1283db0bdf7d34fd7c7c5be8a97d768fd51486 /README.md | |
parent | 55ed698a98286b42ae7a79b0762b190c52c8ef38 (diff) |
doc: clarify use of SIMD features
You need a nightly compiler.
Ref #188
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 17 |
1 files changed, 9 insertions, 8 deletions
@@ -385,14 +385,15 @@ $ cargo build --release --features 'pcre2' ``` (Tip: use `--features 'pcre2 simd-accel avx-accel'` to also include compile -time SIMD optimizations.) - -Enabling the PCRE2 feature will attempt to automatically find and link with -your system's PCRE2 library via `pkg-config`. If one doesn't exist, then -ripgrep will build PCRE2 from source using your system's C compiler and then -statically link it into the final executable. Static linking can be forced even -when there is an available PCRE2 system library by either building ripgrep with -the MUSL target or by setting `PCRE2_SYS_STATIC=1`. +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 +`pkg-config`. If one doesn't exist, then ripgrep will build PCRE2 from source +using your system's C compiler and then statically link it into the final +executable. Static linking can be forced even when there is an available PCRE2 +system library by either building ripgrep with the MUSL target or by setting +`PCRE2_SYS_STATIC=1`. ripgrep can be built with the MUSL target on Linux by first installing the MUSL library on your system (consult your friendly neighborhood package manager). |