]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
doc: Remove bitmask documentation
authorJeff Lucovsky <jeff@lucovsky.org>
Mon, 23 Mar 2020 13:08:14 +0000 (09:08 -0400)
committerJeff Lucovsky <jeff@lucovsky.org>
Mon, 23 Mar 2020 13:08:14 +0000 (09:08 -0400)
This commit removes documentation for the never-implemented bitmask
option for the `byte_jump` and `byte_test` keywords.

doc/userguide/rules/payload-keywords.rst

index ad4e5814af024280d013de91e68fe23232cf4827..bee555c5231698d06da7730167d231e552ff02ae 100644 (file)
@@ -304,7 +304,7 @@ The ``byte_test`` keyword extracts ``<num of bytes>`` and performs an operation
 Format::
   
   byte_test:<num of bytes>, [!]<operator>, <test value>, <offset> [,relative] \
-  [,<endian>][, string, <num type>][, dce][, bitmask <bitmask value>]
+  [,<endian>][, string, <num type>][, dce]; 
 
 
 +----------------+------------------------------------------------------------------------------+
@@ -337,8 +337,6 @@ Format::
 +----------------+------------------------------------------------------------------------------+
 | [dce]                 | Allow the DCE module determine the byte order                                |
 +----------------+------------------------------------------------------------------------------+
-| [bitmask]     | Applies the AND operator on the bytes converted                              |
-+----------------+------------------------------------------------------------------------------+
 
 
 Example::
@@ -376,7 +374,7 @@ Format::
 
   byte_jump:<num of bytes>, <offset> [, relative][, multiplier <mult_value>] \
        [, <endian>][, string, <num_type>][, align][, from_beginning][, from_end] \ 
-        [, post_offset <value>][, dce][, bitmask <value>];
+        [, post_offset <value>][, dce];
 
 +-----------------------+-----------------------------------------------------------------------+
 | <num of bytes>       | The number of bytes selected from the packet to be converted          |
@@ -408,9 +406,6 @@ Format::
 +-----------------------+-----------------------------------------------------------------------+
 | [dce]                        | Allow the DCE module determine the byte order                         |
 +-----------------------+-----------------------------------------------------------------------+
-| [bitmask] <value>    | The AND operator will be applied by <value> and the                   |
-|                      | converted bytes, then jump operation is performed                     |
-+-----------------------+-----------------------------------------------------------------------+
 
 Example::