Re: [PATCH] doc: mention bigFileThreshold for packing

Christian Walther [off-list ref] writes:

Junio C Hamano wrote:

quoted

I doubt that the description of --window/--depth command line
options, for both repack and pack-objects, is the best place to add
this "Note".  Even if we were to add it as an appendix to these
places, please do not break the flow of explanation by inserting it
before the description of the default values of these options.

OK. That was where I would have looked for it, because it explains
why --window wasn't effective in my attempts to get better
compression, but I don't insist on it - any place would have
worked, as I read both manpages back and forth several times.

The "pack-objects" command (and to some degree "repack", too) is
about packing throughout, and --depth/--window is not necessarily
the central piece of the puzzle, and that, together with disruption
of the flow of the original explanation, was the reason why I found
the initial location a bit odd.

In git-repack.txt, there is a "Configuration" section at the
bottom, I guess it would fit there? There is none in
git-pack-objects.txt, but I could add it. What do you think?

You're right---if there is an existing CONFIGURATION section, that
may be a much better place.  There are configuration variables that
affect how the packing works other than the core.bigFileThreshold,
and attributes like "delta" would also affect the outcome.

Describing all in one CONFIGURATION section would be valuable.

What I queued is with the following ready to be squashed in,
primarily because I was lazy and didn't have time/inclination to
look for a better place myself ;-)

Thanks.

---- >8 ----
Subject: [PATCH] fixup! doc: mention bigFileThreshold for packing

---
 Documentation/git-pack-objects.txt | 7 +++----
 Documentation/git-repack.txt       | 7 +++----
 2 files changed, 6 insertions(+), 8 deletions(-)

diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
index 59150ded4b..be0f953c35 100644
--- a/Documentation/git-pack-objects.txt
+++ b/Documentation/git-pack-objects.txt

@@ -97,12 +97,11 @@ base-name::
 	side, because delta data needs to be applied that many
 	times to get to the necessary object.
 +
-Note that delta compression is never used on objects larger than the
-`core.bigFileThreshold` configuration variable (see
-linkgit:git-config[1]).
-+
 The default value for --window is 10 and --depth is 50. The maximum
 depth is 4095.
++
+Note that delta compression is never used on objects larger than the
+`core.bigFileThreshold` configuration variable (see linkgit:git-config[1]).
 
 --window-memory=<n>::
 	This option provides an additional limit on top of `--window`;

diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt
index 0a7038ec4a..145fff6e01 100644
--- a/Documentation/git-repack.txt
+++ b/Documentation/git-repack.txt

@@ -96,12 +96,11 @@ to the new separate pack will be written.
 	affects the performance on the unpacker side, because delta data needs
 	to be applied that many times to get to the necessary object.
 +
-Note that delta compression is never used on objects larger than the
-`core.bigFileThreshold` configuration variable (see
-linkgit:git-config[1]).
-+
 The default value for --window is 10 and --depth is 50. The maximum
 depth is 4095.
++
+Note that delta compression is never used on objects larger than the
+`core.bigFileThreshold` configuration variable (see linkgit:git-config[1]).
 
 --threads=<n>::
 	This option is passed through to `git pack-objects`.

-- 
2.30.1-597-g82b686dd6a