Add a few function requirements numbers to interfaces in the comments

of sqlite3.h.in.  This is experimental. (CVS 4583)

FossilOrigin-Name: b829a64515e88e83aecd339342bad3b140c86bb0

diff --git a/manifest b/manifest
index 1add362f516619f72cd6d3d5c2f526df58b7ef7c..aae3e3be850ba78793e618e00bae8019628d96fa 100644 (file)
--- a/manifest
+++ b/manifest
@@ -1,5 +1,5 @@
-C Make\ssure\swe\snever\stry\sto\s"truncate"\sa\sfile\sto\sa\slarger\ssize.\s(CVS\s4582)
-D 2007-11-29T18:44:27
+C Add\sa\sfew\sfunction\srequirements\snumbers\sto\sinterfaces\sin\sthe\scomments\nof\ssqlite3.h.in.\s\sThis\sis\sexperimental.\s(CVS\s4583)
+D 2007-11-30T01:06:17
 F Makefile.arm-wince-mingw32ce-gcc ac5f7b2cef0cd850d6f755ba6ee4ab961b1fadf7
 F Makefile.in d9419c71360931f0711d572e06f726f29656bfc3
 F Makefile.linux-gcc d53183f4aa6a9192d249731c90dbdffbd2c68654
@@ -134,7 +134,7 @@ F src/random.c 4a22746501bf36b0a088c66e38dde5daba6a35da
 F src/select.c 7c0ab94b8f287eb94fdb1eb101be603832ecfc34
 F src/server.c 087b92a39d883e3fa113cae259d64e4c7438bc96
 F src/shell.c c97be281cfc3dcb14902f45e4b16f20038eb83ff
-F src/sqlite.h.in 75ae0863db3a0b074868a6157e34b646dbe143dd
+F src/sqlite.h.in 0d6d4b9d18f1d0b058a7a543ffa777bd5fbf4a99
 F src/sqlite3ext.h a93f59cdee3638dc0c9c086f80df743a4e68c3cb
 F src/sqliteInt.h f5d5b5f0dcfcd2098131c57c08ece6e314e47697
 F src/sqliteLimit.h 15ffe2116746c27ace2b428a26a4fcd6dba6fa65
@@ -595,7 +595,7 @@ F www/tclsqlite.tcl 8be95ee6dba05eabcd27a9d91331c803f2ce2130
 F www/vdbe.tcl 87a31ace769f20d3627a64fa1fade7fed47b90d0
 F www/version3.tcl 890248cf7b70e60c383b0e84d77d5132b3ead42b
 F www/whentouse.tcl fc46eae081251c3c181bd79c5faef8195d7991a5
-P cfd683ac80fd043343e0f0af90805058daa3818d
-R efe61aec0ac9fa4f2be861c956b27113
+P 7d2f6a1d6c5ab89a3b65fbcaf172abf6d81e206b
+R 7dcc2a7d5ec1c8a9e267a3bf49b6ac94
 U drh
-Z fd3607ea80d91b437bccfba278c95b97
+Z 16eb3aedea7a38e849b48842d4f0e5b5

diff --git a/manifest.uuid b/manifest.uuid
index 8dd31848b64aea32719ab84d42d39a5c9904bd5b..c91018ce5bffd8cc0f011b0ee4dfd01ce45b45b1 100644 (file)
--- a/manifest.uuid
+++ b/manifest.uuid
@@ -1 +1 @@
-7d2f6a1d6c5ab89a3b65fbcaf172abf6d81e206b
\ No newline at end of file
+b829a64515e88e83aecd339342bad3b140c86bb0
\ No newline at end of file

