From: Hallvard Furuseth <hallvard@openldap.org>
Date: Tue, 19 Feb 2013 20:14:23 +0000 (+0100)
Subject: ITS#7485 Document key/data size limits in lmdb.h.
X-Git-Tag: OPENLDAP_REL_ENG_2_4_34~3^2~10
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=8ad25001ffed13d12d1e84705002cc799b6c8676;p=openldap

ITS#7485 Document key/data size limits in lmdb.h.

mdb.c already describes them. The user doc should too.
---

diff --git a/libraries/liblmdb/lmdb.h b/libraries/liblmdb/lmdb.h
index aaaa2922f1..220eea1c6a 100644
--- a/libraries/liblmdb/lmdb.h
+++ b/libraries/liblmdb/lmdb.h
@@ -192,7 +192,14 @@ typedef unsigned int	MDB_dbi;
 /** @brief Opaque structure for navigating through a database */
 typedef struct MDB_cursor MDB_cursor;
 
-/** @brief Generic structure used for passing keys and data in and out of the database. */
+/** @brief Generic structure used for passing keys and data in and out
+ * of the database.
+ *
+ * Key sizes must be between 1 and the liblmdb build-time constant
+ * #MDB_MAXKEYSIZE inclusive. This currently defaults to 511. The
+ * same applies to data sizes in databases with the #MDB_DUPSORT flag.
+ * Other data items can in theory be from 0 to 0xffffffff bytes long.
+ */
 typedef struct MDB_val {
 	size_t		 mv_size;	/**< size of the data item */
 	void		*mv_data;	/**< address of the data item */