Updated settings documentation (issue-352)

Change-Id: I3c2281881a74e549aa68c7af46c29422f3ae21bd

diff --git a/src/main/distrib/data/gitblit.properties b/src/main/distrib/data/gitblit.properties
index 78717bb225c667452dcfca3ade79d69b1586a56f..b9e6e06a1fe68d4fa61c74b3953b09bec99fb71e 100644 (file)
--- 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.\r
 # Documentation courtesy of the Gerrit project.\r
 #\r
+#\r
+# NOTE: The importance of JGit's streamFileTreshold AND Git's bigFileThreshold\r
+# ISSUE: https://bugs.eclipse.org/bugs/show_bug.cgi?id=394078\r
+#\r
+# "core.bigFileThreshold  \r
+#\r
+#    Files larger than this size are stored deflated, without\r
+#    attempting delta compression.  Storing large files without\r
+#    delta compression avoids excessive memory usage, at the\r
+#    slight expense of increased disk usage.\r
+#\r
+#  Default is 512 MiB on all platforms.\r
+#  This should be reasonable for most projects as source code and other \r
+#  text files can still be delta compressed, \r
+#  but larger binary media files won't be."\r
+#  -- Git documentation\r
+#\r
+# If streamFileTreshold < bigFileTreshold you _may_ spend alot of time waiting\r
+# for push and/or fetch to complete.  It may even look hung.\r
+#\r
+# Until the issue is resolved gracefully, a workaround is to configure\r
+# bigFileThreshold < streamFileTreshold AND then repack the repository.\r
+#\r
+# e.g. from the repository folder with Gitblit NOT running:\r
+#     git config core.bigFileTreshold 40m\r
+#     git gc --aggressive\r
+#\r
 # SINCE 1.0.0\r
 # RESTART REQUIRED\r
 git.streamFileThreshold = 50m\r