diff mbox series

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

Message ID 0b40b24b95d81cbc956eb4c7761e043c16a00be0.1683659931.git.gitgitgadget@gmail.com (mailing list archive)
State New, archived
Headers show
Series pack-refs: Teach --exclude option to exclude refs from being packed | expand

Commit Message

John Cai May 9, 2023, 7:18 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 | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
diff mbox series

Patch

diff --git a/Documentation/git-pack-refs.txt b/Documentation/git-pack-refs.txt
index 154081f2de2..e011e5fead3 100644
--- a/Documentation/git-pack-refs.txt
+++ b/Documentation/git-pack-refs.txt
@@ -49,10 +49,11 @@  OPTIONS
 
 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
+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
+and broken refs. Useful for a repository with many branches of historical
+interests.
 
 --no-prune::