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