apr-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Joe Orton <...@manyfish.co.uk>
Subject [PATCH] improve comment style
Date Wed, 16 Oct 2002 12:30:29 GMT
In Autoconf, it's good practice to use "dnl" only when commenting on an
m4 construct, or something which doesn't end up in the configure script.
But otherwise, '#' should be used, so that the configure script can be
debugged more easily.

This fixes some uses of "dnl" which should be "#", and removes uses of
the redundant "dnl #" oddity.

Index: configure.in
===================================================================
RCS file: /home/cvspublic/apr/configure.in,v
retrieving revision 1.487
diff -u -r1.487 configure.in
--- configure.in	16 Oct 2002 11:46:14 -0000	1.487
+++ configure.in	16 Oct 2002 12:28:07 -0000
@@ -1,16 +1,16 @@
-dnl #
-dnl # Autoconf configuration file for APR
-dnl #
-dnl # Process this file with autoconf to produce a configure script.
-dnl # Use ./buildconf to prepare build files and run autoconf for APR.
+dnl 
+dnl Autoconf configuration file for APR
+dnl 
+dnl Process this file with autoconf to produce a configure script.
+dnl Use ./buildconf to prepare build files and run autoconf for APR.
 
 AC_INIT(build/apr_common.m4)
 AC_CONFIG_HEADER(include/arch/unix/apr_private.h)
 AC_CONFIG_AUX_DIR(build)
 
-dnl #
-dnl # Include our own M4 macros along with those for libtool
-dnl #
+dnl 
+dnl Include our own M4 macros along with those for libtool
+dnl 
 sinclude(build/apr_common.m4)
 sinclude(build/apr_network.m4)
 sinclude(build/apr_threads.m4)
@@ -33,12 +33,12 @@
 echo "Configuring APR library"
 echo "Platform: $host"
 
-dnl # Some initial steps for configuration.  We setup the default directory
-dnl # and which files are to be configured.
+dnl Some initial steps for configuration.  We setup the default directory
+dnl and which files are to be configured.
 
 dnl Setup the directory macros now
 
-dnl Absolute source/build directory
+# Absolute source/build directory
 apr_srcdir=`(cd $srcdir && pwd)`
 apr_builddir=`pwd`
 AC_SUBST(apr_srcdir)
@@ -48,15 +48,15 @@
   USE_VPATH=1
 fi
 
-dnl Libtool might need this symbol -- it must point to the location of
-dnl the generated libtool script (not necessarily the "top" build dir).
-dnl
+# Libtool might need this symbol -- it must point to the location of
+# the generated libtool script (not necessarily the "top" build dir).
+#
 top_builddir="$apr_builddir"
 AC_SUBST(top_builddir)
 
-dnl Directory containing apr build macros, helpers, and make rules
-dnl NOTE: make rules (rules.mk) will be in the builddir for vpath
-dnl
+# Directory containing apr build macros, helpers, and make rules
+# NOTE: make rules (rules.mk) will be in the builddir for vpath
+#
 apr_buildout=$apr_builddir/build
 apr_builders=$apr_srcdir/build
 AC_SUBST(apr_builders)
@@ -66,7 +66,7 @@
 dnl Initialize mkdir -p functionality.
 APR_MKDIR_P_CHECK($apr_builders/mkdir.sh)
 
-dnl get our version information
+# get our version information
 get_version="$apr_builders/get-version.sh"
 version_hdr="$apr_srcdir/include/apr_version.h"
 APR_MAJOR_VERSION="`$get_version major $version_hdr APR`"
@@ -141,7 +141,7 @@
     if test "x$LTFLAGS" = "x"; then
         LTFLAGS='--silent'
     fi
-    dnl get libtool's setting of shlibpath_var
+    # get libtool's setting of shlibpath_var
     eval `grep "^shlibpath_var=[[A-Z_]]*$" $apr_builddir/libtool`
     if test "x$shlibpath_var" = "x"; then
         shlibpath_var=REPLACE_WITH_YOUR_SHLIBPATH_VAR
@@ -171,7 +171,7 @@
       export_lib_target=''
 fi
 
