From 1f9daef870a8c7a984955166a542628d69012ed5 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Fri, 27 May 2011 23:37:24 -0400
Subject: [PATCH] Codepro analyze dependencies. Documentation.

---
 distrib/gitblit.properties |   52 ++++++++++++++++++++++++++++++++++++++++------------
 1 files changed, 40 insertions(+), 12 deletions(-)

diff --git a/distrib/gitblit.properties b/distrib/gitblit.properties
index 4e2965f..c17674a 100644
--- a/distrib/gitblit.properties
+++ b/distrib/gitblit.properties
@@ -3,18 +3,22 @@
 #
 
 # Allow push/pull over http/https with JGit servlet
+# Changing this value requires a server restart.
 git.enableGitServlet = true
 
 # Base folder for repositories
+# Changing this value requires a server restart.
 # Use forward slashes even on Windows!!
+# e.g. c:/gitrepos
 git.repositoriesFolder = git
 
 # Export all repositories
+# Changing this value requires a server restart.
 # if false, each exported repository must have a .git/git-daemon-export-ok file
 git.exportAll = true
 
 # Search repositories folder for nested repositories
-# e.g. /libraries/mylibrary.git
+# e.g. c:/gitrepos/libraries/mylibrary.git
 git.nestedRepositories = true
 
 #
@@ -22,12 +26,15 @@
 #
 
 # Require authentication to see everything but the admin pages
+# Changing this value requires a server restart.
 web.authenticateViewPages = false
 
 # Require admin authentication for the admin functions and pages
+# Changing this value requires a server restart.
 web.authenticateAdminPages = true
 
 # Simple user realm file to authenticate users
+# Changing this value requires a server restart.
 realm.realmFile = users.properties
 
 # How to store passwords.
@@ -44,10 +51,11 @@
 # If blank Gitblit is displayed.
 web.siteName =
 
-# If web.authenticate=true, users with "admin" role can create repositories,
-# create users, and edit repository metadata (owner, description, etc)
+# If web.authenticateAdminPages=true, users with "admin" role can create
+# repositories, create users, and edit repository metadata.
 #
-# If web.authenticate=false, any user can execute the aforementioned functions.  
+# If web.authenticateAdminPages=false, any user can execute the aforementioned
+# functions.  
 web.allowAdministration = true
 
 # Allow dyanamic zip downloads.   
@@ -60,20 +68,23 @@
 
 # Use the client timezone when formatting dates.
 # This uses AJAX to determine the browser's timezone.
+# Changing this value requires a server restart.
 web.useClientTimezone = false
 
 # Date and Time formats
+# http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html
 web.datestampShortFormat = yyyy-MM-dd
 web.datetimestampLongFormat = EEEE, MMMM d, yyyy h:mm a z
 
 # Show other URLs on the summary page for accessing your git repositories
 # Use spaces to separate urls. {0} is the token for the repository name.
+# e.g.
 # web.otherUrls = ssh://localhost/git/{0} git://localhost/git/{0}
 web.otherUrls = 
 
 # Choose how to present the repositories list.
-# grouped = group nested/subfolder repositories together (no sorting)
-# flat = flat list of repositories (sorting allowed)
+#   grouped = group nested/subfolder repositories together (no sorting)
+#   flat = flat list of repositories (sorting allowed)
 web.repositoryListType = grouped
 
 # If using a grouped repository list and there are repositories at the
@@ -92,7 +103,7 @@
 web.showSearchTypeSelection = false
 
 # Generates a line graph of repository activity over time on the Summary page.
-# This is a real-time graph so generation may be expensive. 
+# This uses the Google Charts API. 
 web.generateActivityGraph = true
 
 # The number of commits to display on the summary page
@@ -108,22 +119,27 @@
 web.itemsPerPage = 50
 
 # Registered extensions for google-code-prettify
+# (case-insensitive)
 web.prettyPrintExtensions = c cpp cs css htm html java js php pl prefs properties py rb sh sql xml vb
 
 # Registered extensions for markdown transformation
-web.markdownExtensions = md mkd markdown
+# (CASE-SENSITIVE)
+web.markdownExtensions = md mkd markdown MD MKD
 
 # Image extensions
+# (case-insensitive)
 web.imageExtensions = bmp jpg gif png 
 
 # Registered extensions for binary blobs
+# (case-insensitive)
 web.binaryExtensions = jar pdf tar.gz zip
 
 # Aggressive heap management will run the garbage collector on every generated
-# page.  This slows down page generation but improves heap consumption. 
+# page.  This slows down page generation a little but improves heap consumption. 
 web.aggressiveHeapManagement = true
 
 # Run the webapp in debug mode
+# Changing this value requires a server restart.
 web.debugMode = false
 
 # Enable/disable global regex substitutions (i.e. shared across repositories)
@@ -141,9 +157,21 @@
 #
 # Server Settings
 #
+# Changing any of these values requires a server restart.
+
+# The temporary folder to decompress the gitblit webapp. 
 server.tempFolder = temp
+
+# The common log4j logging pattern
+# http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/PatternLayout.html
 server.log4jPattern = %-5p %d{MM-dd HH:mm:ss.SSS}  %-20.20c{1}  %m%n
+
+# Alternatively, you may specify a logging pattern for your OS.
+# If the os pattern is blank, the common pattern is used.
+
+# This windows pattern fits (mostly) within the fixed bounds of a command prompt.
 server.log4jPattern.windows = %-5p %m%n
+
 server.log4jPattern.linux =
 
 
@@ -162,13 +190,13 @@
 
 # Specify the interface for Jetty to bind the standard connector.
 # You may specify an ip or an empty value to bind to all interfaces.
-# Specifying localhost will result in Git:Blit ONLY listening to requests to
+# Specifying localhost will result in Gitblit ONLY listening to requests to
 # localhost.
 server.httpBindInterface = localhost
 
 # Specify the interface for Jetty to bind the secure connector.
 # You may specify an ip or an empty value to bind to all interfaces.
-# Specifying localhost will result in Git:Blit ONLY listening to requests to
+# Specifying localhost will result in Gitblit ONLY listening to requests to
 # localhost.
 server.httpsBindInterface = localhost
 
@@ -176,7 +204,7 @@
 # Keystore password and certificate password must match.
 # This is provided for convenience, its probably more secure to set this value
 # using the --storePassword command line parameter.
-server.storePassword = dosomegit
+server.storePassword = gitblit
 
 # Port for shutdown monitor to listen on.
 server.shutdownPort = 8081

--
Gitblit v1.9.1