[PATCH] docs: explain the order of output in cat-file batch operations

From: ahmed akef via GitGitGadget <gitgitgadget@gmail.com>
Date: Aug 19, 2024, 12:26 UTC
Message-ID: <pull.1761.git.git.1724070410906.gitgitgadget@gmail.com>

From: ahmed akef <aemed.akef.1@gmail.com>

the order of the output is not described explicitly so someone can make complex code to parse it instead of just depending on the order

Signed-off-by: ahmed akef <aemed.akef.1@gmail.com>
---
    explain the order of output in cat-file batch operations since it is not
    explicit

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1761%2Fahmedakef%2Fexplain-the-order-of-output-in-cat-file-batch-operations-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1761/ahmedakef/explain-the-order-of-output-in-cat-file-batch-operations-v1
Pull-Request: https://github.com/git/git/pull/1761

 Documentation/git-cat-file.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt
index bd95a6c10a7..f1e0b4a7219 100644
--- a/Documentation/git-cat-file.txt
+++ b/Documentation/git-cat-file.txt
@@ -270,8 +270,8 @@ 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].
 
 When `--batch-command` is given, `cat-file` will read commands from stdin,

base-commit: 406f326d271e0bacecdb00425422c5fa3f314930

-- 
gitgitgadget