-dnl On AIX, libraries need to be specified on the link of lib_target
+# On AIX, libraries need to be specified on the link of lib_target
 lib_target_libs=""
 case $host in
     *aix*)
@@ -194,7 +194,7 @@
 AC_SUBST(LT_LDFLAGS)
 AC_SUBST(lib_target_libs)
 
-dnl #----------------------------- Checks for compiler flags
+dnl ----------------------------- Checks for compiler flags
 nl='
 '
 echo $ac_n "${nl}Check for compiler flags...${nl}"
@@ -310,8 +310,8 @@
   ) dnl
 fi
 
-dnl # this is the place to put specific options for platform/compiler
-dnl # combinations
+# this is the place to put specific options for platform/compiler
+# combinations
 case "$host:$CC" in
     *-hp-hpux*:cc )
 	APR_ADDTO(CFLAGS,[-Ae +DAportable +Z])
@@ -323,11 +323,11 @@
 	;;
 esac
 
-dnl force_atomic_generic flag 
-dnl this will be set we find a cpu/OS combo
-dnl which is historical and doesn't work with the method
-dnl we are using for the more up to date cpu/OS
-dnl  (ie.. old sparcs)
+# force_atomic_generic flag 
+# this will be set we find a cpu/OS combo
+# which is historical and doesn't work with the method
+# we are using for the more up to date cpu/OS
+# (ie.. old sparcs)
 apr_force_atomic_generic=0
 proc_mutex_is_global=0
 nonportable_atomics_enabled=0
@@ -453,8 +453,8 @@
 AC_SUBST(eolstr)
 AC_SUBST(INSTALL_SUBDIRS)
 
-dnl For some platforms we need a version string which allows easy numeric
-dnl comparisons.
+# For some platforms we need a version string which allows easy numeric
+# comparisons.
 case $host in
     *freebsd*)
         # 3.4-RELEASE: 340   4.1.1-RELEASE: 411
@@ -468,7 +468,7 @@
         ;;
 esac
 
-dnl #----------------------------- Checks for Any required Libraries
+dnl ----------------------------- Checks for Any required Libraries
 dnl Note: Autoconf will always append LIBS with an extra " " in AC_CHECK_LIB.
 dnl It should check for LIBS being empty and set LIBS equal to the new value 
 dnl without the extra " " in that case, but they didn't do that.  So, we
@@ -481,7 +481,7 @@
 AC_CHECK_LIB(truerand, main)
 AC_CHECK_LIB(m, modf)
 
-dnl #----------------------------- Checking for Threads
+dnl ----------------------------- Checking for Threads
 echo $ac_n "${nl}Checking for Threads...${nl}"
 
 if test -z "$enable_threads"; then
@@ -537,10 +537,10 @@
         AC_CHECK_FUNCS(pthread_key_delete pthread_rwlock_init)
 
         if test "$ac_cv_func_pthread_rwlock_init" = "yes"; then
