]> git.ipfire.org Git - thirdparty/sqlite.git/commitdiff
Doc touchups in the line-editing feature check code.
authorstephan <stephan@noemail.net>
Thu, 7 Nov 2024 15:23:54 +0000 (15:23 +0000)
committerstephan <stephan@noemail.net>
Thu, 7 Nov 2024 15:23:54 +0000 (15:23 +0000)
FossilOrigin-Name: bb5656bdc905947df205432e108ca6724393061a27028e23bf35b4bf48505d4f

auto.def
autosetup/README.md
autosetup/proj.tcl
manifest
manifest.uuid

index 01badb8b5387ca4a43bc93f85989e6f00c28d287..8e17e634055c0b15ea4782a8a7cdd627a1b0a9c7 100644 (file)
--- a/auto.def
+++ b/auto.def
@@ -791,7 +791,7 @@ if {1} {
 #   - HAVE_LINENOISE to 0, 1, or 2
 #   - HAVE_EDITLINE to 0 or 1
 #
-# Only one of ^^^ those will be set to 1.
+# Only one of ^^^ those will be set to non-0.
 #
 #   - LDFLAGS_READLINE = linker flags or empty string
 #
@@ -807,7 +807,8 @@ if {1} {
 #
 # Order of checks:
 #
-#  1) --with-linenoise trumps all others
+#  1) --with-linenoise trumps all others and skips all of the
+#     complexities involved with the remaining options.
 #
 #  2) --editline trumps --readline
 #
@@ -815,7 +816,7 @@ if {1} {
 #
 #  4) Default to automatic search for optional readline
 #
-#  5) Try to find readline resp. editline. If it's not found AND the
+#  5) Try to find readline or editline. If it's not found AND the
 #     corresponding --FEATURE flag was explicitly given, fail fatally,
 #     else fail silently.
 proc sqlite-check-line-editing {} {
@@ -825,7 +826,9 @@ proc sqlite-check-line-editing {} {
   define HAVE_EDITLINE 0
   define LDFLAGS_READLINE ""
   define CFLAGS_READLINE ""
-  set failIfNotFound 0 ; # Set to 1 for explicit --FEATURE requests
+  set failIfNotFound 0 ; # Gets set to 1 for explicit --FEATURE requests
+                         # so that we know whether to fail fatally or not
+                         # if the library is not found.
   set libsForReadline {readline edit} ; # -l<LIB> names to check for readline().
                                         # The libedit check changes this.
   set editLibName "readline" ; # "readline" or "editline"
@@ -874,8 +877,8 @@ proc sqlite-check-line-editing {} {
     #
     # shell.c historically expects HAVE_EDITLINE to be set for
     # libedit, but it then expects to see <editline/readline.h>, which
-    # some system's don't actually have, despite having libedit.  If
-    # we end up finding <editline/readline.h> below, we will use
+    # some system's don't actually have despite having libedit.  If we
+    # end up finding <editline/readline.h> below, we will use
     # -DHAVE_EDITLINE=1, else we will use -DHAVE_READLINE=1. In either
     # case, we will link against libedit.
     set failIfNotFound 1
@@ -899,11 +902,9 @@ proc sqlite-check-line-editing {} {
     } else {
       set v [file dirname $v]
       if {[string match */readline $v]} {
-        # Special case: if the path includes .../readline/readline.h, set
-        # the -I to one dir up from that because our sources include
-        # <readline/readline.h> or <editline/readline.h>.  Reminder: if
-        # auto.def is being run by jimsh0 then [file normalize] will not
-        # work!
+        # Special case: if the path includes .../readline/readline.h,
+        # set the -I to one dir up from that because our sources
+        # #include <readline/readline.h> or <editline/readline.h>.
         set v [file dirname $v]
       }
       proj-opt-set with-readline-cflags "-I$v"
@@ -978,7 +979,7 @@ proc sqlite-check-line-editing {} {
       # Alert the user that, despite outward appearances, we won't be
       # linking to the GPL'd libreadline. Presumably that distinction is
       # significant for those using --editline.
-      proj-indented-notice -notice {
+      proj-indented-notice {
         NOTE: the local libedit but uses <readline/readline.h> so we
         will compile with -DHAVE_READLINE=1 but will link with
         libedit.
@@ -1009,8 +1010,7 @@ proc sqlite-check-line-editing {} {
                return 0;
              }
            }]} {
-      user-notice "WARNING: readline-style completion disabled due to rl_completion_matches() signature mismatch"
-      show-notices
+      proj-warn "readline-style completion disabled due to rl_completion_matches() signature mismatch"
       sqlite-add-shell-opt -DSQLITE_OMIT_READLINE_COMPLETION
     }
     return $editLibName
index 696569a4237bf5f4a08a469bade6b7948433f2c8..f80a46aad047eb5d2438a10926325416c5458cd6 100644 (file)
@@ -126,7 +126,7 @@ In (mostly) alphabetical order:
   `show-notices` is called or the next time autosetup would output
   something. This can be used to generate warnings between a "checking
   for..." message and its resulting "yes/no/whatever" message in such
-  a way as to not spoil layout of such messages.
+  a way as to not spoil the layout of such messages.
 
 <a name="tclcompat"></a>
 Ensuring TCL Compatibility
index 91a7ca77b1da17ca733113451a52bf59bd8842e6..b2c527e622fc71d950c125defc967ec8519dceb4 100644 (file)
@@ -61,6 +61,7 @@ set proj_(isatty) [isatty? stdout]
 #
 # Emits a warning message to stderr.
 proc proj-warn {msg} {
+  show-notices
   puts stderr "WARNING: $msg"
 }
 ########################################################################
index 53d31b690875f620e99d39e5f82e5d9219a08dc6..902eb0341a30efd5f0ab5ec5c42316ad0f7d3bc1 100644 (file)
--- a/manifest
+++ b/manifest
@@ -1,5 +1,5 @@
-C tcl\sconfiguration:\s--with-tcl=prefix\sis\sequivalent\sto\spassing\sthe\s--prefix\sdir\sto\sit.\sIf\s--with-tcl\sor\s--enable-tcl\sare\sexplicitly\spassed\sin\sand\stclConfig.sh\sis\snot\sfound,\sfail\sfatally.\sWhen\sTCL\sis\seither\sexplicitly\sdisabled\sor\sdefault\ssearch\sfor\sit\sfails\snon-fatally,\sbe\smore\sexplicit\sabout\swhich\scomponents\sare\snot\savailable.
-D 2024-11-07T15:04:15.370
+C Doc\stouchups\sin\sthe\sline-editing\sfeature\scheck\scode.
+D 2024-11-07T15:23:54.771
 F .fossil-settings/empty-dirs dbb81e8fc0401ac46a1491ab34a7f2c7c0452f2f06b54ebb845d024ca8283ef1
 F .fossil-settings/ignore-glob 35175cdfcf539b2318cb04a9901442804be81cd677d8b889fcc9149c21f239ea
 F LICENSE.md e108e1e69ae8e8a59e93c455654b8ac9356a11720d3345df2a4743e9590fb20d
@@ -13,7 +13,7 @@ F art/icon-80x90.gif 65509ce3e5f86a9cd64fe7fca2d23954199f31fe44c1e09e208c80fb83d
 F art/sqlite370.eps aa97a671332b432a54e1d74ff5e8775be34200c2
 F art/sqlite370.ico af56c1d00fee7cd4753e8631ed60703ed0fc6e90
 F art/sqlite370.jpg d512473dae7e378a67e28ff96a34da7cb331def2
-F auto.def 994745e992211047879521fa05742b9eaedafe8f2600a7b8d784c32e6afa41fa
+F auto.def 8adbbcff2808b47c6ea7e55c8303e89e9364906a73dd2ffc55f8171e74366393
 F autoconf/INSTALL 83e4a25da9fd053c7b3665eaaaf7919707915903
 F autoconf/Makefile.am adedc1324b6a87fdd1265ddd336d2fb7d4f36a0e77b86ea553ae7cc4ea239347
 F autoconf/Makefile.fallback 22fe523eb36dfce31e0f6349f782eb084e86a5620b2b0b4f84a2d6133f53f5ac
@@ -37,7 +37,7 @@ F autoconf/tea/win/rules.vc 94a18c3e453535459b4a643983acca52fb8756e79055bd2ad4b0
 F autoconf/tea/win/targets.vc 96a25a1fa6e9e9cfb348fd3760a5395b4ce8acafc8ed10f0412937ec200d5dbd
 F autosetup/LICENSE 41a26aebdd2cd185d1e2b210f71b7ce234496979f6b35aef2cbf6b80cbed4ce4
 F autosetup/README.autosetup a78ff8c4a3d2636a4268736672a74bf14a82f42687fcf0631a70c516075c031e
-F autosetup/README.md 0fd0e5f83122a5ba12896540f2804921c90165dd475323adf57369b5baad91be
+F autosetup/README.md 8f2f1cc05913a9d1267f32eb8325f77b3ac6b45cd7d8f6149667efcd90ddbcaa
 F autosetup/autosetup 9416ffdcdd6e2dbf7f6d1e5c890078518930f8af7722a950eacc28c7f151d2d6 x
 F autosetup/autosetup-config.guess dfa101c5e8220e864d5e9c72a85e87110df60260d36cb951ad0a85d6d9eaa463 x
 F autosetup/autosetup-config.sub a38fb074d0dece01cf919e9fb534a26011608aa8fa606490864295328526cd73 x
@@ -50,7 +50,7 @@ F autosetup/cc.tcl c0fcc50ca91deff8741e449ddad05bcd08268bc31177e613a6343bbd1fd3e
 F autosetup/default.auto 5cdf016de2140e50f1db190a02039dc42fb390af1dda4cc4853e3042a9ef0e82
 F autosetup/jimsh0.c d40e381ea4526a067590e7b91bd4b2efa6d4980d286f908054c647b3df4aee14
 F autosetup/pkg-config.tcl 4e635bf39022ff65e0d5434339dd41503ea48fc53822c9c5bde88b02d3d952ba
-F autosetup/proj.tcl f125ba46b08b2ae0aa4afc4c3547fdd6c9487a609e0147217e62b2e4ec5d5e0e
+F autosetup/proj.tcl 5afbe391eae951567752ba8f0b4ecc05acd5a261e4417161623adda448154ad5
 F autosetup/system.tcl 51d4be76cd9a9074704b584e5c9cbba616202c8468cf9ba8a4f8294a7ab1dba9
 F autosetup/tmake.auto eaebc74ad538dfdd3c817c27eefc31930c20510c4f3a3704071f6cb0629ed71f
 F autosetup/tmake.tcl a275793ec1b6f8708179af0acef1f6f10d46c2920739743f7a8720c6d700c7a9
@@ -2200,8 +2200,8 @@ F tool/version-info.c 3b36468a90faf1bbd59c65fd0eb66522d9f941eedd364fabccd7227350
 F tool/warnings-clang.sh bbf6a1e685e534c92ec2bfba5b1745f34fb6f0bc2a362850723a9ee87c1b31a7
 F tool/warnings.sh 49a486c5069de041aedcbde4de178293e0463ae9918ecad7539eedf0ec77a139
 F tool/win/sqlite.vsix deb315d026cc8400325c5863eef847784a219a2f
-P 6201b5707f8c895028f9c08cb4f83d33a16a91bf04ed3830ac51aa763d6b7205
-R 159b8b906d14c083582767b8ea344e43
+P c5389d39a90047683e80ae9081d5d10aaa95da00dfc8a133b4a1a6949a11620d
+R 54316963f5f6d26ad35729ed06088c2e
 U stephan
-Z a561785360eeb191a2906420651521c2
+Z e2fe9fb1c41d92d4fc9e1c534eca8ef3
 # Remove this line to create a well-formed Fossil manifest.
index 80e093e1e3d58a922018d59f88c7321f245abc55..a80268072a65d6fdb172417ab0944f8b6c8fc104 100644 (file)
@@ -1 +1 @@
-c5389d39a90047683e80ae9081d5d10aaa95da00dfc8a133b4a1a6949a11620d
+bb5656bdc905947df205432e108ca6724393061a27028e23bf35b4bf48505d4f