[PATCH] Document git-svn fetch --log-window-size parameter

The --log-window-size parameter to git-svn fetch is undocumented.

Minimally describe what it does and why the user might change it.

Signed-off-by: Gunnlaugur Þór Briem <redacted>
---
 Documentation/git-svn.txt | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index cfe8d2b..64756c9 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt

@@ -146,6 +146,12 @@ Skip "branches" and "tags" of first level directories;;
 ------------------------------------------------------------------------
 --
 
+--log-window-size=<n>;;
+    Fetch <n> log entries per request when scanning Subversion history.
+    The default is 100. For very large Subversion repositories, larger
+    values may be needed for 'clone'/'fetch' to complete in reasonable
+    time. But overly large values may lead to request timeouts.
+
 'clone'::
 	Runs 'init' and 'fetch'.  It will automatically create a
 	directory based on the basename of the URL passed to it;

-- 
1.7.12.3

On Tue, Oct 23, 2012 at 10:33:26AM +0000, Gunnlaugur Þór Briem wrote:

The --log-window-size parameter to git-svn fetch is undocumented.

Minimally describe what it does and why the user might change it.

Thanks. Your description makes sense to me, but I do not have enough
git-svn knowledge to know if it covers all intended uses of the flag.
Eric?

+--log-window-size=<n>;;
+    Fetch <n> log entries per request when scanning Subversion history.
+    The default is 100. For very large Subversion repositories, larger
+    values may be needed for 'clone'/'fetch' to complete in reasonable
+    time. But overly large values may lead to request timeouts.

-Peff

Jeff King [off-list ref] wrote:

On Tue, Oct 23, 2012 at 10:33:26AM +0000, Gunnlaugur Þór Briem wrote:

quoted

The --log-window-size parameter to git-svn fetch is undocumented.

Minimally describe what it does and why the user might change it.

Thanks. Your description makes sense to me, but I do not have enough
git-svn knowledge to know if it covers all intended uses of the flag.
Eric?

quoted

+--log-window-size=<n>;;
+    Fetch <n> log entries per request when scanning Subversion history.
+    The default is 100. For very large Subversion repositories, larger
+    values may be needed for 'clone'/'fetch' to complete in reasonable
+    time. But overly large values may lead to request timeouts.

Overly large values also lead to excessive memory usage.  I may have
only had 256M in my dev machine at the time I added this parameter:

  commit 6af1db447b10c03db4c04a55000efaa9aad38caa
  Author: Eric Wong [off-list ref]
  Date:   Wed Feb 14 16:04:10 2007 -0800

      git-svn: allow --log-window-size to be specified, default to 100
      
      The newer default value should should lower memory usage for
      large fetches and also help with fetching from less reliable
      servers.  Previously the value was 1000 and memory usage
      got a bit high on some repositories and fetching became
      less reliable in some cases.
      
      Signed-off-by: Eric Wong [off-list ref]

On Fri, Oct 26, 2012 at 09:46:02AM +0000, Eric Wong wrote:

quoted

Thanks. Your description makes sense to me, but I do not have enough
git-svn knowledge to know if it covers all intended uses of the flag.
Eric?

quoted

+--log-window-size=<n>;;
+    Fetch <n> log entries per request when scanning Subversion history.
+    The default is 100. For very large Subversion repositories, larger
+    values may be needed for 'clone'/'fetch' to complete in reasonable
+    time. But overly large values may lead to request timeouts.

Overly large values also lead to excessive memory usage.  I may have
only had 256M in my dev machine at the time I added this parameter:

That's probably worth mentioning. Gunnlaugur, any objection to me
amending your commit with:

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 64756c9..8b0d3ad 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt

@@ -150,7 +150,8 @@ Skip "branches" and "tags" of first level directories;;
     Fetch <n> log entries per request when scanning Subversion history.
     The default is 100. For very large Subversion repositories, larger
     values may be needed for 'clone'/'fetch' to complete in reasonable
-    time. But overly large values may lead to request timeouts.
+    time. But overly large values may lead to higher memory usage and
+    request timeouts.
 
 'clone'::
 	Runs 'init' and 'fetch'.  It will automatically create a

?

-Peff

On Fri, Oct 26, 2012 at 1:32 PM, Jeff King [off-list ref] wrote:

No objection, that sounds fine to me.

-Gulli

Jeff King [off-list ref] wrote:

On Fri, Oct 26, 2012 at 09:46:02AM +0000, Eric Wong wrote:

quoted

Overly large values also lead to excessive memory usage.  I may have
only had 256M in my dev machine at the time I added this parameter:

That's probably worth mentioning. Gunnlaugur, any objection to me
amending your commit with:

Thanks both, I've amended and S-o-b on my end.  Shall I add:
Signed-off-by: Jeff King <redacted>

and push?

On Mon, Oct 29, 2012 at 08:18:47PM +0000, Eric Wong wrote:

Jeff King [off-list ref] wrote:

quoted

On Fri, Oct 26, 2012 at 09:46:02AM +0000, Eric Wong wrote:

quoted

Overly large values also lead to excessive memory usage.  I may have
only had 256M in my dev machine at the time I added this parameter:

That's probably worth mentioning. Gunnlaugur, any objection to me
amending your commit with:

Thanks both, I've amended and S-o-b on my end.  Shall I add:
Signed-off-by: Jeff King <redacted>

Since it was such a small topic, I just went ahead and queued bc22b27 in
my repo. If that's not OK, I can revert it from 'next' and wait to get
it by pulling from you.

-Peff

Jeff King [off-list ref] wrote:

Since it was such a small topic, I just went ahead and queued bc22b27 in
my repo. If that's not OK, I can revert it from 'next' and wait to get
it by pulling from you.

That's fine, thanks!