]> git.ipfire.org Git - thirdparty/git.git/commitdiff
merge-tree: improve docs for --stdin
authorPhillip Wood <phillip.wood@dunelm.org.uk>
Tue, 18 Feb 2025 16:24:38 +0000 (16:24 +0000)
committerJunio C Hamano <gitster@pobox.com>
Tue, 18 Feb 2025 17:52:40 +0000 (09:52 -0800)
Add a section for --stdin in the list of options and document that it
implies -z so readers know how to parse the output. Also correct the
merge status documentation for --stdin as if the status is less than
zero "git merge-tree" dies before printing it.

Signed-off-by: Phillip Wood <phillip.wood@dunelm.org.uk>
Acked-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-merge-tree.txt

index 0b6a8a19b1f98fb7ddb1964f1d0425e44497a5b2..efb16b4f27dc0e5ebd9b56ef80593fe9fef18d5d 100644 (file)
@@ -40,6 +40,11 @@ After the merge completes, a new toplevel tree object is created.  See
 OPTIONS
 -------
 
+--stdin::
+       Read the commits to merge from the standard input rather than
+       the command-line. See <<INPUT,INPUT FORMAT>> below for more
+       information.  Implies `-z`.
+
 -z::
        Do not quote filenames in the <Conflicted file info> section,
        and end each filename with a NUL character rather than
@@ -116,8 +121,6 @@ This is an integer status followed by a NUL character.  The integer status is:
 
      0: merge had conflicts
      1: merge was clean
-     <0: something prevented the merge from running (e.g. access to repository
-        objects denied by filesystem)
 
 [[OIDTLT]]
 OID of toplevel tree
@@ -235,6 +238,7 @@ with linkgit:git-merge[1]:
   * any messages that would have been printed to stdout (the
     <<IM,Informational messages>>)
 
+[[INPUT]]
 INPUT FORMAT
 ------------
 'git merge-tree --stdin' input format is fully text based. Each line