[PATCH] Doc: clarify that pack-objects makes packs, plural
- From
- Jonathan Tan <jonathantanmy@google.com>
- Date
- Aug 22, 2017, 18:22 UTC
- Message-ID
- <20170822182242.20862-1-jonathantanmy@google.com>
The documentation for pack-objects describes that it creates "a packed archive of objects", which is confusing because it may create multiple packs if --max-pack-size is set. Update the documentation to clarify this.
Signed-off-by: Jonathan Tan <jonathantanmy@google.com> --- It took me quite some time before I realized that pack-objects actually may write multiple packs, the opening lines of the doc confusing me. Here's a doc update. --- Documentation/git-pack-objects.txt | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt index 8973510a4..d8264ad57 100644 --- a/Documentation/git-pack-objects.txt +++ b/Documentation/git-pack-objects.txt @@ -3,7 +3,7 @@ git-pack-objects(1) NAME ---- -git-pack-objects - Create a packed archive of objects +git-pack-objects - Create packed archives of objects SYNOPSIS @@ -18,8 +18,9 @@ SYNOPSIS DESCRIPTION ----------- -Reads list of objects from the standard input, and writes a packed -archive with specified base-name, or to the standard output. +Reads list of objects from the standard input, and writes either one or +more packed archives with the specified base-name to disk, or a packed +archive to the standard output. A packed archive is an efficient way to transfer a set of objects between two repositories as well as an access efficient archival @@ -47,9 +48,9 @@ transport by their peers. OPTIONS ------- base-name:: - Write into a pair of files (.pack and .idx), using + Write into pairs of files (.pack and .idx), using <base-name> to determine the name of the created file. - When this option is used, the two files are written in + When this option is used, the two files in a pair are written in <base-name>-<SHA-1>.{pack,idx} files. <SHA-1> is a hash based on the pack content and is written to the standard output of the command.
-- 2.14.1.342.g6490525c54-goog