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