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.

diff --git a/doc/userguide/devguide/index.rst b/doc/userguide/devguide/index.rst
index 9393af8b320904251512ad284e26e940033fca04..bcfac16812c82df3a713cdeccd875201a9297cdc 100644 (file)
--- 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 (file)
index 0000000..fb5d0c3
--- /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.
+