summaryrefslogtreecommitdiff
path: root/Documentation/git-cat-file.txt
diff options
context:
space:
mode:
authorAdam Roben <aroben@apple.com>2008-04-23 15:17:46 -0400
committerJunio C Hamano <gitster@pobox.com>2008-05-05 21:17:32 -0700
commit05d5667fec9650b049f47edd8cca23a43b135365 (patch)
tree1d7e42cd7e960d31bca1e73d91105b473f51c205 /Documentation/git-cat-file.txt
parent4814dbe830baf5a72d8abbbfcc60eeea478b47c2 (diff)
downloadgit-05d5667fec9650b049f47edd8cca23a43b135365.tar.gz
git-cat-file: Add --batch-check option
This new option allows multiple objects to be specified on stdin. For each object specified, a line of the following form is printed: <sha1> SP <type> SP <size> LF If the object does not exist in the repository, a line of the following form is printed: <object> SP missing LF Signed-off-by: Adam Roben <aroben@apple.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-cat-file.txt')
-rw-r--r--Documentation/git-cat-file.txt31
1 files changed, 26 insertions, 5 deletions
diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt
index df42cb10f2..d5821af309 100644
--- a/Documentation/git-cat-file.txt
+++ b/Documentation/git-cat-file.txt
@@ -9,12 +9,16 @@ git-cat-file - Provide content or type/size information for repository objects
SYNOPSIS
--------
'git-cat-file' [-t | -s | -e | -p | <type>] <object>
+'git-cat-file' --batch-check < <list-of-objects>
DESCRIPTION
-----------
-Provides content or type of objects in the repository. The type
-is required unless '-t' or '-p' is used to find the object type,
-or '-s' is used to find the object size.
+In the first form, provides content or type of objects in the repository. The
+type is required unless '-t' or '-p' is used to find the object type, or '-s'
+is used to find the object size.
+
+In the second form, a list of object (separated by LFs) is provided on stdin,
+and the SHA1, type, and size of each object is printed on stdout.
OPTIONS
-------
@@ -46,6 +50,10 @@ OPTIONS
or to ask for a "blob" with <object> being a tag object that
points at it.
+--batch-check::
+ Print the SHA1, type, and size of each object provided on stdin. May not be
+ combined with any other options or arguments.
+
OUTPUT
------
If '-t' is specified, one of the <type>.
@@ -56,9 +64,22 @@ If '-e' is specified, no output.
If '-p' is specified, the contents of <object> are pretty-printed.
-Otherwise the raw (though uncompressed) contents of the <object> will
-be returned.
+If <type> is specified, the raw (though uncompressed) contents of the <object>
+will be returned.
+
+If '--batch-check' is specified, output of the following form is printed for
+each object specified fon stdin:
+
+------------
+<sha1> SP <type> SP <size> LF
+------------
+
+Additionally, output of the following form is printed for each object specified
+on stdin that does not exist in the repository:
+------------
+<object> SP missing LF
+------------
Author
------