changeset 15133:f91eac1bc66d

m4/acinclude.m4: Correct typos, use consistent style for describing macros. * m4/acinclude.m4: Correct typos, use consistent style for describing macros.
author Rik <rik@octave.org>
date Wed, 08 Aug 2012 21:51:23 -0700
parents 3e5b00d964ad
children edae65062740
files m4/acinclude.m4
diffstat 1 files changed, 55 insertions(+), 75 deletions(-) [+]
line wrap: on
line diff
--- a/m4/acinclude.m4	Wed Aug 08 15:33:52 2012 -0700
+++ b/m4/acinclude.m4	Wed Aug 08 21:51:23 2012 -0700
@@ -39,7 +39,6 @@
 dnl
 dnl Figure out the hardware-vendor-os info.
 dnl
-dnl OCTAVE_HOST_TYPE
 AC_DEFUN([OCTAVE_HOST_TYPE],
 [AC_CANONICAL_HOST
 if test -z "$host"; then
@@ -54,7 +53,6 @@
 dnl
 dnl Set default value for a variable and substitute it.
 dnl
-dnl OCTAVE_SET_DEFAULT
 AC_DEFUN([OCTAVE_SET_DEFAULT],
 [ifelse($#, 2, [: ${$1=$2}
 ])dnl
@@ -75,7 +73,7 @@
 AC_SUBST(ARFLAGS)
 ])
 dnl
-dnl See if the compiler supports placement delete
+dnl Check if the compiler supports placement delete.
 dnl
 AC_DEFUN([OCTAVE_PLACEMENT_DELETE],
 [AC_CACHE_CHECK([whether <new> defines placement delete operator],
@@ -90,7 +88,7 @@
 AC_LANG_POP(C++)
 ])
 dnl
-dnl See if the compiler dynamic auto arrays
+dnl Check if the compiler dynamic auto arrays.
 dnl
 AC_DEFUN([OCTAVE_DYNAMIC_AUTO_ARRAYS],
 [AC_CACHE_CHECK([whether C++ supports dynamic auto arrays],
@@ -105,11 +103,11 @@
 AC_LANG_POP(C++)
 ])
 dnl
-dnl See if the C++ library has the bit_and, bit_or and bit_xor
+dnl Check if the C++ library has the bit_and, bit_or, and bit_xor
 dnl templates defined.
 dnl
 AC_DEFUN([OCTAVE_CXX_BITWISE_OP_TEMPLATES],
-[AC_CACHE_CHECK([whether bit_and, bit_or and bit_xor are defined in the c++ library],
+[AC_CACHE_CHECK([whether bit_and, bit_or, bit_xor are defined in the C++ library],
 octave_cv_cxx_bitwise_op_templates,
 [AC_LANG_PUSH(C++)
 AC_COMPILE_IFELSE([AC_LANG_PROGRAM([[#include <functional>]],
@@ -126,7 +124,7 @@
 ])
 
 dnl
-dnl See if the C++ library has functions to set real and imaginary
+dnl Check if the C++ library has functions to set real and imaginary
 dnl parts of complex numbers independently.
 dnl
 AC_DEFUN([OCTAVE_CXX_COMPLEX_SETTERS],
@@ -142,7 +140,7 @@
 AC_LANG_POP(C++)
 ])
 dnl
-dnl See if the C++ library has functions to access real and imaginary
+dnl Check if the C++ library has functions to access real and imaginary
 dnl parts of complex numbers independently via references.
 dnl
 AC_DEFUN([OCTAVE_CXX_COMPLEX_REFERENCE_ACCESSORS],
@@ -158,7 +156,7 @@
 AC_LANG_POP(C++)
 ])
 dnl
-dnl See if the Carbon Framework defines CGDisplayBitsPerPixel.
+dnl Check if the Carbon Framework defines CGDisplayBitsPerPixel.
 dnl
 AC_DEFUN([OCTAVE_CARBON_CGDISPLAYBITSPERPIXEL],
 [AC_CACHE_CHECK([whether CGDisplayBitsPerPixel is defined in the Carbon Framework],
@@ -177,7 +175,7 @@
 AC_LANG_POP(C++)
 ])
 dnl
-dnl The following test is from Karl Berry's Kpathseach library.  I'm
+dnl The following test is from Karl Berry's Kpathsearch library.  I'm
 dnl including it here in case we someday want to make the use of
 dnl kpathsea optional.
 dnl
@@ -185,6 +183,7 @@
 dnl This test program is due to Mike Hibler <mike@cs.utah.edu>.
 dnl We don't actually need to run this if we don't have putenv, but it
 dnl doesn't hurt.
+dnl 
 AC_DEFUN([OCTAVE_SMART_PUTENV],
 [AC_MSG_CHECKING([whether putenv uses malloc])
 AC_CACHE_VAL(octave_cv_func_putenv_malloc,
@@ -244,10 +243,9 @@
   AC_DEFINE(SMART_PUTENV,1,[To quiet autoheader.])
 fi])
 dnl
-dnl Check to see if C++ compiler needs the new friend template declaration 
+dnl Check if C++ compiler needs the new friend template declaration
 dnl syntax. 
 dnl
-dnl OCTAVE_CXX_NEW_FRIEND_TEMPLATE_DECL
 AC_DEFUN([OCTAVE_CXX_NEW_FRIEND_TEMPLATE_DECL], [
   AC_REQUIRE([AC_PROG_CXX])
   AC_MSG_CHECKING([for C++ support for new friend template declaration])
@@ -279,12 +277,10 @@
   fi
 ])
 dnl
-dnl Check to see if C compiler handles FLAG command line option.  If
-dnl two arguments are specified, execute the second arg as shell
-dnl commands.  Otherwise, add FLAG to CFLAGS if the compiler accepts
-dnl the flag.
+dnl Check if C compiler handles FLAG command line option.  If two
+dnl arguments are specified, execute the second arg as shell commands.
+dnl Otherwise, add FLAG to CFLAGS if the compiler accepts the flag.
 dnl
-dnl OCTAVE_CC_FLAG
 AC_DEFUN([OCTAVE_CC_FLAG], [
   ac_safe=`echo "$1" | sed 'y% ./+-:=%___p___%'`
   AC_MSG_CHECKING([whether ${CC-cc} accepts $1])
@@ -309,12 +305,10 @@
   fi
 ])
 dnl
-dnl Check to see if C++ compiler handles FLAG command line option.  If
-dnl two arguments are specified, execute the second arg as shell
-dnl commands.  Otherwise, add FLAG to CXXFLAGS if the compiler accepts
-dnl the flag.
+dnl Check if C++ compiler handles FLAG command line option.  If two
+dnl arguments are specified, execute the second arg as shell commands.
+dnl Otherwise, add FLAG to CXXFLAGS if the compiler accepts the flag.
 dnl
-dnl OCTAVE_CXX_FLAG
 AC_DEFUN([OCTAVE_CXX_FLAG], [
   ac_safe=`echo "$1" | sed 'y%./+-:=%__p___%'`
   AC_MSG_CHECKING([whether ${CXX-g++} accepts $1])
@@ -339,12 +333,11 @@
   fi
 ])
 dnl
-dnl Check to see if Fortran compiler handles FLAG command line option.  If
+dnl Check if Fortran compiler handles FLAG command line option.  If
 dnl two arguments are specified, execute the second arg as shell
 dnl commands.  Otherwise, add FLAG to FFLAGS if the compiler accepts
 dnl the flag.
 dnl
-dnl OCTAVE_F77_FLAG
 AC_DEFUN([OCTAVE_F77_FLAG], [
   ac_safe=`echo "$1" | sed 'y%./+-:=%__p___%'`
   AC_MSG_CHECKING([whether ${F77-g77} accepts $1])
@@ -369,7 +362,7 @@
   fi
 ])
 dnl
-dnl Check to see whether Fortran compiler has the intrinsic function ISNAN.
+dnl Check if Fortran compiler has the intrinsic function ISNAN.
 dnl
 AC_DEFUN([OCTAVE_CHECK_FORTRAN_HAVE_ISNAN], [
   AC_LANG_PUSH(Fortran 77)
@@ -391,7 +384,7 @@
   AC_LANG_POP(Fortran 77)      
 ])
 dnl
-dnl Check to see whether the default Fortran INTEGER is 64 bits wide.
+dnl Check if the default Fortran INTEGER is 64 bits wide.
 dnl
 AC_DEFUN([OCTAVE_CHECK_FORTRAN_INTEGER_SIZE], [
   octave_fintsize_save_FFLAGS="$FFLAGS"
@@ -445,16 +438,14 @@
   FFLAGS="$octave_fintsize_save_FFLAGS"
 ])
 dnl
-dnl
-dnl Adds warnings to final summary
+dnl Add warning to final summary.
 dnl
 AC_DEFUN([OCTAVE_CONFIGURE_WARNING], [
   AC_MSG_WARN([$][$1])
   m4_set_add([summary_warning_list], [$1])
 ])
 dnl
-dnl
-dnl Prints final summary
+dnl Print final summary.
 dnl
 AC_DEFUN([OCTAVE_CONFIGURE_WARNING_SUMMARY], [
   m4_set_foreach([summary_warning_list], [elt], [
@@ -464,10 +455,9 @@
     fi])
 ])
 dnl
-dnl
-dnl
 dnl OCTAVE_CHECK_LIBRARY(LIBRARY, DOC-NAME, WARN-MSG, HEADER, FUNC,
 dnl                      LANG, DOC-STRING, EXTRA-CHECK)
+dnl
 AC_DEFUN([OCTAVE_CHECK_LIBRARY], [
   AC_ARG_WITH([$1-includedir],
     [AS_HELP_STRING([--with-$1-includedir=DIR],
@@ -545,7 +535,7 @@
   fi
 ])
 dnl
-dnl Check for flex
+dnl Check for flex.
 dnl
 AC_DEFUN([OCTAVE_PROG_FLEX], [
 ### For now, don't define LEXLIB to be -lfl -- we don't use anything in
@@ -573,7 +563,7 @@
   AC_SUBST(LFLAGS)
 ])
 dnl
-dnl Check for bison
+dnl Check for bison.
 dnl
 AC_DEFUN([OCTAVE_PROG_BISON], [
   AC_PROG_YACC
@@ -617,7 +607,7 @@
 fi
 ])
 dnl
-dnl Does gnuplot exist?
+dnl Check for gnuplot.
 dnl
 AC_DEFUN([OCTAVE_PROG_GNUPLOT], [
 gp_names="gnuplot"
@@ -631,7 +621,7 @@
     GNUPLOT="$gp_default"
     warn_gnuplot="
 
-gnuplot not found. It isn't necessary to have gnuplot installed, but
+gnuplot not found.  It isn't necessary to have gnuplot installed, but
 without native graphics or gnuplot you won't be able to use any of
 Octave's plotting commands.
 "
@@ -641,9 +631,8 @@
 AC_SUBST(GNUPLOT)
 ])
 dnl
-dnl Is gperf installed?
+dnl Check for gperf.
 dnl
-dnl OCTAVE_PROG_GPERF
 AC_DEFUN([OCTAVE_PROG_GPERF], [
   AC_CHECK_PROG(GPERF, gperf, gperf, [])
   if test -z "$GPERF"; then
@@ -658,9 +647,8 @@
   AC_SUBST(GPERF)
 ])
 dnl
-dnl Is ghostscript installed?
+dnl Check for ghostscript.
 dnl
-dnl OCTAVE_PROG_GHOSTSCRIPT
 AC_DEFUN([OCTAVE_PROG_GHOSTSCRIPT], [
   case "$canonical_host_type" in
     *-*-mingw* | *-*-msdosmsvc)
@@ -685,9 +673,8 @@
   AC_SUBST(GHOSTSCRIPT)
 ])
 dnl
-dnl Find makeinfo required for reading documentation
+dnl Check for makeinfo.
 dnl
-dnl OCTAVE_PROG_MAKEINFO
 AC_DEFUN([OCTAVE_PROG_MAKEINFO],
 dnl use MKINFO, not MAKEINFO, for variable name because Automake automatically
 dnl defines a value for MAKEINFO even when it does not exist which will then
@@ -698,9 +685,8 @@
    fi
 ])
 dnl
-dnl Is texi2dvi installed?
+dnl Check for texi2dvi.
 dnl
-dnl OCTAVE_PROG_TEXI2DVI
 AC_DEFUN([OCTAVE_PROG_TEXI2DVI], [
   AC_CHECK_PROG(TEXI2DVI, texi2dvi, texi2dvi, [])
   if test -z "$TEXI2DVI"; then
@@ -715,9 +701,8 @@
   AC_SUBST(TEXI2DVI)
 ])
 dnl
-dnl Is texi2pdf installed?
+dnl Check for texi2pdf.
 dnl
-dnl OCTAVE_PROG_TEXI2PDF
 AC_DEFUN([OCTAVE_PROG_TEXI2PDF], [
   AC_REQUIRE([OCTAVE_PROG_TEXI2DVI])
   AC_CHECK_PROG(TEXI2PDF, texi2pdf, texi2pdf, [])
@@ -742,10 +727,9 @@
   AC_SUBST(TEXI2PDF)
 ])
 dnl
-dnl See if the C++ library is ISO compliant.
+dnl Check if the C++ library is ISO compliant.
 dnl FIXME: This is obviously very simplistic, and trivially fooled.
 dnl
-dnl OCTAVE_CXX_ISO_COMPLIANT_LIBRARY
 AC_DEFUN([OCTAVE_CXX_ISO_COMPLIANT_LIBRARY], [
   AC_REQUIRE([AC_PROG_CXX])
   AC_MSG_CHECKING([if C++ library is ISO compliant])
@@ -806,9 +790,7 @@
   AC_SUBST(READLINE_LIBS)
 ])
 dnl
-dnl Check to see if C++ reintrepret cast works for function pointers.
-dnl
-dnl OCTAVE_CXX_BROKEN_REINTERPRET_CAST
+dnl Check if C++ reinterpret cast works for function pointers.
 dnl
 AC_DEFUN([OCTAVE_CXX_BROKEN_REINTERPRET_CAST], [
   AC_REQUIRE([AC_PROG_CXX])
@@ -827,7 +809,7 @@
 fi
   AC_LANG_POP(C++)])
 dnl
-dnl Find find.
+dnl Find find program.
 dnl
 # Prefer GNU find if found.
 AN_MAKEVAR([FIND],  [OCTAVE_PROG_FIND])
@@ -836,7 +818,7 @@
 AC_DEFUN([OCTAVE_PROG_FIND],
 [AC_CHECK_PROGS(FIND, gfind find, )])
 dnl
-dnl Find sed.
+dnl Find sed program.
 dnl
 # Check for a fully-functional sed program, that truncates
 # as few characters as possible and that supports "\(X\|Y\)"
@@ -902,25 +884,22 @@
 AC_MSG_RESULT([$SED])
 ])
 dnl
-dnl Find Perl.
+dnl Find Perl program.
 dnl
-dnl OCTAVE_PROG_PERL
 AC_DEFUN([OCTAVE_PROG_PERL],
 [AC_CHECK_PROG(PERL, perl, perl, [])
   AC_SUBST(PERL)
 ])
 dnl
-dnl Find Python.
+dnl Find Python program.
 dnl
-dnl OCTAVE_PROG_PYTHON
 AC_DEFUN([OCTAVE_PROG_PYTHON],
 [AC_CHECK_PROG(PYTHON, python, python, [])
   AC_SUBST(PYTHON)
 ])
 dnl
-dnl Find desktop-file-install.
+dnl Find desktop-file-install program.
 dnl
-dnl OCTAVE_PROG_DESKTOP_FILE_INSTALL
 AC_DEFUN([OCTAVE_PROG_DESKTOP_FILE_INSTALL],
 [AC_CHECK_PROG(DESKTOP_FILE_INSTALL, desktop-file-install, desktop-file-install, [])
   AC_SUBST(DESKTOP_FILE_INSTALL)
@@ -962,7 +941,7 @@
 fi
 ])
 dnl
-dnl Check for UMFPACK seperately split complex matrix and RHS. Note
+dnl Check for UMFPACK separately split complex matrix and RHS.  Note
 dnl that as umfpack.h can be in three different places, rather than
 dnl include it, just declare the functions needed.
 dnl
@@ -1018,9 +997,9 @@
 fi
 ])
 dnl
-dnl Check whether using HDF5 DLL under Windows. This is done by
+dnl Check whether using HDF5 DLL under Windows.  This is done by
 dnl testing for a data symbol in the HDF5 library, which would
-dnl requires the definition of _HDF5USEDL_ under MSVC compiler.
+dnl require the definition of _HDF5USEDL_ under MSVC compiler.
 dnl
 AC_DEFUN([OCTAVE_HDF5_DLL], [
   AC_CACHE_CHECK([if _HDF5USEDLL_ needs to be defined],octave_cv_hdf5_dll, [
@@ -1098,7 +1077,7 @@
   fi
 ])
 dnl
-dnl Check whether Qhull works (does not crash)
+dnl Check whether Qhull works (does not crash).
 dnl
 AC_DEFUN([OCTAVE_CHECK_QHULL_OK],
   [AC_CACHE_CHECK([whether the qhull library works],
@@ -1152,11 +1131,11 @@
   fi
 ])
 dnl
-dnl Check whether ARPACK works (does not crash)
+dnl Check whether ARPACK works (does not crash).
 dnl
 dnl Using a pure Fortran program doesn't seem to crash when linked
-dnl with the buggy ARPACK library but the C++ program does.  Maybe
-dnl it is the memory allocation that exposes the bug and using statically
+dnl with the buggy ARPACK library but the C++ program does.  Maybe it
+dnl is the memory allocation that exposes the bug and using statically
 dnl allocated arrays in Fortran does not?
 dnl
 AC_DEFUN([OCTAVE_CHECK_ARPACK_OK], [
@@ -1302,7 +1281,7 @@
   fi
 ])
 dnl
-dnl Check for OpenGL.  If found, define OPENGL_LIBS
+dnl Check for OpenGL.  If found, define OPENGL_LIBS.
 dnl
 dnl FIXME: The following tests should probably check for the
 dnl libraries separately.
@@ -1377,9 +1356,8 @@
 AC_SUBST(OPENGL_LIBS)
 ])
 dnl
-dnl See if function gluTessCallback is called with "(...)"
+dnl Check if function gluTessCallback is called with "(...)".
 dnl
-dnl OCTAVE_GLUTESSCALLBACK_THREEDOTS
 AC_DEFUN([OCTAVE_GLUTESSCALLBACK_THREEDOTS],
 [AC_CACHE_CHECK([whether gluTessCallback is called with "(...)"],
 octave_cv_glutesscallback_threedots,
@@ -1399,9 +1377,9 @@
 fi
 ])
 dnl
-dnl Check for support of OpenMP with a given compiler flag. If
-dnl found define HAVE_OPENMP and add the compile flag to CFLAGS
-dnl and CXXFLAGS.
+dnl Check for support of OpenMP with a given compiler flag.
+dnl If found define HAVE_OPENMP and add the compile flag
+dnl to CFLAGS and CXXFLAGS.
 dnl
 AC_DEFUN([OCTAVE_CHECK_OPENMP],
 [AC_MSG_CHECKING([for support of OpenMP])
@@ -1622,11 +1600,13 @@
    AC_SUBST([FT2_LIBS])])
 dnl end of freetype2.m4
 
+dnl
 dnl Check whether a math mapper function is available in <cmath>.
 dnl Will define HAVE_CMATH_FUNC if there is a double variant and
 dnl HAVE_CMATH_FUNCF if there is a float variant.
 dnl Currently capable of checking for functions with single 
 dnl argument and returning bool/int/real.
+dnl
 AC_DEFUN([OCTAVE_CMATH_FUNC],[
 AC_MSG_CHECKING([for std::$1 in <cmath>])
 AC_LANG_PUSH(C++)
@@ -1658,6 +1638,7 @@
 AC_LANG_POP(C++)
 ])
 
+dnl
 dnl Check whether fast signed integer arithmetics using bit tricks
 dnl can be used in oct-inttypes.h.  Defines HAVE_FAST_INT_OPS if
 dnl the following conditions hold:
@@ -1669,7 +1650,7 @@
 dnl    (We use casts to prevent optimization interference, so there is no
 dnl     need for things like -ftrapv).
 dnl 4. Bit operations on signed integers work like on unsigned integers,
-dnl    except for the shifts. Shifts are arithmetic.
+dnl    except for the shifts.  Shifts are arithmetic.
 dnl
 AC_DEFUN([OCTAVE_FAST_INT_OPS],
 [AC_CACHE_CHECK([whether fast integer arithmetics is usable],
@@ -1735,7 +1716,6 @@
 dnl "--without-framework-$1".  If this test is successful then perform
 dnl $4, otherwise do $5.
 dnl
-dnl OCTAVE_HAVE_FRAMEWORK
 AC_DEFUN([OCTAVE_HAVE_FRAMEWORK], [
   AC_MSG_CHECKING([whether ${LD-ld} accepts -framework $1])
   AC_CACHE_VAL(octave_cv_framework_$1, [
@@ -1928,7 +1908,7 @@
 ])# PKG_CHECK_MODULES
 
 dnl
-dnl External macros.
+dnl Include external macros.
 dnl
 
 m4_include([m4/ax_pthread.m4])