summaryrefslogtreecommitdiff
path: root/src/include/utils/varbit.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/utils/varbit.h')
-rw-r--r--src/include/utils/varbit.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/include/utils/varbit.h b/src/include/utils/varbit.h
index 2a4ec67698e..c4ae4685865 100644
--- a/src/include/utils/varbit.h
+++ b/src/include/utils/varbit.h
@@ -21,6 +21,11 @@
/*
* Modeled on struct varlena from postgres.h, but data type is bits8.
+ *
+ * Caution: if bit_len is not a multiple of BITS_PER_BYTE, the low-order
+ * bits of the last byte of bit_dat[] are unused and MUST be zeroes.
+ * (This allows bit_cmp() to not bother masking the last byte.)
+ * Also, there should not be any excess bytes counted in the header length.
*/
typedef struct
{