From: Jeff Lucovsky <jeff@lucovsky.org>
Date: Mon, 23 Mar 2020 13:08:14 +0000 (-0400)
Subject: doc: Remove bitmask documentation
X-Git-Tag: suricata-5.0.3~82
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3d7f654f3718458d67357a699239ddb2145004d2;p=thirdparty%2Fsuricata.git

doc: Remove bitmask documentation

This commit removes documentation for the never-implemented bitmask
option for the `byte_jump` and `byte_test` keywords.
---

diff --git a/doc/userguide/rules/payload-keywords.rst b/doc/userguide/rules/payload-keywords.rst
index ad4e5814af..bee555c523 100644
--- a/doc/userguide/rules/payload-keywords.rst
+++ b/doc/userguide/rules/payload-keywords.rst
@@ -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::