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@xxxxxx> --- * Shawn O. Pearce wrote on Sat, Oct 20, 2007 at 05:19:17AM CEST: > Frank Lichtenheld <frank@xxxxxxxxxxxxxx> wrote: > > On Fri, Oct 19, 2007 at 07:41:34PM +0200, Ralf Wildenhues wrote: > > > > > > Is that by design (because there were conflicts) or an omission? > > > In case of the former, maybe the description of -x should mention this. > > > > git commit currently doesn't know that you commit a cherry-pick. The -c > > only says to use the commit message of the original commit. So this is > > currently by design. > > Ralf, can you submit an updated version of this patch that describes > the current behavior better, given the "by design" remark above > from Frank? Here it goes. Still makes me wonder whether that is the ideal mode of operation or not. FWIW, I think the previous passive voice wording was correct English, but here's a rewrite using mostly active voice (sound nicer anyway). Cheers, Ralf Documentation/git-cherry-pick.txt | 11 ++++++----- 1 files changed, 6 insertions(+), 5 deletions(-) diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt index 47b1e8c..76a2edf 100644 --- a/Documentation/git-cherry-pick.txt +++ b/Documentation/git-cherry-pick.txt @@ -27,11 +27,12 @@ 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 - information is useless to the recipient. If on the + When recording the commit, append to the original commit + message a note that indicates which commit this change + was cherry-picked from. Append the note only for cherry + picks without conflicts. 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 maintenance branch for an older release from a -- 1.5.3.1.153.g89df5 - To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
