Edit comments in sqlite.h.in used for generating documentation, to improve

the description of the new sqlite3_prepare_v3() interfaces, and other
miscellaneous cleanup.  No changes to executable code.

FossilOrigin-Name: 284707a7b3514a55cce24292e45632b7033d6edcff5b27deac5118b27c7b2954

diff --git a/manifest b/manifest
index 34d20becdc5effa622678115ec6a0129fc2b247b..ad7ba1155cf789407ca0a70dabcb89bca794ae95 100644 (file)
--- a/manifest
+++ b/manifest
@@ -1,5 +1,5 @@
-C More\supdates\sto\sthe\sWin32\sinterface\sfor\slsm1.
-D 2017-06-29T16:51:52.526
+C Edit\scomments\sin\ssqlite.h.in\sused\sfor\sgenerating\sdocumentation,\sto\simprove\nthe\sdescription\sof\sthe\snew\ssqlite3_prepare_v3()\sinterfaces,\sand\sother\nmiscellaneous\scleanup.\s\sNo\schanges\sto\sexecutable\scode.
+D 2017-06-29T17:27:04.182
 F Makefile.in 081e48dfe7f995d57ce1a88ddf4d2917b4349158648a6cd45b42beae30de3a12
 F Makefile.linux-gcc 7bc79876b875010e8c8f9502eb935ca92aa3c434
 F Makefile.msc 4ebb1d257cac7fb1bcb4ba59278416d410ff1c4bf59447a9c37a415f3516056a
@@ -450,7 +450,7 @@ F src/resolve.c d1e69759e7a79c156c692793f5d16f82f9a60ce5e82efd95e4374b2423034946
 F src/rowset.c 7b7e7e479212e65b723bf40128c7b36dc5afdfac
 F src/select.c 741937503c74d85e64828b63d5a4219d3cfce480a717efef635839606001b1ba
 F src/shell.c 227b86f2bdd707d0a177a4805a5c0b0378ef8337ab1ad04f5d79dc479568735a
-F src/sqlite.h.in fdfae933ad8648defe209a3c155759e5677c23840c84fc7f2a7673bcf39f8b9c
+F src/sqlite.h.in 5d9e3996052222789c2031a0a0107d7bbaea447ff91cb8af1388f01a2e4d8571
 F src/sqlite3.rc 5121c9e10c3964d5755191c80dd1180c122fc3a8
 F src/sqlite3ext.h 58fd0676d3111d02e62e5a35992a7d3da5d3f88753acc174f2d37b774fbbdd28
 F src/sqliteInt.h 37f1a9a3266aa7b11126585314cd98cf11ba6f174b1244de2221270107ea754d
@@ -1627,7 +1627,7 @@ F vsixtest/vsixtest.tcl 6a9a6ab600c25a91a7acc6293828957a386a8a93
 F vsixtest/vsixtest.vcxproj.data 2ed517e100c66dc455b492e1a33350c1b20fbcdc
 F vsixtest/vsixtest.vcxproj.filters 37e51ffedcdb064aad6ff33b6148725226cd608e
 F vsixtest/vsixtest_TemporaryKey.pfx e5b1b036facdb453873e7084e1cae9102ccc67a0
-P 1b4facb1ad0085aa52e63d4d432179467ddc2a69b668d49d86e65ead66a73f57
-R 54d1afcb2229149b45247539ffd292a9
-U mistachkin
-Z bb74ca7ad985e0783b7fe8f258278d9c
+P cae647696769c9fcdc3beafdfdf74d8384217f4b22820e4545093bea7be58f7c
+R 041dfa61180f96fedaa6fea92ed99ea9
+U drh
+Z 9aaf6aa4a967053c1f0cee197b5d2771

diff --git a/manifest.uuid b/manifest.uuid
index e99e4121ce0cb8918a37c5682faf435663f951d2..3edf626bf3b58fd35c10a303040a3826446c1ae9 100644 (file)
--- a/manifest.uuid
+++ b/manifest.uuid
@@ -1 +1 @@
-cae647696769c9fcdc3beafdfdf74d8384217f4b22820e4545093bea7be58f7c
\ No newline at end of file
+284707a7b3514a55cce24292e45632b7033d6edcff5b27deac5118b27c7b2954
\ No newline at end of file

