jerojasro@437: \chapter{Manejo de eventos en repositorios mediante ganchos}
jerojasro@336: \label{chap:hook}
jerojasro@336: 
jerojasro@435: Mercurial ofrece un poderoso mecanismo para permitirle a usted
jerojasro@435: automatizar la ejecución de acciones en respuesta a eventos que
jerojasro@435: ocurran en un repositorio. En algunos casos, usted puede controlar
jerojasro@435: incluso la respuesta de Mercurial a dichos eventos.
jerojasro@435: 
jerojasro@435: Mercurial usa el término \emph{gancho} para identificar estas
jerojasro@435: acciones. Los ganchos son conocidos como ``disparadores'' en algunos
jerojasro@435: sistemas de control de revisiones, pero los dos nombres se refieren al
jerojasro@435: mismo concepto.
jerojasro@435: 
jerojasro@435: \section{Vistazo general de ganchos en Mercurial}
jerojasro@435: 
jerojasro@435: A continuación se encuentra una breve lista de los ganchos que
jerojasro@435: Mercurial soporta. Volveremos a cada uno de estos ganchos con más
jerojasro@435: detalle después, en la sección~\ref{sec:hook:ref}.
jerojasro@435: 
jerojasro@435: \begin{itemize}
jerojasro@435: \item[\small\hook{changegroup}] Es ejecutado luego de que un grupo de
jerojasro@435:     conjuntos de cambios ha sido traído al repositorio desde algún
jerojasro@435:     otro sitio.
jerojasro@435: \item[\small\hook{commit}] Es ejecutado después de la creación de
jerojasro@435:     un conjunto de cambios en el repositorio local.
jerojasro@435: \item[\small\hook{incoming}] Es ejecutado una vez por cada conjunto de
jerojasro@435:     cambios traído al repositorio desde otra ubicación. Note la
jerojasro@435:     diferencia respecto al gancho \hook{changegroup}, que es ejecutado
jerojasro@435:     una vez por cada \emph{grupo} de conjuntos de cambios que se
jerojasro@435:     traiga.
jerojasro@435: \item[\small\hook{outgoing}] Es ejecutado luego de que un grupo de
jerojasro@435:     conjuntos de cambios ha sido transmitido desde el repositorio.
jerojasro@435: \item[\small\hook{prechangegroup}] Es ejecutado antes de iniciar la
jerojasro@435:     recepción de un grupo de conjuntos de cambios en el repositorio.
jerojasro@435: \item[\small\hook{precommit}] De control. Es ejecutado antes de
jerojasro@435:     iniciar una consignación.
jerojasro@435: \item[\small\hook{preoutgoing}] De control. Es ejecutado antes de
jerojasro@435:     iniciar la transmisión de un grupo de conjuntos de cambios desde
jerojasro@435:     el repositorio.
jerojasro@435: \item[\small\hook{pretag}] De control. Es ejecutado antes de crear una
jerojasro@435:     etiqueta.
jerojasro@435: \item[\small\hook{pretxnchangegroup}] De control. Es ejecutado después
jerojasro@435:     de haber recibido un grupo de conjuntos de cambios en el
jerojasro@435:     repositorio local, pero antes de que la transacción se complete y
jerojasro@435:     los cambios sean permanentes dentro del repositorio.
jerojasro@435: \item[\small\hook{pretxncommit}] De control. Es ejecutado luego de la
jerojasro@435:     creación de un conjunto de cambios en el repositorio local, pero
jerojasro@435:     antes de que la transacción que hace permanente el cambio sea
jerojasro@435:     completada.
jerojasro@435: \item[\small\hook{preupdate}] De control. Es ejecutado antes de
jerojasro@435:     iniciar una actualización o fusión en el directorio de trabajo.
jerojasro@435: \item[\small\hook{tag}] Es ejecutado después de la creación de una
jerojasro@435:     etiqueta.
jerojasro@435: \item[\small\hook{update}] Es ejecutado después de que termina una
jerojasro@435:     actualización o una fusión.
jerojasro@435: \end{itemize}
jerojasro@435: Cada uno de los ganchos cuya descripción empieza con la frase
jerojasro@435: ``de control'' tiene la facultad de determinar si una actividad puede
jerojasro@435: continuar. Si el gancho se ejecuta con éxito, la actividad puede
jerojasro@435: continuar; si falla, o bien la actividad no es permitida, o se
jerojasro@435: deshacen los cambios que se puedan haber llevado a cabo, dependiendo
jerojasro@435: del gancho involucrado.
jerojasro@435: 
jerojasro@435: \section{Ganchos y seguridad}
jerojasro@435: 
jerojasro@435: \subsection{Los ganchos se ejecutan con sus privilegios de usuario}
jerojasro@435: 
jerojasro@435: Cuando usted ejecuta un comando de Mercurial en un repositorio, y el
jerojasro@435: comando causa la ejecución de un gancho, dicho gancho se ejecuta en
jerojasro@435: \emph{su} sistema, en \emph{su} cuenta de usuario, con \emph{sus}
jerojasro@435: privilegios. Ya que los ganchos son elementos arbitrarios de código
jerojasro@435: ejecutable, usted debería tratarlos con un nivel adecuado de
jerojasro@435: desconfianza. No instale un gancho a menos en que confíe en quien lo
jerojasro@435: creó y en lo que el gancho hace.
jerojasro@435: 
jerojasro@435: En algunos casos, usted puede estar expuesto a ganchos que usted no
jerojasro@435: %TODO acá introduzco algo de texto por mi cuenta, por claridad
jerojasro@435: instaló. Si usted usa Mercurial en un sistema extraño, tenga en cuenta
jerojasro@435: que Mercurial ejecutará los ganchos definidos en el fichero \hgrc.
jerojasro@435: 
jerojasro@435: Si está trabajando con un repositorio propiedad de otro usuario,
jerojasro@435: Mercurial podrá ejecutar los ganchos definidos en el repositorio de
jerojasro@435: dicho usuario, pero los ejecutará como ``usted''. Por ejemplo, si
jerojasro@435: usted jala (\hgcmd{pull}) desde ese repositorio, y el
jerojasro@435: \sfilename{.hg/hgrc} define un gancho saliente (\hook{outgoing}),
jerojasro@435: dicho gancho se ejecuta bajo su cuenta de usuario, aun cuando usted no
jerojasro@435: es el propietario del repositorio.
jerojasro@336: 
jerojasro@336: \begin{note}
jerojasro@435:   Esto sólo aplica si usted está jalando desde un repositorio en un
jerojasro@435:   sistema de ficheros local o de red. Si está jalando a través de http
jerojasro@435:   o ssh, cualquier gancho saliente (\hook{outgoing}) se ejecutará bajo
jerojasro@435:   la cuenta que está ejecutando el proceso servidor, en el servidor.
jerojasro@336: \end{note}
jerojasro@336: 
jerojasro@435: XXX Para ver qué ganchos han sido definidos en un repositorio, use el
jerojasro@435: comando \hgcmdargs{config}{hooks}. Si usted está trabajando en un
jerojasro@435: repositorio, pero comunicándose con otro que no le pertenece
jerojasro@435: (por ejemplo, usando \hgcmd{pull} o \hgcmd{incoming}), recuerde que
jerojasro@435: los ganchos que debe considerar son los del otro repositorio, no los
jerojasro@435: del suyo.
jerojasro@435: 
jerojasro@435: \subsection{Los ganchos no se propagan}
jerojasro@435: 
jerojasro@435: En Mercurial, no se hace control de revisiones de los ganchos, y no se
jerojasro@435: propagan cuando usted clona, o jala de, un repositorio. El motivo para
jerojasro@435: esto es simple: un gancho es código ejecutable arbitrario. Se ejecuta
jerojasro@435: bajo su identidad, con su nivel de privilegios, en su máquina.
jerojasro@435: 
jerojasro@435: Sería extremadamente descuidado de parte de cualquier sistema
jerojasro@435: distribuido de control de revisiones el implementar control de
jerojasro@435: revisiones para ganchos, ya que esto ofrecería maneras fácilmente
jerojasro@435: %TODO subvertir
jerojasro@435: aprovechables de subvertir las cuentas de los usuarios del sistema de
jerojasro@435: control de revisiones.
jerojasro@435: 
jerojasro@435: Ya que Mercurial no propaga los ganchos, si usted está colaborando con
jerojasro@435: otras personas en un proyecto común, no debería asumir que ellos están
jerojasro@435: usando los mismos ganchos para Mercurial que usted usa, o que los de
jerojasro@435: ellos están configurado correctamente. Usted debería documentar los
jerojasro@435: ganchos que usted espera que la gente use.
jerojasro@336: 
jerojasro@437: En una intranet corporativa, esto es algo más fácil de manejar, ya que
jerojasro@437: usted puede, por ejemplo, proveer una instalación ``estándar'' de
jerojasro@437: Mercurial en un sistema de ficheros NFS, y usar un fichero \hgrc\
jerojasro@437: global para definir los ganchos que verán todos los usuarios. Sin
jerojasro@437: embargo, este enfoque tiene sus límites; vea más abajo.
jerojasro@336: 
jerojasro@441: \subsection{Es posible hacer caso omiso de los ganchos}
jerojasro@441: 
jerojasro@441: Mercurial le permite hacer caso omiso de la deficinión de un gancho,
jerojasro@441: a través de la redefinición del mismo. Usted puede deshabilitar el
jerojasro@441: gancho fijando su valor como una cadena vacía, o cambiar su
jerojasro@441: comportamiento como desee.
jerojasro@441: 
jerojasro@441: Si usted instala un fichero \hgrc\ a nivel de sistema o sitio completo
jerojasro@441: que define algunos ganchos, debe entender que sus usuarios pueden
jerojasro@441: deshabilitar o hacer caso omiso de los mismos.
jerojasro@441: 
jerojasro@441: \subsection{Asegurarse de que ganchos críticos sean ejecutados}
jerojasro@441: 
jerojasro@441: Algunas veces usted puede querer hacer respetar una política, y no
jerojasro@441: permitir que los demás sean capaces de evitarla. Por ejemplo, usted
jerojasro@441: puede tener como requerimiento que cada conjunto de cambios debe pasar
jerojasro@441: un riguroso conjunto de pruebas. Definir este requerimientos a través
jerojasro@441: de un gancho en un fichero \hgrc\ global no servirá con usuarios
jerojasro@441: remotos en computadoras portátiles, y por supuesto que los usuarios
jerojasro@441: locales pueden evitar esto a voluntad haciendo caso omiso del gancho.
jerojasro@441: 
jerojasro@441: En vez de eso, usted puede definir las políticas para usar Mercurial
jerojasro@441: de tal forma que se espere que los usuarios propaguen los cambios a
jerojasro@441: través de un servidor ``canónico'' bien conocido que usted ha
jerojasro@441: asegurado y configurado apropiadamente.
jerojasro@441: 
jerojasro@441: Una manera de hacer esto es a través de una combinación de ingeniería
jerojasro@441: socual y tecnología. Cree una cuenta de acceso restringido; los
jerojasro@441: usuarios pueden empujar cambios a través de la red a los repositorios
jerojasro@441: administrados por esta cuenta, pero no podrán ingresar a dicha cuenta
jerojasro@441: para ejecutar órdenes en el intérprete de comandos. En este escenario,
jerojasro@441: un usuario puede enviar un conjunto de cambios que contenga la
jerojasro@441: porquería que él desee.
jerojasro@441: 
jerojasro@441: Cuando alguien empuja un conjunto de cambios al servidor del que todos
jerojasro@441: jalan, el servidor probará el conjunto de cambios antes de aceptarlo
jerojasro@441: como permanente, y lo rechazará si no logra pasar el conjunto de
jerojasro@441: pruebas. Si la gente sólo jala cambios desde este servidor de filtro,
jerojasro@441: servirá para asegurarse de que todos los cambios que la gente jala han
jerojasro@441: sido examinados automáticamente
jerojasro@441: 
jerojasro@441: \section{Precauciones con ganchos \texttt{pretxn} en un repositorio de
jerojasro@441: acceso compartido}
jerojasro@441: 
jerojasro@441: Si usted desea usar ganchos para llevar a cabo automáticamente algún
jerojasro@441: trabajo en un repositorio al que varias personas tienen acceso
jerojasro@441: compartido, debe tener cuidado con la forma de hacerlo.
jerojasro@441: 
jerojasro@441: Mercurial sólo bloquea un repositorio cuando está escribiendo al
jerojasro@441: mismo, y sólo las partes de Mercurial que escriben al repositorio le
jerojasro@441: prestan atención a los bloqueos. Los bloqueos de escritura son
jerojasro@441: necesarios para evitar que múltiples escritores simultáneos
jerojasro@441: interfieran entre sí, corrompiendo el repositorio.
jerojasro@441: 
jerojasro@441: Ya que Mercurial tiene cuidado con el orden en que lee y escribe
jerojasro@441: datos, no necesita adquirir un bloqueo cuando desea leer datos del
jerojasro@441: repositorio. Las partes de Mercurial que leen del repositorio nunca le
jerojasro@441: prestan atención a los bloqueos. Este esquema de lectura libre de
jerojasro@441: bloqueos incremententa en gran medida el desempeño y la concurrencia.
jerojasro@441: 
jerojasro@441: Sin embargo, para tener un gran desempeño es necesario hacer
jerojasro@441: sacrificios, uno de los cuales tiene el potencial de causarle
jerojasro@441: problemas a menos de que usted esté consciente de él. Describirlo
jerojasro@441: requiere algo de detalle respecto a cómo Mercurial añade conjuntos de
jerojasro@441: cambios al repositorio y cómo lee esos cambios de vuelta.
jerojasro@441: 
jerojasro@441: Cuando Mercurial \emph{escribe} metadatos, los escribe directamente en
jerojasro@441: el fichero de destino. Primero escribe los datos del fichero, luego
jerojasro@441: los datos del manifiesto (que contienen punteros a los nuevos datos
jerojasro@441: del fichero), luego datos de la bitácora de cambios (que contienen
jerojasro@441: punteros a los nuevos datos del manifiesto). Antes de la primera
jerojasro@441: escritura a cada fichero, se guarda un registro de dónde estaba el
jerojasro@441: final de fichero en su registro de transacciones. Si la transacción
jerojasro@441: debe ser deshecha, Mercurial simplemente trunca cada fichero de vuelta
jerojasro@441: al tamaño que tenía antes de que empezara la transacción.
jerojasro@441: 
jerojasro@441: Cuando Mercurial \emph{lee} metadatos, lee la bitácora de cambios
jerojasro@441: primero, y luego todo lo demás. Como un lector sólo accederá a las
jerojasro@441: partes del manifiesto o de los metadatos de fichero que él puede ver
jerojasro@441: en la bitácora de cambios, nunca puede ver datos parcialmente
jerojasro@441: escritos.
jerojasro@441: 
jerojasro@441: Algunos ganchos de control (\hook{pretxncommit} y
jerojasro@441: \hook{pretxnchangegroup}) se ejecutan cuando una transacción está casi
jerojasro@441: completa. Todos los metadatos han sido escritos, pero Mercurial aún
jerojasro@441: puede deshacer la transacción y hacer que los datos recién escritos
jerojasro@441: desaparezcan.
jerojasro@441: 
jerojasro@441: Si alguno de estos ganchos permanece en ejecución por mucho tiempo,
jerojasro@441: abre una ventana de tiempo en la que un lector puede ver los metadatos
jerojasro@441: de conjuntos de cambios que aún no son permanentes y que no debería
jerojasro@441: considerarse que estén ``realmante ahí''. Entre más tiempo tome la
jerojasro@441: ejecución del gancho, más tiempo estará abierta esta ventana.
jerojasro@441: 
jerojasro@441: \subsection{Ilustración del problema}
jerojasro@441: 
jerojasro@441: En principio, un buen uso del gancho \hook{pretxnchangegroup} sería
jerojasro@441: ensamblar y probar automáticamente todos los cambios entrantes antes
jerojasro@441: de que sean aceptados en un repositorio central. Esto le permitiría a
jerojasro@441: usted garantizar que nadie pueda empujar cambios que ``rompan el
jerojasro@441: ensamblaje''. Pero si un cliente puede jalar cambios mientras están
jerojasro@441: siendo probados, la utilidad de esta prueba es nula; alguien confiado
jerojasro@441: puede jalar cambios sin probar, lo que potencialmente podría romper su
jerojasro@441: proceso de ensamblaje.
jerojasro@441: 
jerojasro@441: La respuesta técnica más segura frente a este retos es montar dicho
jerojasro@441: repositorio ``guardián'' como \emph{unidireccional}. Permita que
jerojasro@441: reciba cambios desde el exterior, pero no permita que nadie jale
jerojasro@441: cambios de él (use el gancho \hook{preoutgoing} para bloquear esto).
jerojasro@441: Configure un gancho \hook{changegroup} para que si el ensamblaje o
jerojasro@441: prueba tiene éxito, el gancho empuje los nuevos cambios a otro
jerojasro@441: repositorio del que la gente \emph{pueda} jalar.
jerojasro@441: 
jerojasro@441: En la práctica, montar un cuello de botella centralizado como éste a
jerojasro@441: menudo no es una buena idea, y la visibilidad de las transacciones no
jerojasro@441: tiene nada que ver con el problema. A medida que el tamaño de un
jerojasro@441: proyecto---y el tiempo que toma ensamblarlo y probarlo---crece, usted
jerojasro@441: se acerca rápidamente a un límite con este enfoque ``pruebe antes de
jerojasro@441: comprar'', en el que tiene más conjuntos de cambios a probar que
jerojasro@441: tiempo para ocuparse de ellos. El resultado inevitable es frustración
jerojasro@441: para todos los que estén involucrados.
jerojasro@441: 
jerojasro@441: Una aproximación que permite manejar mejor el crecimiento es hacer que
jerojasro@441: la gente ensamble y pruebe antes de empujar, y ejecutar el ensamble y
jerojasro@441: pruebas automáticas centralmente \emph{después} de empujar, para
jerojasro@441: asegurarse de que todo esté bien. La ventaja de este enfoque es que no
jerojasro@441: impone un límite a la rata en la que un repositorio puede aceptar
jerojasro@441: cambios.
jerojasro@441: 
jerojasro@441: \section{Tutorial corto de uso de ganchos}
jerojasro@336: \label{sec:hook:simple}
jerojasro@336: 
jerojasro@442: Escribir un gancho para Mercurial es fácil. Empecemos con un gancho
jerojasro@442: que se ejecute cuando usted termine un \hgcmd{commit}, y simplemente
jerojasro@442: muestre el hash del conjunto de cambios que usted acaba de crear. El
jerojasro@442: gancho se llamará \hook{commit}.
jerojasro@336: 
jerojasro@336: \begin{figure}[ht]
jerojasro@336:   \interaction{hook.simple.init}
jerojasro@442:   \caption{Un gancho simple que se ejecuta al hacer la consignación de
jerojasro@442:   un conjunto de cambios}
jerojasro@336:   \label{ex:hook:init}
jerojasro@336: \end{figure}
jerojasro@336: 
jerojasro@442: Todos los ganchos siguen el patrón del ejemplo~\ref{ex:hook:init}.
jerojasro@442: Usted puede añadir una entrada a la sección \rcsection{hooks} de su
jerojasro@442: fichero \hgrc.  A la izquierda está el nombre del evento respecto al
jerojasro@442: cual dispararse; a la derecha está la acción a llevar a cabo. Como
jerojasro@442: puede ver, es posible ejecutar cualquier orden de la línea de comandos
jerojasro@442: en un gancho. Mercurial le pasa información extra al gancho usando
jerojasro@442: variables de entorno (busque \envar{HG\_NODE} en el ejemplo).
jerojasro@442: 
jerojasro@442: \subsection{Llevar a cabo varias acciones por evento}
jerojasro@442: 
jerojasro@442: A menudo, usted querrá definir más de un gancho para un tipo de evento
jerojasro@442: particular, como se muestra en el ejemplo~\ref{ex:hook:ext}. 
jerojasro@442: Mercurial le permite hacer esto añadiendo una \emph{extensión} al
jerojasro@442: final del nombre de un gancho. Usted extiende el nombre del gancho
jerojasro@442: %TODO Yuk, no me gusta ese "parada completa"
jerojasro@442: poniendo el nombre del gancho, seguido por una parada completa (el
jerojasro@442: caracter ``\texttt{.}''), seguido de algo más de texto de su elección.
jerojasro@442: Por ejemplo, Mercurial ejecutará tanto \texttt{commit.foo} como
jerojasro@442: \texttt{commit.bar} cuando ocurra el evento \texttt{commit}.
jerojasro@336: 
jerojasro@336: \begin{figure}[ht]
jerojasro@336:   \interaction{hook.simple.ext}
jerojasro@442:   \caption{Definición de un segundo gancho \hook{commit}}
jerojasro@336:   \label{ex:hook:ext}
jerojasro@336: \end{figure}
jerojasro@336: 
jerojasro@442: Para dar un orden bien definido de ejecución cuando hay múltiples
jerojasro@442: ganchos definidos para un evento, Mercurial ordena los ganchos de
jerojasro@442: acuerdo a su extensión, y los ejecuta en dicho orden. En el ejemplo de
jerojasro@442: arribam \texttt{commit.bar} se ejecutará antes que
jerojasro@442: \texttt{commit.foo}, y \texttt{commit} se ejecutará antes de ambos.
jerojasro@442: 
jerojasro@442: Es una buena idea usar una extensión descriptiva cuando usted define
jerojasro@442: un gancho. Esto le ayudará a recordar para qué se usa el gancho. Si el
jerojasro@442: gancho falla, usted recibirá un mensaje de error que contiene el
jerojasro@442: nombre y la extensión del gancho, así que usar una extensión
jerojasro@442: descriptiva le dará una pista inmediata de porqué el gancho falló (vea
jerojasro@442: un ejemplo en la sección~\ref{sec:hook:perm}).
jerojasro@442: 
jerojasro@442: \subsection{Controlar cuándo puede llevarse a cabo una actividad}
jerojasro@336: \label{sec:hook:perm}
jerojasro@336: 
jerojasro@442: En los ejemplos anteriores, usamos el gancho \hook{commit}, que es
jerojasro@442: ejecutado después de que se ha completado una consignación. Este es
jerojasro@442: uno de los varios ganchos que Mercurial ejecuta luego de que una
jerojasro@442: actividad termina. Tales ganchos no tienen forma de influenciar la
jerojasro@442: actividad como tal.
jerojasro@442: 
jerojasro@442: Mercurial define un número de eventos que ocurren antes de que una
jerojasro@442: actividad empiece; o luego de que empiece, pero antes de que termine.
jerojasro@442: Los ganchos que se disparan con estos eventos tienen la capacidad
jerojasro@442: adicional de elegir si la actividad puede continuar, o si su ejecución
jerojasro@442: es abortada.
jerojasro@442: 
jerojasro@442: El gancho \hook{pretxncommit} se ejecuta justo antes de que una
jerojasro@442: consignación se ejecute. En otras palabras, los metadatos que
jerojasro@442: representan el conjunto de cambios han sido escritos al disco, pero no
jerojasro@442: se ha terminado la transacción. El gancho \hook{pretxncommit} tiene la
jerojasro@442: capacidad de decidir si una transacción se completa, o debe
jerojasro@442: deshacerse.
jerojasro@442: 
jerojasro@442: Si el gancho \hook{pretxncommit} termina con un código de salida de
jerojasro@442: cero, se permite que la transacción se complete; la consignación
jerojasro@442: termina; y el gancho \hook{commit} es ejecutado. Si el gancho
jerojasro@442: \hook{pretxncommit} termina con un código de salida diferente de cero,
jerojasro@442: la transacción es revertida; los metadatos representando el conjunto
jerojasro@442: de cambios son borrados; y el gancho \hook{commit} no es ejecutado.
jerojasro@336: 
jerojasro@336: \begin{figure}[ht]
jerojasro@336:   \interaction{hook.simple.pretxncommit}
jerojasro@442:   \caption{Uso del gancho \hook{pretxncommit} hook to control commits}
jerojasro@336:   \label{ex:hook:pretxncommit}
jerojasro@336: \end{figure}
jerojasro@336: 
jerojasro@452: El gancho en el ejemplo~\ref{ex:hook:pretxncommit} revisa si el
jerojasro@452: mensaje de consignación contiene el ID de algún fallo. Si lo contiene,
jerojasro@452: la consignación puede continuar. Si no, la consignación es cancelada.
jerojasro@452: 
jerojasro@452: \section{Escribir sus propios ganchos}
jerojasro@452: 
jerojasro@452: Cuando usted escriba un gancho, puede encontrar útil el ejecutar
jerojasro@452: Mercurial o bien pasándole la opción \hggopt{-v}, o con el valor de
jerojasro@452: configuración \rcitem{ui}{verbose} fijado en ``true'' (verdadero).
jerojasro@452: Cuando lo haga, Mercurial imprimirá un mensaje antes de llamar cada
jerojasro@452: gancho.
jerojasro@452: 
jerojasro@452: \subsection{Escoger cómo debe ejecutarse su gancho}
jerojasro@336: \label{sec:hook:lang}
jerojasro@336: 
jerojasro@452: Usted puede escribir un gancho que funcione como un programa normal
jerojasro@452: ---típicamente un guión de línea de comandos---o como una función de
jerojasro@452: Python que se ejecuta dentro del proceso Mercurial.
jerojasro@452: 
jerojasro@452: Escribir un gancho como un programa externo tiene la ventaja de que no
jerojasro@452: requiere ningún conocimiento del funcionamiento interno de Mercurial.
jerojasro@452: Usted puede ejecutar comandos Mercurial normales para obtener la
jerojasro@452: informción extra que pueda necesitar. La contraparte de esto es que
jerojasro@452: los ganchos externos son más lentos que los ganchos internos
jerojasro@452: ejecutados dentro del proceso.
jerojasro@452: 
jerojasro@452: Un gancho Python interno tiene acceso completo a la API de Mercurial,
jerojasro@452: y no se ``externaliza'' a otro proceso, así que es inherentemente más
jerojasro@452: rápido que un gancho externo. Adicionalmente es más fácil obtener la
jerojasro@452: mayoría de la información que un gancho requiere a través de llamadas
jerojasro@452: directas a la API de Mercurial que hacerlo ejecutando comandos
jerojasro@452: Mercurial.
jerojasro@452: 
jerojasro@452: Si se siente a gusto con Python, o requiere un alto desempeño,
jerojasro@452: escribir sus ganchos en Python puede ser una buena elección. Sin
jerojasro@452: embargo, cuando usted tiene un gancho bastante directo por escribir y
jerojasro@452: no le importa el desempeño (el caso de la mayoría de los ganchos), es
jerojasro@452: perfectamente admisible un guión de línea de comandos.
jerojasro@336: 
jerojasro@461: \subsection{Parámetros para ganchos}
jerojasro@336: \label{sec:hook:param}
jerojasro@336: 
jerojasro@461: Mercurial llama cada gancho con un conjunto de paŕametros bien
jerojasro@461: definidos. En Python, un parámetro se pasa como argumento de palabra
jerojasro@461: clave a su función de gancho. Para un programa externo, los parámetros
jerojasro@461: son pasados como variables de entornos.
jerojasro@461: 
jerojasro@461: Sin importar si su gancho está escrito en Python o como guión de línea
jerojasro@461: de comandos, los nombres y valores de los parámetros específicos de
jerojasro@461: los ganchos serán los mismos. Un parámetro booleano será representado
jerojasro@461: como un valor booleano en Python, pero como el número 1 (para
jerojasro@461: ``verdadero'') o 0 (para falso) en una variable de entorno para un
jerojasro@461: gancho externo. Si un parámetro se llama \texttt{foo}, el argumento de
jerojasro@461: palabra clave para un gancho en Python también se llamará
jerojasro@461: \texttt{foo}, mientras que la variable de entorno para un gancho
jerojasro@461: externo se llamará \texttt{HG\_FOO}.
jerojasro@461: 
jerojasro@461: \subsection{Valores de retorno de ganchos y control de actividades}
jerojasro@461: 
jerojasro@461: Un gancho que se ejecuta exitosamente debe terminar con un código de
jerojasro@461: salida de cero, si es externo, o retornar el valor booleano
jerojasro@461: ``falso'', si es interno. Un fallo se indica con un código de salida
jerojasro@461: diferente de cero desde un gancho externo, o un valor de retorno
jerojasro@461: booleano ``verdadero''. Si un gancho interno genera una excepción, se
jerojasro@461: considera que el gancho ha fallado.
jerojasro@461: 
jerojasro@461: Para los ganchos que controlan si una actividad puede continuar o no,
jerojasro@461: cero/falso quiere decir ``permitir'', mientras que
jerojasro@461: % TODO me suena mejor "no permitir" que "denegar"
jerojasro@461: no-cero/verdadero/excepción quiere decir ``no permitir''.
jerojasro@461: 
jerojasro@461: \subsection{Escribir un gancho externo}
jerojasro@461: 
jerojasro@461: Cuando usted define un gancho externo en su fichero \hgrc\ y el mismo
jerojasro@461: es ejecutado, dicha definición pasa a su intérprete de comandos, que
jerojasro@461: hace la interpretación correspondiente. Esto significa que usted puede
jerojasro@461: usar elementos normales del intérprete en el cuerpo del gancho.
jerojasro@461: 
jerojasro@461: Un gancho ejecutable siempre es ejecutado con su directorio actual
jerojasro@461: fijado al directorio raíz del repositorio.
jerojasro@461: 
jerojasro@461: Cada parámetro para el gancho es pasado como una variable de entorno;
jerojasro@461: el nombre está en mayúsculas, y tiene como prefijo la cadena
jerojasro@461: ``\texttt{HG\_}''.
jerojasro@461: 
jerojasro@461: Con la excepción de los parámetros para los ganchos, Mercurial no
jerojasro@461: define o modifica ninguna variable de entorno al ejecutar un gancho.
jerojasro@461: Es útil recordar esto al escribir un gancho global que podría ser
jerojasro@461: ejecutado por varios usuarios con distintas variables de entorno
jerojasro@461: fijadas. En situaciones con múltiples usuarios, usted no debería
jerojasro@461: asumir la existencia de ninguna variable de entorno, ni que sus
jerojasro@461: valores sean los mismos que tenían cuando usted probó el gancho en su
jerojasro@461: ambiente de trabajo.
jerojasro@461: 
jerojasro@461: \subsection{Indicar a Mercurial que use un gancho interno}
jerojasro@461: 
jerojasro@461: La sintaxis para definir un gancho interno en el fichero \hgrc\ es
jerojasro@461: ligeramente diferente de la usada para un gancho externo. El valor del
jerojasro@461: gancho debe comenzar con el texto ``\texttt{python:}'', y continuar
jerojasro@461: con el nombre completamente cualificado de un objeto invocable que se
jerojasro@461: usará como el valor del gancho.
jerojasro@461: 
jerojasro@461: El módulo en que vive un gancho es importado automáticamente cuando se
jerojasro@461: ejecuta un gancho. Siempre que usted tenga el nombre del módulo y la
jerojasro@461: variable de entorno \envar{PYTHONPATH} ajustada adecuadamente, todo
jerojasro@461: debería funcionar sin problemas.
jerojasro@461: 
jerojasro@461: El siguiente fragmento de ejemplo de un fichero \hgrc\ ilustra la
jerojasro@461: sintaxis y significado de los conceptos que acabamos de describir.
jerojasro@336: \begin{codesample2}
jerojasro@336:   [hooks]
jerojasro@336:   commit.example = python:mymodule.submodule.myhook
jerojasro@336: \end{codesample2}
jerojasro@461: Cuando Mercurial ejecuta el gancho \texttt{commit.example}, importa 
jerojasro@461: \texttt{mymodule.submodule}, busca el objeto invocable llamado
jerojasro@461: \texttt{myhook}, y lo invoca (llama).
jerojasro@461: 
jerojasro@461: \subsection{Escribir un gancho interno}
jerojasro@461: 
jerojasro@461: El gancho interno más sencillo no hace nada, pero ilustra la
jerojasro@461: estructura básica de la API\footnote{\emph{Application Progamming
jerojasro@461: Interface}, Interfaz para Programación de Aplicaciones} para ganchos:
jerojasro@336: \begin{codesample2}
jerojasro@336:   def myhook(ui, repo, **kwargs):
jerojasro@336:       pass
jerojasro@336: \end{codesample2}
jerojasro@462: El primer argumento para un gancho Python siempre es un objeto
jerojasro@462: \pymodclass{mercurial.ui}{ui}.  El segundo es un objeto repositorio;
jerojasro@462: de momento, siempre es una instancia de 
jerojasro@462: \pymodclass{mercurial.localrepo}{localrepository}.  Después de estos
jerojasro@462: dos argumentos están los argumentos de palabra clave. Los argumentos
jerojasro@462: que se pasen dependerán del tipo de gancho que se esté llamando, pero
jerojasro@462: un gancho siempre puede ignorar los argumentos que no le interesen,
jerojasro@462: relegándolos a un diccionario de argumentos por palabras clave, como se
jerojasro@462: hizo arriba con \texttt{**kwargs}.
jerojasro@462: 
jerojasro@462: \section{Ejemplos de ganchos}
jerojasro@462: 
jerojasro@462: \subsection{Escribir mensajes de consignación significativos}
jerojasro@462: 
jerojasro@462: Es difícil de imaginar un mensaje de consignación útil y al mismo
jerojasro@462: tiempo muy corto. El simple gancho \hook{pretxncommit} de la
jerojasro@462: figura~\ref{ex:hook:msglen.go} evitará que usted consigne un conjunto
jerojasro@462: de cambios con un mensaje de menos de 10 bytes de longitud.
jerojasro@336: 
jerojasro@336: \begin{figure}[ht]
jerojasro@336:   \interaction{hook.msglen.go}
jerojasro@462:   \caption{Un gancho que prohíbe mensajes de consignación demasiado
jerojasro@462:   cortos}
jerojasro@336:   \label{ex:hook:msglen.go}
jerojasro@336: \end{figure}
jerojasro@336: 
jerojasro@462: \subsection{Comprobar espacios en blanco finales}
jerojasro@462: 
jerojasro@462: Un uso interesante para ganchos relacionados con consignaciones es
jerojasro@462: ayudarle a escribir código más limpio. Un ejemplo simple de
jerojasro@462: %TODO dictum => regla
jerojasro@462: ``código más limpio'' es la regla de que un cambio no debe añadir
jerojasro@462: líneas de texto que contengan ``espacios en blanco finales''. El
jerojasro@462: espacio en blanco final es una serie de caracteres de espacio y
jerojasro@462: tabulación que se encuentran al final de una línea de texto. En la
jerojasro@462: mayoría de los casos, el espacio en blanco final es innecesario, ruido
jerojasro@462: invisible, pero ocasionalmente es problemático, y la gente en general
jerojasro@462: prefiere deshacerse de él.
jerojasro@462: 
jerojasro@462: Usted puede usar cualquiera de los ganchos \hook{precommit} o
jerojasro@462: \hook{pretxncommit} para revisar si tiene el problema de los espacios
jerojasro@462: en blanco finales. Si usa el gancho \hook{precommit}, el gancho no
jerojasro@462: sabrá qué ficheros se están consignando, por lo que se tendrá que
jerojasro@462: revisar cada fichero modificado en el repositorio para ver si tiene
jerojasro@462: espacios en blanco finales. Si usted sólo quiere consignar un cambio
jerojasro@462: al fichero \filename{foo}, y el fichero \filename{bar} contiene
jerojasro@462: espacios en blanco finales, hacer la revisión en el gancho
jerojasro@462: \hook{precommit} evitará que usted haga la consignación de
jerojasro@462: \filename{foo} debido al problem en \filename{bar}.  Este no parece el
jerojasro@462: enfoque adeucado.
jerojasro@462: 
jerojasro@462: Si usted escogiera el gancho \hook{pretxncommit}, la revisión no
jerojasro@462: ocurriría sino hasta justo antes de que la transacción para la
jerojasro@462: consignación se complete. Esto le permitirá comprobar por posibles
jerojasro@462: problemas sólo en los ficheros que serán consignados. Sin embargo, si
jerojasro@462: usted ingresó el mensaje de consignación de manera interactiva y el
jerojasro@462: %TODO roll-back
jerojasro@462: gancho falla, la transacción será deshecha; usted tendrá que
jerojasro@462: reingresar el mensaje de consignación luego de que corrija el problema
jerojasro@462: con los espacios en blanco finales y ejecute \hgcmd{commit} de nuevo.
jerojasro@336: 
jerojasro@336: \begin{figure}[ht]
jerojasro@336:   \interaction{hook.ws.simple}
jerojasro@462:   \caption{Un gancho simple que revisa si hay espacios en blanco
jerojasro@462:   finales}
jerojasro@336:   \label{ex:hook:ws.simple}
jerojasro@336: \end{figure}
jerojasro@336: 
jerojasro@462: La figura~\ref{ex:hook:ws.simple} presenta un gancho
jerojasro@462: \hook{pretxncommit} simple que comprueba la existencia de espacios en
jerojasro@462: blanco finales. Este gancho es corto, pero no brinda mucha ayuda.
jerojasro@462: Termina con un código de salida de error si un cambio añade una línea
jerojasro@462: con espacio en blanco final a cualquier fichero, pero no muestra
jerojasro@462: ninguna información que pueda ser útil para identificar el fichero o
jerojasro@462: la línea de texto origen del problema. También tiene la agradable
jerojasro@462: propiedad de no prestar atención a las líneas que no sufrieron
jerojasro@462: modificaciones; sólo las líneas que introducen nuevos espacios en
jerojasro@462: blanco finales causan problemas.
jerojasro@336: 
jerojasro@336: \begin{figure}[ht]
jerojasro@336:   \interaction{hook.ws.better}
jerojasro@336:   \caption{A better trailing whitespace hook}
jerojasro@336:   \label{ex:hook:ws.better}
jerojasro@336: \end{figure}
jerojasro@336: 
jerojasro@462: El ejemplo de la figura~\ref{ex:hook:ws.better} es mucho más complejo,
jerojasro@462: pero también más útil. El gancho procesa un diff unificado para
jerojasro@462: revisar si alguna línea añade espacios en blanco finales, e imprime el
jerojasro@462: nombre del fichero y el número de línea de cada ocurrencia. Aún mejor,
jerojasro@462: si el cambio añade espacios en blanco finales, este gancho guarda el
jerojasro@462: mensaje de consignación e imprime el nombre del fichero en el que el
jerojasro@462: mensaje fue guardado, antes de terminar e indicarle a Mercurial que
jerojasro@462: deshaga la transacción, para que uste pueda usar
jerojasro@462: \hgcmdargs{commit}{\hgopt{commit}{-l}~\emph{nombre\_fichero}} para
jerojasro@462: reutilizar el mensaje de consignación guardado anteriormente, una vez
jerojasro@462: usted haya corregido el problema.
jerojasro@462: 
jerojasro@464: Como anotación final, note en la figura~\ref{ex:hook:ws.better} el
jerojasro@462: %TODO on-site => in-situ ?
jerojasro@462: uso de la característica de edición \emph{in-situ} de \command{perl}
jerojasro@462: para eliminar los espacios en blanco finales en un fichero. Esto es
jerojasro@462: lo suficientemente conciso y poderoso para que lo presente aquí.
jerojasro@463: % TODO corregí el backslash, y comprobé por mi cuenta un archivo
jerojasro@463: % aparte, y el comando hace lo que debe hacer. Favor copiar del pdf el
jerojasro@463: % comando perl y comprobar con un archivo con espacios en blanco
jerojasro@463: % finales, y si todo está bien (que debería), borrar esta nota
jerojasro@463: \begin{codesample2}
jerojasro@463:     perl -pi -e 's,\textbackslash{}s+\$,,' nombre\_fichero
jerojasro@336: \end{codesample2}
jerojasro@336: 
jerojasro@464: %TODO bundled
jerojasro@464: \section{Ganchos bundled}
jerojasro@464: 
jerojasro@464: Mercurial se instala con varios ganchos bundled. Usted puede
jerojasro@464: encontrarlos en el directorio \dirname{hgext} del árbol de ficheros
jerojasro@464: fuente de Mercurial. Si usted está usando un paquete binario de
jerojasro@464: Mercurial, los ganchos estarán ubicados en el directorio
jerojasro@464: \dirname{hgext} en donde su instalador de paquetes haya puesto a
jerojasro@336: Mercurial.
jerojasro@336: 
jerojasro@464: \subsection{\hgext{acl}---control de acceso a partes de un repositorio}
jerojasro@464: 
jerojasro@464: La extensión \hgext{acl} le permite controlar a qué usuarios remotos
jerojasro@464: les está permitido empujar conjuntos de cambios a un servidor en red.
jerojasro@464: Usted puede proteger cualquier porción de un repositorio (incluyendo
jerojasro@464: el repositorio completo), de tal manera que un usuario remoto
jerojasro@464: específico pueda empujar cambios que no afecten la porción protegida.
jerojasro@464: 
jerojasro@464: Esta extensión implementa control de acceso basado en la identidad del
jerojasro@464: usuario que empuja los conjuntos de cambios, \emph{no} en la identidad
jerojasro@464: de quien hizo la consignación de los mismos. Usar este gancho tiene
jerojasro@464: sentido sólo si se tiene un servidor adecuadamente asegurado que
jerojasro@464: autentique a los usuarios remotos, y si usted desea segurarse de que
jerojasro@464: sólo se le permita a ciertos usuarios empujar cambios a dicho
jerojasro@464: servidor.
jerojasro@464: 
jerojasro@474: \subsubsection{Configuración del gancho \hook{acl}}
jerojasro@464: 
jerojasro@464: Para administrar los conjuntos de cambios entrantes, se debe usar el
jerojasro@464: gancho \hgext{acl} como un gancho de tipo \hook{pretxnchangegroup}.
jerojasro@464: Esto le permite ver qué ficheros son modificados por cada conjunto de
jerojasro@464: %TODO rollback => "deshacer el efecto"
jerojasro@464: cambios entrante, y deshacer el efecto de un grupo de conjuntos de
jerojasro@464: cambios si alguno de ellos modifica algún fichero ``prohibido''.
jerojasro@464: Ejemplo:
jerojasro@336: \begin{codesample2}
jerojasro@336:   [hooks]
jerojasro@336:   pretxnchangegroup.acl = python:hgext.acl.hook
jerojasro@336: \end{codesample2}
jerojasro@336: 
jerojasro@464: La extensión \hgext{acl} es configurada mediante tres secciones.
jerojasro@464: 
jerojasro@464: La sección \rcsection{acl} sólo tiene una entrada,
jerojasro@464: \rcitem{acl}{sources}\footnote{Fuentes.}, que lista las fuentes de los
jerojasro@464: conjuntos de cambios entrantes a las que el gancho debe prestar
jerojasro@464: atención. Usualmente usted no necesita configurar esta sección.
jerojasro@464: \begin{itemize}
jerojasro@464:   \item[\rcitem{acl}{serve}] Controlar conjuntos de
jerojasro@464:     cambios entrantes que están llegando desde un repositorio a
jerojasro@464:     través de http o ssh. Este es el valor por defecto de
jerojasro@464:   \rcitem{acl}{sources}, y usualmente es el único valor de
jerojasro@464:   configuración que necesitará para este ítem.
jerojasro@464: \item[\rcitem{acl}{pull}] Controlar conjuntos de cambios entrantes que
jerojasro@464:   lleguen vía un pull (jalado) desde un repositorio local.
jerojasro@464: \item[\rcitem{acl}{push}] Controlar conjuntos de cambios entrantes que
jerojasro@464:   lleguen vía un push (empuje) desde un repositorio local.
jerojasro@464: \item[\rcitem{acl}{bundle}] Controlar conjuntos de cambios entrantes
jerojasro@464:     %TODO bundle
jerojasro@464:   que lleguen desde otro repositorio a través de un bundle.
jerojasro@464: \end{itemize}
jerojasro@464: 
jerojasro@464: La sección \rcsection{acl.allow} controla los usuarios a los que les
jerojasro@464: está permitido añadir conjuntos de cambios al repositorio. Si esta
jerojasro@464: sección no está presente, se le permite acceso a todos los usuarios
jerojasro@464: excepto  a los que se les haya negado explícitamente el acceso. Si
jerojasro@464: esta sección no está presente, se niega el acceso a todos los usuarios
jerojasro@464: excepto a todos a los que se les haya permitido de manera explícita
jerojasro@464: (así que una sección vacía implica que se niega el acceso a todos los
jerojasro@464: usuarios).
jerojasro@464: 
jerojasro@464: La sección \rcsection{acl.deny} determina a qué usuarios no se les
jerojasro@464: permite añadir conjuntos de cambios al repositorio. Si esta sección no
jerojasro@464: está presente o está vacía, no se niega el acceso a ningún usuario.
jerojasro@464: 
jerojasro@464: La sintaxis para los ficheros \rcsection{acl.allow} y
jerojasro@464: \rcsection{acl.deny} es idéntica. A la izquierda de cada entrada se
jerojasro@464: encuentra un patrón glob que asocia ficheros o directorios, respecto a
jerojasro@464: la raíz del repositorio; a la derecha, un nombre usuario.
jerojasro@464: 
jerojasro@464: En el siguiente ejemplo, el usuario \texttt{escritordoc} sólo puede
jerojasro@464: empujar cambios al directorio \dirname{docs} del repositorio, mientras
jerojasro@464: que \texttt{practicante} puede enviar cambios a cualquier fichero o
jerojasro@464: directorio excepto \dirname{fuentes/sensitivo}.
jerojasro@336: \begin{codesample2}
jerojasro@336:   [acl.allow]
jerojasro@464:   docs/** = escritordoc
jerojasro@336: 
jerojasro@336:   [acl.deny]
jerojasro@464:   fuentes/sensitivo/** = practicante
jerojasro@336: \end{codesample2}
jerojasro@336: 
jerojasro@465: \subsubsection{Pruebas y resolución de problemas}
jerojasro@465: 
jerojasro@465: Si usted desea probar el gancho \hgext{acl}, ejecútelo habilitando la
jerojasro@465: opción de salida de depuración habilitada. Ya que usted probablemente
jerojasro@465: lo estará ejecutando en un servidor donde no es conveniente (o incluso
jerojasro@465: posible) pasar la opción \hggopt{--debug}, no olvide que usted puede
jerojasro@465: habilitar la salida de depuración en su \hgrc:
jerojasro@336: \begin{codesample2}
jerojasro@336:   [ui]
jerojasro@336:   debug = true
jerojasro@336: \end{codesample2}
jerojasro@465: Con esto habilitado, el gancho \hgext{acl} imprimirá suficiente
jerojasro@465: información para permitirle saber porqué está permitiendo o denegando
jerojasro@465: la operación de empujar a usuarios específicos.
jerojasro@465: 
jerojasro@465: \subsection{\hgext{bugzilla}---integración con Bugzilla}
jerojasro@465: 
jerojasro@465: La extensión \hgext{bugzilla} añade un comentario a un fallo Bugzilla
jerojasro@465: siempre que encuentre una referencia al ID de dicho fallo en un
jerojasro@465: mensaje de consignación. Usted puede instalar este gancho en un
jerojasro@465: servidor compartido, para que cada vez que un usuario remoto empuje
jerojasro@465: cambios al servidor, el gancho sea ejecutado.
jerojasro@465: 
jerojasro@465: Se añade un comentario al fallo que se ve así (usted puede configurar
jerojasro@465: los contenidos del comentario---vea más abajo):
jerojasro@465: %TODO traducir?
jerojasro@336: \begin{codesample2}
jerojasro@336:   Changeset aad8b264143a, made by Joe User <joe.user@domain.com> in
jerojasro@336:   the frobnitz repository, refers to this bug.
jerojasro@336: 
jerojasro@336:   For complete details, see
jerojasro@336:   http://hg.domain.com/frobnitz?cmd=changeset;node=aad8b264143a
jerojasro@336: 
jerojasro@336:   Changeset description:
jerojasro@336:         Fix bug 10483 by guarding against some NULL pointers
jerojasro@336: \end{codesample2}
jerojasro@465: El valor de este gancho se encuentra en que automatiza el proceso de
jerojasro@465: actualizar un fallo cuando un conjunto de cambios se refiera a él. Si
jerojasro@465: usted configura este gancho adecuadamente, hará fácil para la gente
jerojasro@465: navegar directamente desde un fallo Bugzilla a un conjunto de cambios
jerojasro@465: que se refiere a ese fallo.
jerojasro@465: 
jerojasro@465: Usted puede usar el código de este gancho como un punto de partida
jerojasro@465: para otras recetas de integración con Bugzilla aún más exóticas. Acá
jerojasro@465: hay algunas posibilidades:
jerojasro@465: \begin{itemize}
jerojasro@465: \item Requerir que cada conjunto de cambios tenga un ID de fallo en su
jerojasro@465:   mensaje de consignación. En este caso, usted querrá configurar el
jerojasro@465:   gancho como uno de tipo \hook{pretxncommit}.  Esto le permitirá al
jerojasro@465:   gancho rechazar cambios que no contiene IDs de fallos.
jerojasro@465: \item Permitir a los conjuntos de cambios entrantes modificar
jerojasro@465:   automáticamente el \emph{estado} de un fallo, así como simplemente
jerojasro@465:   añadir un comentario. Por ejemplo, el gancho podría reconocer la
jerojasro@465:   cadena ``corregido fallo 31337'' como la señal de que debería
jerojasro@465:   actualizar el estado del fallo 31337 a ``requiere pruebas''.
jerojasro@336: \end{itemize}
jerojasro@336: 
jerojasro@466: \subsubsection{Configuración del gancho \hook{bugzilla}}
jerojasro@336: \label{sec:hook:bugzilla:config}
jerojasro@336: 
jerojasro@466: Usted debería configurar este gancho en el \hgrc\ de su servidor como
jerojasro@466: un gancho \hook{incoming}\footnote{Entrante.}, por ejemplo como sigue:
jerojasro@336: \begin{codesample2}
jerojasro@336:   [hooks]
jerojasro@336:   incoming.bugzilla = python:hgext.bugzilla.hook
jerojasro@336: \end{codesample2}
jerojasro@336: 
jerojasro@466: Debido a la naturaleza especializada de este gancho, y porque Bugzilla
jerojasro@466: no fue escrito con este tipo de integración en mente, configurar este
jerojasro@466: % TODO involved => complejo ? no intarwebs here :(
jerojasro@466: gancho es un proceso algo complejo.
jerojasro@466: 
jerojasro@466: Antes de empezar, usted debe instalar la interfaz de Python para MySQL
jerojasro@466: en los sistemas en los que se vaya a ejecutar el gancho. Si no está
jerojasro@466: disponible como paquete binario para su sistema, usted puede descargar
jerojasro@466: el paquete desde~\cite{web:mysql-python}.
jerojasro@466: 
jerojasro@466: La información para configurar este gancho se ubica en la sección 
jerojasro@466: \rcsection{bugzilla} de su \hgrc.
jerojasro@466: \begin{itemize}
jerojasro@466: \item[\rcitem{bugzilla}{version}] La versión de Bugzilla instalada en
jerojasro@466:   el servidor. El esquema de base de datos que Bugzilla usa cambia
jerojasro@466:   ocasionalmente, así que este gancho debe saber exactamente qué
jerojasro@466:   esquema usar. A la fecha, la única versión soportada es la
jerojasro@466:   \texttt{2.16}.
jerojasro@466: \item[\rcitem{bugzilla}{host}] El nombre de máquina (\emph{hostname})
jerojasro@466:   del servidor MySQL que almacena sus datos Bugzilla. La base de datos
jerojasro@466:   debe ser configurada para permitir conexiones desde las máquinas en
jerojasro@466:   las que usted ejecute el gancho \hook{bugzilla}.
jerojasro@466: \item[\rcitem{bugzilla}{user}] El nombre de usuario que se usará para
jerojasro@466:   conectarse al servidor MySQL. La base de datos debe ser configurada
jerojasro@466:   para permitir a dicho usuario conectarse desde cualquiera de las
jerojasro@466:   máquinas en las que se ejecute el gancho \hook{bugzilla}.  Este
jerojasro@466:   usuario debe tener acceso y poder modificar las tablas de Bugzilla.
jerojasro@466:   El valor por defecto para este ítem es \texttt{bugs}, que es el
jerojasro@466:   nombre estándar del usuario para Bugzilla en una base de datos
jerojasro@466:   MySQL.
jerojasro@466: \item[\rcitem{bugzilla}{password}] La contraseña MySQL para el usuario
jerojasro@466:   configurado anteriormente. Ésta es almacenada como texto plano, así
jerojasro@466:   que usted deberá asegurarse de que los usuarios no autorizados no
jerojasro@466:   puedan leer el fichero \hgrc\ en donde usted guarda esta
jerojasro@466:   información.
jerojasro@466: \item[\rcitem{bugzilla}{db}] El nombre de la base de datos Bugzilla en
jerojasro@466:   el servidor MySQL. El nombre por defecto para este ítem es
jerojasro@466:   \texttt{bugs}, que es el nombre estándar de la base de datos MySQL
jerojasro@466:   en donde Bugzilla almacena sus datos.
jerojasro@466: \item[\rcitem{bugzilla}{notify}] Si usted desea que Bugzilla envíe un
jerojasro@466:     %TODO suBscriptores?
jerojasro@466:   correo de notificación a los suscriptores después de que el gancho
jerojasro@466:   haya añadido un comentario a un fallo, necesitará que este gancho
jerojasro@466:   ejecute un comando siempre que actualice la base de datos. El
jerojasro@466:   comando que se ejecute depende de en dónde haya sido instalado
jerojasro@466:   Bugzilla, pero típicamente se verá así, si usted ha instalado
jerojasro@466:   Bugzilla en \dirname{/var/www/html/bugzilla}:
jerojasro@336:   \begin{codesample4}
jerojasro@336:     cd /var/www/html/bugzilla && ./processmail %s nobody@nowhere.com
jerojasro@336:   \end{codesample4}
jerojasro@466:   El programa \texttt{processmail} de Bugzilla espera recibir un ID de
jerojasro@466:   fallo (el gancho reemplaza ``\texttt{\%s}'' por el ID del fallo) y
jerojasro@466:   una dirección de correo. También espera poder escribir a ciertos
jerojasro@466:   ficheros en el directorio en que se ejecuta. Si Bugzilla y éste
jerojasro@466:   gancho no están instalados en la misma máquina, usted deberá
jerojasro@466:   encontrar una manera de ejecutar \texttt{processmail} en el servidor
jerojasro@466:   donde está instalado Bugzilla.
jerojasro@336: \end{itemize}
jerojasro@336: 
jerojasro@467: \subsubsection{Asociar nombres de consignadores a nombres de usuario
jerojasro@467: Bugzilla}
jerojasro@336: 
jerojasro@468: Por defecto, el gancho \hgext{bugzilla} trata de usar la dirección de
jerojasro@468: correo electrónico de la persona que hizo la consignación del conjunto
jerojasro@468: de cambios como el nombre de usuario Bugzilla con el cual debe
jerojasro@468: actualizar el fallo. Si esto no se ajusta a sus necesidades, es
jerojasro@468: posible asociar direcciones de correo a nombres de usuario Bugzilla
jerojasro@468: usando una sección \rcsection{usermap}.
jerojasro@468: 
jerojasro@468: Cada ítem en la sección \rcsection{usermap} contiene una dirección de
jerojasro@468: correo electrónico a la izquierda, y un nombre de usuario Bugzilla a
jerojasro@468: la derecha.
jerojasro@336: \begin{codesample2}
jerojasro@336:   [usermap]
jerojasro@336:   jane.user@example.com = jane
jerojasro@336: \end{codesample2}
jerojasro@468: Usted puede mantener los datos de \rcsection{usermap} en un fichero
jerojasro@468: \hgrc, o decirle al gancho \hgext{bugzilla} que lea la información
jerojasro@468: desde un fichero \filename{usermap} externo.  En este caso, usted
jerojasro@468: puede almacenar los datos de \filename{usermap} en (por ejemplo) un
jerojasro@468: repositorio modificable por los usuarios. Esto hace posible para sus
jerojasro@468: usuarios mantener sus propias entradas \rcitem{bugzilla}{usermap}.  El
jerojasro@468: fichero \hgrc\ principal se vería así:
jerojasro@468: \begin{codesample2}
jerojasro@468:   # fichero hgrc normal se refiere a un fichero usermap externo
jerojasro@336:   [bugzilla]
jerojasro@336:   usermap = /home/hg/repos/userdata/bugzilla-usermap.conf
jerojasro@336: \end{codesample2}
jerojasro@468: Mientras que el fichero \filename{usermap} al que se hace referencia
jerojasro@468: se vería así:
jerojasro@468: \begin{codesample2}
jerojasro@468:   # bugzilla-usermap.conf - dentro de un repositorio hg
jerojasro@336:   [usermap]
jerojasro@336:   stephanie@example.com = steph
jerojasro@336: \end{codesample2}
jerojasro@336: 
jerojasro@468: \subsubsection{Configurar el texto que se añade a un fallo}
jerojasro@468: 
jerojasro@468: Usted puede configurar el texto que este gancho añade como comentario;
jerojasro@468: usted los especifica como una plantilla Mercurial. Varias entradas
jerojasro@468: \hgrc\ (aún en la sección \rcsection{bugzilla}) controlan este
jerojasro@468: comportamiento.
jerojasro@468: \begin{itemize}
jerojasro@468: \item[\texttt{strip}] La cantidad de elementos iniciales de ruta a
jerojasro@468:   remover de un nombre de ruta del repositorio para construir una ruta
jerojasro@468:   parcial para una URL. Por ejemplo, si los repositorios en su
jerojasro@468:   servidor se ubican en \dirname{/home/hg/repos}, y usted tiene un
jerojasro@468:   repositorio cuya ruta es \dirname{/home/hg/repos/app/tests},
jerojasro@468:   entonces fijar \texttt{strip} a \texttt{4} resultará en una ruta
jerojasro@468:   parcial de \dirname{app/tests}.  El gancho hará disponible esta ruta
jerojasro@468:   parcial cuando expanda una plantilla, como \texttt{webroot}.
jerojasro@468: \item[\texttt{template}] El texto de la plantilla a usar. En adición a
jerojasro@468:   las variables usuales relacionadas con conjuntos de cambios, esta
jerojasro@468:   plantilla puede usar \texttt{hgweb} (el valor del ítem de
jerojasro@468:   configuración \texttt{hgweb} de arriba) y \texttt{webroot} (la ruta
jerojasro@468:   construida usando \texttt{strip} arriba).
jerojasro@468: \end{itemize}
jerojasro@468: 
jerojasro@468: Adicionalmente, usted puede añadir un ítem \rcitem{web}{baseurl} a la
jerojasro@468: sección \rcsection{web} de su \hgrc.  El gancho \hgext{bugzilla}
jerojasro@468: publicará esto cuando expanda una plantilla, como la cadena base a
jerojasro@468: usar cuando se construya una URL que le permita a los usuarios navegar
jerojasro@468: desde un comentario de Bugzilla a la vista de un conjunto de cambios.
jerojasro@468: Ejemplo:
jerojasro@336: \begin{codesample2}
jerojasro@336:   [web]
jerojasro@336:   baseurl = http://hg.domain.com/
jerojasro@336: \end{codesample2}
jerojasro@336: 
jerojasro@468: A continuación se presenta un ejemplo completo de configuración para
jerojasro@468: el gancho \hgext{bugzilla}.
jerojasro@468: %TODO traducir?
jerojasro@336: \begin{codesample2}
jerojasro@336:   [bugzilla]
jerojasro@336:   host = bugzilla.example.com
jerojasro@336:   password = mypassword
jerojasro@336:   version = 2.16
jerojasro@336:   # server-side repos live in /home/hg/repos, so strip 4 leading
jerojasro@336:   # separators
jerojasro@336:   strip = 4
jerojasro@336:   hgweb = http://hg.example.com/
jerojasro@336:   usermap = /home/hg/repos/notify/bugzilla.conf
jerojasro@336:   template = Changeset \{node|short\}, made by \{author\} in the \{webroot\}
jerojasro@336:     repo, refers to this bug.\\nFor complete details, see 
jerojasro@336:     \{hgweb\}\{webroot\}?cmd=changeset;node=\{node|short\}\\nChangeset
jerojasro@336:     description:\\n\\t\{desc|tabindent\}
jerojasro@336: \end{codesample2}
jerojasro@336: 
jerojasro@468: \subsubsection{Pruebas y resolución de problemas}
jerojasro@468: 
jerojasro@468: Los problemas más comunes que aparecen en la configuración del gancho
jerojasro@468: \hgext{bugzilla} suelen estar relacionados con la ejecución del guión
jerojasro@468: de Bugzilla \filename{processmail} y la asociación de nombres de
jerojasro@468: consignadores a nombres de usuario.
jerojasro@468: 
jerojasro@474: Recuerde que en la sección~\ref{sec:hook:bugzilla:config} arriba el
jerojasro@474: usuario que ejecuta el proceso Mercurial en el servidor es también 
jerojasro@474: el usuario que ejecutará el guión \filename{processmail}. El guión
jerojasro@474: \filename{processmail} algunas veces hace que Bugzilla escriba en
jerojasro@474: ficheros en su directorio de configuración, y los ficheros de
jerojasro@474: configuración de Bugzilla usualmente son propiedad del usuario bajo el
jerojasro@474: cual se ejecuta el servidor web.
jerojasro@474: 
jerojasro@474: Usted puede hacer que \filename{processmail} sea ejecutado con la
jerojasro@474: identidad del usuario adecuado usando el comando \command{sudo}. A
jerojasro@474: continuación se presenta una entrada de ejemplo para un fichero
jerojasro@474: \filename{sudoers}.
jerojasro@336: \begin{codesample2}
jerojasro@336:   hg_user = (httpd_user) NOPASSWD: /var/www/html/bugzilla/processmail-wrapper %s
jerojasro@336: \end{codesample2}
jerojasro@474: Esto permite que el usuario \texttt{hg\_user} ejecute el programa
jerojasro@474: \filename{processmail-wrapper} con la identidad del usuario
jerojasro@336: \texttt{httpd\_user}.
jerojasro@336: 
jerojasro@474: Esta indirección a través de un guión envoltorio es necesaria, porque
jerojasro@474: \filename{processmail} espera que al ser ejecutado su directorio
jerojasro@474: actual sea aquel en el cual se instaló Bugzilla; usted no puede
jerojasro@474: especificar ese tipo de condición en un fichero \filename{sudoers}.
jerojasro@474: Los contenidos del giuón envoltorio son simples:
jerojasro@336: \begin{codesample2}
jerojasro@336:   #!/bin/sh
jerojasro@336:   cd `dirname $0` && ./processmail "$1" nobody@example.com
jerojasro@336: \end{codesample2}
jerojasro@474: No parece importar qué dirección de correo se le pase a
jerojasro@336: \filename{processmail}.
jerojasro@336: 
jerojasro@474: Si su \rcsection{usermap} no es configurada correctamente, los
jerojasro@474: usuarios verán un mensaje de error del gancho \hgext{bugzilla} cuando
jerojasro@474: empujen cambios al servidor. El mensaje de error se verá así:
jerojasro@336: \begin{codesample2}
jerojasro@336:   cannot find bugzilla user id for john.q.public@example.com
jerojasro@336: \end{codesample2}
jerojasro@474: Lo que esto quiere decir es que la dirección del consignador,
jerojasro@474: \texttt{john.q.public@example.com}, no es un nombre de usuario
jerojasro@474: Bugzilla válido, ni tiene una entrada en su \rcsection{usermap} que lo
jerojasro@474: asocie con un nombre de usuario válido Bugzilla.
jerojasro@474: 
jerojasro@474: \subsection{\hgext{notify}---enviar notificaciones de correo
jerojasro@474: electrónico}
jerojasro@474: 
jerojasro@474: %TODO feeds => notificaciones: lo más fácil es mirar en wikipedia
jerojasro@474: Aunque el servidor web embebido de Mercurial provee notificaciones de
jerojasro@474: cambios en cada repositorio, muchas personas prefieren recibir las
jerojasro@474: notificaciones de cambios vía correo electrónico. El gancho
jerojasro@474: \hgext{notify}\footnote{Notificación.} le permite a usted enviar
jerojasro@474: notificaciones a un conjunto de direcciones de correo cuando lleguen
jerojasro@474: conjuntos de cambios en los que los subscriptores estén interesados.
jerojasro@474: 
jerojasro@474: De la misma forma que con el gancho \hgext{bugzilla}, el gancho
jerojasro@474: \hgext{notify} está orientado a plantillas, así que usted puede
jerojasro@474: personalizar los contenidos del mensaje de notificación que se envía.
jerojasro@474: 
jerojasro@474: Por defecto, el gancho \hgext{notify} incluye un diff de cada conjunto
jerojasro@474: %TODO que se envía? revisar, pienso que es ``que se recibe''
jerojasro@474: de cambios que se envía; usted puede limitar el tamaño del diff, o
jerojasro@474: desactivar completamente esta característica. Es útil para permitir a
jerojasro@474: los subscriptores revisar los cambios inmediatamente, en vez de tener
jerojasro@474: que hacer clic para visitar una URL.
jerojasro@474: 
jerojasro@474: \subsubsection{Configuración del gancho \hgext{notify}}
jerojasro@474: 
jerojasro@474: Usted puede configurar el gancho \hgext{notify} para enviar un mensaje
jerojasro@474: de correo por conjunto de cambios entrante, o uno por grupo entrante
jerojasro@474: de conjuntos de cambios (todos los que llegaron en un único empuje o
jerojasro@474: jalado).
jerojasro@336: \begin{codesample2}
jerojasro@336:   [hooks]
jerojasro@474:   # enviar un correo por grupo de cambios
jerojasro@336:   changegroup.notify = python:hgext.notify.hook
jerojasro@474:   # enviar un correo por cambio
jerojasro@336:   incoming.notify = python:hgext.notify.hook
jerojasro@336: \end{codesample2}
jerojasro@336: 
jerojasro@474: La información para configurar este gancho se ubica en la sección
jerojasro@474: \rcsection{notify} de un fichero \hgrc.
jerojasro@474: \begin{itemize}
jerojasro@474: \item[\rcitem{notify}{test}] Por defecto, este gancho no envía correos
jerojasro@474:   en absoluto; en vez de eso, imprime el mensaje que se
jerojasro@474:   \emph{enviaría}. Fije este ítem en \texttt{false} para permitir el
jerojasro@474:   envío de correos. El motivo por el que el envío de correos está
jerojasro@474:   desactivado es que hacen falta varios intentos para configurar esta
jerojasro@474:   extensión exactamente como usted desea, y sería maleducado enviar a
jerojasro@474:   los subscriptores una cantidad de notificaciones ``rotas'' mientras
jerojasro@474:   usted depura su configuración.
jerojasro@474: \item[\rcitem{notify}{config}] La ruta a un fichero de configuración
jerojasro@474:   que contiene información de subscripción. Esto se mantiene separado
jerojasro@474:   del \hgrc\ principal para que usted pueda mantenerlo en un
jerojasro@474:   repositorio. La gente puede clonar ese repositorio, actualizar sus
jerojasro@474:   subscripciones, y empujar los cambios de vuelta a su servidor.
jerojasro@474: \item[\rcitem{notify}{strip}] La cantidad de caracteres iniciales de
jerojasro@474:   separación de ruta a remover de la ruta del repositorio, al decidir
jerojasro@474:   si un repositorio tiene subscriptores. Por ejemplo, si los
jerojasro@474:   repositorios en su servidor están en \dirname{/home/hg/repos}, y
jerojasro@474:   \hgext{notify} está trabajando con un repositorio llamado
jerojasro@474:   \dirname{/home/hg/repos/shared/test}, fijar \rcitem{notify}{strip} a
jerojasro@474:   \texttt{4} hará que \hgext{notify} elimine las partes iniciales de
jerojasro@474:   la ruta hasta \dirname{shared/test}, y asociará los subscriptores
jerojasro@474:   frente a dicha ruta.
jerojasro@474: \item[\rcitem{notify}{template}] El texto de plantilla a usar cuando
jerojasro@474:   se envíen mensajes. Especifica los contenidos de la cabecera del
jerojasro@474:   mensaje y el cuerpo del mismo.
jerojasro@474: \item[\rcitem{notify}{maxdiff}] El número máximo de líneas de datos de
jerojasro@474:   diff a añadir al final de un mensaje. Si la longitud de un diff es
jerojasro@474:   mayor a eso, se trunca. Por defecto, está fijado en 300. Fije esto a 
jerojasro@474:   \texttt{0} para omitir los diffs en los correos de notificación.
jerojasro@474: \item[\rcitem{notify}{sources}] Una lista de fuentes de conjuntos de
jerojasro@474:   cambios a considerar. Esto le permite a usted indicar a
jerojasro@474:   \hgext{notify} para que sólo envíe correos acerca de cambios que
jerojasro@474:   usuarios remotos hayan empujado al repositorio vía un servidor, por
jerojasro@474:   ejemplo.  Vea la sección~\ref{sec:hook:sources} para las fuentes que
jerojasro@474:   usted puede especificar aquí.
jerojasro@474: \end{itemize}
jerojasro@474: 
jerojasro@474: Si usted fija el ítem \rcitem{web}{baseurl} en la sección
jerojasro@474: \rcsection{web}, usted lo puede usar en una plantilla; estará
jerojasro@474: disponible como \texttt{webroot}.
jerojasro@474: 
jerojasro@474: A continuación se presenta un ejemplo completo de configuración para
jerojasro@474: el gancho \hgext{notify}.
jerojasro@336: \begin{codesample2}
jerojasro@336:   [notify]
jerojasro@474:   # enviar correo
jerojasro@336:   test = false
jerojasro@474:   # datos de subscriptores están en el repositorio notify
jerojasro@336:   config = /home/hg/repos/notify/notify.conf
jerojasro@474:   # repos están en /home/hg/repos on server, así que elimine 4
jerojasro@474:   # caracteres"/"
jerojasro@336:   strip = 4
jerojasro@336:   template = X-Hg-Repo: \{webroot\}
jerojasro@336:     Subject: \{webroot\}: \{desc|firstline|strip\}
jerojasro@336:     From: \{author\}
jerojasro@336: 
jerojasro@336:     changeset \{node|short\} in \{root\}
jerojasro@336:     details: \{baseurl\}\{webroot\}?cmd=changeset;node=\{node|short\}
jerojasro@336:     description:
jerojasro@336:       \{desc|tabindent|strip\}
jerojasro@336: 
jerojasro@336:   [web]
jerojasro@336:   baseurl = http://hg.example.com/
jerojasro@336: \end{codesample2}
jerojasro@336: 
jerojasro@474: Esto producirá un mensaje que se verá como el siguiente:
jerojasro@336: \begin{codesample2}
jerojasro@336:   X-Hg-Repo: tests/slave
jerojasro@336:   Subject: tests/slave: Handle error case when slave has no buffers
jerojasro@336:   Date: Wed,  2 Aug 2006 15:25:46 -0700 (PDT)
jerojasro@336: 
jerojasro@336:   changeset 3cba9bfe74b5 in /home/hg/repos/tests/slave
jerojasro@336:   details: http://hg.example.com/tests/slave?cmd=changeset;node=3cba9bfe74b5
jerojasro@336:   description:
jerojasro@336:           Handle error case when slave has no buffers
jerojasro@336:   diffs (54 lines):
jerojasro@336: 
jerojasro@336:   diff -r 9d95df7cf2ad -r 3cba9bfe74b5 include/tests.h
jerojasro@336:   --- a/include/tests.h      Wed Aug 02 15:19:52 2006 -0700
jerojasro@336:   +++ b/include/tests.h      Wed Aug 02 15:25:26 2006 -0700
jerojasro@336:   @@ -212,6 +212,15 @@ static __inline__ void test_headers(void *h)
jerojasro@336:   [...snip...]
jerojasro@336: \end{codesample2}
jerojasro@336: 
jerojasro@468: \subsubsection{Pruebas y resolución de problemas}
jerojasro@468: 
jerojasro@468: No olvide que por defecto, la extensión \hgext{notify} \emph{no
jerojasro@468: enviará ningún correo electrónico} hasta que usted la configure
jerojasro@468: explícitamente para hacerlo, fijando el valor de \rcitem{notify}{test}
jerojasro@468: a \texttt{false}.  Hasta que usted haga eso, simplemente se imprimirá
jerojasro@468: el mensaje que se \emph{enviaría}.
jerojasro@336: 
jerojasro@475: \section{Información para escritores de ganchos}
jerojasro@336: \label{sec:hook:ref}
jerojasro@336: 
jerojasro@475: \subsection{Ejecución de ganchos internos}
jerojasro@475: 
jerojasro@475: Un gancho interno es llamado con argumentos de la siguiente forma:
jerojasro@336: \begin{codesample2}
jerojasro@336:   def myhook(ui, repo, **kwargs):
jerojasro@336:       pass
jerojasro@336: \end{codesample2}
jerojasro@475: El parámetro \texttt{ui} es un objeto \pymodclass{mercurial.ui}{ui}.
jerojasro@475: El parámetro \texttt{repo} es un objeto
jerojasro@475: \pymodclass{mercurial.localrepo}{localrepository}. Los nombres y
jerojasro@475: valores de los parámetros en \texttt{**kwargs} dependen del gancho que
jerojasro@475: se invoque, con las siguientes características en común:
jerojasro@475: \begin{itemize}
jerojasro@475: \item Si hay un parámetro llamado \texttt{node} o
jerojasro@475:   \texttt{parent\emph{N}}, contendrá un ID hexadecimal de un conjunto
jerojasro@475:   de cambios. La cadena vacía es usada para representar un
jerojasro@475:   ``ID de conjunto de cambios nulo'' en vez de una cadena de ceros.
jerojasro@475: \item Si hay un parámetro llamado \texttt{url}, contendrá la URL de un
jerojasro@475:   repositorio remoto, si puede ser determinada.
jerojasro@475: \item Los parámetros booleanos son representados como objetos
jerojasro@475:     \texttt{bool} de Python.
jerojasro@475: \end{itemize}
jerojasro@475: 
jerojasro@475: Un gancho interno es ejecutado sin cambiar el directorio de trabajo
jerojasro@475: del proceso (a diferencia de los ganchos externos, que son ejecutados
jerojasro@475: desde la raíz del repositorio). El gancho no debe cambiar el
jerojasro@475: directorio de trabajo del proceso, porque esto haría que falle
jerojasro@475: cualquier llamada que se haga a la API de Mercurial.
jerojasro@475: 
jerojasro@475: Si un gancho retorna el valor booleano ``false''\footnote{Falso.}, se
jerojasro@475: considera que éste tuvo éxito. Si retorna
jerojasro@475: ``true''\footnote{Verdadero.} o genera una excepción, se considera que
jerojasro@475: ha fallado. Una manera útil de pensar en esta convención de llamado es
jerojasro@475: ``dígame si usted falló''.
jerojasro@475: 
jerojasro@475: Note que los IDs de conjuntos de cambios son pasados a los ganchos de
jerojasro@475: Python como cadenas hexadecimales, no como los hashes binarios que la
jerojasro@475: API de Mercurial usa normalmente. Para convertir un hash de
jerojasro@475: hexadecimal a binario, use la función \pymodfunc{mercurial.node}{bin}.
jerojasro@475: 
jerojasro@475: \subsection{Ejecución de ganchos externos}
jerojasro@475: 
jerojasro@475: Un gancho externo es pasado al intérprete de comandos del usuario bajo
jerojasro@475: el cual se ejecuta Mercurial. Las características del intérprete, como
jerojasro@475: sustitución de variables y redirección de comandos, están disponibles.
jerojasro@475: El gancho es ejecutado desde el directorio raíz del repositorio
jerojasro@475: (a diferencia de los ganchos internos, que se ejecutan desde el mismo
jerojasro@475: directorio en que Mercurial fue ejecutado).
jerojasro@475: 
jerojasro@475: Los parámetros para el gancho se pasan como variables de entorno. El
jerojasro@475: nombre de cada variable de entorno se pasa a mayúsculas y se le añade
jerojasro@475: el prefijo ``\texttt{HG\_}''.  Por ejemplo, si el nombre de un
jerojasro@475: parámetro es ``\texttt{node}'', el nombre de la variable de entorno
jerojasro@475: que almacena el parámetro se llamará ``\texttt{HG\_NODE}''.
jerojasro@475: 
jerojasro@475: Un parámetro booleano se representa con la cadena ``\texttt{1}'' para
jerojasro@475: ``true'', ``\texttt{0}'' para ``false''.  Si una variable se llama
jerojasro@475: \envar{HG\_NODE}, \envar{HG\_PARENT1} o \envar{HG\_PARENT2},  
jerojasro@475: contendrá un ID de conjunto de cambios representado como una cadena
jerojasro@475: hexadecimal. La cadena vacía es usada para representar un ``ID de
jerojasro@475: conjunto de cambios nulo'' en vez de una cadena de ceros. Si una
jerojasro@475: variable de entorno se llama \envar{HG\_URL}, contendrá la URL de un
jerojasro@475: repositorio remoto, si puede ser determinada.
jerojasro@475: 
jerojasro@475: Si un gancho termina con un código de salida de cero, se considera que
jerojasro@475: tuvo éxito. Si termina con un código de salida diferente de cero, se
jerojasro@475: considera que falló.
jerojasro@475: 
jerojasro@475: \subsection{Averiguar de dónde vienen los conjuntos de cambios}
jerojasro@475: %TODO los trae la cigüeña. De París. Y quedan debajo de una col.
jerojasro@475: 
jerojasro@475: Un gancho que involucra la transferencia de conjuntos de cambios entre
jerojasro@475: un repositorio local y otro puede ser capaz de averiguar información
jerojasro@475: acerca de ``el otro lado''. Mercurial sabe \emph{cómo} son
jerojasro@475: transferidos los conjuntos de cambios, y en muchos casos también desde
jerojasro@475: o hacia donde están siendo transferidos.
jerojasro@475: 
jerojasro@475: \subsubsection{Fuentes de conjuntos de cambios}
jerojasro@336: \label{sec:hook:sources}
jerojasro@336: 
jerojasro@475: Mercurial le indicará a un gancho cuáles son, o fueron, los medios
jerojasro@475: usados para transferir los conjuntos de cambios entre repositorios.
jerojasro@475: Esta información es provista por Mercurial en un parámetro Python
jerojasro@475: llamado \texttt{source}\footnote{Fuente.}, o una variable de entorno
jerojasro@475: llamada \envar{HG\_SOURCE}.
jerojasro@475: 
jerojasro@475: \begin{itemize}
jerojasro@475: \item[\texttt{serve}] Los conjuntos de cambios son transferidos desde
jerojasro@475:   o hacia un repositorio remoto a través de http o ssh.
jerojasro@475: \item[\texttt{pull}] Los conjuntos de cambios son transferidos vía una
jerojasro@475:   operación de jalado de un repositorio a otro.
jerojasro@475: \item[\texttt{push}] Los conjuntos de cambios son transferidos vía un
jerojasro@475:   empuje de un repositorio a otro.
jerojasro@475: \item[\texttt{bundle}] Los conjuntos de cambios son transferidos desde
jerojasro@475:     %TODO bundle
jerojasro@475:   o hacia un bundle.
jerojasro@475: \end{itemize}
jerojasro@475: 
jerojasro@475: \subsubsection{A dónde van los cambios---URLs de repositorios remotos}
jerojasro@336: \label{sec:hook:url}
jerojasro@475: %TODO al cielo? no, ésos son los perros
jerojasro@475: 
jerojasro@475: Cuando es posible, Mercurial le indicará a los ganchos la ubicación de
jerojasro@475: ``el otro lado'' de una actividad que transfiera datos de conjuntos de
jerojasro@475: cambios entre repositorios. Esto es provisto por Mercurial en un
jerojasro@475: parámetro Python llamado \texttt{url}, o en una variable de entorno
jerojasro@475: llamada \envar{HG\_URL}.
jerojasro@475: 
jerojasro@475: No siempre esta información está disponible. Si un gancho es invocado
jerojasro@475: un repositorio que es servido a través de http o ssh, Mercurial no
jerojasro@475: puede averiguar dónde está el repositorio remoto, pero puede saber
jerojasro@475: desde dónde se conecta el cliente. En esos casos, la URL tendrá una de
jerojasro@475: las siguientes formas:
jerojasro@475: \begin{itemize}
jerojasro@475: \item \texttt{remote:ssh:\emph{ip-address}}---cliente ssh remoto, en
jerojasro@475:   la dirección IP dada.
jerojasro@475: \item \texttt{remote:http:\emph{ip-address}}---cliente remoto http, en
jerojasro@475:   la dirección IP dada. Si el cliente está usando SSL, tendrá la forma
jerojasro@475:   \texttt{remote:https:\emph{ip-address}}.
jerojasro@475: \item Vacío---no se pudo descubrir información acerca del cliente
jerojasro@475:   remoto.
jerojasro@336: \end{itemize}
jerojasro@336: 
jerojasro@336: \section{Hook reference}
jerojasro@336: 
jerojasro@336: \subsection{\hook{changegroup}---after remote changesets added}
jerojasro@336: \label{sec:hook:changegroup}
jerojasro@336: 
jerojasro@336: This hook is run after a group of pre-existing changesets has been
jerojasro@336: added to the repository, for example via a \hgcmd{pull} or
jerojasro@336: \hgcmd{unbundle}.  This hook is run once per operation that added one
jerojasro@336: or more changesets.  This is in contrast to the \hook{incoming} hook,
jerojasro@336: which is run once per changeset, regardless of whether the changesets
jerojasro@336: arrive in a group.
jerojasro@336: 
jerojasro@336: Some possible uses for this hook include kicking off an automated
jerojasro@336: build or test of the added changesets, updating a bug database, or
jerojasro@336: notifying subscribers that a repository contains new changes.
jerojasro@336: 
jerojasro@336: Parameters to this hook:
jerojasro@336: \begin{itemize}
jerojasro@336: \item[\texttt{node}] A changeset ID.  The changeset ID of the first
jerojasro@336:   changeset in the group that was added.  All changesets between this
jerojasro@336:   and \index{tags!\texttt{tip}}\texttt{tip}, inclusive, were added by
jerojasro@336:   a single \hgcmd{pull}, \hgcmd{push} or \hgcmd{unbundle}.
jerojasro@336: \item[\texttt{source}] A string.  The source of these changes.  See
jerojasro@336:   section~\ref{sec:hook:sources} for details.
jerojasro@336: \item[\texttt{url}] A URL.  The location of the remote repository, if
jerojasro@336:   known.  See section~\ref{sec:hook:url} for more information.
jerojasro@336: \end{itemize}
jerojasro@336: 
jerojasro@336: See also: \hook{incoming} (section~\ref{sec:hook:incoming}),
jerojasro@336: \hook{prechangegroup} (section~\ref{sec:hook:prechangegroup}),
jerojasro@336: \hook{pretxnchangegroup} (section~\ref{sec:hook:pretxnchangegroup})
jerojasro@336: 
jerojasro@336: \subsection{\hook{commit}---after a new changeset is created}
jerojasro@336: \label{sec:hook:commit}
jerojasro@336: 
jerojasro@336: This hook is run after a new changeset has been created.
jerojasro@336: 
jerojasro@336: Parameters to this hook:
jerojasro@336: \begin{itemize}
jerojasro@336: \item[\texttt{node}] A changeset ID.  The changeset ID of the newly
jerojasro@336:   committed changeset.
jerojasro@336: \item[\texttt{parent1}] A changeset ID.  The changeset ID of the first
jerojasro@336:   parent of the newly committed changeset.
jerojasro@336: \item[\texttt{parent2}] A changeset ID.  The changeset ID of the second
jerojasro@336:   parent of the newly committed changeset.
jerojasro@336: \end{itemize}
jerojasro@336: 
jerojasro@336: See also: \hook{precommit} (section~\ref{sec:hook:precommit}),
jerojasro@336: \hook{pretxncommit} (section~\ref{sec:hook:pretxncommit})
jerojasro@336: 
jerojasro@336: \subsection{\hook{incoming}---after one remote changeset is added}
jerojasro@336: \label{sec:hook:incoming}
jerojasro@336: 
jerojasro@336: This hook is run after a pre-existing changeset has been added to the
jerojasro@336: repository, for example via a \hgcmd{push}.  If a group of changesets
jerojasro@336: was added in a single operation, this hook is called once for each
jerojasro@336: added changeset.
jerojasro@336: 
jerojasro@336: You can use this hook for the same purposes as the \hook{changegroup}
jerojasro@336: hook (section~\ref{sec:hook:changegroup}); it's simply more convenient
jerojasro@336: sometimes to run a hook once per group of changesets, while other
jerojasro@336: times it's handier once per changeset.
jerojasro@336: 
jerojasro@336: Parameters to this hook:
jerojasro@336: \begin{itemize}
jerojasro@336: \item[\texttt{node}] A changeset ID.  The ID of the newly added
jerojasro@336:   changeset.
jerojasro@336: \item[\texttt{source}] A string.  The source of these changes.  See
jerojasro@336:   section~\ref{sec:hook:sources} for details.
jerojasro@336: \item[\texttt{url}] A URL.  The location of the remote repository, if
jerojasro@336:   known.  See section~\ref{sec:hook:url} for more information.
jerojasro@336: \end{itemize}
jerojasro@336: 
jerojasro@336: See also: \hook{changegroup} (section~\ref{sec:hook:changegroup}) \hook{prechangegroup} (section~\ref{sec:hook:prechangegroup}), \hook{pretxnchangegroup} (section~\ref{sec:hook:pretxnchangegroup})
jerojasro@336: 
jerojasro@336: \subsection{\hook{outgoing}---after changesets are propagated}
jerojasro@336: \label{sec:hook:outgoing}
jerojasro@336: 
jerojasro@336: This hook is run after a group of changesets has been propagated out
jerojasro@336: of this repository, for example by a \hgcmd{push} or \hgcmd{bundle}
jerojasro@336: command.
jerojasro@336: 
jerojasro@336: One possible use for this hook is to notify administrators that
jerojasro@336: changes have been pulled.
jerojasro@336: 
jerojasro@336: Parameters to this hook:
jerojasro@336: \begin{itemize}
jerojasro@336: \item[\texttt{node}] A changeset ID.  The changeset ID of the first
jerojasro@336:   changeset of the group that was sent.
jerojasro@336: \item[\texttt{source}] A string.  The source of the of the operation
jerojasro@336:   (see section~\ref{sec:hook:sources}).  If a remote client pulled
jerojasro@336:   changes from this repository, \texttt{source} will be
jerojasro@336:   \texttt{serve}.  If the client that obtained changes from this
jerojasro@336:   repository was local, \texttt{source} will be \texttt{bundle},
jerojasro@336:   \texttt{pull}, or \texttt{push}, depending on the operation the
jerojasro@336:   client performed.
jerojasro@336: \item[\texttt{url}] A URL.  The location of the remote repository, if
jerojasro@336:   known.  See section~\ref{sec:hook:url} for more information.
jerojasro@336: \end{itemize}
jerojasro@336: 
jerojasro@336: See also: \hook{preoutgoing} (section~\ref{sec:hook:preoutgoing})
jerojasro@336: 
jerojasro@336: \subsection{\hook{prechangegroup}---before starting to add remote changesets}
jerojasro@336: \label{sec:hook:prechangegroup}
jerojasro@336: 
jerojasro@336: This controlling hook is run before Mercurial begins to add a group of
jerojasro@336: changesets from another repository.
jerojasro@336: 
jerojasro@336: This hook does not have any information about the changesets to be
jerojasro@336: added, because it is run before transmission of those changesets is
jerojasro@336: allowed to begin.  If this hook fails, the changesets will not be
jerojasro@336: transmitted.
jerojasro@336: 
jerojasro@336: One use for this hook is to prevent external changes from being added
jerojasro@336: to a repository.  For example, you could use this to ``freeze'' a
jerojasro@336: server-hosted branch temporarily or permanently so that users cannot
jerojasro@336: push to it, while still allowing a local administrator to modify the
jerojasro@336: repository.
jerojasro@336: 
jerojasro@336: Parameters to this hook:
jerojasro@336: \begin{itemize}
jerojasro@336: \item[\texttt{source}] A string.  The source of these changes.  See
jerojasro@336:   section~\ref{sec:hook:sources} for details.
jerojasro@336: \item[\texttt{url}] A URL.  The location of the remote repository, if
jerojasro@336:   known.  See section~\ref{sec:hook:url} for more information.
jerojasro@336: \end{itemize}
jerojasro@336: 
jerojasro@336: See also: \hook{changegroup} (section~\ref{sec:hook:changegroup}),
jerojasro@336: \hook{incoming} (section~\ref{sec:hook:incoming}), ,
jerojasro@336: \hook{pretxnchangegroup} (section~\ref{sec:hook:pretxnchangegroup})
jerojasro@336: 
jerojasro@336: \subsection{\hook{precommit}---before starting to commit a changeset}
jerojasro@336: \label{sec:hook:precommit}
jerojasro@336: 
jerojasro@336: This hook is run before Mercurial begins to commit a new changeset.
jerojasro@336: It is run before Mercurial has any of the metadata for the commit,
jerojasro@336: such as the files to be committed, the commit message, or the commit
jerojasro@336: date.
jerojasro@336: 
jerojasro@336: One use for this hook is to disable the ability to commit new
jerojasro@336: changesets, while still allowing incoming changesets.  Another is to
jerojasro@336: run a build or test, and only allow the commit to begin if the build
jerojasro@336: or test succeeds.
jerojasro@336: 
jerojasro@336: Parameters to this hook:
jerojasro@336: \begin{itemize}
jerojasro@336: \item[\texttt{parent1}] A changeset ID.  The changeset ID of the first
jerojasro@336:   parent of the working directory.
jerojasro@336: \item[\texttt{parent2}] A changeset ID.  The changeset ID of the second
jerojasro@336:   parent of the working directory.
jerojasro@336: \end{itemize}
jerojasro@336: If the commit proceeds, the parents of the working directory will
jerojasro@336: become the parents of the new changeset.
jerojasro@336: 
jerojasro@336: See also: \hook{commit} (section~\ref{sec:hook:commit}),
jerojasro@336: \hook{pretxncommit} (section~\ref{sec:hook:pretxncommit})
jerojasro@336: 
jerojasro@336: \subsection{\hook{preoutgoing}---before starting to propagate changesets}
jerojasro@336: \label{sec:hook:preoutgoing}
jerojasro@336: 
jerojasro@336: This hook is invoked before Mercurial knows the identities of the
jerojasro@336: changesets to be transmitted.
jerojasro@336: 
jerojasro@336: One use for this hook is to prevent changes from being transmitted to
jerojasro@336: another repository.
jerojasro@336: 
jerojasro@336: Parameters to this hook:
jerojasro@336: \begin{itemize}
jerojasro@336: \item[\texttt{source}] A string.  The source of the operation that is
jerojasro@336:   attempting to obtain changes from this repository (see
jerojasro@336:   section~\ref{sec:hook:sources}).  See the documentation for the
jerojasro@336:   \texttt{source} parameter to the \hook{outgoing} hook, in
jerojasro@336:   section~\ref{sec:hook:outgoing}, for possible values of this
jerojasro@336:   parameter.
jerojasro@336: \item[\texttt{url}] A URL.  The location of the remote repository, if
jerojasro@336:   known.  See section~\ref{sec:hook:url} for more information.
jerojasro@336: \end{itemize}
jerojasro@336: 
jerojasro@336: See also: \hook{outgoing} (section~\ref{sec:hook:outgoing})
jerojasro@336: 
jerojasro@336: \subsection{\hook{pretag}---before tagging a changeset}
jerojasro@336: \label{sec:hook:pretag}
jerojasro@336: 
jerojasro@336: This controlling hook is run before a tag is created.  If the hook
jerojasro@336: succeeds, creation of the tag proceeds.  If the hook fails, the tag is
jerojasro@336: not created.
jerojasro@336: 
jerojasro@336: Parameters to this hook:
jerojasro@336: \begin{itemize}
jerojasro@336: \item[\texttt{local}] A boolean.  Whether the tag is local to this
jerojasro@336:   repository instance (i.e.~stored in \sfilename{.hg/localtags}) or
jerojasro@336:   managed by Mercurial (stored in \sfilename{.hgtags}).
jerojasro@336: \item[\texttt{node}] A changeset ID.  The ID of the changeset to be tagged.
jerojasro@336: \item[\texttt{tag}] A string.  The name of the tag to be created.
jerojasro@336: \end{itemize}
jerojasro@336: 
jerojasro@336: If the tag to be created is revision-controlled, the \hook{precommit}
jerojasro@336: and \hook{pretxncommit} hooks (sections~\ref{sec:hook:commit}
jerojasro@336: and~\ref{sec:hook:pretxncommit}) will also be run.
jerojasro@336: 
jerojasro@336: See also: \hook{tag} (section~\ref{sec:hook:tag})
jerojasro@336: 
jerojasro@336: \subsection{\hook{pretxnchangegroup}---before completing addition of
jerojasro@336:   remote changesets}
jerojasro@336: \label{sec:hook:pretxnchangegroup}
jerojasro@336: 
jerojasro@336: This controlling hook is run before a transaction---that manages the
jerojasro@336: addition of a group of new changesets from outside the
jerojasro@336: repository---completes.  If the hook succeeds, the transaction
jerojasro@336: completes, and all of the changesets become permanent within this
jerojasro@336: repository.  If the hook fails, the transaction is rolled back, and
jerojasro@336: the data for the changesets is erased.
jerojasro@336: 
jerojasro@336: This hook can access the metadata associated with the almost-added
jerojasro@336: changesets, but it should not do anything permanent with this data.
jerojasro@336: It must also not modify the working directory.
jerojasro@336: 
jerojasro@336: While this hook is running, if other Mercurial processes access this
jerojasro@336: repository, they will be able to see the almost-added changesets as if
jerojasro@336: they are permanent.  This may lead to race conditions if you do not
jerojasro@336: take steps to avoid them.
jerojasro@336: 
jerojasro@336: This hook can be used to automatically vet a group of changesets.  If
jerojasro@336: the hook fails, all of the changesets are ``rejected'' when the
jerojasro@336: transaction rolls back.
jerojasro@336: 
jerojasro@336: Parameters to this hook:
jerojasro@336: \begin{itemize}
jerojasro@336: \item[\texttt{node}] A changeset ID.  The changeset ID of the first
jerojasro@336:   changeset in the group that was added.  All changesets between this
jerojasro@336:   and \index{tags!\texttt{tip}}\texttt{tip}, inclusive, were added by
jerojasro@336:   a single \hgcmd{pull}, \hgcmd{push} or \hgcmd{unbundle}.
jerojasro@336: \item[\texttt{source}] A string.  The source of these changes.  See
jerojasro@336:   section~\ref{sec:hook:sources} for details.
jerojasro@336: \item[\texttt{url}] A URL.  The location of the remote repository, if
jerojasro@336:   known.  See section~\ref{sec:hook:url} for more information.
jerojasro@336: \end{itemize}
jerojasro@336: 
jerojasro@336: See also: \hook{changegroup} (section~\ref{sec:hook:changegroup}),
jerojasro@336: \hook{incoming} (section~\ref{sec:hook:incoming}),
jerojasro@336: \hook{prechangegroup} (section~\ref{sec:hook:prechangegroup})
jerojasro@336: 
jerojasro@336: \subsection{\hook{pretxncommit}---before completing commit of new changeset}
jerojasro@336: \label{sec:hook:pretxncommit}
jerojasro@336: 
jerojasro@336: This controlling hook is run before a transaction---that manages a new
jerojasro@336: commit---completes.  If the hook succeeds, the transaction completes
jerojasro@336: and the changeset becomes permanent within this repository.  If the
jerojasro@336: hook fails, the transaction is rolled back, and the commit data is
jerojasro@336: erased.
jerojasro@336: 
jerojasro@336: This hook can access the metadata associated with the almost-new
jerojasro@336: changeset, but it should not do anything permanent with this data.  It
jerojasro@336: must also not modify the working directory.
jerojasro@336: 
jerojasro@336: While this hook is running, if other Mercurial processes access this
jerojasro@336: repository, they will be able to see the almost-new changeset as if it
jerojasro@336: is permanent.  This may lead to race conditions if you do not take
jerojasro@336: steps to avoid them.
jerojasro@336: 
jerojasro@336: Parameters to this hook:
jerojasro@336: \begin{itemize}
jerojasro@336: \item[\texttt{node}] A changeset ID.  The changeset ID of the newly
jerojasro@336:   committed changeset.
jerojasro@336: \item[\texttt{parent1}] A changeset ID.  The changeset ID of the first
jerojasro@336:   parent of the newly committed changeset.
jerojasro@336: \item[\texttt{parent2}] A changeset ID.  The changeset ID of the second
jerojasro@336:   parent of the newly committed changeset.
jerojasro@336: \end{itemize}
jerojasro@336: 
jerojasro@336: See also: \hook{precommit} (section~\ref{sec:hook:precommit})
jerojasro@336: 
jerojasro@336: \subsection{\hook{preupdate}---before updating or merging working directory}
jerojasro@336: \label{sec:hook:preupdate}
jerojasro@336: 
jerojasro@336: This controlling hook is run before an update or merge of the working
jerojasro@336: directory begins.  It is run only if Mercurial's normal pre-update
jerojasro@336: checks determine that the update or merge can proceed.  If the hook
jerojasro@336: succeeds, the update or merge may proceed; if it fails, the update or
jerojasro@336: merge does not start.
jerojasro@336: 
jerojasro@336: Parameters to this hook:
jerojasro@336: \begin{itemize}
jerojasro@336: \item[\texttt{parent1}] A changeset ID.  The ID of the parent that the
jerojasro@336:   working directory is to be updated to.  If the working directory is
jerojasro@336:   being merged, it will not change this parent.
jerojasro@336: \item[\texttt{parent2}] A changeset ID.  Only set if the working
jerojasro@336:   directory is being merged.  The ID of the revision that the working
jerojasro@336:   directory is being merged with.
jerojasro@336: \end{itemize}
jerojasro@336: 
jerojasro@336: See also: \hook{update} (section~\ref{sec:hook:update})
jerojasro@336: 
jerojasro@336: \subsection{\hook{tag}---after tagging a changeset}
jerojasro@336: \label{sec:hook:tag}
jerojasro@336: 
jerojasro@336: This hook is run after a tag has been created.
jerojasro@336: 
jerojasro@336: Parameters to this hook:
jerojasro@336: \begin{itemize}
jerojasro@336: \item[\texttt{local}] A boolean.  Whether the new tag is local to this
jerojasro@336:   repository instance (i.e.~stored in \sfilename{.hg/localtags}) or
jerojasro@336:   managed by Mercurial (stored in \sfilename{.hgtags}).
jerojasro@336: \item[\texttt{node}] A changeset ID.  The ID of the changeset that was
jerojasro@336:   tagged.
jerojasro@336: \item[\texttt{tag}] A string.  The name of the tag that was created.
jerojasro@336: \end{itemize}
jerojasro@336: 
jerojasro@336: If the created tag is revision-controlled, the \hook{commit} hook
jerojasro@336: (section~\ref{sec:hook:commit}) is run before this hook.
jerojasro@336: 
jerojasro@336: See also: \hook{pretag} (section~\ref{sec:hook:pretag})
jerojasro@336: 
jerojasro@336: \subsection{\hook{update}---after updating or merging working directory}
jerojasro@336: \label{sec:hook:update}
jerojasro@336: 
jerojasro@336: This hook is run after an update or merge of the working directory
jerojasro@336: completes.  Since a merge can fail (if the external \command{hgmerge}
jerojasro@336: command fails to resolve conflicts in a file), this hook communicates
jerojasro@336: whether the update or merge completed cleanly.
jerojasro@336: 
jerojasro@336: \begin{itemize}
jerojasro@336: \item[\texttt{error}] A boolean.  Indicates whether the update or
jerojasro@336:   merge completed successfully.
jerojasro@336: \item[\texttt{parent1}] A changeset ID.  The ID of the parent that the
jerojasro@336:   working directory was updated to.  If the working directory was
jerojasro@336:   merged, it will not have changed this parent.
jerojasro@336: \item[\texttt{parent2}] A changeset ID.  Only set if the working
jerojasro@336:   directory was merged.  The ID of the revision that the working
jerojasro@336:   directory was merged with.
jerojasro@336: \end{itemize}
jerojasro@336: 
jerojasro@336: See also: \hook{preupdate} (section~\ref{sec:hook:preupdate})
jerojasro@336: 
jerojasro@336: %%% Local Variables: 
jerojasro@336: %%% mode: latex
jerojasro@336: %%% TeX-master: "00book"
jerojasro@336: %%% End: