Happy New Year

[openldap] / libraries / liblmdb / lmdb.h

diff --git a/libraries/liblmdb/lmdb.h b/libraries/liblmdb/lmdb.h
index 11b46bfa4866faca3c5eefacabc0d445ed8393e1..117f16ea3120d3a67c8b9785c128200b11172710 100644 (file)
--- a/libraries/liblmdb/lmdb.h
+++ b/libraries/liblmdb/lmdb.h
@@ -119,7 +119,7 @@
  *
  *     @author Howard Chu, Symas Corporation.
  *
- *     @copyright Copyright 2011-2014 Howard Chu, Symas Corp. All rights reserved.
+ *     @copyright Copyright 2011-2015 Howard Chu, Symas Corp. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted only as authorized by the OpenLDAP
@@ -194,7 +194,7 @@ typedef int mdb_filehandle_t;
        MDB_VERINT(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH)
 
 /** The release date of this library version */
-#define MDB_VERSION_DATE       "July 24, 2014"
+#define MDB_VERSION_DATE       "September 20, 2014"
 
 /** A stringifier for the version info */
 #define MDB_VERSTR(a,b,c,d)    "LMDB " #a "." #b "." #c ": (" d ")"
@@ -516,8 +516,8 @@ int  mdb_env_create(MDB_env **env);
         *              and uses fewer mallocs, but loses protection from application bugs
         *              like wild pointer writes and other bad updates into the database.
         *              Incompatible with nested transactions.
-        *              Processes with and without MDB_WRITEMAP on the same environment do
-        *              not cooperate well.
+        *              Do not mix processes with and without MDB_WRITEMAP on the same
+        *              environment.  This can defeat durability (#mdb_env_sync etc).
         *      <li>#MDB_NOMETASYNC
         *              Flush system buffers to disk only once per transaction, omit the
         *              metadata flush. Defer that until the system flushes files to disk,
@@ -698,7 +698,8 @@ int  mdb_env_info(MDB_env *env, MDB_envinfo *stat);
         * Data is always written to disk when #mdb_txn_commit() is called,
         * but the operating system may keep it buffered. LMDB always flushes
         * the OS buffers upon commit as well, unless the environment was
-        * opened with #MDB_NOSYNC or in part #MDB_NOMETASYNC.
+        * opened with #MDB_NOSYNC or in part #MDB_NOMETASYNC. This call is
+        * not valid if the environment was opened with #MDB_RDONLY.
         * @param[in] env An environment handle returned by #mdb_env_create()
         * @param[in] force If non-zero, force a synchronous flush.  Otherwise
         *  if the environment has the #MDB_NOSYNC flag set the flushes
@@ -706,6 +707,7 @@ int  mdb_env_info(MDB_env *env, MDB_envinfo *stat);
         * @return A non-zero error value on failure and 0 on success. Some possible
         * errors are:
         * <ul>
+        *      <li>EACCES - the environment is read-only.
         *      <li>EINVAL - an invalid parameter was specified.
         *      <li>EIO - an error occurred during synchronization.
         * </ul>
@@ -1025,9 +1027,9 @@ int  mdb_txn_renew(MDB_txn *txn);
         * After a successful commit the
         * handle will reside in the shared environment, and may be used
         * by other transactions. This function must not be called from
-        * multiple concurrent transactions. A transaction that uses this function
-        * must finish (either commit or abort) before any other transaction may
-        * use this function.
+        * multiple concurrent transactions in the same process. A transaction
+        * that uses this function must finish (either commit or abort) before
+        * any other transaction in the process may use this function.
         *
         * To use named databases (with name != NULL), #mdb_env_set_maxdbs()
         * must be called before opening the environment.  Database names
@@ -1270,10 +1272,9 @@ int  mdb_get(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
         *              LMDB does nothing else with this memory, the caller is expected
         *              to modify all of the space requested.
         *      <li>#MDB_APPEND - append the given key/data pair to the end of the
-        *              database. No key comparisons are performed. This option allows
-        *              fast bulk loading when keys are already known to be in the
-        *              correct order. Loading unsorted keys with this flag will cause
-        *              data corruption.
+        *              database. This option allows fast bulk loading when keys are
+        *              already known to be in the correct order. Loading unsorted keys
+        *              with this flag will cause a #MDB_KEYEXIST error.
         *      <li>#MDB_APPENDDUP - as above, but for sorted dup data.
         * </ul>
         * @return A non-zero error value on failure and 0 on success. Some possible