changeset 21274:05e9415e545a

lib: Comment seq_range_array_invert() that its values must be within min_seq..max_seq
author Timo Sirainen <timo.sirainen@dovecot.fi>
date Thu, 08 Dec 2016 18:07:12 +0200
parents ff92e16346c9
children 319a5c683194
files src/lib/seq-range-array.h
diffstat 1 files changed, 3 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/src/lib/seq-range-array.h	Thu Dec 08 17:50:46 2016 +0200
+++ b/src/lib/seq-range-array.h	Thu Dec 08 18:07:12 2016 +0200
@@ -57,7 +57,9 @@
 /* Return number of sequences in the range. */
 unsigned int seq_range_count(const ARRAY_TYPE(seq_range) *array) ATTR_PURE;
 
-/* Invert the sequence range. For example 5:6 -> min_seq:4,7:max_seq. */
+/* Invert the sequence range. For example 5:6 -> min_seq:4,7:max_seq.
+   The array must not have any sequences outside min_seq..max_seq or this
+   function will assert-crash. */
 void seq_range_array_invert(ARRAY_TYPE(seq_range) *array,
 			    uint32_t min_seq, uint32_t max_seq);