ITS#7771 mdb_cursor_put doc: Cursor moves on error
authorHallvard Furuseth <hallvard@openldap.org>
Fri, 30 May 2014 07:06:08 +0000 (09:06 +0200)
committerHallvard Furuseth <hallvard@openldap.org>
Fri, 30 May 2014 07:06:08 +0000 (09:06 +0200)
libraries/liblmdb/lmdb.h

index 4f46bbb..7a38a29 100644 (file)
@@ -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.