From 5965e695fa4a814316e7b916648a175ab16b5511 Mon Sep 17 00:00:00 2001
From: Joakim Erdfelt
Date: Thu, 24 Oct 2013 14:06:50 -0700
Subject: Cleaning up modules

---
 jetty-client/src/main/config/modules/client.mod           |  1 -
 jetty-deploy/src/main/config/modules/deploy.mod           |  2 --
 jetty-distribution/src/main/resources/modules/setuid.mod  |  5 +++++
 jetty-jaas/src/main/config/modules/jaas.mod               |  5 ++---
 jetty-jaspi/src/main/config/modules/jaspi.mod             |  1 +
 jetty-jmx/src/main/config/modules/jmx-remote.mod          |  3 +--
 jetty-jmx/src/main/config/modules/jmx.mod                 |  8 +++++---
 jetty-jsp/src/main/config/modules/jsp.mod                 |  3 ++-
 .../src/main/config/modules/overlay.mod                   |  1 -
 jetty-plus/src/main/config/modules/plus.mod               |  3 +--
 jetty-proxy/src/main/config/modules/proxy.mod             |  1 -
 jetty-rewrite/src/main/config/modules/rewrite.mod         |  1 -
 jetty-server/src/main/config/modules/continuation.mod     |  6 ++++--
 jetty-server/src/main/config/modules/http.mod             |  1 +
 jetty-server/src/main/config/modules/https.mod            |  3 +++
 jetty-server/src/main/config/modules/jvm.mod              | 15 +++++++--------
 jetty-server/src/main/config/modules/lowresources.mod     |  1 +
 jetty-server/src/main/config/modules/requestlog.mod       |  3 ++-
 jetty-server/src/main/config/modules/server.mod           | 10 ++++++++--
 jetty-server/src/main/config/modules/ssl.mod              |  5 ++++-
 .../spdy-http-server/src/main/config/modules/npn.mod      |  9 ++++++---
 .../spdy-http-server/src/main/config/modules/spdy.mod     |  8 ++++++++
 jetty-util/src/main/config/modules/logging.mod            |  2 +-
 jetty-webapp/src/main/config/modules/webapp.mod           |  2 +-
 .../src/main/config/modules/websocket.mod                 |  5 ++---
 25 files changed, 65 insertions(+), 39 deletions(-)

diff --git a/jetty-client/src/main/config/modules/client.mod b/jetty-client/src/main/config/modules/client.mod
index 6788eacf79..39b58d4e69 100644
--- a/jetty-client/src/main/config/modules/client.mod
+++ b/jetty-client/src/main/config/modules/client.mod
@@ -3,5 +3,4 @@
 #
 
 [lib]
-# Client jars
 lib/jetty-client-${jetty.version}.jar
diff --git a/jetty-deploy/src/main/config/modules/deploy.mod b/jetty-deploy/src/main/config/modules/deploy.mod
index 84c90ab5d2..8cb36977c1 100644
--- a/jetty-deploy/src/main/config/modules/deploy.mod
+++ b/jetty-deploy/src/main/config/modules/deploy.mod
@@ -6,12 +6,10 @@
 webapp
 
 [lib]
-# Deploy jars
 lib/jetty-deploy-${jetty.version}.jar
 
 [files]
 webapps/
 
 [xml]
-# Deploy configuration
 etc/jetty-deploy.xml
diff --git a/jetty-distribution/src/main/resources/modules/setuid.mod b/jetty-distribution/src/main/resources/modules/setuid.mod
index 79be762389..64c9e23c9a 100644
--- a/jetty-distribution/src/main/resources/modules/setuid.mod
+++ b/jetty-distribution/src/main/resources/modules/setuid.mod
@@ -1,3 +1,7 @@
+#
+# Set UID Feature
+#
+
 [depend]
 server
 
@@ -8,6 +12,7 @@ lib/setuid/jetty-setuid-java-1.0.1.jar
 etc/jetty-setuid.xml
 
 [ini-template]
+## SetUID Configuration
 # jetty.startServerAsPrivileged=false
 # jetty.username=jetty
 # jetty.groupname=jetty
diff --git a/jetty-jaas/src/main/config/modules/jaas.mod b/jetty-jaas/src/main/config/modules/jaas.mod
index 854d8963e8..4932140ca6 100644
--- a/jetty-jaas/src/main/config/modules/jaas.mod
+++ b/jetty-jaas/src/main/config/modules/jaas.mod
@@ -1,17 +1,16 @@
 #
-# JAAS Feature
+# JAAS Module
 #
 
 [depend]
 server
 
 [lib]
-# JAAS jars
 lib/jetty-jaas-${jetty.version}.jar
 
 [xml]
-# JAAS configuration
 etc/jetty-jaas.xml
 
 [ini-template]
+## JAAS Configuration
 jaas.login.conf=etc/login.conf
diff --git a/jetty-jaspi/src/main/config/modules/jaspi.mod b/jetty-jaspi/src/main/config/modules/jaspi.mod
index 5b10b49a71..e7019ae1b6 100644
--- a/jetty-jaspi/src/main/config/modules/jaspi.mod
+++ b/jetty-jaspi/src/main/config/modules/jaspi.mod
@@ -1,6 +1,7 @@
 #
 # Jetty JASPI Module
 #
+
 [depend]
 security
 
diff --git a/jetty-jmx/src/main/config/modules/jmx-remote.mod b/jetty-jmx/src/main/config/modules/jmx-remote.mod
index 25222755e8..3696ff5037 100644
--- a/jetty-jmx/src/main/config/modules/jmx-remote.mod
+++ b/jetty-jmx/src/main/config/modules/jmx-remote.mod
@@ -1,11 +1,10 @@
 #
-# JMX Remote Feature
+# JMX Remote Module
 #
 
 [depend]
 jmx
 
 [xml]
-# JMX remote configuration
 etc/jetty-jmx-remote.xml
 
diff --git a/jetty-jmx/src/main/config/modules/jmx.mod b/jetty-jmx/src/main/config/modules/jmx.mod
index 6ac0a2f429..0c0ebc4d17 100644
--- a/jetty-jmx/src/main/config/modules/jmx.mod
+++ b/jetty-jmx/src/main/config/modules/jmx.mod
@@ -1,16 +1,18 @@
 #
-# JMX Feature
+# JMX Module
 #
 
 [lib]
-# JMX jars (as defined in start.config)
 lib/jetty-jmx-${jetty.version}.jar
 
 [xml]
-# JMX configuration
 etc/jetty-jmx.xml
 
 [ini-template]
+## JMX Configuration
+## Enable the "jmx-remote" module for an open port accessible by remote machines
 # jetty.jmxrmihost=localhost
 # jetty.jmxrmiport=1099
+## Strictly speaking you shouldn't need --exec to use this in most environments.
+## If this isn't working, make sure you enable --exec as well
 # -Dcom.sun.management.jmxremote
