From: drh <drh@noemail.net>
Date: Thu, 22 Jul 2010 11:40:34 +0000 (+0000)
Subject: Tweaks to the virtual table documentation contained in comments of sqlite3.h.
X-Git-Tag: version-3.7.2~105
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=6ba8e9667c934a8b5e5e059ebb27aec4690113c2;p=thirdparty%2Fsqlite.git

Tweaks to the virtual table documentation contained in comments of sqlite3.h.
No changes to actual code.

FossilOrigin-Name: f5866d4723460e80814b8599e0b84ff4a924da6f
---

diff --git a/manifest b/manifest
index ebf522eec3..d59b2f25b3 100644
--- a/manifest
+++ b/manifest
@@ -1,8 +1,8 @@
 -----BEGIN PGP SIGNED MESSAGE-----
 Hash: SHA1
 
-C Fix\sa\scomment\stypo.\s\sThis\scheck-in\sis\s3.7.0\srelease\scandidate\s2.
-D 2010-07-21T16:16:28
+C Tweaks\sto\sthe\svirtual\stable\sdocumentation\scontained\sin\scomments\sof\ssqlite3.h.\nNo\schanges\sto\sactual\scode.
+D 2010-07-22T11:40:34
 F Makefile.arm-wince-mingw32ce-gcc fcd5e9cd67fe88836360bb4f9ef4cb7f8e2fb5a0
 F Makefile.in ec08dc838fd8110fe24c92e5130bcd91cbb1ff2e
 F Makefile.linux-gcc d53183f4aa6a9192d249731c90dbdffbd2c68654
@@ -173,7 +173,7 @@ F src/resolve.c 1c0f32b64f8e3f555fe1f732f9d6f501a7f05706
 F src/rowset.c 69afa95a97c524ba6faf3805e717b5b7ae85a697
 F src/select.c 4903ff1bbd08b55cbce00ea43c645530de41b362
 F src/shell.c fd4ccdb37c3b68de0623eb938a649e0990710714
-F src/sqlite.h.in 8b05aef506d9bc7fc7da1572744e3174cb16ed59
+F src/sqlite.h.in 2585fc82c922f2772e201e60a76d5fd1ca18370e
 F src/sqlite3ext.h 69dfb8116af51b84a029cddb3b35062354270c89
 F src/sqliteInt.h d9e42f2029d4c526f9ba960bda1980ef17429c30
 F src/sqliteLimit.h 196e2f83c3b444c4548fc1874f52f84fdbda40f3
@@ -840,14 +840,14 @@ F tool/speedtest2.tcl ee2149167303ba8e95af97873c575c3e0fab58ff
 F tool/speedtest8.c 2902c46588c40b55661e471d7a86e4dd71a18224
 F tool/speedtest8inst1.c 293327bc76823f473684d589a8160bde1f52c14e
 F tool/vdbe-compress.tcl d70ea6d8a19e3571d7ab8c9b75cba86d1173ff0f
-P 13ed106c8c279422a6159e28c6887d13a88b7b8b
-R 48f3b6e106f37a4303da6eef05383891
+P b36b105eab6fd3195f4bfba6cb5cda0f063b7460
+R 49569c3fd825d76a4d3c437f67a4e29e
 U drh
-Z 6f03f192e574b328cbf6ee712ebb1776
+Z 1e846dd14c5e4b7b2a4e9b36e0335e29
 -----BEGIN PGP SIGNATURE-----
 Version: GnuPG v1.4.6 (GNU/Linux)
 
-iD8DBQFMRx1eoxKgR168RlERAkrAAJ9jYeUOTv2JXqP7/ZLTAQf2A6QoNACeLuA0
-lTLlFWVnujV93G1zfacFBTo=
-=MCKn
+iD8DBQFMSC41oxKgR168RlERAvgpAJ0bdRAr4fv+g+Tf5xbTOmRdNhaCLQCbBTe8
+EMRyonOpV9dCdr+RpWJl7G8=
+=MacA
 -----END PGP SIGNATURE-----
diff --git a/manifest.uuid b/manifest.uuid
index 91eedcec16..661dc3bf39 100644
--- a/manifest.uuid
+++ b/manifest.uuid
@@ -1 +1 @@
-b36b105eab6fd3195f4bfba6cb5cda0f063b7460
\ No newline at end of file
+f5866d4723460e80814b8599e0b84ff4a924da6f
\ No newline at end of file
diff --git a/src/sqlite.h.in b/src/sqlite.h.in
index a8c6be2333..711e815e0f 100644
--- a/src/sqlite.h.in
+++ b/src/sqlite.h.in
@@ -4320,7 +4320,8 @@ struct sqlite3_module {
 ** CAPI3REF: Virtual Table Indexing Information
 ** KEYWORDS: sqlite3_index_info
 **
-** The sqlite3_index_info structure and its substructures is used to
+** The sqlite3_index_info structure and its substructures is used as part
+** of the [virtual table] interface to
 ** pass information into and receive the reply from the [xBestIndex]
 ** method of a [virtual table module].  The fields under **Inputs** are the
 ** inputs to xBestIndex and are read-only.  xBestIndex inserts its
@@ -4328,10 +4329,12 @@ struct sqlite3_module {
 **
 ** ^(The aConstraint[] array records WHERE clause constraints of the form:
 **
-** <pre>column OP expr</pre>
+** <blockquote>column OP expr</blockquote>
 **
 ** where OP is =, &lt;, &lt;=, &gt;, or &gt;=.)^  ^(The particular operator is
-** stored in aConstraint[].op.)^  ^(The index of the column is stored in
+** stored in aConstraint[].op using one of the
+** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^
+** ^(The index of the column is stored in
 ** aConstraint[].iColumn.)^  ^(aConstraint[].usable is TRUE if the
 ** expr on the right-hand side can be evaluated (and thus the constraint
 ** is usable) and false if it cannot.)^
@@ -4391,6 +4394,15 @@ struct sqlite3_index_info {
   int orderByConsumed;       /* True if output is already ordered */
   double estimatedCost;      /* Estimated cost of using this index */
 };
+
+/*
+** CAPI3REF: Virtual Table Constraint Operator Codes
+**
+** These macros defined the allowed values for the
+** [sqlite3_index_info].aConstraint[].op field.  Each value represents
+** an operator that is part of a constraint term in the wHERE clause of
+** a query that uses a [virtual table].
+*/
 #define SQLITE_INDEX_CONSTRAINT_EQ    2
 #define SQLITE_INDEX_CONSTRAINT_GT    4
 #define SQLITE_INDEX_CONSTRAINT_LE    8