Explain API deprecations in Changelog for 1.0.0. release.

farsightsec · Aug 26, 2021 · b7506ed · b7506ed
1 parent 42a80c9
commit b7506ed
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,7 +1,17 @@
 nmsg (1.0.0)
 
   * Replace libxs with zeromq and associated calls.
-  * Change format of unknown rrtypes in nmsgtool JSON output.
+
+  * API functions nmsg_input_open_xs(), nmsg_input_open_xs_endpoint(),
+    nmsg_io_add_input_xs_channel(), nmsg_output_open_xs(), and
+    nmsg_output_open_xs_endpoint() are deprecated and replaced with
+    respectively: nmsg_input_open_zmq(), nmsg_input_open_zmq_endpoint(),
+    nmsg_io_add_input_zmq_channel(), nmsg_output_open_zmq(), and
+    nmsg_output_open_zmq_endpoint().
+
+  * Change format of unknown rrtypes in nmsgtool JSON output to "TYPE" followed
+    by number.
+
   * Update nmsgtool command-line options: --readzchan replaces --readzsock,
     --writezsock replaces --writexsock.
 

diff --git a/debian/changelog b/debian/changelog
@@ -1,7 +1,17 @@
 nmsg (1.0.0-1) debian-fsi; urgency=medium
 
   * Replace libxs with zeromq and associated calls.
-  * Change format of unknown rrtypes in nmsgtool JSON output.
+
+  * API functions nmsg_input_open_xs(), nmsg_input_open_xs_endpoint(),
+    nmsg_io_add_input_xs_channel(), nmsg_output_open_xs(), and
+    nmsg_output_open_xs_endpoint() are deprecated and replaced with
+    respectively: nmsg_input_open_zmq(), nmsg_input_open_zmq_endpoint(),
+    nmsg_io_add_input_zmq_channel(), nmsg_output_open_zmq(), and
+    nmsg_output_open_zmq_endpoint().
+
+  * Change format of unknown rrtypes in nmsgtool JSON output to "TYPE" followed
+    by number.
+
   * Update nmsgtool command-line options: --readzchan replaces --readzsock,
     --writezsock replaces --writexsock.