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