Mercurial > hgbook
annotate en/undo.tex @ 382:d64d38d2a91a
more hook.tex
author | Yoshiki Yazawa <yaz@honeyplanet.jp> |
---|---|
date | Thu, 19 Feb 2009 20:42:55 +0900 |
parents | 7a6bd93174bd |
children | a168daed199b |
rev | line source |
---|---|
121
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
1 \chapter{Finding and fixing your mistakes} |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
2 \label{chap:undo} |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
3 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
4 To err might be human, but to really handle the consequences well |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
5 takes a top-notch revision control system. In this chapter, we'll |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
6 discuss some of the techniques you can use when you find that a |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
7 problem has crept into your project. Mercurial has some highly |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
8 capable features that will help you to isolate the sources of |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
9 problems, and to handle them appropriately. |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
10 |
122
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
11 \section{Erasing local history} |
121
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
12 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
13 \subsection{The accidental commit} |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
14 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
15 I have the occasional but persistent problem of typing rather more |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
16 quickly than I can think, which sometimes results in me committing a |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
17 changeset that is either incomplete or plain wrong. In my case, the |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
18 usual kind of incomplete changeset is one in which I've created a new |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
19 source file, but forgotten to \hgcmd{add} it. A ``plain wrong'' |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
20 changeset is not as common, but no less annoying. |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
21 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
22 \subsection{Rolling back a transaction} |
126
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
23 \label{sec:undo:rollback} |
121
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
24 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
25 In section~\ref{sec:concepts:txn}, I mentioned that Mercurial treats |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
26 each modification of a repository as a \emph{transaction}. Every time |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
27 you commit a changeset or pull changes from another repository, |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
28 Mercurial remembers what you did. You can undo, or \emph{roll back}, |
200
9bba958be4c6
Mention automatic example generation.
Bryan O'Sullivan <bos@serpentine.com>
parents:
131
diff
changeset
|
29 exactly one of these actions using the \hgcmd{rollback} command. (See |
9bba958be4c6
Mention automatic example generation.
Bryan O'Sullivan <bos@serpentine.com>
parents:
131
diff
changeset
|
30 section~\ref{sec:undo:rollback-after-push} for an important caveat |
9bba958be4c6
Mention automatic example generation.
Bryan O'Sullivan <bos@serpentine.com>
parents:
131
diff
changeset
|
31 about the use of this command.) |
121
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
32 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
33 Here's a mistake that I often find myself making: committing a change |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
34 in which I've created a new file, but forgotten to \hgcmd{add} it. |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
35 \interaction{rollback.commit} |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
36 Looking at the output of \hgcmd{status} after the commit immediately |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
37 confirms the error. |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
38 \interaction{rollback.status} |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
39 The commit captured the changes to the file \filename{a}, but not the |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
40 new file \filename{b}. If I were to push this changeset to a |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
41 repository that I shared with a colleague, the chances are high that |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
42 something in \filename{a} would refer to \filename{b}, which would not |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
43 be present in their repository when they pulled my changes. I would |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
44 thus become the object of some indignation. |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
45 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
46 However, luck is with me---I've caught my error before I pushed the |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
47 changeset. I use the \hgcmd{rollback} command, and Mercurial makes |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
48 that last changeset vanish. |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
49 \interaction{rollback.rollback} |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
50 Notice that the changeset is no longer present in the repository's |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
51 history, and the working directory once again thinks that the file |
122
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
52 \filename{a} is modified. The commit and rollback have left the |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
53 working directory exactly as it was prior to the commit; the changeset |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
54 has been completely erased. I can now safely \hgcmd{add} the file |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
55 \filename{b}, and rerun my commit. |
121
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
56 \interaction{rollback.add} |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
57 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
58 \subsection{The erroneous pull} |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
59 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
60 It's common practice with Mercurial to maintain separate development |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
61 branches of a project in different repositories. Your development |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
62 team might have one shared repository for your project's ``0.9'' |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
63 release, and another, containing different changes, for the ``1.0'' |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
64 release. |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
65 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
66 Given this, you can imagine that the consequences could be messy if |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
67 you had a local ``0.9'' repository, and accidentally pulled changes |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
68 from the shared ``1.0'' repository into it. At worst, you could be |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
69 paying insufficient attention, and push those changes into the shared |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
70 ``0.9'' tree, confusing your entire team (but don't worry, we'll |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
71 return to this horror scenario later). However, it's more likely that |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
72 you'll notice immediately, because Mercurial will display the URL it's |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
73 pulling from, or you will see it pull a suspiciously large number of |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
74 changes into the repository. |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
75 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
76 The \hgcmd{rollback} command will work nicely to expunge all of the |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
77 changesets that you just pulled. Mercurial groups all changes from |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
78 one \hgcmd{pull} into a single transaction, so one \hgcmd{rollback} is |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
79 all you need to undo this mistake. |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
80 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
81 \subsection{Rolling back is useless once you've pushed} |
200
9bba958be4c6
Mention automatic example generation.
Bryan O'Sullivan <bos@serpentine.com>
parents:
131
diff
changeset
|
82 \label{sec:undo:rollback-after-push} |
121
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
83 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
84 The value of the \hgcmd{rollback} command drops to zero once you've |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
85 pushed your changes to another repository. Rolling back a change |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
86 makes it disappear entirely, but \emph{only} in the repository in |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
87 which you perform the \hgcmd{rollback}. Because a rollback eliminates |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
88 history, there's no way for the disappearance of a change to propagate |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
89 between repositories. |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
90 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
91 If you've pushed a change to another repository---particularly if it's |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
92 a shared repository---it has essentially ``escaped into the wild,'' |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
93 and you'll have to recover from your mistake in a different way. What |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
94 will happen if you push a changeset somewhere, then roll it back, then |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
95 pull from the repository you pushed to, is that the changeset will |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
96 reappear in your repository. |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
97 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
98 (If you absolutely know for sure that the change you want to roll back |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
99 is the most recent change in the repository that you pushed to, |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
100 \emph{and} you know that nobody else could have pulled it from that |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
101 repository, you can roll back the changeset there, too, but you really |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
102 should really not rely on this working reliably. If you do this, |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
103 sooner or later a change really will make it into a repository that |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
104 you don't directly control (or have forgotten about), and come back to |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
105 bite you.) |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
106 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
107 \subsection{You can only roll back once} |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
108 |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
109 Mercurial stores exactly one transaction in its transaction log; that |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
110 transaction is the most recent one that occurred in the repository. |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
111 This means that you can only roll back one transaction. If you expect |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
112 to be able to roll back one transaction, then its predecessor, this is |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
113 not the behaviour you will get. |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
114 \interaction{rollback.twice} |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
115 Once you've rolled back one transaction in a repository, you can't |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
116 roll back again in that repository until you perform another commit or |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
117 pull. |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
118 |
122
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
119 \section{Reverting the mistaken change} |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
120 |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
121 If you make a modification to a file, and decide that you really |
124
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
122 didn't want to change the file at all, and you haven't yet committed |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
123 your changes, the \hgcmd{revert} command is the one you'll need. It |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
124 looks at the changeset that's the parent of the working directory, and |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
125 restores the contents of the file to their state as of that changeset. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
126 (That's a long-winded way of saying that, in the normal case, it |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
127 undoes your modifications.) |
122
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
128 |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
129 Let's illustrate how the \hgcmd{revert} command works with yet another |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
130 small example. We'll begin by modifying a file that Mercurial is |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
131 already tracking. |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
132 \interaction{daily.revert.modify} |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
133 If we don't want that change, we can simply \hgcmd{revert} the file. |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
134 \interaction{daily.revert.unmodify} |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
135 The \hgcmd{revert} command provides us with an extra degree of safety |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
136 by saving our modified file with a \filename{.orig} extension. |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
137 \interaction{daily.revert.status} |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
138 |
124
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
139 Here is a summary of the cases that the \hgcmd{revert} command can |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
140 deal with. We will describe each of these in more detail in the |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
141 section that follows. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
142 \begin{itemize} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
143 \item If you modify a file, it will restore the file to its unmodified |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
144 state. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
145 \item If you \hgcmd{add} a file, it will undo the ``added'' state of |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
146 the file, but leave the file itself untouched. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
147 \item If you delete a file without telling Mercurial, it will restore |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
148 the file to its unmodified contents. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
149 \item If you use the \hgcmd{remove} command to remove a file, it will |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
150 undo the ``removed'' state of the file, and restore the file to its |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
151 unmodified contents. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
152 \end{itemize} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
153 |
122
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
154 \subsection{File management errors} |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
155 \label{sec:undo:mgmt} |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
156 |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
157 The \hgcmd{revert} command is useful for more than just modified |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
158 files. It lets you reverse the results of all of Mercurial's file |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
159 management commands---\hgcmd{add}, \hgcmd{remove}, and so on. |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
160 |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
161 If you \hgcmd{add} a file, then decide that in fact you don't want |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
162 Mercurial to track it, use \hgcmd{revert} to undo the add. Don't |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
163 worry; Mercurial will not modify the file in any way. It will just |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
164 ``unmark'' the file. |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
165 \interaction{daily.revert.add} |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
166 |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
167 Similarly, if you ask Mercurial to \hgcmd{remove} a file, you can use |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
168 \hgcmd{revert} to restore it to the contents it had as of the parent |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
169 of the working directory. |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
170 \interaction{daily.revert.remove} |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
171 This works just as well for a file that you deleted by hand, without |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
172 telling Mercurial (recall that in Mercurial terminology, this kind of |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
173 file is called ``missing''). |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
174 \interaction{daily.revert.missing} |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
175 |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
176 If you revert a \hgcmd{copy}, the copied-to file remains in your |
123 | 177 working directory afterwards, untracked. Since a copy doesn't affect |
178 the copied-from file in any way, Mercurial doesn't do anything with | |
179 the copied-from file. | |
122
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
180 \interaction{daily.revert.copy} |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
181 |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
182 \subsubsection{A slightly special case: reverting a rename} |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
183 |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
184 If you \hgcmd{rename} a file, there is one small detail that |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
185 you should remember. When you \hgcmd{revert} a rename, it's not |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
186 enough to provide the name of the renamed-to file, as you can see |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
187 here. |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
188 \interaction{daily.revert.rename} |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
189 As you can see from the output of \hgcmd{status}, the renamed-to file |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
190 is no longer identified as added, but the renamed-\emph{from} file is |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
191 still removed! This is counter-intuitive (at least to me), but at |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
192 least it's easy to deal with. |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
193 \interaction{daily.revert.rename-orig} |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
194 So remember, to revert a \hgcmd{rename}, you must provide \emph{both} |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
195 the source and destination names. |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
196 |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
197 (By the way, if you rename a file, then modify the renamed-to file, |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
198 then revert both components of the rename, when Mercurial restores the |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
199 file that was removed as part of the rename, it will be unmodified. |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
200 If you need the modifications in the renamed-to file to show up in the |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
201 renamed-from file, don't forget to copy them over.) |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
202 |
123 | 203 These fiddly aspects of reverting a rename arguably constitute a small |
122
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
204 bug in Mercurial. |
3af28630fe8c
How to goodbye depression by reverting one thousand times daily.
Bryan O'Sullivan <bos@serpentine.com>
parents:
121
diff
changeset
|
205 |
124
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
206 \section{Dealing with committed changes} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
207 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
208 Consider a case where you have committed a change $a$, and another |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
209 change $b$ on top of it; you then realise that change $a$ was |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
210 incorrect. Mercurial lets you ``back out'' an entire changeset |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
211 automatically, and building blocks that let you reverse part of a |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
212 changeset by hand. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
213 |
126
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
214 Before you read this section, here's something to keep in mind: the |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
215 \hgcmd{backout} command undoes changes by \emph{adding} history, not |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
216 by modifying or erasing it. It's the right tool to use if you're |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
217 fixing bugs, but not if you're trying to undo some change that has |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
218 catastrophic consequences. To deal with those, see |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
219 section~\ref{sec:undo:aaaiiieee}. |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
220 |
124
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
221 \subsection{Backing out a changeset} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
222 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
223 The \hgcmd{backout} command lets you ``undo'' the effects of an entire |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
224 changeset in an automated fashion. Because Mercurial's history is |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
225 immutable, this command \emph{does not} get rid of the changeset you |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
226 want to undo. Instead, it creates a new changeset that |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
227 \emph{reverses} the effect of the to-be-undone changeset. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
228 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
229 The operation of the \hgcmd{backout} command is a little intricate, so |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
230 let's illustrate it with some examples. First, we'll create a |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
231 repository with some simple changes. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
232 \interaction{backout.init} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
233 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
234 The \hgcmd{backout} command takes a single changeset ID as its |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
235 argument; this is the changeset to back out. Normally, |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
236 \hgcmd{backout} will drop you into a text editor to write a commit |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
237 message, so you can record why you're backing the change out. In this |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
238 example, we provide a commit message on the command line using the |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
239 \hgopt{backout}{-m} option. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
240 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
241 \subsection{Backing out the tip changeset} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
242 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
243 We're going to start by backing out the last changeset we committed. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
244 \interaction{backout.simple} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
245 You can see that the second line from \filename{myfile} is no longer |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
246 present. Taking a look at the output of \hgcmd{log} gives us an idea |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
247 of what the \hgcmd{backout} command has done. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
248 \interaction{backout.simple.log} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
249 Notice that the new changeset that \hgcmd{backout} has created is a |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
250 child of the changeset we backed out. It's easier to see this in |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
251 figure~\ref{fig:undo:backout}, which presents a graphical view of the |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
252 change history. As you can see, the history is nice and linear. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
253 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
254 \begin{figure}[htb] |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
255 \centering |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
256 \grafix{undo-simple} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
257 \caption{Backing out a change using the \hgcmd{backout} command} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
258 \label{fig:undo:backout} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
259 \end{figure} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
260 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
261 \subsection{Backing out a non-tip change} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
262 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
263 If you want to back out a change other than the last one you |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
264 committed, pass the \hgopt{backout}{--merge} option to the |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
265 \hgcmd{backout} command. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
266 \interaction{backout.non-tip.clone} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
267 This makes backing out any changeset a ``one-shot'' operation that's |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
268 usually simple and fast. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
269 \interaction{backout.non-tip.backout} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
270 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
271 If you take a look at the contents of \filename{myfile} after the |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
272 backout finishes, you'll see that the first and third changes are |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
273 present, but not the second. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
274 \interaction{backout.non-tip.cat} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
275 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
276 As the graphical history in figure~\ref{fig:undo:backout-non-tip} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
277 illustrates, Mercurial actually commits \emph{two} changes in this |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
278 kind of situation (the box-shaped nodes are the ones that Mercurial |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
279 commits automatically). Before Mercurial begins the backout process, |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
280 it first remembers what the current parent of the working directory |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
281 is. It then backs out the target changeset, and commits that as a |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
282 changeset. Finally, it merges back to the previous parent of the |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
283 working directory, and commits the result of the merge. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
284 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
285 \begin{figure}[htb] |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
286 \centering |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
287 \grafix{undo-non-tip} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
288 \caption{Automated backout of a non-tip change using the \hgcmd{backout} command} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
289 \label{fig:undo:backout-non-tip} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
290 \end{figure} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
291 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
292 The result is that you end up ``back where you were'', only with some |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
293 extra history that undoes the effect of the changeset you wanted to |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
294 back out. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
295 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
296 \subsubsection{Always use the \hgopt{backout}{--merge} option} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
297 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
298 In fact, since the \hgopt{backout}{--merge} option will do the ``right |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
299 thing'' whether or not the changeset you're backing out is the tip |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
300 (i.e.~it won't try to merge if it's backing out the tip, since there's |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
301 no need), you should \emph{always} use this option when you run the |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
302 \hgcmd{backout} command. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
303 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
304 \subsection{Gaining more control of the backout process} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
305 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
306 While I've recommended that you always use the |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
307 \hgopt{backout}{--merge} option when backing out a change, the |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
308 \hgcmd{backout} command lets you decide how to merge a backout |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
309 changeset. Taking control of the backout process by hand is something |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
310 you will rarely need to do, but it can be useful to understand what |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
311 the \hgcmd{backout} command is doing for you automatically. To |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
312 illustrate this, let's clone our first repository, but omit the |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
313 backout change that it contains. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
314 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
315 \interaction{backout.manual.clone} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
316 As with our earlier example, We'll commit a third changeset, then back |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
317 out its parent, and see what happens. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
318 \interaction{backout.manual.backout} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
319 Our new changeset is again a descendant of the changeset we backout |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
320 out; it's thus a new head, \emph{not} a descendant of the changeset |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
321 that was the tip. The \hgcmd{backout} command was quite explicit in |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
322 telling us this. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
323 \interaction{backout.manual.log} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
324 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
325 Again, it's easier to see what has happened by looking at a graph of |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
326 the revision history, in figure~\ref{fig:undo:backout-manual}. This |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
327 makes it clear that when we use \hgcmd{backout} to back out a change |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
328 other than the tip, Mercurial adds a new head to the repository (the |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
329 change it committed is box-shaped). |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
330 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
331 \begin{figure}[htb] |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
332 \centering |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
333 \grafix{undo-manual} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
334 \caption{Backing out a change using the \hgcmd{backout} command} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
335 \label{fig:undo:backout-manual} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
336 \end{figure} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
337 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
338 After the \hgcmd{backout} command has completed, it leaves the new |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
339 ``backout'' changeset as the parent of the working directory. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
340 \interaction{backout.manual.parents} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
341 Now we have two isolated sets of changes. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
342 \interaction{backout.manual.heads} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
343 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
344 Let's think about what we expect to see as the contents of |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
345 \filename{myfile} now. The first change should be present, because |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
346 we've never backed it out. The second change should be missing, as |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
347 that's the change we backed out. Since the history graph shows the |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
348 third change as a separate head, we \emph{don't} expect to see the |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
349 third change present in \filename{myfile}. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
350 \interaction{backout.manual.cat} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
351 To get the third change back into the file, we just do a normal merge |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
352 of our two heads. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
353 \interaction{backout.manual.merge} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
354 Afterwards, the graphical history of our repository looks like |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
355 figure~\ref{fig:undo:backout-manual-merge}. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
356 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
357 \begin{figure}[htb] |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
358 \centering |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
359 \grafix{undo-manual-merge} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
360 \caption{Manually merging a backout change} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
361 \label{fig:undo:backout-manual-merge} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
362 \end{figure} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
363 |
126
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
364 \subsection{Why \hgcmd{backout} works as it does} |
124
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
365 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
366 Here's a brief description of how the \hgcmd{backout} command works. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
367 \begin{enumerate} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
368 \item It ensures that the working directory is ``clean'', i.e.~that |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
369 the output of \hgcmd{status} would be empty. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
370 \item It remembers the current parent of the working directory. Let's |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
371 call this changeset \texttt{orig} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
372 \item It does the equivalent of a \hgcmd{update} to sync the working |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
373 directory to the changeset you want to back out. Let's call this |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
374 changeset \texttt{backout} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
375 \item It finds the parent of that changeset. Let's call that |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
376 changeset \texttt{parent}. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
377 \item For each file that the \texttt{backout} changeset affected, it |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
378 does the equivalent of a \hgcmdargs{revert}{-r parent} on that file, |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
379 to restore it to the contents it had before that changeset was |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
380 committed. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
381 \item It commits the result as a new changeset. This changeset has |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
382 \texttt{backout} as its parent. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
383 \item If you specify \hgopt{backout}{--merge} on the command line, it |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
384 merges with \texttt{orig}, and commits the result of the merge. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
385 \end{enumerate} |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
386 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
387 An alternative way to implement the \hgcmd{backout} command would be |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
388 to \hgcmd{export} the to-be-backed-out changeset as a diff, then use |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
389 the \cmdopt{patch}{--reverse} option to the \command{patch} command to |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
390 reverse the effect of the change without fiddling with the working |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
391 directory. This sounds much simpler, but it would not work nearly as |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
392 well. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
393 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
394 The reason that \hgcmd{backout} does an update, a commit, a merge, and |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
395 another commit is to give the merge machinery the best chance to do a |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
396 good job when dealing with all the changes \emph{between} the change |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
397 you're backing out and the current tip. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
398 |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
399 If you're backing out a changeset that's~100 revisions back in your |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
400 project's history, the chances that the \command{patch} command will |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
401 be able to apply a reverse diff cleanly are not good, because |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
402 intervening changes are likely to have ``broken the context'' that |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
403 \command{patch} uses to determine whether it can apply a patch (if |
125 | 404 this sounds like gibberish, see \ref{sec:mq:patch} for a |
124
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
405 discussion of the \command{patch} command). Also, Mercurial's merge |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
406 machinery will handle files and directories being renamed, permission |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
407 changes, and modifications to binary files, none of which |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
408 \command{patch} can deal with. |
c9aad709bd3a
Document the backout command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
123
diff
changeset
|
409 |
126
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
410 \section{Changes that should never have been} |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
411 \label{sec:undo:aaaiiieee} |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
412 |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
413 Most of the time, the \hgcmd{backout} command is exactly what you need |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
414 if you want to undo the effects of a change. It leaves a permanent |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
415 record of exactly what you did, both when committing the original |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
416 changeset and when you cleaned up after it. |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
417 |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
418 On rare occasions, though, you may find that you've committed a change |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
419 that really should not be present in the repository at all. For |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
420 example, it would be very unusual, and usually considered a mistake, |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
421 to commit a software project's object files as well as its source |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
422 files. Object files have almost no intrinsic value, and they're |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
423 \emph{big}, so they increase the size of the repository and the amount |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
424 of time it takes to clone or pull changes. |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
425 |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
426 Before I discuss the options that you have if you commit a ``brown |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
427 paper bag'' change (the kind that's so bad that you want to pull a |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
428 brown paper bag over your head), let me first discuss some approaches |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
429 that probably won't work. |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
430 |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
431 Since Mercurial treats history as accumulative---every change builds |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
432 on top of all changes that preceded it---you generally can't just make |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
433 disastrous changes disappear. The one exception is when you've just |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
434 committed a change, and it hasn't been pushed or pulled into another |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
435 repository. That's when you can safely use the \hgcmd{rollback} |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
436 command, as I detailed in section~\ref{sec:undo:rollback}. |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
437 |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
438 After you've pushed a bad change to another repository, you |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
439 \emph{could} still use \hgcmd{rollback} to make your local copy of the |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
440 change disappear, but it won't have the consequences you want. The |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
441 change will still be present in the remote repository, so it will |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
442 reappear in your local repository the next time you pull. |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
443 |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
444 If a situation like this arises, and you know which repositories your |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
445 bad change has propagated into, you can \emph{try} to get rid of the |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
446 changeefrom \emph{every} one of those repositories. This is, of |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
447 course, not a satisfactory solution: if you miss even a single |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
448 repository while you're expunging, the change is still ``in the |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
449 wild'', and could propagate further. |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
450 |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
451 If you've committed one or more changes \emph{after} the change that |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
452 you'd like to see disappear, your options are further reduced. |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
453 Mercurial doesn't provide a way to ``punch a hole'' in history, |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
454 leaving changesets intact. |
fa3c43dd3a1e
More undo-related verbiage.
Bryan O'Sullivan <bos@serpentine.com>
parents:
125
diff
changeset
|
455 |
129 | 456 XXX This needs filling out. The \texttt{hg-replay} script in the |
457 \texttt{examples} directory works, but doesn't handle merge | |
458 changesets. Kind of an important omission. | |
459 | |
201
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
460 \subsection{Protect yourself from ``escaped'' changes} |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
461 |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
462 If you've committed some changes to your local repository and they've |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
463 been pushed or pulled somewhere else, this isn't necessarily a |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
464 disaster. You can protect yourself ahead of time against some classes |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
465 of bad changeset. This is particularly easy if your team usually |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
466 pulls changes from a central repository. |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
467 |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
468 By configuring some hooks on that repository to validate incoming |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
469 changesets (see chapter~\ref{chap:hook}), you can automatically |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
470 prevent some kinds of bad changeset from being pushed to the central |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
471 repository at all. With such a configuration in place, some kinds of |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
472 bad changeset will naturally tend to ``die out'' because they can't |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
473 propagate into the central repository. Better yet, this happens |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
474 without any need for explicit intervention. |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
475 |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
476 For instance, an incoming change hook that verifies that a changeset |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
477 will actually compile can prevent people from inadvertantly ``breaking |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
478 the build''. |
80fc720338a5
Mention use of hooks to defend against propagation of bad changes.
Bryan O'Sullivan <bos@serpentine.com>
parents:
200
diff
changeset
|
479 |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
480 \section{Finding the source of a bug} |
200
9bba958be4c6
Mention automatic example generation.
Bryan O'Sullivan <bos@serpentine.com>
parents:
131
diff
changeset
|
481 \label{sec:undo:bisect} |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
482 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
483 While it's all very well to be able to back out a changeset that |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
484 introduced a bug, this requires that you know which changeset to back |
282 | 485 out. Mercurial provides an invaluable command, called |
486 \hgcmd{bisect}, that helps you to automate this process and accomplish | |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
487 it very efficiently. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
488 |
282 | 489 The idea behind the \hgcmd{bisect} command is that a changeset has |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
490 introduced some change of behaviour that you can identify with a |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
491 simple binary test. You don't know which piece of code introduced the |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
492 change, but you know how to test for the presence of the bug. The |
282 | 493 \hgcmd{bisect} command uses your test to direct its search for the |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
494 changeset that introduced the code that caused the bug. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
495 |
282 | 496 Here are a few scenarios to help you understand how you might apply |
497 this command. | |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
498 \begin{itemize} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
499 \item The most recent version of your software has a bug that you |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
500 remember wasn't present a few weeks ago, but you don't know when it |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
501 was introduced. Here, your binary test checks for the presence of |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
502 that bug. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
503 \item You fixed a bug in a rush, and now it's time to close the entry |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
504 in your team's bug database. The bug database requires a changeset |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
505 ID when you close an entry, but you don't remember which changeset |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
506 you fixed the bug in. Once again, your binary test checks for the |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
507 presence of the bug. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
508 \item Your software works correctly, but runs~15\% slower than the |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
509 last time you measured it. You want to know which changeset |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
510 introduced the performance regression. In this case, your binary |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
511 test measures the performance of your software, to see whether it's |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
512 ``fast'' or ``slow''. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
513 \item The sizes of the components of your project that you ship |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
514 exploded recently, and you suspect that something changed in the way |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
515 you build your project. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
516 \end{itemize} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
517 |
282 | 518 From these examples, it should be clear that the \hgcmd{bisect} |
519 command is not useful only for finding the sources of bugs. You can | |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
520 use it to find any ``emergent property'' of a repository (anything |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
521 that you can't find from a simple text search of the files in the |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
522 tree) for which you can write a binary test. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
523 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
524 We'll introduce a little bit of terminology here, just to make it |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
525 clear which parts of the search process are your responsibility, and |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
526 which are Mercurial's. A \emph{test} is something that \emph{you} run |
282 | 527 when \hgcmd{bisect} chooses a changeset. A \emph{probe} is what |
528 \hgcmd{bisect} runs to tell whether a revision is good. Finally, | |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
529 we'll use the word ``bisect'', as both a noun and a verb, to stand in |
282 | 530 for the phrase ``search using the \hgcmd{bisect} command. |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
531 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
532 One simple way to automate the searching process would be simply to |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
533 probe every changeset. However, this scales poorly. If it took ten |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
534 minutes to test a single changeset, and you had 10,000 changesets in |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
535 your repository, the exhaustive approach would take on average~35 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
536 \emph{days} to find the changeset that introduced a bug. Even if you |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
537 knew that the bug was introduced by one of the last 500 changesets, |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
538 and limited your search to those, you'd still be looking at over 40 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
539 hours to find the changeset that introduced your bug. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
540 |
282 | 541 What the \hgcmd{bisect} command does is use its knowledge of the |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
542 ``shape'' of your project's revision history to perform a search in |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
543 time proportional to the \emph{logarithm} of the number of changesets |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
544 to check (the kind of search it performs is called a dichotomic |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
545 search). With this approach, searching through 10,000 changesets will |
282 | 546 take less than three hours, even at ten minutes per test (the search |
547 will require about 14 tests). Limit your search to the last hundred | |
548 changesets, and it will take only about an hour (roughly seven tests). | |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
549 |
282 | 550 The \hgcmd{bisect} command is aware of the ``branchy'' nature of a |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
551 Mercurial project's revision history, so it has no problems dealing |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
552 with branches, merges, or multiple heads in a repoository. It can |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
553 prune entire branches of history with a single probe, which is how it |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
554 operates so efficiently. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
555 |
282 | 556 \subsection{Using the \hgcmd{bisect} command} |
557 | |
558 Here's an example of \hgcmd{bisect} in action. | |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
559 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
560 \begin{note} |
282 | 561 In versions 0.9.5 and earlier of Mercurial, \hgcmd{bisect} was not a |
562 core command: it was distributed with Mercurial as an extension. | |
563 This section describes the built-in command, not the old extension. | |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
564 \end{note} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
565 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
566 Now let's create a repository, so that we can try out the |
282 | 567 \hgcmd{bisect} command in isolation. |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
568 \interaction{bisect.init} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
569 We'll simulate a project that has a bug in it in a simple-minded way: |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
570 create trivial changes in a loop, and nominate one specific change |
267
d145739b7865
The script actually only creates 35 changesets (as I understand it)
bab@draketo.de
parents:
257
diff
changeset
|
571 that will have the ``bug''. This loop creates 35 changesets, each |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
572 adding a single file to the repository. We'll represent our ``bug'' |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
573 with a file that contains the text ``i have a gub''. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
574 \interaction{bisect.commits} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
575 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
576 The next thing that we'd like to do is figure out how to use the |
282 | 577 \hgcmd{bisect} command. We can use Mercurial's normal built-in help |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
578 mechanism for this. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
579 \interaction{bisect.help} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
580 |
282 | 581 The \hgcmd{bisect} command works in steps. Each step proceeds as follows. |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
582 \begin{enumerate} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
583 \item You run your binary test. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
584 \begin{itemize} |
282 | 585 \item If the test succeeded, you tell \hgcmd{bisect} by running the |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
586 \hgcmdargs{bisect}{good} command. |
282 | 587 \item If it failed, run the \hgcmdargs{bisect}{--bad} command. |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
588 \end{itemize} |
282 | 589 \item The command uses your information to decide which changeset to |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
590 test next. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
591 \item It updates the working directory to that changeset, and the |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
592 process begins again. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
593 \end{enumerate} |
282 | 594 The process ends when \hgcmd{bisect} identifies a unique changeset |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
595 that marks the point where your test transitioned from ``succeeding'' |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
596 to ``failing''. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
597 |
282 | 598 To start the search, we must run the \hgcmdargs{bisect}{--reset} command. |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
599 \interaction{bisect.search.init} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
600 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
601 In our case, the binary test we use is simple: we check to see if any |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
602 file in the repository contains the string ``i have a gub''. If it |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
603 does, this changeset contains the change that ``caused the bug''. By |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
604 convention, a changeset that has the property we're searching for is |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
605 ``bad'', while one that doesn't is ``good''. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
606 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
607 Most of the time, the revision to which the working directory is |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
608 synced (usually the tip) already exhibits the problem introduced by |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
609 the buggy change, so we'll mark it as ``bad''. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
610 \interaction{bisect.search.bad-init} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
611 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
612 Our next task is to nominate a changeset that we know \emph{doesn't} |
282 | 613 have the bug; the \hgcmd{bisect} command will ``bracket'' its search |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
614 between the first pair of good and bad changesets. In our case, we |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
615 know that revision~10 didn't have the bug. (I'll have more words |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
616 about choosing the first ``good'' changeset later.) |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
617 \interaction{bisect.search.good-init} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
618 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
619 Notice that this command printed some output. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
620 \begin{itemize} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
621 \item It told us how many changesets it must consider before it can |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
622 identify the one that introduced the bug, and how many tests that |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
623 will require. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
624 \item It updated the working directory to the next changeset to test, |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
625 and told us which changeset it's testing. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
626 \end{itemize} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
627 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
628 We now run our test in the working directory. We use the |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
629 \command{grep} command to see if our ``bad'' file is present in the |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
630 working directory. If it is, this revision is bad; if not, this |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
631 revision is good. |
131
153efeaa8f57
Fix stupid build bugs.
Bryan O'Sullivan <bos@serpentine.com>
parents:
130
diff
changeset
|
632 \interaction{bisect.search.step1} |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
633 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
634 This test looks like a perfect candidate for automation, so let's turn |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
635 it into a shell function. |
131
153efeaa8f57
Fix stupid build bugs.
Bryan O'Sullivan <bos@serpentine.com>
parents:
130
diff
changeset
|
636 \interaction{bisect.search.mytest} |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
637 We can now run an entire test step with a single command, |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
638 \texttt{mytest}. |
131
153efeaa8f57
Fix stupid build bugs.
Bryan O'Sullivan <bos@serpentine.com>
parents:
130
diff
changeset
|
639 \interaction{bisect.search.step2} |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
640 A few more invocations of our canned test step command, and we're |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
641 done. |
131
153efeaa8f57
Fix stupid build bugs.
Bryan O'Sullivan <bos@serpentine.com>
parents:
130
diff
changeset
|
642 \interaction{bisect.search.rest} |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
643 |
282 | 644 Even though we had~40 changesets to search through, the \hgcmd{bisect} |
645 command let us find the changeset that introduced our ``bug'' with | |
646 only five tests. Because the number of tests that the \hgcmd{bisect} | |
647 command grows logarithmically with the number of changesets to | |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
648 search, the advantage that it has over the ``brute force'' search |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
649 approach increases with every changeset you add. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
650 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
651 \subsection{Cleaning up after your search} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
652 |
282 | 653 When you're finished using the \hgcmd{bisect} command in a |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
654 repository, you can use the \hgcmdargs{bisect}{reset} command to drop |
282 | 655 the information it was using to drive your search. The command |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
656 doesn't use much space, so it doesn't matter if you forget to run this |
282 | 657 command. However, \hgcmd{bisect} won't let you start a new search in |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
658 that repository until you do a \hgcmdargs{bisect}{reset}. |
131
153efeaa8f57
Fix stupid build bugs.
Bryan O'Sullivan <bos@serpentine.com>
parents:
130
diff
changeset
|
659 \interaction{bisect.search.reset} |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
660 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
661 \section{Tips for finding bugs effectively} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
662 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
663 \subsection{Give consistent input} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
664 |
282 | 665 The \hgcmd{bisect} command requires that you correctly report the |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
666 result of every test you perform. If you tell it that a test failed |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
667 when it really succeeded, it \emph{might} be able to detect the |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
668 inconsistency. If it can identify an inconsistency in your reports, |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
669 it will tell you that a particular changeset is both good and bad. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
670 However, it can't do this perfectly; it's about as likely to report |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
671 the wrong changeset as the source of the bug. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
672 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
673 \subsection{Automate as much as possible} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
674 |
282 | 675 When I started using the \hgcmd{bisect} command, I tried a few times |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
676 to run my tests by hand, on the command line. This is an approach |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
677 that I, at least, am not suited to. After a few tries, I found that I |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
678 was making enough mistakes that I was having to restart my searches |
282 | 679 several times before finally getting correct results. |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
680 |
282 | 681 My initial problems with driving the \hgcmd{bisect} command by hand |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
682 occurred even with simple searches on small repositories; if the |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
683 problem you're looking for is more subtle, or the number of tests that |
282 | 684 \hgcmd{bisect} must perform increases, the likelihood of operator |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
685 error ruining the search is much higher. Once I started automating my |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
686 tests, I had much better results. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
687 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
688 The key to automated testing is twofold: |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
689 \begin{itemize} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
690 \item always test for the same symptom, and |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
691 \item always feed consistent input to the \hgcmd{bisect} command. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
692 \end{itemize} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
693 In my tutorial example above, the \command{grep} command tests for the |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
694 symptom, and the \texttt{if} statement takes the result of this check |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
695 and ensures that we always feed the same input to the \hgcmd{bisect} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
696 command. The \texttt{mytest} function marries these together in a |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
697 reproducible way, so that every test is uniform and consistent. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
698 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
699 \subsection{Check your results} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
700 |
282 | 701 Because the output of a \hgcmd{bisect} search is only as good as the |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
702 input you give it, don't take the changeset it reports as the |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
703 absolute truth. A simple way to cross-check its report is to manually |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
704 run your test at each of the following changesets: |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
705 \begin{itemize} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
706 \item The changeset that it reports as the first bad revision. Your |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
707 test should still report this as bad. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
708 \item The parent of that changeset (either parent, if it's a merge). |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
709 Your test should report this changeset as good. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
710 \item A child of that changeset. Your test should report this |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
711 changeset as bad. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
712 \end{itemize} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
713 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
714 \subsection{Beware interference between bugs} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
715 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
716 It's possible that your search for one bug could be disrupted by the |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
717 presence of another. For example, let's say your software crashes at |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
718 revision 100, and worked correctly at revision 50. Unknown to you, |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
719 someone else introduced a different crashing bug at revision 60, and |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
720 fixed it at revision 80. This could distort your results in one of |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
721 several ways. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
722 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
723 It is possible that this other bug completely ``masks'' yours, which |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
724 is to say that it occurs before your bug has a chance to manifest |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
725 itself. If you can't avoid that other bug (for example, it prevents |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
726 your project from building), and so can't tell whether your bug is |
282 | 727 present in a particular changeset, the \hgcmd{bisect} command cannot |
728 help you directly. Instead, you can mark a changeset as untested by | |
729 running \hgcmdargs{bisect}{--skip}. | |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
730 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
731 A different problem could arise if your test for a bug's presence is |
248 | 732 not specific enough. If you check for ``my program crashes'', then |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
733 both your crashing bug and an unrelated crashing bug that masks it |
282 | 734 will look like the same thing, and mislead \hgcmd{bisect}. |
735 | |
736 Another useful situation in which to use \hgcmdargs{bisect}{--skip} is | |
737 if you can't test a revision because your project was in a broken and | |
738 hence untestable state at that revision, perhaps because someone | |
739 checked in a change that prevented the project from building. | |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
740 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
741 \subsection{Bracket your search lazily} |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
742 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
743 Choosing the first ``good'' and ``bad'' changesets that will mark the |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
744 end points of your search is often easy, but it bears a little |
282 | 745 discussion nevertheless. From the perspective of \hgcmd{bisect}, the |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
746 ``newest'' changeset is conventionally ``bad'', and the older |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
747 changeset is ``good''. |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
748 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
749 If you're having trouble remembering when a suitable ``good'' change |
282 | 750 was, so that you can tell \hgcmd{bisect}, you could do worse than |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
751 testing changesets at random. Just remember to eliminate contenders |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
752 that can't possibly exhibit the bug (perhaps because the feature with |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
753 the bug isn't present yet) and those where another problem masks the |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
754 bug (as I discussed above). |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
755 |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
756 Even if you end up ``early'' by thousands of changesets or months of |
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
757 history, you will only add a handful of tests to the total number that |
282 | 758 \hgcmd{bisect} must perform, thanks to its logarithmic behaviour. |
130
26b7a4e943aa
Describe the bisect extension.
Bryan O'Sullivan <bos@serpentine.com>
parents:
129
diff
changeset
|
759 |
121
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
760 %%% Local Variables: |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
761 %%% mode: latex |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
762 %%% TeX-master: "00book" |
9094c9fda8ec
Start chapter on error recovery.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
763 %%% End: |