release 1.4.0

Change-Id: I1e7f96cf96906450ef1323e1f9c48fcfd30f14ff
Signed-off-by: Thiago da Silva <thiago@redhat.com>

AUTHORS

@@ -6,6 +6,7 @@ Kevin Greenan (kmgreen2@gmail.com)
 Contributors
 ------------
 Timur Alperovich (timuralp@swiftstack.com)
+Tim Burke (tim.burke@gmail.com)
 Thiago da Silva (thiago@redhat.com)
 Eric Lambert (eric_lambert@xyratex.com)
 Ondřej Nový (ondrej.novy@firma.seznam.cz)

ChangeLog

@@ -1,3 +1,10 @@
+New in 1.4.0
+------------
+
+ * Add support for ISA-L Cauchy
+ * Fixed memory leak in get_metadata
+ * Added soft warning log line when using liberasurecode <1.3.1
+
 New in 1.3.1
 ------------
 

README.rst

@@ -1,3 +1,6 @@
+PyEClib
+-------
+
 This library provides a simple Python interface for implementing erasure codes
 and is known to work with Python v2.6, 2.7 and 3.x.
 
@@ -6,11 +9,11 @@ which is a C based erasure code library.  Please let us know if you have any
 issues building or installing (email: kmgreen2@gmail.com or tusharsg@gmail.com).
 
 PyECLib supports a variety of Erasure Coding backends including the standard Reed
-Soloman implementations provided by Jerasure [2], liberasurecode [3] and Intel
+Soloman implementations provided by Jerasure [1], liberasurecode [3] and Intel
 ISA-L [4].  It also provides support for a flat XOR-based encoder and decoder
 (part of liberasurecode) - a class of HD Combination Codes based on "Flat
 XOR-based erasure codes in storage systems: Constructions, efficient recovery,
-and tradeoffs" in IEEE MSST 2010).  These codes are well-suited to archival
+and tradeoffs" in IEEE MSST 2010[2]).  These codes are well-suited to archival
 use-cases, have a simple construction and require a minimum number of
 participating disks during single-disk reconstruction (think XOR-based LRC code).
 
@@ -28,6 +31,10 @@ Examples of using PyECLib are provided in the "tools" directory:
 
       tools/pyeclib_fragments_needed.py
 
+  A configuration utility to help compare available EC schemes in terms of
+  performance and redundancy::
+
+      tools/pyeclib_conf_tool.py
 
 PyEClib initialization::
 
@@ -39,13 +46,11 @@ Supported ``ec_type`` values:
 
   * ``liberasurecode_rs_vand`` => Vandermonde Reed-Solomon encoding, software-only backend implemented by liberasurecode [3]
   * ``jerasure_rs_vand`` => Vandermonde Reed-Solomon encoding, based on Jerasure [1]
-  * ``jerasure_rs_cauchy`` => Cauchy Reed-Solomon encoding (Jerasure variant), based on Jerasure [2]
+  * ``jerasure_rs_cauchy`` => Cauchy Reed-Solomon encoding (Jerasure variant), based on Jerasure [1]
   * ``flat_xor_hd_3``, ``flat_xor_hd_4`` => Flat-XOR based HD combination codes, liberasurecode [3]
   * ``isa_l_rs_vand`` => Intel Storage Acceleration Library (ISA-L) - SIMD accelerated Erasure Coding backends [4]
-  * ``shss`` => NTT Lab Japan's Erasure Coding Library
+  * ``isa_l_rs_cauchy`` => Cauchy Reed-Solomon encoding (ISA-L variant) [4]
-
+  * ``shss`` => NTT Lab Japan's Erasure Coding Library [5]
-A configuration utility is provided to help compare available EC schemes in 
-terms of performance and redundancy:: `tools/pyeclib_conf_tool.py`
 
 
 The Python API supports the following functions:
@@ -226,25 +231,25 @@ needs to be taken when handling input to and output from the ``encode()`` and
 
 Quick Start
 
-  Install pre-requisites:
+  Install pre-requisites::
 
     * Python 2.6, 2.7 or 3.x (including development packages), argparse, setuptools
     * liberasurecode v1.2.0 or greater [3]
     * Erasure code backend libraries, gf-complete and Jerasure [1],[2], ISA-L [4] etc
 
-    An example for ubuntu to install dependency packages:
+  An example for ubuntu to install dependency packages::
+
       $ sudo apt-get install build-essential python-dev python-pip liberasurecode-dev
       $ sudo pip install -U bindep -r test-requirement.txt
 
-    If you want to confirm all dependency packages installed succuessfully, try:
+  If you want to confirm all dependency packages installed successfully, try::
+
       $ sudo bindep -f bindep.txt
 
-    That shows missing dependency packages for you, http://docs.openstack.org/infra/bindep/
+  *Note*: currently liberasurecode-dev/liberasurecode-devel in package repo is older than v1.2.0
-
-    *Note*: currently liberasurecode-dev/liberasurecode-devel in package repo is older
-            than v1.2.0
 
   Install PyECLib::
+
       $ sudo python setup.py install
 
   Run test suite included::

doc/source/conf.py

@@ -48,9 +48,9 @@ copyright = u'2016, Kevin Greenan, Tushar Gohad, Kota Tsuyuzaki'
 # built documents.
 #
 # The short X.Y version.
-version = '1.3.1'
+version = '1.4.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.3.1'
+release = '1.4.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

setup.py

@@ -159,7 +159,7 @@ class install(_install):
 
 module = Extension('pyeclib_c',
                    define_macros=[('MAJOR VERSION', '1'),
-                                  ('MINOR VERSION', '3')],
+                                  ('MINOR VERSION', '4')],
                    include_dirs=[default_python_incdir,
                                  'src/c/pyeclib_c',
                                  '/usr/include',
@@ -172,12 +172,13 @@ module = Extension('pyeclib_c',
                    sources=['src/c/pyeclib_c/pyeclib_c.c'])
 
 setup(name='pyeclib',
-      version='1.3.1',
+      version='1.4.0',
       author='Kevin Greenan',
       author_email='kmgreen2@gmail.com',
       maintainer='Kevin Greenan and Tushar Gohad',
       maintainer_email='kmgreen2@gmail.com, tusharsg@gmail.com',
       url='http://git.openstack.org/cgit/openstack/pyeclib/',
+      bugtrack_url='https://bugs.launchpad.net/pyeclib',
       description='This library provides a simple Python interface for \
                    implementing erasure codes.  To obtain the best possible \
                    performance, the underlying erasure code algorithms are \