summaryrefslogtreecommitdiff
path: root/src/librsync.h
diff options
context:
space:
mode:
authorDonovan Baarda <abo@minkirri.apana.org.au>2019-09-18 14:24:28 +1000
committerDonovan Baarda <abo@minkirri.apana.org.au>2019-09-18 14:24:28 +1000
commit311dd066f43faba7a440cdbcfd9bb5487a54b8ab (patch)
treeca03725c242bbcf977d19b0c49dcda8b9ab6a18d /src/librsync.h
parenta811058fe95ce3b6555748cb3ac8ba58d8fec7ab (diff)
downloadlibrsync-311dd066f43faba7a440cdbcfd9bb5487a54b8ab.tar.gz
Tidy up rs_sig_args() docstring.
Diffstat (limited to 'src/librsync.h')
-rw-r--r--src/librsync.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/src/librsync.h b/src/librsync.h
index 463c7fd..676a648 100644
--- a/src/librsync.h
+++ b/src/librsync.h
@@ -419,10 +419,11 @@ LIBRSYNC_EXPORT rs_result rs_job_free(rs_job_t *);
* "unknown", and other arguments set to a value to use or zero for
* "recommended". On return zero input args will be set to recommended values
* and the returned result will indicate if any inputs were invalid. The
- * strong_len input is considered a minimum value where 0 means "maxium", and
- * will be increased if the suggested value for the old_fsize is larger. You
- * should set strong_len to at least 16 or ideally 0 if you need protection
- * against hash collision attacks.
+ * strong_len input is considered a minimum value where 0 means "maximum", and
+ * will be increased if the suggested value for the old_fsize is larger. Use
+ * strong_len=0 for the best protection against hash collision attacks. Use
+ * strong_len=1 for the smallest signature size that is safe for the given file
+ * size and block length.
*
* \param old_fsize - the original file size (-1 for "unknown").
*