Fix field name case in debian/copyright (Upstream-contact => Upstream-Contact).
[debian-pyxattr.git] / NEWS
1 News
2 ====
3
4 Version 0.6.1
5 -------------
6
7 *released Tue, 24 Jul 2018*
8
9 Minor bugfix, performance and compatibility release.
10
11 * Minor compatibility fix: on Linux, drop the use of the `attr` library,
12   and instead switch to the glibc header `sys/xattr.h`, which is
13   provided for a really long time (since glibc 2.3). The formerly used
14   header `attr/xattr.h` has been removed from the `attr` library in
15   version 2.4.48. Fix provided by Lars Wendler, many thanks!
16 * Release the GIL when performing I/O. Patch proposed by xwhuang, many
17   thanks. I tested this a long while back it seemed to impact
18   performance on local filesystems, but upon further inspection, the
19   downsides are minor (between 0 and 5%, in many cases negligible). For
20   remote or slow filesystems, this should allow much increased
21   parallelism.
22 * Fix symlink set operation on MacOS X; bugfix provided by adamlin, much
23   appreciated! This also uncovered testing problems related to symlinks,
24   which are now fixed (the bug would be caught by the updated tests).
25
26 Version 0.6.0
27 -------------
28
29 *released Mon, 23 Jan 2017*
30
31 Bugfix and feature release (hence the version bump).
32
33 The main change is to the implementation of how attributes are listed
34 and read. This was done due to existing race issues when attributes are
35 modified while being read (github issue #12), but basically all various
36 internal paths that dealt with retrieving an attribute value or listing
37 attributes were unified in a single helper function that does handle
38 such concurrent modifications. As a side effect, the size of the buffers
39 used for such reads have changed, which (depending on attribute value)
40 might change the trade-off between number of syscalls done and memory
41 usage.
42
43 As feature release, OSX support was contributed by Adam Knight
44 <adam@movq.us>, thanks a lot! I don't have access to OSX so the testing
45 for it is done via Travis builds; please report any issues.
46
47 Version 0.5.6
48 -------------
49
50 *released Sat, 09 Apr 2016*
51
52 Small bugfix release:
53
54 * Fixes some sign-compare warnings
55 * Fixes potential name truncation in merge_ns()
56 * Fixes building on systems which don't have ENODATA
57
58 Tested with Python 2.7.11, Python 3.5.1 and PyPy 5.0.1.
59
60 Version 0.5.5
61 -------------
62
63 *released Fri, 01 May 2015*
64
65 Bugfix release:
66
67 * fixes some more memory leaks when handling out-of-memory in get_all()
68   function
69 * improve error reporting when an attribute disappears after we asked
70   for its length but before we managed to read it
71 * fix int/size_t issues found by RedHat/Fedora,
72   https://bugzilla.redhat.com/show_bug.cgi?id=1127310; the fix is
73   different than their fix, but it should accomplish the same thing
74 * convert all code to only do explicit casts after checking boundaries,
75   making the code `-Wconversion`-clean (although that warning is not
76   enabled by default)
77
78 Version 0.5.4
79 -------------
80
81 *released Thu, 30 Apr 2015*
82
83 Fix memory leaks on some of the error-handling paths of the `get()`
84 function.
85
86 Version 0.5.3
87 -------------
88
89 *released Fri, 23 May 2014*
90
91 Small optimisations release:
92
93 * ari edelkind contributed a speed-up optimisation for handling of files
94   without xattrs (which is, in general, the expected case)
95 * Jonas Borgström contributed a behaviour change to the handling of file
96   names: under Python 3 and up, unicode paths are encoded/decoded using
97   the 'surogatee' handler, instead of the 'strict' handler; while this
98   can hide encoding errors, it mirrors what Python libraries do
99   (e.g. see os.fsencode/fsdecode)
100 * Sean Patrick Santos contributed improvements to the test suite so that
101   it can be used even on files systems which have built-in attributes
102   (e.g. when using SELinux, or NFSv4); to enable this, define the
103   attributes in the TEST_IGNORE_XATTRS environment variable
104
105 Version 0.5.2
106 -------------
107
108 *released Thu, 03 Jan 2013*
109
110 Bug-fix release. Thanks to Michał Górny, it looked like the library had
111 problem running under pypy, but actually there was a bug in the
112 PyArg_ParseTuple use of et# (signed vs. unsigned, and lack of compiler
113 warnings). This was fixed, and now the test suite passed with many
114 CPython versions and PyPy (version 1.9).
115
116 Version 0.5.1
117 -------------
118
119 *released Wed, 16 May 2012*
120
121 Bug-fix release. Thanks to Dave Malcolm and his cpychecker tool, a
122 number of significant bugs (refcount leaks and potential NULL-pointer
123 dereferences) have been fixed.
124
125 Furthermore, compatibility with Python 3 has been improved; this however
126 required changing the meaning of the ``namespace`` argument to the
127 functions: if passed, None is no longer a valid value; pass an empty
128 string if (due to the structure of your program) you have to pass this
129 argument but want to specify no namespace.
130
131 Also, the project home page has changed from SourceForge to GitHub, and
132 the documentation has been converted from epydoc-based to sphinx.
133
134
135 Version 0.5
136 -----------
137
138 *released Sun, 27 Dec 2009*
139
140 Implemented support for Python 3. This required a significant change to
141 the C module, hence the new version number.
142
143 Version 0.4
144 -----------
145
146 *released Mon, 30 Jun 2008*
147
148 API
149 ~~~
150
151 The old functions ({get,set,list,remove}xattr) are deprecated and replaced with
152 a new API that is namespace-aware and hopefully will allow other OSes (e.g.
153 FreeBSD) to be supported more naturally.
154
155 Both the old and the new API are supported in the 0.4 versions, however users
156 are encouraged to migrate to the new API.
157
158 New features
159 ~~~~~~~~~~~~
160
161 A new bulk get function called get_all() has been added that should be somewhat
162 faster in case of querying files which have many attributes.
163
164 License
165 ~~~~~~~
166
167 Since LGPLv3 is not compatible with GPLv2 (which unfortunately I didn't realize
168 before), the license was changed to LGPLv2.1 or later.
169
170 Internals
171 ~~~~~~~~~
172
173 Unittest coverage was improved.
174
175 Version 0.3
176 -----------
177
178 *released Sun, 09 Mar 2008*
179
180 * changed licence from GPL to LGPL (3 or later)
181 * changed listxattr return type from tuple to a list
182 * developer-related: added unittests
183
184 Version 0.2.2
185 -------------
186
187 *released Sun, 01 Jul 2007*
188
189 * fixed listing symlink xattrs
190
191 Version 0.2.1
192 -------------
193
194 *released Sat, 11 Feb 2006*
195
196 * fixed a bug when reading symlink EAs (you weren't able to
197   do it, actually)
198 * fixed a possible memory leak when the actual read of the EA
199   failed but the call to get the length of the EA didn't
200
201 .. Local Variables:
202 .. mode: rst
203 .. fill-column: 72
204 .. End: