Minor cleanups to the header comments on various test_*.c file, to make

the suitable for programmer-level documentation.

FossilOrigin-Name: a65d043a2ad895b931871c67e0ef397a1dc614a6

diff --git a/manifest b/manifest
index b8b2ce242c06aafffec9ac80d172b84509e26f4f..eb200a5f8a6195013d231046f6989e6a3a79ca87 100644 (file)
--- a/manifest
+++ b/manifest
@@ -1,5 +1,5 @@
-C Adjustments\sto\sdocumentation\shyperlinks\sto\saccommodate\sthe\snew\sVFS\ndocumentation.
-D 2011-05-20T20:42:11.435
+C Minor\scleanups\sto\sthe\sheader\scomments\son\svarious\stest_*.c\sfile,\sto\smake\nthe\ssuitable\sfor\sprogrammer-level\sdocumentation.
+D 2011-05-23T18:37:42.742
 F Makefile.arm-wince-mingw32ce-gcc d6df77f1f48d690bd73162294bbba7f59507c72f
 F Makefile.in 11dcc00a8d0e5202def00e81732784fb0cc4fe1d
 F Makefile.linux-gcc 91d710bdc4998cb015f39edf3cb314ec4f4d7e23
@@ -200,7 +200,7 @@ F src/test_autoext.c 30e7bd98ab6d70a62bb9ba572e4c7df347fe645e
 F src/test_backup.c c129c91127e9b46e335715ae2e75756e25ba27de
 F src/test_btree.c 47cd771250f09cdc6e12dda5bc71bc0b3abc96e2
 F src/test_config.c 9a6aa8301a56906612b5e70f5b38e80cfb8af8e7
-F src/test_demovfs.c 938d0f595f8bd310076e1c06cf7885a01ce7ce01
+F src/test_demovfs.c 20a4975127993f4959890016ae9ce5535a880094
 F src/test_devsym.c e7498904e72ba7491d142d5c83b476c4e76993bc
 F src/test_func.c cbdec5cededa0761daedde5baf06004a9bf416b5
 F src/test_fuzzer.c f884f6f32e8513d34248d6e1ac8a32047fead254
@@ -208,10 +208,10 @@ F src/test_hexio.c c4773049603151704a6ab25ac5e936b5109caf5a
 F src/test_init.c 5d624ffd0409d424cf9adbfe1f056b200270077c
 F src/test_intarray.c d879bbf8e4ce085ab966d1f3c896a7c8b4f5fc99
 F src/test_intarray.h 489edb9068bb926583445cb02589344961054207
-F src/test_journal.c 785edd54f963aefb3c1628124170a56697c68c70
+F src/test_journal.c 03313c693cca72959dcaaf79f8d76f21c01e19ff
 F src/test_loadext.c df586c27176e3c2cb2e099c78da67bf14379a56e
 F src/test_malloc.c 7ca7be34e0e09ef0ed6619544552ed95732e41f6
-F src/test_multiplex.c 8e67617b80b532315293761970589581745a52a0
+F src/test_multiplex.c a7457a1ac46964b7f897d75ecfd447410ec067e6
 F src/test_multiplex.h e99c571bc4968b7a9363b661481f3934bfead61d
 F src/test_mutex.c a6bd7b9cf6e19d989e31392b06ac8d189f0d573e
 F src/test_onefile.c 40cf9e212a377a6511469384a64b01e6e34b2eec
@@ -226,7 +226,7 @@ F src/test_superlock.c 2b97936ca127d13962c3605dbc9a4ef269c424cd
 F src/test_syscall.c 162c4ec0137a549c009bb9ecab550527743cfc5d
 F src/test_tclvar.c f4dc67d5f780707210d6bb0eb6016a431c04c7fa
 F src/test_thread.c 361ae0a0f1cbf5a28ad0388a258b104017a370c0
-F src/test_vfs.c 0ac5b2e3da61bc385c1017890687c359746be2fd
+F src/test_vfs.c e7855568dfa1e0ba73668d273b65605d9f8b77e8
 F src/test_vfstrace.c 0b884e06094a746da729119a2cabdc7aa790063d
 F src/test_wholenumber.c 6129adfbe7c7444f2e60cc785927f3aa74e12290
 F src/test_wsd.c 41cadfd9d97fe8e3e4e44f61a4a8ccd6f7ca8fe9
@@ -938,7 +938,7 @@ F tool/speedtest8.c 2902c46588c40b55661e471d7a86e4dd71a18224
 F tool/speedtest8inst1.c 293327bc76823f473684d589a8160bde1f52c14e
 F tool/split-sqlite3c.tcl d9be87f1c340285a3e081eb19b4a247981ed290c
 F tool/vdbe-compress.tcl d70ea6d8a19e3571d7ab8c9b75cba86d1173ff0f
-P a6a0fefbe503a2c81aa1847ced3bac21850d8faa
-R 1c4aa7e39f492e96b1f4f46ead44733c
+P 139a8f53ae1979591734a8244fb33655a6499193
+R 135e5df582474459d4ad1ce32ee0336a
 U drh
-Z 31318bdaf7f46736283d7518e5463d58
+Z 551eea5e1688e783dfd89f144647d748

