]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
doc/lua: Lua API name consistency
authorJeff Lucovsky <jeff@lucovsky.org>
Wed, 13 Jan 2021 18:39:21 +0000 (13:39 -0500)
committerVictor Julien <victor@inliniac.net>
Thu, 14 Jan 2021 11:48:14 +0000 (12:48 +0100)
This commit updates the documentation of the SCFlow* function names
available to Lua scripts.

Formerly, they used the prefix "Sc"; now they use "SC".

doc/userguide/lua/lua-functions.rst

index 293b31cd7680aa0934efc4d74c36a04665f96cc7..c5b53729b8796dcf0ba3b7babac155a4581965c5 100644 (file)
@@ -879,39 +879,39 @@ index so in our case we need to use 0.
 ::
 
  function match(args)
-     a = ScFlowintGet(0);
+     a = SCFlowintGet(0);
      if a then
-         ScFlowintSet(0, a + 1)
+         SCFlowintSet(0, a + 1)
      else
-         ScFlowintSet(0, 1)
+         SCFlowintSet(0, 1)
      end 
 
-ScFlowintGet
+SCFlowintGet
 ~~~~~~~~~~~~
 
 Get the Flowint at index given by the parameter.
 
-ScFlowintSet
+SCFlowintSet
 ~~~~~~~~~~~~
 
 Set the Flowint at index given by the first parameter. The second parameter is the value.
 
-ScFlowintIncr
+SCFlowintIncr
 ~~~~~~~~~~~~~
 
 Increment Flowint at index given by the first parameter.
 
-ScFlowintDecr
+SCFlowintDecr
 ~~~~~~~~~~~~~
 
 Decrement Flowint at index given by the first parameter.
 
-ScFlowvarGet
+SCFlowvarGet
 ~~~~~~~~~~~~
 
 Get the Flowvar at index given by the parameter.
 
-ScFlowvarSet
+SCFlowvarSet
 ~~~~~~~~~~~~
 
 Set a Flowvar. First parameter is the index, second is the data
@@ -929,13 +929,13 @@ You can use it to set string
  end
  
  function match(args)
-     a = ScFlowvarGet(0);
+     a = SCFlowvarGet(0);
      if a then
          a = tostring(tonumber(a)+1)
-         ScFlowvarSet(0, a, #a)
+         SCFlowvarSet(0, a, #a)
      else
          a = tostring(1)
-         ScFlowvarSet(0, a, #a)
+         SCFlowvarSet(0, a, #a)
      end 
 
 Misc