diff --git a/src/sqlite.h.in b/src/sqlite.h.in
index 31d92fbe710875e25f788f1bf7b2b419c7b3fefd..da02f7951ca5fea2f798064583652778b289acba 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.271 2007/11/21 15:24:01 drh Exp $
+** @(#) $Id: sqlite.h.in,v 1.272 2007/11/30 01:06:17 drh Exp $
 */
 #ifndef _SQLITE3_H_
 #define _SQLITE3_H_
@@ -63,13 +63,13 @@ extern "C" {
 #endif
 
 /*
-** CAPI3REF: Compile-Time Library Version Numbers
+** CAPI3REF: Compile-Time Library Version Numbers {F10100}
 **
-** The version of the SQLite library is contained in the sqlite3.h
-** header file in a #define named SQLITE_VERSION.  The SQLITE_VERSION
+** {F10101} The version of the SQLite library is contained in the sqlite3.h
+** header file in a #define named SQLITE_VERSION. {F10102} The SQLITE_VERSION
 ** macro resolves to a string constant.
 **
-** The format of the version string is "X.Y.Z", where
+** {F10103} The format of the SQLITE_VERSION string is "X.Y.Z", where
 ** X is the major version number, Y is the minor version number and Z
 ** is the release number.  The X.Y.Z might be followed by "alpha" or "beta".
 ** For example "3.1.1beta".
@@ -81,11 +81,11 @@ extern "C" {
 ** but not backwards compatible.  The Z value is incremented with
 ** each release but resets back to 0 when Y is incremented.
 **
-** The SQLITE_VERSION_NUMBER is an integer with the value 
-** (X*1000000 + Y*1000 + Z). For example, for version "3.1.1beta", 
-** SQLITE_VERSION_NUMBER is set to 3001001. To detect if they are using 
-** version 3.1.1 or greater at compile time, programs may use the test 
-** (SQLITE_VERSION_NUMBER>=3001001).
+** {F10104} The #define named SQLITE_VERSION_NUMBER is an integer with
+** the value (X*1000000 + Y*1000 + Z). For example, for version "3.5.3", 
+** SQLITE_VERSION_NUMBER is set to 3005003. To detect if they are using 
+** version 3.5.3 or greater at compile time, programs may use the test 
+** (SQLITE_VERSION_NUMBER>=3005003). {END}
 **
 ** See also: [sqlite3_libversion()] and [sqlite3_libversion_number()].
 */
@@ -93,18 +93,19 @@ extern "C" {
 #define SQLITE_VERSION_NUMBER --VERSION-NUMBER--
 
 /*
-** CAPI3REF: Run-Time Library Version Numbers
+** CAPI3REF: Run-Time Library Version Numbers {F10110}
 **
-** These routines return values equivalent to the header constants
+** {F10111} The sqlite3_libversion() and sqlite3_libversion_number()
+** routines return values equivalent to the header constants
 ** [SQLITE_VERSION] and [SQLITE_VERSION_NUMBER].  The values returned
 ** by this routines should only be different from the header values
 ** if you compile your program using an sqlite3.h header from a
 ** different version of SQLite that the version of the library you
 ** link against.
 **
-** The sqlite3_version[] string constant contains the text of the
+** {F10112} The sqlite3_version[] string constant contains the text of the
 ** [SQLITE_VERSION] string.  The sqlite3_libversion() function returns
-** a poiner to the sqlite3_version[] string constant.  The function
+** a pointer to the sqlite3_version[] string constant.  The function
 ** is provided for DLL users who can only access functions and not
 ** constants within the DLL.
 */
@@ -113,9 +114,10 @@ const char *sqlite3_libversion(void);
 int sqlite3_libversion_number(void);
 
 /*
-** CAPI3REF: Test To See If The Library Is Threadsafe
+** CAPI3REF: Test To See If The Library Is Threadsafe {F10200}
 **
-** This routine returns TRUE (nonzero) if SQLite was compiled with
+** {F10201} The sqlite3_threadsafe() routine returns TRUE (nonzero) 
+** if SQLite was compiled with
 ** all of its mutexes enabled and is thus threadsafe.  It returns
 ** zero if the particular build is for single-threaded operation
 ** only.
@@ -137,7 +139,7 @@ int sqlite3_libversion_number(void);
 int sqlite3_threadsafe(void);
 
 /*
-** CAPI3REF: Database Connection Handle
+** CAPI3REF: Database Connection Handle {F11000}
 **
 ** Each open SQLite database is represented by pointer to an instance of the
 ** opaque structure named "sqlite3".  It is useful to think of an sqlite3
@@ -152,7 +154,7 @@ typedef struct sqlite3 sqlite3;
 
 
 /*
-** CAPI3REF: 64-Bit Integer Types
+** CAPI3REF: 64-Bit Integer Types {F10300}
 **
 ** Some compilers do not support the "long long" datatype.  So we have
 ** to do compiler-specific typedefs for 64-bit signed and unsigned integers.
@@ -182,23 +184,22 @@ typedef sqlite_uint64 sqlite3_uint64;
 #endif
 
 /*
-** CAPI3REF: Closing A Database Connection
+** CAPI3REF: Closing A Database Connection {F11100}
 **
-** Call this function with a pointer to a structure that was previously
-** returned from [sqlite3_open()], [sqlite3_open16()], or
-** [sqlite3_open_v2()] and the corresponding database will by
-** closed.
+** {F11101} The sqlite3_close() interface is the destructor for
+** the [sqlite3] object.
 **
-** All SQL statements prepared using [sqlite3_prepare_v2()] or
+** {F11102} All SQL statements prepared using [sqlite3_prepare_v2()] or
 ** [sqlite3_prepare16_v2()] must be destroyed using [sqlite3_finalize()]
-** before this routine is called. Otherwise, SQLITE_BUSY is returned and the
-** database connection remains open.
-**
-** Passing this routine a database connection that has already been
-** closed results in undefined behavior.  If other interfaces that
-** reference the same database connection are pending (either in the
-** same thread or in different threads) when this routine is called,
-** then the behavior is undefined and is almost certainly undesirable.
+** before sqlite3_close() is called. Otherwise, sqlite3_close() returns
+** SQLITE_BUSY and database connection remains open.
+**
+** {U11103} Calling sqlite3_close on a database connection that has 
+** already been closed results in undefined behavior.  {U11104} If 
+** other interfaces that reference the same database connection are 
+** pending (either in the same thread or in different threads) when 
+** sqlite3_close() is called, then the behavior is undefined and is
+** almost certainly undesirable.
 */
 int sqlite3_close(sqlite3 *);