diff --git a/src/sqlite.h.in b/src/sqlite.h.in
index 05875a4109c5aa655ff361cfa588340ad742c1dd..ab722203992de0e693cdc3e1b51d9b50a646bb32 100644 (file)
--- a/src/sqlite.h.in
+++ b/src/sqlite.h.in
@@ -1,5 +1,5 @@
 /*
-** 2001 September 15
+** 2001-09-15
 **
 ** The author disclaims copyright to this source code.  In place of
 ** a legal notice, here is a blessing:
@@ -3483,19 +3483,22 @@ int sqlite3_limit(sqlite3*, int id, int newVal);
 
 /*
 ** CAPI3REF: Prepare Flags
-** KEYWORDS:
 **
 ** These constants define various flags that can be passed into
-** the [sqlite3_prepare_v3()] interface.
+** "prepFlags" parameter of the [sqlite3_prepare_v3()] and
+** [sqlite3_prepare16_v3()] interfaces.
+**
+** New flags may be added in future releases of SQLite.
 **
 ** <dl>
 ** [[SQLITE_PREPARE_PERSISTENT]] ^(<dt>SQLITE_PREPARE_PERSISTENT</dt>
 ** <dd>The SQLITE_PREPARE_PERSISTENT flag causes [sqlite3_prepare_v3()]
+** and [sqlite3_prepare16_v3()]
 ** to optimize the resulting prepared statement to be retained for a 
 ** relatively long amount of time.)^  ^Without this flag,
-** [sqlite3_prepare_v3()] assumes that the prepared statement will be used
-** just once or at most a few times and then destroyed using
-** [sqlite3_finalize()] relatively soon.
+** [sqlite3_prepare_v3()] and [sqlite3_prepare16_v3()] assume that
+** the prepared statement will be used just once or at most a few times
+** and then destroyed using [sqlite3_finalize()] relatively soon.
 ** </dl>
 */
 #define SQLITE_PREPARE_PERSISTENT              0x01
@@ -3506,8 +3509,19 @@ int sqlite3_limit(sqlite3*, int id, int newVal);
 ** METHOD: sqlite3
 ** CONSTRUCTOR: sqlite3_stmt
 **
-** To execute an SQL query, it must first be compiled into a byte-code
-** program using one of these routines.
+** To execute an SQL statement, it must first be compiled into a byte-code
+** program using one of these routines.  Or, in other words, these routines
+** are constructors for the [prepared statement] object.
+**
+** The preferred routine to use is [sqlite3_prepare_v2()].  The
+** [sqlite3_prepare()] interface is legacy and should be avoided.
+** [sqlite3_prepare_v3()] has an extra "prepFlags" option that is used
+** for special purposes.
+**
+** The use of the UTF-8 interfaces is preferred, as SQLite currently
+** does all parsing using UTF-8.  The UTF-16 interfaces are provided
+** as a convenience.  The UTF-16 interfaces work by converting the
+** input text into UTF-8, then invoking the corresponding UTF-8 interface.
 **
 ** The first argument, "db", is a [database connection] obtained from a
 ** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
@@ -3546,7 +3560,7 @@ int sqlite3_limit(sqlite3*, int id, int newVal);
 **
 ** The sqlite3_prepare_v2(), sqlite3_prepare_v3(), sqlite3_prepare16_v2(),
 ** and sqlite3_prepare16_v3() interfaces are recommended for all new programs.
-** The older interfaces are retained (sqlite3_prepare() and sqlite3_prepare16())
+** The older interfaces (sqlite3_prepare() and sqlite3_prepare16())
 ** are retained for backwards compatibility, but their use is discouraged.
 ** ^In the "vX" interfaces, the prepared statement
 ** that is returned (the [sqlite3_stmt] object) contains a copy of the