configure: cosmetic improvements on comments

This patch brings more consistency in the presentation of comments,
including:
 - 2 line spaces between blocks (M4 macro tend to make the file look quite
bulky, so it is making the file more aerated)
 - fixes in the length of underlining
 - adding a few comments on the reason of the check to ease maintainance

Signed-off-by: Christophe CURIS <christophe.curis@free.fr>

configure.ac

@@ -43,7 +43,7 @@ AM_INIT_AUTOMAKE([1.11 silent-rules])
 AH_BOTTOM([#include "config-paths.h"])
 
 dnl libtool library versioning
-dnl =======================
+dnl ==========================
 dnl
 dnl current
 dnl revision
@@ -84,7 +84,7 @@ WUTIL_VERSION=$WUTIL_CURRENT:$WUTIL_REVISION:$WUTIL_AGE
 AC_SUBST(WUTIL_VERSION)
 
 
-dnl Checks for programs.
+dnl Checks for programs
 dnl ===================
 AC_PROG_CC
 WM_PROG_CC_C11
@@ -225,7 +225,8 @@ WM_PROG_CC_NESTEDFUNC
 
 
 dnl Posix thread
-dnl =================
+dnl ============
+dnl they are used by util/wmiv
 AX_PTHREAD
 
 
@@ -312,7 +313,7 @@ AS_IF([test "x$enable_lcov" != "xno"],
 
 AM_CONDITIONAL([USE_LCOV], [test "x$enable_lcov" != "xno"])
 
-dnl
+
 dnl ============================
 dnl Checks for library functions
 dnl ============================
@@ -362,22 +363,27 @@ AS_IF([test "x$ac_cv_search_strlcat" = "x-lbsd" -o "x$ac_cv_search_strlcpy" = "x
 )
 AC_SUBST(LIBBSD)
 
+
 dnl Check for OpenBSD kernel memory interface - kvm(3)
 dnl ==================================================
 AS_IF([test "x$WM_OSDEP" = "xbsd"],
   AC_SEARCH_LIBS([kvm_openfiles], [kvm]) )
 
+
 dnl Check for inotify
 dnl =================
+dnl It is used by WindowMaker to reload automatically the configuration when the
+dnl user changed it using WPref or wdwrite
 AC_CHECK_HEADERS(sys/inotify.h, AC_DEFINE(HAVE_INOTIFY, 1, Check for inotify))
 
 
 dnl Check for syslog 
-dnl =================
+dnl ================
+dnl It is used by WUtil to log the wwarning, werror and wfatal
 AC_CHECK_HEADERS([syslog.h], [AC_DEFINE([HAVE_SYSLOG], [1], [Check for syslog])])
 
 
-dnl Checks for header files.
+dnl Checks for header files
 dnl =======================
 AC_HEADER_SYS_WAIT
 AC_HEADER_TIME
@@ -385,8 +391,8 @@ AC_CHECK_HEADERS(fcntl.h limits.h sys/ioctl.h libintl.h poll.h malloc.h ctype.h
 		 string.h strings.h)
 
 
-dnl Checks for typedefs, structures, and compiler characteristics.
+dnl Checks for typedefs, structures, and compiler characteristics
-dnl ==============================================================
+dnl =============================================================
 AC_C_CONST
 AC_C_INLINE
 WM_C_NORETURN
@@ -399,6 +405,7 @@ dnl pkg-config
 dnl ==========
 AC_CHECK_PROG(PKGCONFIG, pkg-config, pkg-config) 
 
+
 dnl gettext
 dnl =======
 
@@ -521,6 +528,7 @@ AC_SUBST(UTILMOFILES)
 AC_SUBST(WINGSMOFILES)
 AC_SUBST(supported_locales)
 
+
 dnl ===========================================
 dnl 		Stuff that uses X
 dnl ===========================================
@@ -543,6 +551,7 @@ inc_search_path="$inc_search_path $XCFLAGS"
 
 AC_SUBST(X_LIBRARY_PATH)
 
+
 dnl Decide which locale function to use, setlocale() or _Xsetlocale()
 dnl by MANOME Tomonori 
 dnl ===========================================
@@ -556,25 +565,29 @@ if test "$use_locale" = yes; then
 		$XLFLAGS $XLIBS)
 fi
 
+
 dnl Check whether XInternAtoms() exist
 dnl ==================================
 AC_CHECK_LIB(X11, XInternAtoms, 
              AC_DEFINE(HAVE_XINTERNATOMS, 1, [define if your X server has XInternAtoms() (set by configure)]),,
              $XLFLAGS $XLIBS)
 
+
 dnl Check whether XConvertCase() exist
 dnl ==================================
 AC_CHECK_LIB(X11, XConvertCase, 
              AC_DEFINE(HAVE_XCONVERTCASE, 1, [define if your X server has XConvertCase() (set by configure)]),,
              $XLFLAGS $XLIBS)
 
+
 dnl XKB keyboard language status
 dnl ============================
 AC_ARG_ENABLE(modelock, AS_HELP_STRING([--enable-modelock], [XKB keyboard language status support]),
 		AC_DEFINE(XKB_MODELOCK, 1, [whether XKB language MODELOCK should be enabled]))
 
+
 dnl XDND Drag-nd-Drop support
-dnl ============================
+dnl =========================
 AC_ARG_ENABLE([xdnd],
     [AS_HELP_STRING([--disable-xdnd], [disable Drag-nd-Drop support])],
     [AS_CASE(["$enableval"],
@@ -585,6 +598,7 @@ AC_ARG_ENABLE([xdnd],
   AC_DEFINE(XDND, 1, [whether Drag-nd-Drop support should be enabled])
 ])
 
+
 dnl XShape support
 dnl ==============
 AC_ARG_ENABLE([shape],
@@ -595,6 +609,7 @@ AC_ARG_ENABLE([shape],
     [enable_shape=auto])
 WM_XEXT_CHECK_XSHAPE
 
+
 dnl MIT-SHM support
 dnl ===============
 AC_ARG_ENABLE([shm],
@@ -605,11 +620,13 @@ AC_ARG_ENABLE([shm],
     [enable_shm=auto])
 WM_XEXT_CHECK_XSHM
 
+
 dnl X Misceleanous Utility
 dnl ======================
-# the libXmu is used in WRaster
+dnl the libXmu is used in WRaster
 WM_EXT_CHECK_XMU
 
+
 dnl XINERAMA support
 dnl ================
 AC_ARG_ENABLE([xinerama],
@@ -620,8 +637,9 @@ AC_ARG_ENABLE([xinerama],
     [enable_xinerama=auto])
 WM_XEXT_CHECK_XINERAMA
 
+
 dnl RandR support
-dnl ==============
+dnl =============
 AC_ARG_ENABLE([randr],
     [AS_HELP_STRING([--enable-randr], [enable RandR extension support (NOT recommended, buggy)])],
     [AS_CASE(["$enableval"],
@@ -630,15 +648,17 @@ AC_ARG_ENABLE([randr],
     [enable_randr=no])
 WM_XEXT_CHECK_XRANDR
 
-dnl
+
+dnl Math library
+dnl ============
 dnl libWINGS uses math functions, check whether usage requires linking
 dnl against libm
-dnl
 WM_CHECK_LIBM
 
-dnl
+
+dnl FontConfig
+dnl ==========
 dnl libWINGS uses FcPatternDel from libfontconfig
-dnl
 AC_MSG_CHECKING([for fontconfig library])
 FCLIBS=`$PKGCONFIG fontconfig --libs`
 if test "x$FCLIBS" = "x" ; then
@@ -745,11 +765,12 @@ dnl 		End of stuff that uses X
 dnl ===============================================
 
 dnl EXIF Support
-dnl ===========
+dnl ============
 WM_CHECK_LIBEXIF
 AS_IF([test "x$LIBEXIF" != "x"],
         [AC_DEFINE(HAVE_EXIF, 1, [Define if EXIF can be used])])
 
+
 dnl PNG Support
 dnl ===========
 AC_ARG_ENABLE([png],
@@ -795,7 +816,7 @@ WM_IMGFMT_CHECK_TIFF
 
 
 dnl WEBP Support
-dnl ===========
+dnl ============
 AC_ARG_ENABLE([webp],
     [AS_HELP_STRING([--disable-webp], [disable WEBP support through libwebp])],
     [AS_CASE(["$enableval"],
@@ -805,8 +826,8 @@ AC_ARG_ENABLE([webp],
 WM_IMGFMT_CHECK_WEBP
 
 
-dnl MAGICK Support
+dnl MagicK Support
-dnl ===========
+dnl ==============
 AC_ARG_ENABLE([magick],
     [AS_HELP_STRING([--disable-magick], [disable MAGICK support through libMagickWand])],
     [AS_CASE(["$enableval"],
@@ -866,7 +887,6 @@ AC_SUBST(pixmapdir)
 
 dnl Support for GNUSTEP_LOCAL_ROOT, for WPrefs.app
 dnl ==============================================
-
 AC_ARG_WITH(gnustepdir, AS_HELP_STRING([--with-gnustepdir=PATH], [specify the directory for GNUstep applications]))
 
 if test "x`echo $with_gnustepdir | grep ^/`" != "x"; then
@@ -902,6 +922,9 @@ if test "$enableval" = yes; then
 fi
 )
 
+
+dnl Support for removing non-public symbols from a library
+dnl ======================================================
 gl_LD_VERSION_SCRIPT
 
 
@@ -913,7 +936,7 @@ WM_CFLAGS_GCC_OPTION_POSTPONED
 AC_SUBST(lib_search_path)
 AC_SUBST(inc_search_path)
 
-dnl
+
 dnl Spit out the configuration
 dnl ==========================
 AC_CONFIG_FILES(
@@ -950,6 +973,9 @@ AC_CONFIG_FILES(
 
 AC_OUTPUT
 
+
+dnl Provide a summary of the config
+dnl ===============================
 if test "x$MOFILES" = "x"; then
 	mof=None
 else
@@ -1006,4 +1032,3 @@ dnl ================================================
 dnl Local Variables:
 dnl compile-command: "autoconf"
 dnl End:
-

m4/windowmaker.m4

@@ -24,12 +24,11 @@ m4_pattern_forbid([^_?WM_])
 m4_pattern_allow([^WM_OSDEP(_[A-Z]*)?$])
 
 
-dnl
+# WM_CHECK_XFT_VERSION(MIN_VERSION, [ACTION-IF-FOUND [,ACTION-IF-NOT-FOUND]])
-dnl WM_CHECK_XFT_VERSION(MIN_VERSION, [ACTION-IF-FOUND [,ACTION-IF-NOT-FOUND]])
+#
-dnl
+# $XFTFLAGS should be defined before calling this macro,
-dnl # $XFTFLAGS should be defined before calling this macro,
+# else it will not be able to find Xft.h
-dnl # else it will not be able to find Xft.h
+#
-dnl
 AC_DEFUN([WM_CHECK_XFT_VERSION],
 [
 CPPFLAGS_old="$CPPFLAGS"
@@ -61,14 +60,14 @@ CPPFLAGS="$CPPFLAGS_old"
 ])
 
 
-dnl _WM_LIB_CHECK_FUNCTS
+# _WM_LIB_CHECK_FUNCTS
-dnl -----------------------
+# --------------------
-dnl (internal shell functions)
+# (internal shell functions)
-dnl
+#
-dnl Create 2 shell functions:
+# Create 2 shell functions:
-dnl  wm_fn_imgfmt_try_link: try to link against library
+#  wm_fn_imgfmt_try_link: try to link against library
-dnl  wm_fn_imgfmt_try_compile: try to compile against header
+#  wm_fn_imgfmt_try_compile: try to compile against header
-dnl
+#
 AC_DEFUN_ONCE([_WM_LIB_CHECK_FUNCTS],
 [@%:@ wm_fn_lib_try_link FUNCTION LFLAGS
 @%:@ ----------------------------------

m4/wm_attributes.m4

@@ -16,6 +16,7 @@
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
+
 # WM_C_NORETURN
 # -------------
 #
@@ -61,8 +62,9 @@ AS_CASE([$wm_cv_c_noreturn],
         [Defines the attribute to tell the compiler that a function never returns, if the ISO C11 attribute does not work])])
 ])
 
+
 # _WM_SHELLFN_FUNCATTRIBUTE
-# ----------------------
+# -------------------------
 # (internal shell function only!)
 #
 # Create a shell function to check if we can compile with special

m4/wm_imgfmt_check.m4

@@ -16,6 +16,7 @@
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
+
 # WM_IMGFMT_CHECK_GIF
 # -------------------
 #
@@ -175,7 +176,7 @@ AC_DEFUN_ONCE([WM_IMGFMT_CHECK_TIFF],
 
 
 # WM_IMGFMT_CHECK_WEBP
-# -------------------
+# --------------------
 #
 # Check for WEBP file support through 'libwebp'
 # The check depends on variable 'enable_webp' being either:

m4/wm_libexif.m4

@@ -16,8 +16,9 @@
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
+
 # WM_CHECK_LIBEXIF
-# -------------
+# ----------------
 #
 # Checks the needed library link flags
 # Sets variable LIBEXIF with the appropriates flags

m4/wm_libmath.m4

@@ -16,6 +16,7 @@
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
+
 # WM_CHECK_LIBM
 # -------------
 #

m4/wm_prog_cc_c11.m4

@@ -16,8 +16,9 @@
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
+
 # WM_PROG_CC_C11
-# ---------------------
+# --------------
 #
 # Check if the compiler supports C11 standard natively, or if any
 # option may help enabling the support