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