]> git.ipfire.org Git - thirdparty/haproxy.git/commitdiff
DOC: install: recommend pcre2
authorAbhijeet Rastogi <abhijeet.1989@gmail.com>
Thu, 8 Feb 2024 02:47:42 +0000 (18:47 -0800)
committerWilly Tarreau <w@1wt.eu>
Thu, 8 Feb 2024 07:55:57 +0000 (08:55 +0100)
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

INSTALL
Makefile

diff --git a/INSTALL b/INSTALL
index 8ebf8d298ce6cc5ac898b9c04c2534035ff117e3..ad0596b8706c0c6e1c9c64364eb069c28ec695fe 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -34,18 +34,18 @@ are a few build examples :
   - recent Linux system with all options, make and install :
     $ make clean
     $ 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
 
   - 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 :
-    $ 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
 
   - 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
 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
 regex, you may benefit from using some alternative regex implementations such as
-PCRE. HAProxy natively supports PCRE and PCRE2, both in standard and JIT
-flavors (Just In Time). The following options are available depending on the
-library version provided on your system :
+PCRE. HAProxy natively supports PCRE and PCRE2 (recommended), both in standard
+and JIT flavors (Just In Time). The following options are available depending on
+the library version provided on your system :
 
   - "USE_PCRE=1"         : enable PCRE version 1, dynamic linking
   - "USE_STATIC_PCRE=1"  : enable PCRE version 1, static linking
index f1b870b0ed7fb8033545db6f544bf22891889f80..207ae57ba438587d0638491e38b3e6938775300e 100644 (file)
--- a/Makefile
+++ b/Makefile
 #   USE_KQUEUE              : enable kqueue() on BSD. Automatic.
 #   USE_EVPORTS             : enable event ports on SunOS systems. 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_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_POLL                : enable poll(). Automatic.
 #   USE_THREAD              : enable threads support.
-#   USE_STATIC_PCRE         : enable static libpcre. Recommended.
-#   USE_STATIC_PCRE2        : enable static libpcre2.
+#   USE_STATIC_PCRE         : enable static libpcre.
+#   USE_STATIC_PCRE2        : enable static libpcre2. Recommended.
 #   USE_TPROXY              : enable transparent proxy. Automatic.
 #   USE_LINUX_TPROXY        : enable full transparent proxy. Automatic.
 #   USE_LINUX_SPLICE        : enable kernel 2.6 splicing. Automatic.