Skip to content

Commit efd086c

Browse files
committed
Clarify a bit the documentation wrt. match/regex
This closes #468
1 parent a9b53d0 commit efd086c

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

doc/source/config.rst

+13-13
Original file line numberDiff line numberDiff line change
@@ -436,23 +436,23 @@ Filters
436436

437437
- ``alias(description)``: human-readable ``description`` of the rule
438438
- ``cidr(ip/mask)``: match on the client's `cidr <https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing>`_
439-
- ``filename(name)``: match in the file ``name``
440-
- ``filename_r(regexp)``: the file name matching the ``regexp``
441-
- ``function(name)``: match on function ``name``
442-
- ``function_r(regexp)``: the function matching the ``regexp``
443-
- ``hash(sha256)``: match on the file's `sha256 <https://en.wikipedia.org/wiki/SHA-2>`_ sum
444-
- ``line(line_number)``: match on the file's line.
445-
- ``param(name)``: match on the function's parameter ``name``
439+
- ``filename(name)``: exact match on the file's ``name``
440+
- ``filename_r(regexp)``: file name matching the ``regexp``
441+
- ``function(name)``: exact match on function ``name``
442+
- ``function_r(regexp)``: function name matching the ``regexp``
443+
- ``hash(sha256)``: exact match on the file's `sha256 <https://en.wikipedia.org/wiki/SHA-2>`_ sum
444+
- ``line(line_number)``: exact match on the file's line.
445+
- ``param(name)``: exact match on the function's parameter ``name``
446446
- ``param_r(regexp)``: match on the function's parameter ``regexp``
447-
- ``param_type(type)``: match on the function's parameter ``type``
448-
- ``pos(nth_argument)``: match on the nth argument, starting from ``0``
449-
- ``ret(value)``: match on the function's return ``value``
447+
- ``param_type(type)``: exact match on the function's parameter ``type``
448+
- ``pos(nth_argument)``: exact match on the nth argument, starting from ``0``
449+
- ``ret(value)``: exact match on the function's return ``value``
450450
- ``ret_r(regexp)``: match with a ``regexp`` on the function's return
451451
- ``ret_type(type_name)``: match on the ``type_name`` of the function's return value
452-
- ``value(value)``: match on a literal ``value``
452+
- ``value(value)``: exact match on a literal ``value``
453453
- ``value_r(regexp)``: match on a value matching the ``regexp``
454-
- ``var(name)``: match on a **local variable** ``name``
455-
- ``key(name)``: match on the presence of ``name`` as a key in the hashtable
454+
- ``var(name)``: exact match on a **local variable** ``name``
455+
- ``key(name)``: exact match on the presence of ``name`` as a key in the hashtable
456456
- ``key_r(regexp)``: match with ``regexp`` on keys in the hashtable
457457

458458
The ``type`` must be one of the following values:

0 commit comments

Comments
 (0)