From: drh <drh@noemail.net>
Date: Mon, 14 Apr 2014 14:43:09 +0000 (+0000)
Subject: Fix comments on the rtreenode() and rtreedepth() test function in the R-Tree
X-Git-Tag: version-3.13.0~148^2~145^2~12
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=de8c279b28defed9ca99483bdc22eb3959f63fd9;p=thirdparty%2Fsqlite.git

Fix comments on the rtreenode() and rtreedepth() test function in the R-Tree
module.

FossilOrigin-Name: ade5b986e8baab9df7bdaf7ccfaee2d6ba55fa3c
---

diff --git a/ext/rtree/rtree.c b/ext/rtree/rtree.c
index 5fff43529e..17375718e9 100644
--- a/ext/rtree/rtree.c
+++ b/ext/rtree/rtree.c
@@ -2946,10 +2946,10 @@ static int rtreeInit(
 ** Implementation of a scalar function that decodes r-tree nodes to
 ** human readable strings. This can be used for debugging and analysis.
 **
-** The scalar function takes two arguments, a blob of data containing
-** an r-tree node, and the number of dimensions the r-tree indexes.
-** For a two-dimensional r-tree structure called "rt", to deserialize
-** all nodes, a statement like:
+** The scalar function takes two arguments: (1) the number of dimensions
+** to the rtree (between 1 and 5, inclusive) and (2) a blob of data containing
+** an r-tree node.  For a two-dimensional r-tree structure called "rt", to
+** deserialize all nodes, a statement like:
 **
 **   SELECT rtreenode(2, data) FROM rt_node;
 **
@@ -3003,6 +3003,15 @@ static void rtreenode(sqlite3_context *ctx, int nArg, sqlite3_value **apArg){
   sqlite3_result_text(ctx, zText, -1, sqlite3_free);
 }
 
+/* This routine implements an SQL function that returns the "depth" parameter
+** from the front of a blob that is an r-tree node.  For example:
+**
+**     SELECT rtreedepth(data) FROM rt_node WHERE nodeno=1;
+**
+** The depth value is 0 for all nodes other than the root node, and the root
+** node always has nodeno=1, so the example above is the primary use for this
+** routine.  This routine is intended for testing and analysis only.
+*/
 static void rtreedepth(sqlite3_context *ctx, int nArg, sqlite3_value **apArg){
   UNUSED_PARAMETER(nArg);
   if( sqlite3_value_type(apArg[0])!=SQLITE_BLOB 
diff --git a/manifest b/manifest
index 9126cb413e..89c7e30ee7 100644
--- a/manifest
+++ b/manifest
@@ -1,5 +1,5 @@
-C Remove\sover\s300\slines\sof\sunused\scode,\scode\sthat\simplemented\sthe\solder\s\nGuttman\sinsertion\salgorithms\sthat\sare\sno\slonger\sused.
-D 2014-04-14T12:18:17.185
+C Fix\scomments\son\sthe\srtreenode()\sand\srtreedepth()\stest\sfunction\sin\sthe\sR-Tree\nmodule.
+D 2014-04-14T14:43:09.474
 F Makefile.arm-wince-mingw32ce-gcc d6df77f1f48d690bd73162294bbba7f59507c72f
 F Makefile.in e4ee6d36cdf6136aee0158675a3b24dd3bf31a5a
 F Makefile.linux-gcc 91d710bdc4998cb015f39edf3cb314ec4f4d7e23
@@ -120,7 +120,7 @@ F ext/misc/vfslog.c fe40fab5c077a40477f7e5eba994309ecac6cc95
 F ext/misc/vtshim.c babb0dc2bf116029e3e7c9a618b8a1377045303e
 F ext/misc/wholenumber.c 784b12543d60702ebdd47da936e278aa03076212
 F ext/rtree/README 6315c0d73ebf0ec40dedb5aa0e942bc8b54e3761
-F ext/rtree/rtree.c d7fbe473260cc53463c372c9cf7303495a40fbc8
+F ext/rtree/rtree.c 07630c252ce0ba63d2d0e6922847eff6eec64fbc
 F ext/rtree/rtree.h 834dbcb82dc85b2481cde6a07cdadfddc99e9b9e
 F ext/rtree/rtree1.test cf679265ecafff494a768ac9c2f43a70915a6290
 F ext/rtree/rtree2.test acbb3a4ce0f4fbc2c304d2b4b784cfa161856bba
@@ -1175,7 +1175,7 @@ F tool/vdbe_profile.tcl 67746953071a9f8f2f668b73fe899074e2c6d8c1
 F tool/warnings-clang.sh f6aa929dc20ef1f856af04a730772f59283631d4
 F tool/warnings.sh d1a6de74685f360ab718efda6265994b99bbea01
 F tool/win/sqlite.vsix 030f3eeaf2cb811a3692ab9c14d021a75ce41fff
-P ca7357e66ca60f59477b1db000c2cdaeb8082ae1
-R cf842e59d29c59dde99b1f71fa55bf0f
+P 3ba5f295c709faebf5505e61f6dc5266b811b086
+R e7b36f9b46b38d0d4d4bc75aff5d0712
 U drh
-Z e4f991d8b5489d1278b0a7eb150a81ec
+Z 1c3694849e99525baeaeac92e41be917
diff --git a/manifest.uuid b/manifest.uuid
index 512a941529..0a6c215cd0 100644
--- a/manifest.uuid
+++ b/manifest.uuid
@@ -1 +1 @@
-3ba5f295c709faebf5505e61f6dc5266b811b086
\ No newline at end of file
+ade5b986e8baab9df7bdaf7ccfaee2d6ba55fa3c
\ No newline at end of file