From de2b82c65dac0e9768bc32f38e96b61d0b778843 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Sun, 28 Aug 2005 03:01:09 -0700 Subject: [PATCH] Document "git cherry-pick" and "git revert" Signed-off-by: Junio C Hamano --- Documentation/git-cherry-pick-script.txt | 57 ++++++++++++++++++++++++++++++++ Documentation/git-revert-script.txt | 16 ++++++++- Documentation/git.txt | 3 ++ 3 files changed, 75 insertions(+), 1 deletion(-) create mode 100644 Documentation/git-cherry-pick-script.txt diff --git a/Documentation/git-cherry-pick-script.txt b/Documentation/git-cherry-pick-script.txt new file mode 100644 index 00000000..ab9fb227 --- /dev/null +++ b/Documentation/git-cherry-pick-script.txt @@ -0,0 +1,57 @@ +git-cherry-pick-script(1) +========================= +v0.99.5 Aug 2005 + +NAME +---- +git-cherry-pick-script - Apply the change introduced by an existing commit. + +SYNOPSIS +-------- +'git-cherry-pick-script' [-n] [-r] + +DESCRIPTION +----------- +Given one existing commit, apply the change the patch introduces, and record a +new commit that records it. This requires your working tree to be clean (no +modifications from the HEAD commit). + +OPTIONS +------- +:: + Commit to cherry-pick. + +-r:: + Usuall the command appends which commit was + cherry-picked after the original commit message when + making a commit. This option, '--replay', causes it to + use the original commit message intact. This is useful + when you are reordering the patches in your private tree + before publishing, and is used by 'git rebase'. + +-n:: + Usually the command automatically creates a commit with + a commit log message stating which commit was + cherry-picked. This flag applies the change necessary + to cherry-pick the named commit to your working tree, + but does not make the commit. In addition, when this + option is used, your working tree does not have to match + the HEAD commit. The cherry-pick is done against the + beginning state of your working tree. + + This is useful when cherry-picking more than one commits' + effect to your working tree in a row. + + +Author +------ +Written by Junio C Hamano + +Documentation +-------------- +Documentation by Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-revert-script.txt b/Documentation/git-revert-script.txt index 727073e2..9609dcd3 100644 --- a/Documentation/git-revert-script.txt +++ b/Documentation/git-revert-script.txt @@ -7,7 +7,7 @@ git-revert-script - Revert an existing commit. SYNOPSIS -------- -'git-revert-script' +'git-revert-script' [-n] DESCRIPTION ----------- @@ -20,6 +20,20 @@ OPTIONS :: Commit to revert. +-n:: + Usually the command automatically creates a commit with + a commit log message stating which commit was reverted. + This flag applies the change necessary to revert the + named commit to your working tree, but does not make the + commit. In addition, when this option is used, your + working tree does not have to match the HEAD commit. + The revert is done against the beginning state of your + working tree. + + This is useful when reverting more than one commits' + effect to your working tree in a row. + + Author ------ Written by Junio C Hamano diff --git a/Documentation/git.txt b/Documentation/git.txt index 807a4700..221889bc 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -198,6 +198,9 @@ Porcelain-ish Commands link:git-revert-script.html[git-revert-script]:: Revert an existing commit. +link:git-cherry-pick-script.html[git-cherry-pick-script]:: + Cherry-pick the effect of an existing commit. + link:git-rebase-script.html[git-rebase-script]:: Rebase local commits to new upstream head. -- 2.11.0