From: Juliana Fajardini <jufajardini@oisf.net>
Date: Tue, 6 May 2025 17:07:40 +0000 (-0300)
Subject: doc/exceptions: standardize page section markdown
X-Git-Url: http://git.ipfire.org/gitweb/gitweb.cgi?a=commitdiff_plain;h=c5269e2c269c3431d4127a4dd49f1dfdb6ab1b0a;p=thirdparty%2Fsuricata.git

doc/exceptions: standardize page section markdown

Following the discussion on #7396, use those symbols for to keep the
standard.
Remove the repeting `Exception Policies` section header, too.

Related to
Task #7396

(cherry picked from commit e5c1e5f7922697b67430fd67ff7048015d822381)
---

diff --git a/doc/userguide/configuration/exception-policies.rst b/doc/userguide/configuration/exception-policies.rst
index 9ce8188e15..5d99c116fb 100644
--- a/doc/userguide/configuration/exception-policies.rst
+++ b/doc/userguide/configuration/exception-policies.rst
@@ -1,7 +1,7 @@
 .. _exception policies:
 
 Exception Policies
-==================
+##################
 
 Suricata has a set of configuration variables to indicate what should the engine
 do when certain exception conditions, such as hitting a memcap, are reached.
@@ -13,13 +13,10 @@ For developers or for researching purposes, there are also simulation options
 exposed in debug mode and passed via command-line. These exist to force or
 simulate failures or errors and understand Suricata behavior under such conditions.
 
-Exception Policies
-------------------
-
 .. _master-switch:
 
 Master Switch
-~~~~~~~~~~~~~
+*************
 
 It is possible to set all configuration policies via what we call "master
 switch". This offers a quick way to define what the engine should do in case of
@@ -43,7 +40,7 @@ This value will be overwritten by specific exception policies whose settings are
 also defined in the yaml file.
 
 Auto
-''''
+====
 
 **In IPS mode**, the default behavior for most of the exception policies is to
 fail close. This means droping the flow, or the packet, when the flow action is
@@ -57,7 +54,7 @@ It is possible to disable this default, by setting the exception policies'
 ``master-switch``, or ignoring the exception policies.
 
 Specific settings
-~~~~~~~~~~~~~~~~~
+*****************
 
 Exception policies are implemented for:
 
@@ -116,7 +113,7 @@ The *drop*, *pass* and *reject* are similar to the rule actions described in :re
 actions<suricata-yaml-action-order>`.
 
 Exception Policies and Midstream Pick-up Sessions
--------------------------------------------------
+*************************************************
 
 Suricata behavior can be difficult to track in case of midstream session
 pick-ups. Consider this matrix illustrating the different interactions for
@@ -198,10 +195,11 @@ whole flow.
 Notes:
 
    * Not valid means that Suricata will error out and won't start.
-   * ``REJECT`` will make Suricata send a Reset-packet unreach error to the sender of the matching packet.
+   * ``REJECT`` will make Suricata send a Reset-packet unreach error to the sender
+     of the matching packet.
 
 Command-line Options for Simulating Exceptions
-----------------------------------------------
+==============================================
 
 It is also possible to force specific exception scenarios, to check engine
 behavior under failure or error conditions.