-            dnl #----------------------------- Checking for pthread_rwlock_t
-            dnl # Linux is silly as it has pthread_rwlock_init defined
-            dnl # but keeps the pthread_rwlock_t structure hidden unless 
-            dnl # special things are defined.
+            dnl ----------------------------- Checking for pthread_rwlock_t
+            dnl Linux is silly as it has pthread_rwlock_init defined
+            dnl but keeps the pthread_rwlock_t structure hidden unless 
+            dnl special things are defined.
             AC_TRY_COMPILE([#include <sys/types.h>
 #include <pthread.h>], 
                 [pthread_rwlock_t rwlock=PTHREAD_RWLOCK_INITIALIZER;],
@@ -607,17 +607,17 @@
 
 AC_CHECK_FUNCS(poll)
 
-dnl #----------------------------- Checking for missing POSIX thread functions
+dnl ----------------------------- Checking for missing POSIX thread functions
 AC_CHECK_FUNCS(getpwnam_r)
 AC_CHECK_FUNCS(getpwuid_r)
 AC_CHECK_FUNCS(getgrnam_r)
 AC_CHECK_FUNCS(getgrgid_r)
 
-dnl #----------------------------- Checking for Shared Memory Support 
+dnl ----------------------------- Checking for Shared Memory Support 
 echo $ac_n "${nl}Checking for Shared Memory Support...${nl}"
 
-dnl The Posix function are in librt on Solaris. This will
-dnl also help us find sem_open when doing locking below
+# The Posix function are in librt on Solaris. This will
+# also help us find sem_open when doing locking below
 case $host in
    *-solaris*)
        AC_CHECK_LIB(rt, shm_open)
@@ -634,7 +634,7 @@
 AC_CHECK_FUNCS(create_area)
 AC_CHECK_HEADERS(os2.h)
 
-dnl Not all systems can mmap /dev/zero (such as HP-UX).  Check for that.
+# Not all systems can mmap /dev/zero (such as HP-UX).  Check for that.
 if test "$ac_cv_func_mmap" = "yes" &&
    test "$ac_cv_file__dev_zero" = "yes"; then
     AC_MSG_CHECKING(for mmap that can map /dev/zero)
@@ -666,7 +666,7 @@
     AC_MSG_RESULT($ac_cv_file__dev_zero)
 fi
 
-dnl Now we determine which one is our anonymous shmem preference.
+# Now we determine which one is our anonymous shmem preference.
 haveshmgetanon="0"
 havemmapzero="0"
 havemmapanon="0"
@@ -692,10 +692,10 @@
                          [BeOS areas])])
 case $host in
     *linux* ) 
-        dnl Linux has problems with MM_SHMT_MMANON even though it reports
-        dnl that it has it.
-        dnl FIXME - find exact 2.3 version that MMANON was fixed in.  It is
-        dnl confirmed fixed in 2.4 series.
+        # Linux has problems with MM_SHMT_MMANON even though it reports
+        # that it has it.
+        # FIXME - find exact 2.3 version that MMANON was fixed in.  It is
+        # confirmed fixed in 2.4 series.
         if test $os_version -le "240"; then
             APR_DECISION_OVERRIDE(USE_SHMEM_MMAP_ZERO USE_SHMEM_SHMGET_ANON)
         fi
@@ -730,7 +730,7 @@
 AC_SUBST(havemmapzero)
 AC_SUBST(havemmapanon)
 
-dnl Now we determine which one is our name-based shmem preference.
+# Now we determine which one is our name-based shmem preference.
 havemmaptmp="0"
 havemmapshm="0"
 haveshmget="0"
@@ -758,10 +758,10 @@
               APR_DECIDE(USE_SHMEM_OS2, [OS/2 DosAllocSharedMem()])])
 case $host in
     *linux* ) 
-        dnl Linux has problems with MM_SHMT_MMANON even though it reports
-        dnl that it has it.
-        dnl FIXME - find exact 2.3 version that MMANON was fixed in.  It is
-        dnl confirmed fixed in 2.4 series.
+        # Linux has problems with MM_SHMT_MMANON even though it reports
+        # that it has it.
+        # FIXME - find exact 2.3 version that MMANON was fixed in.  It is
+        # confirmed fixed in 2.4 series.
         if test $os_version -le "240"; then
             APR_DECISION_OVERRIDE(USE_SHMEM_MMAP_TMP USE_SHMEM_MMAP_SHM dnl
                                   USE_SHMEM_SHMGET)
@@ -795,7 +795,7 @@
         ;;
 esac
 
-dnl Do we have any shared memory support?
+# Do we have any shared memory support?
 if test "$usemmaptmp$usemmapshm$usemmapzero$useshmget$usemmapanon$usebeosarea$useos2shm"
= "0000000"; then
   sharedmem="0"
 else
@@ -814,7 +814,7 @@
 AC_SUBST(haveos2shm)
 AC_SUBST(sharedmem)
 
-dnl #----------------------------- Checks for Any required Functions
+dnl ----------------------------- Checks for Any required Functions
 dnl Checks for library functions. (N.B. poll is further down)
 AC_CHECK_FUNCS(alloca calloc strcasecmp stricmp setsid isinf isnan)
 AC_CHECK_FUNCS(setrlimit, [ have_setrlimit="1" ], [ have_setrlimit="0" ]) 
