Updated settings documentation (issue-352)

Change-Id: I3c2281881a74e549aa68c7af46c29422f3ae21bd

1 files changed, 27 insertions, 0 deletions

diff --git a/src/main/distrib/data/gitblit.properties b/src/main/distrib/data/gitblit.properties
index 78717bb2..b9e6e06a 100644
--- a/src/main/distrib/data/gitblit.properties
+++ b/src/main/distrib/data/gitblit.properties
@@ -381,6 +381,33 @@ git.packedGitOpenFiles = 128
 # Common unit suffixes of k, m, or g are supported.

 # Documentation courtesy of the Gerrit project.

 #

+#

+# NOTE: The importance of JGit's streamFileTreshold AND Git's bigFileThreshold

+# ISSUE: https://bugs.eclipse.org/bugs/show_bug.cgi?id=394078

+#

+# "core.bigFileThreshold  

+#

+#    Files larger than this size are stored deflated, without

+#    attempting delta compression.  Storing large files without

+#    delta compression avoids excessive memory usage, at the

+#    slight expense of increased disk usage.

+#

+#  Default is 512 MiB on all platforms.

+#  This should be reasonable for most projects as source code and other 

+#  text files can still be delta compressed, 

+#  but larger binary media files won't be."

+#  -- Git documentation

+#

+# If streamFileTreshold < bigFileTreshold you _may_ spend alot of time waiting

+# for push and/or fetch to complete.  It may even look hung.

+#

+# Until the issue is resolved gracefully, a workaround is to configure

+# bigFileThreshold < streamFileTreshold AND then repack the repository.

+#

+# e.g. from the repository folder with Gitblit NOT running:

+#     git config core.bigFileTreshold 40m

+#     git gc --aggressive

+#

 # SINCE 1.0.0

 # RESTART REQUIRED

 git.streamFileThreshold = 50m