Add documentation on the sqlite3_mutex_methods object. (CVS 5232)

FossilOrigin-Name: c3c7bfc9db6774824be14a1394e1842716dce8ec

manifest

@@ -1,5 +1,5 @@
-C Added\snew\sconfiguration\soptions\sto\squery\sthe\slow-level\smalloc\sinterface\nand\sto\sprovide\smemory\sbuffers\sfor\sscratch,\spage-cache,\sand\sheap\smemory\nallocators.\s(CVS\s5231)
-D 2008-06-18T13:27:47
+C Add\sdocumentation\son\sthe\ssqlite3_mutex_methods\sobject.\s(CVS\s5232)
+D 2008-06-18T13:47:04
 F Makefile.arm-wince-mingw32ce-gcc ac5f7b2cef0cd850d6f755ba6ee4ab961b1fadf7
 F Makefile.in dc5608df93faf4406cfd7a1c8ed9ab93d8bfbfd5
 F Makefile.linux-gcc d53183f4aa6a9192d249731c90dbdffbd2c68654
@@ -143,7 +143,7 @@ F src/printf.c 8b063da9dcde26b7c500a01444b718d86f21bc6e
 F src/random.c 2b2db2de4ab491f5a14d3480466f8f4b5a5db74a
 F src/select.c 669687459e7d0193c89de06c5dbed55b4a41191c
 F src/shell.c a12ea645271b7876c8f080146f48e20b00d367ec
-F src/sqlite.h.in ada07a820e5a9d1264e2f9736f2bf7edd0a623ff
+F src/sqlite.h.in 48a3a643fa711141cb53b1c714be74098770e224
 F src/sqlite3ext.h faacd0e6a81aabee0861c6d7883c9172e74ef5b3
 F src/sqliteInt.h 90dff45c2fa188ff8763dd5358f7b1040e1bb4fb
 F src/sqliteLimit.h f435e728c6b620ef7312814d660a81f9356eb5c8
@@ -596,7 +596,7 @@ F tool/speedtest16.c c8a9c793df96db7e4933f0852abb7a03d48f2e81
 F tool/speedtest2.tcl ee2149167303ba8e95af97873c575c3e0fab58ff
 F tool/speedtest8.c 1dbced29de5f59ba2ebf877edcadf171540374d1
 F tool/speedtest8inst1.c 293327bc76823f473684d589a8160bde1f52c14e
-P 262baee9952b28afe5dc77eb7365ebb11a480906
-R 5f557fa3b0a0319b470b2906d72f8bb7
+P e36201a352f832c97c5c0fcb872c1f094cac03d2
+R 8648cd5178619fc653bfd259b7c7bae3
 U drh
-Z 9163b748554dc08433fe2724996f3f54
+Z 67e332d2264b741dc268059d30026b9b

manifest.uuid

@@ -1 +1 @@
-e36201a352f832c97c5c0fcb872c1f094cac03d2
+c3c7bfc9db6774824be14a1394e1842716dce8ec

src/sqlite.h.in

@@ -30,7 +30,7 @@
 ** the version number) and changes its name to "sqlite3.h" as
 ** part of the build process.
 **
-** @(#) $Id: sqlite.h.in,v 1.333 2008/06/18 13:27:47 drh Exp $
+** @(#) $Id: sqlite.h.in,v 1.334 2008/06/18 13:47:04 drh Exp $
 */
 #ifndef _SQLITE3_H_
 #define _SQLITE3_H_
@@ -5849,6 +5849,27 @@ int sqlite3_mutex_try(sqlite3_mutex*);
 void sqlite3_mutex_leave(sqlite3_mutex*);
 int sqlite3_mutex_end(void);
 
+/*
+** CAPI3REF: Mutex Methods Object {F17120}
+**
+** An instance of this structure defines the low-level routines
+** used to allocate and use mutexes.  This structure is used as
+** an argument to the [SQLITE_CONFIG_MUTEX] and [SQLITE_CONFIG_GETMUTEX]
+** options of [sqlite3_config()].  The methods defined by this
+** structure implement the following interfaces (respectively):
+**
+** <ul>
+** <li>  [sqlite3_mutex_init()] </li>
+** <li>  [sqlite3_mutex_alloc()] </li>
+** <li>  [sqlite3_mutex_free()] </li>
+** <li>  [sqlite3_mutex_enter()] </li>
+** <li>  [sqlite3_mutex_try()] </li>
+** <li>  [sqlite3_mutex_leave()] </li>
+** <li>  [sqlite3_mutex_end()] </li>
+** <li>  [sqlite3_mutex_held()] </li>
+** <li>  [sqlite3_mutex_notheld()] </li>
+** </ul>
+*/
 typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
 struct sqlite3_mutex_methods {
   int (*xMutexInit)(void);