diff --git a/manifest.uuid b/manifest.uuid
index 372beb9a2c70d7d9de826fef04fbbeb45a12a651..196319ab0a50a4a7ac64c764aa35e95eb47d632c 100644 (file)
--- a/manifest.uuid
+++ b/manifest.uuid
@@ -1 +1 @@
-139a8f53ae1979591734a8244fb33655a6499193
\ No newline at end of file
+a65d043a2ad895b931871c67e0ef397a1dc614a6
\ No newline at end of file

diff --git a/src/test_demovfs.c b/src/test_demovfs.c
index d7bcd1f908285cd3e8bcdf33916bfad697e0b61f..637627071d9e28f4b3451bbbddf808d1a91200f8 100644 (file)
--- a/src/test_demovfs.c
+++ b/src/test_demovfs.c
@@ -10,14 +10,12 @@
 **
 *************************************************************************
 **
-** An example of a simple VFS implementation that omits complex features
-** often not required or not possible on embedded platforms. Also includes
-** code to buffer writes to the journal file, which can be a significant
-** performance improvement on some embedded platforms.
+** This file implements an example of a simple VFS implementation that 
+** omits complex features often not required or not possible on embedded
+** platforms.  Code is included to buffer writes to the journal file, 
+** which can be a significant performance improvement on some embedded
+** platforms.
 **
-*/
-
-/*
 ** OVERVIEW
 **
 **   The code in this file implements a minimal SQLite VFS that can be 

diff --git a/src/test_journal.c b/src/test_journal.c
index ca4c5c38844b96381a6b1d26cb1567eb7b7b9e55..68869723b3e2af7492fc828cc985b34cd387cb6c 100644 (file)
--- a/src/test_journal.c
+++ b/src/test_journal.c
@@ -14,13 +14,7 @@
 ** an existing VFS. The code in this file attempts to verify that SQLite
 ** correctly populates and syncs a journal file before writing to a
 ** corresponding database file.
-*/
-#if SQLITE_TEST          /* This file is used for testing only */
-
-#include "sqlite3.h"
-#include "sqliteInt.h"
-
-/*
+**
 ** INTERFACE
 **
 **   The public interface to this wrapper VFS is two functions:
@@ -99,6 +93,10 @@
 **
 **     c) The journal file is deleted using xDelete.
 */
+#if SQLITE_TEST          /* This file is used for testing only */
+
+#include "sqlite3.h"
+#include "sqliteInt.h"
 
 /*
 ** Maximum pathname length supported by the jt backend.

diff --git a/src/test_multiplex.c b/src/test_multiplex.c
index 32e63ae889ea0ebc8eded072d603d948d08947ed..f709c9a99f403e9e31f6629a74d16431b4d263b4 100644 (file)
--- a/src/test_multiplex.c
+++ b/src/test_multiplex.c
@@ -11,13 +11,36 @@
 *************************************************************************
 **
 ** This file contains a VFS "shim" - a layer that sits in between the
-** pager and the real VFS.
+** pager and the real VFS - that breaks up a very large database file
+** into two or more smaller files on disk.  This is useful, for example,
+** in order to support large, multi-gigabyte databases on older filesystems
+** that limit the maximum file size to 2 GiB.
 **
-** This particular shim enforces a multiplex system on DB files.  
-** This shim shards/partitions a single DB file into smaller 
-** "chunks" such that the total DB file size may exceed the maximum
-** file size of the underlying file system.
+** USAGE:
 **
+** Compile this source file and link it with your application.  Then
+** at start-time, invoke the following procedure:
+**
+**   int sqlite3_multiplex_initialize(
+**      const char *zOrigVfsName,    // The underlying real VFS
+**      int makeDefault              // True to make multiplex the default VFS
+**   );
+**
+** The procedure call above will create and register a new VFS shim named
+** "multiplex".  The multiplex VFS will use the VFS named by zOrigVfsName to
+** do the actual disk I/O.  (The zOrigVfsName parameter may be NULL, in 
+** which case the default VFS at the moment sqlite3_multiplex_initialize()
+** is called will be used as the underlying real VFS.)  
+**
+** If the makeDefault parameter is TRUE then multiplex becomes the new
+** default VFS.  Otherwise, you can use the multiplex VFS by specifying
+** "multiplex" as the 4th parameter to sqlite3_open_v2() or by employing
+** URI filenames and adding "vfs=multiplex" as a parameter to the filename
+** URI.
+**
+** The multiplex VFS allows databases up to 32 GiB in size.  But it splits
+** the files up into 1 GiB pieces, so that they will work even on filesystems
+** that do not support large files.
 */
 #include "sqlite3.h"
 #include <string.h>

diff --git a/src/test_vfs.c b/src/test_vfs.c
index ba078a0f9b8b56ff0fb14b234d1a4099e3f86a48..696321d26eefd2df6e478007a0316e1871e2064a 100644 (file)
--- a/src/test_vfs.c
+++ b/src/test_vfs.c
@@ -10,10 +10,6 @@
 **
 ******************************************************************************
 **
-*/
-#if SQLITE_TEST          /* This file is used for testing only */
-
-/*
 ** This file contains the implementation of the Tcl [testvfs] command,
 ** used to create SQLite VFS implementations with various properties and
 ** instrumentation to support testing SQLite.
@@ -28,6 +24,7 @@
 **   -mxpathname INTEGER        (Value for sqlite3_vfs.mxPathname)
 **   -iversion   INTEGER        (Value for sqlite3_vfs.iVersion)
 */
+#if SQLITE_TEST          /* This file is used for testing only */
 
 #include "sqlite3.h"
 #include "sqliteInt.h"