zfec: update in-line comments/docs

darcs-hash:8ed8783b257bbbc7f65efa4f9fd7ff0b2700a03a

diff --git a/zfec/README.txt b/zfec/README.txt
index a4e991010e43204d6712ba358ef9c8bbc2ec43ef..5c3e30e3e65f3c260711be1cd9320eef5c6b16fb 100644 (file)
--- a/zfec/README.txt
+++ b/zfec/README.txt
@@ -22,8 +22,8 @@ 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
 package makes several changes from the original "fec" package, including
 addition of the Python API, refactoring of the C API to support zero-copy
-operation, a few clean-ups and micro-optimizations of the core code itself, 
-and the addition of a command-line tool named "zfec".
+operation, a few clean-ups and optimizations of the core code itself, and the
+addition of a command-line tool named "zfec".
 
 
  * Installation

diff --git a/zfec/zfec/fec.h b/zfec/zfec/fec.h
index 60cb14bdf1aa46da10c53977c72615ce18416ebe..e9f11081b4e900ad34dac9cab8ed7b2166b929e0 100644 (file)
--- a/zfec/zfec/fec.h
+++ b/zfec/zfec/fec.h
@@ -23,6 +23,7 @@ void fec_free(fec_t* p);
  * @param inpkts the "primary blocks" i.e. the chunks of the input data
  * @param fecs buffers into which the secondary blocks will be written
  * @param block_nums the numbers of the desired blocks -- including both primary blocks (the id < k) which fec_encode() ignores and check blocks (the id >= k) which fec_encode() will produce and store into the buffers of the fecs parameter
+XXX wrong -- it includes only the block nums of the secondary blocks
  * @param num_block_nums the length of the block_nums array
  */
 void fec_encode(const fec_t* code, const gf*restrict const*restrict const src, gf*restrict const*restrict const fecs, const unsigned*restrict const block_nums, size_t num_block_nums, size_t sz);