]> git.ipfire.org Git - thirdparty/sqlite.git/commitdiff
Fix some documentation comments in sqlite.h.in. No functional code changes.
authordrh <drh@noemail.net>
Sat, 12 Dec 2009 23:57:36 +0000 (23:57 +0000)
committerdrh <drh@noemail.net>
Sat, 12 Dec 2009 23:57:36 +0000 (23:57 +0000)
FossilOrigin-Name: c16b9bec77c8b9120b728f8431648d95175a83b8

manifest
manifest.uuid
src/sqlite.h.in

index 7aff063b1c272665597615a966c1581c454d8414..38095f317e065fb11108d0bd850093b769d6657c 100644 (file)
--- a/manifest
+++ b/manifest
@@ -1,5 +1,8 @@
-C Tests\sto\scover\sa\sfew\sextra\sbranches\sin\sfts3.c.
-D 2009-12-12T19:15:28
+-----BEGIN PGP SIGNED MESSAGE-----
+Hash: SHA1
+
+C Fix\ssome\sdocumentation\scomments\sin\ssqlite.h.in.\s\sNo\sfunctional\scode\schanges.
+D 2009-12-12T23:57:36
 F Makefile.arm-wince-mingw32ce-gcc fcd5e9cd67fe88836360bb4f9ef4cb7f8e2fb5a0
 F Makefile.in c5827ead754ab32b9585487177c93bb00b9497b3
 F Makefile.linux-gcc d53183f4aa6a9192d249731c90dbdffbd2c68654
@@ -164,7 +167,7 @@ F src/resolve.c d052e5c44bab34f83b3c1741aaa07478d18b5dd5
 F src/rowset.c 69afa95a97c524ba6faf3805e717b5b7ae85a697
 F src/select.c 68c58dc49341472e4e5661a47a1a9e5f8a161340
 F src/shell.c f4948cb6d30665d755a6b5e0ec313d1094aab828
-F src/sqlite.h.in 0c73df1f6e82e18e24b5abe8a561abfa6d098b96
+F src/sqlite.h.in 649e62a2a3f80f1cb4221faf2b5487da63208000
 F src/sqlite3ext.h 69dfb8116af51b84a029cddb3b35062354270c89
 F src/sqliteInt.h e946a6a3f2df015cdbc7668e9626987e8badbb5f
 F src/sqliteLimit.h 3afab2291762b5d09ae20c18feb8e9fa935a60a6
@@ -779,7 +782,14 @@ F tool/speedtest2.tcl ee2149167303ba8e95af97873c575c3e0fab58ff
 F tool/speedtest8.c 2902c46588c40b55661e471d7a86e4dd71a18224
 F tool/speedtest8inst1.c 293327bc76823f473684d589a8160bde1f52c14e
 F tool/vdbe-compress.tcl d70ea6d8a19e3571d7ab8c9b75cba86d1173ff0f
