git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
To: git@vger.kernel.org
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>,
	Eric Sunshine <sunshine@sunshineco.com>,
	newren@gmail.com, phillip.wood123@gmail.com, gitster@pobox.com
Subject: [PATCH v3 1/1] doc: merge-tree: improve example script
Date: Wed,  9 Oct 2024 18:53:45 +0200	[thread overview]
Message-ID: <c7e0d76e71eef56c6279e0f7e82a2d194f78d2a4.1728492617.git.code@khaugsbakk.name> (raw)
In-Reply-To: <cover.1728492617.git.code@khaugsbakk.name>

• Provide a commit message in the example command.

  The command will hang since it is waiting for a commit message on
  stdin.  Which is usable but not straightforward enough since this is
  example code.
• Use `||` directly since that is more straightforward than checking the
  last exit status.

  Also use `echo` and `exit` since `die` is not defined.
• Expose variable declarations.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 Documentation/git-merge-tree.txt | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/Documentation/git-merge-tree.txt b/Documentation/git-merge-tree.txt
index 84cb2edf6d0..0b6a8a19b1f 100644
--- a/Documentation/git-merge-tree.txt
+++ b/Documentation/git-merge-tree.txt
@@ -211,9 +211,15 @@ linkgit:git-commit-tree[1], linkgit:git-write-tree[1],
 linkgit:git-update-ref[1], and linkgit:git-mktag[1].  Thus, it can be
 used as a part of a series of steps such as:
 
-       NEWTREE=$(git merge-tree --write-tree $BRANCH1 $BRANCH2)
-       test $? -eq 0 || die "There were conflicts..."
-       NEWCOMMIT=$(git commit-tree $NEWTREE -p $BRANCH1 -p $BRANCH2)
+       vi message.txt
+       BRANCH1=refs/heads/test
+       BRANCH2=main
+       NEWTREE=$(git merge-tree --write-tree $BRANCH1 $BRANCH2) || {
+           echo "There were conflicts..." 1>&2
+           exit 1
+       }
+       NEWCOMMIT=$(git commit-tree $NEWTREE -F message.txt \
+           -p $BRANCH1 -p $BRANCH2)
        git update-ref $BRANCH1 $NEWCOMMIT
 
 Note that when the exit status is non-zero, `NEWTREE` in this sequence
-- 
2.46.1.641.g54e7913fcb6


  reply	other threads:[~2024-10-09 16:54 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-07 11:10 [PATCH 0/3] doc: merge-tree: improve the script example Kristoffer Haugsbakk
2024-10-07 11:10 ` [PATCH 1/3] doc: merge-tree: provide a commit message Kristoffer Haugsbakk
2024-10-07 12:02   ` Kristoffer Haugsbakk
2024-10-07 15:17   ` Elijah Newren
2024-10-07 15:23     ` Kristoffer Haugsbakk
2024-10-07 11:10 ` [PATCH 2/3] doc: merge-tree: use lower-case variables Kristoffer Haugsbakk
2024-10-07 14:58   ` Phillip Wood
2024-10-07 15:22     ` Elijah Newren
2024-10-07 11:10 ` [PATCH 3/3] doc: merge-tree: use || directly Kristoffer Haugsbakk
2024-10-07 15:24   ` Elijah Newren
2024-10-07 15:44     ` Kristoffer Haugsbakk
2024-10-07 14:59 ` [PATCH 0/3] doc: merge-tree: improve the script example Phillip Wood
2024-10-07 15:00   ` Kristoffer Haugsbakk
2024-10-08 19:06 ` [PATCH v2 0/2] " Kristoffer Haugsbakk
2024-10-08 19:06   ` [PATCH v2 1/2] doc: merge-tree: provide a commit message Kristoffer Haugsbakk
2024-10-08 20:42     ` Junio C Hamano
2024-10-08 20:44       ` Kristoffer Haugsbakk
2024-10-09 16:35       ` Kristoffer Haugsbakk
2024-10-09 17:38         ` Junio C Hamano
2024-10-09 16:58       ` Andreas Schwab
2024-10-08 19:06   ` [PATCH v2 2/2] doc: merge-tree: use || directly Kristoffer Haugsbakk
2024-10-08 20:44     ` Junio C Hamano
2024-10-08 20:48       ` Kristoffer Haugsbakk
2024-10-09 16:53   ` [PATCH v3 0/1] doc: merge-tree: improve the script example Kristoffer Haugsbakk
2024-10-09 16:53     ` Kristoffer Haugsbakk [this message]
2024-10-09 20:50     ` Elijah Newren
2024-10-10  0:01       ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=c7e0d76e71eef56c6279e0f7e82a2d194f78d2a4.1728492617.git.code@khaugsbakk.name \
    --to=code@khaugsbakk.name \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=newren@gmail.com \
    --cc=phillip.wood123@gmail.com \
    --cc=sunshine@sunshineco.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).