document module API+ABI changes

diff --git a/NEWS b/NEWS
index 33b8e68593c65c01c1b75c080504ce7abf349ee0..fe5429b154b381a4fcbe71b070082f06b425eb88 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -42,6 +42,8 @@ Bugfixes
 Module API changes
 ------------------
 - kr_straddr_split() changed API a bit (compiler will catch that)
+- C modules defining `*_layer` or `*_props` symbols need to change a bit
+  See the upgrading guide for details.  It's detected on module load.
 
 
 Knot Resolver 3.2.1 (2019-01-10)

diff --git a/doc/upgrading.rst b/doc/upgrading.rst
index 013d41c0f696f4abb520c1eab1679fce30fc99df..c638d32c260105dc8ad2c483806dcde577fd062c 100644 (file)
--- a/doc/upgrading.rst
+++ b/doc/upgrading.rst
@@ -63,6 +63,9 @@ Module changes
   ``kres_modules.*``.
 * ``kr_straddr_split()`` API has changed.
 
+* C modules defining ``*_layer`` or ``*_props`` symbols need to use a different style, but it's typically a trivial change.
+  Instead of exporting the corresponding symbols, the module should assign pointers to its static structures inside its ``*_init()`` function.  Example migration:
+  `bogus_log module <https://gitlab.labs.nic.cz/knot/knot-resolver/commit/2875a3970#9fa69cdc6ee1903dc22e3262f58996395acab364>`_.
 
 .. _upgrade-from-2-to-3: