Reorder and tidy documentation.

diff --git a/aclocal.glob b/aclocal.glob
index 760229c..9fb8a2b 100644 (file)
--- a/aclocal.glob
+++ b/aclocal.glob
@@ -1,6 +1,6 @@
 dnl -*-fundamental-*-                                    *@--GLOB-HEADER--@*
 dnl
-dnl $Id: aclocal.glob,v 1.3 1999/07/17 10:27:44 mdw Exp $
+dnl $Id: aclocal.glob,v 1.4 1999/07/26 23:44:32 mdw Exp $
 dnl
 dnl Common library of autoconf macros
 dnl
@@ -28,6 +28,9 @@ dnl Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 dnl----- Revision history ---------------------------------------------------
 dnl
 dnl $Log: aclocal.glob,v $
+dnl Revision 1.4  1999/07/26 23:44:32  mdw
+dnl Reorder and tidy documentation.
+dnl
 dnl Revision 1.3  1999/07/17 10:27:44  mdw
 dnl More useful macros added.
 dnl
@@ -40,7 +43,7 @@ dnl
 
 dnl----- Common files distribution --------------------------- *@--NOTICE--@*
 dnl
-dnl $Id: aclocal.glob,v 1.3 1999/07/17 10:27:44 mdw Exp $
+dnl $Id: aclocal.glob,v 1.4 1999/07/26 23:44:32 mdw Exp $
 
 dnl --- *@-AC_PROG_CC_STDC-@* ---
 dnl
