diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 85 |
1 files changed, 79 insertions, 6 deletions
@@ -9,7 +9,7 @@ See end of file for copyright statement. GINT ==== Sergey Poznyakoff <gray@gnu.org> -1, April 5, 2010 +2, May 11, 2010 NAME ---- @@ -273,21 +273,58 @@ Scheme counterpart. By supplying the +snarf-doc-filter+ option, you instruct *GINT* to use Scheme implementation instead. See the section <<doc-snarfing, Doc snarfing>> for a detailed discussion. +[[option-generators]] +By default, the generated +configure+ script always checks for Guile. The +following options modify this behavior: + +with-guile:: +Add a +--with-guile+ option to configure. Do not check for Guile if +configure was called with +--with-guile=no+ (or +--without-guile+). + +without-guile:: +Same as above, except that Guile checks are disabled by default. I.e. the +configure script checks for Guile only if invoked with the +--with-guile+ +option. + +enable-guile:: +Add a +--enable-guile+ option to configure. Do not check for Guile if +configure was called with +--enable-guile=no+ (or +--disable-guile+). + +disable-guile:: +Same as above, except that Guile checks are disabled by default. I.e. the +configure script checks for Guile only if invoked with the +--enable-guile+ +option. + +Only one of these four options may be given to a +GINT_INIT+ invocation. + Here is a more complex example: .+GINT_INIT+ macro ------------------------------------------------------- -GINT_INIT([modules/gint], [1.8 std-site-dir], +GINT_INIT([modules/gint], [1.8 with-guile std-site-dir], [use_guile=yes], [use_guile=no]) ------------------------------------------------------- This fragment initializes the +GINT+ module located in `modules/gint` and -checks for Guile version 1.8 or newer. The resulting script sets -<<sitedir,sitedir>> to the standard Guile site directory. The -shell variable `use_guile` is set to `yes` or `no`, depending on -whether Guile was found or not. +checks for Guile version 1.8 or newer. The resulting script understands +the +--with-guile+ option and sets <<sitedir,sitedir>> to the standard Guile +site directory. The shell variable `use_guile` is set to `yes` or `no`, +depending on whether Guile was found or not. + +Notice, that you may not use this macro within a shell conditional, or +within any +Autoconf+ macro that generates such a conditional. In particular, +the following invocation is wrong: + +.*Wrong usage* +----------------------------------------- +AC_ARG_WITH([guile], + [GINT_INIT([modules/gint])]) +----------------------------------------- + +Instead, use one of the <<option-generators, option generating>> options, +described above. [[gint-subst-vars]] Substitution Variables @@ -295,10 +332,12 @@ Substitution Variables Upon successful return, +GINT_INIT+ sets the following Automake substitution variables: +[[GUILE_VERSION]] GUILE_VERSION:: The version of Guile, as a string, e.g. `1.9.9`. Additionally, a _C_ preprocessor macro with the same name is defined. +[[GUILE_VERSION_NUMBER]] GUILE_VERSION_NUMBER:: The version of Guile packed into a decimal number using the following formula: + @@ -330,6 +369,40 @@ The full pathname of the `guile-tools` binary. GUILE_SITE:: The full pathname of the Guile site-wide module directory. +[[gint-shell-vars]] +Shell Variables +--------------- +The +GINT_INIT+ macro sets the following shell variables: + +gint_enable_guile:: +By default, set to `yes`. If an <<option-generators, option generating>> +option was used, this variable is set to `no` if the *Guile* checks were +disabled (either by default or by the user request) and to `yes` otherwise. + +gint_cv_guile:: +Set to `yes` if a sufficiently new version of *Guile* was found, and to +`no` otherwise. + +[[gint_cv_guile_debug]] +gint_cv_guile_debug:: +Set if guile supports the debugging macros (i.e. +SCM_DEVAL_P+, ++SCM_BACKTRACE_P+, +SCM_RECORD_POSITIONS_P+ and SCM_RESET_DEBUG_MODE). + +[[config.h defines]] +Config.h Defines +---------------- +GUILE_DEBUG_MACROS:: +Defined if guile supports the debugging macros (i.e. +SCM_DEVAL_P+, ++SCM_BACKTRACE_P+, +SCM_RECORD_POSITIONS_P+ and SCM_RESET_DEBUG_MODE). +See also the <<gint_cv_guile_debug, +gint_cv_guile_debug+>> variable. + +GUILE_VERSION:: +Same as the <<GUILE_VERSION, +GUILE_VERSION+>> substitution variable. + +GUILE_VERSION_NUMBER:: +Same as the <<GUILE_VERSION_NUMBER, +GUILE_VERSION_NUMBER+>> substitution +variable. + [[doc-snarfing]] Doc Snarfing ~~~~~~~~~~~~ |