From: Hallvard Furuseth <hallvard@openldap.org>
Date: Fri, 30 May 2014 07:06:08 +0000 (+0200)
Subject: ITS#7771 mdb_cursor_put doc: Cursor moves on error
X-Git-Tag: OPENLDAP_REL_ENG_2_4_40~132^2~10
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=92c01ffda80fe2224391b46b9be12eeb449456bf;p=openldap

ITS#7771 mdb_cursor_put doc: Cursor moves on error
---

diff --git a/libraries/liblmdb/lmdb.h b/libraries/liblmdb/lmdb.h
index 4f46bbb153..7a38a29cbb 100644
--- a/libraries/liblmdb/lmdb.h
+++ b/libraries/liblmdb/lmdb.h
@@ -1336,9 +1336,9 @@ int  mdb_cursor_get(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
 	/** @brief Store by cursor.
 	 *
 	 * This function stores key/data pairs into the database.
-	 * If the function fails for any reason, the state of the cursor will be
-	 * unchanged. If the function succeeds and an item is inserted into the
-	 * database, the cursor is always positioned to refer to the newly inserted item.
+	 * The cursor is positioned at the new item, or on failure usually near it.
+	 * @note Earlier documentation incorrectly said errors would leave the
+	 * state of the cursor unchanged.
 	 * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
 	 * @param[in] key The key operated on.
 	 * @param[in] data The data operated on.