From d824b5f901bdad36d61122bd82adb79a1f0c33fe Mon Sep 17 00:00:00 2001 From: Nathan Bird Date: Tue, 2 Mar 2010 16:57:17 -0500 Subject: [PATCH] Finishing doc for file-enable-sql-reader-syntax, adding warnings to docs on other enable methods, tip at the top of the syntax page. --- doc/ref-syntax.xml | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/doc/ref-syntax.xml b/doc/ref-syntax.xml index dd0dd0e..e0364fa 100644 --- a/doc/ref-syntax.xml +++ b/doc/ref-syntax.xml @@ -16,6 +16,12 @@ utilities for enabling and disabling the square bracket reader syntax and for constructing symbolic SQL expressions. + + Tip: just want it on + + file-enable-sql-reader-syntax at the top of each file is easiest. + + @@ -57,6 +63,12 @@ Modifies the default readtable. + + + &clsql; tries to keep track of whether the syntax has already been enabled. This can be problematic if the syntax is somehow disabled externally to &clsql; as future attempts to enable the syntax will do nothing--the system thinks it is already enabled. This may happen if there is an enable, but no disable, in a file that is processed with load or compile-file as the lisp implementation will restore the readtable on completion. Or, even if there is a disable but a compiler-error is encountered before running the disable. If you encounter this try running disable-sql-reader-syntax a couple times in the REPL. + + See file-enable-sql-reader-syntax for an alternative. + Affected by @@ -77,6 +89,7 @@ locally-enable-sql-reader-syntax locally-disable-sql-reader-syntax restore-sql-reader-syntax-state + file-enable-sql-reader-syntax @@ -151,6 +164,7 @@ locally-enable-sql-reader-syntax locally-disable-sql-reader-syntax restore-sql-reader-syntax-state + file-enable-sql-reader-syntax @@ -172,7 +186,7 @@ LOCALLY-ENABLE-SQL-READER-SYNTAX - Globally enable square bracket reader syntax. + Locally enable square bracket reader syntax. Macro @@ -210,6 +224,12 @@ Modifies the default readtable. + + + &clsql; tries to keep track of whether the syntax has already been enabled. This can be problematic if the syntax is somehow disabled externally to &clsql; as future attempts to enable the syntax will do nothing--the system thinks it is already enabled. This may happen if there is an enable, but no disable, in a file that is processed with load or compile-file as the lisp implementation will restore the readtable on completion. Or, even if there is a disable but a compiler-error is encountered before running the disable. If you encounter this try running disable-sql-reader-syntax a couple times in the REPL. + + See file-enable-sql-reader-syntax for an alternative. + Affected by @@ -228,6 +248,7 @@ disable-sql-reader-syntax locally-disable-sql-reader-syntax restore-sql-reader-syntax-state + file-enable-sql-reader-syntax @@ -310,6 +331,7 @@ disable-sql-reader-syntax locally-enable-sql-reader-syntax restore-sql-reader-syntax-state + file-enable-sql-reader-syntax @@ -394,6 +416,7 @@ disable-sql-reader-syntax locally-enable-sql-reader-syntax locally-disable-sql-reader-syntax + file-enable-sql-reader-syntax @@ -438,7 +461,7 @@ disable-sql-reader-syntax which try to keep track of whether the syntax has been enabled or disabled and keep track of the old read-table for restoration this function just enables it unconditionally. - Once enabled this way there is no corresponding disable function but instead relies on being used in a file context. The spec for load and compile-file states that the *readtable* will be restored after processing the file. + Once enabled this way there is no corresponding disable function but instead relies on being used in a file context. The spec for load and compile-file states that the *readtable* will be restored after processing the file. Examples @@ -453,7 +476,7 @@ Side Effects - Modifies the readtable. + Modifies the readtable for #\[ and #\] -- 2.34.1