From 15bff25111c307c3821f81a1d91c377ee98729e2 Mon Sep 17 00:00:00 2001
From: drh <>
Date: Fri, 22 Dec 2023 12:57:49 +0000
Subject: Add a new comment to debugging output routine sqlite3WhereLoopPrint()
 to remind us of what the various fields of the debug output mean.  No changes
 to code.

FossilOrigin-Name: da5f34fd4052432b1ae27bb12e56b358cdc5c1282653d60ed0f0fe62f727e4ee
---
 src/where.c | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'src')

diff --git a/src/where.c b/src/where.c
index 15f206a09..a1545ce0b 100644
--- a/src/where.c
+++ b/src/where.c
@@ -2245,6 +2245,18 @@ void sqlite3WhereClausePrint(WhereClause *pWC){
 #ifdef WHERETRACE_ENABLED
 /*
 ** Print a WhereLoop object for debugging purposes
+**
+** Format example:
+**
+**     .--- Position in WHERE clause           rSetup, rRun, nOut ---.
+**     |                                                             |
+**     |  .--- selfMask                       nTerm ------.          |
+**     |  |                                               |          |
+**     |  |   .-- prereq    Idx          wsFlags----.     |          |
+**     |  |   |             Name                    |     |          |
+**     |  |   |           __|__        nEq ---.  ___|__   |        __|__
+**     | / \ / \         /     \              | /      \ / \      /     \
+**     1.002.001         t2.t2xy              2 f 010241 N 2 cost 0,56,31
 */
 void sqlite3WhereLoopPrint(WhereLoop *p, WhereClause *pWC){
   WhereInfo *pWInfo = pWC->pWInfo;
-- 
cgit v1.2.3