mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

revert: rename --reset option to --quit

Browse Source 
The option to "git cherry-pick" and "git revert" to discard the
sequencer state introduced by v1.7.8-rc0~141^2~6 (revert: Introduce
--reset to remove sequencer state, 2011-08-04) has a confusing name.
Change it now, while we still have the time.

The new name for "cherry-pick, please get out of my way, since I've
long forgotten about the sequence of commits I was cherry-picking when
you wrote that old .git/sequencer directory" is --quit.  Mnemonic:
this is analagous to quiting a program the user is no longer using ---
we just want to get out of the multiple-command cherry-pick procedure
and not to reset HEAD or rewind any other old state.

The "--reset" option is kept as a synonym to minimize the impact.  We
might consider dropping it for simplicity in a separate patch, though.

Adjust documentation and tests to use the newly preferred name (--quit)
instead of --reset.  While at it, let's clarify the short descriptions
of these operations in "-h" output.

Before:

	--reset		forget the current operation
	--continue	continue the current operation

After:

	--quit		end revert or cherry-pick sequence
	--continue	resume revert or cherry-pick sequence

Noticed-by: Phil Hord <phil.hord@gmail.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jonathan Nieder
2011-11-22 05:14:29 -06:00
committed by Junio C Hamano
parent 0f64a5a3a2
commit f80a87262a
7 changed files with 49 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/git-cherry-pick.txt
View File

@ -9,8 +9,8 @@ SYNOPSIS
--------
[verse]
'git cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] [--ff] <commit>...
'git cherry-pick' --reset
'git cherry-pick' --continue
'git cherry-pick' --quit
DESCRIPTION
-----------

2
Documentation/git-revert.txt
View File

@ -9,8 +9,8 @@ SYNOPSIS
--------
[verse]
'git revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] <commit>...
'git revert' --reset
'git revert' --continue
'git revert' --quit
DESCRIPTION
-----------

10
Documentation/sequencer.txt
View File

@ -1,9 +1,9 @@
--reset::
Forget about the current operation in progress. Can be used
to clear the sequencer state after a failed cherry-pick or
revert.
--continue::
Continue the operation in progress using the information in
'.git/sequencer'. Can be used to continue after resolving
conflicts in a failed cherry-pick or revert.
--quit::
Forget about the current operation in progress. Can be used
to clear the sequencer state after a failed cherry-pick or
revert.