diff mbox series

[v4,1/3] docs: clarify git-pack-refs --all will pack all refs

Message ID 554da1dc705f437c4822b9bc5c8b604abf1e6144.1683927282.git.gitgitgadget@gmail.com (mailing list archive)
State Accepted
Commit 283174b214c4c5416772dcacbc6389dd192969a0
Headers show
Series pack-refs: allow users control over which refs to pack | expand

Commit Message

John Cai May 12, 2023, 9:34 p.m. UTC 
From: John Cai <johncai86@gmail.com>

--all packs not just branch tips but anything under refs/ with the
exception of hidden refs and broken refs. Clarify this in the
documentation.

Signed-off-by: John Cai <johncai86@gmail.com>
---
 Documentation/git-pack-refs.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/Documentation/git-pack-refs.txt b/Documentation/git-pack-refs.txt
index 154081f2de2..22f00665006 100644
--- a/Documentation/git-pack-refs.txt
+++ b/Documentation/git-pack-refs.txt
@@ -51,8 +51,9 @@  The command by default packs all tags and refs that are already
 packed, and leaves other refs
 alone.  This is because branches are expected to be actively
 developed and packing their tips does not help performance.
-This option causes branch tips to be packed as well.  Useful for
-a repository with many branches of historical interests.
+This option causes all refs to be packed as well, with the exception
+of hidden refs, broken refs, and symbolic refs. Useful for a repository
+with many branches of historical interests.
 
 --no-prune::