Ensure validity of max_search_depth

[wimlib] / include / wimlib / hc_matchfinder.h

diff --git a/include/wimlib/hc_matchfinder.h b/include/wimlib/hc_matchfinder.h
index 1403a15781039a49f0400e4789ecde9667f7b261..a5cca95e6a9d18032aad1ae8004ec33650ecd3a1 100644 (file)
--- a/include/wimlib/hc_matchfinder.h
+++ b/include/wimlib/hc_matchfinder.h
@@ -145,8 +145,9 @@ hc_matchfinder_init(struct hc_matchfinder *mf)
  *     The maximum permissible match length at this position.
  * @nice_len
  *     Stop searching if a match of at least this length is found.
  *     The maximum permissible match length at this position.
  * @nice_len
  *     Stop searching if a match of at least this length is found.

+ *     Must be <= @max_len.

  * @max_search_depth
  * @max_search_depth

- *     Limit on the number of potential matches to consider.
+ *     Limit on the number of potential matches to consider.  Must be >= 1.

  * @offset_ret
  *     If a match is found, its offset is returned in this location.
  *
  * @offset_ret
  *     If a match is found, its offset is returned in this location.
  *