]> git.ipfire.org Git - thirdparty/vectorscan.git/commitdiff
update description of HS_FLAG_SOM_LEFTMOST to eliminate ambiguity
authorHong, Yang A <yang.a.hong@intel.com>
Thu, 16 Apr 2020 12:16:14 +0000 (12:16 +0000)
committerHong, Yang A <yang.a.hong@intel.com>
Mon, 25 May 2020 13:47:53 +0000 (13:47 +0000)
doc/dev-reference/compilation.rst
src/hs_compile.h

index a2eee106da19df4e822a17831087b161d1985be4..e78552b40897588a94d9537ebf306052183bf618 100644 (file)
@@ -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
index 4c372ffe06ba2ba0c89281856fa3d4c85c57b06d..8f48a79253e6a3ce13f64e5f3307e76c6c32cfac 100644 (file)
@@ -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