]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
doc: Update bypass docs to use new keyword format
authorJames <sudosev@protonmail.ch>
Sun, 7 Jul 2024 17:43:02 +0000 (18:43 +0100)
committerVictor Julien <victor@inliniac.net>
Thu, 17 Apr 2025 06:22:11 +0000 (08:22 +0200)
Ticket: #7143

Update documentation to reflect new sticky buffer keyword format

doc/userguide/rules/bypass-keyword.rst

index e5505a68dd279c2a234317f89f76c9fc4e422291..86525a8480f64065b3375294e7abc95025720f41 100644 (file)
@@ -1,19 +1,23 @@
 Bypass Keyword
 ==============
 
-Suricata has a ``bypass`` keyword that can be used in signatures to exclude traffic from further evaluation.
+.. role:: example-rule-emphasis
 
-The ``bypass`` keyword is useful in cases where there is a large flow expected (e.g. Netflix, Spotify, YouTube).
+Suricata has a ``bypass`` keyword that can be used in signatures to exclude
+traffic from further evaluation.
 
-The ``bypass`` keyword is considered a post-match keyword.
+The ``bypass`` keyword is useful in cases where there is a large flow expected
+(e.g. Netflix, Spotify, YouTube).
 
+The ``bypass`` keyword is considered a post-match keyword.
 
 bypass
 ------
 
 Bypass a flow on matching http traffic.
 
-Example::
+.. container:: example-rule
 
-  alert http any any -> any any (content:"suricata.io"; \
-      http_host; bypass; sid:10001; rev:1;)
+  alert http any any -> any any (http.host; \
+  content:"suricata.io"; :example-rule-emphasis:`bypass;` \
+  sid:10001; rev:1;)