From: Alexandre Iooss <erdnaxe@crans.org>
Date: Fri, 28 Jul 2023 07:46:02 +0000 (+0200)
Subject: doc/userguide: improve SCStreamingBuffer example
X-Git-Tag: suricata-7.0.1~53
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c80941dd8dbe359377deb26acc832e667c281da4;p=thirdparty%2Fsuricata.git

doc/userguide: improve SCStreamingBuffer example

Add direction indication in SCStreamingBuffer usage example.
This adds documentation for the changes introduced by commit
5b1d8c7e94ef613107870d4d9d9cdde76d4c3438.
---

diff --git a/doc/userguide/lua/lua-functions.rst b/doc/userguide/lua/lua-functions.rst
index 9eff240f53..92473d52c3 100644
--- a/doc/userguide/lua/lua-functions.rst
+++ b/doc/userguide/lua/lua-functions.rst
@@ -960,7 +960,13 @@ SCStreamingBuffer
 ::
 
   function log(args)
-      data = SCStreamingBuffer()
+      -- sb_ts and sb_tc are bools indicating the direction of the data
+      data, sb_open, sb_close, sb_ts, sb_tc = SCStreamingBuffer()
+      if sb_ts then
+        print("->")
+      else
+        print("<-")
+      end
       hex_dump(data)
   end