summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTushar Gohad <tushar.gohad@intel.com>2015-01-30 18:30:40 -0700
committerTushar Gohad <tushar.gohad@intel.com>2015-01-30 18:42:05 -0700
commit92c39d590c63fd1dced7b3934962f47428c3c03d (patch)
tree1caf7b39b3c1b9bfb6c911a72f6473c62feeee59 /README.md
parentff5dd3901748c5419ba3cfd328ebcfb2503be4d1 (diff)
downloadliberasurecode-92c39d590c63fd1dced7b3934962f47428c3c03d.tar.gz
doc: Update decode() param force_metadata_checks
Signed-off-by: Tushar Gohad <tushar.gohad@intel.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 3 insertions, 4 deletions
diff --git a/README.md b/README.md
index 00f7c1c..548208c 100644
--- a/README.md
+++ b/README.md
@@ -178,17 +178,16 @@ int liberasurecode_encode_cleanup(int desc, char **encoded_data,
* @param fragments - erasure encoded fragments (> = k)
* @param num_fragments - number of fragments being passed in
* @param fragment_len - length of each fragment (assume they are the same)
+ * @param force_metadata_checks - force fragment metadata checks (default: 0)
* @param out_data - _output_ pointer to decoded data
* @param out_data_len - _output_ length of decoded output
- * (both output data pointers are allocated by liberasurecode,
- * caller invokes liberasurecode_decode_clean() after it has
- * read decoded data in 'out_data')
*
* @return 0 on success, -error code otherwise
*/
int liberasurecode_decode(int desc,
char **available_fragments, /* input */
int num_fragments, uint64_t fragment_len, /* input */
+ int force_metadata_checks, /* input */
char **out_data, uint64_t *out_data_len); /* output */
/**
@@ -420,4 +419,4 @@ Code organization
|-- INSTALL
+-- ChangeLog
```
---- \ No newline at end of file
+---