Updates to the sqlite3_stmt_scanstatus() documentation. No changes to code.

FossilOrigin-Name: d97c324eb1d870c994911c53fbf84205f4e3e7a1

diff --git a/manifest b/manifest
index 07d97518f1d1c2d7f2896d4c10be1448e15e1c9b..8d217ecfe030fb135bf5c9f59f74ca68dc45e11f 100644 (file)
--- a/manifest
+++ b/manifest
@@ -1,5 +1,5 @@
-C Add\sthe\sexperimental\ssqlite3_stmt_scanstatus()\sAPI.\sFor\scomparing\sthe\snumber\sof\srows\sactually\svisited\sby\sa\sloop\swith\sthe\sestimate\sused\sby\sthe\squery\splanner.
-D 2014-11-03T16:56:43.943
+C Updates\sto\sthe\ssqlite3_stmt_scanstatus()\sdocumentation.\s\sNo\schanges\sto\scode.
+D 2014-11-03T18:03:00.467
 F Makefile.arm-wince-mingw32ce-gcc d6df77f1f48d690bd73162294bbba7f59507c72f
 F Makefile.in cf57f673d77606ab0f2d9627ca52a9ba1464146a
 F Makefile.linux-gcc 91d710bdc4998cb015f39edf3cb314ec4f4d7e23
@@ -229,7 +229,7 @@ F src/resolve.c 4965007d6497b6a4d7a6d98751cc39712885f952
 F src/rowset.c eccf6af6d620aaa4579bd3b72c1b6395d9e9fa1e
 F src/select.c 428165951748151e87a15295b7357221433e311b
 F src/shell.c 282f8f5278e0c78eb442217531172ec9e1538796
-F src/sqlite.h.in 3b69f7d9b74e2e5d0448dc2f0d2d160517afa253
+F src/sqlite.h.in 11f33a3e968a9637d6fa4ae879b83edd171ac88f
 F src/sqlite3.rc 992c9f5fb8285ae285d6be28240a7e8d3a7f2bad
 F src/sqlite3ext.h 17d487c3c91b0b8c584a32fbeb393f6f795eea7d
 F src/sqliteInt.h 8f67ca79e957b8ece7453b8e320b6a996e1b4761
@@ -1211,7 +1211,7 @@ F tool/vdbe_profile.tcl 67746953071a9f8f2f668b73fe899074e2c6d8c1
 F tool/warnings-clang.sh f6aa929dc20ef1f856af04a730772f59283631d4
 F tool/warnings.sh 0abfd78ceb09b7f7c27c688c8e3fe93268a13b32
 F tool/win/sqlite.vsix deb315d026cc8400325c5863eef847784a219a2f
-P a518bc3318232d652349eb29303ff250aee40459 4c5714ab3dba19513374c7b1478221a0b90b450c
-R ce3f2c2aee62a076b6ed59326c9cde3e
-U dan
-Z cd275722bcaf367ed1a07165e9a16c03
+P ab3b0fc5760c6d428dbe1f974726a7d3526640bc
+R e3e372d3594a5227dc7ce2380d71aae3
+U drh
+Z 7bcc3180ea33e48aa6d0e7855da7bfd4

diff --git a/manifest.uuid b/manifest.uuid
index c71e9c3f3710295372ff353ed781b1c222a0150f..0611c8a12ec3db0546ccc0f4df1954c60d9e44d5 100644 (file)
--- a/manifest.uuid
+++ b/manifest.uuid
@@ -1 +1 @@
-ab3b0fc5760c6d428dbe1f974726a7d3526640bc
\ No newline at end of file
+d97c324eb1d870c994911c53fbf84205f4e3e7a1
\ No newline at end of file

diff --git a/src/sqlite.h.in b/src/sqlite.h.in
index f51dca0d840dde314b5fbf22f52574ea7d2e2f39..41cc43984614cc42dec99e991c5728174e470fe5 100644 (file)
--- a/src/sqlite.h.in
+++ b/src/sqlite.h.in
@@ -7411,35 +7411,36 @@ int sqlite3_vtab_on_conflict(sqlite3 *);
 /* #define SQLITE_ABORT 4  // Also an error code */
 #define SQLITE_REPLACE  5
 
