From: drh <drh@noemail.net>
Date: Mon, 3 May 2010 18:51:41 +0000 (+0000)
Subject: Documentation stubs for sqlite3_wal_autocheckpoint and sqlite3_wal_checkpoint.
X-Git-Tag: version-3.7.2~446
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=324e46d4240a6ff3f4d210f81e913ada327727f1;p=thirdparty%2Fsqlite.git

Documentation stubs for sqlite3_wal_autocheckpoint and sqlite3_wal_checkpoint.

FossilOrigin-Name: 313762427d96954667909887a797ea996dc6304a
---

diff --git a/manifest b/manifest
index e3b4bf39be..48bf8c5c55 100644
--- a/manifest
+++ b/manifest
@@ -1,8 +1,8 @@
 -----BEGIN PGP SIGNED MESSAGE-----
 Hash: SHA1
 
-C Fix\sa\sbug\sin\sthe\sxCurrentTime()\smethod\sof\sthe\sos_unix.c\sVFS.
-D 2010-05-03T18:22:53
+C Documentation\sstubs\sfor\ssqlite3_wal_autocheckpoint\sand\ssqlite3_wal_checkpoint.
+D 2010-05-03T18:51:42
 F Makefile.arm-wince-mingw32ce-gcc fcd5e9cd67fe88836360bb4f9ef4cb7f8e2fb5a0
 F Makefile.in d83a0ffef3dcbfb08b410a6c6dd6c009ec9167fb
 F Makefile.linux-gcc d53183f4aa6a9192d249731c90dbdffbd2c68654
@@ -169,7 +169,7 @@ F src/resolve.c ac5f1a713cd1ae77f08b83cc69581e11bf5ae6f9
 F src/rowset.c 69afa95a97c524ba6faf3805e717b5b7ae85a697
 F src/select.c c03d8a0565febcde8c6a12c5d77d065fddae889b
 F src/shell.c c40427c7245535a04a9cb4a417b6cc05c022e6a4
-F src/sqlite.h.in 409c5a6df42a54122d2bf8a0e2cfdad29f60f462
+F src/sqlite.h.in 7afbe9fb794092cb38bd3cfab72c39560ce0def5
 F src/sqlite3ext.h 69dfb8116af51b84a029cddb3b35062354270c89
 F src/sqliteInt.h e7f1368eb56d8a410e510bcffb9ca5795060c58c
 F src/sqliteLimit.h 196e2f83c3b444c4548fc1874f52f84fdbda40f3
@@ -812,14 +812,14 @@ F tool/speedtest2.tcl ee2149167303ba8e95af97873c575c3e0fab58ff
 F tool/speedtest8.c 2902c46588c40b55661e471d7a86e4dd71a18224
 F tool/speedtest8inst1.c 293327bc76823f473684d589a8160bde1f52c14e
 F tool/vdbe-compress.tcl d70ea6d8a19e3571d7ab8c9b75cba86d1173ff0f
-P 7ed85e87dd206083310ba28afab4389885f61dac
-R 5175e74c66fe957d15866ec25a37a50d
+P 551df11a5613e3edc6c5de44f0ac6abc2d0e6cdf
+R 4bf4e5b0f4a906e96bd3ac0228a243cf
 U drh
-Z 4c12b5cd19d1cf1c4b00a44c7ab023bf
+Z 0fab1e112184576c01ef1da394728446
 -----BEGIN PGP SIGNATURE-----
 Version: GnuPG v1.4.6 (GNU/Linux)
 
-iD8DBQFL3xSAoxKgR168RlERAk5NAJ9h19oeeZO4MhhXCfAtgzetnJJ0ogCeOHLB
-kqaxDmXroX+ZHOZd5wAc6lI=
-=i9YY
+iD8DBQFL3xtBoxKgR168RlERAs2dAJ9tK6vYcy8xoZSuH9L5BfJRR+YsjwCeN1V1
+fc6lrByT4ChnQSV8LN9F/xI=
+=0Ylj
 -----END PGP SIGNATURE-----
diff --git a/manifest.uuid b/manifest.uuid
index c7289ee3a3..dcf04aa6a1 100644
--- a/manifest.uuid
+++ b/manifest.uuid
@@ -1 +1 @@
-551df11a5613e3edc6c5de44f0ac6abc2d0e6cdf
\ No newline at end of file
+313762427d96954667909887a797ea996dc6304a
\ No newline at end of file
diff --git a/src/sqlite.h.in b/src/sqlite.h.in
index f31c10ec28..00e8336586 100644
--- a/src/sqlite.h.in
+++ b/src/sqlite.h.in
@@ -5796,11 +5796,29 @@ void *sqlite3_wal_hook(
 
 /*
 ** CAPI3REF: Configure an auto-checkpoint
+**
+** The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around
+** [sqlite3_wal_hook()] that causes any database on [database connection] D
+** to automatically checkpoint
+** after committing a transaction if there are N or
+** more frames in the write-ahead-log file.  Passing zero or 
+** a negative value as the nFrame parameter disables automatic
+** checkpoints entirely.
+**
+** The callback registered by this function replaces any existing callback
+** registered using [sqlite3_wal_hook()]. Likewise, registering a callback
+** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism
+** configured by this function.
 */
 int sqlite3_wal_autocheckpoint(sqlite3 *db, int N);
 
 /*
 ** CAPI3REF: Checkpoint a database
+**
+** The [sqlite3_wal_checkpoint(D,X)] interface causes database named X
+** on [database connection] D to be checkpointed.  If X is NULL or an
+** empty string, then a checkpoint is run on all databases of
+** connection D.
 */
 int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb);