Add to modules' help text (displayed by ./configure -h) more

information that will be useful in deciding whether to enable
them or not.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1029814 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/modules/cache/config.m4 b/modules/cache/config.m4
index 2c29cf8c3ec99907f36295069de0f808e811adb7..0c2c89614cb99f9fc3fa394094bb79e067266616 100644 (file)
--- a/modules/cache/config.m4
+++ b/modules/cache/config.m4
@@ -22,7 +22,7 @@ case "$host" in
     ;;
 esac
 
-APACHE_MODULE(cache, dynamic file caching, $cache_objs, , most)
+APACHE_MODULE(cache, dynamic file caching.  At least one storage management module (e.g. mod_disk_cache) is also necessary., $cache_objs, , most)
 APACHE_MODULE(disk_cache, disk caching module, $disk_cache_objs, , most)
 
 AC_DEFUN([CHECK_DISTCACHE], [

diff --git a/modules/core/config.m4 b/modules/core/config.m4
index 279cc4109fbeca8b57666dc1c667965af2634be4..b97ae11a4912f05ceda0fe156bcf7b2f5da6fd3c 100644 (file)
--- a/modules/core/config.m4
+++ b/modules/core/config.m4
@@ -43,7 +43,7 @@ if test "$sharedobjs" = "yes"; then
     fi
 fi
 
-APACHE_MODULE(so, DSO capability, , , $enable_so)
+APACHE_MODULE(so, DSO capability.  This module will be automatically enabled unless you build all modules statically., , , $enable_so)
 
 APR_CHECK_APR_DEFINE(APR_HAS_THREADS)
 

diff --git a/modules/dav/fs/config6.m4 b/modules/dav/fs/config6.m4
index 515111cd01cbab78deb45e64e57cbbfd9463c228..235d0d7fcd407e6fd607a038e4fddb3cd48b3ef8 100644 (file)
--- a/modules/dav/fs/config6.m4
+++ b/modules/dav/fs/config6.m4
@@ -18,6 +18,6 @@ case "$host" in
     ;;
 esac
 
-APACHE_MODULE(dav_fs, DAV provider for the filesystem, $dav_fs_objects, , $dav_fs_enable)
+APACHE_MODULE(dav_fs, DAV provider for the filesystem.  --enable-dav also enables mod_dav_fs., $dav_fs_objects, , $dav_fs_enable)
 
 APACHE_MODPATH_FINISH

diff --git a/modules/dav/lock/config6.m4 b/modules/dav/lock/config6.m4
index bc35ee3c038e31b7de64221865a2ccca32771d6b..b3078dd558af9cc753c915471d065f9e1ba7d9f6 100644 (file)
--- a/modules/dav/lock/config6.m4
+++ b/modules/dav/lock/config6.m4
@@ -12,6 +12,6 @@ case "$host" in
     ;;
 esac
 
-APACHE_MODULE(dav_lock, DAV provider for generic locking, $dav_lock_objects, , no)
+APACHE_MODULE(dav_lock, DAV provider for generic locking - requires --enable-dav, $dav_lock_objects, , no)
 
 APACHE_MODPATH_FINISH

diff --git a/modules/dav/main/config5.m4 b/modules/dav/main/config5.m4
index 59c077ebbc8f972480cecfd4297597963a636a16..74f0db97b1dfc07572a07668991db4522c85eb09 100644 (file)
--- a/modules/dav/main/config5.m4
+++ b/modules/dav/main/config5.m4
@@ -10,7 +10,7 @@ else
   dav_enable=most
 fi
 
-APACHE_MODULE(dav, WebDAV protocol handling, $dav_objects, , $dav_enable)
+APACHE_MODULE(dav, WebDAV protocol handling.  --enable-dav also enables mod_dav_fs, $dav_objects., , $dav_enable)
 
 if test "$dav_enable" != "no" -o "$enable_dav" != "no"; then
   apache_need_expat=yes

diff --git a/modules/debugging/config.m4 b/modules/debugging/config.m4
index 6a75501fd986ece1f21ba3a2b1ede512bb042ff5..f49d0770867e73c91b2dc4531071f02d39fe9d85 100644 (file)
--- a/modules/debugging/config.m4
+++ b/modules/debugging/config.m4
@@ -1,7 +1,7 @@
 
 APACHE_MODPATH_INIT(debugging)
 
-APACHE_MODULE(bucketeer, buckets manipulation filter, , , no)
-APACHE_MODULE(dumpio, I/O dump filter, , , most)
+APACHE_MODULE(bucketeer, buckets manipulation filter.  Useful only for developers and testing purposes., , , no)
+APACHE_MODULE(dumpio, I/O dump filter.  Useful only for developers and testing purposes., , , most)
 
 APACHE_MODPATH_FINISH

diff --git a/modules/filters/config.m4 b/modules/filters/config.m4
index 3eccac23165b9fe2469cb908349a2b8160835d8f..732251f1771c30c9ef532b471efe34b119366675 100644 (file)
--- a/modules/filters/config.m4
+++ b/modules/filters/config.m4
@@ -20,9 +20,9 @@ APACHE_MODULE(sed, filter request and/or response bodies through sed, $sed_obj)
 if test "$ac_cv_ebcdic" = "yes"; then
 # mod_charset_lite can be very useful on an ebcdic system,
 #   so include it by default
-    APACHE_MODULE(charset_lite, character set translation, , , yes)
+    APACHE_MODULE(charset_lite, character set translation.  Enabled by default only on EBCDIC systems., , , yes)
 else
-    APACHE_MODULE(charset_lite, character set translation, , , no)
+    APACHE_MODULE(charset_lite, character set translation.  Enabled by default only on EBCDIC systems., , , no)
 fi
 
 

diff --git a/modules/generators/config5.m4 b/modules/generators/config5.m4
index 117facf31229126e0aa5754e9568799bf09a2913..e3efda6134ab1a208524129c944be944a6394587 100644 (file)
--- a/modules/generators/config5.m4
+++ b/modules/generators/config5.m4
@@ -14,7 +14,7 @@ APACHE_MODULE(suexec, set uid and gid for spawned processes, , , no, [
 if ap_mpm_is_threaded; then
 # if we are using a threaded MPM, we will get better performance with
 # mod_cgid, so make it the default.
-    APACHE_MODULE(cgid, CGI scripts, , , yes, [
+    APACHE_MODULE(cgid, CGI scripts.  Enabled by default with threaded MPMs, , , yes, [
     case $host in
       *-solaris2*)
         case `uname -r` in
@@ -52,13 +52,13 @@ For more info: <http://issues.apache.org/bugzilla/show_bug.cgi?id=34264>])
         ;;
     esac
   ])
-    APACHE_MODULE(cgi, CGI scripts, , , no)
+    APACHE_MODULE(cgi, CGI scripts.  Enabled by default with non-threaded MPMs, , , no)
 else
 # if we are using a non-threaded MPM, it makes little sense to use
 # mod_cgid, and it just opens up holes we don't need.  Make mod_cgi the
 # default
-    APACHE_MODULE(cgi, CGI scripts, , , yes)
-    APACHE_MODULE(cgid, CGI scripts, , , no)
+    APACHE_MODULE(cgi, CGI scripts.  Enabled by default with non-threaded MPMs, , , yes)
+    APACHE_MODULE(cgid, CGI scripts.  Enabled by default with threaded MPMs, , , no)
 fi
 
 APR_ADDTO(INCLUDES, [-I\$(top_srcdir)/$modpath_current])

diff --git a/modules/http/config2.m4 b/modules/http/config2.m4
index 87a7cc8a2082fb5b68012a39d0019c3e781778f8..64960075f63defd529b720df20511d96816022ea 100644 (file)
--- a/modules/http/config2.m4
+++ b/modules/http/config2.m4
@@ -14,7 +14,7 @@ elif test "$enable_http" = "shared"; then
     AC_MSG_ERROR([mod_http can not be built as a shared DSO])
 fi
 
-APACHE_MODULE(http, HTTP protocol handling, $http_objects, , static)
-APACHE_MODULE(mime, mapping of file-extension to MIME, , , yes)
+APACHE_MODULE(http,[HTTP protocol handling.  The http module is a basic one that enables the server to function as an HTTP server. It is only useful to disable it if you want to use another protocol module instead. Don't disable this module unless you are really sure what you are doing. Note: This module will always be linked statically.], $http_objects, , static)
+APACHE_MODULE(mime, mapping of file-extension to MIME.  Disabling this module is normally not recommended., , , yes)
 
 APACHE_MODPATH_FINISH

diff --git a/modules/loggers/config.m4 b/modules/loggers/config.m4
index 23ee15eee25c5f0c117d366da172bd1580567b37..8571e9e7083b92e10f70eaca7e4c83759dbe93ae 100644 (file)
--- a/modules/loggers/config.m4
+++ b/modules/loggers/config.m4
@@ -4,7 +4,7 @@ dnl APACHE_MODULE(name, helptext[, objects[, structname[, default[, config]]]])
 
 APACHE_MODPATH_INIT(loggers)
        
-APACHE_MODULE(log_config, logging configuration, , , yes)
+APACHE_MODULE(log_config, logging configuration.  You won't be able to log requests to the server without this module., , , yes)
 APACHE_MODULE(log_forensic, forensic logging)
 
 if test "x$enable_log_forensic" != "xno"; then

diff --git a/modules/proxy/config.m4 b/modules/proxy/config.m4
index 73649de4ed634d6bb428a3324eb3adecdec79358..b0606a500f66978525389d7007dbadc611971c2f 100644 (file)
--- a/modules/proxy/config.m4
+++ b/modules/proxy/config.m4
@@ -46,18 +46,18 @@ case "$host" in
     ;;
 esac
 
-APACHE_MODULE(proxy_connect, Apache proxy CONNECT module, $proxy_connect_objs, , $proxy_mods_enable)
-APACHE_MODULE(proxy_ftp, Apache proxy FTP module, $proxy_ftp_objs, , $proxy_mods_enable)
-APACHE_MODULE(proxy_http, Apache proxy HTTP module, $proxy_http_objs, , $proxy_mods_enable)
-APACHE_MODULE(proxy_fcgi, Apache proxy FastCGI module, $proxy_fcgi_objs, , $proxy_mods_enable)
-APACHE_MODULE(proxy_scgi, Apache proxy SCGI module, $proxy_scgi_objs, , $proxy_mods_enable)
-APACHE_MODULE(proxy_fdpass, Apache proxy to Unix Daemon Socket module, $proxy_fdpass_objs, , $proxy_mods_fdpass_enable, [
+APACHE_MODULE(proxy_connect, Apache proxy CONNECT module.  Requires and is enabled by --enable-proxy., $proxy_connect_objs, , $proxy_mods_enable)
+APACHE_MODULE(proxy_ftp, Apache proxy FTP module.  Requires and is enabled by --enable-proxy., $proxy_ftp_objs, , $proxy_mods_enable)
+APACHE_MODULE(proxy_http, Apache proxy HTTP module.  Requires and is enabled by --enable-proxy., $proxy_http_objs, , $proxy_mods_enable)
+APACHE_MODULE(proxy_fcgi, Apache proxy FastCGI module.  Requires and is enabled by --enable-proxy., $proxy_fcgi_objs, , $proxy_mods_enable)
+APACHE_MODULE(proxy_scgi, Apache proxy SCGI module.  Requires and is enabled by --enable-proxy., $proxy_scgi_objs, , $proxy_mods_enable)
+APACHE_MODULE(proxy_fdpass, Apache proxy to Unix Daemon Socket module.  Requires --enable-proxy., $proxy_fdpass_objs, , $proxy_mods_fdpass_enable, [
   if test $ac_cv_have_decl_CMSG_DATA = "no"; then
     AC_MSG_ERROR([Your system does not support CMSG_DATA.])
   fi
 ])
-APACHE_MODULE(proxy_ajp, Apache proxy AJP module, $proxy_ajp_objs, , $proxy_mods_enable)
-APACHE_MODULE(proxy_balancer, Apache proxy BALANCER module, $proxy_balancer_objs, , $proxy_mods_enable)
+APACHE_MODULE(proxy_ajp, Apache proxy AJP module.  Requires and is enabled by --enable-proxy., $proxy_ajp_objs, , $proxy_mods_enable)
+APACHE_MODULE(proxy_balancer, Apache proxy BALANCER module.  Requires and is enabled by --enable-proxy., $proxy_balancer_objs, , $proxy_mods_enable)
 
 APACHE_MODULE(serf, [Reverse proxy module using Serf], , , no, [
     APACHE_CHECK_SERF