]> git.ipfire.org Git - thirdparty/git.git/commitdiff
docs: explain the order of output in the batched mode of git-cat-file(1)
authorahmed akef <aemed.akef.1@gmail.com>
Thu, 22 Aug 2024 19:50:31 +0000 (19:50 +0000)
committerJunio C Hamano <gitster@pobox.com>
Thu, 22 Aug 2024 21:59:22 +0000 (14:59 -0700)
The batched mode of git-cat-file(1) reads multiple objects from stdin
and prints their respective contents to stdout.
The order in which those objects are printed is not documented
and may not be immediately obvious to the user.
Document it.

Signed-off-by: ahmed akef <aemed.akef.1@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-cat-file.txt

index bd95a6c10a7d0b1ee16b619c4b546c8d9c0b0e13..d5890ae3686f6bce5612ece434850d054726ec5a 100644 (file)
@@ -270,9 +270,9 @@ BATCH OUTPUT
 ------------
 
 If `--batch` or `--batch-check` is given, `cat-file` will read objects
-from stdin, one per line, and print information about them. By default,
-the whole line is considered as an object, as if it were fed to
-linkgit:git-rev-parse[1].
+from stdin, one per line, and print information about them in the same
+order as they have been read. By default, the whole line is
+considered as an object, as if it were fed to linkgit:git-rev-parse[1].
 
 When `--batch-command` is given, `cat-file` will read commands from stdin,
 one per line, and print information based on the command given. With