-/* CAPI3REF: Prepared Statement Scan Status Opcodes
-** KEYWORDS: {scanstatus option}
+/*
+** CAPI3REF: Prepared Statement Scan Status Opcodes
+** KEYWORDS: {scanstatus options}
 **
 ** The following constants can be used for the T parameter to the
 ** [sqlite3_stmt_scanstatus(S,X,T,V)] interface.  Each constant designates a
 ** different metric for sqlite3_stmt_scanstatus() to return.
 **
 ** <dl>
-** [[SQLITE_SCANSTAT_NLOOP]] <td>SQLITE_SCANSTAT_NLOOP</dt>
-** <dd>The [sqlite3_int64] variable pointed to by the T parameter will be set to the
+** [[SQLITE_SCANSTAT_NLOOP]] <dt>SQLITE_SCANSTAT_NLOOP</dt>
+** <dd>^The [sqlite3_int64] variable pointed to by the T parameter will be set to the
 ** total number of times that the X-th loop has run.</dd>
 **
-** [[SQLITE_SCANSTAT_NVISIT]] <td>SQLITE_SCANSTAT_NVISIT</dt>
-** <dd>The [sqlite3_int64] variable pointed to by the T parameter will be set to the
+** [[SQLITE_SCANSTAT_NVISIT]] <dt>SQLITE_SCANSTAT_NVISIT</dt>
+** <dd>^The [sqlite3_int64] variable pointed to by the T parameter will be set to the
 ** total number of rows visited by the X-th loop.</dd>
 **
-** [[SQLITE_SCANSTAT_EST]] <td>SQLITE_SCANSTAT_EST</dt>
-** <dd>The [sqlite3_int64] variable pointed to by the T parameter will be set to the
+** [[SQLITE_SCANSTAT_EST]] <dt>SQLITE_SCANSTAT_EST</dt>
+** <dd>^The [sqlite3_int64] variable pointed to by the T parameter will be set to the
 ** query planner's estimate for the number of rows visited for each
 ** iteration of the X-th loop.  If the query planner's estimate was accurate,
 ** then this value should be approximately NVISIT/NLOOP.
 **
-** [[SQLITE_SCANSTAT_NAME]] <td>SQLITE_SCANSTAT_NAME</dt>
-** <dd>The "const char *" variable pointed to by the T parameter will be set to 
+** [[SQLITE_SCANSTAT_NAME]] <dt>SQLITE_SCANSTAT_NAME</dt>
+** <dd>^The "const char *" variable pointed to by the T parameter will be set to 
 ** a zero-terminated UTF-8 string containing the name of the index or table used
 ** for the X-th loop.
 **
-** [[SQLITE_SCANSTAT_EXPLAIN]] <td>SQLITE_SCANSTAT_EXPLAIN</dt>
-** <dd>The "const char *" variable pointed to by the T parameter will be set to 
+** [[SQLITE_SCANSTAT_EXPLAIN]] <dt>SQLITE_SCANSTAT_EXPLAIN</dt>
+** <dd>^The "const char *" variable pointed to by the T parameter will be set to 
 ** a zero-terminated UTF-8 string containing the [EXPLAIN QUERY PLAN] description
 ** for the X-th loop.
 ** </dl>
@@ -7458,21 +7459,23 @@ int sqlite3_vtab_on_conflict(sqlite3 *);
 ** The "iScanStatusOp" parameter determines which status information to return.
 ** The "iScanStatusOp" must be one of the [scanstatus options] or the behavior of
 ** this interface is undefined.
-** The requested measurement is written into a variable pointed to by
+** ^The requested measurement is written into a variable pointed to by
 ** the "pOut" parameter.
 ** Parameter "idx" identifies the specific loop to retrieve statistics for.
-** Loops are numbered starting from zero. If idx is out of range - less than
+** Loops are numbered starting from zero. ^If idx is out of range - less than
 ** zero or greater than or equal to the total number of loops used to implement
 ** the statement - a non-zero value is returned and the variable that pOut
 ** points to is unchanged.
 **
-** Statistics might not be available for all loops in all statements. In cases
+** ^Statistics might not be available for all loops in all statements. ^In cases
 ** where there exist loops with no available statistics, this function behaves
 ** as if the loop did not exist - it returns non-zero and leave the variable
 ** that pOut points to unchanged.
 **
 ** This API is only available if the library is built with pre-processor
 ** symbol [SQLITE_ENABLE_STMT_SCANSTATUS] defined.
+**
+** See also: [sqlite3_stmt_scanstatus_reset()]
 */
 SQLITE_EXPERIMENTAL int sqlite3_stmt_scanstatus(
   sqlite3_stmt *pStmt,      /* Prepared statement for which info desired */
@@ -7484,7 +7487,7 @@ SQLITE_EXPERIMENTAL int sqlite3_stmt_scanstatus(
 /*
 ** CAPI3REF: Zero Scan-Status Counters
 **
-** Zero all sqlite3_stmt_scanstatus() related event counters.
+** ^Zero all [sqlite3_stmt_scanstatus()] related event counters.
 **
 ** This API is only available if the library is built with pre-processor
 ** symbol [SQLITE_ENABLE_STMT_SCANSTATUS] defined.