From: drh <drh@noemail.net>
Date: Wed, 3 Dec 2014 16:30:27 +0000 (+0000)
Subject: Futher tweaks to the sqlite3_wal_checkpoint_v2() documentation.
X-Git-Tag: version-3.8.8~128
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=5b875311a3f99aae9f489bd30ffe9d9a2295d981;p=thirdparty%2Fsqlite.git

Futher tweaks to the sqlite3_wal_checkpoint_v2() documentation.

FossilOrigin-Name: 7d284d047b0677fb4532df5aae06f5bad997f5e9
---

diff --git a/manifest b/manifest
index 97c3ddfce2..e54424a2c5 100644
--- a/manifest
+++ b/manifest
@@ -1,5 +1,5 @@
-C Updates\sto\sthe\sdocumentation\sfor\ssqlite3_wal_checkpoint_v2()\sand\srelated\ninterfaces,\sincluding\sadding\smany\srequirements\smarks.
-D 2014-12-03T15:50:09.223
+C Futher\stweaks\sto\sthe\ssqlite3_wal_checkpoint_v2()\sdocumentation.
+D 2014-12-03T16:30:27.252
 F Makefile.arm-wince-mingw32ce-gcc d6df77f1f48d690bd73162294bbba7f59507c72f
 F Makefile.in a226317fdf3f4c895fb3cfedc355b4d0868ce1fb
 F Makefile.linux-gcc 91d710bdc4998cb015f39edf3cb314ec4f4d7e23
@@ -230,7 +230,7 @@ F src/resolve.c 4965007d6497b6a4d7a6d98751cc39712885f952
 F src/rowset.c eccf6af6d620aaa4579bd3b72c1b6395d9e9fa1e
 F src/select.c 428165951748151e87a15295b7357221433e311b
 F src/shell.c 45d9c9bd7cde07845af957f2d849933b990773cf
-F src/sqlite.h.in 7d33b94a32b013832b53ad86be543168f87f8eb7
+F src/sqlite.h.in 8c881e8d225167a878ed7d78a776b372304823a9
 F src/sqlite3.rc 992c9f5fb8285ae285d6be28240a7e8d3a7f2bad
 F src/sqlite3ext.h 17d487c3c91b0b8c584a32fbeb393f6f795eea7d
 F src/sqliteInt.h c9e95b8fa9aee30d46387735c5be73fa58886e38
@@ -1223,7 +1223,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 edda2b9e7a15ed486de81b10dd9bacd39c571d3f
-R d436425f6a4681c70264f79cf1bfa41d
+P 1e212d9899387344fd62c7b6fbcc59ea885b6d7c
+R e9765e182534ca03b14c9167cc7abee7
 U drh
-Z 881f6486595c3b0d62652277de190ac9
+Z 0ecdc98d536d1a5e17e6fc5f0fd27d98
diff --git a/manifest.uuid b/manifest.uuid
index 74bdbd7193..b754092001 100644
--- a/manifest.uuid
+++ b/manifest.uuid
@@ -1 +1 @@
-1e212d9899387344fd62c7b6fbcc59ea885b6d7c
\ No newline at end of file
+7d284d047b0677fb4532df5aae06f5bad997f5e9
\ No newline at end of file
diff --git a/src/sqlite.h.in b/src/sqlite.h.in
index 74c59f9257..09ba5038dd 100644
--- a/src/sqlite.h.in
+++ b/src/sqlite.h.in
@@ -7302,12 +7302,14 @@ int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb);
 ** </dl>
 **
 ** ^If pnLog is not NULL, then *pnLog is set to the total number of frames in
-** the log file before returning or to -1 if the checkpoint could not run because
+** the log file or to -1 if the checkpoint could not run because
 ** of an error or because the database is not in [WAL mode]. ^If pnCkpt is not NULL,
-** then *pnCkpt is set to the total number of checkpointed frames (including any
-** that were already checkpointed before the function was called) or to -1 if the
-** checkpoint could not run due to an error or because the database is not in
-** WAL mode.
+** then *pnCkpt is set to the total number of checkpointed frames in the log file
+** (including any that were already checkpointed before the function was called)
+** or to -1 if the checkpoint could not run due to an error or because the
+** database is not in WAL mode. ^Note that upon successful completion of
+** an SQLITE_CHECKPOINT_TRUNCATE, the log file will have been truncated to
+** zero bytes and so both *pnLog and *pnCkpt will be set to zero.
 **
 ** ^All calls obtain an exclusive "checkpoint" lock on the database file. ^If
 ** any other process is running a checkpoint operation at the same time, the 
@@ -7342,6 +7344,11 @@ int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb);
 ** zDb is not NULL (or a zero length string) and is not the name of any
 ** attached database, SQLITE_ERROR is returned to the caller.
 **
+** ^Unless it returns SQLITE_MISUSE,
+** the sqlite3_wal_checkpoint_v2() interface
+** sets the error information that is queried by
+** [sqlite3_errcode()] and [sqlite3_errmsg()].
+**
 ** ^The [PRAGMA wal_checkpoint] command can be used to invoke this interface
 ** from SQL.
 */