From: drh <drh@noemail.net>
Date: Mon, 18 Mar 2013 17:18:18 +0000 (+0000)
Subject: Clarifications to the documentation for the sqlite3_aggregate_context() API.
X-Git-Tag: version-3.7.16.1~12
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=ce3ca25cbcd117d0a238bc028a83c453673dd0fe;p=thirdparty%2Fsqlite.git

Clarifications to the documentation for the sqlite3_aggregate_context() API.
Also, shorten an over-length source line in sqlite.h.in.

FossilOrigin-Name: 4fe2db1d866c80fe51f7fddbf9ce6753fb55b5f6
---

diff --git a/manifest b/manifest
index 81e2d81daa..ef5a112618 100644
--- a/manifest
+++ b/manifest
@@ -1,5 +1,5 @@
-C Version\s3.7.16
-D 2013-03-18T11:39:23.116
+C Clarifications\sto\sthe\sdocumentation\sfor\sthe\ssqlite3_aggregate_context()\sAPI.\nAlso,\sshorten\san\sover-length\ssource\sline\sin\ssqlite.h.in.
+D 2013-03-18T17:18:18.835
 F Makefile.arm-wince-mingw32ce-gcc d6df77f1f48d690bd73162294bbba7f59507c72f
 F Makefile.in 9a804abbd3cae82d196e4d33aba13239e32522a5
 F Makefile.linux-gcc 91d710bdc4998cb015f39edf3cb314ec4f4d7e23
@@ -176,7 +176,7 @@ F src/resolve.c 9079da7d59aed2bb14ec8315bc7f720dd85b5b65
 F src/rowset.c 64655f1a627c9c212d9ab497899e7424a34222e0
 F src/select.c e1c6f6abdf9f359f4e735cb8ae11d2f359bf52a9
 F src/shell.c 7c41bfcd9e5bf9d96b9215f79b03a5b2b44a3bca
-F src/sqlite.h.in f2fa32f440dda59ca47e22889966b2a6eb3b491c
+F src/sqlite.h.in e0ace39d7c14dc9e988cf579f75aaf2a7db7ae77
 F src/sqlite3.rc fea433eb0a59f4c9393c8e6d76a6e2596b1fe0c0
 F src/sqlite3ext.h 7183ab832e23db0f934494f16928da127a571d75
 F src/sqliteInt.h 0f8f05ee4db4ba9120b38f7a3992b325698f6e8a
@@ -1038,10 +1038,7 @@ F tool/vdbe-compress.tcl f12c884766bd14277f4fcedcae07078011717381
 F tool/warnings-clang.sh f6aa929dc20ef1f856af04a730772f59283631d4
 F tool/warnings.sh fbc018d67fd7395f440c28f33ef0f94420226381
 F tool/win/sqlite.vsix 97894c2790eda7b5bce3cc79cb2a8ec2fde9b3ac
-P 0b452734faa0839c817f040322e7733e423bfce2
-R ad71abb6cd4a6ebc6857153126653bad
-T +bgcolor * #d0c0ff
-T +sym-release *
-T +sym-version-3.7.16 *
+P 66d5f2b76750f3520eb7a495f6247206758f5b90
+R 6b3383461c64bf451ee04663b065cc63
 U drh
-Z d73f3a9c465960162106ae1e090c862c
+Z f8cab3c95e26c38e205a97060fe1ac3e
diff --git a/manifest.uuid b/manifest.uuid
index 8d7655aac9..14df4dedc4 100644
--- a/manifest.uuid
+++ b/manifest.uuid
@@ -1 +1 @@
-66d5f2b76750f3520eb7a495f6247206758f5b90
\ No newline at end of file
+4fe2db1d866c80fe51f7fddbf9ce6753fb55b5f6
\ No newline at end of file
diff --git a/src/sqlite.h.in b/src/sqlite.h.in
index 0373353d7b..a6f9b0b370 100644
--- a/src/sqlite.h.in
+++ b/src/sqlite.h.in
@@ -3993,7 +3993,8 @@ SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);
 SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
 SQLITE_DEPRECATED int sqlite3_global_recover(void);
 SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);
-SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),void*,sqlite3_int64);
+SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),
+                      void*,sqlite3_int64);
 #endif
 
 /*
@@ -4073,14 +4074,17 @@ int sqlite3_value_numeric_type(sqlite3_value*);
 ** In those cases, sqlite3_aggregate_context() might be called for the
 ** first time from within xFinal().)^
 **
-** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer if N is
-** less than or equal to zero or if a memory allocate error occurs.
+** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer 
+** when first called if N is less than or equal to zero or if a memory
+** allocate error occurs.
 **
 ** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is
 ** determined by the N parameter on first successful call.  Changing the
 ** value of N in subsequent call to sqlite3_aggregate_context() within
 ** the same aggregate function instance will not resize the memory
-** allocation.)^
+** allocation.)^  Within the xFinal callback, it is customary to set
+** N=0 in calls to sqlite3_aggregate_context(C,N) so that no 
+** pointless memory allocations occur.
 **
 ** ^SQLite automatically frees the memory allocated by 
 ** sqlite3_aggregate_context() when the aggregate query concludes.