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