hgbook
view es/hook.tex @ 487:f8614aad2cbb
chapter taken to translate to spanish
| author | Igor Támara <igor@tamarapatino.org> |
|---|---|
| date | Tue Jan 06 22:40:18 2009 -0500 (2009-01-06) |
| parents | 5236357a00b2 |
| children | 54d3cad45353 |
line source
1 \chapter{Manejo de eventos en repositorios mediante ganchos}
2 \label{chap:hook}
4 Mercurial ofrece un poderoso mecanismo para permitirle a usted
5 automatizar la ejecución de acciones en respuesta a eventos que
6 ocurran en un repositorio. En algunos casos, usted puede controlar
7 incluso la respuesta de Mercurial a dichos eventos.
9 Mercurial usa el término \emph{gancho} para identificar estas
10 acciones. Los ganchos son conocidos como ``disparadores'' en algunos
11 sistemas de control de revisiones, pero los dos nombres se refieren al
12 mismo concepto.
14 \section{Vistazo general de ganchos en Mercurial}
16 A continuación se encuentra una breve lista de los ganchos que
17 Mercurial soporta. Volveremos a cada uno de estos ganchos con más
18 detalle después, en la sección~\ref{sec:hook:ref}.
20 \begin{itemize}
21 \item[\small\hook{changegroup}] Es ejecutado luego de que un grupo de
22 conjuntos de cambios ha sido traído al repositorio desde algún
23 otro sitio.
24 \item[\small\hook{commit}] Es ejecutado después de la creación de
25 un conjunto de cambios en el repositorio local.
26 \item[\small\hook{incoming}] Es ejecutado una vez por cada conjunto de
27 cambios traído al repositorio desde otra ubicación. Note la
28 diferencia respecto al gancho \hook{changegroup}, que es ejecutado
29 una vez por cada \emph{grupo} de conjuntos de cambios que se
30 traiga.
31 \item[\small\hook{outgoing}] Es ejecutado luego de que un grupo de
32 conjuntos de cambios ha sido transmitido desde el repositorio.
33 \item[\small\hook{prechangegroup}] Es ejecutado antes de iniciar la
34 recepción de un grupo de conjuntos de cambios en el repositorio.
35 \item[\small\hook{precommit}] De control. Es ejecutado antes de
36 iniciar una consignación.
37 \item[\small\hook{preoutgoing}] De control. Es ejecutado antes de
38 iniciar la transmisión de un grupo de conjuntos de cambios desde
39 el repositorio.
40 \item[\small\hook{pretag}] De control. Es ejecutado antes de crear una
41 etiqueta.
42 \item[\small\hook{pretxnchangegroup}] De control. Es ejecutado después
43 de haber recibido un grupo de conjuntos de cambios en el
44 repositorio local, pero antes de que la transacción se complete y
45 los cambios sean permanentes dentro del repositorio.
46 \item[\small\hook{pretxncommit}] De control. Es ejecutado luego de la
47 creación de un conjunto de cambios en el repositorio local, pero
48 antes de que la transacción que hace permanente el cambio sea
49 completada.
50 \item[\small\hook{preupdate}] De control. Es ejecutado antes de
51 iniciar una actualización o fusión en el directorio de trabajo.
52 \item[\small\hook{tag}] Es ejecutado después de la creación de una
53 etiqueta.
54 \item[\small\hook{update}] Es ejecutado después de que termina una
55 actualización o una fusión.
56 \end{itemize}
57 Cada uno de los ganchos cuya descripción empieza con la frase
58 ``de control'' tiene la facultad de determinar si una actividad puede
59 continuar. Si el gancho se ejecuta con éxito, la actividad puede
60 continuar; si falla, o bien la actividad no es permitida, o se
61 deshacen los cambios que se puedan haber llevado a cabo, dependiendo
62 del gancho involucrado.
64 \section{Ganchos y seguridad}
66 \subsection{Los ganchos se ejecutan con sus privilegios de usuario}
68 Cuando usted ejecuta un comando de Mercurial en un repositorio, y el
69 comando causa la ejecución de un gancho, dicho gancho se ejecuta en
70 \emph{su} sistema, en \emph{su} cuenta de usuario, con \emph{sus}
71 privilegios. Ya que los ganchos son elementos arbitrarios de código
72 ejecutable, usted debería tratarlos con un nivel adecuado de
73 desconfianza. No instale un gancho a menos en que confíe en quien lo
74 creó y en lo que el gancho hace.
76 En algunos casos, usted puede estar expuesto a ganchos que usted no
77 %TODO acá introduzco algo de texto por mi cuenta, por claridad
78 instaló. Si usted usa Mercurial en un sistema extraño, tenga en cuenta
79 que Mercurial ejecutará los ganchos definidos en el fichero \hgrc.
81 Si está trabajando con un repositorio propiedad de otro usuario,
82 Mercurial podrá ejecutar los ganchos definidos en el repositorio de
83 dicho usuario, pero los ejecutará como ``usted''. Por ejemplo, si
84 usted jala (\hgcmd{pull}) desde ese repositorio, y el
85 \sfilename{.hg/hgrc} define un gancho saliente (\hook{outgoing}),
86 dicho gancho se ejecuta bajo su cuenta de usuario, aun cuando usted no
87 es el propietario del repositorio.
89 \begin{note}
90 Esto sólo aplica si usted está jalando desde un repositorio en un
91 sistema de ficheros local o de red. Si está jalando a través de http
92 o ssh, cualquier gancho saliente (\hook{outgoing}) se ejecutará bajo
93 la cuenta que está ejecutando el proceso servidor, en el servidor.
94 \end{note}
96 XXX Para ver qué ganchos han sido definidos en un repositorio, use el
97 comando \hgcmdargs{config}{hooks}. Si usted está trabajando en un
98 repositorio, pero comunicándose con otro que no le pertenece
99 (por ejemplo, usando \hgcmd{pull} o \hgcmd{incoming}), recuerde que
100 los ganchos que debe considerar son los del otro repositorio, no los
101 del suyo.
103 \subsection{Los ganchos no se propagan}
105 En Mercurial, no se hace control de revisiones de los ganchos, y no se
106 propagan cuando usted clona, o jala de, un repositorio. El motivo para
107 esto es simple: un gancho es código ejecutable arbitrario. Se ejecuta
108 bajo su identidad, con su nivel de privilegios, en su máquina.
110 Sería extremadamente descuidado de parte de cualquier sistema
111 distribuido de control de revisiones el implementar control de
112 revisiones para ganchos, ya que esto ofrecería maneras fácilmente
113 %TODO subvertir
114 aprovechables de subvertir las cuentas de los usuarios del sistema de
115 control de revisiones.
117 Ya que Mercurial no propaga los ganchos, si usted está colaborando con
118 otras personas en un proyecto común, no debería asumir que ellos están
119 usando los mismos ganchos para Mercurial que usted usa, o que los de
120 ellos están configurado correctamente. Usted debería documentar los
121 ganchos que usted espera que la gente use.
123 En una intranet corporativa, esto es algo más fácil de manejar, ya que
124 usted puede, por ejemplo, proveer una instalación ``estándar'' de
125 Mercurial en un sistema de ficheros NFS, y usar un fichero \hgrc\
126 global para definir los ganchos que verán todos los usuarios. Sin
127 embargo, este enfoque tiene sus límites; vea más abajo.
129 \subsection{Es posible hacer caso omiso de los ganchos}
131 Mercurial le permite hacer caso omiso de la deficinión de un gancho,
132 a través de la redefinición del mismo. Usted puede deshabilitar el
133 gancho fijando su valor como una cadena vacía, o cambiar su
134 comportamiento como desee.
136 Si usted instala un fichero \hgrc\ a nivel de sistema o sitio completo
137 que define algunos ganchos, debe entender que sus usuarios pueden
138 deshabilitar o hacer caso omiso de los mismos.
140 \subsection{Asegurarse de que ganchos críticos sean ejecutados}
142 Algunas veces usted puede querer hacer respetar una política, y no
143 permitir que los demás sean capaces de evitarla. Por ejemplo, usted
144 puede tener como requerimiento que cada conjunto de cambios debe pasar
145 un riguroso conjunto de pruebas. Definir este requerimientos a través
146 de un gancho en un fichero \hgrc\ global no servirá con usuarios
147 remotos en computadoras portátiles, y por supuesto que los usuarios
148 locales pueden evitar esto a voluntad haciendo caso omiso del gancho.
150 En vez de eso, usted puede definir las políticas para usar Mercurial
151 de tal forma que se espere que los usuarios propaguen los cambios a
152 través de un servidor ``canónico'' bien conocido que usted ha
153 asegurado y configurado apropiadamente.
155 Una manera de hacer esto es a través de una combinación de ingeniería
156 socual y tecnología. Cree una cuenta de acceso restringido; los
157 usuarios pueden empujar cambios a través de la red a los repositorios
158 administrados por esta cuenta, pero no podrán ingresar a dicha cuenta
159 para ejecutar órdenes en el intérprete de comandos. En este escenario,
160 un usuario puede enviar un conjunto de cambios que contenga la
161 porquería que él desee.
163 Cuando alguien empuja un conjunto de cambios al servidor del que todos
164 jalan, el servidor probará el conjunto de cambios antes de aceptarlo
165 como permanente, y lo rechazará si no logra pasar el conjunto de
166 pruebas. Si la gente sólo jala cambios desde este servidor de filtro,
167 servirá para asegurarse de que todos los cambios que la gente jala han
168 sido examinados automáticamente
170 \section{Precauciones con ganchos \texttt{pretxn} en un repositorio de
171 acceso compartido}
173 Si usted desea usar ganchos para llevar a cabo automáticamente algún
174 trabajo en un repositorio al que varias personas tienen acceso
175 compartido, debe tener cuidado con la forma de hacerlo.
177 Mercurial sólo bloquea un repositorio cuando está escribiendo al
178 mismo, y sólo las partes de Mercurial que escriben al repositorio le
179 prestan atención a los bloqueos. Los bloqueos de escritura son
180 necesarios para evitar que múltiples escritores simultáneos
181 interfieran entre sí, corrompiendo el repositorio.
183 Ya que Mercurial tiene cuidado con el orden en que lee y escribe
184 datos, no necesita adquirir un bloqueo cuando desea leer datos del
185 repositorio. Las partes de Mercurial que leen del repositorio nunca le
186 prestan atención a los bloqueos. Este esquema de lectura libre de
187 bloqueos incremententa en gran medida el desempeño y la concurrencia.
189 Sin embargo, para tener un gran desempeño es necesario hacer
190 sacrificios, uno de los cuales tiene el potencial de causarle
191 problemas a menos de que usted esté consciente de él. Describirlo
192 requiere algo de detalle respecto a cómo Mercurial añade conjuntos de
193 cambios al repositorio y cómo lee esos cambios de vuelta.
195 Cuando Mercurial \emph{escribe} metadatos, los escribe directamente en
196 el fichero de destino. Primero escribe los datos del fichero, luego
197 los datos del manifiesto (que contienen punteros a los nuevos datos
198 del fichero), luego datos de la bitácora de cambios (que contienen
199 punteros a los nuevos datos del manifiesto). Antes de la primera
200 escritura a cada fichero, se guarda un registro de dónde estaba el
201 final de fichero en su registro de transacciones. Si la transacción
202 debe ser deshecha, Mercurial simplemente trunca cada fichero de vuelta
203 al tamaño que tenía antes de que empezara la transacción.
205 Cuando Mercurial \emph{lee} metadatos, lee la bitácora de cambios
206 primero, y luego todo lo demás. Como un lector sólo accederá a las
207 partes del manifiesto o de los metadatos de fichero que él puede ver
208 en la bitácora de cambios, nunca puede ver datos parcialmente
209 escritos.
211 Algunos ganchos de control (\hook{pretxncommit} y
212 \hook{pretxnchangegroup}) se ejecutan cuando una transacción está casi
213 completa. Todos los metadatos han sido escritos, pero Mercurial aún
214 puede deshacer la transacción y hacer que los datos recién escritos
215 desaparezcan.
217 Si alguno de estos ganchos permanece en ejecución por mucho tiempo,
218 abre una ventana de tiempo en la que un lector puede ver los metadatos
219 de conjuntos de cambios que aún no son permanentes y que no debería
220 considerarse que estén ``realmante ahí''. Entre más tiempo tome la
221 ejecución del gancho, más tiempo estará abierta esta ventana.
223 \subsection{Ilustración del problema}
225 En principio, un buen uso del gancho \hook{pretxnchangegroup} sería
226 ensamblar y probar automáticamente todos los cambios entrantes antes
227 de que sean aceptados en un repositorio central. Esto le permitiría a
228 usted garantizar que nadie pueda empujar cambios que ``rompan el
229 ensamblaje''. Pero si un cliente puede jalar cambios mientras están
230 siendo probados, la utilidad de esta prueba es nula; alguien confiado
231 puede jalar cambios sin probar, lo que potencialmente podría romper su
232 proceso de ensamblaje.
234 La respuesta técnica más segura frente a este retos es montar dicho
235 repositorio ``guardián'' como \emph{unidireccional}. Permita que
236 reciba cambios desde el exterior, pero no permita que nadie jale
237 cambios de él (use el gancho \hook{preoutgoing} para bloquear esto).
238 Configure un gancho \hook{changegroup} para que si el ensamblaje o
239 prueba tiene éxito, el gancho empuje los nuevos cambios a otro
240 repositorio del que la gente \emph{pueda} jalar.
242 En la práctica, montar un cuello de botella centralizado como éste a
243 menudo no es una buena idea, y la visibilidad de las transacciones no
244 tiene nada que ver con el problema. A medida que el tamaño de un
245 proyecto---y el tiempo que toma ensamblarlo y probarlo---crece, usted
246 se acerca rápidamente a un límite con este enfoque ``pruebe antes de
247 comprar'', en el que tiene más conjuntos de cambios a probar que
248 tiempo para ocuparse de ellos. El resultado inevitable es frustración
249 para todos los que estén involucrados.
251 Una aproximación que permite manejar mejor el crecimiento es hacer que
252 la gente ensamble y pruebe antes de empujar, y ejecutar el ensamble y
253 pruebas automáticas centralmente \emph{después} de empujar, para
254 asegurarse de que todo esté bien. La ventaja de este enfoque es que no
255 impone un límite a la rata en la que un repositorio puede aceptar
256 cambios.
258 \section{Tutorial corto de uso de ganchos}
259 \label{sec:hook:simple}
261 Escribir un gancho para Mercurial es fácil. Empecemos con un gancho
262 que se ejecute cuando usted termine un \hgcmd{commit}, y simplemente
263 muestre el hash del conjunto de cambios que usted acaba de crear. El
264 gancho se llamará \hook{commit}.
266 \begin{figure}[ht]
267 \interaction{hook.simple.init}
268 \caption{Un gancho simple que se ejecuta al hacer la consignación de
269 un conjunto de cambios}
270 \label{ex:hook:init}
271 \end{figure}
273 Todos los ganchos siguen el patrón del ejemplo~\ref{ex:hook:init}.
274 Usted puede añadir una entrada a la sección \rcsection{hooks} de su
275 fichero \hgrc. A la izquierda está el nombre del evento respecto al
276 cual dispararse; a la derecha está la acción a llevar a cabo. Como
277 puede ver, es posible ejecutar cualquier orden de la línea de comandos
278 en un gancho. Mercurial le pasa información extra al gancho usando
279 variables de entorno (busque \envar{HG\_NODE} en el ejemplo).
281 \subsection{Llevar a cabo varias acciones por evento}
283 A menudo, usted querrá definir más de un gancho para un tipo de evento
284 particular, como se muestra en el ejemplo~\ref{ex:hook:ext}.
285 Mercurial le permite hacer esto añadiendo una \emph{extensión} al
286 final del nombre de un gancho. Usted extiende el nombre del gancho
287 %TODO Yuk, no me gusta ese "parada completa"
288 poniendo el nombre del gancho, seguido por una parada completa (el
289 caracter ``\texttt{.}''), seguido de algo más de texto de su elección.
290 Por ejemplo, Mercurial ejecutará tanto \texttt{commit.foo} como
291 \texttt{commit.bar} cuando ocurra el evento \texttt{commit}.
293 \begin{figure}[ht]
294 \interaction{hook.simple.ext}
295 \caption{Definición de un segundo gancho \hook{commit}}
296 \label{ex:hook:ext}
297 \end{figure}
299 Para dar un orden bien definido de ejecución cuando hay múltiples
300 ganchos definidos para un evento, Mercurial ordena los ganchos de
301 acuerdo a su extensión, y los ejecuta en dicho orden. En el ejemplo de
302 arribam \texttt{commit.bar} se ejecutará antes que
303 \texttt{commit.foo}, y \texttt{commit} se ejecutará antes de ambos.
305 Es una buena idea usar una extensión descriptiva cuando usted define
306 un gancho. Esto le ayudará a recordar para qué se usa el gancho. Si el
307 gancho falla, usted recibirá un mensaje de error que contiene el
308 nombre y la extensión del gancho, así que usar una extensión
309 descriptiva le dará una pista inmediata de porqué el gancho falló (vea
310 un ejemplo en la sección~\ref{sec:hook:perm}).
312 \subsection{Controlar cuándo puede llevarse a cabo una actividad}
313 \label{sec:hook:perm}
315 En los ejemplos anteriores, usamos el gancho \hook{commit}, que es
316 ejecutado después de que se ha completado una consignación. Este es
317 uno de los varios ganchos que Mercurial ejecuta luego de que una
318 actividad termina. Tales ganchos no tienen forma de influenciar la
319 actividad como tal.
321 Mercurial define un número de eventos que ocurren antes de que una
322 actividad empiece; o luego de que empiece, pero antes de que termine.
323 Los ganchos que se disparan con estos eventos tienen la capacidad
324 adicional de elegir si la actividad puede continuar, o si su ejecución
325 es abortada.
327 El gancho \hook{pretxncommit} se ejecuta justo antes de que una
328 consignación se ejecute. En otras palabras, los metadatos que
329 representan el conjunto de cambios han sido escritos al disco, pero no
330 se ha terminado la transacción. El gancho \hook{pretxncommit} tiene la
331 capacidad de decidir si una transacción se completa, o debe
332 deshacerse.
334 Si el gancho \hook{pretxncommit} termina con un código de salida de
335 cero, se permite que la transacción se complete; la consignación
336 termina; y el gancho \hook{commit} es ejecutado. Si el gancho
337 \hook{pretxncommit} termina con un código de salida diferente de cero,
338 la transacción es revertida; los metadatos representando el conjunto
339 de cambios son borrados; y el gancho \hook{commit} no es ejecutado.
341 \begin{figure}[ht]
342 \interaction{hook.simple.pretxncommit}
343 \caption{Uso del gancho \hook{pretxncommit} hook to control commits}
344 \label{ex:hook:pretxncommit}
345 \end{figure}
347 El gancho en el ejemplo~\ref{ex:hook:pretxncommit} revisa si el
348 mensaje de consignación contiene el ID de algún fallo. Si lo contiene,
349 la consignación puede continuar. Si no, la consignación es cancelada.
351 \section{Escribir sus propios ganchos}
353 Cuando usted escriba un gancho, puede encontrar útil el ejecutar
354 Mercurial o bien pasándole la opción \hggopt{-v}, o con el valor de
355 configuración \rcitem{ui}{verbose} fijado en ``true'' (verdadero).
356 Cuando lo haga, Mercurial imprimirá un mensaje antes de llamar cada
357 gancho.
359 \subsection{Escoger cómo debe ejecutarse su gancho}
360 \label{sec:hook:lang}
362 Usted puede escribir un gancho que funcione como un programa normal
363 ---típicamente un guión de línea de comandos---o como una función de
364 Python que se ejecuta dentro del proceso Mercurial.
366 Escribir un gancho como un programa externo tiene la ventaja de que no
367 requiere ningún conocimiento del funcionamiento interno de Mercurial.
368 Usted puede ejecutar comandos Mercurial normales para obtener la
369 informción extra que pueda necesitar. La contraparte de esto es que
370 los ganchos externos son más lentos que los ganchos internos
371 ejecutados dentro del proceso.
373 Un gancho Python interno tiene acceso completo a la API de Mercurial,
374 y no se ``externaliza'' a otro proceso, así que es inherentemente más
375 rápido que un gancho externo. Adicionalmente es más fácil obtener la
376 mayoría de la información que un gancho requiere a través de llamadas
377 directas a la API de Mercurial que hacerlo ejecutando comandos
378 Mercurial.
380 Si se siente a gusto con Python, o requiere un alto desempeño,
381 escribir sus ganchos en Python puede ser una buena elección. Sin
382 embargo, cuando usted tiene un gancho bastante directo por escribir y
383 no le importa el desempeño (el caso de la mayoría de los ganchos), es
384 perfectamente admisible un guión de línea de comandos.
386 \subsection{Parámetros para ganchos}
387 \label{sec:hook:param}
389 Mercurial llama cada gancho con un conjunto de paŕametros bien
390 definidos. En Python, un parámetro se pasa como argumento de palabra
391 clave a su función de gancho. Para un programa externo, los parámetros
392 son pasados como variables de entornos.
394 Sin importar si su gancho está escrito en Python o como guión de línea
395 de comandos, los nombres y valores de los parámetros específicos de
396 los ganchos serán los mismos. Un parámetro booleano será representado
397 como un valor booleano en Python, pero como el número 1 (para
398 ``verdadero'') o 0 (para falso) en una variable de entorno para un
399 gancho externo. Si un parámetro se llama \texttt{foo}, el argumento de
400 palabra clave para un gancho en Python también se llamará
401 \texttt{foo}, mientras que la variable de entorno para un gancho
402 externo se llamará \texttt{HG\_FOO}.
404 \subsection{Valores de retorno de ganchos y control de actividades}
406 Un gancho que se ejecuta exitosamente debe terminar con un código de
407 salida de cero, si es externo, o retornar el valor booleano
408 ``falso'', si es interno. Un fallo se indica con un código de salida
409 diferente de cero desde un gancho externo, o un valor de retorno
410 booleano ``verdadero''. Si un gancho interno genera una excepción, se
411 considera que el gancho ha fallado.
413 Para los ganchos que controlan si una actividad puede continuar o no,
414 cero/falso quiere decir ``permitir'', mientras que
415 % TODO me suena mejor "no permitir" que "denegar"
416 no-cero/verdadero/excepción quiere decir ``no permitir''.
418 \subsection{Escribir un gancho externo}
420 Cuando usted define un gancho externo en su fichero \hgrc\ y el mismo
421 es ejecutado, dicha definición pasa a su intérprete de comandos, que
422 hace la interpretación correspondiente. Esto significa que usted puede
423 usar elementos normales del intérprete en el cuerpo del gancho.
425 Un gancho ejecutable siempre es ejecutado con su directorio actual
426 fijado al directorio raíz del repositorio.
428 Cada parámetro para el gancho es pasado como una variable de entorno;
429 el nombre está en mayúsculas, y tiene como prefijo la cadena
430 ``\texttt{HG\_}''.
432 Con la excepción de los parámetros para los ganchos, Mercurial no
433 define o modifica ninguna variable de entorno al ejecutar un gancho.
434 Es útil recordar esto al escribir un gancho global que podría ser
435 ejecutado por varios usuarios con distintas variables de entorno
436 fijadas. En situaciones con múltiples usuarios, usted no debería
437 asumir la existencia de ninguna variable de entorno, ni que sus
438 valores sean los mismos que tenían cuando usted probó el gancho en su
439 ambiente de trabajo.
441 \subsection{Indicar a Mercurial que use un gancho interno}
443 La sintaxis para definir un gancho interno en el fichero \hgrc\ es
444 ligeramente diferente de la usada para un gancho externo. El valor del
445 gancho debe comenzar con el texto ``\texttt{python:}'', y continuar
446 con el nombre completamente cualificado de un objeto invocable que se
447 usará como el valor del gancho.
449 El módulo en que vive un gancho es importado automáticamente cuando se
450 ejecuta un gancho. Siempre que usted tenga el nombre del módulo y la
451 variable de entorno \envar{PYTHONPATH} ajustada adecuadamente, todo
452 debería funcionar sin problemas.
454 El siguiente fragmento de ejemplo de un fichero \hgrc\ ilustra la
455 sintaxis y significado de los conceptos que acabamos de describir.
456 \begin{codesample2}
457 [hooks]
458 commit.example = python:mymodule.submodule.myhook
459 \end{codesample2}
460 Cuando Mercurial ejecuta el gancho \texttt{commit.example}, importa
461 \texttt{mymodule.submodule}, busca el objeto invocable llamado
462 \texttt{myhook}, y lo invoca (llama).
464 \subsection{Escribir un gancho interno}
466 El gancho interno más sencillo no hace nada, pero ilustra la
467 estructura básica de la API\ndt{\emph{Application Progamming
468 Interface}, Interfaz para Programación de Aplicaciones} para ganchos:
469 \begin{codesample2}
470 def myhook(ui, repo, **kwargs):
471 pass
472 \end{codesample2}
473 El primer argumento para un gancho Python siempre es un objeto
474 \pymodclass{mercurial.ui}{ui}. El segundo es un objeto repositorio;
475 de momento, siempre es una instancia de
476 \pymodclass{mercurial.localrepo}{localrepository}. Después de estos
477 dos argumentos están los argumentos de palabra clave. Los argumentos
478 que se pasen dependerán del tipo de gancho que se esté llamando, pero
479 un gancho siempre puede ignorar los argumentos que no le interesen,
480 relegándolos a un diccionario de argumentos por palabras clave, como se
481 hizo arriba con \texttt{**kwargs}.
483 \section{Ejemplos de ganchos}
485 \subsection{Escribir mensajes de consignación significativos}
487 Es difícil de imaginar un mensaje de consignación útil y al mismo
488 tiempo muy corto. El simple gancho \hook{pretxncommit} de la
489 figura~\ref{ex:hook:msglen.go} evitará que usted consigne un conjunto
490 de cambios con un mensaje de menos de 10 bytes de longitud.
492 \begin{figure}[ht]
493 \interaction{hook.msglen.go}
494 \caption{Un gancho que prohíbe mensajes de consignación demasiado
495 cortos}
496 \label{ex:hook:msglen.go}
497 \end{figure}
499 \subsection{Comprobar espacios en blanco finales}
501 Un uso interesante para ganchos relacionados con consignaciones es
502 ayudarle a escribir código más limpio. Un ejemplo simple de
503 %TODO dictum => regla
504 ``código más limpio'' es la regla de que un cambio no debe añadir
505 líneas de texto que contengan ``espacios en blanco finales''. El
506 espacio en blanco final es una serie de caracteres de espacio y
507 tabulación que se encuentran al final de una línea de texto. En la
508 mayoría de los casos, el espacio en blanco final es innecesario, ruido
509 invisible, pero ocasionalmente es problemático, y la gente en general
510 prefiere deshacerse de él.
512 Usted puede usar cualquiera de los ganchos \hook{precommit} o
513 \hook{pretxncommit} para revisar si tiene el problema de los espacios
514 en blanco finales. Si usa el gancho \hook{precommit}, el gancho no
515 sabrá qué ficheros se están consignando, por lo que se tendrá que
516 revisar cada fichero modificado en el repositorio para ver si tiene
517 espacios en blanco finales. Si usted sólo quiere consignar un cambio
518 al fichero \filename{foo}, y el fichero \filename{bar} contiene
519 espacios en blanco finales, hacer la revisión en el gancho
520 \hook{precommit} evitará que usted haga la consignación de
521 \filename{foo} debido al problem en \filename{bar}. Este no parece el
522 enfoque adeucado.
524 Si usted escogiera el gancho \hook{pretxncommit}, la revisión no
525 ocurriría sino hasta justo antes de que la transacción para la
526 consignación se complete. Esto le permitirá comprobar por posibles
527 problemas sólo en los ficheros que serán consignados. Sin embargo, si
528 usted ingresó el mensaje de consignación de manera interactiva y el
529 %TODO roll-back
530 gancho falla, la transacción será deshecha; usted tendrá que
531 reingresar el mensaje de consignación luego de que corrija el problema
532 con los espacios en blanco finales y ejecute \hgcmd{commit} de nuevo.
534 \begin{figure}[ht]
535 \interaction{hook.ws.simple}
536 \caption{Un gancho simple que revisa si hay espacios en blanco
537 finales}
538 \label{ex:hook:ws.simple}
539 \end{figure}
541 La figura~\ref{ex:hook:ws.simple} presenta un gancho
542 \hook{pretxncommit} simple que comprueba la existencia de espacios en
543 blanco finales. Este gancho es corto, pero no brinda mucha ayuda.
544 Termina con un código de salida de error si un cambio añade una línea
545 con espacio en blanco final a cualquier fichero, pero no muestra
546 ninguna información que pueda ser útil para identificar el fichero o
547 la línea de texto origen del problema. También tiene la agradable
548 propiedad de no prestar atención a las líneas que no sufrieron
549 modificaciones; sólo las líneas que introducen nuevos espacios en
550 blanco finales causan problemas.
552 \begin{figure}[ht]
553 \interaction{hook.ws.better}
554 \caption{A better trailing whitespace hook}
555 \label{ex:hook:ws.better}
556 \end{figure}
558 El ejemplo de la figura~\ref{ex:hook:ws.better} es mucho más complejo,
559 pero también más útil. El gancho procesa un diff unificado para
560 revisar si alguna línea añade espacios en blanco finales, e imprime el
561 nombre del fichero y el número de línea de cada ocurrencia. Aún mejor,
562 si el cambio añade espacios en blanco finales, este gancho guarda el
563 mensaje de consignación e imprime el nombre del fichero en el que el
564 mensaje fue guardado, antes de terminar e indicarle a Mercurial que
565 deshaga la transacción, para que uste pueda usar
566 \hgcmdargs{commit}{\hgopt{commit}{-l}~\emph{nombre\_fichero}} para
567 reutilizar el mensaje de consignación guardado anteriormente, una vez
568 usted haya corregido el problema.
570 Como anotación final, note en la figura~\ref{ex:hook:ws.better} el
571 %TODO on-site => in-situ ?
572 uso de la característica de edición \emph{in-situ} de \command{perl}
573 para eliminar los espacios en blanco finales en un fichero. Esto es
574 lo suficientemente conciso y poderoso para que lo presente aquí.
575 % TODO corregí el backslash, y comprobé por mi cuenta un archivo
576 % aparte, y el comando hace lo que debe hacer. Favor copiar del pdf el
577 % comando perl y comprobar con un archivo con espacios en blanco
578 % finales, y si todo está bien (que debería), borrar esta nota
579 \begin{codesample2}
580 perl -pi -e 's,\textbackslash{}s+\$,,' nombre\_fichero
581 \end{codesample2}
583 %TODO bundled
584 \section{Ganchos bundled}
586 Mercurial se instala con varios ganchos bundled. Usted puede
587 encontrarlos en el directorio \dirname{hgext} del árbol de ficheros
588 fuente de Mercurial. Si usted está usando un paquete binario de
589 Mercurial, los ganchos estarán ubicados en el directorio
590 \dirname{hgext} en donde su instalador de paquetes haya puesto a
591 Mercurial.
593 \subsection{\hgext{acl}---control de acceso a partes de un repositorio}
595 La extensión \hgext{acl} le permite controlar a qué usuarios remotos
596 les está permitido empujar conjuntos de cambios a un servidor en red.
597 Usted puede proteger cualquier porción de un repositorio (incluyendo
598 el repositorio completo), de tal manera que un usuario remoto
599 específico pueda empujar cambios que no afecten la porción protegida.
601 Esta extensión implementa control de acceso basado en la identidad del
602 usuario que empuja los conjuntos de cambios, \emph{no} en la identidad
603 de quien hizo la consignación de los mismos. Usar este gancho tiene
604 sentido sólo si se tiene un servidor adecuadamente asegurado que
605 autentique a los usuarios remotos, y si usted desea segurarse de que
606 sólo se le permita a ciertos usuarios empujar cambios a dicho
607 servidor.
609 \subsubsection{Configuración del gancho \hook{acl}}
611 Para administrar los conjuntos de cambios entrantes, se debe usar el
612 gancho \hgext{acl} como un gancho de tipo \hook{pretxnchangegroup}.
613 Esto le permite ver qué ficheros son modificados por cada conjunto de
614 %TODO rollback => "deshacer el efecto"
615 cambios entrante, y deshacer el efecto de un grupo de conjuntos de
616 cambios si alguno de ellos modifica algún fichero ``prohibido''.
617 Ejemplo:
618 \begin{codesample2}
619 [hooks]
620 pretxnchangegroup.acl = python:hgext.acl.hook
621 \end{codesample2}
623 La extensión \hgext{acl} es configurada mediante tres secciones.
625 La sección \rcsection{acl} sólo tiene una entrada,
626 \rcitem{acl}{sources}\ndt{Fuentes.}, que lista las fuentes de los
627 conjuntos de cambios entrantes a las que el gancho debe prestar
628 atención. Usualmente usted no necesita configurar esta sección.
629 \begin{itemize}
630 \item[\rcitem{acl}{serve}] Controlar conjuntos de
631 cambios entrantes que están llegando desde un repositorio a
632 través de http o ssh. Este es el valor por defecto de
633 \rcitem{acl}{sources}, y usualmente es el único valor de
634 configuración que necesitará para este ítem.
635 \item[\rcitem{acl}{pull}] Controlar conjuntos de cambios entrantes que
636 lleguen vía un pull (jalado) desde un repositorio local.
637 \item[\rcitem{acl}{push}] Controlar conjuntos de cambios entrantes que
638 lleguen vía un push (empuje) desde un repositorio local.
639 \item[\rcitem{acl}{bundle}] Controlar conjuntos de cambios entrantes
640 %TODO bundle
641 que lleguen desde otro repositorio a través de un bundle.
642 \end{itemize}
644 La sección \rcsection{acl.allow} controla los usuarios a los que les
645 está permitido añadir conjuntos de cambios al repositorio. Si esta
646 sección no está presente, se le permite acceso a todos los usuarios
647 excepto a los que se les haya negado explícitamente el acceso. Si
648 esta sección no está presente, se niega el acceso a todos los usuarios
649 excepto a todos a los que se les haya permitido de manera explícita
650 (así que una sección vacía implica que se niega el acceso a todos los
651 usuarios).
653 La sección \rcsection{acl.deny} determina a qué usuarios no se les
654 permite añadir conjuntos de cambios al repositorio. Si esta sección no
655 está presente o está vacía, no se niega el acceso a ningún usuario.
657 La sintaxis para los ficheros \rcsection{acl.allow} y
658 \rcsection{acl.deny} es idéntica. A la izquierda de cada entrada se
659 encuentra un patrón glob que asocia ficheros o directorios, respecto a
660 la raíz del repositorio; a la derecha, un nombre usuario.
662 En el siguiente ejemplo, el usuario \texttt{escritordoc} sólo puede
663 empujar cambios al directorio \dirname{docs} del repositorio, mientras
664 que \texttt{practicante} puede enviar cambios a cualquier fichero o
665 directorio excepto \dirname{fuentes/sensitivo}.
666 \begin{codesample2}
667 [acl.allow]
668 docs/** = escritordoc
670 [acl.deny]
671 fuentes/sensitivo/** = practicante
672 \end{codesample2}
674 \subsubsection{Pruebas y resolución de problemas}
676 Si usted desea probar el gancho \hgext{acl}, ejecútelo habilitando la
677 opción de salida de depuración habilitada. Ya que usted probablemente
678 lo estará ejecutando en un servidor donde no es conveniente (o incluso
679 posible) pasar la opción \hggopt{--debug}, no olvide que usted puede
680 habilitar la salida de depuración en su \hgrc:
681 \begin{codesample2}
682 [ui]
683 debug = true
684 \end{codesample2}
685 Con esto habilitado, el gancho \hgext{acl} imprimirá suficiente
686 información para permitirle saber porqué está permitiendo o denegando
687 la operación de empujar a usuarios específicos.
689 \subsection{\hgext{bugzilla}---integración con Bugzilla}
691 La extensión \hgext{bugzilla} añade un comentario a un fallo Bugzilla
692 siempre que encuentre una referencia al ID de dicho fallo en un
693 mensaje de consignación. Usted puede instalar este gancho en un
694 servidor compartido, para que cada vez que un usuario remoto empuje
695 cambios al servidor, el gancho sea ejecutado.
697 Se añade un comentario al fallo que se ve así (usted puede configurar
698 los contenidos del comentario---vea más abajo):
699 %TODO traducir?
700 \begin{codesample2}
701 Changeset aad8b264143a, made by Joe User <joe.user@domain.com> in
702 the frobnitz repository, refers to this bug.
704 For complete details, see
705 http://hg.domain.com/frobnitz?cmd=changeset;node=aad8b264143a
707 Changeset description:
708 Fix bug 10483 by guarding against some NULL pointers
709 \end{codesample2}
710 El valor de este gancho se encuentra en que automatiza el proceso de
711 actualizar un fallo cuando un conjunto de cambios se refiera a él. Si
712 usted configura este gancho adecuadamente, hará fácil para la gente
713 navegar directamente desde un fallo Bugzilla a un conjunto de cambios
714 que se refiere a ese fallo.
716 Usted puede usar el código de este gancho como un punto de partida
717 para otras recetas de integración con Bugzilla aún más exóticas. Acá
718 hay algunas posibilidades:
719 \begin{itemize}
720 \item Requerir que cada conjunto de cambios tenga un ID de fallo en su
721 mensaje de consignación. En este caso, usted querrá configurar el
722 gancho como uno de tipo \hook{pretxncommit}. Esto le permitirá al
723 gancho rechazar cambios que no contiene IDs de fallos.
724 \item Permitir a los conjuntos de cambios entrantes modificar
725 automáticamente el \emph{estado} de un fallo, así como simplemente
726 añadir un comentario. Por ejemplo, el gancho podría reconocer la
727 cadena ``corregido fallo 31337'' como la señal de que debería
728 actualizar el estado del fallo 31337 a ``requiere pruebas''.
729 \end{itemize}
731 \subsubsection{Configuración del gancho \hook{bugzilla}}
732 \label{sec:hook:bugzilla:config}
734 Usted debería configurar este gancho en el \hgrc\ de su servidor como
735 un gancho \hook{incoming}\ndt{Entrante.}, por ejemplo como sigue:
736 \begin{codesample2}
737 [hooks]
738 incoming.bugzilla = python:hgext.bugzilla.hook
739 \end{codesample2}
741 Debido a la naturaleza especializada de este gancho, y porque Bugzilla
742 no fue escrito con este tipo de integración en mente, configurar este
743 % TODO involved => complejo ? no intarwebs here :(
744 gancho es un proceso algo complejo.
746 Antes de empezar, usted debe instalar la interfaz de Python para MySQL
747 en los sistemas en los que se vaya a ejecutar el gancho. Si no está
748 disponible como paquete binario para su sistema, usted puede descargar
749 el paquete desde~\cite{web:mysql-python}.
751 La información para configurar este gancho se ubica en la sección
752 \rcsection{bugzilla} de su \hgrc.
753 \begin{itemize}
754 \item[\rcitem{bugzilla}{version}] La versión de Bugzilla instalada en
755 el servidor. El esquema de base de datos que Bugzilla usa cambia
756 ocasionalmente, así que este gancho debe saber exactamente qué
757 esquema usar. A la fecha, la única versión soportada es la
758 \texttt{2.16}.
759 \item[\rcitem{bugzilla}{host}] El nombre de máquina (\emph{hostname})
760 del servidor MySQL que almacena sus datos Bugzilla. La base de datos
761 debe ser configurada para permitir conexiones desde las máquinas en
762 las que usted ejecute el gancho \hook{bugzilla}.
763 \item[\rcitem{bugzilla}{user}] El nombre de usuario que se usará para
764 conectarse al servidor MySQL. La base de datos debe ser configurada
765 para permitir a dicho usuario conectarse desde cualquiera de las
766 máquinas en las que se ejecute el gancho \hook{bugzilla}. Este
767 usuario debe tener acceso y poder modificar las tablas de Bugzilla.
768 El valor por defecto para este ítem es \texttt{bugs}, que es el
769 nombre estándar del usuario para Bugzilla en una base de datos
770 MySQL.
771 \item[\rcitem{bugzilla}{password}] La contraseña MySQL para el usuario
772 configurado anteriormente. Ésta es almacenada como texto plano, así
773 que usted deberá asegurarse de que los usuarios no autorizados no
774 puedan leer el fichero \hgrc\ en donde usted guarda esta
775 información.
776 \item[\rcitem{bugzilla}{db}] El nombre de la base de datos Bugzilla en
777 el servidor MySQL. El nombre por defecto para este ítem es
778 \texttt{bugs}, que es el nombre estándar de la base de datos MySQL
779 en donde Bugzilla almacena sus datos.
780 \item[\rcitem{bugzilla}{notify}] Si usted desea que Bugzilla envíe un
781 %TODO suBscriptores?
782 correo de notificación a los suscriptores después de que el gancho
783 haya añadido un comentario a un fallo, necesitará que este gancho
784 ejecute un comando siempre que actualice la base de datos. El
785 comando que se ejecute depende de en dónde haya sido instalado
786 Bugzilla, pero típicamente se verá así, si usted ha instalado
787 Bugzilla en \dirname{/var/www/html/bugzilla}:
788 \begin{codesample4}
789 cd /var/www/html/bugzilla && ./processmail %s nobody@nowhere.com
790 \end{codesample4}
791 El programa \texttt{processmail} de Bugzilla espera recibir un ID de
792 fallo (el gancho reemplaza ``\texttt{\%s}'' por el ID del fallo) y
793 una dirección de correo. También espera poder escribir a ciertos
794 ficheros en el directorio en que se ejecuta. Si Bugzilla y éste
795 gancho no están instalados en la misma máquina, usted deberá
796 encontrar una manera de ejecutar \texttt{processmail} en el servidor
797 donde está instalado Bugzilla.
798 \end{itemize}
800 \subsubsection{Asociar nombres de consignadores a nombres de usuario
801 Bugzilla}
803 Por defecto, el gancho \hgext{bugzilla} trata de usar la dirección de
804 correo electrónico de la persona que hizo la consignación del conjunto
805 de cambios como el nombre de usuario Bugzilla con el cual debe
806 actualizar el fallo. Si esto no se ajusta a sus necesidades, es
807 posible asociar direcciones de correo a nombres de usuario Bugzilla
808 usando una sección \rcsection{usermap}.
810 Cada ítem en la sección \rcsection{usermap} contiene una dirección de
811 correo electrónico a la izquierda, y un nombre de usuario Bugzilla a
812 la derecha.
813 \begin{codesample2}
814 [usermap]
815 jane.user@example.com = jane
816 \end{codesample2}
817 Usted puede mantener los datos de \rcsection{usermap} en un fichero
818 \hgrc, o decirle al gancho \hgext{bugzilla} que lea la información
819 desde un fichero \filename{usermap} externo. En este caso, usted
820 puede almacenar los datos de \filename{usermap} en (por ejemplo) un
821 repositorio modificable por los usuarios. Esto hace posible para sus
822 usuarios mantener sus propias entradas \rcitem{bugzilla}{usermap}. El
823 fichero \hgrc\ principal se vería así:
824 \begin{codesample2}
825 # fichero hgrc normal se refiere a un fichero usermap externo
826 [bugzilla]
827 usermap = /home/hg/repos/userdata/bugzilla-usermap.conf
828 \end{codesample2}
829 Mientras que el fichero \filename{usermap} al que se hace referencia
830 se vería así:
831 \begin{codesample2}
832 # bugzilla-usermap.conf - dentro de un repositorio hg
833 [usermap]
834 stephanie@example.com = steph
835 \end{codesample2}
837 \subsubsection{Configurar el texto que se añade a un fallo}
839 Usted puede configurar el texto que este gancho añade como comentario;
840 usted los especifica como una plantilla Mercurial. Varias entradas
841 \hgrc\ (aún en la sección \rcsection{bugzilla}) controlan este
842 comportamiento.
843 \begin{itemize}
844 \item[\texttt{strip}] La cantidad de elementos iniciales de ruta a
845 remover de un nombre de ruta del repositorio para construir una ruta
846 parcial para una URL. Por ejemplo, si los repositorios en su
847 servidor se ubican en \dirname{/home/hg/repos}, y usted tiene un
848 repositorio cuya ruta es \dirname{/home/hg/repos/app/tests},
849 entonces fijar \texttt{strip} a \texttt{4} resultará en una ruta
850 parcial de \dirname{app/tests}. El gancho hará disponible esta ruta
851 parcial cuando expanda una plantilla, como \texttt{webroot}.
852 \item[\texttt{template}] El texto de la plantilla a usar. En adición a
853 las variables usuales relacionadas con conjuntos de cambios, esta
854 plantilla puede usar \texttt{hgweb} (el valor del ítem de
855 configuración \texttt{hgweb} de arriba) y \texttt{webroot} (la ruta
856 construida usando \texttt{strip} arriba).
857 \end{itemize}
859 Adicionalmente, usted puede añadir un ítem \rcitem{web}{baseurl} a la
860 sección \rcsection{web} de su \hgrc. El gancho \hgext{bugzilla}
861 publicará esto cuando expanda una plantilla, como la cadena base a
862 usar cuando se construya una URL que le permita a los usuarios navegar
863 desde un comentario de Bugzilla a la vista de un conjunto de cambios.
864 Ejemplo:
865 \begin{codesample2}
866 [web]
867 baseurl = http://hg.domain.com/
868 \end{codesample2}
870 A continuación se presenta un ejemplo completo de configuración para
871 el gancho \hgext{bugzilla}.
872 %TODO traducir?
873 \begin{codesample2}
874 [bugzilla]
875 host = bugzilla.example.com
876 password = mypassword
877 version = 2.16
878 # server-side repos live in /home/hg/repos, so strip 4 leading
879 # separators
880 strip = 4
881 hgweb = http://hg.example.com/
882 usermap = /home/hg/repos/notify/bugzilla.conf
883 template = Changeset \{node|short\}, made by \{author\} in the \{webroot\}
884 repo, refers to this bug.\\nFor complete details, see
885 \{hgweb\}\{webroot\}?cmd=changeset;node=\{node|short\}\\nChangeset
886 description:\\n\\t\{desc|tabindent\}
887 \end{codesample2}
889 \subsubsection{Pruebas y resolución de problemas}
891 Los problemas más comunes que aparecen en la configuración del gancho
892 \hgext{bugzilla} suelen estar relacionados con la ejecución del guión
893 de Bugzilla \filename{processmail} y la asociación de nombres de
894 consignadores a nombres de usuario.
896 Recuerde que en la sección~\ref{sec:hook:bugzilla:config} arriba el
897 usuario que ejecuta el proceso Mercurial en el servidor es también
898 el usuario que ejecutará el guión \filename{processmail}. El guión
899 \filename{processmail} algunas veces hace que Bugzilla escriba en
900 ficheros en su directorio de configuración, y los ficheros de
901 configuración de Bugzilla usualmente son propiedad del usuario bajo el
902 cual se ejecuta el servidor web.
904 Usted puede hacer que \filename{processmail} sea ejecutado con la
905 identidad del usuario adecuado usando el comando \command{sudo}. A
906 continuación se presenta una entrada de ejemplo para un fichero
907 \filename{sudoers}.
908 \begin{codesample2}
909 hg_user = (httpd_user) NOPASSWD: /var/www/html/bugzilla/processmail-wrapper %s
910 \end{codesample2}
911 Esto permite que el usuario \texttt{hg\_user} ejecute el programa
912 \filename{processmail-wrapper} con la identidad del usuario
913 \texttt{httpd\_user}.
915 Esta indirección a través de un guión envoltorio es necesaria, porque
916 \filename{processmail} espera que al ser ejecutado su directorio
917 actual sea aquel en el cual se instaló Bugzilla; usted no puede
918 especificar ese tipo de condición en un fichero \filename{sudoers}.
919 Los contenidos del giuón envoltorio son simples:
920 \begin{codesample2}
921 #!/bin/sh
922 cd `dirname $0` && ./processmail "$1" nobody@example.com
923 \end{codesample2}
924 No parece importar qué dirección de correo se le pase a
925 \filename{processmail}.
927 Si su \rcsection{usermap} no es configurada correctamente, los
928 usuarios verán un mensaje de error del gancho \hgext{bugzilla} cuando
929 empujen cambios al servidor. El mensaje de error se verá así:
930 \begin{codesample2}
931 cannot find bugzilla user id for john.q.public@example.com
932 \end{codesample2}
933 Lo que esto quiere decir es que la dirección del consignador,
934 \texttt{john.q.public@example.com}, no es un nombre de usuario
935 Bugzilla válido, ni tiene una entrada en su \rcsection{usermap} que lo
936 asocie con un nombre de usuario válido Bugzilla.
938 \subsection{\hgext{notify}---enviar notificaciones de correo
939 electrónico}
941 %TODO feeds => notificaciones: lo más fácil es mirar en wikipedia
942 Aunque el servidor web embebido de Mercurial provee notificaciones de
943 cambios en cada repositorio, muchas personas prefieren recibir las
944 notificaciones de cambios vía correo electrónico. El gancho
945 \hgext{notify}\ndt{Notificación.} le permite a usted enviar
946 notificaciones a un conjunto de direcciones de correo cuando lleguen
947 conjuntos de cambios en los que los subscriptores estén interesados.
949 De la misma forma que con el gancho \hgext{bugzilla}, el gancho
950 \hgext{notify} está orientado a plantillas, así que usted puede
951 personalizar los contenidos del mensaje de notificación que se envía.
953 Por defecto, el gancho \hgext{notify} incluye un diff de cada conjunto
954 %TODO que se envía? revisar, pienso que es ``que se recibe''
955 de cambios que se envía; usted puede limitar el tamaño del diff, o
956 desactivar completamente esta característica. Es útil para permitir a
957 los subscriptores revisar los cambios inmediatamente, en vez de tener
958 que hacer clic para visitar una URL.
960 \subsubsection{Configuración del gancho \hgext{notify}}
962 Usted puede configurar el gancho \hgext{notify} para enviar un mensaje
963 de correo por conjunto de cambios entrante, o uno por grupo entrante
964 de conjuntos de cambios (todos los que llegaron en un único empuje o
965 jalado).
966 \begin{codesample2}
967 [hooks]
968 # enviar un correo por grupo de cambios
969 changegroup.notify = python:hgext.notify.hook
970 # enviar un correo por cambio
971 incoming.notify = python:hgext.notify.hook
972 \end{codesample2}
974 La información para configurar este gancho se ubica en la sección
975 \rcsection{notify} de un fichero \hgrc.
976 \begin{itemize}
977 \item[\rcitem{notify}{test}] Por defecto, este gancho no envía correos
978 en absoluto; en vez de eso, imprime el mensaje que se
979 \emph{enviaría}. Fije este ítem en \texttt{false} para permitir el
980 envío de correos. El motivo por el que el envío de correos está
981 desactivado es que hacen falta varios intentos para configurar esta
982 extensión exactamente como usted desea, y sería maleducado enviar a
983 los subscriptores una cantidad de notificaciones ``rotas'' mientras
984 usted depura su configuración.
985 \item[\rcitem{notify}{config}] La ruta a un fichero de configuración
986 que contiene información de subscripción. Esto se mantiene separado
987 del \hgrc\ principal para que usted pueda mantenerlo en un
988 repositorio. La gente puede clonar ese repositorio, actualizar sus
989 subscripciones, y empujar los cambios de vuelta a su servidor.
990 \item[\rcitem{notify}{strip}] La cantidad de caracteres iniciales de
991 separación de ruta a remover de la ruta del repositorio, al decidir
992 si un repositorio tiene subscriptores. Por ejemplo, si los
993 repositorios en su servidor están en \dirname{/home/hg/repos}, y
994 \hgext{notify} está trabajando con un repositorio llamado
995 \dirname{/home/hg/repos/shared/test}, fijar \rcitem{notify}{strip} a
996 \texttt{4} hará que \hgext{notify} elimine las partes iniciales de
997 la ruta hasta \dirname{shared/test}, y asociará los subscriptores
998 frente a dicha ruta.
999 \item[\rcitem{notify}{template}] El texto de plantilla a usar cuando
1000 se envíen mensajes. Especifica los contenidos de la cabecera del
1001 mensaje y el cuerpo del mismo.
1002 \item[\rcitem{notify}{maxdiff}] El número máximo de líneas de datos de
1003 diff a añadir al final de un mensaje. Si la longitud de un diff es
1004 mayor a eso, se trunca. Por defecto, está fijado en 300. Fije esto a
1005 \texttt{0} para omitir los diffs en los correos de notificación.
1006 \item[\rcitem{notify}{sources}] Una lista de fuentes de conjuntos de
1007 cambios a considerar. Esto le permite a usted indicar a
1008 \hgext{notify} para que sólo envíe correos acerca de cambios que
1009 usuarios remotos hayan empujado al repositorio vía un servidor, por
1010 ejemplo. Vea la sección~\ref{sec:hook:sources} para las fuentes que
1011 usted puede especificar aquí.
1012 \end{itemize}
1014 Si usted fija el ítem \rcitem{web}{baseurl} en la sección
1015 \rcsection{web}, usted lo puede usar en una plantilla; estará
1016 disponible como \texttt{webroot}.
1018 A continuación se presenta un ejemplo completo de configuración para
1019 el gancho \hgext{notify}.
1020 \begin{codesample2}
1021 [notify]
1022 # enviar correo
1023 test = false
1024 # datos de subscriptores están en el repositorio notify
1025 config = /home/hg/repos/notify/notify.conf
1026 # repos están en /home/hg/repos on server, así que elimine 4
1027 # caracteres"/"
1028 strip = 4
1029 template = X-Hg-Repo: \{webroot\}
1030 Subject: \{webroot\}: \{desc|firstline|strip\}
1031 From: \{author\}
1033 changeset \{node|short\} in \{root\}
1034 details: \{baseurl\}\{webroot\}?cmd=changeset;node=\{node|short\}
1035 description:
1036 \{desc|tabindent|strip\}
1038 [web]
1039 baseurl = http://hg.example.com/
1040 \end{codesample2}
1042 Esto producirá un mensaje que se verá como el siguiente:
1043 \begin{codesample2}
1044 X-Hg-Repo: tests/slave
1045 Subject: tests/slave: Handle error case when slave has no buffers
1046 Date: Wed, 2 Aug 2006 15:25:46 -0700 (PDT)
1048 changeset 3cba9bfe74b5 in /home/hg/repos/tests/slave
1049 details: http://hg.example.com/tests/slave?cmd=changeset;node=3cba9bfe74b5
1050 description:
1051 Handle error case when slave has no buffers
1052 diffs (54 lines):
1054 diff -r 9d95df7cf2ad -r 3cba9bfe74b5 include/tests.h
1055 --- a/include/tests.h Wed Aug 02 15:19:52 2006 -0700
1056 +++ b/include/tests.h Wed Aug 02 15:25:26 2006 -0700
1057 @@ -212,6 +212,15 @@ static __inline__ void test_headers(void *h)
1058 [...snip...]
1059 \end{codesample2}
1061 \subsubsection{Pruebas y resolución de problemas}
1063 No olvide que por defecto, la extensión \hgext{notify} \emph{no
1064 enviará ningún correo electrónico} hasta que usted la configure
1065 explícitamente para hacerlo, fijando el valor de \rcitem{notify}{test}
1066 a \texttt{false}. Hasta que usted haga eso, simplemente se imprimirá
1067 el mensaje que se \emph{enviaría}.
1069 \section{Información para escritores de ganchos}
1070 \label{sec:hook:ref}
1072 \subsection{Ejecución de ganchos internos}
1074 Un gancho interno es llamado con argumentos de la siguiente forma:
1075 \begin{codesample2}
1076 def myhook(ui, repo, **kwargs):
1077 pass
1078 \end{codesample2}
1079 El parámetro \texttt{ui} es un objeto \pymodclass{mercurial.ui}{ui}.
1080 El parámetro \texttt{repo} es un objeto
1081 \pymodclass{mercurial.localrepo}{localrepository}. Los nombres y
1082 valores de los parámetros en \texttt{**kwargs} dependen del gancho que
1083 se invoque, con las siguientes características en común:
1084 \begin{itemize}
1085 \item Si hay un parámetro llamado \texttt{node} o
1086 \texttt{parent\emph{N}}, contendrá un ID hexadecimal de un conjunto
1087 de cambios. La cadena vacía es usada para representar un
1088 ``ID de conjunto de cambios nulo'' en vez de una cadena de ceros.
1089 \item Si hay un parámetro llamado \texttt{url}, contendrá la URL de un
1090 repositorio remoto, si puede ser determinada.
1091 \item Los parámetros booleanos son representados como objetos
1092 \texttt{bool} de Python.
1093 \end{itemize}
1095 Un gancho interno es ejecutado sin cambiar el directorio de trabajo
1096 del proceso (a diferencia de los ganchos externos, que son ejecutados
1097 desde la raíz del repositorio). El gancho no debe cambiar el
1098 directorio de trabajo del proceso, porque esto haría que falle
1099 cualquier llamada que se haga a la API de Mercurial.
1101 Si un gancho retorna el valor booleano ``false''\ndt{Falso.}, se
1102 considera que éste tuvo éxito. Si retorna
1103 ``true''\ndt{Verdadero.} o genera una excepción, se considera que
1104 ha fallado. Una manera útil de pensar en esta convención de llamado es
1105 ``dígame si usted falló''.
1107 Note que los IDs de conjuntos de cambios son pasados a los ganchos de
1108 Python como cadenas hexadecimales, no como los hashes binarios que la
1109 API de Mercurial usa normalmente. Para convertir un hash de
1110 hexadecimal a binario, use la función \pymodfunc{mercurial.node}{bin}.
1112 \subsection{Ejecución de ganchos externos}
1114 Un gancho externo es pasado al intérprete de comandos del usuario bajo
1115 el cual se ejecuta Mercurial. Las características del intérprete, como
1116 sustitución de variables y redirección de comandos, están disponibles.
1117 El gancho es ejecutado desde el directorio raíz del repositorio
1118 (a diferencia de los ganchos internos, que se ejecutan desde el mismo
1119 directorio en que Mercurial fue ejecutado).
1121 Los parámetros para el gancho se pasan como variables de entorno. El
1122 nombre de cada variable de entorno se pasa a mayúsculas y se le añade
1123 el prefijo ``\texttt{HG\_}''. Por ejemplo, si el nombre de un
1124 parámetro es ``\texttt{node}'', el nombre de la variable de entorno
1125 que almacena el parámetro se llamará ``\texttt{HG\_NODE}''.
1127 Un parámetro booleano se representa con la cadena ``\texttt{1}'' para
1128 ``true'', ``\texttt{0}'' para ``false''. Si una variable se llama
1129 \envar{HG\_NODE}, \envar{HG\_PARENT1} o \envar{HG\_PARENT2},
1130 contendrá un ID de conjunto de cambios representado como una cadena
1131 hexadecimal. La cadena vacía es usada para representar un ``ID de
1132 conjunto de cambios nulo'' en vez de una cadena de ceros. Si una
1133 variable de entorno se llama \envar{HG\_URL}, contendrá la URL de un
1134 repositorio remoto, si puede ser determinada.
1136 Si un gancho termina con un código de salida de cero, se considera que
1137 tuvo éxito. Si termina con un código de salida diferente de cero, se
1138 considera que falló.
1140 \subsection{Averiguar de dónde vienen los conjuntos de cambios}
1141 %TODO los trae la cigüeña. De París. Y quedan debajo de una col.
1143 Un gancho que involucra la transferencia de conjuntos de cambios entre
1144 un repositorio local y otro puede ser capaz de averiguar información
1145 acerca de ``el otro lado''. Mercurial sabe \emph{cómo} son
1146 transferidos los conjuntos de cambios, y en muchos casos también desde
1147 o hacia donde están siendo transferidos.
1149 \subsubsection{Fuentes de conjuntos de cambios}
1150 \label{sec:hook:sources}
1152 Mercurial le indicará a un gancho cuáles son, o fueron, los medios
1153 usados para transferir los conjuntos de cambios entre repositorios.
1154 Esta información es provista por Mercurial en un parámetro Python
1155 llamado \texttt{source}\ndt{Fuente.}, o una variable de entorno
1156 llamada \envar{HG\_SOURCE}.
1158 \begin{itemize}
1159 \item[\texttt{serve}] Los conjuntos de cambios son transferidos desde
1160 o hacia un repositorio remoto a través de http o ssh.
1161 \item[\texttt{pull}] Los conjuntos de cambios son transferidos vía una
1162 operación de jalado de un repositorio a otro.
1163 \item[\texttt{push}] Los conjuntos de cambios son transferidos vía un
1164 empuje de un repositorio a otro.
1165 \item[\texttt{bundle}] Los conjuntos de cambios son transferidos desde
1166 %TODO bundle
1167 o hacia un bundle.
1168 \end{itemize}
1170 \subsubsection{A dónde van los cambios---URLs de repositorios remotos}
1171 \label{sec:hook:url}
1172 %TODO al cielo? no, ésos son los perros
1174 Cuando es posible, Mercurial le indicará a los ganchos la ubicación de
1175 ``el otro lado'' de una actividad que transfiera datos de conjuntos de
1176 cambios entre repositorios. Esto es provisto por Mercurial en un
1177 parámetro Python llamado \texttt{url}, o en una variable de entorno
1178 llamada \envar{HG\_URL}.
1180 No siempre esta información está disponible. Si un gancho es invocado
1181 un repositorio que es servido a través de http o ssh, Mercurial no
1182 puede averiguar dónde está el repositorio remoto, pero puede saber
1183 desde dónde se conecta el cliente. En esos casos, la URL tendrá una de
1184 las siguientes formas:
1185 \begin{itemize}
1186 \item \texttt{remote:ssh:\emph{ip-address}}---cliente ssh remoto, en
1187 la dirección IP dada.
1188 \item \texttt{remote:http:\emph{ip-address}}---cliente remoto http, en
1189 la dirección IP dada. Si el cliente está usando SSL, tendrá la forma
1190 \texttt{remote:https:\emph{ip-address}}.
1191 \item Vacío---no se pudo descubrir información acerca del cliente
1192 remoto.
1193 \end{itemize}
1195 \section{Referencia de ganchos}
1197 \subsection{\hook{changegroup}---luego de añadir conjuntos de cambios
1198 remotos}
1199 \label{sec:hook:changegroup}
1201 Este gancho es ejecutado luego de que un grupo de conjuntos de cambios
1202 preexistentes ha sido añadido al repositorio, por ejemplo vía un
1203 \hgcmd{pull} o \hgcmd{unbundle}. Este gancho es ejecutado una vez por
1204 cada operación que añade uno o más conjuntos de cambios. Este gancho
1205 se diferencia del gancho \hook{incoming}, que es ejecutado una vez por
1206 cada conjunto de cambios, sin importar si los cambios llegan en grupo.
1208 Algunos usos posibles para este gancho includen el probar o ensamblar
1209 los conjuntos de cambios añadidos, actualizar una base de datos de
1210 fallos, o notificar a subscriptores de que el repositorio contiene
1211 nuevos cambios.
1213 Parámetros para este gancho:
1214 \begin{itemize}
1215 \item[\texttt{node}] Un ID de conjunto de cambios. El ID del primer conjunto
1216 de cambios que fue añadido en el grupo. Todos los conjuntos de
1217 cambios entre éste y la punta
1218 %TODO mirar qué hacer con el índice
1219 \index{tags!\texttt{tip}}(\texttt{tip}), inclusive, fueron añadidos
1220 %TODO unbundle
1221 por un único jalado (\hgcmd{pull}), empuje (\hgcmd{push}) o \hgcmd{unbundle}.
1222 \item[\texttt{source}] Una cadena. La fuente de estos cambios. Vea la
1223 sección~\ref{sec:hook:sources} para más detalles.
1224 \item[\texttt{url}] Una URL. La ubicación del repositorio remoto, si
1225 es conocida. Vea la sección~\ref{sec:hook:url} para más información.
1226 \end{itemize}
1228 Veta también: \hook{incoming} (sección~\ref{sec:hook:incoming}),
1229 \hook{prechangegroup} (sección~\ref{sec:hook:prechangegroup}),
1230 \hook{pretxnchangegroup} (sección~\ref{sec:hook:pretxnchangegroup})
1232 \subsection{\hook{commit}---luego de la creación de un nuevo conjunto
1233 de cambios}
1234 \label{sec:hook:commit}
1236 Este gancho es ejecutado luego de la creación de un nuevo conjunto de
1237 cambios.
1239 Parámetros para este gancho:
1240 \begin{itemize}
1241 \item[\texttt{node}] Un ID de conjunto de cambios. El ID de conjunto
1242 de cambios del conjunto de cambios que acabó de ser consignado.
1243 \item[\texttt{parent1}] Un ID de conjunto de cambios. El ID de
1244 conjunto de cambios del primer padre del conjunto de cambios que
1245 acaba de ser consignado.
1246 \item[\texttt{parent2}] Un ID de conjunto de cambios. El ID de
1247 conjunto de cambios del segundo padre del conjunto de cambios que
1248 acaba de ser consignado.
1249 \end{itemize}
1251 Vea también: \hook{precommit} (sección~\ref{sec:hook:precommit}),
1252 \hook{pretxncommit} (sección~\ref{sec:hook:pretxncommit})
1254 \subsection{\hook{incoming}---luego de que un conjunto de cambios
1255 remoto es añadido}
1256 \label{sec:hook:incoming}
1258 Este gancho es ejecutado luego de que un conjunto de cambios
1259 preexistente ha sido añadido al repositorio, por ejemplo, vía un
1260 \hgcmd{push}. Si un grupo de conjuntos de cambios fue añadido en una
1261 sola operación, este gancho es ejecutado una vez por cada conjunto de
1262 cambios añadido.
1264 Usted puede usar este gancho para los mismos fines que el gancho
1265 \hook{changegroup} (sección~\ref{sec:hook:changegroup}); simplemente
1266 algunas veces es más conveniente ejecutar un gancho una vez por cada
1267 grupo de conjuntos de cambios, mientras que otras es más útil correrlo
1268 por cada conjunto de cambios.
1270 Parámetros para este gancho:
1271 \begin{itemize}
1272 \item[\texttt{node}] Un ID de conjunto de cambios. El ID del conjunto
1273 de cambios recién añadido.
1274 \item[\texttt{source}] Una cadena. La fuente de estos cambios. Vea la
1275 sección~\ref{sec:hook:sources} para más detalles.
1276 \item[\texttt{url}] Una URL. La ubicación del repositorio remoto, si
1277 es conocida. Vea la sección~\ref{sec:hook:url} para más información.
1278 \end{itemize}
1280 Vea también: \hook{changegroup} (sección~\ref{sec:hook:changegroup})
1281 \hook{prechangegroup} (sección~\ref{sec:hook:prechangegroup}),
1282 \hook{pretxnchangegroup} (sección~\ref{sec:hook:pretxnchangegroup})
1284 \subsection{\hook{outgoing}---luego de la propagación de los conjuntos
1285 de cambios}
1286 \label{sec:hook:outgoing}
1288 Este gancho es ejecutado luego de que un grupo de conjuntos de cambios
1289 ha sido propagado fuera de éste repositorio, por ejemplo por un
1290 comando \hgcmd{push} o \hgcmd{bundle}.
1292 Un uso posible para este gancho es notificar a los administradores que
1293 los cambios han sido jalados.
1295 Parámetros para este gancho:
1296 \begin{itemize}
1297 \item[\texttt{node}] Un ID de conjunto de cambios. El ID del primer conjunto
1298 de cambios del grupo que fue enviado.
1299 \item[\texttt{source}] Una cadena. La fuente de la operación (vea la
1300 sección~\ref{sec:hook:sources}). Si un cliente remoto jaló cambios
1301 de este repositorio, \texttt{source} será \texttt{serve}. Si el
1302 cliente que obtuvo los cambios desde este repositorio era local,
1303 \texttt{source} será \texttt{bundle}, \texttt{pull}, o
1304 \texttt{push}, dependiendo de la operación que llevó a cabo el
1305 cliente.
1306 \item[\texttt{url}] Una URL. La ubicación del repositorio remoto, si
1307 es conocida. Vea la sección~\ref{sec:hook:url} para más información.
1308 \end{itemize}
1310 Vea también: \hook{preoutgoing} (sección~\ref{sec:hook:preoutgoing})
1312 \subsection{\hook{prechangegroup}---antes de empezar la adición de
1313 conjuntos de cambios remotos}
1314 \label{sec:hook:prechangegroup}
1316 Este gancho de control es ejecutado antes de que Mercurial empiece a
1317 añadir un grupo de conjuntos de cambios de otro repositorio.
1319 Este gancho no tiene ninguna información acerca de los conjuntos de
1320 cambios que van a ser añadidos, porque es ejecutado antes de que se
1321 permita que empiece la transmisión de dichos conjuntos de cambios. Si
1322 este gancho falla, los conjuntos de cambios no serán transmitidos.
1324 Un uso para este gancho es prevenir que se añadan cambios externos a un
1325 repositorio. Por ejemplo, usted podría usarlo para ``congelar''
1326 temporal o permanentemente una rama ubicada en un servidor para que
1327 los usuarios no puedan empujar cambios a ella, y permitiendo al mismo
1328 tiempo modificaciones al repositorio por parte de un administrador
1329 local.
1331 Parámetros para este gancho:
1332 \begin{itemize}
1333 \item[\texttt{source}] Una cadena. La fuente de estos cambios. Vea la
1334 sección~\ref{sec:hook:sources} para más detalles.
1335 \item[\texttt{url}] Una URL. La ubicación del repositorio remoto, si
1336 es conocida. Vea la sección~\ref{sec:hook:url} para más información.
1337 \end{itemize}
1339 Vea también: \hook{changegroup} (sección~\ref{sec:hook:changegroup}),
1340 \hook{incoming} (sección~\ref{sec:hook:incoming}), ,
1341 \hook{pretxnchangegroup} (sección~\ref{sec:hook:pretxnchangegroup})
1343 \subsection{\hook{precommit}---antes de iniciar la consignación de un
1344 conjunto de cambios}
1345 \label{sec:hook:precommit}
1347 Este gancho es ejecutado antes de que Mercurial inicie la consignación
1348 de un nuevo conjunto de cambios. Es ejecutado antes de que Mercurial
1349 tenga cualquier de los metadatos para la consignación, como los
1350 ficheros a ser consignados, el mensaje de consignación, o la fecha de
1351 consignación.
1353 Un uso para este gancho es deshabilitar la capacidad de consignar
1354 nuevos conjuntos de cambios, pero permitiendo conjuntos de cambios
1355 entrantes. Otro es ejecutar un proceso de ensamble/compilación o
1356 prueba, y permitir la consignación sólo si el ensamble/compilación o
1357 prueba tiene éxito.
1359 Parámetros para este gancho:
1360 \begin{itemize}
1361 \item[\texttt{parent1}] Un ID de conjunto de cambios. El ID de
1362 conjunto de cambios del primer padre del directorio de trabajo.
1363 \item[\texttt{parent2}] Un ID de conjunto de cambios. El ID de
1364 conjunto de cambios del segundo padre del directorio de trabajo.
1365 \end{itemize}
1366 Si la consignación continúa, los padres del directorio de trabajo se
1367 convertirán en los padres del nuevo conjunto de cambios.
1369 Vea también: \hook{commit} (sección~\ref{sec:hook:commit}),
1370 \hook{pretxncommit} (sección~\ref{sec:hook:pretxncommit})
1372 \subsection{\hook{preoutgoing}---antes de empezar la propagación de
1373 conjuntos de cambios}
1374 \label{sec:hook:preoutgoing}
1376 Este gancho es ejecutado antes de que Mercurial conozca las
1377 identidades de los conjuntos de cambios que deben ser transmitidos.
1379 Un uso para este gancho es evitar que los cambios sean transmitidos a
1380 otro repositorio.
1382 Parámetros para este gancho:
1383 \begin{itemize}
1384 \item[\texttt{source}] Una cadena. La fuente la operación que está
1385 tratando de obtener cambios de éste repositorio (vea
1386 la sección~\ref{sec:hook:sources}). Revise la documentación para
1387 el parámetro \texttt{source} del gancho \hook{outgoing}, en la
1388 sección~\ref{sec:hook:outgoing}, para ver los posibles valores de
1389 este parámetro.
1390 \item[\texttt{url}] Una URL. La ubicación del repositorio remoto, si
1391 es conocida. Vea la sección~\ref{sec:hook:url} para más información.
1392 \end{itemize}
1394 Vea también: \hook{outgoing} (sección~\ref{sec:hook:outgoing})
1396 \subsection{\hook{pretag}---antes de etiquetar un conjunto de cambios}
1397 \label{sec:hook:pretag}
1399 Este gancho de control es ejecutado antes de la creación de una
1400 etiqueta. Si el gancho termina exitosamente, la creación de la
1401 etiqueta continúa. Si el gancho falla, no se crea la etiqueta.
1403 Parámetros para este gancho:
1404 \begin{itemize}
1405 \item[\texttt{local}] Un booleano. Indica si la etiqueta es local a
1406 ésta instancia del repositorio (p.e.~almacenado en
1407 \sfilename{.hg/localtags}) o administrado por Mercurial (almacenado
1408 en \sfilename{.hgtags}).
1409 \item[\texttt{node}] Un ID de conjunto de cambios. El ID del conjunto
1410 de cambios a etiquetar.
1411 \item[\texttt{tag}] Una cadena. El nombre de la etiqueta por crear.
1412 \end{itemize}
1414 Si la etiqueta que se va a crear se encuentra bajo control de
1415 revisiones, los ganchos \hook{precommit} y \hook{pretxncommit}
1416 (secciones~\ref{sec:hook:commit} y~\ref{sec:hook:pretxncommit})
1417 también serán ejecutados.
1419 Vea también: \hook{tag} (sección~\ref{sec:hook:tag})
1421 \subsection{\hook{pretxnchangegroup}---antes de completar la adición
1422 de conjuntos de cambios remotos}
1423 \label{sec:hook:pretxnchangegroup}
1425 Este gancho de control es ejecutado antes de una transacción---la que
1426 maneja la adición de un grupo de conjuntos de cambios nuevos desde
1427 fuera del repositorio---se complete. Si el gancho tiene éxito, la
1428 transacción se completa, y todos los conjuntos de cambios se vuelven
1429 permanentes dentro de este repositorio. Si el gancho falla, la
1430 transacción es deshecha, y los datos para los conjuntos de cambios son
1431 eliminados.
1433 Este gancho puede acceder a los metadatos asociados con los conjuntos
1434 de cambios casi añadidos, pero no debe hacer nada permanente con estos
1435 datos. Tampoco debe modificar el directorio de trabajo.
1437 Mientras este gancho está corriendo, si otro proceso Mercurial accesa
1438 el repositorio, podrá ver los conjuntos de cambios casi añadidos como
1439 si fueran permanentes. Esto puede llevar a condiciones de carrera si
1440 usted no toma precauciones para evitarlas.
1442 Este gancho puede ser usado para examinar automáticamente un grupo de
1443 conjuntos de cambios. Si el gancho falla, todos los conjuntos de
1444 cambios son ``rechazados'' cuando la transacción se deshace.
1446 Parámetros para este gancho:
1447 \begin{itemize}
1448 \item[\texttt{node}] Un ID de conjunto de cambios. El ID del primer
1449 conjunto de cambios que fue añadido en el grupo. Todos los
1450 conjuntos de cambios entre éste y el
1451 \index{tags!\texttt{tip}}\texttt{tip}, inclusive, fueron añadidos
1452 por un único \hgcmd{pull}, \hgcmd{push} o \hgcmd{unbundle}.
1453 \item[\texttt{source}] Una cadena. La fuente de estos cambios. Vea la
1454 sección~\ref{sec:hook:sources} para más detalles.
1455 \item[\texttt{url}] Una URL. La ubicación del repositorio remoto, si
1456 es conocida. Vea la sección~\ref{sec:hook:url} para más información.
1457 \end{itemize}
1459 Vea también: \hook{changegroup} (sección~\ref{sec:hook:changegroup}),
1460 \hook{incoming} (sección~\ref{sec:hook:incoming}),
1461 \hook{prechangegroup} (sección~\ref{sec:hook:prechangegroup})
1463 \subsection{\hook{pretxncommit}---antes de completar la consignación
1464 de un nuevo conjunto de cambios}
1465 \label{sec:hook:pretxncommit}
1467 Este gancho de control es ejecutado antes de que una transacción---que
1468 maneja una nueva consignación---se complete. Si el gancho tiene éxito,
1469 la transacción se completa y el conjunto de cambios se hace permanente
1470 dentro de éste repositorio. Si el gancho falla, la transacción es
1471 deshecha, y los datos de consignación son borrados.
1473 Este gancho tiene acceso a los metadatos asociados con el
1474 prácticamente nuevo conjunto de cambios, pero no debería hacer nada
1475 permanente con estos datos. Tampoco debe modificar el directorio de
1476 trabajo.
1478 Mientras este gancho está corriendo, si otro proceso Mercurial accesa
1479 éste repositorio, podrá ver el prácticamente nuevo conjunto de cambios
1480 como si fuera permanente. Esto puede llevar a condiciones de carrera si
1481 usted no toma precauciones para evitarlas.
1483 Parámetros para este gancho:
1484 \begin{itemize}
1485 \item[\texttt{node}] Un ID de conjunto de cambios. El ID del
1486 conjunto de cambios recién consignado.
1487 \item[\texttt{parent1}] Un ID de conjunto de cambios. El ID de
1488 conjunto de cambios del primer padre del conjunto de cambios que
1489 acaba de ser consignado.
1490 \item[\texttt{parent2}] Un ID de conjunto de cambios. El ID de
1491 conjunto de cambios del segundo padre del conjunto de cambios que
1492 acaba de ser consignado.
1493 \end{itemize}
1495 Vea también: \hook{precommit} (sección~\ref{sec:hook:precommit})
1497 \subsection{\hook{preupdate}---antes de actualizar o fusionar el
1498 directorio de trabajo}
1499 \label{sec:hook:preupdate}
1501 Este gancho de control es ejecutado antes de actualizar o fusionar el
1502 directorio de trabajo. Es ejecutado sólo si las revisiones usuales de
1503 Mercurial antes de las actualizaciones determinan que la actualización
1504 o fusión pueden proceder. Si el gancho termina exitosamente, la
1505 actualización o fusión pueden proceder.; si falla, la actualización o
1506 fusión no empiezan.
1508 Parámetros para este gancho:
1509 \begin{itemize}
1510 \item[\texttt{parent1}] Un ID de conjunto de cambios. El ID del
1511 padre al que el directorio de trabajo será actualizado. Si se está
1512 fusionando el directorio de trabajo, no cambiará este padre.
1513 \item[\texttt{parent2}] Un ID de conjunto de cambios. Sólo está
1514 definido si se está fusionando el directorio de trabajo. El ID de la
1515 revisión con la cual está siendo fusionado el directorio de trabajo.
1516 \end{itemize}
1518 Vea también: \hook{update} (sección~\ref{sec:hook:update})
1520 \subsection{\hook{tag}---luego de etiquetar un conjunto de cambios}
1521 \label{sec:hook:tag}
1523 Este gancho es ejecutado luego de la creación de una etiqueta.
1525 Parámetros para este gancho:
1526 \begin{itemize}
1527 \item[\texttt{local}] Un booleano. Indica si la etiqueta es local a
1528 ésta instancia del repositorio (p.e.~almacenado en
1529 \sfilename{.hg/localtags}) o administrado por Mercurial (almacenado
1530 en \sfilename{.hgtags}).
1531 \item[\texttt{node}] Un ID de conjunto de cambios. El ID del
1532 conjunto de cambios que fue etiquetado.
1533 \item[\texttt{tag}] Una cadena. El nombre de la etiqueta que fue
1534 creada.
1535 \end{itemize}
1537 Si la etiqueta creada está bajo control de revisiones, el gancho
1538 \hook{commit} (sección~\ref{sec:hook:commit}) es ejecutado antes de
1539 este gancho.
1541 Vea también: \hook{pretag} (sección~\ref{sec:hook:pretag})
1543 \subsection{\hook{update}---luego de actualizar o fusionar el
1544 directorio de trabajo}
1545 \label{sec:hook:update}
1547 Este gancho es ejecutado después de una actualización o fusión en el
1548 directorio de trabajo. Ya que una fusión puede fallar (si el comando
1549 externo \command{hgmerge} no puede resolver los conflictos en un
1550 fichero), este gancho indica si la actualización o fusión fueron
1551 completados adecuadamente.
1553 \begin{itemize}
1554 \item[\texttt{error}] Un booleano. Indica si la actualización o fusión
1555 fue completada exitosamente.
1556 \item[\texttt{parent1}] Un ID de conjunto de cambios. El ID del padre
1557 al cual fue actualizado el directorio de trabajo. Si se fusionó el
1558 directorio de trabajo, no se habrá cambiado este padre.
1559 \item[\texttt{parent2}] Un ID de conjunto de cambios. Sólo está
1560 definido si se fusionó el directorio de trabajo. El ID de la
1561 revisión con la que fue fusionado el directorio de trabajo.
1562 \end{itemize}
1564 Vea también: \hook{preupdate} (sección~\ref{sec:hook:preupdate})
1566 %%% Local Variables:
1567 %%% mode: latex
1568 %%% TeX-master: "00book"
1569 %%% End: