src/bindings/rmr-python/docs/Changelog.rst

   1 Change Log
   2 ==========
   3
   4 All notable changes to this project will be documented in this file.
   5
   6 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__
   7 and this project adheres to `Semantic
   8 Versioning <http://semver.org/>`__.
   9
  10 [0.13.4] - 10/21/2019
  11 --------------------
  12
  13 ::
  14
  15     * Correct cause of nil pointer exception in message summary.
  16
  17
  18 [0.13.3] - 10/10/2019
  19 --------------------
  20
  21 ::
  22
  23     * Add missing unit test for receive all.
  24     * Correct bug in summary function.
  25
  26 [0.13.2] - 10/2/2019
  27 --------------------
  28
  29 ::
  30
  31     * Fix a constant name (RMRFL_MT_CALL)
  32
  33 [0.13.1] - 10/1/2019
  34 --------------------
  35
  36 ::
  37
  38     * Correct unit test bug in rmr-python. With RMR 1.8.x connections are forced to be asynch by default to prevent kubernetes blocking the attempt for minutes. However, the asynch nature of connections makes unit tests concerned with the ability to send and receive messages non-deterministic as some connections are established before the first message is sent, and others are not. This change ensures that unit tests establish connections in a synchronous manner which ensures that the first send will not be rejected by NNG due to a pending connection.
  39
  40 [0.13.0] - 9/27/2019
  41 --------------------
  42
  43 ::
  44    * Add a helpers module to provide extensions and helper functions such as receive all queued messages.
  45    * Enhance unit test to check only for RMR constants which are needed.
  46    * Correct unprintable characters in documentation.
  47
  48
  49 [0.12.0] - 8/23/2019
  50 --------------------
  51
  52 ::
  53    * Add final unit tests for rmr.py; unit test coverage for rmr python is about 95%. The remaining functions are dangerous to unit test directly, e.g., rcv which may block forever
  54    * Fix a bug where meid was being intepreted as bytes (but then cast into a string); the correct interpretation is a string, so now it will truncate after a null byte.
  55    * Removes access to the raw function rmr_get_meid(ptr, dest) in favor of just rmr_get_meid(ptr). Also get_meid is now rmr_get_meid since it wasn't consistent with the naming.
  56
  57
  58 [0.11.0] - 8/21/2019
  59 --------------------
  60
  61 ::
  62    * Overhaul unit tests to remove mocking from the rmr tests, which gives much greater confidence in changing the code. More is still needed however, specifically test sends and test receives.
  63    * Adds an alias rmr_set_meid to rmr_bytes2meid for naming consistency.
  64    * Found a possible inconsistency/bug that requires further investigation later; setting meid takes bytes, but getting it returns a string.
  65
  66
  67 [0.10.8] - 8/20/2019
  68 --------------------
  69
  70 ::
  71    * Fix invocation of _rmr_alloc function
  72
  73
  74 [0.10.7] - 8/14/2019
  75 --------------------
  76
  77 ::
  78    * Finish sphinx documentation
  79    * Make public functions that wrap ctype declarions, allowing for docstrings
  80    * Fix a bug where rmr_set_stimeout was pointing to the wrong function
  81
  82
  83 [0.10.6] - 8/13/2019
  84 --------------------
  85
  86 ::
  87    * Moves Changelog.md to this file, to be consistent with rst-ification
  88    * Sets up a Dockerfile to generate documentation for rmr-python using sphinx
  89
  90
  91 [0.10.5] - 8/13/2019
  92 --------------------
  93
  94 ::
  95
  96    * Make the PYPI page for rmr look nicer.
  97
  98 .. _section-1:
  99
 100 [0.10.4] - 8/08/2019
 101 --------------------
 102
 103 ::
 104
 105    * Fix underlying problem getting errno from some environments; now references new RMR message field to get errno value.
 106    * Add /usr/local/lib64 to tox environment variable to support systems where libraries natually install in lib64 rather than lib.
 107
 108 .. _section-2:
 109
 110 [0.10.3] - 7/31/2019
 111 --------------------
 112
 113 ::
 114
 115    * (Correctly) Include license here per Jira RICPLT-1855
 116
 117 .. _section-3:
 118
 119 [0.10.2] - 7/31/2019
 120 --------------------
 121
 122 ::
 123
 124    * Include license here per Jira RICPLT-1855
 125
 126 .. _section-4:
 127
 128 [0.10.0] - 5/15/2019
 129 --------------------
 130
 131 ::
 132
 133    * Fix a bug in rmr mock that prevented it for being used for rmr_rcv (was only usable for rmr_torcv)
 134    * Add more unit tests, esp for message summary
 135    * Remove meid truncation in the case where a nil is present mid string
 136    * Change the defaul mock of meid and get_src to something more useful
 137
 138 .. _section-5:
 139
 140 [0.9.0] - 5/13/2019
 141 -------------------
 142
 143 ::
 144
 145    * Add a new module for mocking out rmr-python, useful for other packages that depend on rmr-python
 146
 147 .. _section-6:
 148
 149 [0.8.4] - 5/10/2019
 150 -------------------
 151
 152 ::
 153
 154    * Add some unit tests; more to come
 155
 156 .. _section-7:
 157
 158 [0.8.3] - 5/8/2019
 159 ------------------
 160
 161 ::
 162
 163    * Better loop indexing in meid string handling
 164
 165 .. _section-8:
 166
 167 [0.8.2] - 5/8/2019
 168 ------------------
 169
 170 ::
 171
 172    * Fix examples bug
 173    * add liscneses for LF push
 174
 175 .. _section-9:
 176
 177 [0.8.1] - 5/7/2019
 178 ------------------
 179
 180 ::
 181
 182    * Better andling of meid in message summary
 183
 184 .. _section-10:
 185
 186 [0.8.0] - 5/7/2019
 187 ------------------
 188
 189 ::
 190
 191    * Refactor some code to be more functional
 192    * Put back RMR_MAX_RCV_BYTES as a constant
 193    * Add tox.ini, although right now it only LINTs
 194
 195 .. _section-11:
 196
 197 [0.7.0] - 5/6/2019
 198 ------------------
 199
 200 ::
 201
 202    * Add constant fetching from RMr library
 203
 204 .. _section-12:
 205
 206 [0.6.0] - 5/6/2019
 207 ------------------
 208
 209 ::
 210
 211    * Add a new field to rmr_mbuf_t: sub_id
 212    * Fix prior commits lint-ailing python style
 213
 214 .. _section-13:
 215
 216 [0.5.0] - 5/3/2019
 217 ------------------
 218
 219 ::
 220
 221    * Add errno access via new function: rmr.errno()
 222    * Add new functions to access new RMr header fields: get_src, get_meid, rmr_bytes2meid
 223    * Add new RMr constants for error states
 224
 225 .. _section-14:
 226
 227 [0.4.1] - 4/8/2019
 228 ------------------
 229
 230 ::
 231
 232    * Fix a non-ascii encoding issue
 233
 234 .. _section-15:
 235
 236 [0.4.0] - 3/28/2019
 237 -------------------
 238
 239 ::
 240
 241    * Greatly imroved test sender/receiver
 242    * Three new functions implemented (rmr_close, rmr_set_stimeout, rmr_payload_size)
 243
 244 .. _section-16:
 245
 246 [0.3.0] - 3/26/2019
 247 -------------------
 248
 249 ::
 250
 251    * Support a new receive function that (hurray!) has a timeout
 252
 253 .. _section-17:
 254
 255 [0.2.1] - 3/25/2019
 256 -------------------
 257
 258 ::
 259
 260    * Add two new MR states
 261
 262 .. _section-18:
 263
 264 [0.2.0] - 3/25/2019
 265 -------------------
 266
 267 ::
 268
 269    * Switch to NNG from nanomessage
 270
 271 .. _section-19:
 272
 273 [0.1.0] - 3/14/2019
 274 -------------------
 275
 276 ::
 277
 278    * Initial Creation