@@ -894,7 +894,7 @@
 
 APR_CHECK_SIGWAIT_ONE_ARG
 
-dnl #----------------------------- Checks for Any required Headers
+dnl ----------------------------- Checks for Any required Headers
 AC_HEADER_STDC
 
 APR_FLAG_HEADERS(
@@ -958,9 +958,9 @@
     sys/un.h		\
     sys/wait.h)
 
-dnl IRIX 6.5 has a problem in <netinet/tcp.h> which prevents it from
-dnl being included by itself.  Check for <netinet/tcp.h> manually,
-dnl including another header file first.
+# IRIX 6.5 has a problem in <netinet/tcp.h> which prevents it from
+# being included by itself.  Check for <netinet/tcp.h> manually,
+# including another header file first.
 AC_MSG_CHECKING(for netinet/tcp.h)
 AC_TRY_CPP([
 #ifdef HAVE_NETINET_IN_H
@@ -1007,7 +1007,7 @@
 AC_SUBST(pthreadh)
 AC_SUBST(semaphoreh)
 
-dnl #----------------------------- Checking for h_errno in <netdb.h>
+# Checking for h_errno in <netdb.h>
 if test "$netdbh" = "1"; then
   APR_CHECK_H_ERRNO_FLAG
   if test "$ac_cv_h_errno_cflags" = "no"; then
@@ -1015,7 +1015,7 @@
   fi
 fi
 
-dnl #----------------------------- Checks for standard typedefs
+dnl ----------------------------- Checks for standard typedefs
 AC_TYPE_OFF_T
 AC_TYPE_PID_T
 AC_TYPE_SIZE_T
@@ -1030,7 +1030,7 @@
 
 APR_INADDR_NONE
 
-dnl # Checks for integer size
+dnl Checks for integer size
 AC_CHECK_SIZEOF(char, 1)
 AC_CHECK_SIZEOF(int, 4)
 AC_CHECK_SIZEOF(long, 4)
@@ -1044,8 +1044,8 @@
 if test "$ac_cv_sizeof_int" = "4"; then
     int_value=int
 fi
-dnl # Now we need to find what apr_int64_t (sizeof == 8) will be.
-dnl # The first match is our preference.
+# Now we need to find what apr_int64_t (sizeof == 8) will be.
+# The first match is our preference.
 if test "$ac_cv_sizeof_int" = "8"; then
     int64_literal='#define APR_INT64_C(val) (val)'
     int64_t_fmt='#define APR_INT64_T_FMT "d"'
@@ -1062,10 +1062,10 @@
     int64_strfn="strtol"
 elif test "$ac_cv_sizeof_long_long" = "8"; then
     int64_literal='#define APR_INT64_C(val) (val##LL)'
-    dnl Linux, Solaris, FreeBSD all support ll with printf.
-    dnl BSD 4.4 originated 'q'.  Solaris is more popular and 
-    dnl doesn't support 'q'.  Solaris wins.  Exceptions can
-    dnl go to the OS-dependent section.
+    # Linux, Solaris, FreeBSD all support ll with printf.
+    # BSD 4.4 originated 'q'.  Solaris is more popular and 
+    # doesn't support 'q'.  Solaris wins.  Exceptions can
+    # go to the OS-dependent section.
     int64_t_fmt='#define APR_INT64_T_FMT "lld"'
     int64_t_fmt_len='#define APR_INT64_T_FMT_LEN 3'
     int64_value="long long"
@@ -1086,8 +1086,8 @@
     long_value="__int64"
     int64_strfn="strtoll"
 else
-    dnl # int64_literal may be overriden if your compiler thinks you have
-    dnl # a 64-bit value but APR does not agree.
+    # int64_literal may be overriden if your compiler thinks you have
+    # a 64-bit value but APR does not agree.
     int64_literal='#error Can not determine the proper size for apr_int64_t'
     int64_t_fmt='#error Can not determine the proper size for apr_int64_t'
     int64_t_fmt_len='#error Can not determine the proper size for apr_int64_t'
@@ -1230,7 +1230,7 @@
 AC_SUBST(int64_literal) 
 AC_SUBST(stdint) 
 
-dnl #----------------------------- Checking for string functions
+dnl ----------------------------- Checking for string functions
 AC_CHECK_FUNCS(strnicmp, have_strnicmp="1", have_strnicmp="0")
 AC_CHECK_FUNCS(strncasecmp, have_strncasecmp="1", have_strncasecmp="0")
 AC_CHECK_FUNCS(stricmp, have_stricmp="1", have_stricmp="0")
@@ -1240,7 +1240,7 @@
 AC_CHECK_FUNCS(memchr, have_memchr="1", have_memchr="0")
 AC_CHECK_FUNCS($int64_strfn, have_int64_strfn="1", have_int64_strfn="0")
 
-dnl #----------------------------- We have a fallback position
+dnl ----------------------------- We have a fallback position
 if test "$have_int64_strfn" = "0" && test "$int64_strfn" = "strtoll"; then
     int64_strfn="strtoq"
     AC_CHECK_FUNCS($int64_strfn, have_int64_strfn="1", have_int64_strfn="0")
@@ -1256,7 +1256,7 @@
 AC_SUBST(have_int64_strfn)
 AC_SUBST(int64_strfn)
 
-dnl #----------------------------- Checking for DSO support
+dnl ----------------------------- Checking for DSO support
 echo $ac_n "${nl}Checking for DSO...${nl}"
 AC_ARG_ENABLE(dso,
   [  --enable-dso            Enable dso support ],
@@ -1300,7 +1300,7 @@
 
 AC_SUBST(aprdso)
 
-dnl #----------------------------- Checking for Processes
+dnl ----------------------------- Checking for Processes
 echo $ac_n "${nl}Checking for Processes...${nl}"
 
 AC_CHECK_FUNCS(waitpid)
@@ -1345,14 +1345,14 @@
 test "x$ac_cv_struct_rlimit" = xyes && struct_rlimit=1
 AC_SUBST(struct_rlimit)
 
-dnl #----------------------------- Checking for Locking Characteristics 
+dnl ----------------------------- Checking for Locking Characteristics 
 echo $ac_n "${nl}Checking for Locking...${nl}"
 
 AC_CHECK_FUNCS(semget semctl flock)
 AC_CHECK_HEADERS(semaphore.h)
 AC_CHECK_FUNCS(sem_close sem_unlink sem_post sem_wait)
 
-dnl Some systems return ENOSYS from sem_open.
+# Some systems return ENOSYS from sem_open.
 AC_CACHE_CHECK(for working sem_open,ac_cv_func_sem_open,[
 AC_TRY_RUN([
 #include <errno.h>
@@ -1577,7 +1577,7 @@
   AC_MSG_RESULT(no)
 fi
 
-dnl #----------------------------- Checking for /dev/random 
+dnl ----------------------------- Checking for /dev/random 
 AC_MSG_CHECKING(for entropy source)
 
 AC_ARG_WITH(egd, 
@@ -1645,7 +1645,7 @@
 fi
 
 AC_SUBST(rand)
-dnl #----------------------------- Checking for Time Support 
+dnl ----------------------------- Checking for Time Support 
 echo $ac_n "${nl}Checking for Time Support...${nl}"
 AC_CACHE_CHECK([for tm_gmtoff in struct tm], ac_cv_struct_tm_gmtoff,
 [AC_TRY_COMPILE([#include <sys/types.h>
@@ -1656,7 +1656,7 @@
     AC_DEFINE(HAVE_GMTOFF)
 fi
 
-dnl #----------------------------- Checking for Networking Support 
+dnl ----------------------------- Checking for Networking Support 
 echo $ac_n "${nl}Checking for Networking support...${nl}"
 AC_MSG_CHECKING(for in_addr in netinet/in.h)
 AC_TRY_COMPILE([
@@ -1683,7 +1683,7 @@
 
 APR_CHECK_SOCKADDR_SA_LEN
 
-dnl Check the types only if we have gethostbyname_r
+# Check the types only if we have gethostbyname_r
 if test "$ac_cv_func_gethostbyname_r" = "yes"; then
     APR_CHECK_GETHOSTBYNAME_R_STYLE
 fi
@@ -1691,7 +1691,7 @@
 APR_CHECK_TCP_NODELAY_INHERITED
 APR_CHECK_O_NONBLOCK_INHERITED
 
-dnl # Look for a way of corking TCP...
+# Look for a way of corking TCP...
 APR_CHECK_DEFINE(TCP_CORK, netinet/tcp.h)
 APR_CHECK_DEFINE(TCP_NOPUSH, netinet/tcp.h)
 apr_tcp_nopush_flag="0"
@@ -1736,7 +1736,7 @@
 APR_CHECK_RESOLV_RETRANS
 
 echo $ac_n "${nl}Checking for IPv6 Networking support...${nl}"
-dnl # Start of checking for IPv6 support...
+dnl Start of checking for IPv6 support...
 
 AC_ARG_ENABLE(ipv6,
   [  --disable-ipv6          Disable IPv6 support in APR.],
@@ -1747,9 +1747,9 @@
 
 case $host in
   *apple-darwin*)
-    dnl # It appears that Jaguar has all the right features, but
-    dnl # getnameinfo() fails to find the hostname for a mapped
-    dnl # address.
+    # It appears that Jaguar has all the right features, but
+    # getnameinfo() fails to find the hostname for a mapped
+    # address.
     broken_ipv6=1
     ;;
   *)
@@ -1792,7 +1792,7 @@
 
 AC_SUBST(have_ipv6)
 
-dnl #----------------------------- Finalize the variables
+dnl ----------------------------- Finalize the variables
 
 echo $ac_n "${nl}Restore user-defined environment settings...${nl}"
 
@@ -1807,7 +1807,7 @@
 AC_SUBST(NOTEST_LIBS)
 AC_SUBST(NOTEST_INCLUDES)
 
-dnl #----------------------------- Construct the files
+dnl ----------------------------- Construct the files
 
 AC_SUBST(LDLIBS)
 AC_SUBST(AR)
@@ -1837,9 +1837,9 @@
 fi
 AC_SUBST(SUBDIRS)
 
-dnl
-dnl BSD/OS (BSDi) needs to use a different include syntax in the Makefiles
-dnl
+#
+# BSD/OS (BSDi) needs to use a different include syntax in the Makefiles
+#
 case $host in
 *bsdi*)
     # Check whether they've installed GNU make
@@ -1881,7 +1881,7 @@
 chmod +x apr-config
 ])
 
-dnl #----------------------------- Fixup Makefiles for VPATH support
+dnl ----------------------------- Fixup Makefiles for VPATH support
 
 changequote({,})
 
Index: build/apr_common.m4
===================================================================
RCS file: /home/cvspublic/apr/build/apr_common.m4,v
retrieving revision 1.42
diff -u -r1.42 apr_common.m4
--- build/apr_common.m4	16 Oct 2002 11:36:33 -0000	1.42
+++ build/apr_common.m4	16 Oct 2002 12:28:08 -0000
@@ -524,8 +524,8 @@
 if test "$ac_cv_crypt_r_style" = "cryptd"; then
     AC_DEFINE(CRYPT_R_CRYPTD, 1, [Define if crypt_r has uses CRYPTD])
 fi
-dnl if we don't combine these conditions, CRYPT_R_STRUCT_CRYPT_DATA
-dnl will end up defined twice
+# if we don't combine these conditions, CRYPT_R_STRUCT_CRYPT_DATA
+# will end up defined twice
 if test "$ac_cv_crypt_r_style" = "struct_crypt_data" -o \
    "$ac_cv_crypt_r_style" = "struct_crypt_data_gnu_source"; then
     AC_DEFINE(CRYPT_R_STRUCT_CRYPT_DATA, 1, [Define if crypt_r uses struct crypt_data])

Mime
View raw message