comparison hgext/histedit.py @ 31055:f1b63ec4b987

histedit: improve documentation and behaviour of dates This clarifies in the histedit documentation that the 'edit' action preserves the date and that the 'fold' action uses the later date. The documentation was previously silent on this issue which left users in doubt.
author Ben Schmidt <insightfuls@users.noreply.github.com>
date Sat, 18 Feb 2017 21:30:28 +1100
parents d4825798818b
children 37ab9e20991c
comparison
equal deleted inserted replaced
31054:59e69ed81776 31055:f1b63ec4b987
69 69
70 Add beta 70 Add beta
71 *** 71 ***
72 Add delta 72 Add delta
73 73
74 Edit the commit message to your liking, then close the editor. For 74 Edit the commit message to your liking, then close the editor. The date used
75 this example, let's assume that the commit message was changed to 75 for the commit will be the later of the two commits' dates. For this example,
76 ``Add beta and delta.`` After histedit has run and had a chance to 76 let's assume that the commit message was changed to ``Add beta and delta.``
77 remove any old or temporary revisions it needed, the history looks 77 After histedit has run and had a chance to remove any old or temporary
78 like this:: 78 revisions it needed, the history looks like this::
79 79
80 @ 2[tip] 989b4d060121 2009-04-27 18:04 -0500 durin42 80 @ 2[tip] 989b4d060121 2009-04-27 18:04 -0500 durin42
81 | Add beta and delta. 81 | Add beta and delta.
82 | 82 |
83 o 1 081603921c3f 2009-04-27 18:04 -0500 durin42 83 o 1 081603921c3f 2009-04-27 18:04 -0500 durin42
95 95
96 The ``edit`` operation will drop you back to a command prompt, 96 The ``edit`` operation will drop you back to a command prompt,
97 allowing you to edit files freely, or even use ``hg record`` to commit 97 allowing you to edit files freely, or even use ``hg record`` to commit
98 some changes as a separate commit. When you're done, any remaining 98 some changes as a separate commit. When you're done, any remaining
99 uncommitted changes will be committed as well. When done, run ``hg 99 uncommitted changes will be committed as well. When done, run ``hg
100 histedit --continue`` to finish this step. You'll be prompted for a 100 histedit --continue`` to finish this step. If there are uncommitted
101 new commit message, but the default commit message will be the 101 changes, you'll be prompted for a new commit message, but the default
102 original message for the ``edit`` ed revision. 102 commit message will be the original message for the ``edit`` ed
103 revision, and the date of the original commit will be preserved.
103 104
104 The ``message`` operation will give you a chance to revise a commit 105 The ``message`` operation will give you a chance to revise a commit
105 message without changing the contents. It's a shortcut for doing 106 message without changing the contents. It's a shortcut for doing
106 ``edit`` immediately followed by `hg histedit --continue``. 107 ``edit`` immediately followed by `hg histedit --continue``.
107 108
882 883
883 - `drop` to omit changeset 884 - `drop` to omit changeset
884 885
885 - `mess` to reword the changeset commit message 886 - `mess` to reword the changeset commit message
886 887
887 - `fold` to combine it with the preceding changeset 888 - `fold` to combine it with the preceding changeset (using the later date)
888 889
889 - `roll` like fold, but discarding this commit's description 890 - `roll` like fold, but discarding this commit's description
890 891
891 - `edit` to edit this changeset 892 - `edit` to edit this changeset (preserving date)
892 893
893 There are a number of ways to select the root changeset: 894 There are a number of ways to select the root changeset:
894 895
895 - Specify ANCESTOR directly 896 - Specify ANCESTOR directly
896 897