Ensure validity of max_search_depth

[wimlib] / include / wimlib / bt_matchfinder.h

diff --git a/include/wimlib/bt_matchfinder.h b/include/wimlib/bt_matchfinder.h
index 1d30e36216a05876e8074956b3b7dfe4de2e012c..78ecdd751c20dd62c5787d52d8a81dda81d35ffb 100644 (file)
--- a/include/wimlib/bt_matchfinder.h
+++ b/include/wimlib/bt_matchfinder.h
@@ -127,8 +127,9 @@ bt_right_child(struct bt_matchfinder *mf, pos_t node)
  *     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
- *     Limit on the number of potential matches to consider.
+ *     Limit on the number of potential matches to consider.  Must be >= 1.
  * @next_hash
  *     Pointer to the hash code for the current sequence, which was computed
  *     one position in advance so that the binary tree root could be