NEWS

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