lib/matchfinder: document matchfinder_rebase() preconditions

ebiggers · Oct 29, 2020 · f8057e8 · f8057e8
1 parent 6d66819
commit f8057e8
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/matchfinder_common.h b/lib/matchfinder_common.h
@@ -75,6 +75,9 @@ matchfinder_init(mf_pos_t *data, size_t size)
  * hash bucket.  Note that in the latter table, the links are 1-ary in the case
  * of "hash chains", and 2-ary in the case of "binary trees".  In either case,
  * the links need to be rebased in the same way.
+ *
+ * 'data' must be aligned to a MATCHFINDER_MEM_ALIGNMENT boundary, and
+ * 'size' must be a multiple of MATCHFINDER_SIZE_ALIGNMENT.
  */
 #ifndef matchfinder_rebase
 static forceinline void