git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
To: git@vger.kernel.org
Subject: [PATCH] git-cherry-pick: improve description of -x.
Date: Fri, 19 Oct 2007 19:41:34 +0200	[thread overview]
Message-ID: <20071019174134.GD9906@ins.uni-bonn.de> (raw)

Reword the first sentence of the description of -x, in order to
make it easier to read and understand.

Signed-off-by: Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
---

I have two issues with "git-cherry-pick -x": When reading its manpage
description for the first time, I completely failed to understand the
first sentence, and had to try it out in order to understand.

Further, I am surprised that -x seems to be nonfunctional when the
cherry pick introduces a conflict.  Example:
  git init
  echo >dummy
  git add dummy
  git commit -m dummy
  git checkout -b br
  echo one >file
  git add file
  git commit -m one
  echo two >>file
  git commit -a -m two
  git checkout master
  git cherry-pick -x br         # conflict, tells me "-c ..." arg to use
                                # for the commit later
  echo '1d
  w' | ed file                  # resolve conflict
  git add file
  git commit -c ...

The prototype commit message now does not contain the
| (cherry picked from commit ...).

Is that by design (because there were conflicts) or an omission?
In case of the former, maybe the description of -x should mention this.

Thanks,
Ralf

 Documentation/git-cherry-pick.txt |    8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt
index 47b1e8c..c7d83ce 100644
--- a/Documentation/git-cherry-pick.txt
+++ b/Documentation/git-cherry-pick.txt
@@ -27,10 +27,10 @@ OPTIONS
 	message prior committing.
 
 -x::
-	Cause the command to append which commit was
-	cherry-picked after the original commit message when
-	making a commit.  Do not use this option if you are
-	cherry-picking from your private branch because the
+	When recording the commit, the original commit message will
+	be appended with a note that indicates which commit this
+	change was cherry-picked from.  Do not use this option if
+	you are cherry-picking from your private branch because the
 	information is useless to the recipient.  If on the
 	other hand you are cherry-picking between two publicly
 	visible branches (e.g. backporting a fix to a
-- 
1.5.3.1.153.g89df5

             reply	other threads:[~2007-10-19 17:41 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-10-19 17:41 Ralf Wildenhues [this message]
2007-10-19 21:11 ` [PATCH] git-cherry-pick: improve description of -x Frank Lichtenheld
2007-10-20  3:19   ` Shawn O. Pearce
2007-10-21  9:36     ` Ralf Wildenhues
2007-10-22  5:14       ` Shawn O. Pearce
2007-10-22  5:19         ` Ralf Wildenhues

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=20071019174134.GD9906@ins.uni-bonn.de \
    --to=ralf.wildenhues@gmx.de \
    --cc=git@vger.kernel.org \
    /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).