doc/guides/regexdevs/features_overview.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2020 Mellanox Technologies, Ltd
   3
   4 Overview of RegEx Drivers Features
   5 ==================================
   6
   7 This section explains the supported features that are listed in the table below.
   8
   9 Cross buffer
  10   Support cross buffer detection.
  11
  12 PCRE start anchor
  13   Support PCRE start anchor.
  14
  15 PCRE atomic grouping
  16   Support PCRE atomic grouping.
  17
  18 PCRE back reference
  19   Support PCRE back regerence.
  20
  21 PCRE back tracking ctrl
  22   Support PCRE back tracking ctrl.
  23
  24 PCRE call outs
  25   Support PCRE call outes.
  26
  27 PCRE forward reference
  28   Support Forward reference.
  29
  30 PCRE greedy
  31   Support PCRE greedy mode.
  32
  33 PCRE match all
  34   Support PCRE match all.
  35
  36 PCRE match as end
  37   Support match as end.
  38
  39 PCRE match point rst
  40   Support PCRE match point reset directive.
  41
  42 PCRE New line conventions
  43   Support new line conventions.
  44
  45 PCRE new line SEQ
  46   Support new line sequence.
  47
  48 PCRE look around
  49   Support PCRE look around.
  50
  51 PCRE possessive qualifiers
  52   Support PCRE possessive qualifiers.
  53
  54 PCRE subroutine references
  55   Support PCRE subroutine references.
  56
  57 PCRE UTF 8
  58   Support UTF-8.
  59
  60 PCRE UTF 16
  61   Support UTF-16.
  62
  63 PCRE UTF 32
  64   Support UTF-32.
  65
  66 PCRE word boundary
  67   Support word boundaries.
  68
  69 Run time compilation
  70   Support compilation during run time.
  71
  72 Armv8
  73   Support armv8 (64bit) architecture.
  74
  75 x86
  76   Support x86 architecture.
  77
  78 .. note::
  79
  80    Most of the features capabilities should be provided by the drivers via the
  81    RegEx ``info_get`` operation.
  82
  83
  84 References
  85 ==========
  86
  87   * `PCRE: PCRE pattern man page <https://www.pcre.org/original/doc/html/pcrepattern.html>`_
  88
  89
  90 Features Table
  91 ==============
  92
  93 .. _table_regex_pmd_features:
  94
  95 .. include:: overview_feature_table.txt
  96
  97 .. Note::
  98
  99    Features marked with "P" are partially supported. Refer to the appropriate
 100    driver guide in the following sections for details.