Documentation updates in sqlite.h.in. No changes to code. (CVS 5315)

FossilOrigin-Name: 168fd6f83e2c837e91d02fa49fff3fe2f9538928

manifest

@@ -1,5 +1,5 @@
-C Fix\shandling\sof\s"x\sIN\s(...)"\sand\s"x\sNOT\sIN\s(...)"\sexpressions\swhen\sthe\sset\scontains\san\sSQL\sNULL\svalue.\s(CVS\s5314)
-D 2008-06-26T18:04:03
+C Documentation\supdates\sin\ssqlite.h.in.\sNo\schanges\sto\scode.\s(CVS\s5315)
+D 2008-06-26T18:16:06
 F Makefile.arm-wince-mingw32ce-gcc fcd5e9cd67fe88836360bb4f9ef4cb7f8e2fb5a0
 F Makefile.in 325dfac0a0dd1cb4d975f1ace6453157892e6042
 F Makefile.linux-gcc d53183f4aa6a9192d249731c90dbdffbd2c68654
@@ -127,7 +127,7 @@ F src/mutex.h e52ffa1dfc6a6077e8b1823d2c2b7dfcbcf85594
 F src/mutex_os2.c 9c5637aa4c307c552566d0f0b3bd206245b54a97
 F src/mutex_unix.c c1526811f4b97a7cd9d4d72d2b9623d06abd05ce
 F src/mutex_w32.c f0d21ff1f6981e5aedc56796adf3a347423ef736
-F src/os.c 2b0b710dc1bcf69de7c9c54ed0cf98f5cb38bbd1
+F src/os.c 292b3b4a49fe5bf6cf2f1cf0af186ebd334e80b8
 F src/os.h ef8abeb9afc694b82dbd169a91c9b7e26db3c892
 F src/os_common.h 24525d8b7bce66c374dfc1810a6c9043f3359b60
 F src/os_os2.c 38fd8cfb1c122c39e451d9f3e779c602283dba33
@@ -142,7 +142,7 @@ F src/printf.c 8b063da9dcde26b7c500a01444b718d86f21bc6e
 F src/random.c 5c754319d38abdd6acd74601ee0105504adc508a
 F src/select.c e27de53be426254e1b75690c9c99482bb1431b79
 F src/shell.c 479807b87f0409289eec4a776cd6ae56d30544b1
-F src/sqlite.h.in 2b9e8de3378101ad8ec8de98e3679ad5c2f39427
+F src/sqlite.h.in bcdf4f68ce70ca30f0c3d351858383ce398e3c66
 F src/sqlite3ext.h f162a72daef5ebf8b211fe8c0ec96e85d22fbf9b
 F src/sqliteInt.h 969acf22dbe79075e486074a8ffdc1e2fc2b8b1f
 F src/sqliteLimit.h f435e728c6b620ef7312814d660a81f9356eb5c8
@@ -594,7 +594,7 @@ F tool/speedtest16.c c8a9c793df96db7e4933f0852abb7a03d48f2e81
 F tool/speedtest2.tcl ee2149167303ba8e95af97873c575c3e0fab58ff
 F tool/speedtest8.c 1dbced29de5f59ba2ebf877edcadf171540374d1
 F tool/speedtest8inst1.c 293327bc76823f473684d589a8160bde1f52c14e
-P e1de2287fd9b067f687cb8b427786b878af6c5b7
-R 01ffd027189ad04179892df9936c6090
-U danielk1977
-Z c4dcbe6b5c0897a85aa2b72a88c7084f
+P d45a97be71fa61ab4a692bd807ab762130f7f5b9
+R 3dedfcadac16cf05d22a150cef869c0f
+U drh
+Z 3f2fbb3accba9d608a70c4032d103e16

manifest.uuid

@@ -1 +1 @@
-d45a97be71fa61ab4a692bd807ab762130f7f5b9
+168fd6f83e2c837e91d02fa49fff3fe2f9538928

src/os.c

@@ -13,7 +13,7 @@
 ** This file contains OS interface code that is common to all
 ** architectures.
 **
-** $Id: os.c,v 1.118 2008/06/26 10:41:19 danielk1977 Exp $
+** $Id: os.c,v 1.119 2008/06/26 18:16:06 drh Exp $
 */
 #define _SQLITE_OS_C_ 1
 #include "sqliteInt.h"
@@ -275,4 +275,3 @@ int sqlite3_vfs_unregister(sqlite3_vfs *pVfs){
   sqlite3_mutex_leave(mutex);
   return SQLITE_OK;
 }
-

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.359 2008/06/26 15:04:58 drh Exp $
+** @(#) $Id: sqlite.h.in,v 1.360 2008/06/26 18:16:06 drh Exp $
 */
 #ifndef _SQLITE3_H_
 #define _SQLITE3_H_
@@ -1416,10 +1416,10 @@ void sqlite3_interrupt(sqlite3*);
 **
 ** LIMITATIONS:
 **
-** {A10512} The input to sqlite3_complete() must be a zero-terminated
+** {A10512} The input to [sqlite3_complete()] must be a zero-terminated
 **          UTF-8 string.
 **
-** {A10513} The input to sqlite3_complete16() must be a zero-terminated
+** {A10513} The input to [sqlite3_complete16()] must be a zero-terminated
 **          UTF-16 string in native byte order.
 */
 int sqlite3_complete(const char *sql);
@@ -2763,11 +2763,13 @@ const char *sqlite3_sql(sqlite3_stmt *pStmt);
 ** sqlite3_value object but no mutex is held for an unprotected
 ** sqlite3_value object.  If SQLite is compiled to be single-threaded
 ** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)
