zfec: update docs

This commit is contained in:
Zooko O'Whielacronx 2007-04-20 11:45:16 -07:00
parent f4beff38c4
commit 948f958a72
2 changed files with 15 additions and 13 deletions

View File

@ -1,18 +1,20 @@
* Intro and Licence
This package implements an "erasure code", or "forward error correction code".
It is offered under the GNU General Public License v2 or (at your option) any
later version. This package also comes with the added permission that, in the
case that you are obligated to release a derived work under this licence (as
per section 2.b of the GPL), you may delay the fulfillment of this obligation
for up to 12 months.
This package implements an "erasure code", or "forward error correction
code".
The most widely known example of an erasure code is the RAID-5 algorithm which
makes it so that in the event of the loss of any one hard drive, the stored
data can be completely recovered. The algorithm in the zfec package has a
similar effect, but instead of recovering from the loss of only a single
element, it can be parameterized to choose in advance the number of elements
whose loss it can tolerate.
It is offered under the GNU General Public License v2 or (at your option) any
later version. This package also comes with the added permission that, in
the case that you are obligated to release a derived work under this licence
(as per section 2.b of the GPL), you may delay the fulfillment of this
obligation for up to 12 months.
The most widely known example of an erasure code is the RAID-5 algorithm
which makes it so that in the event of the loss of any one hard drive, the
stored data can be completely recovered. The algorithm in the zfec package
has a similar effect, but instead of recovering from the loss of only a
single element, it can be parameterized to choose in advance the number of
elements whose loss it can tolerate.
This package is largely based on the old "fec" library by Luigi Rizzo et al.,
which is a mature and optimized implementation of erasure coding. The zfec

View File

@ -61,7 +61,7 @@ trove_classifiers=[
setup(name='zfec',
version='1.0.0a3',
summary='a fast C implementation of Reed-Solomon erasure coding with command-line, C, and Python interfaces',
description='Erasure coding -- also called "forward error correction" -- is the generation of redundant blocks of information such that if some blocks are lost ("erased") then the original data can be recovered from the remaining blocks. This package contains an optimized implementation along with command-line, C, and Python interfaces.',
description='Fast, portable, programmable erasure coding a.k.a. "forward error correction": the generation of redundant blocks of information such that if some blocks are lost then the original data can be recovered from the remaining blocks.',
author='Zooko O\'Whielacronx',
author_email='zooko@zooko.com',
url='http://allmydata.com/source/zfec',