Clarification in the documentation of the sqlite3_mutex_held() and

sqlite3_mutex_notheld() interfaces.  Make it clear that these routines
are only for use inside assert(). (CVS 4298)

FossilOrigin-Name: a6bbf6eaf6ccc471b4efe02cd8a3971112d909ab

diff --git a/manifest b/manifest
index bc4bc882b5abef55d77e9745d5eb99003115a1c8..9c2dfb315e3f5e652bf986c2e1b3d3d62fd4c1ee 100644 (file)
--- a/manifest
+++ b/manifest
@@ -1,5 +1,5 @@
-C Use\srecursive\smutexes\sin\spthreads.\s\sIf\sthe\spthreads\simplementation\sdoes\snot\nsupport\srecursive\smutexes,\sthen\syou\scannot\scompile\sSQLite\swith\nSQLITE_THREADSAFE=1.\s\sTicket\s#2588.\s(CVS\s4297)
-D 2007-08-25T14:39:46
+C Clarification\sin\sthe\sdocumentation\sof\sthe\ssqlite3_mutex_held()\sand\nsqlite3_mutex_notheld()\sinterfaces.\s\sMake\sit\sclear\sthat\sthese\sroutines\nare\sonly\sfor\suse\sinside\sassert().\s(CVS\s4298)
+D 2007-08-25T14:49:37
 F Makefile.in 938f2769921fa1b30c633548f153804021eb1512
 F Makefile.linux-gcc 65241babba6faf1152bf86574477baab19190499
 F README 9c4e2d6706bdcc3efdd773ce752a8cdab4f90028
@@ -125,7 +125,7 @@ F src/random.c 4a22746501bf36b0a088c66e38dde5daba6a35da
 F src/select.c 98c367bce3f38c5adfcc97de9ab5c79b0e5dc2b2
 F src/server.c 087b92a39d883e3fa113cae259d64e4c7438bc96
 F src/shell.c ac29402b538515fa4697282387be9c1205e6e9eb
-F src/sqlite.h.in 22397464e1026437a755489c3eeb459346ae8749
+F src/sqlite.h.in 7dfaf428b5f76fcacf17a346f253d74f60f8dbe6
 F src/sqlite3ext.h 9a26028378c288af500d8b94ed079666fed5806b
 F src/sqliteInt.h 13c908f5f156a192fcd247f993ac513bfaf81f53
 F src/sqliteLimit.h 1bcbbdfa856f8b71b561abb31edb864b0eca1d12
@@ -561,7 +561,7 @@ F www/tclsqlite.tcl 8be95ee6dba05eabcd27a9d91331c803f2ce2130
 F www/vdbe.tcl 87a31ace769f20d3627a64fa1fade7fed47b90d0
 F www/version3.tcl 890248cf7b70e60c383b0e84d77d5132b3ead42b
 F www/whentouse.tcl fc46eae081251c3c181bd79c5faef8195d7991a5
-P b076e1655d6bae5ae10e6ceee646f502435da66a
-R edf973d5cbe24872437fb8ece94bf656
+P 1668284d151e78d16b0d83bf55dfd9d349a452a7
+R 7564b5bfcb8bbb8ed0a65088101cdf1b
 U drh
-Z efa71bea2fd6dc4b3f3ab38d3c01a446
+Z 24484f519020cb40e59b1e0abccf1bd2

diff --git a/manifest.uuid b/manifest.uuid
index 27d0237c560a56d83ac8ed467d6d6c4f034cfd3b..5ffc0e4ddf84fe49aafc845a8cdf2bbb321089b2 100644 (file)
--- a/manifest.uuid
+++ b/manifest.uuid
@@ -1 +1 @@
-1668284d151e78d16b0d83bf55dfd9d349a452a7
\ No newline at end of file
+a6bbf6eaf6ccc471b4efe02cd8a3971112d909ab
\ No newline at end of file

diff --git a/src/sqlite.h.in b/src/sqlite.h.in
index 1b68a87ab76c50566ce44cca2efdc01fe87afb40..24ee2ae075488498d59dbcfaefeeea6f6e7bcf9c 100644 (file)
--- a/src/sqlite.h.in
+++ b/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.240 2007/08/24 16:08:29 drh Exp $
+** @(#) $Id: sqlite.h.in,v 1.241 2007/08/25 14:49:37 drh Exp $
 */
 #ifndef _SQLITE3_H_
 #define _SQLITE3_H_
@@ -3312,7 +3312,9 @@ int sqlite3_vfs_unregister(sqlite3_vfs*);
 ** is not currently allocated.  SQLite will never do either.
 **
 ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
-** are intended for use inside assert() statements.  They should
+** are intended for use inside assert() statements.  The SQLite core
+** never uses these routines except inside an assert() and applications
+** are advised to follow the lead of the core.  These routines should
 ** return true if the mutex in their argument is held or not held,
 ** respectively, by the current thread. The implementation is
 ** not required to provided working implementations of these