diff --git a/jetty-jsp/src/main/config/modules/jsp.mod b/jetty-jsp/src/main/config/modules/jsp.mod
index 8f7b582f85..b67dfe278d 100644
--- a/jetty-jsp/src/main/config/modules/jsp.mod
+++ b/jetty-jsp/src/main/config/modules/jsp.mod
@@ -9,5 +9,6 @@ servlet
 lib/jsp/*.jar
 
 [ini-template]
+# JSP Configuration
 # To use an non-jdk compiler for JSP compilation uncomment next line
-#-Dorg.apache.jasper.compiler.disablejsr199=true
+# -Dorg.apache.jasper.compiler.disablejsr199=true
diff --git a/jetty-overlay-deployer/src/main/config/modules/overlay.mod b/jetty-overlay-deployer/src/main/config/modules/overlay.mod
index 5e73f6bc29..87bf9e1722 100644
--- a/jetty-overlay-deployer/src/main/config/modules/overlay.mod
+++ b/jetty-overlay-deployer/src/main/config/modules/overlay.mod
@@ -9,5 +9,4 @@ deploy
 lib/jetty-overlay-deployer-${jetty.version}.jar
 
 [xml]
-# Plus requires configuration
 etc/jetty-overlay.xml
diff --git a/jetty-plus/src/main/config/modules/plus.mod b/jetty-plus/src/main/config/modules/plus.mod
index b781f00bf2..d8dee1e95e 100644
--- a/jetty-plus/src/main/config/modules/plus.mod
+++ b/jetty-plus/src/main/config/modules/plus.mod
@@ -1,5 +1,5 @@
 #
-# Jetty Proxy module
+# Jetty Plus module
 #
 
 [depend]
@@ -11,5 +11,4 @@ jndi
 lib/jetty-plus-${jetty.version}.jar
 
 [xml]
-# Plus requires configuration
 etc/jetty-plus.xml
diff --git a/jetty-proxy/src/main/config/modules/proxy.mod b/jetty-proxy/src/main/config/modules/proxy.mod
index 7873329afa..9486a83943 100644
--- a/jetty-proxy/src/main/config/modules/proxy.mod
+++ b/jetty-proxy/src/main/config/modules/proxy.mod
@@ -10,5 +10,4 @@ client
 lib/jetty-proxy-${jetty.version}.jar
 
 [xml]
-# Proxy requires configuration
 etc/jetty-proxy.xml
diff --git a/jetty-rewrite/src/main/config/modules/rewrite.mod b/jetty-rewrite/src/main/config/modules/rewrite.mod
index 85fe5f090d..d2e00c8e89 100644
--- a/jetty-rewrite/src/main/config/modules/rewrite.mod
+++ b/jetty-rewrite/src/main/config/modules/rewrite.mod
@@ -9,5 +9,4 @@ server
 lib/jetty-rewrite-${jetty.version}.jar
 
 [xml]
-# Annotations needs annotations configuration
 etc/jetty-rewrite.xml
diff --git a/jetty-server/src/main/config/modules/continuation.mod b/jetty-server/src/main/config/modules/continuation.mod
index 2ca78b57de..231c09d0f3 100644
--- a/jetty-server/src/main/config/modules/continuation.mod
+++ b/jetty-server/src/main/config/modules/continuation.mod
@@ -1,4 +1,6 @@
-# Module to add Continuation jar to classpath
+#
+# Classic Jetty Continuation Support Module
+#
 
 [lib]
-lib/jetty-continuation-${jetty.version}.jar
\ No newline at end of file
+lib/jetty-continuation-${jetty.version}.jar
diff --git a/jetty-server/src/main/config/modules/http.mod b/jetty-server/src/main/config/modules/http.mod
index 7588ce291e..c8a325f056 100644
--- a/jetty-server/src/main/config/modules/http.mod
+++ b/jetty-server/src/main/config/modules/http.mod
@@ -9,5 +9,6 @@ server
 etc/jetty-http.xml
 
 [ini-template]
+## HTTP Connector Configuration
 jetty.port=8080
 http.timeout=30000
diff --git a/jetty-server/src/main/config/modules/https.mod b/jetty-server/src/main/config/modules/https.mod
index c01652339b..7838ea6abd 100644
--- a/jetty-server/src/main/config/modules/https.mod
+++ b/jetty-server/src/main/config/modules/https.mod
@@ -9,5 +9,8 @@ ssl
 etc/jetty-https.xml
 
 [ini-template]
+## HTTPS Configuration
+# HTTP port to listen on
 https.port=8443
+# HTTPS idle timeout in milliseconds
 https.timeout=30000
diff --git a/jetty-server/src/main/config/modules/jvm.mod b/jetty-server/src/main/config/modules/jvm.mod
index 7f9dfb965c..195521c57f 100644
--- a/jetty-server/src/main/config/modules/jvm.mod
+++ b/jetty-server/src/main/config/modules/jvm.mod
@@ -1,17 +1,16 @@
 [ini-template]
-#===========================================================
-# Configure JVM arguments.
-# If JVM args are include in an ini file then --exec is needed
-# to start a new JVM from start.jar with the extra args.
-# If you wish to avoid an extra JVM running, place JVM args
-# on the normal command line and do not use --exec
-#-----------------------------------------------------------
+## JVM Configuration
+## If JVM args are include in an ini file then --exec is needed
+## to start a new JVM from start.jar with the extra args.
+##
+## If you wish to avoid an extra JVM running, place JVM args
+## on the normal command line and do not use --exec
 # --exec
 # -Xmx2000m
 # -Xmn512m
 # -XX:+UseConcMarkSweepGC
 # -XX:ParallelCMSThreads=2
-# -XX:+CMSClassUnloadingEnabled  
+# -XX:+CMSClassUnloadingEnabled
 # -XX:+UseCMSCompactAtFullCollection
 # -XX:CMSInitiatingOccupancyFraction=80
 # -verbose:gc
diff --git a/jetty-server/src/main/config/modules/lowresources.mod b/jetty-server/src/main/config/modules/lowresources.mod
index f743c642ca..99112d55fa 100644
--- a/jetty-server/src/main/config/modules/lowresources.mod
+++ b/jetty-server/src/main/config/modules/lowresources.mod
@@ -9,6 +9,7 @@ server
 etc/jetty-lowresources.xml
 
 [ini-template]
+## Low Resources Configuration
 # lowresources.period=1050
 # lowresources.lowResourcesIdleTimeout=200
 # lowresources.monitorThreads=true
diff --git a/jetty-server/src/main/config/modules/requestlog.mod b/jetty-server/src/main/config/modules/requestlog.mod
index 143811d7ec..43e1e004ed 100644
--- a/jetty-server/src/main/config/modules/requestlog.mod
+++ b/jetty-server/src/main/config/modules/requestlog.mod
@@ -12,9 +12,10 @@ etc/jetty-requestlog.xml
 logs/
 
 [ini-template]
+## Request Log Configuration
 # How many days to retain the logs
 # requestlog.retain=90
-# If an existing log with the same name is found, just append to it 
+# If an existing log with the same name is found, just append to it
 # requestlog.append=true
 # Use the extended log output
 # requestlog.extended=true
diff --git a/jetty-server/src/main/config/modules/server.mod b/jetty-server/src/main/config/modules/server.mod
index d096311b43..cdaf90440d 100644
--- a/jetty-server/src/main/config/modules/server.mod
+++ b/jetty-server/src/main/config/modules/server.mod
@@ -1,5 +1,5 @@
 #
-# Base server
+# Base Server Module
 #
 
 [optional]
@@ -18,15 +18,21 @@ lib/jetty-util-${jetty.version}.jar
 lib/jetty-io-${jetty.version}.jar
 
 [xml]
-# Annotations needs annotations configuration
 etc/jetty.xml
 
 [ini-template]
+## Server Threading Configuration
+# minimum number of threads
 threads.min=10
+# maximum number of threads
 threads.max=200
+# thread idle timeout in milliseconds
 threads.timeout=60000
+# What host to listen on (leave commented to listen on all interfaces)
 #jetty.host=myhost.com
+# Dump the state of the Jetty server, components, and webapps after startup
 jetty.dump.start=false
+# Dump the state of the Jetty server, before stop
 jetty.dump.stop=false
 
 
diff --git a/jetty-server/src/main/config/modules/ssl.mod b/jetty-server/src/main/config/modules/ssl.mod
index 325d5b8d33..915f472d89 100644
--- a/jetty-server/src/main/config/modules/ssl.mod
+++ b/jetty-server/src/main/config/modules/ssl.mod
@@ -1,5 +1,6 @@
-
+#
 # SSL Keystore module
+#
 
 [depend]
 server
@@ -11,6 +12,7 @@ etc/jetty-ssl.xml
 http://git.eclipse.org/c/jetty/org.eclipse.jetty.project.git/plain/jetty-server/src/main/config/etc/keystore:etc/keystore
 
 [ini-template]
+## SSL Keystore Configuration
 # define the port to use for secure redirection
 jetty.secure.port=8443
 
@@ -20,6 +22,7 @@ jetty.truststore=etc/keystore
 
 # Set the demonstration passwords.
 # Note that OBF passwords are not secure, just protected from casual observation
+# See http://www.eclipse.org/jetty/documentation/current/configuring-security-secure-passwords.html
 jetty.keystore.password=OBF:1vny1zlo1x8e1vnw1vn61x8g1zlu1vn4
 jetty.keymanager.password=OBF:1u2u1wml1z7s1z7a1wnl1u2g
 jetty.truststore.password=OBF:1vny1zlo1x8e1vnw1vn61x8g1zlu1vn4
diff --git a/jetty-spdy/spdy-http-server/src/main/config/modules/npn.mod b/jetty-spdy/spdy-http-server/src/main/config/modules/npn.mod
index ab4f462f3a..783f5d89e0 100644
--- a/jetty-spdy/spdy-http-server/src/main/config/modules/npn.mod
+++ b/jetty-spdy/spdy-http-server/src/main/config/modules/npn.mod
@@ -1,14 +1,16 @@
+#
+# NPN Module
+#
 
 [files]
 http://repo1.maven.org/maven2/org/mortbay/jetty/npn/npn-boot/1.1.6.v20130911/npn-boot-1.1.6.v20130911.jar:lib/npn/npn-boot-1.1.6.v20130911.jar
 
 [ini-template]
-
-# NPN boot jar for JRE 1.7.0_40
+# NPN Configuration
+# NPN boot jar for JRE 1.7.0_45
 --exec
 -Xbootclasspath/p:lib/npn/npn-boot-1.1.6.v20130911.jar
 
-
 # For other versions of JRE, an appropriate npn-boot jar must be downloaded
 #
 # 1.7.0 - 1.7.0u2 - 1.7.0u3                   http://repo1.maven.org/maven2/org/mortbay/jetty/npn/npn-boot/1.0.0.v20120402/npn-boot-1.0.0.v20120402.jar
@@ -18,6 +20,7 @@ http://repo1.maven.org/maven2/org/mortbay/jetty/npn/npn-boot/1.1.6.v20130911/npn
 # 1.7.0u13                                    http://repo1.maven.org/maven2/org/mortbay/jetty/npn/npn-boot/1.1.4.v20130313/npn-boot-1.1.4.v20130313.jar
 # 1.7.0u15 - 1.7.0u17 - 1.7.0u21 - 1.7.0u25   http://repo1.maven.org/maven2/org/mortbay/jetty/npn/npn-boot/1.1.5.v20130313/npn-boot-1.1.5.v20130313.jar
 # 1.7.0u40                                    http://repo1.maven.org/maven2/org/mortbay/jetty/npn/npn-boot/1.1.6.v20130911/npn-boot-1.1.6.v20130911.jar
+# 1.7.0u45                                    http://repo1.maven.org/maven2/org/mortbay/jetty/npn/npn-boot/1.1.6.v20130911/npn-boot-1.1.6.v20130911.jar
 #
 # Then edit the -Xbootclasspath line above with the correct version
 
diff --git a/jetty-spdy/spdy-http-server/src/main/config/modules/spdy.mod b/jetty-spdy/spdy-http-server/src/main/config/modules/spdy.mod
index 67019561d7..eab614bfb9 100644
--- a/jetty-spdy/spdy-http-server/src/main/config/modules/spdy.mod
+++ b/jetty-spdy/spdy-http-server/src/main/config/modules/spdy.mod
@@ -1,3 +1,7 @@
+#
+# SPDY Support Module
+#
+
 [depend]
 ssl
 npn
@@ -10,6 +14,10 @@ etc/jetty-ssl.xml
 etc/jetty-spdy.xml
 
 [ini-template]
+## SPDY Configuration
+# Port for SPDY connections
 spdy.port=8443
+# SPDY idle timeout in milliseconds
 spdy.timeout=30000
+# Initial Window Size for SPDY
 #spdy.initialWindowSize=65536
diff --git a/jetty-util/src/main/config/modules/logging.mod b/jetty-util/src/main/config/modules/logging.mod
index 3296369389..f72863d1f2 100644
--- a/jetty-util/src/main/config/modules/logging.mod
+++ b/jetty-util/src/main/config/modules/logging.mod
@@ -3,9 +3,9 @@
 #
 
 [xml]
-
 etc/jetty-logging.xml
 
 [ini-template]
+## STDERR / STDOUT Logging
 # Number of days to retain logs
 # jetty.log.retain=90
diff --git a/jetty-webapp/src/main/config/modules/webapp.mod b/jetty-webapp/src/main/config/modules/webapp.mod
index f62c554555..43ce06ec32 100644
--- a/jetty-webapp/src/main/config/modules/webapp.mod
+++ b/jetty-webapp/src/main/config/modules/webapp.mod
@@ -1,5 +1,5 @@
 #
-# Base server
+# WebApp Support Module
 #
 
 [depend]
diff --git a/jetty-websocket/javax-websocket-server-impl/src/main/config/modules/websocket.mod b/jetty-websocket/javax-websocket-server-impl/src/main/config/modules/websocket.mod
index 481bdfaaf1..e866b17989 100644
--- a/jetty-websocket/javax-websocket-server-impl/src/main/config/modules/websocket.mod
+++ b/jetty-websocket/javax-websocket-server-impl/src/main/config/modules/websocket.mod
@@ -1,13 +1,12 @@
 #
-# WebSocket Feature
+# WebSocket Module
 #
 
 [depend]
-# WebSocket needs Annotations feature
+# javax.websocket needs annotations
 annotations
 
 [lib]
-# WebSocket needs websocket jars (as defined in start.config)
 lib/websocket/*.jar
 
 
-- 
cgit v1.2.3