DOC: install: recommend pcre2

Makefile comments are also updated to recommend the PCRE2 related
options. PCRE1 is EOL by now:

   https://www.mail-archive.com/haproxy@formilux.org/msg41326.html
This commit is contained in:
Abhijeet Rastogi 2024-02-07 18:47:42 -08:00 committed by Willy Tarreau
parent 66b20aada4
commit 2192dfa6b6
2 changed files with 11 additions and 11 deletions

14
INSTALL
View File

@ -34,18 +34,18 @@ are a few build examples :
- recent Linux system with all options, make and install : - recent Linux system with all options, make and install :
$ make clean $ make clean
$ make -j $(nproc) TARGET=linux-glibc \ $ make -j $(nproc) TARGET=linux-glibc \
USE_OPENSSL=1 USE_LUA=1 USE_PCRE=1 USE_SYSTEMD=1 USE_OPENSSL=1 USE_LUA=1 USE_PCRE2=1 USE_SYSTEMD=1
$ sudo make install $ sudo make install
- FreeBSD and OpenBSD, build with all options : - FreeBSD and OpenBSD, build with all options :
$ gmake -j 4 TARGET=freebsd USE_OPENSSL=1 USE_LUA=1 USE_PCRE=1 $ gmake -j 4 TARGET=freebsd USE_OPENSSL=1 USE_LUA=1 USE_PCRE2=1
- embedded Linux, build using a cross-compiler : - embedded Linux, build using a cross-compiler :
$ make -j $(nproc) TARGET=linux-glibc USE_OPENSSL=1 USE_PCRE=1 \ $ make -j $(nproc) TARGET=linux-glibc USE_OPENSSL=1 USE_PCRE2=1 \
CC=/opt/cross/gcc730-arm/bin/gcc ADDLIB=-latomic CC=/opt/cross/gcc730-arm/bin/gcc ADDLIB=-latomic
- Build with static PCRE on Solaris / UltraSPARC : - Build with static PCRE on Solaris / UltraSPARC :
$ make TARGET=solaris CPU=ultrasparc USE_STATIC_PCRE=1 $ make TARGET=solaris CPU=ultrasparc USE_STATIC_PCRE2=1
For more advanced build options or if a command above reports an error, please For more advanced build options or if a command above reports an error, please
read the following sections. read the following sections.
@ -181,9 +181,9 @@ regex engine which could be slow or even crash on certain patterns.
If you plan on importing a particularly heavy configuration involving a lot of If you plan on importing a particularly heavy configuration involving a lot of
regex, you may benefit from using some alternative regex implementations such as regex, you may benefit from using some alternative regex implementations such as
PCRE. HAProxy natively supports PCRE and PCRE2, both in standard and JIT PCRE. HAProxy natively supports PCRE and PCRE2 (recommended), both in standard
flavors (Just In Time). The following options are available depending on the and JIT flavors (Just In Time). The following options are available depending on
library version provided on your system : the library version provided on your system :
- "USE_PCRE=1" : enable PCRE version 1, dynamic linking - "USE_PCRE=1" : enable PCRE version 1, dynamic linking
- "USE_STATIC_PCRE=1" : enable PCRE version 1, static linking - "USE_STATIC_PCRE=1" : enable PCRE version 1, static linking

View File

@ -17,14 +17,14 @@
# USE_KQUEUE : enable kqueue() on BSD. Automatic. # USE_KQUEUE : enable kqueue() on BSD. Automatic.
# USE_EVPORTS : enable event ports on SunOS systems. Automatic. # USE_EVPORTS : enable event ports on SunOS systems. Automatic.
# USE_NETFILTER : enable netfilter on Linux. Automatic. # USE_NETFILTER : enable netfilter on Linux. Automatic.
# USE_PCRE : enable use of libpcre for regex. Recommended. # USE_PCRE : enable use of libpcre for regex.
# USE_PCRE_JIT : enable JIT for faster regex on libpcre >= 8.32 # USE_PCRE_JIT : enable JIT for faster regex on libpcre >= 8.32
# USE_PCRE2 : enable use of libpcre2 for regex. # USE_PCRE2 : enable use of libpcre2 for regex. Recommended.
# USE_PCRE2_JIT : enable JIT for faster regex on libpcre2 # USE_PCRE2_JIT : enable JIT for faster regex on libpcre2
# USE_POLL : enable poll(). Automatic. # USE_POLL : enable poll(). Automatic.
# USE_THREAD : enable threads support. # USE_THREAD : enable threads support.
# USE_STATIC_PCRE : enable static libpcre. Recommended. # USE_STATIC_PCRE : enable static libpcre.
# USE_STATIC_PCRE2 : enable static libpcre2. # USE_STATIC_PCRE2 : enable static libpcre2. Recommended.
# USE_TPROXY : enable transparent proxy. Automatic. # USE_TPROXY : enable transparent proxy. Automatic.
# USE_LINUX_TPROXY : enable full transparent proxy. Automatic. # USE_LINUX_TPROXY : enable full transparent proxy. Automatic.
# USE_LINUX_SPLICE : enable kernel 2.6 splicing. Automatic. # USE_LINUX_SPLICE : enable kernel 2.6 splicing. Automatic.