@@ -1048,32 +1051,23 @@ AC_DEFUN(AM_SYS_POSIX_TERMIOS,
 
 dnl----- Macros by Mark Wooding ------------------------------ *@--IGNORE--@*
 
-dnl --- *@-mdw_DECL_ENVIRON-@* ---
+dnl --- *@-mdw_REQUIRE-@* ---
 dnl
 dnl Author:    Mark Wooding
 dnl
-dnl Synopsis:  mdw_DECL_ENVIRON
+dnl Synopsis:  mdw_REQUIRE(MACRO, ARGS...)
 dnl
-dnl Arguments: ---
+dnl Arguments: MACRO = name of a macro which should have been called
+dnl            ARGS = arguments to pass
 dnl
-dnl Use:       If the global variable `environ' is declared anywhere
-dnl            `obvious', then define the preprocessor symbol DECL_ENVIRON.
+dnl Use:       Like `AC_REQUIRE', only it handles arguments.
 
-AC_DEFUN(mdw_DECL_ENVIRON,
-[AC_CHECK_HEADERS([unistd.h])
-AC_CACHE_CHECK([for declaration of \`environ'], sw_cv_environ,
-[AC_EGREP_CPP(environ, 
-[#include <sys/types.h>
-#if HAVE_UNISTD_H
-#include <unistd.h>
-#endif
-#if STDC_HEADERS
-#include <stdlib.h>
-#include <stddef.h>
-#endif], [sw_cv_environ=yes], [sw_cv_environ=no])])
-if test $sw_cv_environ = yes; then
-  AC_DEFINE(DECL_ENVIRON)
-fi])
+AC_DEFUN(mdw_REQUIRE,
+[ifdef([AC_PROVIDED_$1], ,
+[AC_DIVERT_PUSH(builtin(eval, AC_DIVERSION_CURRENT - 1))dnl
+indir($@)
+AC_DIVERT_POP()dnl
+])])
 
 dnl --- *@-mdw_CURSES-@* ---
 dnl
@@ -1083,12 +1077,14 @@ dnl Synopsis:   mdw_CURSES
 dnl
 dnl Arguments: ---
 dnl
-dnl Use:       Attempts to find an implementation of `curses'.  A `curses'
-dnl            library (`ncurses' by preference) will be added to `LIBS'.
-dnl            If a library could be found, the preprocessor symbol
-dnl            HAVE_CURSES is defined, along with one of HAVE_NCURSES_H,
-dnl            HAVE_NCURSES_NCURSES_H or HAVE_CURSES_H, suggesting which
-dnl            header to include (in the obvious way).
+dnl Use:       Searches for a `curses' library (one of `ncurses' or
+dnl            `curses') using mdw_CHECK_MANYLIBS.  If one is found, the
+dnl            preprocessor macro HAVE_CURSES is defined, and a search is
+dnl            made for a `curses' header file (one of <ncurses.h>,
+dnl            <ncurses/ncurses.h> or <curses.h>) using AC_CHECK_HEADERS
+dnl            and the appropriate preprocessor symbol is defined.
+dnl            Finally, a check is made for the function `wresize' using
+dnl            AC_CHECK_FUNCS.
 
 AC_DEFUN(mdw_CURSES,
 [mdw_CHECK_MANYLIBS(newwin, ncurses curses, AC_DEFINE(HAVE_CURSES))
@@ -1111,11 +1107,12 @@ dnl Synopsis:   mdw_TYPE_SSIZE_T
 dnl
 dnl Arguments: ---
 dnl
-dnl Use:       Finds an appropriate type for `ssize_t' if there isn't a
-dnl            sensible one to use already.
+dnl Use:       Checks whether the Posix type `ssize_t' is defined.  If not,
+dnl            it defaults to `int'.
 
 AC_DEFUN(mdw_TYPE_SSIZE_T,
-[AC_CACHE_CHECK(for ssize_t, sw_cv_ssize_t,
+[AC_REQUIRE([AC_HEADER_STDC])
+AC_CACHE_CHECK(for ssize_t, mdw_cv_ssize_t,
 [AC_EGREP_CPP(ssize_t,
 [#include <sys/types.h>
 #if HAVE_UNISTD_H
@@ -1125,28 +1122,37 @@ AC_DEFUN(mdw_TYPE_SSIZE_T,
 #include <stdlib.h>
 #include <stddef.h>
 #endif],
-[sw_cv_ssize_t=yes], [sw_cv_ssize_t=no])])
-if test $sw_cv_ssize_t = no; then
+[mdw_cv_ssize_t=yes], [mdw_cv_ssize_t=no])])
+if test $mdw_cv_ssize_t = no; then
   AC_DEFINE(ssize_t, int)
 fi])
 
-dnl --- *@-mdw_REQUIRE-@* ---
+dnl --- *@-mdw-DECL_ENVIRON-@* ---
 dnl
 dnl Author:    Mark Wooding
 dnl
-dnl Synopsis:  mdw_REQUIRE(MACRO, ARGS...)
+dnl Synopsis:  mdw_DECL_ENVIRON
 dnl
-dnl Arguments: MACRO = name of a macro which should have been called
-dnl            ARGS = arguments to pass
+dnl Arguments: ---
 dnl
-dnl Use:       Like `AC_REQUIRE', only it handles arguments.
+dnl Use:       Searches for a declaration of the global `environ' variable.
+dnl            If one is found in one of the `usual' places, DECL_ENVIRON
+dnl            is defined as a preprocessor symbol.
 
-AC_DEFUN(mdw_REQUIRE,
-[ifdef([AC_PROVIDED_$1], ,
-[AC_DIVERT_PUSH(builtin(eval, AC_DIVERSION_CURRENT - 1))dnl
-indir($@)
-AC_DIVERT_POP()dnl
-])])
+AC_DEFUN(mdw_DECL_ENVIRON,
+[AC_CACHE_CHECK([for declaration of \`environ'], mdw_cv_environ,
+[AC_EGREP_CPP(environ, 
+[#include <sys/types.h>
+#if HAVE_UNISTD_H
+#include <unistd.h>
+#endif
+#if STDC_HEADERS
+#include <stdlib.h>
+#include <stddef.h>
+#endif], [mdw_cv_environ=yes], [mdw_cv_environ=no])])
+if test $mdw_cv_environ = yes; then
+  AC_DEFINE(DECL_ENVIRON)
+fi])
 
 dnl --- *@-mdw_CHECK_MANYLIBS-@* ---
 dnl