rev |
line source |
igor@374
|
1 \chapter{Encontrar y arreglar sus equivocaciones}
|
jerojasro@343
|
2 \label{chap:undo}
|
jerojasro@343
|
3
|
igor@374
|
4 Errar es humano, pero tratar adecuadamente las consecuencias requiere
|
igor@374
|
5 un sistema de control de revisiones de primera categoría. En este
|
igor@374
|
6 capítulo, discutiremos algunas técnicas que puede usar cuando
|
igor@374
|
7 encuentra que hay un problema enraizado en su proyecto. Mercurial
|
igor@374
|
8 tiene unas características poderosas que le ayudarán a isolar las
|
igor@374
|
9 fuentes de los problemas, y a dar cuenta de ellas apropiadamente.
|
igor@374
|
10
|
igor@374
|
11 \section{Borrar la historia local}
|
igor@374
|
12
|
igor@374
|
13 \subsection{La consignación accidental}
|
igor@374
|
14
|
igor@374
|
15 Tengo el problema ocasional, pero persistente de teclear más rápido de
|
igor@374
|
16 lo que pienso, que aveces resulta en consignar un conjunto de cambios
|
igor@374
|
17 incompleto o simplemente malo. En mi caso, el conjunto de cambios
|
igor@378
|
18 incompleto consiste en que creé un nuevo fichero fuente, pero olvidé
|
igor@374
|
19 hacerle \hgcmd{add}. Un conjunto de cambios``simplemente malo'' no es
|
igor@374
|
20 tan común, pero sí resulta muy molesto.
|
igor@374
|
21
|
igor@378
|
22 \subsection{Hacer rollback una transacción}
|
jerojasro@343
|
23 \label{sec:undo:rollback}
|
jerojasro@343
|
24
|
igor@374
|
25 En la sección~\ref{sec:concepts:txn}, mencioné que Mercurial trata
|
igor@374
|
26 modificación a un repositorio como una \emph{transacción}. Cada vez
|
igor@374
|
27 que consigna un conjunto de cambios o lo jala de otro repositorio,
|
igor@378
|
28 Mercurial recuerda lo que hizo. Puede deshacer, o hacer \emph{roll back}\ndt{El significado igual que en los
|
igor@378
|
29 ambientes de sistemas manejadores de bases de datos se refiere a
|
igor@378
|
30 la atomicidad e integridad al devolver un conjunto de acciones que
|
igor@378
|
31 permitan dejar el repositorio en un estado consistente previo},
|
igor@374
|
32 exactamente una de tales acciones usando la orden \hgcmd{rollback}.
|
igor@374
|
33 (Ver en la sección~\ref{sec:undo:rollback-after-push} una anotación
|
igor@374
|
34 importante acerca del uso de esta orden.)
|
igor@374
|
35
|
igor@374
|
36 A continuación una equivocación que me sucede frecuentemente:
|
igor@374
|
37 consignar un cambio en el cual he creado un nuevo fichero, pero he
|
igor@374
|
38 olvidado hacerle \hgcmd{add}.
|
jerojasro@343
|
39 \interaction{rollback.commit}
|
igor@374
|
40 La salida de \hgcmd{status} después de la consignación confirma
|
igor@374
|
41 inmediatamente este error.
|
jerojasro@343
|
42 \interaction{rollback.status}
|
igor@378
|
43 La consignación capturó los cambios en el fichero \filename{a}, pero
|
igor@374
|
44 no el nuevo fichero \filename{b}. Si yo publicara este conjunto de
|
igor@374
|
45 cambios a un repositorio compartido con un colega, es bastante
|
igor@374
|
46 probable que algo en \filename{a} se refiriera a \filename{b}, el cual
|
igor@374
|
47 podría no estar presente cuando jalen mis cambios del repositorio. Me
|
igor@374
|
48 convertiría el sujeto de cierta indignación.
|
igor@374
|
49
|
igor@374
|
50 Como sea, la suerte me acompaña---Encontré mi error antes de publicar
|
igor@374
|
51 el conjunto de cambios. Uso la orden \hgcmd{rollback}, y Mercurial
|
igor@374
|
52 hace desaparecer el último conjunto de cambios.
|
jerojasro@343
|
53 \interaction{rollback.rollback}
|
igor@374
|
54 El conjunto de cambios ya no está en la historia del repositorio, y el
|
igor@374
|
55 directorio de trabajo cree que el fichero \filename{a} ha sido
|
igor@377
|
56 modificado. La consignación y el roll back dejaron el directorio de
|
igor@377
|
57 trabajo exactamente como estaba antes de la consignación; el conjunto
|
igor@374
|
58 de cambios ha sido eliminado totlamente. Ahora puedo hacer \hgcmd{add}
|
igor@374
|
59 al fichero \filename{b}, y hacer de nuevo la consignación.
|
jerojasro@343
|
60 \interaction{rollback.add}
|
jerojasro@343
|
61
|
igor@374
|
62 \subsection{Erroneamente jalado}
|
igor@374
|
63
|
igor@374
|
64 Mantener ramas de desarrollo separadas de un proyecto en distintos
|
igor@374
|
65 repositorios es una práctica común con Mercurial. Su equipo de
|
igor@374
|
66 desarrollo puede tener un repositorio compartido para la versión ``0.9''
|
igor@374
|
67 y otra con cambios distintos para la versión ``1.0''.
|
igor@374
|
68
|
igor@374
|
69 Con este escenario, puede imaginar las consecuencias si tuviera un
|
igor@374
|
70 repositorio local ``0.9'', y jalara accidentalmente los cambios del
|
igor@374
|
71 repositorio compartido de la versión ``1.0'' en este. En el peor de
|
igor@374
|
72 los casos, por falta de atención, es posible que publique tales
|
igor@374
|
73 cambios en el árbol compartido ``0.9'', confundiendo a todo su equipo
|
igor@374
|
74 de trabajo(pero no se preocupe, volveremos a este terrorífico
|
igor@374
|
75 escenario posteriormente). En todo caso, es muy probable que usted se
|
igor@374
|
76 de cuenta inmediatamente, dado que Mercurial mostrará el URL de donde
|
igor@374
|
77 está jalando, o que vea jalando una sospechosa gran cantidad de
|
igor@374
|
78 cambios en el repositorio.
|
igor@374
|
79
|
igor@377
|
80 La orden \hgcmd{rollback} excluirá eficientemente los conjuntos de
|
igor@377
|
81 cambios que haya acabado de jalar. Mercurial agrupa todos los cambios
|
igor@377
|
82 de un \hgcmd{pull} a una única transacción y bastará con un
|
igor@377
|
83 \hgcmd{rollback} para deshacer esta equivocación.
|
igor@377
|
84
|
igor@377
|
85 \subsection{Después de publicar, un roll back es futil}
|
jerojasro@343
|
86 \label{sec:undo:rollback-after-push}
|
jerojasro@343
|
87
|
igor@377
|
88 El valor de \hgcmd{rollback} se anula cuando ha publicado sus cambios
|
igor@377
|
89 a otro repositorio. Un cambio desaparece totalmente al hacer roll back,
|
igor@377
|
90 pero \emph{solamente} en el repositorio en el cual aplica
|
igor@377
|
91 \hgcmd{rollback}. Debido a que un roll back elimina la historia,
|
igor@377
|
92 no hay forma de que la desaparición de un cambio se propague entre
|
igor@377
|
93 repositorios.
|
igor@377
|
94
|
igor@377
|
95 Si ha publicado un cambio en otro repositorio---particularmente si es
|
igor@377
|
96 un repositorio público---esencialmente está ``en terreno agreste,''
|
igor@377
|
97 y tendrá que reparar la equivocación de un modo distinto. Lo que
|
igor@377
|
98 pasará si publica un conjunto de cambios en algún sitio, hacer
|
igor@377
|
99 rollback y después volver a jalar del repositorio del cual había
|
igor@377
|
100 publicado, es que el conjunto de cambios reaparecerá en su repositorio.
|
igor@377
|
101
|
igor@377
|
102 (Si está absolutamente segruro de que el conjunto de cambios al que
|
igor@377
|
103 desea hacer rollback es el cambio más reciente del repositorio en el
|
igor@377
|
104 cual publicó, \emph{y} sabe que nadie más pudo haber jalado de tal
|
igor@377
|
105 repositorio, puede hacer rollback del conjunto de cambios allí, pero
|
igor@377
|
106 es mejor no confiar en una solución de este estilo. Si lo hace, tarde
|
igor@377
|
107 o temprano un conjunto de cambios logrará colarse en un repositorio
|
igor@377
|
108 que usted no controle directamente(o del cual se ha olvidado), y
|
igor@377
|
109 volverá a hostigarle.)
|
igor@377
|
110
|
igor@377
|
111 \subsection{Solamente hay un roll back}
|
igor@377
|
112
|
igor@377
|
113 Mercurial almacena exactamente una transacción en su bitácora de
|
igor@377
|
114 transacciones; tal transacción es la más reciente de las que haya
|
igor@377
|
115 ocurrido en el repositorio. Esto significa que solamente puede hacer
|
igor@377
|
116 roll back a una transacción. Si espera poder hacer roll back a una
|
igor@377
|
117 transacción después al antecesor, observará que no es el
|
igor@377
|
118 comportamiento que obtendrá.
|
jerojasro@343
|
119 \interaction{rollback.twice}
|
igor@377
|
120 Una vez que haya aplicado un rollback en una transacción a un
|
igor@377
|
121 repositorio, no podrá volver a hacer rollback hasta que haga una
|
igor@377
|
122 consignación o haya jalado.
|
jerojasro@343
|
123
|
igor@386
|
124 \section{Revertir un cambio equivocado}
|
igor@386
|
125
|
igor@386
|
126 Si modifica un fichero y se da cuenta que no quería realmente cambiar
|
igor@386
|
127 tal fichero, y todavía no ha consignado los cambios, la orden
|
igor@386
|
128 necesaria es \hgcmd{revert}. Observa el conjunto de cambios padre del
|
igor@386
|
129 directorio y restaura los contenidos del fichero al estado de tal
|
igor@386
|
130 conjunto de cambios. (Es una forma larga de decirlo, usualmente
|
igor@386
|
131 deshace sus modificaciones.)
|
igor@386
|
132
|
igor@386
|
133 Ilustremos como actúa la orden \hgcmd{revert} con un ejemplo
|
igor@386
|
134 pequeño. Comenzaremos modificando un fichero al cual Mercurial ya está
|
igor@386
|
135 siguiendo.
|
jerojasro@343
|
136 \interaction{daily.revert.modify}
|
igor@386
|
137 Si no queremos ese cambio, podemos aplicar \hgcmd{revert} al fichero.
|
jerojasro@343
|
138 \interaction{daily.revert.unmodify}
|
igor@386
|
139 La orden \hgcmd{revert} nos brinda un grado adicional de seguridad
|
igor@386
|
140 guardando nuestro fichero modificado con la extensión \filename{.orig}.
|
jerojasro@343
|
141 \interaction{daily.revert.status}
|
jerojasro@343
|
142
|
igor@386
|
143 Este es un resumen de casos en los cuales la orden \hgcmd{revert} es
|
igor@386
|
144 de utilidad. Describiremos cada uno de ellos con más detalle en la
|
igor@386
|
145 sección siguiente.
|
jerojasro@343
|
146 \begin{itemize}
|
igor@386
|
147 \item Si usted modifica un fichero, lo restaurará a su estado sin
|
igor@386
|
148 modificación previo.
|
igor@386
|
149 \item Si usted hace \hgcmd{add} a un fichero, revertirá el estado de
|
igor@386
|
150 ``adicionado'' del fichero, pero no lo tocará
|
igor@386
|
151 \item Si borra un fichero sin decirle a Mercurial, restaurará el
|
igor@386
|
152 fichero con sus contenidos sin modificación.
|
igor@386
|
153 \item Si usa la orden \hgcmd{remove} para eliminar un fichero, deshará
|
igor@386
|
154 el estado ``removido'' del fichero, y lo restaurará con sus
|
igor@386
|
155 contenidos sin modificación.
|
jerojasro@343
|
156 \end{itemize}
|
jerojasro@343
|
157
|
igor@386
|
158 \subsection{Errores al administrar ficheros}
|
jerojasro@343
|
159 \label{sec:undo:mgmt}
|
jerojasro@343
|
160
|
igor@386
|
161 La orden \hgcmd{revert} es útil para más que ficheros modificados. Le
|
igor@386
|
162 permite reversar los resultados de todas las órdenes de administración
|
igor@386
|
163 de ficheros que provee Mercurial---\hgcmd{add}, \hgcmd{remove}, y las
|
igor@386
|
164 demás.
|
igor@386
|
165
|
igor@386
|
166 Si usted hace \hgcmd{add} a un fichero, y no deseaba que Mercurial le
|
igor@386
|
167 diera seguimiento, use \hgcmd{revert} para deshacer la adición. No se
|
igor@386
|
168 preocupe; Mercurial no modificará de forma alguna el fichero.
|
igor@386
|
169 Solamente lo ``desmarcará''.
|
jerojasro@343
|
170 \interaction{daily.revert.add}
|
jerojasro@343
|
171
|
igor@386
|
172 De forma similar, Si le solicita a Mercurial hacer \hgcmd{remove} a un
|
igor@386
|
173 fichero, puede usar \hgcmd{revert} para restarurarlo a los contenidos
|
igor@386
|
174 que tenía la revisión padre del directorio de trabajo.
|
jerojasro@343
|
175 \interaction{daily.revert.remove}
|
igor@386
|
176 Funciona de la misma manera para un fichero que usted haya eliminado
|
igor@386
|
177 manualmente, sin decirle a Mercurial (recuerde que en la terminología
|
igor@386
|
178 de Mercurial esta clase de fichero se llama ``faltante'').
|
jerojasro@343
|
179 \interaction{daily.revert.missing}
|
jerojasro@343
|
180
|
igor@386
|
181 Si usted revierte un \hgcmd{copy}, el fichero a donde se copió
|
igor@386
|
182 permanece en su directorio de trabajo, pero sin seguimiento. Dado que
|
igor@386
|
183 una copia no afecta el fichero fuente de copiado de ninguna maner,
|
igor@386
|
184 Mercurial no hace nada con este.
|
jerojasro@343
|
185 \interaction{daily.revert.copy}
|
jerojasro@343
|
186
|
igor@386
|
187 \subsubsection{Un caso ligeramente especial:revertir un renombramiento}
|
igor@386
|
188
|
igor@386
|
189 Si hace \hgcmd{rename} a un fichero, hay un detalle que debe tener en
|
igor@386
|
190 cuenta. Cuando aplica \hgcmd{revert} a un cambio de nombre, no es
|
igor@386
|
191 suficiente proveer el nombre del fichero destino, como puede verlo en
|
igor@386
|
192 el siguiente ejemplo.
|
jerojasro@343
|
193 \interaction{daily.revert.rename}
|
igor@386
|
194 Como puede ver en la salida de \hgcmd{status}, el fichero con el nuevo
|
igor@386
|
195 nombre no se identifica más como agregado, pero el fichero con el
|
igor@386
|
196 nombre-\emph{inicial} se elimna! Esto es contra-intuitivo (por lo
|
igor@386
|
197 menos para mí), pero por lo menos es fácil arreglarlo.
|
jerojasro@343
|
198 \interaction{daily.revert.rename-orig}
|
igor@386
|
199 Por lo tanto, recuerde, para revertir un \hgcmd{rename}, debe proveer
|
igor@386
|
200 \emph{ambos} nombres, la fuente y el destino.
|
jerojasro@343
|
201
|
jerojasro@343
|
202 % TODO: the output doesn't look like it will be removed!
|
jerojasro@343
|
203
|
igor@386
|
204 (A propósito, si elimina un fichero, y modifica el fichero con el
|
igor@386
|
205 nuevo nombre, al revertir ambos componentes del renombramiento, cuando
|
igor@386
|
206 Mercurial restaure el fichero que fue eliminado como parte del
|
igor@386
|
207 renombramiento, no será modificado.
|
igor@386
|
208 Si necesita que las modificaciones en el archivo destino del
|
igor@386
|
209 renombramiento se muestren, no olvide copiarlas encima.)
|
igor@386
|
210
|
igor@387
|
211 Estos aspectos engorrosos al revertir un renombramiento se constituyen
|
igor@386
|
212 discutiblemente en un fallo de Mercurial.
|
jerojasro@343
|
213
|
igor@387
|
214 \section{Tratar cambios consignados}
|
igor@387
|
215
|
igor@387
|
216 Considere un caso en el que ha consignado el cambio $a$, y otro cambio
|
igor@387
|
217 $b$ sobre este; se ha dado cuenta que el cambio $a$ era
|
igor@387
|
218 incorrecto. Mercurial le permite ``retroceder'' un conjunto de cambios
|
igor@387
|
219 completo automáticamente, y construir bloques que le permitan revertir
|
igor@387
|
220 parte de un conjunto de cambios a mano.
|
igor@387
|
221
|
igor@387
|
222 Antes de leer esta sección, hay algo para tener en cuenta: la orden
|
igor@387
|
223 \hgcmd{backout} deshace cambios \emph{adicionando} a la historia, sin
|
igor@387
|
224 modificar o borrar. Es la herramienta correcta si está arreglando
|
igor@387
|
225 fallos, pero no si está tratando de deshacer algún cambio que tiene
|
igor@387
|
226 consecuencias catastróficas. Para tratar con esos, vea la sección~\ref{sec:undo:aaaiiieee}.
|
igor@387
|
227
|
igor@387
|
228 \subsection{Retroceder un conjunto de cambios}
|
igor@387
|
229
|
igor@387
|
230 La orden \hgcmd{backout} le permite ``deshacer'' los efectos de todo
|
igor@387
|
231 un conjunto de cambios de forma automatizada. Dado que la historia de
|
igor@387
|
232 Mercurial es inmutable, esta orden \emph{no} se deshace del conjunto
|
igor@387
|
233 de cambios que usted desea deshacer. En cambio, crea un nuevo
|
igor@387
|
234 conjunto de cambios que \emph{reversa} el conjunto de cambios que
|
igor@387
|
235 usted indique.
|
igor@387
|
236
|
igor@387
|
237 La operación de la orden \hgcmd{backout} es un poco intrincada, y lo
|
igor@387
|
238 ilustraremos con algunos ejemplos. Primero crearemos un repositorio
|
igor@387
|
239 con algunos cambios sencillos.
|
jerojasro@343
|
240 \interaction{backout.init}
|
jerojasro@343
|
241
|
igor@387
|
242 La orden \hgcmd{backout} toma un ID de conjunto de cambios como su
|
igor@387
|
243 argumento; el conjunto de cambios a retroceder. Normalmente
|
igor@387
|
244 \hgcmd{backout} le ofrecerá un editor de texto para escribir el
|
igor@387
|
245 mensaje de la consignación, para dejar un registro de por qué está
|
igor@387
|
246 retrocediendo. En este ejemplo, colocamos un mensaje en la
|
igor@387
|
247 consignación usando la opción \hgopt{backout}{-m} .
|
igor@387
|
248
|
igor@388
|
249 \subsection{Retroceder el conjunto de cambios punta}
|
igor@387
|
250
|
igor@387
|
251 Comenzamos retrocediendo el último conjunto de cambios que consignamos.
|
jerojasro@343
|
252 \interaction{backout.simple}
|
igor@387
|
253 Puede ver que la segunda línea de \filename{myfile} ya no está
|
igor@387
|
254 presente. La salida de \hgcmd{log} nos da una idea de lo que la orden
|
igor@387
|
255 \hgcmd{backout} ha hecho.
|
jerojasro@343
|
256 \interaction{backout.simple.log}
|
igor@387
|
257 Vea que el nuevo conjunto de cambios que \hgcmd{backout} ha creado es
|
igor@387
|
258 un hijo del conjunto de cambios que retrocedimos. Es más sencillo de
|
igor@387
|
259 ver en la figura~\ref{fig:undo:backout}, que presenta una vista
|
igor@387
|
260 gráfica de la historia de cambios. Como puede ver, la historia es
|
igor@387
|
261 bonita y lineal.
|
jerojasro@343
|
262
|
jerojasro@343
|
263 \begin{figure}[htb]
|
jerojasro@343
|
264 \centering
|
jerojasro@343
|
265 \grafix{undo-simple}
|
igor@387
|
266 \caption{Retroceso de un cambio con la orden \hgcmd{backout}}
|
jerojasro@343
|
267 \label{fig:undo:backout}
|
jerojasro@343
|
268 \end{figure}
|
jerojasro@343
|
269
|
igor@388
|
270 \subsection{Retroceso de un cambio que no es la punta}
|
igor@387
|
271
|
igor@387
|
272 Si desea retrocede un cambio distinto al último que ha consignado, use
|
igor@387
|
273 la opción \hgopt{backout}{--merge} a la orden \hgcmd{backout}.
|
jerojasro@343
|
274 \interaction{backout.non-tip.clone}
|
igor@387
|
275 Que resulta en un retroceso de un conjunto de cambios ``en un sólo
|
igor@387
|
276 tiro'', una operación que resulta normalmente rápida y sencilla.
|
jerojasro@343
|
277 \interaction{backout.non-tip.backout}
|
jerojasro@343
|
278
|
igor@387
|
279 Si ve los contenidos del fichero \filename{myfile} después de
|
igor@387
|
280 finalizar el retroceso, verá que el primer y el tercer cambio están
|
igor@387
|
281 presentes, pero no el segundo.
|
jerojasro@343
|
282 \interaction{backout.non-tip.cat}
|
jerojasro@343
|
283
|
igor@387
|
284 Como lo muestra la historia gráfica en la
|
igor@387
|
285 figura~\ref{fig:undo:backout-non-tip}, Mercurial realmente consigna
|
igor@387
|
286 \emph{dos} cambios en estas situaciones (los nodos encerrados en una
|
igor@387
|
287 caja son aquellos que Mercurial consigna automaticamente). Antes de
|
igor@387
|
288 que Mercurial comience el proceso de retroceso, primero recuerda cuál
|
igor@387
|
289 es el padre del directorio de trabajo. Posteriormente hace un
|
igor@387
|
290 retroceso al conjunto de cambios objetivo y lo consigna como un
|
igor@387
|
291 conjunto de cambios. Finalmente, fusiona con el padre anterior del
|
igor@387
|
292 directorio de trabajo, y consigna el resultado de la fusión.
|
jerojasro@343
|
293
|
jerojasro@343
|
294 % TODO: to me it looks like mercurial doesn't commit the second merge automatically!
|
jerojasro@343
|
295
|
jerojasro@343
|
296 \begin{figure}[htb]
|
jerojasro@343
|
297 \centering
|
jerojasro@343
|
298 \grafix{undo-non-tip}
|
igor@388
|
299 \caption{Retroceso automatizado de un cambio a algo que no es la punta con la orden \hgcmd{backout}}
|
jerojasro@343
|
300 \label{fig:undo:backout-non-tip}
|
jerojasro@343
|
301 \end{figure}
|
jerojasro@343
|
302
|
igor@387
|
303 El resultado es que usted termina ``donde estaba'', solamente con un
|
igor@387
|
304 poco de historia adicional que deshace el efecto de un conjunto de
|
igor@387
|
305 cambios que usted quería evitar.
|
jerojasro@343
|
306
|
igor@388
|
307 \subsubsection{Use siempre la opción \hgopt{backout}{--merge}}
|
igor@388
|
308
|
igor@388
|
309 De hecho, dado que la opción \hgopt{backout}{--merge} siempre hara lo
|
igor@388
|
310 ``correcto'' esté o no retrocediendo el conjunto de cambios punta
|
igor@388
|
311 (p.e.~no tratará de fusionar si está retrocediendo la punta, dado que
|
igor@388
|
312 no es necesario), usted debería usar \emph{siempre} esta opción cuando
|
igor@388
|
313 ejecuta la orden \hgcmd{backout}.
|
igor@388
|
314
|
igor@388
|
315 \subsection{Más control sobre el proceso de retroceso}
|
igor@388
|
316
|
igor@388
|
317 A pesar de que recomiendo usar siempre la opción
|
igor@388
|
318 \hgopt{backout}{--merge} cuando está retrocediendo un cambio, la orden
|
igor@388
|
319 \hgcmd{backout} le permite decidir cómo mezclar un retroceso de un
|
igor@388
|
320 conjunto de cambios. Es muy extraño que usted necestite tomar control
|
igor@388
|
321 del proceso de retroceso de forma manual, pero puede ser útil entender
|
igor@388
|
322 lo que la orden \hgcmd{backout} está haciendo automáticamente para
|
igor@388
|
323 usted. Para ilustrarlo, clonemos nuestro primer repositorio, pero
|
igor@388
|
324 omitamos el retroceso que contiene.
|
jerojasro@343
|
325
|
jerojasro@343
|
326 \interaction{backout.manual.clone}
|
igor@388
|
327 Como en el ejemplo anterior, consignaremos un tercer cambio, después
|
igor@388
|
328 haremos retroceso de su padre, y veremos qué pasa.
|
jerojasro@343
|
329 \interaction{backout.manual.backout}
|
igor@388
|
330 Nuestro nuevo conjunto de cambios es de nuevo un descendiente del
|
igor@388
|
331 conjunto de cambio que retrocedimos; es por lo tanto una nueva cabeza,
|
igor@388
|
332 \emph{no} un descendiente del conjunto de cambios que era la punta. La
|
igor@388
|
333 orden \hgcmd{backout} fue muy explícita diciéndolo.
|
jerojasro@343
|
334 \interaction{backout.manual.log}
|
jerojasro@343
|
335
|
igor@388
|
336 De nuevo, es más sencillo lo que pasó viendo una gráfica de la
|
igor@388
|
337 historia de revisiones, en la figura~\ref{fig:undo:backout-manual}.
|
igor@388
|
338 Esto nos aclara que cuando usamos \hgcmd{backout} para retroceder un
|
igor@388
|
339 cambio a algo que no sea la punta, Mercurial añade una nueva cabeza al
|
igor@388
|
340 repositorio (el cambio que consignó está encerrado en una caja).
|
jerojasro@343
|
341
|
jerojasro@343
|
342 \begin{figure}[htb]
|
jerojasro@343
|
343 \centering
|
jerojasro@343
|
344 \grafix{undo-manual}
|
igor@388
|
345 \caption{Retroceso usando la orden \hgcmd{backout}}
|
jerojasro@343
|
346 \label{fig:undo:backout-manual}
|
jerojasro@343
|
347 \end{figure}
|
jerojasro@343
|
348
|
igor@388
|
349 Después de que la orden \hgcmd{backout} ha terminado, deja un nuevo
|
igor@388
|
350 conjunto de cambios de ``retroceso'' como el padre del directorio de trabajo.
|
jerojasro@343
|
351 \interaction{backout.manual.parents}
|
igor@388
|
352 Ahora tenemos dos conjuntos de cambios aislados.
|
jerojasro@343
|
353 \interaction{backout.manual.heads}
|
jerojasro@343
|
354
|
igor@388
|
355 Reflexionemos acerca de lo que esperamos ver como contenidos de
|
igor@388
|
356 \filename{myfile}. El primer cambio debería estar presente, porque
|
igor@388
|
357 nunca le hicimos retroceso. El segundo cambio debió desaparecer,
|
igor@388
|
358 puesto que es el que retrocedimos. Dado que la gráfica de la historia
|
igor@388
|
359 muestra que el tercer camlio es una cabeza separada, \emph{no}
|
igor@388
|
360 esperamos ver el tercer cambio presente en \filename{myfile}.
|
jerojasro@343
|
361 \interaction{backout.manual.cat}
|
igor@388
|
362 Para que el tercer cambio esté en el archivo, hacemos una fusión usual
|
igor@388
|
363 de las dos cabezas.
|
jerojasro@343
|
364 \interaction{backout.manual.merge}
|
igor@388
|
365 Después de eso, la historia gráfica de nuestro repositorio luce como
|
igor@388
|
366 la figura~\ref{fig:undo:backout-manual-merge}.
|
jerojasro@343
|
367
|
jerojasro@343
|
368 \begin{figure}[htb]
|
jerojasro@343
|
369 \centering
|
jerojasro@343
|
370 \grafix{undo-manual-merge}
|
igor@388
|
371 \caption{Fusión manual de un retroceso}
|
jerojasro@343
|
372 \label{fig:undo:backout-manual-merge}
|
jerojasro@343
|
373 \end{figure}
|
jerojasro@343
|
374
|
igor@388
|
375 \subsection{Por qué \hgcmd{backout} hace lo que hace}
|
igor@388
|
376
|
igor@388
|
377 Esta es una descripción corta de cómo trabaja la orden \hgcmd{backout}.
|
jerojasro@343
|
378 \begin{enumerate}
|
igor@388
|
379 \item Se asegura de que el directorio de trabajo es ``limpio'', esto
|
igor@388
|
380 es, que la salida de \hgcmd{status} debería ser vacía.
|
igor@388
|
381 \item Recuerda el padre actual del directorio de trabajo. A este
|
igor@388
|
382 conjunto de cambio lo llamaremos \texttt{orig}
|
igor@388
|
383 \item Hace el equivalente de un \hgcmd{update} para sincronizar el
|
igor@388
|
384 directorio de trabajo con el conjunto de cambios que usted quiere
|
igor@388
|
385 retroceder. Lo llamaremos \texttt{backout}
|
igor@388
|
386 \item Encuentra el padre del conjunto de cambios. Lo llamaremos
|
igor@388
|
387 \texttt{parent}.
|
igor@388
|
388 \item Para cada archivo del conjunto de cambios que el
|
igor@388
|
389 \texttt{retroceso} afecte, hará el equivalente a
|
igor@388
|
390 \hgcmdargs{revert}{-r parent} sobre ese fichero, para restaurarlo a
|
igor@388
|
391 los contenidos que tenía antes de que el conjunto de cambios fuera
|
igor@388
|
392 consignado.
|
igor@388
|
393 \item Se consigna el resultado como un nuevo conjunto de cambios y
|
igor@388
|
394 tiene a \texttt{backout} como su padre.
|
igor@388
|
395 \item Si especifica \hgopt{backout}{--merge} en la línea de comandos,
|
igor@388
|
396 se fusiona con \texttt{orig}, y se consigna el resultado de la
|
igor@388
|
397 fusión.
|
jerojasro@343
|
398 \end{enumerate}
|
jerojasro@343
|
399
|
igor@388
|
400 Una vía alternativa de implementar la orden \hgcmd{backout} sería usar
|
igor@388
|
401 \hgcmd{export} sobre el conjunto de cambios a retroceder como un diff
|
igor@388
|
402 y después usar laa opción \cmdopt{patch}{--reverse} de la orden
|
igor@388
|
403 \command{patch} para reversar el efecto del cambio sin molestar el
|
igor@388
|
404 directorio de trabajo. Suena mucho más simple, pero no funcionaría
|
igor@388
|
405 bien ni de cerca.
|
igor@388
|
406
|
igor@388
|
407 La razón por la cual \hgcmd{backout} hace una actualización, una
|
igor@388
|
408 consignación, una fusión y otra consignación es para dar a la
|
igor@388
|
409 maquinaria de fusión la mayor oportunidad de hacer un buen trabajo
|
igor@388
|
410 cuando se trata con todos los cambios \emph{entre} el cambio que está
|
igor@388
|
411 retrocediendo y la punta actual.
|
igor@388
|
412
|
igor@388
|
413 Si está retrocediendo un conjunto de cambios que está a unas ~100
|
igor@388
|
414 atrás en su historia del proyecto, las posibilidades de que una orden
|
igor@388
|
415 \command{patch} sea capaz de ser aplicada a un diff reverso,
|
igor@388
|
416 claramente no son altas, porque los cambios que intervienen podrían
|
igor@388
|
417 ``no coincidir con el contexto'' que \command{patch} usa para
|
igor@388
|
418 determinar si puede aplicar un parche (si esto suena como cháchara,
|
igor@388
|
419 vea una discusión de la orden \command{patch} en \ref{sec:mq:patch}).
|
igor@388
|
420 Adicionalmente, la maquinaria de fusión de Mercurial manejará ficheros
|
igor@388
|
421 y directorios renombrados, cambios de permisos, y modificaciones a
|
igor@388
|
422 archivos binarios, nada de lo cual la orden \command{patch} puede manejar.
|
jerojasro@343
|
423
|
jerojasro@343
|
424 \section{Changes that should never have been}
|
jerojasro@343
|
425 \label{sec:undo:aaaiiieee}
|
jerojasro@343
|
426
|
jerojasro@343
|
427 Most of the time, the \hgcmd{backout} command is exactly what you need
|
jerojasro@343
|
428 if you want to undo the effects of a change. It leaves a permanent
|
jerojasro@343
|
429 record of exactly what you did, both when committing the original
|
jerojasro@343
|
430 changeset and when you cleaned up after it.
|
jerojasro@343
|
431
|
jerojasro@343
|
432 On rare occasions, though, you may find that you've committed a change
|
jerojasro@343
|
433 that really should not be present in the repository at all. For
|
jerojasro@343
|
434 example, it would be very unusual, and usually considered a mistake,
|
jerojasro@343
|
435 to commit a software project's object files as well as its source
|
jerojasro@343
|
436 files. Object files have almost no intrinsic value, and they're
|
jerojasro@343
|
437 \emph{big}, so they increase the size of the repository and the amount
|
jerojasro@343
|
438 of time it takes to clone or pull changes.
|
jerojasro@343
|
439
|
jerojasro@343
|
440 Before I discuss the options that you have if you commit a ``brown
|
jerojasro@343
|
441 paper bag'' change (the kind that's so bad that you want to pull a
|
jerojasro@343
|
442 brown paper bag over your head), let me first discuss some approaches
|
jerojasro@343
|
443 that probably won't work.
|
jerojasro@343
|
444
|
jerojasro@343
|
445 Since Mercurial treats history as accumulative---every change builds
|
jerojasro@343
|
446 on top of all changes that preceded it---you generally can't just make
|
jerojasro@343
|
447 disastrous changes disappear. The one exception is when you've just
|
jerojasro@343
|
448 committed a change, and it hasn't been pushed or pulled into another
|
jerojasro@343
|
449 repository. That's when you can safely use the \hgcmd{rollback}
|
jerojasro@343
|
450 command, as I detailed in section~\ref{sec:undo:rollback}.
|
jerojasro@343
|
451
|
jerojasro@343
|
452 After you've pushed a bad change to another repository, you
|
jerojasro@343
|
453 \emph{could} still use \hgcmd{rollback} to make your local copy of the
|
jerojasro@343
|
454 change disappear, but it won't have the consequences you want. The
|
jerojasro@343
|
455 change will still be present in the remote repository, so it will
|
jerojasro@343
|
456 reappear in your local repository the next time you pull.
|
jerojasro@343
|
457
|
jerojasro@343
|
458 If a situation like this arises, and you know which repositories your
|
jerojasro@343
|
459 bad change has propagated into, you can \emph{try} to get rid of the
|
jerojasro@343
|
460 changeefrom \emph{every} one of those repositories. This is, of
|
jerojasro@343
|
461 course, not a satisfactory solution: if you miss even a single
|
jerojasro@343
|
462 repository while you're expunging, the change is still ``in the
|
jerojasro@343
|
463 wild'', and could propagate further.
|
jerojasro@343
|
464
|
jerojasro@343
|
465 If you've committed one or more changes \emph{after} the change that
|
jerojasro@343
|
466 you'd like to see disappear, your options are further reduced.
|
jerojasro@343
|
467 Mercurial doesn't provide a way to ``punch a hole'' in history,
|
jerojasro@343
|
468 leaving changesets intact.
|
jerojasro@343
|
469
|
jerojasro@343
|
470 XXX This needs filling out. The \texttt{hg-replay} script in the
|
jerojasro@343
|
471 \texttt{examples} directory works, but doesn't handle merge
|
jerojasro@343
|
472 changesets. Kind of an important omission.
|
jerojasro@343
|
473
|
jerojasro@343
|
474 \subsection{Protect yourself from ``escaped'' changes}
|
jerojasro@343
|
475
|
jerojasro@343
|
476 If you've committed some changes to your local repository and they've
|
jerojasro@343
|
477 been pushed or pulled somewhere else, this isn't necessarily a
|
jerojasro@343
|
478 disaster. You can protect yourself ahead of time against some classes
|
jerojasro@343
|
479 of bad changeset. This is particularly easy if your team usually
|
jerojasro@343
|
480 pulls changes from a central repository.
|
jerojasro@343
|
481
|
jerojasro@343
|
482 By configuring some hooks on that repository to validate incoming
|
jerojasro@343
|
483 changesets (see chapter~\ref{chap:hook}), you can automatically
|
jerojasro@343
|
484 prevent some kinds of bad changeset from being pushed to the central
|
jerojasro@343
|
485 repository at all. With such a configuration in place, some kinds of
|
jerojasro@343
|
486 bad changeset will naturally tend to ``die out'' because they can't
|
jerojasro@343
|
487 propagate into the central repository. Better yet, this happens
|
jerojasro@343
|
488 without any need for explicit intervention.
|
jerojasro@343
|
489
|
jerojasro@343
|
490 For instance, an incoming change hook that verifies that a changeset
|
jerojasro@343
|
491 will actually compile can prevent people from inadvertantly ``breaking
|
jerojasro@343
|
492 the build''.
|
jerojasro@343
|
493
|
jerojasro@343
|
494 \section{Finding the source of a bug}
|
jerojasro@343
|
495 \label{sec:undo:bisect}
|
jerojasro@343
|
496
|
jerojasro@343
|
497 While it's all very well to be able to back out a changeset that
|
jerojasro@343
|
498 introduced a bug, this requires that you know which changeset to back
|
jerojasro@343
|
499 out. Mercurial provides an invaluable command, called
|
jerojasro@343
|
500 \hgcmd{bisect}, that helps you to automate this process and accomplish
|
jerojasro@343
|
501 it very efficiently.
|
jerojasro@343
|
502
|
jerojasro@343
|
503 The idea behind the \hgcmd{bisect} command is that a changeset has
|
jerojasro@343
|
504 introduced some change of behaviour that you can identify with a
|
jerojasro@343
|
505 simple binary test. You don't know which piece of code introduced the
|
jerojasro@343
|
506 change, but you know how to test for the presence of the bug. The
|
jerojasro@343
|
507 \hgcmd{bisect} command uses your test to direct its search for the
|
jerojasro@343
|
508 changeset that introduced the code that caused the bug.
|
jerojasro@343
|
509
|
jerojasro@343
|
510 Here are a few scenarios to help you understand how you might apply
|
jerojasro@343
|
511 this command.
|
jerojasro@343
|
512 \begin{itemize}
|
jerojasro@343
|
513 \item The most recent version of your software has a bug that you
|
jerojasro@343
|
514 remember wasn't present a few weeks ago, but you don't know when it
|
jerojasro@343
|
515 was introduced. Here, your binary test checks for the presence of
|
jerojasro@343
|
516 that bug.
|
jerojasro@343
|
517 \item You fixed a bug in a rush, and now it's time to close the entry
|
jerojasro@343
|
518 in your team's bug database. The bug database requires a changeset
|
jerojasro@343
|
519 ID when you close an entry, but you don't remember which changeset
|
jerojasro@343
|
520 you fixed the bug in. Once again, your binary test checks for the
|
jerojasro@343
|
521 presence of the bug.
|
jerojasro@343
|
522 \item Your software works correctly, but runs~15\% slower than the
|
jerojasro@343
|
523 last time you measured it. You want to know which changeset
|
jerojasro@343
|
524 introduced the performance regression. In this case, your binary
|
jerojasro@343
|
525 test measures the performance of your software, to see whether it's
|
jerojasro@343
|
526 ``fast'' or ``slow''.
|
jerojasro@343
|
527 \item The sizes of the components of your project that you ship
|
jerojasro@343
|
528 exploded recently, and you suspect that something changed in the way
|
jerojasro@343
|
529 you build your project.
|
jerojasro@343
|
530 \end{itemize}
|
jerojasro@343
|
531
|
jerojasro@343
|
532 From these examples, it should be clear that the \hgcmd{bisect}
|
jerojasro@343
|
533 command is not useful only for finding the sources of bugs. You can
|
jerojasro@343
|
534 use it to find any ``emergent property'' of a repository (anything
|
jerojasro@343
|
535 that you can't find from a simple text search of the files in the
|
jerojasro@343
|
536 tree) for which you can write a binary test.
|
jerojasro@343
|
537
|
jerojasro@343
|
538 We'll introduce a little bit of terminology here, just to make it
|
jerojasro@343
|
539 clear which parts of the search process are your responsibility, and
|
jerojasro@343
|
540 which are Mercurial's. A \emph{test} is something that \emph{you} run
|
jerojasro@343
|
541 when \hgcmd{bisect} chooses a changeset. A \emph{probe} is what
|
jerojasro@343
|
542 \hgcmd{bisect} runs to tell whether a revision is good. Finally,
|
jerojasro@343
|
543 we'll use the word ``bisect'', as both a noun and a verb, to stand in
|
jerojasro@343
|
544 for the phrase ``search using the \hgcmd{bisect} command.
|
jerojasro@343
|
545
|
jerojasro@343
|
546 One simple way to automate the searching process would be simply to
|
jerojasro@343
|
547 probe every changeset. However, this scales poorly. If it took ten
|
jerojasro@343
|
548 minutes to test a single changeset, and you had 10,000 changesets in
|
jerojasro@343
|
549 your repository, the exhaustive approach would take on average~35
|
jerojasro@343
|
550 \emph{days} to find the changeset that introduced a bug. Even if you
|
jerojasro@343
|
551 knew that the bug was introduced by one of the last 500 changesets,
|
jerojasro@343
|
552 and limited your search to those, you'd still be looking at over 40
|
jerojasro@343
|
553 hours to find the changeset that introduced your bug.
|
jerojasro@343
|
554
|
jerojasro@343
|
555 What the \hgcmd{bisect} command does is use its knowledge of the
|
jerojasro@343
|
556 ``shape'' of your project's revision history to perform a search in
|
jerojasro@343
|
557 time proportional to the \emph{logarithm} of the number of changesets
|
jerojasro@343
|
558 to check (the kind of search it performs is called a dichotomic
|
jerojasro@343
|
559 search). With this approach, searching through 10,000 changesets will
|
jerojasro@343
|
560 take less than three hours, even at ten minutes per test (the search
|
jerojasro@343
|
561 will require about 14 tests). Limit your search to the last hundred
|
jerojasro@343
|
562 changesets, and it will take only about an hour (roughly seven tests).
|
jerojasro@343
|
563
|
jerojasro@343
|
564 The \hgcmd{bisect} command is aware of the ``branchy'' nature of a
|
jerojasro@343
|
565 Mercurial project's revision history, so it has no problems dealing
|
jerojasro@343
|
566 with branches, merges, or multiple heads in a repoository. It can
|
jerojasro@343
|
567 prune entire branches of history with a single probe, which is how it
|
jerojasro@343
|
568 operates so efficiently.
|
jerojasro@343
|
569
|
jerojasro@343
|
570 \subsection{Using the \hgcmd{bisect} command}
|
jerojasro@343
|
571
|
jerojasro@343
|
572 Here's an example of \hgcmd{bisect} in action.
|
jerojasro@343
|
573
|
jerojasro@343
|
574 \begin{note}
|
jerojasro@343
|
575 In versions 0.9.5 and earlier of Mercurial, \hgcmd{bisect} was not a
|
jerojasro@343
|
576 core command: it was distributed with Mercurial as an extension.
|
jerojasro@343
|
577 This section describes the built-in command, not the old extension.
|
jerojasro@343
|
578 \end{note}
|
jerojasro@343
|
579
|
jerojasro@343
|
580 Now let's create a repository, so that we can try out the
|
jerojasro@343
|
581 \hgcmd{bisect} command in isolation.
|
jerojasro@343
|
582 \interaction{bisect.init}
|
jerojasro@343
|
583 We'll simulate a project that has a bug in it in a simple-minded way:
|
jerojasro@343
|
584 create trivial changes in a loop, and nominate one specific change
|
jerojasro@343
|
585 that will have the ``bug''. This loop creates 35 changesets, each
|
jerojasro@343
|
586 adding a single file to the repository. We'll represent our ``bug''
|
jerojasro@343
|
587 with a file that contains the text ``i have a gub''.
|
jerojasro@343
|
588 \interaction{bisect.commits}
|
jerojasro@343
|
589
|
jerojasro@343
|
590 The next thing that we'd like to do is figure out how to use the
|
jerojasro@343
|
591 \hgcmd{bisect} command. We can use Mercurial's normal built-in help
|
jerojasro@343
|
592 mechanism for this.
|
jerojasro@343
|
593 \interaction{bisect.help}
|
jerojasro@343
|
594
|
jerojasro@343
|
595 The \hgcmd{bisect} command works in steps. Each step proceeds as follows.
|
jerojasro@343
|
596 \begin{enumerate}
|
jerojasro@343
|
597 \item You run your binary test.
|
jerojasro@343
|
598 \begin{itemize}
|
jerojasro@343
|
599 \item If the test succeeded, you tell \hgcmd{bisect} by running the
|
jerojasro@343
|
600 \hgcmdargs{bisect}{good} command.
|
jerojasro@343
|
601 \item If it failed, run the \hgcmdargs{bisect}{--bad} command.
|
jerojasro@343
|
602 \end{itemize}
|
jerojasro@343
|
603 \item The command uses your information to decide which changeset to
|
jerojasro@343
|
604 test next.
|
jerojasro@343
|
605 \item It updates the working directory to that changeset, and the
|
jerojasro@343
|
606 process begins again.
|
jerojasro@343
|
607 \end{enumerate}
|
jerojasro@343
|
608 The process ends when \hgcmd{bisect} identifies a unique changeset
|
jerojasro@343
|
609 that marks the point where your test transitioned from ``succeeding''
|
jerojasro@343
|
610 to ``failing''.
|
jerojasro@343
|
611
|
jerojasro@343
|
612 To start the search, we must run the \hgcmdargs{bisect}{--reset} command.
|
jerojasro@343
|
613 \interaction{bisect.search.init}
|
jerojasro@343
|
614
|
jerojasro@343
|
615 In our case, the binary test we use is simple: we check to see if any
|
jerojasro@343
|
616 file in the repository contains the string ``i have a gub''. If it
|
jerojasro@343
|
617 does, this changeset contains the change that ``caused the bug''. By
|
jerojasro@343
|
618 convention, a changeset that has the property we're searching for is
|
jerojasro@343
|
619 ``bad'', while one that doesn't is ``good''.
|
jerojasro@343
|
620
|
jerojasro@343
|
621 Most of the time, the revision to which the working directory is
|
jerojasro@343
|
622 synced (usually the tip) already exhibits the problem introduced by
|
jerojasro@343
|
623 the buggy change, so we'll mark it as ``bad''.
|
jerojasro@343
|
624 \interaction{bisect.search.bad-init}
|
jerojasro@343
|
625
|
jerojasro@343
|
626 Our next task is to nominate a changeset that we know \emph{doesn't}
|
jerojasro@343
|
627 have the bug; the \hgcmd{bisect} command will ``bracket'' its search
|
jerojasro@343
|
628 between the first pair of good and bad changesets. In our case, we
|
jerojasro@343
|
629 know that revision~10 didn't have the bug. (I'll have more words
|
jerojasro@343
|
630 about choosing the first ``good'' changeset later.)
|
jerojasro@343
|
631 \interaction{bisect.search.good-init}
|
jerojasro@343
|
632
|
jerojasro@343
|
633 Notice that this command printed some output.
|
jerojasro@343
|
634 \begin{itemize}
|
jerojasro@343
|
635 \item It told us how many changesets it must consider before it can
|
jerojasro@343
|
636 identify the one that introduced the bug, and how many tests that
|
jerojasro@343
|
637 will require.
|
jerojasro@343
|
638 \item It updated the working directory to the next changeset to test,
|
jerojasro@343
|
639 and told us which changeset it's testing.
|
jerojasro@343
|
640 \end{itemize}
|
jerojasro@343
|
641
|
jerojasro@343
|
642 We now run our test in the working directory. We use the
|
jerojasro@343
|
643 \command{grep} command to see if our ``bad'' file is present in the
|
jerojasro@343
|
644 working directory. If it is, this revision is bad; if not, this
|
jerojasro@343
|
645 revision is good.
|
jerojasro@343
|
646 \interaction{bisect.search.step1}
|
jerojasro@343
|
647
|
jerojasro@343
|
648 This test looks like a perfect candidate for automation, so let's turn
|
jerojasro@343
|
649 it into a shell function.
|
jerojasro@343
|
650 \interaction{bisect.search.mytest}
|
jerojasro@343
|
651 We can now run an entire test step with a single command,
|
jerojasro@343
|
652 \texttt{mytest}.
|
jerojasro@343
|
653 \interaction{bisect.search.step2}
|
jerojasro@343
|
654 A few more invocations of our canned test step command, and we're
|
jerojasro@343
|
655 done.
|
jerojasro@343
|
656 \interaction{bisect.search.rest}
|
jerojasro@343
|
657
|
jerojasro@343
|
658 Even though we had~40 changesets to search through, the \hgcmd{bisect}
|
jerojasro@343
|
659 command let us find the changeset that introduced our ``bug'' with
|
jerojasro@343
|
660 only five tests. Because the number of tests that the \hgcmd{bisect}
|
jerojasro@343
|
661 command performs grows logarithmically with the number of changesets to
|
jerojasro@343
|
662 search, the advantage that it has over the ``brute force'' search
|
jerojasro@343
|
663 approach increases with every changeset you add.
|
jerojasro@343
|
664
|
jerojasro@343
|
665 \subsection{Cleaning up after your search}
|
jerojasro@343
|
666
|
jerojasro@343
|
667 When you're finished using the \hgcmd{bisect} command in a
|
jerojasro@343
|
668 repository, you can use the \hgcmdargs{bisect}{reset} command to drop
|
jerojasro@343
|
669 the information it was using to drive your search. The command
|
jerojasro@343
|
670 doesn't use much space, so it doesn't matter if you forget to run this
|
jerojasro@343
|
671 command. However, \hgcmd{bisect} won't let you start a new search in
|
jerojasro@343
|
672 that repository until you do a \hgcmdargs{bisect}{reset}.
|
jerojasro@343
|
673 \interaction{bisect.search.reset}
|
jerojasro@343
|
674
|
jerojasro@343
|
675 \section{Tips for finding bugs effectively}
|
jerojasro@343
|
676
|
jerojasro@343
|
677 \subsection{Give consistent input}
|
jerojasro@343
|
678
|
jerojasro@343
|
679 The \hgcmd{bisect} command requires that you correctly report the
|
jerojasro@343
|
680 result of every test you perform. If you tell it that a test failed
|
jerojasro@343
|
681 when it really succeeded, it \emph{might} be able to detect the
|
jerojasro@343
|
682 inconsistency. If it can identify an inconsistency in your reports,
|
jerojasro@343
|
683 it will tell you that a particular changeset is both good and bad.
|
jerojasro@343
|
684 However, it can't do this perfectly; it's about as likely to report
|
jerojasro@343
|
685 the wrong changeset as the source of the bug.
|
jerojasro@343
|
686
|
jerojasro@343
|
687 \subsection{Automate as much as possible}
|
jerojasro@343
|
688
|
jerojasro@343
|
689 When I started using the \hgcmd{bisect} command, I tried a few times
|
jerojasro@343
|
690 to run my tests by hand, on the command line. This is an approach
|
jerojasro@343
|
691 that I, at least, am not suited to. After a few tries, I found that I
|
jerojasro@343
|
692 was making enough mistakes that I was having to restart my searches
|
jerojasro@343
|
693 several times before finally getting correct results.
|
jerojasro@343
|
694
|
jerojasro@343
|
695 My initial problems with driving the \hgcmd{bisect} command by hand
|
jerojasro@343
|
696 occurred even with simple searches on small repositories; if the
|
jerojasro@343
|
697 problem you're looking for is more subtle, or the number of tests that
|
jerojasro@343
|
698 \hgcmd{bisect} must perform increases, the likelihood of operator
|
jerojasro@343
|
699 error ruining the search is much higher. Once I started automating my
|
jerojasro@343
|
700 tests, I had much better results.
|
jerojasro@343
|
701
|
jerojasro@343
|
702 The key to automated testing is twofold:
|
jerojasro@343
|
703 \begin{itemize}
|
jerojasro@343
|
704 \item always test for the same symptom, and
|
jerojasro@343
|
705 \item always feed consistent input to the \hgcmd{bisect} command.
|
jerojasro@343
|
706 \end{itemize}
|
jerojasro@343
|
707 In my tutorial example above, the \command{grep} command tests for the
|
jerojasro@343
|
708 symptom, and the \texttt{if} statement takes the result of this check
|
jerojasro@343
|
709 and ensures that we always feed the same input to the \hgcmd{bisect}
|
jerojasro@343
|
710 command. The \texttt{mytest} function marries these together in a
|
jerojasro@343
|
711 reproducible way, so that every test is uniform and consistent.
|
jerojasro@343
|
712
|
jerojasro@343
|
713 \subsection{Check your results}
|
jerojasro@343
|
714
|
jerojasro@343
|
715 Because the output of a \hgcmd{bisect} search is only as good as the
|
jerojasro@343
|
716 input you give it, don't take the changeset it reports as the
|
jerojasro@343
|
717 absolute truth. A simple way to cross-check its report is to manually
|
jerojasro@343
|
718 run your test at each of the following changesets:
|
jerojasro@343
|
719 \begin{itemize}
|
jerojasro@343
|
720 \item The changeset that it reports as the first bad revision. Your
|
jerojasro@343
|
721 test should still report this as bad.
|
jerojasro@343
|
722 \item The parent of that changeset (either parent, if it's a merge).
|
jerojasro@343
|
723 Your test should report this changeset as good.
|
jerojasro@343
|
724 \item A child of that changeset. Your test should report this
|
jerojasro@343
|
725 changeset as bad.
|
jerojasro@343
|
726 \end{itemize}
|
jerojasro@343
|
727
|
jerojasro@343
|
728 \subsection{Beware interference between bugs}
|
jerojasro@343
|
729
|
jerojasro@343
|
730 It's possible that your search for one bug could be disrupted by the
|
jerojasro@343
|
731 presence of another. For example, let's say your software crashes at
|
jerojasro@343
|
732 revision 100, and worked correctly at revision 50. Unknown to you,
|
jerojasro@343
|
733 someone else introduced a different crashing bug at revision 60, and
|
jerojasro@343
|
734 fixed it at revision 80. This could distort your results in one of
|
jerojasro@343
|
735 several ways.
|
jerojasro@343
|
736
|
jerojasro@343
|
737 It is possible that this other bug completely ``masks'' yours, which
|
jerojasro@343
|
738 is to say that it occurs before your bug has a chance to manifest
|
jerojasro@343
|
739 itself. If you can't avoid that other bug (for example, it prevents
|
jerojasro@343
|
740 your project from building), and so can't tell whether your bug is
|
jerojasro@343
|
741 present in a particular changeset, the \hgcmd{bisect} command cannot
|
jerojasro@343
|
742 help you directly. Instead, you can mark a changeset as untested by
|
jerojasro@343
|
743 running \hgcmdargs{bisect}{--skip}.
|
jerojasro@343
|
744
|
jerojasro@343
|
745 A different problem could arise if your test for a bug's presence is
|
jerojasro@343
|
746 not specific enough. If you check for ``my program crashes'', then
|
jerojasro@343
|
747 both your crashing bug and an unrelated crashing bug that masks it
|
jerojasro@343
|
748 will look like the same thing, and mislead \hgcmd{bisect}.
|
jerojasro@343
|
749
|
jerojasro@343
|
750 Another useful situation in which to use \hgcmdargs{bisect}{--skip} is
|
jerojasro@343
|
751 if you can't test a revision because your project was in a broken and
|
jerojasro@343
|
752 hence untestable state at that revision, perhaps because someone
|
jerojasro@343
|
753 checked in a change that prevented the project from building.
|
jerojasro@343
|
754
|
jerojasro@343
|
755 \subsection{Bracket your search lazily}
|
jerojasro@343
|
756
|
jerojasro@343
|
757 Choosing the first ``good'' and ``bad'' changesets that will mark the
|
jerojasro@343
|
758 end points of your search is often easy, but it bears a little
|
jerojasro@343
|
759 discussion nevertheless. From the perspective of \hgcmd{bisect}, the
|
jerojasro@343
|
760 ``newest'' changeset is conventionally ``bad'', and the older
|
jerojasro@343
|
761 changeset is ``good''.
|
jerojasro@343
|
762
|
jerojasro@343
|
763 If you're having trouble remembering when a suitable ``good'' change
|
jerojasro@343
|
764 was, so that you can tell \hgcmd{bisect}, you could do worse than
|
jerojasro@343
|
765 testing changesets at random. Just remember to eliminate contenders
|
jerojasro@343
|
766 that can't possibly exhibit the bug (perhaps because the feature with
|
jerojasro@343
|
767 the bug isn't present yet) and those where another problem masks the
|
jerojasro@343
|
768 bug (as I discussed above).
|
jerojasro@343
|
769
|
jerojasro@343
|
770 Even if you end up ``early'' by thousands of changesets or months of
|
jerojasro@343
|
771 history, you will only add a handful of tests to the total number that
|
jerojasro@343
|
772 \hgcmd{bisect} must perform, thanks to its logarithmic behaviour.
|
jerojasro@343
|
773
|
jerojasro@343
|
774 %%% Local Variables:
|
jerojasro@343
|
775 %%% mode: latex
|
jerojasro@343
|
776 %%% TeX-master: "00book"
|
jerojasro@343
|
777 %%% End:
|