+** or if SQLite is run in one of reduced mutex modes 
+** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD]
 ** then there is no distinction between protected and unprotected
 ** sqlite3_value objects and they can be used interchangeably.  However,
 ** for maximum code portability it is recommended that applications
 ** still make the distinction between between protected and unprotected
-** sqlite3_value objects even if they are single threaded.
+** sqlite3_value objects even when not strictly required.
 **
 ** The sqlite3_value objects that are passed as parameters into the
 ** implementation of [application-defined SQL functions] are protected.
@@ -2826,8 +2828,8 @@ typedef struct sqlite3_context sqlite3_context;
 ** The index for named parameters can be looked up using the
 ** [sqlite3_bind_parameter_index()] API if desired.  The index
 ** for "?NNN" parameters is the value of NNN.
-** The NNN value must be between 1 and the compile-time
-** parameter SQLITE_MAX_VARIABLE_NUMBER (default value: 999).
+** The NNN value must be between 1 and the [sqlite3_limit()]
+** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999).
 **
 ** The third argument is the value to bind to the parameter.
 **
@@ -3060,7 +3062,7 @@ int sqlite3_clear_bindings(sqlite3_stmt*);
 **
 ** Return the number of columns in the result set returned by the
 ** [prepared statement]. This routine returns 0 if pStmt is an SQL
-** statement that does not return data (for example an UPDATE).
+** statement that does not return data (for example an [UPDATE]).
 **
 ** INVARIANTS:
 **
@@ -3074,11 +3076,11 @@ int sqlite3_column_count(sqlite3_stmt *pStmt);
 ** CAPI3REF: Column Names In A Result Set {F13720}
 **
 ** These routines return the name assigned to a particular column
-** in the result set of a SELECT statement.  The sqlite3_column_name()
+** in the result set of a [SELECT] statement.  The sqlite3_column_name()
 ** interface returns a pointer to a zero-terminated UTF-8 string
 ** and sqlite3_column_name16() returns a pointer to a zero-terminated
 ** UTF-16 string.  The first parameter is the [prepared statement]
-** that implements the SELECT statement. The second parameter is the
+** that implements the [SELECT] statement. The second parameter is the
 ** column number.  The leftmost column is number 0.
 **
 ** The returned string pointer is valid until either the [prepared statement]
@@ -3131,7 +3133,7 @@ const void *sqlite3_column_name16(sqlite3_stmt*, int N);
 ** CAPI3REF: Source Of Data In A Query Result {F13740}
 **
 ** These routines provide a means to determine what column of what
-** table in which database a result of a SELECT statement comes from.
+** table in which database a result of a [SELECT] statement comes from.
 ** The name of the database or table or column can be returned as
 ** either a UTF-8 or UTF-16 string.  The _database_ routines return
 ** the database name, the _table_ routines return the table name, and
@@ -3157,7 +3159,7 @@ const void *sqlite3_column_name16(sqlite3_stmt*, int N);
 ** UTF-16 encoded strings, the other functions return UTF-8. {END}
 **
 ** These APIs are only available if the library was compiled with the
-** SQLITE_ENABLE_COLUMN_METADATA preprocessor symbol defined.
+** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined.
 **
 ** {A13751}
 ** If two or more threads call one or more of these routines against the same
@@ -3227,8 +3229,8 @@ const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
 ** CAPI3REF: Declared Datatype Of A Query Result {F13760}
 **
 ** The first parameter is a [prepared statement].
-** If this statement is a SELECT statement and the Nth column of the
-** returned result set of that SELECT is a table column (not an
+** If this statement is a [SELECT] statement and the Nth column of the
+** returned result set of that [SELECT] is a table column (not an
 ** expression or subquery) then the declared type of the table
 ** column is returned.  If the Nth column of the result set is an
 ** expression or subquery, then a NULL pointer is returned.
@@ -3297,9 +3299,9 @@ const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
 ** [extended result codes] might be returned as well.
 **
 ** [SQLITE_BUSY] means that the database engine was unable to acquire the
-** database locks it needs to do its job.  If the statement is a COMMIT
+** database locks it needs to do its job.  If the statement is a [COMMIT]
 ** or occurs outside of an explicit transaction, then you can retry the
-** statement.  If the statement is not a COMMIT and occurs within a
+** statement.  If the statement is not a [COMMIT] and occurs within a
 ** explicit transaction then you should rollback the transaction before
 ** continuing.
 **
@@ -5020,7 +5022,7 @@ void sqlite3_soft_heap_limit(int);
 ** in the [database connection] (to be retrieved using sqlite3_errmsg()).
 **
 ** This API is only available if the library was compiled with the
-** SQLITE_ENABLE_COLUMN_METADATA C preprocessor symbol defined.
+** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined.
 */
 int sqlite3_table_column_metadata(
   sqlite3 *db,                /* Connection handle */