zfec: add warning about changed share header in zfec v1.1

darcs-hash:93fac0833f5926037ab3bf56b7776d160e346246

diff --git a/zfec/README.txt b/zfec/README.txt
index 2bd576379269861305e67d16d7a3a349236318d9..b3b16e59605b3c5297c8aad4b56bc0149b909069 100644 (file)
--- a/zfec/README.txt
+++ b/zfec/README.txt
@@ -96,6 +96,10 @@ input to the encoding step.
 
  * Command-Line Tool
 
+NOTE: the format of the sharefiles was changed in zfec v1.1 to allow K == 1 
+and K == M.  This change of the format of sharefiles means that zfec >= v1.1 
+cannot read sharefiles produced by zfec < v1.1.
+
 The bin/ directory contains two Unix-style, command-line tools "zfec" and 
 "zunfec".  Execute "zfec --help" or "zunfec --help" for usage instructions.
 
@@ -233,5 +237,5 @@ releasing it under a Free Software licence.
 Enjoy!
 
 Zooko Wilcox-O'Hearn
-2007-04-27
+2007-10-01
 Boulder, Colorado

diff --git a/zfec/zfec/filefec.py b/zfec/zfec/filefec.py
index 35d64c5cb6c2a5e366efbb492a059a6c4f3d3dcf..7e502a79d4998765add02141b609a57cd920057b 100644 (file)
--- a/zfec/zfec/filefec.py
+++ b/zfec/zfec/filefec.py
@@ -28,7 +28,7 @@ def _build_header(m, k, pad, sh):
     @param pad: the number of bytes of padding added to the file before encoding; 0 <= pad < k
     @param sh: the shnum of this share; 0 <= k < m
 
-    @return: a string (which is hopefully short) encoding m, k, sh, and pad
+    @return: a compressed string encoding m, k, pad, and sh
     """
     assert m >= 1
     assert m <= 2**8