|
Size: 2735
Comment: Expand on the usage docs.
|
Size: 3074
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 13: | Line 13: |
| Line 16: | Line 15: |
| History editing plugin for Mercurial, heavily inspired by git rebase --interactive. | History editing plugin for Mercurial, heavily inspired by {{{git rebase --interactive}}}. |
| Line 18: | Line 17: |
| It allows selecting (pick), combining (fold), rejecting (drop) or modifying (edit) already commited changesets. | It allows selecting ('''pick'''), combining ('''fold'''), rejecting ('''drop''') or modifying ('''edit''') already commited changesets. |
| Line 21: | Line 20: |
| Line 26: | Line 26: |
| Line 31: | Line 30: |
| The extension adds the {{{histedit}}} command which takes a {{{revision}}} argument. All changesets from that revision onwards are selected for history reordering and modification. They are presented as an ordered list with a changeset revision preceded by an action keyword for each line ({{{action revision-id}}}), like this: | The extension adds the {{{histedit}}} command, which takes a {{{revision}}} argument. All changesets from that revision and onwards are selected for history reordering and modification. They are presented as an ordered list with a changeset revision preceded by an action keyword for each line ({{{action revision-id}}}). |
| Line 33: | Line 32: |
| If you were to run {{{hg histedit c561b4e977df}}} for a repo with this history graph: | If you were to run {{{hg histedit c561b4e977df}}} for a repo with the history graph |
| Line 35: | Line 35: |
| @ 3[tip] 7c2fd3b9020c 2009-04-27 18:04 -0500 durin42 | Add delta | o 2 030b686bedc4 2009-04-27 18:04 -0500 durin42 | Add gamma | o 1 c561b4e977df 2009-04-27 18:04 -0500 durin42 | Add beta | o 0 d8d2fcd0e319 2009-04-27 18:04 -0500 durin42 Add alpha |
@ 3[tip] 7c2fd3b9020c 2009-04-27 18:04 -0500 durin42 | Add delta | o 2 030b686bedc4 2009-04-27 18:04 -0500 durin42 | Add gamma | o 1 c561b4e977df 2009-04-27 18:04 -0500 durin42 | Add beta | o 0 d8d2fcd0e319 2009-04-27 18:04 -0500 durin42 Add alpha |
| Line 48: | Line 48: |
| it would show | an editor would open containing the following text: |
| Line 51: | Line 51: |
| pick 030b686bedc4 Add gamma pick c561b4e977df Add beta fold 7c2fd3b9020c Add delta |
pick c561b4e977df Add beta pick 030b686bedc4 Add gamma pick 7c2fd3b9020c Add delta # Edit history between c561b4e977df and 7c2fd3b9020c # # Commands: # p, pick = use commit # e, edit = use commit, but stop for amending # f, fold = use commit, but fold into previous commit # d, drop = remove commit from history # 0 files updated, 0 files merged, 0 files removed, 0 files unresolved |
| Line 56: | Line 66: |
| History rewriting works by reordering those changesets, so they reflect a new ordering in the history graph, or by changing the desired action to take on each changeset. The possible actions are one of:{{{pick}}}, {{{fold}}}, {{{edit}}} or {{{drop}}} | History rewriting works by reordering changesets so that they reflect a new ordering in the history graph, or by changing the desired action to take on each changeset. The possible actions are one of {{{pick}}}, {{{fold}}}, {{{edit}}} and {{{drop}}}: |
| Line 58: | Line 68: |
| {{{pick}}} - it's the default action and simply accepts the changeset as is {{{fold}}} - combines a changeset with the previous changeset in the list and opens an editor to edit the commit message {{{edit}}} - will drop to the command prompt, allowing to edit files freely to commit some changes as a separate commit. When done, any remaining uncommitted changes will be committed as well. When done, run {{{hg histedit --continue}}} to finish this step or {{{hg histedit --abort}}} to abandon the new changes and keep the previous state. {{{drop}}} - will remove the changeset from history |
pick:: Simply accepts the changeset as is. This is the default action. fold:: Combines a changeset with the previous changeset in the list and opens an editor to edit the commit message. edit:: Drops to the command prompt, allowing to edit files freely to commit some changes as a separate commit. When done, any remaining uncommitted changes will be committed as well. When done, run {{{hg histedit --continue}}} to finish this step or {{{hg histedit --abort}}} to abandon the new changes and keep the previous state. drop:: Removes the changeset from history. |
| Line 64: | Line 73: |
| When changes lead to conflicts then the user is dropped to the command prompt and has the very same options as when the {{{edit}}} action is selected. To accept new changes the {{{hg histedit --continue}}} options is used and to drop them the {{{hg histedit --abort}}} one. | When changes lead to conflicts then the user is dropped to the command prompt and has the very same options as when the {{{edit}}} action is selected. To accept new changes the {{{hg histedit --continue}}} command is used and to drop them the {{{hg histedit --abort}}} one. |
| Line 66: | Line 75: |
| See http://bitbucket.org/durin42/histedit/src/tip/README for a more detailed explanation | See http://bitbucket.org/durin42/histedit/src/tip/README for a more detailed explanation. |
Histedit Extension
This extension is not distributed with Mercurial.
Author: Augie Fackler
Download site:
Home page: http://bitbucket.org/durin42/histedit/
Works with: Mercurial 1.2 and beyond.
1. Overview
History editing plugin for Mercurial, heavily inspired by git rebase --interactive.
It allows selecting (pick), combining (fold), rejecting (drop) or modifying (edit) already commited changesets.
2. Configuration
Configure your .hgrc to enable the extension by adding following lines:
[extensions] histedit =
3. Usage Scenario
The extension adds the histedit command, which takes a revision argument. All changesets from that revision and onwards are selected for history reordering and modification. They are presented as an ordered list with a changeset revision preceded by an action keyword for each line (action revision-id).
If you were to run hg histedit c561b4e977df for a repo with the history graph
@ 3[tip] 7c2fd3b9020c 2009-04-27 18:04 -0500 durin42
| Add delta
|
o 2 030b686bedc4 2009-04-27 18:04 -0500 durin42
| Add gamma
|
o 1 c561b4e977df 2009-04-27 18:04 -0500 durin42
| Add beta
|
o 0 d8d2fcd0e319 2009-04-27 18:04 -0500 durin42
Add alphaan editor would open containing the following text:
pick c561b4e977df Add beta pick 030b686bedc4 Add gamma pick 7c2fd3b9020c Add delta # Edit history between c561b4e977df and 7c2fd3b9020c # # Commands: # p, pick = use commit # e, edit = use commit, but stop for amending # f, fold = use commit, but fold into previous commit # d, drop = remove commit from history # 0 files updated, 0 files merged, 0 files removed, 0 files unresolved
History rewriting works by reordering changesets so that they reflect a new ordering in the history graph, or by changing the desired action to take on each changeset. The possible actions are one of pick, fold, edit and drop:
- pick
- Simply accepts the changeset as is. This is the default action.
- fold
- Combines a changeset with the previous changeset in the list and opens an editor to edit the commit message.
- edit
Drops to the command prompt, allowing to edit files freely to commit some changes as a separate commit. When done, any remaining uncommitted changes will be committed as well. When done, run hg histedit --continue to finish this step or hg histedit --abort to abandon the new changes and keep the previous state.
- drop
- Removes the changeset from history.
When changes lead to conflicts then the user is dropped to the command prompt and has the very same options as when the edit action is selected. To accept new changes the hg histedit --continue command is used and to drop them the hg histedit --abort one.
See http://bitbucket.org/durin42/histedit/src/tip/README for a more detailed explanation.