hgbook
view es/mq-collab.tex @ 531:d2b1369e58d0
passed the file through spell check
also corrected a couple of redaction problems
also corrected a couple of redaction problems
| author | Javier Rojas <jerojasro@devnull.li> |
|---|---|
| date | Sun Jan 25 11:40:32 2009 -0500 (2009-01-25) |
| parents | a8cdb3cac133 |
| children |
line source
1 \chapter{Usos avanzados de las Colas de Mercurial}
2 \label{chap:mq-collab}
4 Auunque es fácil aprender los usos más directos de las Colas de
5 Mercurial, tener algo de disciplina junto con algunas de las
6 capacidadees menos usadas de MQ hace posible trabajar en entornos de
7 desarrollo complejos.
9 En este capítulo, usaré como ejemplo una técnica que he usado para
10 administrar el desarrollo de un controlador de dispositivo Infiniband
11 para el kernel de Linux. El controlador en cuestión es grande
12 (al menos en lo que se refiere a controladores), con 25,000 líneas de
13 código esparcidas en 35 ficheros fuente. Es mantenido por un equipo
14 pequeño de desarrolladores.
16 Aunque mucho del material en este capítulo es específico de Linux, los
17 mismos principios aplican a cualquier base de código de la que usted
18 no sea el propietario principal, y sobre la que usted necesita hacer
19 un montón de desarrollo.
21 \section{El problema de múltiples objetivos}
23 El kernel de Linux cambia con rapidez, y nunca ha sido estable
24 internamente; los desarrolladores hacen cambios drásticos entre
25 %TODO no encontré una traducción adecuada para "release". Por eso el
26 %cambio
27 versiones frecuentemente. Esto significa que una versión del
28 controlador que funciona bien con una versión particular del kernel ni
29 siquiera \emph{compilará} correctamente contra, típicamente, cualquier
30 otra versión.
32 Para mantener un controlador, debemos tener en cuenta una buena
33 cantidad de versiones de Linux en mente.
34 \begin{itemize}
35 \item Un objetivo es el árbol de desarrollo principal del kernel de
36 Linux. En este caso el mantenimiento del código es compartido
37 parcialmente por otros desarrolladores en la comunidad del kernel,
38 %TODO drive-by.
39 quienes hacen modificaciones ``de-afán'' al controlador a medida que
40 desarrollan y refinan subsistemas en el kernel.
41 %TODO backport
42 \item También mantenemos algunos ``backports'' para versiones antiguas
43 del kernel de Linux, para dar soporte a las necesidades de los
44 clientes que están corriendo versiones antiguas de Linux que no
45 incorporan nuestros controladores. (Hacer el \emph{backport} de un
46 pedazo de código es modificarlo para que trabaje en una versión
47 de su entorno objetivo anterior a aquella para la cual fue escrito.)
48 \item Finalmente, nosotros liberamos nuestro software de acuerdo a un
49 cronograma que no necesariamente está alineado con el que usan los
50 distribuidores de Linux y los desarrolladores del kernel, así que
51 podemos entregar nuevas características a los clientes sin forzarlos
52 a actualizar kernels completos o distribuciones.
53 \end{itemize}
55 \subsection{Aproximaciones tentadoras que no funcionan adecuadamente}
57 Hay dos maneras estándar de mantener una porción de software que debe
58 funcionar en muchos entornos diferentes.
60 La primera es mantener varias ramas, cada una pensada para un único
61 entorno. El problema de esta aproximación es que usted debe tener una
62 disciplina férrea con el flujo de cambios entre repositorios. Una
63 nueva característica o un arreglo de fallo deben empezar su vida en un
64 repositorio ``prístino'', y luego propagarse a cada repositorio de
65 backport. Los cambios para backports están más limitados respecto a
66 las ramas a las que deberían propagarse; un cambio para backport que
67 es aplicado a una rama en la que no corresponde probablemente hará que
68 el controlador no compile.
70 La segunda es mantener un único árbol de código fuente lleno de
71 declaraciones que activen o desactiven secciones de código dependiendo
72 del entorno objetivo. Ya que estos ``ifdefs'' no están permitidos en
73 el árbol del kernel de Linux, debe seguirse algún proceso manual o
74 automático para eliminarlos y producir un árbol limpio. Una base de
75 código mantenida de esta manera se convierte rápidamente en un nido de
76 ratas de bloques condicionales que son difíciles de entender y
77 mantener.
79 %TODO canónica?
80 Ninguno de estos enfoques es adecuado para situaciones en las que
81 usted no es ``dueño'' de la copia canónica de un árbol de fuentes. En
82 el caso de un controlador de Linux que es distribuido con el kernel
83 estándar, el árbol de Linux contiene la copia del código que será
84 considerada por el mundo como la canónica. La versión oficial de
85 ``mi'' controlador puede ser modificada por gente que no conozco, sin
86 que yo siquiera me entere de ello hasta después de que los cambios
87 aparecen en el árbol de Linus.
89 Estos enfoques tienen la debilidad adicional de dificultar la
90 %TODO upstream. no no es río arriba
91 generación de parches bien formados para enviarlos a la versión
92 oficial.
94 En principio, las Colas de Mercurial parecen ser un buen candidato
95 para administrar un escenario de desarrollo como el de arriba. Aunque
96 este es de hecho el caso, MQ tiene unas cuantas características
97 adicionales que hacen el trabajo más agradable.
99 \section{Aplicar parches condicionalmente mediante guardias}
101 Tal vez la mejor manera de conservar la cordura con tantos entornos
102 objetivo es poder escoger parches específicos para aplicar para cada
103 situación. MQ provee una característica llamada ``guardias''
104 (que se origina del comando \texttt{guards} de Quilt) que hace
105 precisamente ésto. Para empezar, creemos un repositorio sencillo para
106 experimentar.
107 \interaction{mq.guards.init}
108 Esto nos brinda un pequeño repositorio que contiene dos parches que no
109 tienen ninguna dependencia respecto al otro, porque tocan ficheros
110 diferentes.
112 La idea detrás de la aplicación condicional es que usted puede
113 ``etiquetar'' un parche con un \emph{guardia}, que simplemente es una
114 cadena de texto de su elección, y luego decirle a MQ que seleccione
115 guardias específicos para usar cuando aplique parches. MQ entonces
116 aplicará, u omitirá, un parche vigilado, dependiendo de los guardias
117 que usted haya seleccionado.
119 Un parche puede tener una cantidad arbitraria de guardias; cada uno es
120 \emph{positivo} (``aplique el parche si este guardia es
121 seleccionado'') o \emph{negativo} (``omita este parche si este guardia
122 es seleccionado''). Un parche sin guardias siempre es aplicado.
124 \section{Controlar los guardias de un parche}
126 %TODO tal vez no decir determinar, sino definir?
127 El comando \hgxcmd{mq}{qguard} le permite determinar qué guardias
128 deben aplicarse a un parche, o mostrar los guardias que están en
129 efecto. Sin ningún argumento, el comando muestra los guardias del
130 parche actual de la parte más alta de la pila.
131 \interaction{mq.guards.qguard}
132 Para poner un guardia positivo en un parche, prefije el nombre del
133 guardia con un ``\texttt{+}''.
134 \interaction{mq.guards.qguard.pos}
135 Para poner un guardia negativo en un parche, prefije el nombre del
136 guardia con un ``\texttt{-}''.
137 \interaction{mq.guards.qguard.neg}
139 \begin{note}
140 El comando \hgxcmd{mq}{qguard} \emph{pone} los guardias en un
141 parche; no los \emph{modifica}. Esto significa que si usted ejecuta
142 \hgcmdargs{qguard}{+a +b} sobre un parche, y luego
143 \hgcmdargs{qguard}{+c} en el mismo parche, el único guardia sobre el
144 parche después del comando será \texttt{+c}.
145 \end{note}
147 Mercurial almacena los guardias en el fichero \sfilename{series}; la
148 forma en que son almacenados es fácil tanto de entender como de editar
149 a mano. (En otras palabras, usted no tiene que usar el comando
150 \hgxcmd{mq}{qguard} si no lo desea; está bien simplemente editar el
151 fichero \sfilename{series})
152 \interaction{mq.guards.series}
154 \section{Selecccionar los guardias a usar}
156 %TODO tal vez no decir determinar, sino definir?
157 El comando \hgxcmd{mq}{qselect} determina qué guardias están activos
158 en cualquier momento. El efecto de esto es determinar qué parches
159 aplicará MQ la próxima vez que usted ejecute \hgxcmd{mq}{qpush}. No
160 tiene ningún otro efecto; en particular, no hace nada a los parches
161 que ya han sido aplicados.
163 Sin argumentos, el comando \hgxcmd{mq}{qselect} lista los guardias en
164 efecto actualmente, uno por cada línea de salida. Cada argumento es
165 tratado como el nombre de un guardia a aplicar.
166 \interaction{mq.guards.qselect.foo}
167 Si está interesado, los guardias seleccionados actualmente están
168 almacenados en el fichero \sfilename{guards}.
169 \interaction{mq.guards.qselect.cat}
170 Podemos ver el efecto que tienen los guardias seleccionados cuando
171 ejecutamos \hgxcmd{mq}{qpush}.
172 \interaction{mq.guards.qselect.qpush}
174 Un guardia no puede empezar con un caracter ``\texttt{+}'' o
175 ``\texttt{-}''. El nombre del guardia no debe contener espacios en
176 blanco, pero muchos otros caracteres son aceptables. Si usted trata de
177 usar un guardia con un nombre inválido, MQ se quejará:
178 \interaction{mq.guards.qselect.error}
179 Cambiar los guardias seleccionados cambia los parches que son
180 aplicados.
181 \interaction{mq.guards.qselect.quux}
182 Usted puede ver en el ejemplo de abajo que los guardias negativos
183 tienen precedencia sobre los guardias positivos.
184 \interaction{mq.guards.qselect.foobar}
186 \section{Reglas de MQ para aplicar parches}
188 Las reglas que MQ usa para decidir si debe aplicar un parche son las
189 siguientes.
190 \begin{itemize}
191 \item Un parche sin guardias es aplicado siempre.
192 \item Si el parche tiene algún guardia negativo que corresponda con
193 cualquiera de los guardias seleccionados, se salta el parche.
194 \item Si el parche tiene algún guardia positivo que corresponda con
195 cualquiera de los guardias seleccionados, se aplica el parche.
196 \item Si el parche tiene guardias positivos o negativos, pero ninguno
197 corresponde con cualquiera de los guardias seleccionados, se salta
198 el parche.
199 \end{itemize}
201 \section{Podar el entorno de trabajo}
203 En el trabajo del controlador de dispositivo que mencioné
204 anteriormente, yo no aplico los parches a un árbol normal del kernel
205 de Linux. En cambio, uso un repositorio que sólo contiene una
206 instantánea de los ficheros fuente y de cabecera que son relevantes
207 para el desarrollo de Infiniband. Este repositorio tiene un~1\% del
208 tamaño del repositorio del kernel, por lo que es más fácil trabajar
209 con él.
211 Luego escojo una versión ``base'' sobre la cual son aplicados los
212 parches. Es una instantánea del árbol del kernel de Linux en una
213 revisión de mi elección. Cuando tomo la instantánea, almaceno el ID de
214 conjunto de cambios en el mensaje de consignación. Ya que la
215 instantánea preserva la ``forma'' y el contenido de las partes
216 relevantes del árbol del kernel, puedo aplicar mis parches sobre mi
217 pequeño repositorio o sobre un árbol normal del kernel.
219 Normalmente, el árbol base sobre el que se aplican los parches debería
220 ser una instantánea de un árbol de desarrollo muy reciente. Esto
221 facilita mucho el desarrollo de parches que puedan ser enviados al
222 árbol oficial con pocas o ninguna modificación.
224 \section{Dividir el fichero \sfilename{series}}
226 Yo categorizo los parches en el fichero \sfilename{series} en una
227 serie de grupos lógicos. Cada sección de parches similares empieza con
228 un bloque de comentarios que describen el propósito de los parches que
229 le siguen.
231 La secuencia de grupos de parches que mantengo se muestra a
232 continuación. El orden de los grupos es importante; explicaré porqué
233 luego de que presente los grupos.
234 \begin{itemize}
235 \item El grupo ``aceptado''. Son parches que el equipo de desarrollo
236 ha enviado al mantenedor del subsistema Infiniband, y que él ha
237 aceptado, pero que no están presentes en la instantánea en la cual
238 está basada el repositorio pequeño. Estos son parches de
239 ``sólo lectura'', presentes únicamente para transformar el árbol en
240 un estado similar al del repositorio del mantenedor oficial.
241 \item El grupo ``revisar''. Parches que yo he enviado, pero sobre los
242 que que el mantenedor oficial ha solicitado modificaciones antes de
243 aceptarlos.
244 \item El grupo ``pendiente''. Parches que no he enviado al mantenedor
245 oficial, pero que ya están terminados. Estos parches serán de
246 ``sólo lectura'' por un buen tiempo. Si el mantenedor oficial los
247 acepta cuando los envíe, los moveré al final del grupo ``aceptado''.
248 Si él solicita que modificaciones en alguno de ellos, los moveré al
249 principio del grupo ``revisar''.
250 \item El grupo ``en proceso''. Parches que están siendo activamente
251 desarrollados, y no deberían ser enviados a ninguna parte aún.
252 \item El grupo ``backport''. Parches que adaptan el árbol de fuentes a
253 versiones antiguas del árbol del kernel.
254 \item El grupo ``no enviar''. Parches que por alguna razón nunca deben
255 ser enviados al mantenedor oficial del kernel. Por ejemplo, alguno
256 de esos parches podría cambiar las cadenas de identificación
257 embebidas del controlador para hacer más fácil la distinción, en
258 pruebas de campo, entre una versión del controlador de
259 salida-del-árbol y una versión entregada por un vendedor de alguna
260 distribución.
261 \end{itemize}
263 Ahora volvemos a las razones para ordenar los grupos de parches en
264 esta manera. Quisiéramos que los parches del fondo de la pila sean tan
265 estables como sea posible, para no tener que revisar parches más
266 arriba debido a cambios de contexto. Poner los parches que nunca
267 cambiarán en el primer lugar del fichero \sfilename{series} sirve a
268 este propósito.
270 También desearíamos que los parches que sabemos que debemos modificar
271 sean aplicados sobre un árbol de fuentes que se parezca al oficial
272 tanto como sea posible. Es por esto que mantenemos los parches
273 aceptados disponibles por una buena cantidad de tiempo.
275 Los parches ``backport'' y ``no enviar'' flotan al final del fichero
276 \sfilename{series}. Los parches de backport deben ser aplicados encima
277 de todos los otros parches, y los parches ``no enviar'' pueden
278 perfectamente quedarse fuera del camino.
280 \section{Mantener la serie de parches}
282 En mi trabajo, uso varios guardias para controlar qué parches deben
283 ser aplicados.
285 \begin{itemize}
286 \item Los parches ``aceptados'' son vigilados con
287 \texttt{accepted}. Yo habilito este guardia la mayoría de las veces.
288 Cuando aplico los parches sobre un árbol donde los parches ya están
289 %TODO no será ``desactivar este guardia''? si sí, corregir versión
290 %en inglés también
291 presentes, puedo desactivar este parche, y los parches que lo siguen
292 se aplicarán sin problemas.
293 \item Los parches que están ``terminados'', pero no han sido enviados,
294 no tienen guardias. Si estoy aplicando la pila de parches a una
295 copia del árbol oficial, no necesito habilitar ningún guardia para
296 obtener un árbol de fuentes razonablemente seguro.
297 \item Los parches que necesitan revisión antes de ser reenviados
298 tienen el guardia \texttt{rework}.
299 \item Para aquellos parches que aún están bajo desarrollo, uso
300 \texttt{devel}.
301 \item Un parche de backport puede tener varios guardias, uno para cada
302 versión del kernel a la que aplica. Por ejemplo, un parche que hace
303 backport de un segmento de código a~2.6.9 tendrá un guardia~\texttt{2.6.9}.
304 \end{itemize}
305 La variedad de guardias me brinda una flexibilidad considerable para
306 determinar qué tipo de árbol de fuentes acabaré por obtener. En la
307 mayoría de las situaciones, la selección de guardias apropiados es
308 automatizada durante el proceso de compilación, pero puedo ajustar
309 manualmente los guardias a usar para circunstancias poco comunes.
311 \subsection{El arte de escribir parches de backport}
313 Al usar MQ, escribir un parche de backport es un proceso simple. Todo
314 lo que dicho parche debe hacer es modificar una sección de código que
315 usa una característica del kernel que no está presente en la versión
316 anterior del kernel, para que el controlador siga funcionando
317 correctamente en esa versión anterior.
319 Una meta útil al escribir un buen parche de backport es hacer parecer
320 que el código hubiera sido escrito para la versión vieja del kernel
321 que usted tiene como objetivo. Entre menos intrusivo el parche, más
322 fácil será entenderlo y mantenerlo. Si usted está escribiendo una
323 colección de parches de backport para evitar el efecto de ``nido de
324 ratas'' de tener muchos \texttt{\#ifdef}s (secciones de código fuente
325 que sólo son usados condicionalmente) en su código, no introduzca
326 \texttt{\#ifdef}s dependientes de versiones específicas en los
327 parches. En vez de eso, escriba varios parches, cada uno de ellos
328 haciendo cambios incondicionales, y controle su aplicación usando
329 guardias.
331 Hay dos razones para ubicar los parches de backport en un grupo
332 diferente, aparte de los parches ``regulares'' cuyos efectos son
333 modificados por ellos. La primera es que mezclar los dos hace más
334 difícil usar herramientas como la extensión \hgext{patchbomb} para
335 automatizar el proceso de enviar los parches a un mantenedor oficial.
336 La segunda es que un parche de backport puede perturbar el contexto en
337 el que se aplica un parche regular subsecuente, haciendo imposible
338 aplicar el parche normal limpiamente \emph{sin} que el parche de
339 backport sea aplicado antes.
341 \section{Consejos útiles para hacer desarrollo con MQ}
343 \subsection{Organizar parches en directorios}
345 Si está trabajando en un proyecto grande con MQ, no es difícil
346 acumular un gran número de parches. Por ejemplo, tengo un repositorio
347 de parches que contiene más de 250 parches.
349 Si usted puede agrupar estos parches en categorías lógicas separadas,
350 usted puede almacenarlos en diferentes directorios si lo desea; MQ no
351 tiene problemas manejando nombres de parches que contienen separadores
352 de ruta.
354 \subsection{Ver el historial de un parche}
355 \label{mq-collab:tips:interdiff}
357 Si usted está desarrollando un conjunto de parches en un período de
358 tiempo grande, es una buena idea mantenerlos en un repositorio, como
359 se discutió en la sección~\ref{sec:mq:repo}. Si lo hace, notará
360 rápidamente que usar el comando \hgcmd{diff} para mirar el historial
361 del repositorio no es viable. Esto es debido en parte a que usted está
362 mirando la segunda derivada del código real (el diff de un diff), pero
363 también porque MQ añade ruido al proceso al modificar las marcas de
364 tiempo y los nombres de directorio cuando actualiza un parche.
366 Sin embargo, usted puede usar la extensión \hgext{extdiff}, que es
367 provisto junto con Mercurial, para convertir un diff de dos versiones
368 de un parche en algo legible. Para hacer esto, usted necesitará un
369 paquete de un tercero llamado
370 \package{patchutils}~\cite{web:patchutils}. Éste paquete provee un
371 comando llamado \command{interdiff}, que muestra las diferencias entre
372 dos diffs como un diff. Al usarlo en dos versiones del mismo diff,
373 genera un diff que representa el diff de la primera a la segunda
374 versión.
376 Usted puede habilitar la extensión \hgext{extdiff} de la manera usual,
377 añadiendo una línea a la sección \rcsection{extensions} de su \hgrc.
378 \begin{codesample2}
379 [extensions]
380 extdiff =
381 \end{codesample2}
382 El comando \command{interdiff} espera recibir los nombres de dos
383 ficheros, pero la extensión \hgext{extdiff} le pasa un par de
384 directorios al programa que ejecuta, cada uno de los cuales puede
385 contener una cantidad arbitraria de ficheros. Por esto necesitamos un
386 programa pequeño que ejecute \command{interdiff} en cada par de
387 ficheros de estos dos directorios. Este programa está disponible como
388 \sfilename{hg-interdiff} en el directorio \dirname{examples} del
389 repositorio de código fuente que acompaña a este libro.
390 \excode{hg-interdiff}
392 Con el programa \sfilename{hg-interdiff} en la ruta de búsqueda de su
393 intérprete de comandos, puede ejecutarlo como sigue, desde dentro de
394 un directorio de parches MQ:
395 \begin{codesample2}
396 hg extdiff -p hg-interdiff -r A:B my-change.patch
397 \end{codesample2}
398 Ya que usted seguramente querrá usar este comando tan largo a menudo,
399 puede hacer que \hgext{hgext} lo haga disponible como un comando
400 normal de Mercurial, editando de nuevo su \hgrc.
401 \begin{codesample2}
402 [extdiff]
403 cmd.interdiff = hg-interdiff
404 \end{codesample2}
405 Esto le indica a \hgext{hgext} que ponga a disposición un comando
406 \texttt{interdiff}, con lo que usted puede abreviar la invocación
407 anterior de \hgxcmd{extdiff}{extdiff} a algo un poco más manejable.
408 \begin{codesample2}
409 hg interdiff -r A:B my-change.patch
410 \end{codesample2}
412 \begin{note}
413 %TODO revisar redacción
414 El comando \command{interdiff} trabaja bien sólo si los ficheros
415 contra los cuales son generadas las versiones de un parche se
416 mantienen iguales. Si usted crea un parche, modifica los ficheros
417 subyacentes, y luego regenera el parche, \command{interdiff} podría
418 no producir ningún resultado útil.
419 \end{note}
421 La extensión \hgext{extdiff} es útil para más que solamente mejorar la
422 presentación de los parches~MQ. Para leer más acerca de esto, vaya a
423 la sección~\ref{sec:hgext:extdiff}.
425 %%% Local Variables:
426 %%% mode: latex
427 %%% TeX-master: "00book"
428 %%% End: