From 22991f2da1bd849cb19ca363e8956f3a151231f2 Mon Sep 17 00:00:00 2001 From: "Hong, Yang A" Date: Thu, 16 Apr 2020 12:16:14 +0000 Subject: [PATCH] update description of HS_FLAG_SOM_LEFTMOST to eliminate ambiguity --- doc/dev-reference/compilation.rst | 4 ++-- src/hs_compile.h | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/dev-reference/compilation.rst b/doc/dev-reference/compilation.rst index a2eee106..e78552b4 100644 --- a/doc/dev-reference/compilation.rst +++ b/doc/dev-reference/compilation.rst @@ -55,7 +55,7 @@ Hyperscan provides support for targeting a database at a particular CPU platform; see :ref:`instr_specialization` for details. ===================== -Compile Pure Literals +Compile Pure Literals ===================== Pure literal is a special case of regular expression. A character sequence is @@ -98,7 +98,7 @@ In ``v5.2.0``, Hyperscan introduces 2 new compile APIs for pure literal patterns #. :c:func:`hs_compile_lit_multi`: compiles an array of pure literals into a pattern database. All of the supplied patterns will be scanned for concurrently at scan time, with user-supplied identifiers returned when they - match. + match. These 2 APIs are designed for use cases where all patterns contained in the target rule set are pure literals. Users can pass the initial pure literal diff --git a/src/hs_compile.h b/src/hs_compile.h index 4c372ffe..8f48a792 100644 --- a/src/hs_compile.h +++ b/src/hs_compile.h @@ -985,8 +985,8 @@ hs_error_t HS_CDECL hs_populate_platform(hs_platform_info_t *platform); * offset when a match is reported for this expression. (By default, no start * of match is returned.) * - * Enabling this behaviour may reduce performance and increase stream state - * requirements in streaming mode. + * For all the 3 modes, enabling this behaviour may reduce performance. And + * particularly, it may increase stream state requirements in streaming mode. */ #define HS_FLAG_SOM_LEFTMOST 256