Store doc/readme and doc/news in git
[pylibacl.git] / NEWS
1 News
2 ====
3
4 Version 0.6.0
5 -------------
6
7 *Sun, 29 Nov 2020*
8
9 Major release removing Python 2 support. This allow both code cleanup
10 and new features, such as:
11
12 - Support for pathlib objects in `apply_to` and `has_extended`
13   functions when running with Python 3.6 and newer.
14 - Use of built-in C API functions for bytes/unicode/pathlib conversion
15   when dealing with file names, removing custom code (with the
16   associated benefits).
17
18 Important API changes/bug fixes:
19
20 - Initialisation protocol has been changed, to disallow uninitialised
21   objects; this means that `__new__` will always create valid objects,
22   to prevent the need for checking initialisation status in all code
23   paths; this also (implicitly) fixes memory leaks on re-initialisation
24   (calling `__init__(…)` on an existing object) and segfaults (!) on
25   non-initialised object attribute access. Note ACL re-initialisation is
26   tricky and (still) leads to undefined behaviour of existing Entry
27   objects pointing to it.
28 - Fix another bug in ACL re-initialisation where failures would result
29   in invalid objects; now failed re-initialisation does not touch the
30   original object.
31 - Restore `__setstate__`/`__getstate__` support on Linux; this was
32   inadvertently removed due a typo(!) when adding support for it in
33   FreeBSD. Pickle should work again for ACL instances, although not sure
34   how stable this serialisation format actually is.
35 - Additionally, slightly change `__setstate__()` input to not allow
36   Unicode, since the serialisation format is an opaque binary format.
37 - Fix (and change) entry qualifier (which is a user/group ID) behaviour:
38   assume/require that uid_t/gid_t are unsigned types (they are with
39   glibc, MacOS and FreeBSD at least; the standard doesn't document the
40   signedness), and convert parsing and returning the qualifier to behave
41   accordingly. The breakage was most apparent on 32-bit architectures,
42   in which context the problem was originally reported (see issue #13).
43
44 Minor improvements:
45
46 - Added a `data` keyword argument to `ACL()`, which allows restoring an
47   ACL directly from a serialised form (as given by `__getstate__()`),
48   which should simplify some uses cases (`a = ACL(); a.__set
49   state__(…)`).
50 - When available, add the file path to I/O error messages, which should
51   lead to easier debugging.
52 - The test suite has changed to `pytest`, which allows increased
53   coverage via parameterisation.
54
55 Version 0.5.4
56 -------------
57
58 *released Thu, 14 Nov 2019*
59
60 Maintenance release:
61
62 - Switch build system to Python 3 by default (can be overridden if
63   needed).
64 - Internal improvements for better cpychecker support.
65 - Fix compatibility with PyPy.
66 - Test improvements (both local and on Travis), testing more variations
67   (debug, PyPy).
68 - Improve test coverage, and allow gathering test coverage results.
69 - Drop support (well, drop testing) for Python lower than 2.7.
70 - Minor documentation improvements (closes #9, #12).
71
72 Version 0.5.3
73 -------------
74
75 *released Thu, 30 Apr 2015*
76
77 FreeBSD fixes:
78
79 - Enable all FreeBSD versions after 7.x at level 2 (thanks to Garrett
80   Cooper).
81 - Make test suite pass under FreeBSD, which has a stricter behaviour
82   with regards to invalid ACLs (which we do exercise in the test suite),
83   thanks again to Garret for the bug reports.
84
85 Version 0.5.2
86 -------------
87
88 *released Sat, 24 May 2014*
89
90 No visible changes release: just fix tests when running under pypy.
91
92 Version 0.5.1
93 -------------
94
95 *released Sun, 13 May 2012*
96
97 A bug-fix only release. Critical bugs (memory leaks and possible
98 segmentation faults) have been fixed thanks to Dave Malcolm and his
99 ``cpychecker`` tool. Additionally, some compatibility issues with Python
100 3.x have been fixed (str() methods returning bytes).
101
102 The documentation has been improved and changed from epydoc to sphinx;
103 note however that the documentation is still auto-generated from the
104 docstrings.
105
106 Project reorganisation: the project home page has been moved from
107 SourceForge to GitHub.
108
109 Version 0.5
110 -----------
111
112 *released Sun, 27 Dec 2009*
113
114 Added support for Python 3.x and improved support for Unicode filenames.
115
116 Version 0.4
117 -----------
118
119 *released Sat, 28 Jun 2008*
120
121 License
122 ~~~~~~~
123
124 Starting with this version, pylibacl is licensed under LGPL 2.1,
125 Febryary 1999 or any later versions (see README.rst and COPYING).
126
127 Linux support
128 ~~~~~~~~~~~~~
129
130 A few more Linux-specific functions:
131
132 - add the ACL.equiv_mode() method, which will return the equivalent
133   octal mode if this is a basic ACL and raise an IOError exception
134   otherwise
135
136 - add the acl_extended(...) function, which will check if an fd or path
137   has an extended ACL
138
139 FreeBSD support
140 ~~~~~~~~~~~~~~~
141
142 FreeBSD 7.x will have almost all the acl manipulation functions that
143 Linux has, with the exception of __getstate__/__setstate__. As a
144 workaround, use the str() and ACL(text=...) methods to pass around
145 textual representations.
146
147 Interface
148 ~~~~~~~~~
149
150 At module level there are now a few constants exported for easy-checking
151 at runtime what features have been compiled in:
152
153 - HAS_ACL_FROM_MODE, denoting whether the ACL constructor supports the
154   mode=0xxx parameter
155
156 - HAS_ACL_CHECK, denoting whether ACL instances support the check()
157   method
158
159 - HAS_ACL_ENTRY, denoting whether ACL manipulation is possible and the
160   Entry and Permset classes are available
161
162 - HAS_EXTENEDED_CHECK, denoting whether the acl_extended function is
163   supported
164
165 - HAS_EQUIV_MODE, denoting whether ACL instances support the
166   equiv_mode() method
167
168 Internals
169 ~~~~~~~~~
170
171 Many functions have now unittests, which is a good thing.
172
173
174 Version 0.3
175 -----------
176
177 *released Sun, 21 Oct 2007*
178
179 Linux support
180 ~~~~~~~~~~~~~
181
182 Under Linux, implement more functions from libacl:
183
184 - add ACL(mode=...), implementing acl_from_mode
185 - add ACL().to_any_text, implementing acl_to_any_text
186 - add ACL comparison, using acl_cmp
187 - add ACL().check, which is a more descriptive function than validate
188
189 .. Local Variables:
190 .. mode: rst
191 .. fill-column: 72
192 .. End: