From: ahmed akef <aemed.akef.1@xxxxxxxxx>
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@xxxxxxxxx>
---
docs: explain the order of output in The batched mode of git-cat-file(1)
this is the same change as https://github.com/git/git/pull/1761 but dues
to missteps, the PR got closed and I couldn't fix it, also applied the
review comments from @pks-t
cc: Patrick Steinhardt ps@xxxxxx
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1768%2Fahmedakef%2Fexplain-the-order-of-output-in-cat-file-batch-operations-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1768/ahmedakef/explain-the-order-of-output-in-cat-file-batch-operations-v2
Pull-Request: https://github.com/git/git/pull/1768
Range-diff vs v1:
1: 86a982884ec ! 1: 3f742957aa1 docs: explain the order of output in the batched mode of git-cat-file(1)
@@ Documentation/git-cat-file.txt: 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
-+from stdin, one per line, and print information about them sequentially in the same order.
-+By default, the whole line is considered as an object, as if it were fed to
- linkgit:git-rev-parse[1].
+-linkgit:git-rev-parse[1].
++from stdin, one per line, and print information about them in the same
++order as they have been read from stdin. 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
Documentation/git-cat-file.txt | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt
index bd95a6c10a7..c39074b9ee6 100644
--- a/Documentation/git-cat-file.txt
+++ b/Documentation/git-cat-file.txt
@@ -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 from stdin. 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
base-commit: 80ccd8a2602820fdf896a8e8894305225f86f61d
--
gitgitgadget
