From 8284df3ed426bc0e07899fc12c51b944b3627e33 Mon Sep 17 00:00:00 2001 From: Jason Ish Date: Mon, 11 Mar 2024 17:23:33 -0600 Subject: [PATCH] devguide: add an upgrade section Add an upgrade section to the devguide. This should cover any changes to APIs that users might be using from plugins or as a library user. --- doc/userguide/devguide/index.rst | 1 + doc/userguide/devguide/upgrading/index.rst | 21 +++++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 doc/userguide/devguide/upgrading/index.rst diff --git a/doc/userguide/devguide/index.rst b/doc/userguide/devguide/index.rst index 9393af8b32..bcfac16812 100644 --- a/doc/userguide/devguide/index.rst +++ b/doc/userguide/devguide/index.rst @@ -9,3 +9,4 @@ Suricata Developer Guide internals/index.rst extending/index.rst libsuricata/index.rst + upgrading/index.rst diff --git a/doc/userguide/devguide/upgrading/index.rst b/doc/userguide/devguide/upgrading/index.rst new file mode 100644 index 0000000000..fb5d0c3e6a --- /dev/null +++ b/doc/userguide/devguide/upgrading/index.rst @@ -0,0 +1,21 @@ +Upgrading +========= + +Upgrading 7.0 to 8.0 +-------------------- + +EVE File Types +~~~~~~~~~~~~~~ + +- The ``ThreadInit`` function will now be called when in *threaded* + and *non-threaded* modes. This simplifies the initialization for EVE + filetypes as they can use the same flow of execution for both + modes. To upgrade, either remove the call to ``ThreadInit`` from + ``Init``, or move per-thread setup code from ``Init`` to + ``ThreadInit``. +- Many of the function arguments to the callbacks have been made + ``const`` where it made sense. + +Please see the latest example EVE filetype plugin for an up to date +example. +