Skip to content

Commit 60f4851

Browse files
committed
Merge branch 'jt/doc-pack-objects-fix' into maint
Doc updates. * jt/doc-pack-objects-fix: Doc: clarify that pack-objects makes packs, plural
2 parents 8134746 + 4a4becf commit 60f4851

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

Documentation/git-pack-objects.txt

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@ SYNOPSIS
1818

1919
DESCRIPTION
2020
-----------
21-
Reads list of objects from the standard input, and writes a packed
22-
archive with specified base-name, or to the standard output.
21+
Reads list of objects from the standard input, and writes either one or
22+
more packed archives with the specified base-name to disk, or a packed
23+
archive to the standard output.
2324

2425
A packed archive is an efficient way to transfer a set of objects
2526
between two repositories as well as an access efficient archival
@@ -47,9 +48,9 @@ transport by their peers.
4748
OPTIONS
4849
-------
4950
base-name::
50-
Write into a pair of files (.pack and .idx), using
51+
Write into pairs of files (.pack and .idx), using
5152
<base-name> to determine the name of the created file.
52-
When this option is used, the two files are written in
53+
When this option is used, the two files in a pair are written in
5354
<base-name>-<SHA-1>.{pack,idx} files. <SHA-1> is a hash
5455
based on the pack content and is written to the standard
5556
output of the command.
@@ -108,9 +109,13 @@ base-name::
108109
is taken from the `pack.windowMemory` configuration variable.
109110

110111
--max-pack-size=<n>::
111-
Maximum size of each output pack file. The size can be suffixed with
112+
In unusual scenarios, you may not be able to create files
113+
larger than a certain size on your filesystem, and this option
114+
can be used to tell the command to split the output packfile
115+
into multiple independent packfiles, each not larger than the
116+
given size. The size can be suffixed with
112117
"k", "m", or "g". The minimum size allowed is limited to 1 MiB.
113-
If specified, multiple packfiles may be created, which also
118+
This option
114119
prevents the creation of a bitmap index.
115120
The default is unlimited, unless the config variable
116121
`pack.packSizeLimit` is set.

0 commit comments

Comments
 (0)