Merge branch 'jb/doc-packfile-name' into master

[thirdparty/git.git] / Documentation / git-index-pack.txt

diff --git a/Documentation/git-index-pack.txt b/Documentation/git-index-pack.txt
index d5b7560bfe2d51370c313ee006a9f0ed4388eda4..ac74d058e01d13830b276616dce25d5745b64699 100644 (file)
--- a/Documentation/git-index-pack.txt
+++ b/Documentation/git-index-pack.txt
@@ -93,11 +93,19 @@ OPTIONS
 --max-input-size=<size>::
        Die, if the pack is larger than <size>.
 
+--object-format=<hash-algorithm>::
+       Specify the given object format (hash algorithm) for the pack.  The valid
+       values are 'sha1' and (if enabled) 'sha256'.  The default is the algorithm for
+       the current repository (set by `extensions.objectFormat`), or 'sha1' if no
+       value is set or outside a repository.
++
+This option cannot be used with --stdin.
+
 NOTES
 -----
 
-Once the index has been created, the list of object names is sorted
-and the SHA-1 hash of that list is printed to stdout. If --stdin was
+Once the index has been created, the hash that goes into the name of
+the pack/idx file is printed to stdout. If --stdin was
 also used then this is prefixed by either "pack\t", or "keep\t" if a
 new .keep file was successfully created. This is useful to remove a
 .keep file used as a lock to prevent the race with 'git repack'