-P d2a8c0f683271f5fb8c9badfb13e4e46fd78db71
-R 2bf0117c3db56e5351a8a9dca36e7a01
-U dan
-Z cff0315b4b1d4f7a0aab7cdae117a3f0
+P 06b72b007393dc34d75a8bb16ce0e4507d5f8faa
+R d7c6bfff5c2073c6545191e06295e1ef
+U drh
+Z 0a5a49a40f17017edb818331674b0703
+-----BEGIN PGP SIGNATURE-----
+Version: GnuPG v1.4.6 (GNU/Linux)
+
+iD8DBQFLJC3yoxKgR168RlERAkXmAJ9X3yzpu5k1Ylhlk8Rj31bKGBDKbACdHSEy
+Pua3zjUx13qReaNFgHIlBrU=
+=/Wnd
+-----END PGP SIGNATURE-----
index 3d353b7ff67edb9b86b82c1c5880e4a692566f92..add870ac2fb97121d912dde618249bf6b86218e3 100644 (file)
@@ -1 +1 @@
-06b72b007393dc34d75a8bb16ce0e4507d5f8faa
\ No newline at end of file
+c16b9bec77c8b9120b728f8431648d95175a83b8
\ No newline at end of file
index d5170f906239afdd6ace168bd751fccb8a2dfa3c..ec878dd6630592bb28d4f85e88ede5ad70d7df73 100644 (file)
@@ -1218,7 +1218,8 @@ struct sqlite3_mem_methods {
 **
 ** <dt>SQLITE_CONFIG_LOOKASIDE</dt>
 ** <dd> ^(This option takes two arguments that determine the default
-** memory allocation lookaside optimization.  The first argument is the
+** memory allocation for the lookaside memory allocator on each
+** [database connection].  The first argument is the
 ** size of each lookaside buffer slot and the second is the number of
 ** slots allocated to each database connection.)^  ^(This option sets the
 ** <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]
@@ -2711,8 +2712,9 @@ const void *sqlite3_column_name16(sqlite3_stmt*, int N);
 /*
 ** CAPI3REF: Source Of Data In A Query Result
 **
-** ^These routines provide a means to determine what column of what
-** table in which database a result of a [SELECT] statement comes from.
+** ^These routines provide a means to determine the database, table, and
+** table column that is the origin of a particular result column in
+** [SELECT] statement.
 ** ^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
@@ -2724,10 +2726,10 @@ const void *sqlite3_column_name16(sqlite3_stmt*, int N);
 ** ^The names returned are the original un-aliased names of the
 ** database, table, and column.
 **
-** ^The first argument these interfaces is a [prepared statement].
-** ^These functions return information about the Nth column returned by
+** ^The first argument to these interfaces is a [prepared statement].
+** ^These functions return information about the Nth result column returned by
 ** the statement, where N is the second function argument.
-** ^The left-most column is column 0 for these interface.
+** ^The left-most column is column 0 for these routines.
 **
 ** ^If the Nth column returned by the statement is an expression or
 ** subquery and is not a column value, then all of these functions return
@@ -2735,11 +2737,11 @@ const void *sqlite3_column_name16(sqlite3_stmt*, int N);
 ** occurs.  ^Otherwise, they return the name of the attached database, table
 ** or column that query result column was extracted from.
 **
-** ^As with all other SQLite APIs, those postfixed with "16" return
-** UTF-16 encoded strings, the other functions return UTF-8.
+** ^As with all other SQLite APIs, those whose names end with "16" return
+** UTF-16 encoded strings and the other functions return UTF-8.
 **
 ** ^These APIs are only available if the library was compiled with the
-** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined.
+** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol.
 **
 ** If two or more threads call one or more of these routines against the same
 ** prepared statement and column at the same time then the results are
@@ -3622,14 +3624,14 @@ int sqlite3_create_collation16(
 **
 ** ^To avoid having to register all collation sequences before a database
 ** can be used, a single callback function may be registered with the
-** [database connection] to be called whenever an undefined collation
+** [database connection] to be invoked whenever an undefined collation
 ** sequence is required.
 **
 ** ^If the function is registered using the sqlite3_collation_needed() API,
 ** then it is passed the names of undefined collation sequences as strings
 ** encoded in UTF-8. ^If sqlite3_collation_needed16() is used,
 ** the names are passed as UTF-16 in machine native byte order.
-** ^A call to either function replaces any existing callback.
+** ^A call to either function replaces the existing collation-needed callback.
 **
 ** ^(When the callback is invoked, the first argument passed is a copy
 ** of the second argument to sqlite3_collation_needed() or
@@ -5100,7 +5102,7 @@ SQLITE_EXPERIMENTAL int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiw
 **
 ** ^(Each prepared statement maintains various
 ** [SQLITE_STMTSTATUS_SORT | counters] that measure the number
-** of times it has performed specific operations.)  These counters can
+** of times it has performed specific operations.)^  These counters can
 ** be used to monitor the performance characteristics of the prepared
 ** statements.  For example, if the number of table steps greatly exceeds
 ** the number of table searches or result rows, that would tend to indicate
@@ -5181,10 +5183,10 @@ typedef struct sqlite3_pcache sqlite3_pcache;
 ** [sqlite3_config()] returns.)^
 **
 ** ^The xInit() method is called once for each call to [sqlite3_initialize()]
-** (usually only once during the lifetime of the process). ^It is passed
-** a copy of the sqlite3_pcache_methods.pArg value. ^It can be used to set
-** up global structures and mutexes required by the custom page cache 
-** implementation. 
+** (usually only once during the lifetime of the process). ^(The xInit()
+** method is passed a copy of the sqlite3_pcache_methods.pArg value.)^
+** ^The xInit() method can set up up global structures and/or any mutexes
+** required by the custom page cache implementation. 
 **
 ** ^The xShutdown() method is called from within [sqlite3_shutdown()], 
 ** if the application invokes this API. It can be used to clean up 
@@ -5375,7 +5377,7 @@ typedef struct sqlite3_backup sqlite3_backup;
 **
 ** ^Function sqlite3_backup_step(B,N) will copy up to N pages between 
 ** the source and destination databases specified by [sqlite3_backup] object B.
-** ^If N is negative value, all remaining source pages are copied. 
+** ^If N is negative, all remaining source pages are copied. 
 ** ^If sqlite3_backup_step(B,N) successfully copies N pages and there
 ** are still more pages to be copied, then the function resturns [SQLITE_OK].
 ** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages