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