From: "Christian Walther via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Christian Walther <cwalther@gmx.ch>, Christian Walther <cwalther@gmx.ch>
Subject: [PATCH v2] doc: mention bigFileThreshold for packing
Date: Sun, 21 Feb 2021 13:23:57 +0000 [thread overview]
Message-ID: <pull.872.v2.git.1613913838248.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.872.git.1612897624121.gitgitgadget@gmail.com>
From: Christian Walther <cwalther@gmx.ch>
Knowing about the core.bigFileThreshold configuration variable is
helpful when examining pack file size differences between repositories.
Add a reference to it to the manpages a user is likely to read in this
situation.
Capitalize CONFIGURATION for consistency with other pages having such a
section.
Signed-off-by: Christian Walther <cwalther@gmx.ch>
---
doc: mention bigFileThreshold for packing
I recently spent a lot of time trying to figure out why git repack would
create huge packs on some clones of my repository and small ones on
others, until I found out about the existence of the
core.bigFileThreshold configuration variable, which happened to be set
on some and not on others. It would have saved me a lot of time if that
variable had been mentioned in the relevant manpages that I was reading,
git-repack and git-pack-objects. So this patch adds that.
Changes in v2:
* Move additions to the CONFIGURATION section at the bottom.
* Reword a little after realizing that there are more configuration
variables affecting packing.
* Capitalize CONFIGURATION for consistency with other pages having such
a section.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-872%2Fcwalther%2Fdeltadoc-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-872/cwalther/deltadoc-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/872
Range-diff vs v1:
1: 20b9a56d94b7 < -: ------------ doc: mention bigFileThreshold for packing
-: ------------ > 1: 027d1038fbb1 doc: mention bigFileThreshold for packing
Documentation/git-pack-objects.txt | 11 +++++++++++
Documentation/git-repack.txt | 9 ++++++++-
2 files changed, 19 insertions(+), 1 deletion(-)
diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
index 54d715ead137..f85cb7ea934c 100644
--- a/Documentation/git-pack-objects.txt
+++ b/Documentation/git-pack-objects.txt
@@ -400,6 +400,17 @@ Note that we pick a single island for each regex to go into, using "last
one wins" ordering (which allows repo-specific config to take precedence
over user-wide config, and so forth).
+
+CONFIGURATION
+-------------
+
+Various configuration variables affect packing, see
+linkgit:git-config[1] (search for "pack" and "delta").
+
+Notably, delta compression is not used on objects larger than the
+`core.bigFileThreshold` configuration variable and on files with the
+attribute `delta` set to false.
+
SEE ALSO
--------
linkgit:git-rev-list[1]
diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt
index 92f146d27dc3..fbd4b4ae0677 100644
--- a/Documentation/git-repack.txt
+++ b/Documentation/git-repack.txt
@@ -165,9 +165,12 @@ depth is 4095.
Pass the `--delta-islands` option to `git-pack-objects`, see
linkgit:git-pack-objects[1].
-Configuration
+CONFIGURATION
-------------
+Various configuration variables affect packing, see
+linkgit:git-config[1] (search for "pack" and "delta").
+
By default, the command passes `--delta-base-offset` option to
'git pack-objects'; this typically results in slightly smaller packs,
but the generated packs are incompatible with versions of Git older than
@@ -178,6 +181,10 @@ need to set the configuration variable `repack.UseDeltaBaseOffset` to
is unaffected by this option as the conversion is performed on the fly
as needed in that case.
+Delta compression is not used on objects larger than the
+`core.bigFileThreshold` configuration variable and on files with the
+attribute `delta` set to false.
+
SEE ALSO
--------
linkgit:git-pack-objects[1]
base-commit: 2283e0e9af55689215afa39c03beb2315ce18e83
--
gitgitgadget
prev parent reply other threads:[~2021-02-21 13:27 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-09 19:07 [PATCH] doc: mention bigFileThreshold for packing Christian Walther via GitGitGadget
2021-02-09 21:50 ` Junio C Hamano
2021-02-10 21:43 ` Christian Walther
2021-02-10 22:19 ` Junio C Hamano
2021-02-21 13:23 ` Christian Walther via GitGitGadget [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=pull.872.v2.git.1613913838248.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=cwalther@gmx.ch \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).