diff options
author | Tushar Gohad <tushar.gohad@intel.com> | 2014-07-22 22:20:07 -0700 |
---|---|---|
committer | Tushar Gohad <tushar.gohad@intel.com> | 2014-07-22 22:20:07 -0700 |
commit | 7cc67fee9c2c9074af6eb7903f54322053482759 (patch) | |
tree | 48359f1ac4b53772af03aaa5c2ca88f010ed780f /include | |
parent | 779ff7402495b18d65e50d2a2e46e3c6b75568ef (diff) | |
download | liberasurecode-7cc67fee9c2c9074af6eb7903f54322053482759.tar.gz |
Minor API doc fixup (backend names)
Signed-off-by: Tushar Gohad <tushar.gohad@intel.com>
Diffstat (limited to 'include')
-rw-r--r-- | include/erasurecode/erasurecode.h | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/include/erasurecode/erasurecode.h b/include/erasurecode/erasurecode.h index 07cac3f..a56ebb5 100644 --- a/include/erasurecode/erasurecode.h +++ b/include/erasurecode/erasurecode.h @@ -94,7 +94,9 @@ struct ec_args { /* liberasurecode frontend API functions */ /** - * Returns a list of supported EC backend names + * Returns a list of EC backends implemented/enabled - the user should always + * rely on the return from this function as this set of backends can be + * different from the names listed in ec_backend_names above. */ void liberasurecode_supported_backends(char **backend_names); @@ -111,7 +113,9 @@ void liberasurecode_supported_backends(char **backend_names); * inline_checksum - * algsig_checksum - * backend-specific arguments + * null_args - arguments for the null backend * flat_xor_hd_args - arguments for the xor_hd backend + * jerasure_args - arguments for the Jerasure backend * * @returns liberasurecode instance descriptor (int > 0) */ |