Merge pull request #2968 in SNORT/snort3 from ~OSHUMEIK/snort3:doc_warning to master

Squashed commit of the following:

commit d27f3da7bfab2d1f2ca0ebe212967934d3b892d8
Author: Oleksii Shumeiko <oshumeik@cisco.com>
Date:   Tue Jul 6 14:31:32 2021 +0300

    doc: fix build warnings

    Thanks to jiangrj (github.com/jiangrij) for reporting the issue.

    Fixing indention, nested list.
    Escaping control characters.

diff --git a/doc/user/overview.txt b/doc/user/overview.txt
index 287b0e81d235bbf5ba9aaa0cfc0a8e82e3e8a6be..378247bf87c8747bdcfaa3d934c072dabdd0fdec 100644 (file)
--- a/doc/user/overview.txt
+++ b/doc/user/overview.txt
@@ -234,7 +234,7 @@ If we also wanted to limit retries to at least 5 seconds, we could do:
 
     active = { max_responses = 1, min_interval = 5 }
 
-== Lua Variables
+==== Lua Variables
 
 The following Global Lua Variables are available when Snort is run with
 a lua config using -c option.

diff --git a/src/service_inspectors/http_inspect/dev_notes.txt b/src/service_inspectors/http_inspect/dev_notes.txt
index 671bc978814dff4d5e70d68fe4cd8cf689705902..ace30ff37c39af706c68e6fe3b13a0372b45f30c 100755 (executable)
--- a/src/service_inspectors/http_inspect/dev_notes.txt
+++ b/src/service_inspectors/http_inspect/dev_notes.txt
@@ -290,10 +290,10 @@ generate 119:202 regardless of whether the chunk length eventually turns out to
 4. The chunk length in hexadecimal format. The chunk length may be zero (see above) but it must be
 present. Both upper and lower case hex letters are acceptable. The 0x prefix for hex numbers is not
 acceptable.
-
++
 The goal here is a hexadecimal number followed by CRLF ending the chunk header. Many things may go
 wrong:
-
++
 * More than 8 hex digits other than the leading zeros. The number is limited by Snort to fit into
   32 bits and if it does not that is a fatal error.
 * The CR may be missing, leaving a bare LF as the separator. That generates 119:235 after which
@@ -374,7 +374,7 @@ Insert commands:
   $h2frameheader <frame_type> <frame_length> <flags> <stream_id> generates an HTTP/2 frame header.
     The frame type may be the frame type name in all lowercase or the numeric frame type code:
       (data|headers|priority|rst_stream|settings|push_promise|ping|goaway|window_update|
-      continuation|{0:9})
+      continuation|\{0:9\})
     The frame length is the length of the frame payload, may be in decimal or test tool hex value
       (\xnn, see below under escape sequence for more details)
     The frame flags are represented as a single test tool hex byte (\xnn)