From: drh <> Date: Sun, 7 Dec 2025 18:19:22 +0000 (+0000) Subject: Minor tweaks to the QRF documentation. No changes to code. X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1241fe145008c791f188623799a197d825aa4286;p=thirdparty%2Fsqlite.git Minor tweaks to the QRF documentation. No changes to code. FossilOrigin-Name: b2517d01e65b34ea4ca52c9149d7b255a36a45a50b332cb8ccfdacf22e629be2 --- diff --git a/ext/qrf/README.md b/ext/qrf/README.md index b6a10500ec..111d2b2d96 100644 --- a/ext/qrf/README.md +++ b/ext/qrf/README.md @@ -90,16 +90,10 @@ while( zSql && zSql[0] ){ } ~~~ + ## 2.0 The `sqlite3_qrf_spec` object -The most recent definition of `sqlite3_qrf_spec` is shown below. - -Do not be alarmed by the complexity of this structure. You only need -to understand the properties you want to modify. Zero is always a good -default for all of the attributes (except iVersion and pzOutput/xWrite) -and so simply zeroing out the bulk of this structure is a good start. -You can then slowly make adjustments to individual fields to get the -results you desire. +The `sqlite3_qrf_spec` looks like this: > ~~~ typedef struct sqlite3_qrf_spec sqlite3_qrf_spec; @@ -138,16 +132,19 @@ struct sqlite3_qrf_spec { }; ~~~ -Again, the only fields that must initialized are: +Do not be alarmed by the complexity of this structure. Everything can +be zeroed except for: * `.iVersion` * One of `.pzOutput` or `.xWrite`. -All other fields can be zeroed. Or they can contain other values to -alter the formatting of the query results. +You do not need to understand and configure every field of this object +in order to use QRF effectively. Start by zeroing out the whole structure, +then initializing iVersion and one of pzOutput or xWrite. Then maybe +tweak one or two other settings to get the output you want. Further detail on the meanings of each of the fields in the -`sqlite3_qrf_spec` object are described below. +`sqlite3_qrf_spec` object is in the subsequent sections. ### 2.1 Structure Version Number diff --git a/manifest b/manifest index 298eb27f28..5be241e282 100644 --- a/manifest +++ b/manifest @@ -1,5 +1,5 @@ -C Do\snot\sreturn\stoo\smany\sbytes\sfrom\sthe\szipfile\sextension\sgiven\sa\smalformed\nZIP\sfile. -D 2025-12-06T23:58:09.413 +C Minor\stweaks\sto\sthe\sQRF\sdocumentation.\s\sNo\schanges\sto\scode. +D 2025-12-07T18:19:22.124 F .fossil-settings/binary-glob 61195414528fb3ea9693577e1980230d78a1f8b0a54c78cf1b9b24d0a409ed6a x F .fossil-settings/empty-dirs dbb81e8fc0401ac46a1491ab34a7f2c7c0452f2f06b54ebb845d024ca8283ef1 F .fossil-settings/ignore-glob 35175cdfcf539b2318cb04a9901442804be81cd677d8b889fcc9149c21f239ea @@ -416,7 +416,7 @@ F ext/misc/wholenumber.c 0fa0c082676b7868bf2fa918e911133f2b349bcdceabd1198bba5f6 F ext/misc/windirent.h 02211ce51f3034c675f2dbf4d228194d51b3ee05734678bad5106fff6292e60c F ext/misc/zipfile.c d792ed9b936ddfe9a210ecc893352afaee306c63b084187f6e44951f6f669e21 F ext/misc/zorder.c bddff2e1b9661a90c95c2a9a9c7ecd8908afab5763256294dd12d609d4664eee -F ext/qrf/README.md 6ee2f6431c8260854f815123c7e14769e77c7d0547424b852ae6216099cfdc50 +F ext/qrf/README.md e726cff56c5c8a3aa493d15b6c052834cb6b5f1ca612867bc1cc6a11be8f019b F ext/qrf/dev-notes.md e68a6d91ce4c7eb296ef2daadc2bb79c95c317ad15b9fafe40850c67b29c2430 F ext/qrf/qrf.c 7fb2c4b600fcba4439a3ce8f7aed95f726f15548ce375b78cd983388a0ecebf7 F ext/qrf/qrf.h 0f0387eb4c56eaa46405cd640132624933377e46df3d2baa940392f9a7d35768 @@ -2184,8 +2184,8 @@ F tool/version-info.c 33d0390ef484b3b1cb685d59362be891ea162123cea181cb8e6d2cf6dd F tool/warnings-clang.sh bbf6a1e685e534c92ec2bfba5b1745f34fb6f0bc2a362850723a9ee87c1b31a7 F tool/warnings.sh d924598cf2f55a4ecbc2aeb055c10bd5f48114793e7ba25f9585435da29e7e98 F tool/win/sqlite.vsix deb315d026cc8400325c5863eef847784a219a2f -P 108691a3cb2f296f0ede06c34271ee185f299bfd76e97a1bd06c730a28d94ff4 3d459f1fb1bd1b5e723629c463ab392af7b206ece3388bda216c6a4c26160909 -R 24c7fadd707464dc0ec7c3ced472d67c +P 9766b47beb9ec72f55bfe9fa6e4dadf1829848389388aa30e97094a325de17fa +R 620a97593d72a35202b30b5a287713e0 U drh -Z ee178766ec467478da85eb3dd0679b43 +Z 9bdf30c70846e28b70673bedd2e84b73 # Remove this line to create a well-formed Fossil manifest. diff --git a/manifest.uuid b/manifest.uuid index ea576b1c63..1213867743 100644 --- a/manifest.uuid +++ b/manifest.uuid @@ -1 +1 @@ -9766b47beb9ec72f55bfe9fa6e4dadf1829848389388aa30e97094a325de17fa +b2517d01e65b34ea4ca52c9149d7b255a36a45a50b332cb8ccfdacf22e629be2