From: Zooko O'Whielacronx <zooko@zooko.com>
Date: Fri, 20 Apr 2007 18:45:16 +0000 (-0700)
Subject: zfec: update docs
X-Git-Tag: tahoe_v0.1.0-0-UNSTABLE~12
X-Git-Url: https://git.rkrishnan.org/pf/content/en/seg/bcase?a=commitdiff_plain;h=948f958a723d8cefaa7363223fb70eac59e01dcd;p=tahoe-lafs%2Ftahoe-lafs.git

zfec: update docs
---

diff --git a/zfec/README.txt b/zfec/README.txt
index f7c76da4..b8df225e 100644
--- a/zfec/README.txt
+++ b/zfec/README.txt
@@ -1,18 +1,20 @@
  * Intro and Licence
 
-This package implements an "erasure code", or "forward error correction code".
+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.
-
-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.
+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
diff --git a/zfec/setup.py b/zfec/setup.py
index 9bd37e11..01a31247 100644
--- a/zfec/setup.py
+++ b/zfec/setup.py
@@ -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',