1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-06-11 14:21:10 +02:00

Rewrite comments in texi.

(GUILE_FLAGS): Rewrite.
Thanks to Alexandre Duret-Lutz.
This commit is contained in:
Thien-Thi Nguyen 2002-01-02 23:50:38 +00:00
parent f00eb43f8d
commit 8c4b7ca35f

View file

@ -57,15 +57,19 @@
## Code ## Code
## ---- ## ----
## NOTE: Comments preceding an AC_DEFUN (starting from "Usage:") are massaged
## into doc/ref/autoconf-macros.texi (see Makefile.am in that directory).
# GUILE_PROGS -- set paths to Guile interpreter, config and tool programs # GUILE_PROGS -- set paths to Guile interpreter, config and tool programs
# #
# Usage: GUILE_PROGS # Usage: GUILE_PROGS
# #
# This macro looks for programs `guile', `guile-config' and `guile-tools', # This macro looks for programs @code{guile}, @code{guile-config} and
# and sets variables GUILE, GUILE_CONFIG and GUILE_TOOLS, to their paths, # @code{guile-tools}, and sets variables @var{GUILE}, @var{GUILE_CONFIG} and
# respectively. If either of the first two are not found, signal error. # @var{GUILE_TOOLS}, to their paths, respectively. If either of the first two
# are not found, signal error.
# #
# The variables are marked for substitution, as by AC_SUBST. # The variables are marked for substitution, as by @code{AC_SUBST}.
# #
AC_DEFUN([GUILE_PROGS], AC_DEFUN([GUILE_PROGS],
[AC_PATH_PROG(GUILE,guile) [AC_PATH_PROG(GUILE,guile)
@ -86,45 +90,42 @@ AC_DEFUN([GUILE_PROGS],
# #
# Usage: GUILE_FLAGS # Usage: GUILE_FLAGS
# #
# This macro runs the `guile-config' script, installed with Guile, # This macro runs the @code{guile-config} script, installed with Guile, to
# to find out where Guile's header files and libraries are # find out where Guile's header files and libraries are installed. It sets
# installed. It sets two variables, GUILE_CFLAGS and GUILE_LDFLAGS. # two variables, @var{GUILE_CFLAGS} and @var{GUILE_LDFLAGS}.
# #
# GUILE_CFLAGS: flags to pass to a C or C++ compiler to build code that # @var{GUILE_CFLAGS}: flags to pass to a C or C++ compiler to build code that
# uses Guile header files. This is almost always just a -I flag. # uses Guile header files. This is almost always just a @code{-I} flag.
# #
# GUILE_LDFLAGS: flags to pass to the linker to link a program against # @var{GUILE_LDFLAGS}: flags to pass to the linker to link a program against
# Guile. This includes `-lguile' for the Guile library itself, any # Guile. This includes @code{-lguile} for the Guile library itself, any
# libraries that Guile itself requires (like -lqthreads), and so on. It # libraries that Guile itself requires (like -lqthreads), and so on. It may
# may also include a -L flag to tell the compiler where to find the # also include a @code{-L} flag to tell the compiler where to find the
# libraries. # libraries.
# #
# The variables are marked for substitution, as by AC_SUBST. # The variables are marked for substitution, as by @code{AC_SUBST}.
# #
AC_DEFUN([GUILE_FLAGS],[ AC_DEFUN([GUILE_FLAGS],
## The GUILE_FLAGS macro. [AC_REQUIRE([GUILE_PROGS])dnl
## First, let's just see if we can find Guile at all. AC_MSG_CHECKING([libguile compile flags])
AC_MSG_CHECKING(for Guile) GUILE_CFLAGS="`$GUILE_CONFIG compile`"
guile-config link > /dev/null || { AC_MSG_RESULT([$GUILE_CFLAGS])
echo "configure: cannot find guile-config; is Guile installed?" 1>&2 AC_MSG_CHECKING([libguile link flags])
exit 1 GUILE_LDFLAGS="`$GUILE_CONFIG link`"
} AC_MSG_RESULT([$GUILE_LDFLAGS])
GUILE_CFLAGS="`guile-config compile`"
GUILE_LDFLAGS="`guile-config link`"
AC_SUBST(GUILE_CFLAGS) AC_SUBST(GUILE_CFLAGS)
AC_SUBST(GUILE_LDFLAGS) AC_SUBST(GUILE_LDFLAGS)
AC_MSG_RESULT(yes) ])
])
# GUILE_SITE_DIR -- find path to Guile "site" directory # GUILE_SITE_DIR -- find path to Guile "site" directory
# #
# Usage: GUILE_SITE_DIR # Usage: GUILE_SITE_DIR
# #
# This looks for Guile's "site" directory, usually something like # This looks for Guile's "site" directory, usually something like
# PREFIX/share/guile/site, and sets var GUILE_SITE to the path. # PREFIX/share/guile/site, and sets var @var{GUILE_SITE} to the path.
# Note that the var name is different from the macro name. # Note that the var name is different from the macro name.
# #
# The variable is marked for substitution, as by AC_SUBST. # The variable is marked for substitution, as by @code{AC_SUBST}.
# #
AC_DEFUN([GUILE_SITE_DIR], AC_DEFUN([GUILE_SITE_DIR],
[AC_REQUIRE([GUILE_PROGS])dnl [AC_REQUIRE([GUILE_PROGS])dnl
@ -138,8 +139,8 @@ AC_DEFUN([GUILE_SITE_DIR],
# #
# Usage: GUILE_CHECK_RETVAL(var,check) # Usage: GUILE_CHECK_RETVAL(var,check)
# #
# $1 is a shell variable name to be set to the return value # @var{var} is a shell variable name to be set to the return value.
# $2 is a Guile Scheme expression, evaluated with "$GUILE -c", and # @var{check} is a Guile Scheme expression, evaluated with "$GUILE -c", and
# returning either 0 or non-#f to indicate the check passed. # returning either 0 or non-#f to indicate the check passed.
# Non-0 number or #f indicates failure. # Non-0 number or #f indicates failure.
# Avoid using the character "#" since that confuses autoconf. # Avoid using the character "#" since that confuses autoconf.
@ -154,10 +155,10 @@ AC_DEFUN([GUILE_CHECK],
# #
# Usage: GUILE_MODULE_CHECK(var,module,featuretest,description) # Usage: GUILE_MODULE_CHECK(var,module,featuretest,description)
# #
# $1 is a shell variable name to be set to "yes" or "no" # @var{var} is a shell variable name to be set to "yes" or "no".
# $2 is a list of symbols, like: (ice-9 common-list) # @var{module} is a list of symbols, like: (ice-9 common-list).
# $3 is an expression acceptable to GUILE_CHECK, q.v. # @var{featuretest} is an expression acceptable to GUILE_CHECK, q.v.
# $4 is a present-tense verb phrase (passed to AC_MSG_CHECKING) # @var{description} is a present-tense verb phrase (passed to AC_MSG_CHECKING).
# #
AC_DEFUN([GUILE_MODULE_CHECK], AC_DEFUN([GUILE_MODULE_CHECK],
[AC_MSG_CHECKING([if $2 $4]) [AC_MSG_CHECKING([if $2 $4])
@ -170,8 +171,8 @@ AC_DEFUN([GUILE_MODULE_CHECK],
# #
# Usage: GUILE_MODULE_AVAILABLE(var,module) # Usage: GUILE_MODULE_AVAILABLE(var,module)
# #
# $1 is a shell variable name to be set to "yes" or "no" # @var{var} is a shell variable name to be set to "yes" or "no".
# $2 is a list of symbols, like: (ice-9 common-list) # @var{module} is a list of symbols, like: (ice-9 common-list).
# #
AC_DEFUN([GUILE_MODULE_AVAILABLE], AC_DEFUN([GUILE_MODULE_AVAILABLE],
[GUILE_MODULE_CHECK($1,$2,0,is available) [GUILE_MODULE_CHECK($1,$2,0,is available)
@ -181,7 +182,8 @@ AC_DEFUN([GUILE_MODULE_AVAILABLE],
# #
# Usage: GUILE_MODULE_REQUIRED(symlist) # Usage: GUILE_MODULE_REQUIRED(symlist)
# #
# $1 is a list of symbols, WITHOUT surrounding parens, like: ice-9 common-list # @var{symlist} is a list of symbols, WITHOUT surrounding parens,
# like: ice-9 common-list.
# #
AC_DEFUN([GUILE_MODULE_REQUIRED], AC_DEFUN([GUILE_MODULE_REQUIRED],
[GUILE_MODULE_AVAILABLE(ac_guile_module_required, ($1)) [GUILE_MODULE_AVAILABLE(ac_guile_module_required, ($1))
@ -194,9 +196,9 @@ AC_DEFUN([GUILE_MODULE_REQUIRED],
# #
# Usage: GUILE_MODULE_EXPORTS(var,module,modvar) # Usage: GUILE_MODULE_EXPORTS(var,module,modvar)
# #
# $1 is a shell variable to be set to "yes" or "no" # @var{var} is a shell variable to be set to "yes" or "no".
# $2 is a list of symbols, like: (ice-9 common-list) # @var{module} is a list of symbols, like: (ice-9 common-list).
# $3 is the Guile Scheme variable to check # @var{modvar} is the Guile Scheme variable to check.
# #
AC_DEFUN([GUILE_MODULE_EXPORTS], AC_DEFUN([GUILE_MODULE_EXPORTS],
[GUILE_MODULE_CHECK($1,$2,$3,exports `$3') [GUILE_MODULE_CHECK($1,$2,$3,exports `$3')
@ -206,8 +208,8 @@ AC_DEFUN([GUILE_MODULE_EXPORTS],
# #
# Usage: GUILE_MODULE_REQUIRED_EXPORT(module,modvar) # Usage: GUILE_MODULE_REQUIRED_EXPORT(module,modvar)
# #
# $1 is a list of symbols, like: (ice-9 common-list) # @var{module} is a list of symbols, like: (ice-9 common-list).
# $2 is the Guile Scheme variable to check # @var{modvar} is the Guile Scheme variable to check.
# #
AC_DEFUN([GUILE_MODULE_REQUIRED_EXPORT], AC_DEFUN([GUILE_MODULE_REQUIRED_EXPORT],
[GUILE_MODULE_EXPORTS(guile_module_required_export,$1,$2) [GUILE_MODULE_EXPORTS(guile_module_required_export,$1,$2)