Mercurial > hgbook
annotate ja/hook.tex @ 381:991befd0025c
more hook.tex
author | Yoshiki Yazawa <yaz@honeyplanet.jp> |
---|---|
date | Thu, 19 Feb 2009 14:59:58 +0900 |
parents | beab196f78da |
children | d64d38d2a91a |
rev | line source |
---|---|
374 | 1 %\chapter{Handling repository events with hooks} |
2 \chapter{$B%j%]%8%H%j%$%Y%s%H$r%U%C%/$G<h$j07$&(B} | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
3 \label{chap:hook} |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
4 |
375 | 5 %Mercurial offers a powerful mechanism to let you perform automated |
6 %actions in response to events that occur in a repository. In some | |
7 %cases, you can even control Mercurial's response to those events. | |
8 | |
9 Mercurial$B$O!$%j%]%8%H%j$K5/$3$k%$%Y%s%H$KBP$7$F<+F02=$5$l$?%"%/%7%g%s$r9T(B | |
10 $B$&6/NO$J%a%+%K%:%`$r;}$C$F$$$k!%$$$/$D$+$N%$%Y%s%H$KBP$7$F$O!$(BMercurial$B$N(B | |
11 $BH?1~$r@)8f$9$k$3$H$b$G$-$k!%(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
12 |
375 | 13 %The name Mercurial uses for one of these actions is a \emph{hook}. |
14 %Hooks are called ``triggers'' in some revision control systems, but | |
15 %the two names refer to the same idea. | |
16 | |
17 Mercurial$B$O(B\emph{$B%U%C%/(B}$B$H8F$P$l$k5!9=$r;H$C$F%"%/%7%g%s$r9T$&!%%U%C%/$O(B | |
18 $BB>$N%j%S%8%g%s%3%s%H%m!<%k%7%9%F%`$G$O(B``$B%H%j%,(B''$B$H8F$P$l$k$3$H$b$"$k$,!$(B | |
19 $B$3$l$i$O<B:]$OF1$8$b$N$G$"$k!%(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
20 |
374 | 21 %\section{An overview of hooks in Mercurial} |
22 \section{Mercurial$B$G$N%U%C%/$N35MW(B} | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
23 |
375 | 24 %Here is a brief list of the hooks that Mercurial supports. We will |
25 %revisit each of these hooks in more detail later, in | |
26 %section~\ref{sec:hook:ref}. | |
27 | |
28 Mercurial$B$,%5%]!<%H$9$k%U%C%/$N0lIt$rNs5s$9$k!%8D!9$N%U%C%/$K$D$$$F$O(B | |
29 $B8e$[$I(Bsection~\ref{sec:hook:ref}$B$G>\:Y$K?($l$k!%(B | |
41 | 30 |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
31 \begin{itemize} |
375 | 32 %\item[\small\hook{changegroup}] This is run after a group of |
33 % changesets has been brought into the repository from elsewhere. | |
34 \item[\small\hook{changegroup}] $B%A%'%s%8%;%C%H%0%k!<%W$,30It$+$i%j%]%8%H(B | |
35 $B%j$K2C$o$C$?8e$G8F$S=P$5$l$k!%(B | |
36 | |
37 %\item[\small\hook{commit}] This is run after a new changeset has been | |
38 % created in the local repository. | |
39 \item[\small\hook{commit}] $B%m!<%+%k%j%]%8%H%j$G?7$7$$%A%'%s%8%;%C%H$,:n(B | |
40 $B@.$5$l$?8e$K8F$S=P$5$l$k!%(B | |
41 | |
42 %\item[\small\hook{incoming}] This is run once for each new changeset | |
43 % that is brought into the repository from elsewhere. Notice the | |
44 % difference from \hook{changegroup}, which is run once per | |
45 % \emph{group} of changesets brought in. | |
46 | |
47 \item[\small\hook{incoming}] $B?7$7$$%A%'%s%8%;%C%H$,30It$+$i%j%]%8%H%j$K2C(B | |
48 $B$o$kKh$K8F$S=P$5$l$k!%(B\emph{group}$B$,2C$o$kKh$K8F$S=P$5$l$k%U%C(B | |
49 $B%/$K(B\hook{changegroup}$B%U%C%/$,$"$k!%(B | |
50 | |
51 %\item[\small\hook{outgoing}] This is run after a group of changesets | |
52 % has been transmitted from this repository. | |
53 \item[\small\hook{outgoing}] $B%j%]%8%H%j$+$i%A%'%s%8%;%C%H%0%k!<%W$,30It(B | |
54 $B$KAw?.$5$l$?8e$K8F$S=P$5$l$k!%(B | |
55 | |
56 %\item[\small\hook{prechangegroup}] This is run before starting to | |
57 % bring a group of changesets into the repository. | |
58 \item[\small\hook{prechangegroup}] $B%A%'%s%8%;%C%H%0%k!<%W$r%j%]%8%H%j$+(B | |
59 $B$i30It$K;}$A=P$9A0$K8F$S=P$5$l$k!%(B | |
60 | |
61 %\item[\small\hook{precommit}] Controlling. This is run before starting | |
62 % a commit. | |
63 \item[\small\hook{precommit}] Controlling. $B%3%_%C%H$,;O$^$kA0$K8F$S=P$5(B | |
64 $B$l$k!%(B | |
65 | |
66 %\item[\small\hook{preoutgoing}] Controlling. This is run before | |
67 % starting to transmit a group of changesets from this repository. | |
68 \item[\small\hook{preoutgoing}] Controlling. $B%A%'%s%8%;%C%H%0%k!<%W$r%j(B | |
69 $B%]%8%H%j$+$i30It$KAw?.$9$kA0$K8F$S=P$5$l$k!%(B | |
70 | |
71 %\item[\small\hook{pretag}] Controlling. This is run before creating a tag. | |
72 \item[\small\hook{pretag}] Controlling. $B%?%0$,:n@.$5$l$kA0$K8F$S=P$5$l$k!%(B | |
73 | |
74 %\item[\small\hook{pretxnchangegroup}] Controlling. This is run after a | |
75 % group of changesets has been brought into the local repository from | |
76 % another, but before the transaction completes that will make the | |
77 % changes permanent in the repository. | |
78 \item[\small\hook{pretxnchangegroup}] Controlling. $B%A%'%s%8%;%C%H%0%k!<%W(B | |
79 $B$,30It$+$i%m!<%+%k%j%]%8%H%j$K2C$o$C$?8e!$1JB3E*$K5-O?$9$k$?(B | |
80 $B$a$N%H%i%s%6%/%7%g%s$,40N;$9$kA0$K8F$S=P$5$l$k!%(B | |
81 | |
82 %\item[\small\hook{pretxncommit}] Controlling. This is run after a new | |
83 % changeset has been created in the local repository, but before the | |
84 % transaction completes that will make it permanent. | |
85 \item[\small\hook{pretxncommit}] Controlling. $B?7$7$$%A%'%s%8%;%C%H$,%m!<(B | |
86 $B%+%k%j%]%8%H%j$G:n@.$5$l$?8e!$1JB3E*$K5-O?$9$k$?$a$N%H%i%s%6(B | |
87 $B%/%7%g%s$,40N;$9$kA0$K8F$S=P$5$l$k!%(B | |
88 | |
89 %\item[\small\hook{preupdate}] Controlling. This is run before starting | |
90 % an update or merge of the working directory. | |
91 \item[\small\hook{preupdate}] Controlling. $B%o!<%-%s%0%G%#%l%/%H%j$N99?7(B | |
92 $B$^$?$O%^!<%8$,9T$o$l$kA0$K8F$S=P$5$l$k!%(B | |
93 | |
94 %\item[\small\hook{tag}] This is run after a tag is created. | |
95 \item[\small\hook{tag}] $B%?%0$,:n@.$5$l$?8e$G8F$S=P$5$l$k!%(B | |
96 | |
97 %\item[\small\hook{update}] This is run after an update or merge of the | |
98 % working directory has finished. | |
99 \item[\small\hook{update}] $B%o!<%-%s%0%G%#%l%/%H%j$N99?7$+%^!<%8$,40N;$7(B | |
100 $B$?;~$K8F$S=P$5$l$k!%(B | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
101 \end{itemize} |
375 | 102 %Each of the hooks whose description begins with the word |
103 %``Controlling'' has the ability to determine whether an activity can | |
104 %proceed. If the hook succeeds, the activity may proceed; if it fails, | |
105 %the activity is either not permitted or undone, depending on the hook. | |
106 | |
107 $B%U%C%/$N$&$A!$@bL@$,(B``Controlling''$B$H$$$&8l$G;O$^$k$b$N$O!$%U%C%/$N@.H]$r(B | |
108 $BH=Dj$7!$0J8e$NF0:n$r9T$&$+$I$&$+7hDj$9$k5!G=$,$"$k!%%U%C%/$,@.8y$9$k$HF0(B | |
109 $B:n$O@h$X?J$`!%%U%C%/$,@.8y$7$J$+$C$?>l9g$O0J8e$NF0:n$O<B9T$,5v2D$5$l$J$$(B | |
110 $B$+!$F0:n$,40N;$;$:=*$k!%(B | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
111 |
374 | 112 %\section{Hooks and security} |
113 \section{$B%U%C%/$H%;%-%e%j%F%#(B} | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
114 |
374 | 115 %\subsection{Hooks are run with your privileges} |
116 \subsection{$B%U%C%/$O%f!<%6$N8"8B$GF0:n$9$k(B} | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
117 |
375 | 118 %When you run a Mercurial command in a repository, and the command |
119 %causes a hook to run, that hook runs on \emph{your} system, under | |
120 %\emph{your} user account, with \emph{your} privilege level. Since | |
121 %hooks are arbitrary pieces of executable code, you should treat them | |
122 %with an appropriate level of suspicion. Do not install a hook unless | |
123 %you are confident that you know who created it and what it does. | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
124 |
375 | 125 $B%j%]%8%H%jFb$G(BMercurial$B%3%^%s%I$r<B9T$7!$%3%^%s%I$,%U%C%/$r8F$S=P$7$?>l(B |
126 $B9g!$%U%C%/$O(B\emph{$BA`:n<T(B}$B$N%7%9%F%`$G!$(B\emph{$BA`:n<T(B}$B$NFC8"%l%Y%k$GF0:n$9(B | |
127 $B$k!%%U%C%/$OG$0U$N<B9T%3!<%I$J$N$G!$Aj1~$NN10U$,I,MW$G$"$k!%%U%C%/$r:n$C(B | |
128 $B$?$N$,C/$G!$$=$N%U%C%/$,2?$r$9$k$N$+$-$A$s$HM}2r$9$k$3$H$J$7$K%U%C%/$r%$(B | |
129 $B%s%9%H!<%k$7$F$O$J$i$J$$!%(B | |
130 | |
131 %In some cases, you may be exposed to hooks that you did not install | |
132 %yourself. If you work with Mercurial on an unfamiliar system, | |
133 %Mercurial will run hooks defined in that system's global \hgrc\ file. | |
134 | |
135 $B<+J,$G%$%s%9%H!<%k$7$?$N$G$O$J$$%U%C%/$r<B9T$5$;$F$7$^$&$3$H$bM-$jF@$k!%(B | |
136 $BB>=j$N%7%9%F%`$N>e$G(BMercurial$B$r;H$&>l9g!$(BMercurial$B$,%7%9%F%`%o%$%I$N(B | |
137 \hgrc\ $B%U%!%$%k$GDj5A$5$l$?%U%C%/$r5/F0$9$k2DG=@-$,$"$k!%(B | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
138 |
375 | 139 %If you are working with a repository owned by another user, Mercurial |
140 %can run hooks defined in that user's repository, but it will still run | |
141 %them as ``you''. For example, if you \hgcmd{pull} from that | |
142 %repository, and its \sfilename{.hg/hgrc} defines a local | |
143 %\hook{outgoing} hook, that hook will run under your user account, even | |
144 %though you don't own that repository. | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
145 |
375 | 146 $BB>$N%f!<%6$,=jM-$9$k%j%]%8%H%j$G:n6H$9$k>l9g!$(BMercurial$B$O=jM-<T$N%j%]%8(B |
147 $B%H%jFb$GDj5A$5$l$?%U%C%/$r<B9T$7F@$k$,!$<B9T8"8B$O$"$J$?$N$b$N$G9T$o$l$k!%(B | |
148 $BNc$($P$=$N%j%]%8%H%j$+$i(B\hgcmd{pull}$B$r9T$&$H$-!$%j%]%8%H%jFb$N(B | |
149 \sfilename{.hg/hgrc}$B%U%!%$%k$G%m!<%+%k$J(B\hook{outgoing}$B%U%C%/$,Dj5A$5$l$F(B | |
150 $B$$$k$H!$$"$J$?$O$=$N%j%]%8%H%j$r=jM-$7$F$$$J$$$K$b$+$+$o$i$:$=$N%U%C%/$O(B | |
151 $B$"$J$?$N8"8B$G<B9T$5$l$k!%(B | |
152 | |
153 %\begin{note} | |
154 % This only applies if you are pulling from a repository on a local or | |
155 % network filesystem. If you're pulling over http or ssh, any | |
156 % \hook{outgoing} hook will run under whatever account is executing | |
157 % the server process, on the server. | |
158 %\end{note} | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
159 \begin{note} |
375 | 160 $B$3$l$O%m!<%+%k$J%j%]%8%H%j$d%M%C%H%o!<%/%U%!%$%k%7%9%F%`>e$N%j%]%8%H%j$+(B |
161 $B$i(Bpull$B$7$?>l9g$K$N$_E,MQ$5$l$k!%(Bhttp$B$^$?$O(Bssh$B$r;H$C$F(Bpull$B$7$?>l9g!$$9$Y(B | |
162 $B$F$N(B\hook{outgoing}$B%U%C%/$O%5!<%P>e$G%5!<%P%W%m%;%9$r<B9T$7$F$$$k%"%+%&(B | |
163 $B%s%H$N8"8B$G<B9T$5$l$k!%(B | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
164 \end{note} |
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
165 |
375 | 166 %XXX To see what hooks are defined in a repository, use the |
167 %\hgcmdargs{config}{hooks} command. If you are working in one | |
168 %repository, but talking to another that you do not own (e.g.~using | |
169 %\hgcmd{pull} or \hgcmd{incoming}), remember that it is the other | |
170 %repository's hooks you should be checking, not your own. | |
171 | |
172 XXX $B%j%]%8%H%jFb$GDj5A$5$l$F$$$k%U%C%/$r8+$k$K$O(B | |
173 \hgcmdargs{config}{hooks}$B%3%^%s%I$r;H$&!%$"$k%j%]%8%H%j$G:n6H$7$F$$$F!$?7(B | |
174 $B$7$$%3!<%I$rB>$N%j%]%8%H%j$+$iF~<j$9$k$?$a$KDL?.$r9T$&>l9g!JNc$($P(B | |
175 \hgcmd{pull}$B$+(B\hgcmd{incoming}$B$r<B9T$9$k!K(B $B!$%A%'%C%/$9$Y$-%U%C%/$O<j85$N(B | |
176 $B%j%]%8%H%j$N$b$N$G$O$J$/!$%j%b!<%H$N%j%]%8%H%j$N%U%C%/$G$"$k!%(B | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
177 |
374 | 178 %\subsection{Hooks do not propagate} |
375 | 179 \subsection{$B%U%C%/$OEAGE$7$J$$(B} |
180 | |
181 %In Mercurial, hooks are not revision controlled, and do not propagate | |
182 %when you clone, or pull from, a repository. The reason for this is | |
183 %simple: a hook is a completely arbitrary piece of executable code. It | |
184 %runs under your user identity, with your privilege level, on your | |
185 %machine. | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
186 |
375 | 187 Mercurial$B$G$O!$%U%C%/$O%j%S%8%g%s4IM}$5$l$:!$%j%]%8%H%j$+$i%/%m!<%s$7$?$j(B |
188 pull$B$7$F$bEAGE$7$J$$!%$3$&$J$C$F$$$kM}M3$OC1=c$G!$%U%C%/$OG$0U$N<B9T2DG=(B | |
189 $B%3!<%I$G$"$k$+$i$G$"$k!%%U%C%/$O$"$J$?$N%^%7%s$N>e$G$"$J$?$N%f!<%6!<(BID$B$H(B | |
190 $BFC8"%l%Y%k$GF0:n$GF0$/!%(B | |
191 | |
192 %It would be extremely reckless for any distributed revision control | |
193 %system to implement revision-controlled hooks, as this would offer an | |
194 %easily exploitable way to subvert the accounts of users of the | |
195 %revision control system. | |
196 | |
197 $BJ,;6%j%S%8%g%s%3%s%H%m!<%k%7%9%F%`$K%j%S%8%g%s4IM}$5$l$?%U%C%/$r<BAu$9$k(B | |
198 $B$N$O$H$F$bL5KE$G$"$k!%$3$N$h$&$J5!9=$,$"$k$H%j%S%8%g%s%3%s%H%m!<%k%7%9%F(B | |
199 $B%`$N%f!<%6%"%+%&%s%H$r56Au$9$k$h$&$J;E3]$1$r4JC1$K<B8=$G$-$F$7$^$&!%(B | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
200 |
375 | 201 %Since Mercurial does not propagate hooks, if you are collaborating |
202 %with other people on a common project, you should not assume that they | |
203 %are using the same Mercurial hooks as you are, or that theirs are | |
204 %correctly configured. You should document the hooks you expect people | |
205 %to use. | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
206 |
375 | 207 Mercurial$B$O%U%C%/$rEAGE$5$;$J$$$N$G!$6&DL$N%W%m%8%'%/%H$GB>$N3+H/<T$H6(NO(B |
208 $B$7$F$$$k>l9g!$H`$i$O$"$J$?$,;H$C$F$k$N$HF1$8(BMercurial$B%U%C%/$r;H$C$F$$$k$H(B | |
209 $B2>Dj$7$?$j!$H`$i$N%j%]%8%H%j$G$b%U%C%/$,F1MM$K@5$7$/@_Dj$5$l$F$$$k$H2>Dj(B | |
210 $B$9$Y$-$G$O$J$$!%H`$i$,%U%C%/$r;H$&$h$&$KK>$`$N$G$"$l$P!$;HMQK!$K$D$$$F%I(B | |
211 $B%-%e%a%s%H$r:n@.$9$Y$-$G$"$k!%(B | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
212 |
375 | 213 %In a corporate intranet, this is somewhat easier to control, as you |
214 %can for example provide a ``standard'' installation of Mercurial on an | |
215 %NFS filesystem, and use a site-wide \hgrc\ file to define hooks that | |
216 %all users will see. However, this too has its limits; see below. | |
217 | |
218 $B4k6HFb$N%$%s%H%i%M%C%H$G$O%3%s%H%m!<%k$O4vJ,4JC1$G$"$k!%(B NFS$B%U%!%$%k%7%9(B | |
219 $B%F%`>e$G(BMercurial$B$N(B``$BI8=`(B''$B%$%s%9%H%l!<%7%g%sNc$rDs6!$7!$$9$Y$F$N%f!<%6$,(B | |
220 $B;2>H$9$k%5%$%H%o%$%I$N(B\hgrc\ $B%U%!%$%k$rMQ0U$7!$$=$NCf$G%U%C%/$rDj5A$9$k$3(B | |
221 $B$H$,$G$-$k!%$7$+$7$3$NJ}K!$K$b2<5-$N$h$&$J7gE@$,$"$k!%(B | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
222 |
374 | 223 %\subsection{Hooks can be overridden} |
224 \subsection{$B%U%C%/$O%*!<%P%i%$%I2DG=$G$"$k(B} | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
225 |
375 | 226 %Mercurial allows you to override a hook definition by redefining the |
227 %hook. You can disable it by setting its value to the empty string, or | |
228 %change its behaviour as you wish. | |
229 | |
230 Mercurial$B$G$O!$%U%C%/$r:FDj5A$9$k$3$H$K$h$C$F!$4{B8$N%U%C%/Dj5A$r%*!<%P%i(B | |
231 $B%$%I$9$k$3$H$,$G$-$k!%$3$l$OJQ?t$r6u$NJ8;zNs$K$7$?$j!$5sF0$rJQ99$9$k$3$H(B | |
232 $B$G6X;_$9$k$3$H$,$G$-$k!%(B | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
233 |
375 | 234 %If you deploy a system-~or site-wide \hgrc\ file that defines some |
235 %hooks, you should thus understand that your users can disable or | |
236 %override those hooks. | |
237 | |
238 $B%U%C%/$rDj5A$7$?%7%9%F%`%o%$%I$^$?$O%5%$%H%o%$%I$N(B\hgrc\ $B%U%!%$%k$r;HMQ$7(B | |
239 $B$F$b!$%j%]%8%H%j$N%f!<%6$,%U%C%/$r6X;_$7$?$j%*!<%P%i%$%I$G$-$F$7$^$&$N$K(B | |
240 $B5$IU$/$@$m$&!%(B | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
241 |
374 | 242 %\subsection{Ensuring that critical hooks are run} |
243 \subsection{$B%/%j%F%#%+%k$J%U%C%/$,3N<B$K<B9T$5$l$k$h$&$K$9$k(B} | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
244 |
375 | 245 %Sometimes you may want to enforce a policy that you do not want others |
246 %to be able to work around. For example, you may have a requirement | |
247 %that every changeset must pass a rigorous set of tests. Defining this | |
248 %requirement via a hook in a site-wide \hgrc\ won't work for remote | |
249 %users on laptops, and of course local users can subvert it at will by | |
250 %overriding the hook. | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
251 |
375 | 252 $B;~$K$OB>$N3+H/<T$,2sHr:v$r$H$l$J$$$h$&$J%]%j%7!<$rMW@A$7$?$$>l9g$,$"$k$@(B |
253 $B$m$&!%Nc$($P$9$Y$F$N%A%'%s%8%;%C%H$,873J$J%F%9%H%;%C%H$K%Q%9$9$k$3$H$rI,(B | |
254 $BMW$H$9$k>l9g$,9M$($i$l$k!%$3$l$r%5%$%H%o%$%I$N(B\hgrc\ $B$G%U%C%/$H$7$FDj5A(B | |
255 $B$7$?>l9g!$$3$l$O%i%C%W%H%C%W$r;H$C$F$$$k%j%b!<%H%f!<%6$K$O5!G=$7$J$$$7!$(B | |
256 $B%U%C%/$r%*!<%P%i%$%I$G$-$k$?$a!$%m!<%+%k%f!<%6$K$H$C$F$bL5;k$G$-$F$7$^$&!%(B | |
257 | |
258 %Instead, you can set up your policies for use of Mercurial so that | |
259 %people are expected to propagate changes through a well-known | |
260 %``canonical'' server that you have locked down and configured | |
261 %appropriately. | |
262 | |
263 $B$=$NBe$o$j!$(BMercurial$B$N;HMQ$K4X$9$k%]%j%7!<$r@_Dj$7!$E,@Z$K@_Dj$5$l!$87=E(B | |
264 $B$K4IM}$5$l$?4{CN$N(B``$B%+%N%K%+%k(B''$B%5!<%P$rDL$8$FJQ99$,GH5Z$9$k$h$&$K$9$k$3(B | |
265 $B$H$,$G$-$k!%(B | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
266 |
375 | 267 %One way to do this is via a combination of social engineering and |
268 %technology. Set up a restricted-access account; users can push | |
269 %changes over the network to repositories managed by this account, but | |
270 %they cannot log into the account and run normal shell commands. In | |
271 %this scenario, a user can commit a changeset that contains any old | |
272 %garbage they want. | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
273 |
375 | 274 $B$3$l$r<B8=$9$k0lK!$O%=!<%7%c%k%(%s%8%K%"%j%s%0$H5;=Q$NAH$_9g$o$;$G9T$&J}(B |
275 $BK!$G$"$k!%8BDj%"%/%;%9%"%+%&%s%H$r@_Dj$7!$$3$N%"%+%&%s%H$G4IM}$5$l$F$$$k(B | |
276 $B%j%]%8%H%j$KBP$7$F%f!<%6$OJQ99$r%M%C%H%o!<%/$r2p$7$F(Bpush$B$G$-$k!%$7$+$7%f!<(B | |
277 $B%6$O$3$N%"%+%&%s%H$G%m%0%$%s$7$?$j!$DL>o$N%7%'%k%3%^%s%I$r<B9T$9$k$3$H$O(B | |
278 $B$G$-$J$$!%$3$N%7%J%j%*$G$O!$%f!<%6$O$I$s$J8E$$%4%_$r4^$s$@%A%'%s%8%;%C%H(B | |
279 $B$G$b%3%_%C%H$9$k$3$H$,$G$-$k!%(B | |
280 | |
281 %When someone pushes a changeset to the server that everyone pulls | |
282 %from, the server will test the changeset before it accepts it as | |
283 %permanent, and reject it if it fails to pass the test suite. If | |
284 %people only pull changes from this filtering server, it will serve to | |
285 %ensure that all changes that people pull have been automatically | |
286 %vetted. | |
287 | |
288 $BB?$/$N%f!<%6$,(Bpull$B$9$k%5!<%P$KC/$+$,%A%'%s%8%;%C%H$r(Bpush$B$7$?>l9g!$%5!<%P(B | |
289 $B$O%A%'%s%8%;%C%H$r915WE*$K<u$1F~$l$kA0$K%A%'%C%/$r9T$$!$0lO"$N%F%9%H$r%Q(B | |
290 $B%9$G$-$J$1$l$P%j%8%'%/%H$r9T$&!%%f!<%6$,$3$N%U%#%k%?%5!<%P$+$i$N$_(Bpull$B$r(B | |
291 $B9T$&$N$G$"$l$P!$A4$F$NJQ99$O<+F0E*$KA4$F8!::$5$l$F$$$k$3$H$K$J$k!%(B | |
38
b49a7dd4e564
More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
37
diff
changeset
|
292 |
374 | 293 %\section{Care with \texttt{pretxn} hooks in a shared-access repository} |
294 \section{$B6&M-%"%/%;%9%j%]%8%H%j$G(B\texttt{pretxn}$B%U%C%/$r;H$&(B} | |
41 | 295 |
375 | 296 %If you want to use hooks to do some automated work in a repository |
297 %that a number of people have shared access to, you need to be careful | |
298 %in how you do this. | |
299 | |
300 $BJ#?t$N%f!<%6$,6&M-%"%/%;%9$r9T$&%j%]%8%H%j$G!$<+F02=$5$l$?:n6H$r9T$&$?$a(B | |
301 $B$K%U%C%/$r;HMQ$7$?$$$J$i!$$I$N$h$&$K9T$&$+Cm0U?<$/9M$($kI,MW$,$"$k!%(B | |
41 | 302 |
375 | 303 %Mercurial only locks a repository when it is writing to the |
304 %repository, and only the parts of Mercurial that write to the | |
305 %repository pay attention to locks. Write locks are necessary to | |
306 %prevent multiple simultaneous writers from scribbling on each other's | |
307 %work, corrupting the repository. | |
308 | |
309 Mercurial$B$O%j%]%8%H%j$K=q$-9~$_$r9T$&$H$-$K$@$1%j%]%8%H%j$r%m%C%/$9$k!%(B | |
310 $B$^$?(BMercurial$B$N=q$-9~$_$r9T$&ItJ,$N$_$,%m%C%/$r9MN8$9$k!%=q$-9~$_%m%C%/(B | |
311 $B$O!$J#?t$NF1;~=q$-9~$_$,B>$NJQ99$r>e=q$-$7!$%j%]%8%H%j$rGKB;$9$k$N$rKI$0!%(B | |
41 | 312 |
375 | 313 %Because Mercurial is careful with the order in which it reads and |
314 %writes data, it does not need to acquire a lock when it wants to read | |
315 %data from the repository. The parts of Mercurial that read from the | |
316 %repository never pay attention to locks. This lockless reading scheme | |
317 %greatly increases performance and concurrency. | |
41 | 318 |
375 | 319 Mercurial$B$O%G!<%?$NFI$_=q$-$N=g=x$rCm0U?<$/9T$&$?$a!$%j%]%8%H%j$+$i$N%G!<(B |
320 $B%?FI$_=P$7$N:]$K%m%C%/$r<hF@$9$kI,MW$,$J$$!%(B Mercurial$B$N%j%]%8%H%j$+$iFI(B | |
321 $B$_=P$7$r9T$&ItJ,$O!$%m%C%/$rA4$/5$$K$9$kI,MW$,$J$$!%$3$NL5%m%C%/FI$_=P$7(B | |
322 $B$K$h$C$F!$F1;~<B9T@-$H@-G=$rBgI}$K9b$a$F$$$k!%(B | |
323 | |
324 %With great performance comes a trade-off, though, one which has the | |
325 %potential to cause you trouble unless you're aware of it. To describe | |
326 %this requires a little detail about how Mercurial adds changesets to a | |
327 %repository and reads those changes. | |
328 | |
329 $B$7$+$7$J$,$i$3$N9b@-G=$O$=$l$rCN$i$J$1$l$PLdBj$r0z$-5/$3$9$"$k%H%l!<%I%*(B | |
330 $B%U$r$b$b$?$i$9!%$3$l$r@bL@$9$k$?$a$K!$(BMercurial$B$,$I$N$h$&$K%A%'%s%8%;%C%H(B | |
331 $B$r%j%]%8%H%j$KDI2C$7!$$=$l$i$rFI$_=P$9$+$N>\:Y$K?($l$J$1$l$P$J$i$J$$!%(B | |
41 | 332 |
375 | 333 %When Mercurial \emph{writes} metadata, it writes it straight into the |
334 %destination file. It writes file data first, then manifest data | |
335 %(which contains pointers to the new file data), then changelog data | |
336 %(which contains pointers to the new manifest data). Before the first | |
337 %write to each file, it stores a record of where the end of the file | |
338 %was in its transaction log. If the transaction must be rolled back, | |
339 %Mercurial simply truncates each file back to the size it was before the | |
340 %transaction began. | |
341 | |
342 Mercurial$B$O%a%?%G!<%?$r(B\emph{$B=q$-9~$`(B}$B$H$-!$D>@\L\E*$N%U%!%$%k$K=q$-9~$_(B | |
343 $B$9$k!%(BMercurial$B$O$^$:%U%!%$%k%G!<%?$r=q$-9~$_!$<!$$$G!J?7$7$$%U%!%$%k%G!<(B | |
344 $B%?$N>l=j$r<($9%]%$%s%?$r4^$`!K%^%K%U%'%9%H%G!<%?$r=q$-9~$`!%$=$7$F!J?7$7(B | |
345 $B$$%^%K%U%'%9%H%G!<%?$N>l=j$r<($9%]%$%s%?$r4^$`!K%A%'%s%8%m%0%G!<%?$r=q$-(B | |
346 $B9~$`!%3F!9$N%U%!%$%k$X$N:G=i$N=q$-9~$_$NA0$K!$%U%!%$%k$NKvHx$N%l%3!<%I$r(B | |
347 $B%H%i%s%6%/%7%g%s%m%0$KJ]B8$9$k!%%H%i%s%6%/%7%g%s$,%m!<%k%P%C%/$5$l$k>l9g(B | |
348 $B$O!$(BMercurial$B$O3F!9$N%U%!%$%k$r%H%i%s%6%/%7%g%s$,;O$^$kA0$N%5%$%:$K@Z$j5M(B | |
349 $B$a$k!%(B | |
350 | |
351 %When Mercurial \emph{reads} metadata, it reads the changelog first, | |
352 %then everything else. Since a reader will only access parts of the | |
353 %manifest or file metadata that it can see in the changelog, it can | |
354 %never see partially written data. | |
41 | 355 |
375 | 356 Mercurial$B$O%a%?%G!<%?$r(B\emph{$BFI$`(B}$B;~$K$^$:%A%'%s%8%m%0$rFI$_!$<!$$$G;D$j(B |
357 $B$NItJ,$rFI$`!%%j!<%@$O%A%'%s%8%m%0$K8=$l$k%^%K%U%'%9%H$N0lIt$^$?$O%U%!%$(B | |
358 $B%k%a%?%G!<%?$N0lIt$K$N$_%"%/%;%9$9$k$?$a!$ItJ,E*$K=q$+$l$?%G!<%?$r8+$k$3(B | |
359 $B$H$O$G$-$J$$!%(B | |
360 | |
361 %Some controlling hooks (\hook{pretxncommit} and | |
362 %\hook{pretxnchangegroup}) run when a transaction is almost complete. | |
363 %All of the metadata has been written, but Mercurial can still roll the | |
364 %transaction back and cause the newly-written data to disappear. | |
41 | 365 |
375 | 366 $B$$$/$D$+$N@)8f%U%C%/!J(B\hook{pretxncommit}$B$H(B\hook{pretxnchangegroup}$B!K$O%H(B |
367 $B%i%s%6%/%7%g%s$,$[$\40N;$7$?;~$K<B9T$5$l$k!%$9$Y$F$N%a%?%G!<%?$,=q$-9~$^(B | |
368 $B$l$k$,!$$3$N;~E@$G$b(BMercurial$B$O%H%i%s%6%/%7%g%s$r85$KLa$9$3$H$,$G$-!$$=$N(B | |
369 $B>l9g$O?7$7$/=q$+$l$?%G!<%?$O>C<:$9$k!%(B | |
41 | 370 |
375 | 371 %If one of these hooks runs for long, it opens a window of time during |
372 %which a reader can see the metadata for changesets that are not yet | |
373 %permanent, and should not be thought of as ``really there''. The | |
374 %longer the hook runs, the longer that window is open. | |
375 | |
376 $B$3$l$i$N%U%C%/$N$&$A(B1$B$D$,D9;~4V$K$o$?$C$F<B9T$5$l$F$$$k$H!$%j!<%@$,%A%'%s(B | |
377 $B%8%;%C%H$N%a%?%G!<%?$rFI$`$3$H$N$G$-$k%?%$%`%&%#%s%I%&$,3+$/!%$3$N%A%'%s(B | |
378 $B%8%;%C%H$O$^$@1JB3E*$J$b$N$K$J$C$F$*$i$:!$=>$C$F<B:_$9$k$H9M$($k$Y$-$G$O(B | |
379 $B$J$$$b$N$G$"$k!%%U%C%/$,<B9T$5$l$F$$$k;~4V$,D9$/$J$l$P$J$k$[$I!$%?%$%`%&%#(B | |
380 $B%s%I%&$,3+$/;~4V$bD9$/$J$k!%(B | |
381 | |
374 | 382 %\subsection{The problem illustrated} |
383 \subsection{$BLdBj$N>\:Y(B} | |
134
b727a63518d4
Minor updates to race description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
384 |
377 | 385 %In principle, a good use for the \hook{pretxnchangegroup} hook would |
386 %be to automatically build and test incoming changes before they are | |
387 %accepted into a central repository. This could let you guarantee that | |
388 %nobody can push changes to this repository that ``break the build''. | |
389 %But if a client can pull changes while they're being tested, the | |
390 %usefulness of the test is zero; an unsuspecting someone can pull | |
391 %untested changes, potentially breaking their build. | |
392 | |
393 $B<BMQ$K$*$1$k(B\hook{pretxnchangegroup}$B%U%C%/$NNI$$;HMQK!$H$7$F$O!$E~Ce$7$?(B | |
394 $BJQ99$,Cf1{$N%j%]%8%H%j$K<h$j9~$^$l$kA0$K<+F0$G%S%k%I$H%F%9%H$r9T$&$3$H$,(B | |
395 $B9M$($i$l$k!%$3$l$K$h$j!$%S%k%I$rK8$2$kJQ99$OC/$b%j%]%8%H%j$K(Bpush$B$G$-$J$$(B | |
396 $B$3$H$,3N<B$K$J$k!%%/%i%$%"%s%H$,%F%9%HCf$KJQ99$r(Bpull$B$9$k$3$H$,$G$-$l$P!$(B | |
397 $B$3$N%F%9%H$NM-MQ@-$O%<%m$K$J$C$F$7$^$&!%5?$$$r;}$?$:$KC/$+$,%F%9%H$5$l$F(B | |
398 $B$$$J$$JQ99$r(Bpull$B$G$-$k$N$G$"$l$P!$H`$i$N%S%k%I$O<:GT$9$k2DG=@-$,$"$k!%(B | |
399 | |
400 %The safest technological answer to this challenge is to set up such a | |
401 %``gatekeeper'' repository as \emph{unidirectional}. Let it take | |
402 %changes pushed in from the outside, but do not allow anyone to pull | |
403 %changes from it (use the \hook{preoutgoing} hook to lock it down). | |
404 %Configure a \hook{changegroup} hook so that if a build or test | |
405 %succeeds, the hook will push the new changes out to another repository | |
406 %that people \emph{can} pull from. | |
41 | 407 |
377 | 408 $B$3$NLdBj$X$N5;=QE*$K:G$b0BA4$J2sEz$O!$(B``$BLgHV(B''$B%j%]%8%H%j$r(B\emph{$B0lJ}8~(B}$B$K(B |
409 $B@_Dj$9$k$3$H$G$"$k!%%j%]%8%H%j$r30It$+$i(Bpush$B$5$l$?JQ99$r<u$1<h$k$,!$C/$b(B | |
410 pull$B$G$-$J$$$h$&$K@_Dj$9$k!J(B\hook{preoutgoing}$B%U%C%/$r;H$C$F%j%]%8%H%j$r(B | |
411 $B%m%C%/$9$k!K!%(B\hook{changegroup}$B%U%C%/$r@_Dj$7!$%S%k%I$d%F%9%H$,@.8y$7$?(B | |
378 | 412 $B$H$-$K8B$C$F!$%U%C%/$,?7$?$JJQ99$r%f!<%6$N(Bpull\emph{$B$G$-$k(B}$BJL$N%j%]%8%H(B |
377 | 413 $B%j$K(Bpush$B$9$k$h$&$K$9$k!%(B |
414 | |
415 %In practice, putting a centralised bottleneck like this in place is | |
416 %not often a good idea, and transaction visibility has nothing to do | |
417 %with the problem. As the size of a project---and the time it takes to | |
418 %build and test---grows, you rapidly run into a wall with this ``try | |
419 %before you buy'' approach, where you have more changesets to test than | |
420 %time in which to deal with them. The inevitable result is frustration | |
421 %on the part of all involved. | |
41 | 422 |
377 | 423 $B<B:]>e$O!$$3$N$h$&$K=8Cf$7$?%\%H%k%M%C%/$rCV$/$3$H$ONI$$9M$($H$O8@$($:!$(B |
424 $B%H%i%s%6%/%7%g%s$N2D;k@-$OA4$/$J$$!%%W%m%8%'%/%H$N%5%$%:$*$h$S%S%k%I$H%F(B | |
425 $B%9%H$KMW$9$k;~4V$,A}2C$9$k$K=>$C$F!$$3$N$h$&$J(B``$B;vA0$K;n$9(B''$B<jK!$OJI$KFM(B | |
426 $B$-Ev$?$k!%%F%9%H$K;H$($k;~4V$G;+$-@Z$l$J$$$[$I$N%A%'%s%8%;%C%H$r;n$5$J$1(B | |
427 $B$l$P$J$i$J$/$J$k$+$i$G$"$k!%%U%i%9%H%l!<%7%g%s$,Cy$k$N$OHr$1$i$l$J$$$@$m(B | |
428 $B$&!%(B | |
134
b727a63518d4
Minor updates to race description.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
429 |
377 | 430 %An approach that scales better is to get people to build and test |
431 %before they push, then run automated builds and tests centrally | |
432 %\emph{after} a push, to be sure all is well. The advantage of this | |
433 %approach is that it does not impose a limit on the rate at which the | |
434 %repository can accept changes. | |
435 | |
436 $B$h$j%9%1!<%k$9$k<jK!$O!$3+H/<T$K(Bpush$BA0$N%S%k%I$H%F%9%H$r$5$;$k$3$H$G$"(B | |
437 $B$k!%Cf1{$G<+F0$K$h$k%S%k%I$H%F%9%H$r9T$&$N$O!$(Bpush\emph{$B8e(B}$B$K!$A4$F$KLdBj(B | |
438 $B$,$J$$$3$H$r3NG'$9$k$?$a$K9T$&!%$3$N%"%W%m!<%A$NMxE@$O%j%]%8%H%j$,JQ99$r(B | |
439 $B<u$1F~$l$k%Z!<%9$K2?$b@)8B$r2]$5$J$$$3$H$G$"$k!%(B | |
41 | 440 |
374 | 441 %\section{A short tutorial on using hooks} |
442 \section{$B%U%C%/$N;HMQK!(B} | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
443 \label{sec:hook:simple} |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
444 |
379 | 445 %It is easy to write a Mercurial hook. Let's start with a hook that |
446 %runs when you finish a \hgcmd{commit}, and simply prints the hash of | |
447 %the changeset you just created. The hook is called \hook{commit}. | |
448 | |
449 Mercurial$B%U%C%/$r=q$/$N$OMF0W$$!%$3$3$G$O(B\hgcmd{commit}$B%3%^%s%I$,=*N;$7(B | |
450 $B$?:]$K!$:n@.$5$l$?%A%'%s%8%;%C%H$N%O%C%7%eCM$rI=<($9$k$/%U%C%/$r=q$$$F$_(B | |
451 $B$h$&!%$3$N%U%C%/$r(B\hook{commit}$B$H8F$V$3$H$K$9$k!%(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
452 |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
453 \begin{figure}[ht] |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
454 \interaction{hook.simple.init} |
379 | 455 % \caption{A simple hook that runs when a changeset is committed} |
456 \caption{$B%A%'%s%8%;%C%H$,%3%_%C%H$5$l$?;~$KF0:n$9$kC1=c$J%U%C%/(B} | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
457 \label{ex:hook:init} |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
458 \end{figure} |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
459 |
379 | 460 %All hooks follow the pattern in example~\ref{ex:hook:init}. You add |
461 %an entry to the \rcsection{hooks} section of your \hgrc\. On the left | |
462 %is the name of the event to trigger on; on the right is the action to | |
463 %take. As you can see, you can run an arbitrary shell command in a | |
464 %hook. Mercurial passes extra information to the hook using | |
465 %environment variables (look for \envar{HG\_NODE} in the example). | |
466 | |
467 $BA4$F$N%U%C%/$ONc(B~\ref{ex:hook:init}$B$HF1$8%Q%?!<%s$K$J$k!%(B \hgrc $B%U%!%$%k$N(B | |
468 \rcsection{hooks}$B%;%/%7%g%s$K%(%s%H%j$rDI2C$9$k!%:8JU$K%H%j%,!<$H$J$k%Y%s(B | |
469 $B%H$r5-=R$7!$1&JU$KBP1~$9$k%"%/%7%g%s$r5-=R$9$k!%Nc$K<($7$?DL$j!$%U%C%/$K(B | |
470 $B$OG$0U$N%7%'%k%3%^%s%I$r=q$/$3$H$,$G$-$k!%4D6-JQ?t$r@_Dj$9$k$3$H$G(B | |
471 Mercurial$B$+$i%U%C%/$KDI2C$N>pJs$rEO$9$3$H$,$G$-$k!%!JNc$N(B | |
472 \envar{HG\_NODE}$B$r;2>H!%!K(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
473 |
374 | 474 %\subsection{Performing multiple actions per event} |
475 \subsection{1$B$D$N%$%Y%s%H$KJ#?t$N%"%/%7%g%s$r9T$&(B} | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
476 |
379 | 477 %Quite often, you will want to define more than one hook for a |
478 %particular kind of event, as shown in example~\ref{ex:hook:ext}. | |
479 %Mercurial lets you do this by adding an \emph{extension} to the end of | |
480 %a hook's name. You extend a hook's name by giving the name of the | |
481 %hook, followed by a full stop (the ``\texttt{.}'' character), followed | |
482 %by some more text of your choosing. For example, Mercurial will run | |
483 %both \texttt{commit.foo} and \texttt{commit.bar} when the | |
484 %\texttt{commit} event occurs. | |
485 | |
486 $BNc(B~\ref{ex:hook:ext}$B$K<($7$?$h$&$K!$FCDj$N%$%Y%s%H$K(B2$B$D0J>e$N%U%C%/$rDj5A(B | |
487 $B$9$k$3$H$,I,MW$K$J$k$3$H$,B?$$$@$m$&!%(B Mercurial$B$G$O!$%U%C%/L>$N:G8e$K(B | |
488 \emph{$B3HD%;R(B}$B$rDI2C$9$k$3$H$G$3$l$,2DG=$K$J$k!%3HD%;R$rIU$1$k$K(B | |
489 $B$O!$(B``\texttt{.}'' $BJ8;z$H!$$3$l$KB3$/2?J8;z$+$+$i$J$kL>A0$r%U%C%/$K$D$1$l(B | |
490 $B$P$h$$!%Nc$($P(BMercurial$B$O(B\texttt{commit}$B%$%Y%s%H$,5/$-$?;~$K(B | |
491 \texttt{commit.foo}$B$H(B\texttt{commit.bar}$B%U%C%/$NN>J}$r8F$S=P$9!%(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
492 |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
493 \begin{figure}[ht] |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
494 \interaction{hook.simple.ext} |
379 | 495 % \caption{Defining a second \hook{commit} hook} |
496 \caption{2$BHVL\$N(B\hook{commit}$B%U%C%/$rDj5A$9$k(B} | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
497 \label{ex:hook:ext} |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
498 \end{figure} |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
499 |
379 | 500 %To give a well-defined order of execution when there are multiple |
501 %hooks defined for an event, Mercurial sorts hooks by extension, and | |
502 %executes the hook commands in this sorted order. In the above | |
503 %example, it will execute \texttt{commit.bar} before | |
504 %\texttt{commit.foo}, and \texttt{commit} before both. | |
505 | |
506 1$B$D$N%$%Y%s%H$KJ#?t$N%U%C%/$,Dj5A$5$l$F$$$k;~!$(BMercurial$B$O%U%C%/$r3HD%;R(B | |
507 $B$G%=!<%H$7!$%=!<%H$5$l$?=g=x$K=>$C$F%U%C%/$r<B9T$9$k!%>e5-$NNc$G$O(B | |
508 \texttt{commit}$B!$(B\texttt{commit.bar}$B!$(B\texttt{commit.foo}$B$N=g$K<B9T$9$k!%(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
509 |
379 | 510 %It is a good idea to use a somewhat descriptive extension when you |
511 %define a new hook. This will help you to remember what the hook was | |
512 %for. If the hook fails, you'll get an error message that contains the | |
513 %hook name and extension, so using a descriptive extension could give | |
514 %you an immediate hint as to why the hook failed (see | |
515 %section~\ref{sec:hook:perm} for an example). | |
516 | |
517 $B?7$7$$%U%C%/$rDj5A$9$k;~$K!$FbMF$r@bL@$9$k$h$&$J3HD%;R$rIU$1$k$N$O$h$$9M(B | |
518 $B$($G$"$k!%$3$&$9$k$3$H$K$h$C$F!$%U%C%/$NL\E*$,2?$J$N$+$r3P$($d$9$/$J$k!%(B | |
519 $B%U%C%/$,<:GT$7$?>l9g!$%(%i!<%a%C%;!<%8$K$O%U%C%/L>$H3HD%;R$,4^$^$l$k!%@b(B | |
520 $BL@E*$J3HD%;R$O%U%C%/$,<:GT$7$?M}M3$rCN$k$h$$<j$,$+$j$H$J$k!%!JNc(B | |
521 $B$O(B~\ref{sec:hook:perm}$B$r;2>H$N$3$H!%!K(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
522 |
374 | 523 %\subsection{Controlling whether an activity can proceed} |
524 \subsection{$BF0:n$,?J9T$G$-$k$+$I$&$+@)8f$9$k(B} | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
525 \label{sec:hook:perm} |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
526 |
379 | 527 %In our earlier examples, we used the \hook{commit} hook, which is |
528 %run after a commit has completed. This is one of several Mercurial | |
529 %hooks that run after an activity finishes. Such hooks have no way of | |
530 %influencing the activity itself. | |
531 | |
532 $BA0$NNc$G$O%3%_%C%H$,40N;$7$?8e$K<B9T$5$l$k(B\hook{commit}$B%U%C%/$rMQ$$$?!%$3(B | |
533 $B$l$O(BMercurial$B%U%C%/$N$&$A!$F0:n$,=*N;$7$?8e$K<B9T$5$l$k$b$N$N$&$A$N(B1$B$D$G(B | |
534 $B$"$k!%$3$N$h$&$J%U%C%/$O!$(BMercurial$B$NF0:n$=$N$b$N$K1F6A$r5Z$\$5$J$$!%(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
535 |
379 | 536 %Mercurial defines a number of events that occur before an activity |
537 %starts; or after it starts, but before it finishes. Hooks that | |
538 %trigger on these events have the added ability to choose whether the | |
539 %activity can continue, or will abort. | |
540 | |
541 Mercurial$B$OF0:n$N3+;OA0$d!$3+;O8e=*N;$9$k$^$G$N4V$KH/@8$9$k%$%Y%s%H$rB??t(B | |
542 $BDj5A$7$F$$$k!%$3$l$i$N%$%Y%s%H$G%H%j%,!<$5$l$k%U%C%/$O!$F0:n$rB39T$9$k$+(B | |
543 $BCfCG$9$k$+7h$a$k$3$H$,$G$-$k!%(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
544 |
379 | 545 %The \hook{pretxncommit} hook runs after a commit has all but |
546 %completed. In other words, the metadata representing the changeset | |
547 %has been written out to disk, but the transaction has not yet been | |
548 %allowed to complete. The \hook{pretxncommit} hook has the ability to | |
549 %decide whether the transaction can complete, or must be rolled back. | |
550 | |
551 \hook{pretxncommit}$B%U%C%/$O%3%_%C%H8e!$%3%_%C%H$N40N;A0$K8F$S=P$5$l$k!%(B | |
552 $B8@$$BX$($k$H!$%A%'%s%8%;%C%H$r<($9%a%?%G!<%?$,%G%#%9%/$K=q$-9~$^$l$?8e(B | |
553 $B$G!$%H%i%s%6%/%7%g%s$,40N;$9$kA0$K8F$S=P$5$l$k!%(B | |
554 \hook{pretxncommit}$B%U%C%/$O%H%i%s%6%/%7%g%s$r40N;$9$k$+!$%m!<%k%P%C%/$9(B | |
555 $B$k$+$r7hDj$9$k5!G=$,$"$k!%(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
556 |
379 | 557 %If the \hook{pretxncommit} hook exits with a status code of zero, the |
558 %transaction is allowed to complete; the commit finishes; and the | |
559 %\hook{commit} hook is run. If the \hook{pretxncommit} hook exits with | |
560 %a non-zero status code, the transaction is rolled back; the metadata | |
561 %representing the changeset is erased; and the \hook{commit} hook is | |
562 %not run. | |
563 | |
564 \hook{pretxncommit}$B%U%C%/$,%9%F!<%?%9%3!<%I(B0$B$G=*N;$9$k$H%H%i%s%6%/%7%g%s(B | |
565 $B$O40N;$9$k$3$H$,$G$-!$%3%_%C%H$,=*N;$7!$(B\hook{commit}$B%U%C%/$,8F$S=P$5$l$k!%(B | |
566 \hook{pretxncommit}$B%U%C%/$,Hs(B0$B$N%9%F!<%?%9%3!<%I$G=*N;$9$k$H!$%H%i%s%6%/(B | |
567 $B%7%g%s$O%m!<%k%P%C%/$5$l!$%A%'%s%8%;%C%H$r<($9%a%?%G!<%?$O>C5n$5$l$k!%$3(B | |
568 $B$N>l9g(B\hook{commit}$B%U%C%/$O8F$S=P$5$l$J$$!%(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
569 |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
570 \begin{figure}[ht] |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
571 \interaction{hook.simple.pretxncommit} |
379 | 572 % \caption{Using the \hook{pretxncommit} hook to control commits} |
573 \caption{$B%3%_%C%H$r@)8f$9$k$?$a$K(B\hook{pretxncommit}$B%U%C%/$r;HMQ$9$k(B} | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
574 \label{ex:hook:pretxncommit} |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
575 \end{figure} |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
576 |
379 | 577 %The hook in example~\ref{ex:hook:pretxncommit} checks that a commit |
578 %comment contains a bug ID. If it does, the commit can complete. If | |
579 %not, the commit is rolled back. | |
580 | |
581 ~\ref{ex:hook:pretxncommit}$B$O%3%_%C%H%3%a%s%H$,%P%0(BID$B$r4^$`$+$r%A%'%C%/(B | |
582 $B$9$k!%$b$74^$^$l$l$P%3%_%C%H$O40N;$9$k!%4^$^$J$$>l9g$O%3%_%C%H$O%m!<%k%P%C(B | |
583 $B%/$5$l$k!%(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
584 |
374 | 585 %\section{Writing your own hooks} |
586 \section{$B%*%j%8%J%k$N%U%C%/$r=q$/(B} | |
37 | 587 |
379 | 588 %When you are writing a hook, you might find it useful to run Mercurial |
589 %either with the \hggopt{-v} option, or the \rcitem{ui}{verbose} config | |
590 %item set to ``true''. When you do so, Mercurial will print a message | |
591 %before it calls each hook. | |
592 | |
593 $B%U%C%/$r=q$/>l9g!$(BMercurial$B$r(B\hggopt{-v}$B%*%W%7%g%s$rIU$1$?$j(B | |
594 \rcitem{ui}{verbose}$B@_Dj9`L\$r(B``true''$B$K@_Dj$9$k$3$H$OLr$KN)$D!%$3$N>l(B | |
595 $B9g!$(BMercurial$B$O3F!9$N%U%C%/$r8F$VA0$K%a%C%;!<%8$rI=<($9$k!%(B | |
37 | 596 |
374 | 597 %\subsection{Choosing how your hook should run} |
598 \subsection{$B%U%C%/$,$NF0:nJ}K!$rA*$V(B} | |
37 | 599 \label{sec:hook:lang} |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
600 |
379 | 601 %You can write a hook either as a normal program---typically a shell |
602 %script---or as a Python function that is executed within the Mercurial | |
603 %process. | |
604 | |
605 $B%U%C%/$O%7%'%k%9%/%j%W%H$N$h$&$JDL>o$N%W%m%0%i%`$H$7$F=q$/$3$H$b$G$-$k$7!$(B | |
606 Mercurial$B%W%m%;%9$NFbIt$G8F$S=P$5$l$k(BPython$B4X?t$H$7$F=q$/$3$H$b$G$-$k!%(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
607 |
379 | 608 %Writing a hook as an external program has the advantage that it |
609 %requires no knowledge of Mercurial's internals. You can call normal | |
610 %Mercurial commands to get any added information you need. The | |
611 %trade-off is that external hooks are slower than in-process hooks. | |
612 | |
613 $B%U%C%/$r30It%W%m%0%i%`$H$7$F=q$/MxE@$O(BMercurial$B$NFbItF0:n$rCN$i$J$/$F$b%U%C(B | |
614 $B%/$,=q$1$k$3$H$G$"$k!%I,MW$JDI2C$N>pJs$rF@$k$?$a$KDL>o$N(BMercurial$B%3%^%s%I(B | |
615 $B$r8F$S=P$9$3$H$,$G$-$k!%30It%U%C%/$O%W%m%;%9Fb%U%C%/$h$j$bDcB.$J$N$,%H%l!<(B | |
616 $B%I%*%U$G$"$k!%(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
617 |
379 | 618 %An in-process Python hook has complete access to the Mercurial API, |
619 %and does not ``shell out'' to another process, so it is inherently | |
620 %faster than an external hook. It is also easier to obtain much of the | |
621 %information that a hook requires by using the Mercurial API than by | |
622 %running Mercurial commands. | |
623 | |
624 Python$B%W%m%;%9Fb%U%C%/$O(BMercurial API$B$X$N40A4$J%"%/%;%9$,2DG=$G$"$k!%(B | |
625 $BB>$N%W%m%;%9$r@8@.$9$k$3$H$,$J$$$?$a!$K\<AE*$K30It%U%C%/$h$j$b9bB.$G$"$k!%(B | |
626 $B%U%C%/$,I,MW$H$9$k>pJs$NBgH>$O!$(BMercurial$B%3%^%s%I$r<B9T$9$k$h$j$b(B | |
627 Mercurial API$B$r;H$C$F=8$a$kJ}$,MF0W$$!%(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
628 |
379 | 629 %If you are comfortable with Python, or require high performance, |
630 %writing your hooks in Python may be a good choice. However, when you | |
631 %have a straightforward hook to write and you don't need to care about | |
632 %performance (probably the majority of hooks), a shell script is | |
633 %perfectly fine. | |
634 | |
635 Python$B$r;H$$47$l$F$$$?$j!$9b$$@-G=$,I,MW$J$i$P!$%U%C%/$r(BPython$B$G=q$/$N$,(B | |
636 $B$h$$$@$m$&!%$7$+$7=q$3$&$H$9$k$N$,C1=cL@2r$J%U%C%/$G!$!JB?$/$N%U%C%/$,$=(B | |
637 $B$&$G$"$k$h$&$K!K@-G=$K$OFC$K4X?4$,$J$$>l9g!$%7%'%k%9%/%j%W%H$H$7$F=q$$$F(B | |
638 $B$bA4$/LdBj$J$$!%(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
639 |
374 | 640 %\subsection{Hook parameters} |
641 \subsection{$B%U%C%/%Q%i%a!<%?(B} | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
642 \label{sec:hook:param} |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
643 |
381 | 644 %Mercurial calls each hook with a set of well-defined parameters. In |
645 %Python, a parameter is passed as a keyword argument to your hook | |
646 %function. For an external program, a parameter is passed as an | |
647 %environment variable. | |
648 | |
649 Mercurial$B$O3F!9$N%U%C%/$N8F=P$7$N:]$K$-$A$s$HDj5A$5$l$?%Q%i%a!<%?$rEO(B | |
650 $B$9!%(BPython$B$G$O%Q%i%a!<%?$O%-!<%o!<%I0z?t$H$7$F%U%C%/4X?t$KEO$5$l$k!%30It(B | |
651 $B%W%m%0%i%`$K$O!$%Q%i%a!<%?$O4D6-JQ?t$H$7$FEO$5$l$k!%(B | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
652 |
381 | 653 %Whether your hook is written in Python or as a shell script, the |
654 %hook-specific parameter names and values will be the same. A boolean | |
655 %parameter will be represented as a boolean value in Python, but as the | |
656 %number 1 (for ``true'') or 0 (for ``false'') as an environment | |
657 %variable for an external hook. If a hook parameter is named | |
658 %\texttt{foo}, the keyword argument for a Python hook will also be | |
659 %named \texttt{foo}, while the environment variable for an external | |
660 %hook will be named \texttt{HG\_FOO}. | |
661 | |
662 $B%U%C%/$,(BPython$B$G=q$+$l$F$$$k$+!$%7%'%k%9%/%j%W%H$7$F=q$+$l$F$$$k$+$K4X$o(B | |
663 $B$i$:!$%U%C%/8GM-$N%Q%i%a!<%?L>$HCM$OF1$8$b$N$,MQ$$$i$l$k!%%V!<%k7?%Q%i%a!<(B | |
664 $B%?$O(BPython$B$G$O%V!<%kCM$H$7$F07$o$l$k$,!$30It%U%C%/$N$?$a$N4D6-JQ?t$G(B | |
665 $B$O!$(B1$B!J(B``$B??(B''$B!K$^$?$O(B0$B!J(B``$B56(B''$B!K$H$$$&?tCM$H$7$F07$o$l$k!%(B | |
666 $B%U%C%/%Q%i%a!<%?$K(B\texttt{foo}$B$H$$$&L>A0$,IU$1$i$l$F$$$k$H$-!$(BPython$B%U%C(B | |
667 $B%/$X$N%-!<%o!<%I0z?t$bF1$8(B\texttt{foo}$B$H$$$&L>A0$K$J$k!%(B | |
668 $B0lJ}!$30It%U%C%/$N$?$a$N4D6-JQ?t$G$O(B\texttt{HG\_FOO}$B$H$$$&L>A0$K$J$k!%(B | |
37 | 669 |
374 | 670 %\subsection{Hook return values and activity control} |
671 \subsection{$B%U%C%/$NLa$jCM$HF0:n$N@)8f(B} | |
37 | 672 |
381 | 673 %A hook that executes successfully must exit with a status of zero if |
674 %external, or return boolean ``false'' if in-process. Failure is | |
675 %indicated with a non-zero exit status from an external hook, or an | |
676 %in-process hook returning boolean ``true''. If an in-process hook | |
677 %raises an exception, the hook is considered to have failed. | |
37 | 678 |
381 | 679 %For a hook that controls whether an activity can proceed, zero/false |
680 %means ``allow'', while non-zero/true/exception means ``deny''. | |
37 | 681 |
374 | 682 %\subsection{Writing an external hook} |
683 \subsection{$B30It%U%C%/$r:n@.$9$k(B} | |
37 | 684 |
381 | 685 %When you define an external hook in your \hgrc\ and the hook is run, |
686 %its value is passed to your shell, which interprets it. This means | |
687 %that you can use normal shell constructs in the body of the hook. | |
688 | |
689 $B30It%U%C%/$r(B \hgrc\ $B$GDj5A$7!$<B9T$9$k>l9g!$%U%C%/$O%7%'%k$KEO$5$l$kCM$r(B | |
690 $BJQ49$9$?$a!$%U%C%/$NK\BNItJ,$G%7%'%k%9%/%j%W%H$r5-=R$9$k$3$H$,$G$-$k!%(B | |
37 | 691 |
381 | 692 %An executable hook is always run with its current directory set to a |
693 %repository's root directory. | |
694 | |
695 $B30It%U%C%/$O>o$K%j%]%8%H%j$N%k!<%H%G%#%l%/%H%j$r%+%l%s%H%G%#%l%/%H%j$H$7(B | |
696 $B$F<B9T$5$l$k!%(B | |
697 | |
698 %Each hook parameter is passed in as an environment variable; the name | |
699 %is upper-cased, and prefixed with the string ``\texttt{HG\_}''. | |
37 | 700 |
381 | 701 $B3F!9$N%U%C%/%Q%i%a!<%?$O4D6-JQ?t$H$7$FEO$5$l$k!%$9$J$o$A!$L>A0$OA4$FBgJ8(B |
702 $B;z$K$J$j!$(B``\texttt{HG\_}''$B$H$$$&@\F,<-$,IU$1$i$l$k!%(B | |
37 | 703 |
381 | 704 %With the exception of hook parameters, Mercurial does not set or |
705 %modify any environment variables when running a hook. This is useful | |
706 %to remember if you are writing a site-wide hook that may be run by a | |
707 %number of different users with differing environment variables set. | |
708 %In multi-user situations, you should not rely on environment variables | |
709 %being set to the values you have in your environment when testing the | |
710 %hook. | |
711 | |
712 $B%U%C%/%Q%i%a!<%?$rNc30$H$7$F!$(BMercurial$B$O%U%C%/$r<B9T$9$k:]$K4D6-JQ?t$NDj(B | |
713 $B5A$dJQ99$r9T$o$J$$!%B?$/$N%f!<%6$,<B9T$9$k%5%$%H%o%$%I$N%U%C%/$r:n@.$9$k(B | |
714 $B>l9g!$%f!<%6$,@_Dj$7$F$$$k4D6-JQ?t$O0[$J$k$3$H$r5-21$7$F$*$/$Y$-$G$"$k!%(B | |
715 $B%^%k%A%f!<%64D6-$N>l9g!$%U%C%/$r;n$9:]$K$"$J$?$,@_Dj$7$F$$$k4D6-JQ?t$K0M(B | |
716 $BB8$9$Y$-$G$O$J$$!%(B | |
37 | 717 |
374 | 718 %\subsection{Telling Mercurial to use an in-process hook} |
719 \subsection{Mercurial$B$K%W%m%;%9Fb%U%C%/$r;H$&$h$&$K;X<($9$k(B} | |
37 | 720 |
721 The \hgrc\ syntax for defining an in-process hook is slightly | |
722 different than for an executable hook. The value of the hook must | |
723 start with the text ``\texttt{python:}'', and continue with the | |
724 fully-qualified name of a callable object to use as the hook's value. | |
725 | |
726 The module in which a hook lives is automatically imported when a hook | |
727 is run. So long as you have the module name and \envar{PYTHONPATH} | |
728 right, it should ``just work''. | |
729 | |
730 The following \hgrc\ example snippet illustrates the syntax and | |
731 meaning of the notions we just described. | |
732 \begin{codesample2} | |
733 [hooks] | |
734 commit.example = python:mymodule.submodule.myhook | |
735 \end{codesample2} | |
736 When Mercurial runs the \texttt{commit.example} hook, it imports | |
737 \texttt{mymodule.submodule}, looks for the callable object named | |
738 \texttt{myhook}, and calls it. | |
739 | |
374 | 740 %\subsection{Writing an in-process hook} |
741 \subsection{$B%W%m%;%9Fb%U%C%/$r:n@.$9$k(B} | |
37 | 742 |
743 The simplest in-process hook does nothing, but illustrates the basic | |
744 shape of the hook API: | |
745 \begin{codesample2} | |
746 def myhook(ui, repo, **kwargs): | |
747 pass | |
748 \end{codesample2} | |
749 The first argument to a Python hook is always a | |
750 \pymodclass{mercurial.ui}{ui} object. The second is a repository object; | |
751 at the moment, it is always an instance of | |
752 \pymodclass{mercurial.localrepo}{localrepository}. Following these two | |
753 arguments are other keyword arguments. Which ones are passed in | |
754 depends on the hook being called, but a hook can ignore arguments it | |
755 doesn't care about by dropping them into a keyword argument dict, as | |
756 with \texttt{**kwargs} above. | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
757 |
374 | 758 %\section{Some hook examples} |
759 \section{$B%U%C%/$NNc(B} | |
44
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
760 |
374 | 761 %\subsection{Writing meaningful commit messages} |
762 \subsection{$B0UL#$N$"$k%3%_%C%H%a%C%;!<%8$r=PNO$9$k(B} | |
49 | 763 |
764 It's hard to imagine a useful commit message being very short. The | |
155
914babdc99c8
run-example: better error if bogus section name found.
Bryan O'Sullivan <bos@serpentine.com>
parents:
135
diff
changeset
|
765 simple \hook{pretxncommit} hook of figure~\ref{ex:hook:msglen.go} |
49 | 766 will prevent you from committing a changeset with a message that is |
767 less than ten bytes long. | |
768 | |
769 \begin{figure}[ht] | |
155
914babdc99c8
run-example: better error if bogus section name found.
Bryan O'Sullivan <bos@serpentine.com>
parents:
135
diff
changeset
|
770 \interaction{hook.msglen.go} |
49 | 771 \caption{A hook that forbids overly short commit messages} |
155
914babdc99c8
run-example: better error if bogus section name found.
Bryan O'Sullivan <bos@serpentine.com>
parents:
135
diff
changeset
|
772 \label{ex:hook:msglen.go} |
49 | 773 \end{figure} |
774 | |
374 | 775 %\subsection{Checking for trailing whitespace} |
776 \subsection{$B$V$i2<$,$C$?6uGr$r%A%'%C%/$9$k(B} | |
44
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
777 |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
778 An interesting use of a commit-related hook is to help you to write |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
779 cleaner code. A simple example of ``cleaner code'' is the dictum that |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
780 a change should not add any new lines of text that contain ``trailing |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
781 whitespace''. Trailing whitespace is a series of space and tab |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
782 characters at the end of a line of text. In most cases, trailing |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
783 whitespace is unnecessary, invisible noise, but it is occasionally |
49 | 784 problematic, and people often prefer to get rid of it. |
44
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
785 |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
786 You can use either the \hook{precommit} or \hook{pretxncommit} hook to |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
787 tell whether you have a trailing whitespace problem. If you use the |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
788 \hook{precommit} hook, the hook will not know which files you are |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
789 committing, so it will have to check every modified file in the |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
790 repository for trailing white space. If you want to commit a change |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
791 to just the file \filename{foo}, but the file \filename{bar} contains |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
792 trailing whitespace, doing a check in the \hook{precommit} hook will |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
793 prevent you from committing \filename{foo} due to the problem with |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
794 \filename{bar}. This doesn't seem right. |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
795 |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
796 Should you choose the \hook{pretxncommit} hook, the check won't occur |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
797 until just before the transaction for the commit completes. This will |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
798 allow you to check for problems only the exact files that are being |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
799 committed. However, if you entered the commit message interactively |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
800 and the hook fails, the transaction will roll back; you'll have to |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
801 re-enter the commit message after you fix the trailing whitespace and |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
802 run \hgcmd{commit} again. |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
803 |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
804 \begin{figure}[ht] |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
805 \interaction{hook.ws.simple} |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
806 \caption{A simple hook that checks for trailing whitespace} |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
807 \label{ex:hook:ws.simple} |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
808 \end{figure} |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
809 |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
810 Figure~\ref{ex:hook:ws.simple} introduces a simple \hook{pretxncommit} |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
811 hook that checks for trailing whitespace. This hook is short, but not |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
812 very helpful. It exits with an error status if a change adds a line |
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
813 with trailing whitespace to any file, but does not print any |
49 | 814 information that might help us to identify the offending file or |
815 line. It also has the nice property of not paying attention to | |
816 unmodified lines; only lines that introduce new trailing whitespace | |
817 cause problems. | |
818 | |
819 \begin{figure}[ht] | |
820 \interaction{hook.ws.better} | |
821 \caption{A better trailing whitespace hook} | |
822 \label{ex:hook:ws.better} | |
823 \end{figure} | |
824 | |
825 The example of figure~\ref{ex:hook:ws.better} is much more complex, | |
826 but also more useful. It parses a unified diff to see if any lines | |
827 add trailing whitespace, and prints the name of the file and the line | |
828 number of each such occurrence. Even better, if the change adds | |
829 trailing whitespace, this hook saves the commit comment and prints the | |
830 name of the save file before exiting and telling Mercurial to roll the | |
831 transaction back, so you can use | |
832 \hgcmdargs{commit}{\hgopt{commit}{-l}~\emph{filename}} to reuse the | |
833 saved commit message once you've corrected the problem. | |
834 | |
835 As a final aside, note in figure~\ref{ex:hook:ws.better} the use of | |
836 \command{perl}'s in-place editing feature to get rid of trailing | |
837 whitespace from a file. This is concise and useful enough that I will | |
838 reproduce it here. | |
839 \begin{codesample2} | |
54 | 840 perl -pi -e 's,\\s+\$,,' filename |
49 | 841 \end{codesample2} |
842 | |
374 | 843 %\section{Bundled hooks} |
844 \section{$BAH$_9g$o$;%U%C%/(B} | |
49 | 845 |
846 Mercurial ships with several bundled hooks. You can find them in the | |
847 \dirname{hgext} directory of a Mercurial source tree. If you are | |
848 using a Mercurial binary package, the hooks will be located in the | |
849 \dirname{hgext} directory of wherever your package installer put | |
850 Mercurial. | |
851 | |
374 | 852 %\subsection{\hgext{acl}---access control for parts of a repository} |
853 \subsection{\hgext{acl}---$B%j%]%8%H%j$NItJ,$KBP$9$k%"%/%;%9%3%s%H%m!<%k(B} | |
49 | 854 |
855 The \hgext{acl} extension lets you control which remote users are | |
856 allowed to push changesets to a networked server. You can protect any | |
857 portion of a repository (including the entire repo), so that a | |
858 specific remote user can push changes that do not affect the protected | |
859 portion. | |
860 | |
861 This extension implements access control based on the identity of the | |
862 user performing a push, \emph{not} on who committed the changesets | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
863 they're pushing. It makes sense to use this hook only if you have a |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
864 locked-down server environment that authenticates remote users, and |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
865 you want to be sure that only specific users are allowed to push |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
866 changes to that server. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
867 |
374 | 868 %\subsubsection{Configuring the \hook{acl} hook} |
869 \subsubsection{\hook{acl}$B%U%C%/$N@_Dj(B} | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
870 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
871 In order to manage incoming changesets, the \hgext{acl} hook must be |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
872 used as a \hook{pretxnchangegroup} hook. This lets it see which files |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
873 are modified by each incoming changeset, and roll back a group of |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
874 changesets if they modify ``forbidden'' files. Example: |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
875 \begin{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
876 [hooks] |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
877 pretxnchangegroup.acl = python:hgext.acl.hook |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
878 \end{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
879 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
880 The \hgext{acl} extension is configured using three sections. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
881 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
882 The \rcsection{acl} section has only one entry, \rcitem{acl}{sources}, |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
883 which lists the sources of incoming changesets that the hook should |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
884 pay attention to. You don't normally need to configure this section. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
885 \begin{itemize} |
64
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
886 \item[\rcitem{acl}{serve}] Control incoming changesets that are arriving |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
887 from a remote repository over http or ssh. This is the default |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
888 value of \rcitem{acl}{sources}, and usually the only setting you'll |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
889 need for this configuration item. |
64
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
890 \item[\rcitem{acl}{pull}] Control incoming changesets that are |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
891 arriving via a pull from a local repository. |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
892 \item[\rcitem{acl}{push}] Control incoming changesets that are |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
893 arriving via a push from a local repository. |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
894 \item[\rcitem{acl}{bundle}] Control incoming changesets that are |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
895 arriving from another repository via a bundle. |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
896 \end{itemize} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
897 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
898 The \rcsection{acl.allow} section controls the users that are allowed to |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
899 add changesets to the repository. If this section is not present, all |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
900 users that are not explicitly denied are allowed. If this section is |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
901 present, all users that are not explicitly allowed are denied (so an |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
902 empty section means that all users are denied). |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
903 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
904 The \rcsection{acl.deny} section determines which users are denied |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
905 from adding changesets to the repository. If this section is not |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
906 present or is empty, no users are denied. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
907 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
908 The syntaxes for the \rcsection{acl.allow} and \rcsection{acl.deny} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
909 sections are identical. On the left of each entry is a glob pattern |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
910 that matches files or directories, relative to the root of the |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
911 repository; on the right, a user name. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
912 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
913 In the following example, the user \texttt{docwriter} can only push |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
914 changes to the \dirname{docs} subtree of the repository, while |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
915 \texttt{intern} can push changes to any file or directory except |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
916 \dirname{source/sensitive}. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
917 \begin{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
918 [acl.allow] |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
919 docs/** = docwriter |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
920 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
921 [acl.deny] |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
922 source/sensitive/** = intern |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
923 \end{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
924 |
374 | 925 %\subsubsection{Testing and troubleshooting} |
926 \subsubsection{$B%F%9%H$HLdBj2r7h(B} | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
927 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
928 If you want to test the \hgext{acl} hook, run it with Mercurial's |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
929 debugging output enabled. Since you'll probably be running it on a |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
930 server where it's not convenient (or sometimes possible) to pass in |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
931 the \hggopt{--debug} option, don't forget that you can enable |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
932 debugging output in your \hgrc: |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
933 \begin{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
934 [ui] |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
935 debug = true |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
936 \end{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
937 With this enabled, the \hgext{acl} hook will print enough information |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
938 to let you figure out why it is allowing or forbidding pushes from |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
939 specific users. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
940 |
374 | 941 %\subsection{\hgext{bugzilla}---integration with Bugzilla} |
942 \subsection{\hgext{bugzilla}---Bugzilla$B$X$NE}9g(B} | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
943 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
944 The \hgext{bugzilla} extension adds a comment to a Bugzilla bug |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
945 whenever it finds a reference to that bug ID in a commit comment. You |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
946 can install this hook on a shared server, so that any time a remote |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
947 user pushes changes to this server, the hook gets run. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
948 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
949 It adds a comment to the bug that looks like this (you can configure |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
950 the contents of the comment---see below): |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
951 \begin{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
952 Changeset aad8b264143a, made by Joe User <joe.user@domain.com> in |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
953 the frobnitz repository, refers to this bug. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
954 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
955 For complete details, see |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
956 http://hg.domain.com/frobnitz?cmd=changeset;node=aad8b264143a |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
957 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
958 Changeset description: |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
959 Fix bug 10483 by guarding against some NULL pointers |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
960 \end{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
961 The value of this hook is that it automates the process of updating a |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
962 bug any time a changeset refers to it. If you configure the hook |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
963 properly, it makes it easy for people to browse straight from a |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
964 Bugzilla bug to a changeset that refers to that bug. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
965 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
966 You can use the code in this hook as a starting point for some more |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
967 exotic Bugzilla integration recipes. Here are a few possibilities: |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
968 \begin{itemize} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
969 \item Require that every changeset pushed to the server have a valid |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
970 bug~ID in its commit comment. In this case, you'd want to configure |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
971 the hook as a \hook{pretxncommit} hook. This would allow the hook |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
972 to reject changes that didn't contain bug IDs. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
973 \item Allow incoming changesets to automatically modify the |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
974 \emph{state} of a bug, as well as simply adding a comment. For |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
975 example, the hook could recognise the string ``fixed bug 31337'' as |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
976 indicating that it should update the state of bug 31337 to |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
977 ``requires testing''. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
978 \end{itemize} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
979 |
374 | 980 %\subsubsection{Configuring the \hook{bugzilla} hook} |
981 \subsubsection{\hook{bugzilla}$B%U%C%/$N@_Dj(B} | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
982 \label{sec:hook:bugzilla:config} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
983 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
984 You should configure this hook in your server's \hgrc\ as an |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
985 \hook{incoming} hook, for example as follows: |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
986 \begin{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
987 [hooks] |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
988 incoming.bugzilla = python:hgext.bugzilla.hook |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
989 \end{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
990 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
991 Because of the specialised nature of this hook, and because Bugzilla |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
992 was not written with this kind of integration in mind, configuring |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
993 this hook is a somewhat involved process. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
994 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
995 Before you begin, you must install the MySQL bindings for Python on |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
996 the host(s) where you'll be running the hook. If this is not |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
997 available as a binary package for your system, you can download it |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
998 from~\cite{web:mysql-python}. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
999 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1000 Configuration information for this hook lives in the |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1001 \rcsection{bugzilla} section of your \hgrc. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1002 \begin{itemize} |
64
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1003 \item[\rcitem{bugzilla}{version}] The version of Bugzilla installed on |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1004 the server. The database schema that Bugzilla uses changes |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1005 occasionally, so this hook has to know exactly which schema to use. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1006 At the moment, the only version supported is \texttt{2.16}. |
64
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1007 \item[\rcitem{bugzilla}{host}] The hostname of the MySQL server that |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1008 stores your Bugzilla data. The database must be configured to allow |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1009 connections from whatever host you are running the \hook{bugzilla} |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1010 hook on. |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1011 \item[\rcitem{bugzilla}{user}] The username with which to connect to |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1012 the MySQL server. The database must be configured to allow this |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1013 user to connect from whatever host you are running the |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1014 \hook{bugzilla} hook on. This user must be able to access and |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1015 modify Bugzilla tables. The default value of this item is |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1016 \texttt{bugs}, which is the standard name of the Bugzilla user in a |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1017 MySQL database. |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1018 \item[\rcitem{bugzilla}{password}] The MySQL password for the user you |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1019 configured above. This is stored as plain text, so you should make |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1020 sure that unauthorised users cannot read the \hgrc\ file where you |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1021 store this information. |
64
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1022 \item[\rcitem{bugzilla}{db}] The name of the Bugzilla database on the |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1023 MySQL server. The default value of this item is \texttt{bugs}, |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1024 which is the standard name of the MySQL database where Bugzilla |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1025 stores its data. |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1026 \item[\rcitem{bugzilla}{notify}] If you want Bugzilla to send out a |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1027 notification email to subscribers after this hook has added a |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1028 comment to a bug, you will need this hook to run a command whenever |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1029 it updates the database. The command to run depends on where you |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1030 have installed Bugzilla, but it will typically look something like |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1031 this, if you have Bugzilla installed in |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1032 \dirname{/var/www/html/bugzilla}: |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1033 \begin{codesample4} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1034 cd /var/www/html/bugzilla && ./processmail %s nobody@nowhere.com |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1035 \end{codesample4} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1036 The Bugzilla \texttt{processmail} program expects to be given a |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1037 bug~ID (the hook replaces ``\texttt{\%s}'' with the bug~ID) and an |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1038 email address. It also expects to be able to write to some files in |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1039 the directory that it runs in. If Bugzilla and this hook are not |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1040 installed on the same machine, you will need to find a way to run |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1041 \texttt{processmail} on the server where Bugzilla is installed. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1042 \end{itemize} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1043 |
374 | 1044 %\subsubsection{Mapping committer names to Bugzilla user names} |
1045 \subsubsection{$B%3%_%C%H<T$NL>A0$r(BBugzilla$B$N%f!<%6L>$X%^%C%W$9$k(B} | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1046 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1047 By default, the \hgext{bugzilla} hook tries to use the email address |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1048 of a changeset's committer as the Bugzilla user name with which to |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1049 update a bug. If this does not suit your needs, you can map committer |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1050 email addresses to Bugzilla user names using a \rcsection{usermap} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1051 section. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1052 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1053 Each item in the \rcsection{usermap} section contains an email address |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1054 on the left, and a Bugzilla user name on the right. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1055 \begin{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1056 [usermap] |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1057 jane.user@example.com = jane |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1058 \end{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1059 You can either keep the \rcsection{usermap} data in a normal \hgrc, or |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1060 tell the \hgext{bugzilla} hook to read the information from an |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1061 external \filename{usermap} file. In the latter case, you can store |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1062 \filename{usermap} data by itself in (for example) a user-modifiable |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1063 repository. This makes it possible to let your users maintain their |
64
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1064 own \rcitem{bugzilla}{usermap} entries. The main \hgrc\ file might |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1065 look like this: |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1066 \begin{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1067 # regular hgrc file refers to external usermap file |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1068 [bugzilla] |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1069 usermap = /home/hg/repos/userdata/bugzilla-usermap.conf |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1070 \end{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1071 While the \filename{usermap} file that it refers to might look like |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1072 this: |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1073 \begin{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1074 # bugzilla-usermap.conf - inside a hg repository |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1075 [usermap] |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1076 stephanie@example.com = steph |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1077 \end{codesample2} |
49 | 1078 |
374 | 1079 %\subsubsection{Configuring the text that gets added to a bug} |
1080 \subsubsection{$B%P%0$KDI2C$5$l$?J8;zNs$r@_Dj$9$k(B} | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1081 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1082 You can configure the text that this hook adds as a comment; you |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1083 specify it in the form of a Mercurial template. Several \hgrc\ |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1084 entries (still in the \rcsection{bugzilla} section) control this |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1085 behaviour. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1086 \begin{itemize} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1087 \item[\texttt{strip}] The number of leading path elements to strip |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1088 from a repository's path name to construct a partial path for a URL. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1089 For example, if the repositories on your server live under |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1090 \dirname{/home/hg/repos}, and you have a repository whose path is |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1091 \dirname{/home/hg/repos/app/tests}, then setting \texttt{strip} to |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1092 \texttt{4} will give a partial path of \dirname{app/tests}. The |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1093 hook will make this partial path available when expanding a |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1094 template, as \texttt{webroot}. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1095 \item[\texttt{template}] The text of the template to use. In addition |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1096 to the usual changeset-related variables, this template can use |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1097 \texttt{hgweb} (the value of the \texttt{hgweb} configuration item |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1098 above) and \texttt{webroot} (the path constructed using |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1099 \texttt{strip} above). |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1100 \end{itemize} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1101 |
64
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1102 In addition, you can add a \rcitem{web}{baseurl} item to the |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1103 \rcsection{web} section of your \hgrc. The \hgext{bugzilla} hook will |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1104 make this available when expanding a template, as the base string to |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1105 use when constructing a URL that will let users browse from a Bugzilla |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1106 comment to view a changeset. Example: |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1107 \begin{codesample2} |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1108 [web] |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1109 baseurl = http://hg.domain.com/ |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1110 \end{codesample2} |
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1111 |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1112 Here is an example set of \hgext{bugzilla} hook config information. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1113 \begin{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1114 [bugzilla] |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1115 host = bugzilla.example.com |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1116 password = mypassword |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1117 version = 2.16 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1118 # server-side repos live in /home/hg/repos, so strip 4 leading |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1119 # separators |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1120 strip = 4 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1121 hgweb = http://hg.example.com/ |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1122 usermap = /home/hg/repos/notify/bugzilla.conf |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1123 template = Changeset \{node|short\}, made by \{author\} in the \{webroot\} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1124 repo, refers to this bug.\\nFor complete details, see |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1125 \{hgweb\}\{webroot\}?cmd=changeset;node=\{node|short\}\\nChangeset |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1126 description:\\n\\t\{desc|tabindent\} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1127 \end{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1128 |
374 | 1129 %\subsubsection{Testing and troubleshooting} |
1130 \subsubsection{$B%F%9%H$HLdBj2r7h(B} | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1131 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1132 The most common problems with configuring the \hgext{bugzilla} hook |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1133 relate to running Bugzilla's \filename{processmail} script and mapping |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1134 committer names to user names. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1135 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1136 Recall from section~\ref{sec:hook:bugzilla:config} above that the user |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1137 that runs the Mercurial process on the server is also the one that |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1138 will run the \filename{processmail} script. The |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1139 \filename{processmail} script sometimes causes Bugzilla to write to |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1140 files in its configuration directory, and Bugzilla's configuration |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1141 files are usually owned by the user that your web server runs under. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1142 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1143 You can cause \filename{processmail} to be run with the suitable |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1144 user's identity using the \command{sudo} command. Here is an example |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1145 entry for a \filename{sudoers} file. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1146 \begin{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1147 hg_user = (httpd_user) NOPASSWD: /var/www/html/bugzilla/processmail-wrapper %s |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1148 \end{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1149 This allows the \texttt{hg\_user} user to run a |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1150 \filename{processmail-wrapper} program under the identity of |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1151 \texttt{httpd\_user}. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1152 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1153 This indirection through a wrapper script is necessary, because |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1154 \filename{processmail} expects to be run with its current directory |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1155 set to wherever you installed Bugzilla; you can't specify that kind of |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1156 constraint in a \filename{sudoers} file. The contents of the wrapper |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1157 script are simple: |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1158 \begin{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1159 #!/bin/sh |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1160 cd `dirname $0` && ./processmail "$1" nobody@example.com |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1161 \end{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1162 It doesn't seem to matter what email address you pass to |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1163 \filename{processmail}. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1164 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1165 If your \rcsection{usermap} is not set up correctly, users will see an |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1166 error message from the \hgext{bugzilla} hook when they push changes |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1167 to the server. The error message will look like this: |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1168 \begin{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1169 cannot find bugzilla user id for john.q.public@example.com |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1170 \end{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1171 What this means is that the committer's address, |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1172 \texttt{john.q.public@example.com}, is not a valid Bugzilla user name, |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1173 nor does it have an entry in your \rcsection{usermap} that maps it to |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1174 a valid Bugzilla user name. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1175 |
374 | 1176 %\subsection{\hgext{notify}---send email notifications} |
1177 \subsection{\hgext{notify}---$B%a!<%k$GDLCN$r9T$&(B} | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1178 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1179 Although Mercurial's built-in web server provides RSS feeds of changes |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1180 in every repository, many people prefer to receive change |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1181 notifications via email. The \hgext{notify} hook lets you send out |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1182 notifications to a set of email addresses whenever changesets arrive |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1183 that those subscribers are interested in. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1184 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1185 As with the \hgext{bugzilla} hook, the \hgext{notify} hook is |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1186 template-driven, so you can customise the contents of the notification |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1187 messages that it sends. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1188 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1189 By default, the \hgext{notify} hook includes a diff of every changeset |
63 | 1190 that it sends out; you can limit the size of the diff, or turn this |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1191 feature off entirely. It is useful for letting subscribers review |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1192 changes immediately, rather than clicking to follow a URL. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1193 |
374 | 1194 %\subsubsection{Configuring the \hgext{notify} hook} |
1195 \subsubsection{\hgext{notify}$B%U%C%/$N@_Dj(B} | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1196 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1197 You can set up the \hgext{notify} hook to send one email message per |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1198 incoming changeset, or one per incoming group of changesets (all those |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1199 that arrived in a single pull or push). |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1200 \begin{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1201 [hooks] |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1202 # send one email per group of changes |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1203 changegroup.notify = python:hgext.notify.hook |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1204 # send one email per change |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1205 incoming.notify = python:hgext.notify.hook |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1206 \end{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1207 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1208 Configuration information for this hook lives in the |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1209 \rcsection{notify} section of a \hgrc\ file. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1210 \begin{itemize} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1211 \item[\rcitem{notify}{test}] By default, this hook does not send out |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1212 email at all; instead, it prints the message that it \emph{would} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1213 send. Set this item to \texttt{false} to allow email to be sent. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1214 The reason that sending of email is turned off by default is that it |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1215 takes several tries to configure this extension exactly as you would |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1216 like, and it would be bad form to spam subscribers with a number of |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1217 ``broken'' notifications while you debug your configuration. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1218 \item[\rcitem{notify}{config}] The path to a configuration file that |
63 | 1219 contains subscription information. This is kept separate from the |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1220 main \hgrc\ so that you can maintain it in a repository of its own. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1221 People can then clone that repository, update their subscriptions, |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1222 and push the changes back to your server. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1223 \item[\rcitem{notify}{strip}] The number of leading path separator |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1224 characters to strip from a repository's path, when deciding whether |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1225 a repository has subscribers. For example, if the repositories on |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1226 your server live in \dirname{/home/hg/repos}, and \hgext{notify} is |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1227 considering a repository named \dirname{/home/hg/repos/shared/test}, |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1228 setting \rcitem{notify}{strip} to \texttt{4} will cause |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1229 \hgext{notify} to trim the path it considers down to |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1230 \dirname{shared/test}, and it will match subscribers against that. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1231 \item[\rcitem{notify}{template}] The template text to use when sending |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1232 messages. This specifies both the contents of the message header |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1233 and its body. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1234 \item[\rcitem{notify}{maxdiff}] The maximum number of lines of diff |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1235 data to append to the end of a message. If a diff is longer than |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1236 this, it is truncated. By default, this is set to 300. Set this to |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1237 \texttt{0} to omit diffs from notification emails. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1238 \item[\rcitem{notify}{sources}] A list of sources of changesets to |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1239 consider. This lets you limit \hgext{notify} to only sending out |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1240 email about changes that remote users pushed into this repository |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1241 via a server, for example. See section~\ref{sec:hook:sources} for |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1242 the sources you can specify here. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1243 \end{itemize} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1244 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1245 If you set the \rcitem{web}{baseurl} item in the \rcsection{web} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1246 section, you can use it in a template; it will be available as |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1247 \texttt{webroot}. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1248 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1249 Here is an example set of \hgext{notify} configuration information. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1250 \begin{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1251 [notify] |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1252 # really send email |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1253 test = false |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1254 # subscriber data lives in the notify repo |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1255 config = /home/hg/repos/notify/notify.conf |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1256 # repos live in /home/hg/repos on server, so strip 4 "/" chars |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1257 strip = 4 |
285
814698eebbaf
fixed a typo and formatted the notify hook configuration example nicer.
Timo Paulssen <timonator@perpetuum-immobile.de>
parents:
247
diff
changeset
|
1258 template = X-Hg-Repo: \{webroot\} |
814698eebbaf
fixed a typo and formatted the notify hook configuration example nicer.
Timo Paulssen <timonator@perpetuum-immobile.de>
parents:
247
diff
changeset
|
1259 Subject: \{webroot\}: \{desc|firstline|strip\} |
814698eebbaf
fixed a typo and formatted the notify hook configuration example nicer.
Timo Paulssen <timonator@perpetuum-immobile.de>
parents:
247
diff
changeset
|
1260 From: \{author\} |
814698eebbaf
fixed a typo and formatted the notify hook configuration example nicer.
Timo Paulssen <timonator@perpetuum-immobile.de>
parents:
247
diff
changeset
|
1261 |
814698eebbaf
fixed a typo and formatted the notify hook configuration example nicer.
Timo Paulssen <timonator@perpetuum-immobile.de>
parents:
247
diff
changeset
|
1262 changeset \{node|short\} in \{root\} |
814698eebbaf
fixed a typo and formatted the notify hook configuration example nicer.
Timo Paulssen <timonator@perpetuum-immobile.de>
parents:
247
diff
changeset
|
1263 details: \{baseurl\}\{webroot\}?cmd=changeset;node=\{node|short\} |
814698eebbaf
fixed a typo and formatted the notify hook configuration example nicer.
Timo Paulssen <timonator@perpetuum-immobile.de>
parents:
247
diff
changeset
|
1264 description: |
814698eebbaf
fixed a typo and formatted the notify hook configuration example nicer.
Timo Paulssen <timonator@perpetuum-immobile.de>
parents:
247
diff
changeset
|
1265 \{desc|tabindent|strip\} |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1266 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1267 [web] |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1268 baseurl = http://hg.example.com/ |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1269 \end{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1270 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1271 This will produce a message that looks like the following: |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1272 \begin{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1273 X-Hg-Repo: tests/slave |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1274 Subject: tests/slave: Handle error case when slave has no buffers |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1275 Date: Wed, 2 Aug 2006 15:25:46 -0700 (PDT) |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1276 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1277 changeset 3cba9bfe74b5 in /home/hg/repos/tests/slave |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1278 details: http://hg.example.com/tests/slave?cmd=changeset;node=3cba9bfe74b5 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1279 description: |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1280 Handle error case when slave has no buffers |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1281 diffs (54 lines): |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1282 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1283 diff -r 9d95df7cf2ad -r 3cba9bfe74b5 include/tests.h |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1284 --- a/include/tests.h Wed Aug 02 15:19:52 2006 -0700 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1285 +++ b/include/tests.h Wed Aug 02 15:25:26 2006 -0700 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1286 @@ -212,6 +212,15 @@ static __inline__ void test_headers(void *h) |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1287 [...snip...] |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1288 \end{codesample2} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1289 |
374 | 1290 %\subsubsection{Testing and troubleshooting} |
1291 \subsubsection{$B%F%9%H$HLdBj2r7h(B} | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1292 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1293 Do not forget that by default, the \hgext{notify} extension \emph{will |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1294 not send any mail} until you explicitly configure it to do so, by |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1295 setting \rcitem{notify}{test} to \texttt{false}. Until you do that, |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1296 it simply prints the message it \emph{would} send. |
44
012df94a02fe
Start hook examples. First is for trailing whitespace.
Bryan O'Sullivan <bos@serpentine.com>
parents:
41
diff
changeset
|
1297 |
374 | 1298 %\section{Information for writers of hooks} |
1299 \section{$B%U%C%/:n@=<T$X$N>pJs(B} | |
41 | 1300 \label{sec:hook:ref} |
39
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1301 |
374 | 1302 %\subsection{In-process hook execution} |
1303 \subsection{$B%W%m%;%9Fb%U%C%/$N<B9T(B} | |
39
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1304 |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1305 An in-process hook is called with arguments of the following form: |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1306 \begin{codesample2} |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1307 def myhook(ui, repo, **kwargs): |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1308 pass |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1309 \end{codesample2} |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1310 The \texttt{ui} parameter is a \pymodclass{mercurial.ui}{ui} object. |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1311 The \texttt{repo} parameter is a |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1312 \pymodclass{mercurial.localrepo}{localrepository} object. The |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1313 names and values of the \texttt{**kwargs} parameters depend on the |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1314 hook being invoked, with the following common features: |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1315 \begin{itemize} |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1316 \item If a parameter is named \texttt{node} or |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1317 \texttt{parent\emph{N}}, it will contain a hexadecimal changeset ID. |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1318 The empty string is used to represent ``null changeset ID'' instead |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1319 of a string of zeroes. |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1320 \item If a parameter is named \texttt{url}, it will contain the URL of |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1321 a remote repository, if that can be determined. |
39
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1322 \item Boolean-valued parameters are represented as Python |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1323 \texttt{bool} objects. |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1324 \end{itemize} |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1325 |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1326 An in-process hook is called without a change to the process's working |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1327 directory (unlike external hooks, which are run in the root of the |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1328 repository). It must not change the process's working directory, or |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1329 it will cause any calls it makes into the Mercurial API to fail. |
39
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1330 |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1331 If a hook returns a boolean ``false'' value, it is considered to have |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1332 succeeded. If it returns a boolean ``true'' value or raises an |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1333 exception, it is considered to have failed. A useful way to think of |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1334 the calling convention is ``tell me if you fail''. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1335 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1336 Note that changeset IDs are passed into Python hooks as hexadecimal |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1337 strings, not the binary hashes that Mercurial's APIs normally use. To |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1338 convert a hash from hex to binary, use the |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1339 \pymodfunc{mercurial.node}{bin} function. |
39
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1340 |
374 | 1341 %\subsection{External hook execution} |
1342 \subsection{$B%U%C%/$N30It<B9T(B} | |
39
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1343 |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1344 An external hook is passed to the shell of the user running Mercurial. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1345 Features of that shell, such as variable substitution and command |
39
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1346 redirection, are available. The hook is run in the root directory of |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1347 the repository (unlike in-process hooks, which are run in the same |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1348 directory that Mercurial was run in). |
39
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1349 |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1350 Hook parameters are passed to the hook as environment variables. Each |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1351 environment variable's name is converted in upper case and prefixed |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1352 with the string ``\texttt{HG\_}''. For example, if the name of a |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1353 parameter is ``\texttt{node}'', the name of the environment variable |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1354 representing that parameter will be ``\texttt{HG\_NODE}''. |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1355 |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1356 A boolean parameter is represented as the string ``\texttt{1}'' for |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1357 ``true'', ``\texttt{0}'' for ``false''. If an environment variable is |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1358 named \envar{HG\_NODE}, \envar{HG\_PARENT1} or \envar{HG\_PARENT2}, it |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1359 contains a changeset ID represented as a hexadecimal string. The |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1360 empty string is used to represent ``null changeset ID'' instead of a |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1361 string of zeroes. If an environment variable is named |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1362 \envar{HG\_URL}, it will contain the URL of a remote repository, if |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1363 that can be determined. |
39
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1364 |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1365 If a hook exits with a status of zero, it is considered to have |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1366 succeeded. If it exits with a non-zero status, it is considered to |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1367 have failed. |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1368 |
374 | 1369 %\subsection{Finding out where changesets come from} |
1370 \subsection{$B%A%'%s%8%;%C%H$N=P=h$rD4$Y$k(B} | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1371 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1372 A hook that involves the transfer of changesets between a local |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1373 repository and another may be able to find out information about the |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1374 ``far side''. Mercurial knows \emph{how} changes are being |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1375 transferred, and in many cases \emph{where} they are being transferred |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1376 to or from. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1377 |
374 | 1378 %\subsubsection{Sources of changesets} |
1379 \subsubsection{$B%A%'%s%8%;%C%H$N=P=h(B} | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1380 \label{sec:hook:sources} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1381 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1382 Mercurial will tell a hook what means are, or were, used to transfer |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1383 changesets between repositories. This is provided by Mercurial in a |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1384 Python parameter named \texttt{source}, or an environment variable named |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1385 \envar{HG\_SOURCE}. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1386 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1387 \begin{itemize} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1388 \item[\texttt{serve}] Changesets are transferred to or from a remote |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1389 repository over http or ssh. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1390 \item[\texttt{pull}] Changesets are being transferred via a pull from |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1391 one repository into another. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1392 \item[\texttt{push}] Changesets are being transferred via a push from |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1393 one repository into another. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1394 \item[\texttt{bundle}] Changesets are being transferred to or from a |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1395 bundle. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1396 \end{itemize} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1397 |
374 | 1398 %\subsubsection{Where changes are going---remote repository URLs} |
1399 \subsubsection{$BJQ99$N9T$-@h(B---$B%j%b!<%H%j%]%8%H%j$N(BURL} | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1400 \label{sec:hook:url} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1401 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1402 When possible, Mercurial will tell a hook the location of the ``far |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1403 side'' of an activity that transfers changeset data between |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1404 repositories. This is provided by Mercurial in a Python parameter |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1405 named \texttt{url}, or an environment variable named \envar{HG\_URL}. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1406 |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1407 This information is not always known. If a hook is invoked in a |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1408 repository that is being served via http or ssh, Mercurial cannot tell |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1409 where the remote repository is, but it may know where the client is |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1410 connecting from. In such cases, the URL will take one of the |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1411 following forms: |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1412 \begin{itemize} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1413 \item \texttt{remote:ssh:\emph{ip-address}}---remote ssh client, at |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1414 the given IP address. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1415 \item \texttt{remote:http:\emph{ip-address}}---remote http client, at |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1416 the given IP address. If the client is using SSL, this will be of |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1417 the form \texttt{remote:https:\emph{ip-address}}. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1418 \item Empty---no information could be discovered about the remote |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1419 client. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1420 \end{itemize} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1421 |
374 | 1422 %\section{Hook reference} |
1423 \section{$B%U%C%/;2>H(B} | |
64
d12a199ed472
Update hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
63
diff
changeset
|
1424 |
374 | 1425 %\subsection{\hook{changegroup}---after remote changesets added} |
1426 \subsection{\hook{changegroup}---$B%j%b!<%H%A%'%s%8%;%C%H$,DI2C$5$l$?8e(B} | |
39
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1427 \label{sec:hook:changegroup} |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1428 |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1429 This hook is run after a group of pre-existing changesets has been |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1430 added to the repository, for example via a \hgcmd{pull} or |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1431 \hgcmd{unbundle}. This hook is run once per operation that added one |
41 | 1432 or more changesets. This is in contrast to the \hook{incoming} hook, |
1433 which is run once per changeset, regardless of whether the changesets | |
1434 arrive in a group. | |
1435 | |
1436 Some possible uses for this hook include kicking off an automated | |
1437 build or test of the added changesets, updating a bug database, or | |
1438 notifying subscribers that a repository contains new changes. | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1439 |
39
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1440 Parameters to this hook: |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1441 \begin{itemize} |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1442 \item[\texttt{node}] A changeset ID. The changeset ID of the first |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1443 changeset in the group that was added. All changesets between this |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1444 and \index{tags!\texttt{tip}}\texttt{tip}, inclusive, were added by |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1445 a single \hgcmd{pull}, \hgcmd{push} or \hgcmd{unbundle}. |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1446 \item[\texttt{source}] A string. The source of these changes. See |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1447 section~\ref{sec:hook:sources} for details. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1448 \item[\texttt{url}] A URL. The location of the remote repository, if |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1449 known. See section~\ref{sec:hook:url} for more information. |
39
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1450 \end{itemize} |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1451 |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1452 See also: \hook{incoming} (section~\ref{sec:hook:incoming}), |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1453 \hook{prechangegroup} (section~\ref{sec:hook:prechangegroup}), |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1454 \hook{pretxnchangegroup} (section~\ref{sec:hook:pretxnchangegroup}) |
39
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1455 |
374 | 1456 %\subsection{\hook{commit}---after a new changeset is created} |
1457 \subsection{\hook{commit}---$B?7$7$$%A%'%s%8%;%C%H$,:n@.$5$l$?8e(B} | |
39
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1458 \label{sec:hook:commit} |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1459 |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1460 This hook is run after a new changeset has been created. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1461 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1462 Parameters to this hook: |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1463 \begin{itemize} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1464 \item[\texttt{node}] A changeset ID. The changeset ID of the newly |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1465 committed changeset. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1466 \item[\texttt{parent1}] A changeset ID. The changeset ID of the first |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1467 parent of the newly committed changeset. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1468 \item[\texttt{parent2}] A changeset ID. The changeset ID of the second |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1469 parent of the newly committed changeset. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1470 \end{itemize} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1471 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1472 See also: \hook{precommit} (section~\ref{sec:hook:precommit}), |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1473 \hook{pretxncommit} (section~\ref{sec:hook:pretxncommit}) |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1474 |
374 | 1475 %\subsection{\hook{incoming}---after one remote changeset is added} |
1476 \subsection{\hook{incoming}---$B%j%b!<%H%A%'%s%8%;%C%H$,DI2C$5$l$?8e(B} | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1477 \label{sec:hook:incoming} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1478 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1479 This hook is run after a pre-existing changeset has been added to the |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1480 repository, for example via a \hgcmd{push}. If a group of changesets |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1481 was added in a single operation, this hook is called once for each |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1482 added changeset. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1483 |
41 | 1484 You can use this hook for the same purposes as the \hook{changegroup} |
1485 hook (section~\ref{sec:hook:changegroup}); it's simply more convenient | |
54 | 1486 sometimes to run a hook once per group of changesets, while other |
41 | 1487 times it's handier once per changeset. |
1488 | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1489 Parameters to this hook: |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1490 \begin{itemize} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1491 \item[\texttt{node}] A changeset ID. The ID of the newly added |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1492 changeset. |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1493 \item[\texttt{source}] A string. The source of these changes. See |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1494 section~\ref{sec:hook:sources} for details. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1495 \item[\texttt{url}] A URL. The location of the remote repository, if |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1496 known. See section~\ref{sec:hook:url} for more information. |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1497 \end{itemize} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1498 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1499 See also: \hook{changegroup} (section~\ref{sec:hook:changegroup}) \hook{prechangegroup} (section~\ref{sec:hook:prechangegroup}), \hook{pretxnchangegroup} (section~\ref{sec:hook:pretxnchangegroup}) |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1500 |
374 | 1501 %\subsection{\hook{outgoing}---after changesets are propagated} |
1502 \subsection{\hook{outgoing}---$B%A%'%s%8%;%C%H$,GH5Z$7$?8e(B} | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1503 \label{sec:hook:outgoing} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1504 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1505 This hook is run after a group of changesets has been propagated out |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1506 of this repository, for example by a \hgcmd{push} or \hgcmd{bundle} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1507 command. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1508 |
41 | 1509 One possible use for this hook is to notify administrators that |
1510 changes have been pulled. | |
1511 | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1512 Parameters to this hook: |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1513 \begin{itemize} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1514 \item[\texttt{node}] A changeset ID. The changeset ID of the first |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1515 changeset of the group that was sent. |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1516 \item[\texttt{source}] A string. The source of the of the operation |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1517 (see section~\ref{sec:hook:sources}). If a remote client pulled |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1518 changes from this repository, \texttt{source} will be |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1519 \texttt{serve}. If the client that obtained changes from this |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1520 repository was local, \texttt{source} will be \texttt{bundle}, |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1521 \texttt{pull}, or \texttt{push}, depending on the operation the |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1522 client performed. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1523 \item[\texttt{url}] A URL. The location of the remote repository, if |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1524 known. See section~\ref{sec:hook:url} for more information. |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1525 \end{itemize} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1526 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1527 See also: \hook{preoutgoing} (section~\ref{sec:hook:preoutgoing}) |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1528 |
374 | 1529 %\subsection{\hook{prechangegroup}---before starting to add remote |
1530 %changesets} | |
1531 \subsection{\hook{prechangegroup}---$B%j%b!<%H%A%'%s%8%;%C%H$,$,DI2C$5$l$k(B | |
1532 $BA0(B} | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1533 \label{sec:hook:prechangegroup} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1534 |
41 | 1535 This controlling hook is run before Mercurial begins to add a group of |
1536 changesets from another repository. | |
1537 | |
1538 This hook does not have any information about the changesets to be | |
1539 added, because it is run before transmission of those changesets is | |
1540 allowed to begin. If this hook fails, the changesets will not be | |
1541 transmitted. | |
1542 | |
1543 One use for this hook is to prevent external changes from being added | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1544 to a repository. For example, you could use this to ``freeze'' a |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1545 server-hosted branch temporarily or permanently so that users cannot |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1546 push to it, while still allowing a local administrator to modify the |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1547 repository. |
41 | 1548 |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1549 Parameters to this hook: |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1550 \begin{itemize} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1551 \item[\texttt{source}] A string. The source of these changes. See |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1552 section~\ref{sec:hook:sources} for details. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1553 \item[\texttt{url}] A URL. The location of the remote repository, if |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1554 known. See section~\ref{sec:hook:url} for more information. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1555 \end{itemize} |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1556 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1557 See also: \hook{changegroup} (section~\ref{sec:hook:changegroup}), |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1558 \hook{incoming} (section~\ref{sec:hook:incoming}), , |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1559 \hook{pretxnchangegroup} (section~\ref{sec:hook:pretxnchangegroup}) |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1560 |
374 | 1561 %\subsection{\hook{precommit}---before starting to commit a changeset} |
1562 \subsection{\hook{precommit}---$B%A%'%s%8%;%C%H$r%3%_%C%H$9$kA0(B} | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1563 \label{sec:hook:precommit} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1564 |
41 | 1565 This hook is run before Mercurial begins to commit a new changeset. |
1566 It is run before Mercurial has any of the metadata for the commit, | |
1567 such as the files to be committed, the commit message, or the commit | |
1568 date. | |
1569 | |
1570 One use for this hook is to disable the ability to commit new | |
1571 changesets, while still allowing incoming changesets. Another is to | |
1572 run a build or test, and only allow the commit to begin if the build | |
1573 or test succeeds. | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1574 |
39
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1575 Parameters to this hook: |
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1576 \begin{itemize} |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1577 \item[\texttt{parent1}] A changeset ID. The changeset ID of the first |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1578 parent of the working directory. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1579 \item[\texttt{parent2}] A changeset ID. The changeset ID of the second |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1580 parent of the working directory. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1581 \end{itemize} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1582 If the commit proceeds, the parents of the working directory will |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1583 become the parents of the new changeset. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1584 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1585 See also: \hook{commit} (section~\ref{sec:hook:commit}), |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1586 \hook{pretxncommit} (section~\ref{sec:hook:pretxncommit}) |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1587 |
374 | 1588 %\subsection{\hook{preoutgoing}---before starting to propagate |
1589 %changesets} | |
1590 \subsection{\hook{preoutgoing}---$B%A%'%s%8%;%C%H$rGH5Z$5$;$kA0$K(B} | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1591 \label{sec:hook:preoutgoing} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1592 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1593 This hook is invoked before Mercurial knows the identities of the |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1594 changesets to be transmitted. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1595 |
41 | 1596 One use for this hook is to prevent changes from being transmitted to |
1597 another repository. | |
1598 | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1599 Parameters to this hook: |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1600 \begin{itemize} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1601 \item[\texttt{source}] A string. The source of the operation that is |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1602 attempting to obtain changes from this repository (see |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1603 section~\ref{sec:hook:sources}). See the documentation for the |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1604 \texttt{source} parameter to the \hook{outgoing} hook, in |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1605 section~\ref{sec:hook:outgoing}, for possible values of this |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1606 parameter. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1607 \item[\texttt{url}] A URL. The location of the remote repository, if |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1608 known. See section~\ref{sec:hook:url} for more information. |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1609 \end{itemize} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1610 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1611 See also: \hook{outgoing} (section~\ref{sec:hook:outgoing}) |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1612 |
374 | 1613 %\subsection{\hook{pretag}---before tagging a changeset} |
1614 \subsection{\hook{pretag}---$B%A%'%s%8%;%C%H$K%?%0$r$D$1$kA0$K(B} | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1615 \label{sec:hook:pretag} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1616 |
41 | 1617 This controlling hook is run before a tag is created. If the hook |
1618 succeeds, creation of the tag proceeds. If the hook fails, the tag is | |
1619 not created. | |
1620 | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1621 Parameters to this hook: |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1622 \begin{itemize} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1623 \item[\texttt{local}] A boolean. Whether the tag is local to this |
244
980393101109
Fix up some incorrect and stale directory names.
Bryan O'Sullivan <bos@serpentine.com>
parents:
155
diff
changeset
|
1624 repository instance (i.e.~stored in \sfilename{.hg/localtags}) or |
980393101109
Fix up some incorrect and stale directory names.
Bryan O'Sullivan <bos@serpentine.com>
parents:
155
diff
changeset
|
1625 managed by Mercurial (stored in \sfilename{.hgtags}). |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1626 \item[\texttt{node}] A changeset ID. The ID of the changeset to be tagged. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1627 \item[\texttt{tag}] A string. The name of the tag to be created. |
39
576fef93bb49
Further content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
38
diff
changeset
|
1628 \end{itemize} |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
1629 |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1630 If the tag to be created is revision-controlled, the \hook{precommit} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1631 and \hook{pretxncommit} hooks (sections~\ref{sec:hook:commit} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1632 and~\ref{sec:hook:pretxncommit}) will also be run. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1633 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1634 See also: \hook{tag} (section~\ref{sec:hook:tag}) |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1635 |
374 | 1636 %\subsection{\hook{pretxnchangegroup}---before completing addition of |
1637 %remote changesets} | |
1638 \subsection{\hook{pretxnchangegroup}---$B%j%b!<%H%A%'%s%8%;%C%H$NDI2C$r40(B | |
1639 $BN;$9$kA0$K(B} | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1640 \label{sec:hook:pretxnchangegroup} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1641 |
41 | 1642 This controlling hook is run before a transaction---that manages the |
1643 addition of a group of new changesets from outside the | |
1644 repository---completes. If the hook succeeds, the transaction | |
1645 completes, and all of the changesets become permanent within this | |
1646 repository. If the hook fails, the transaction is rolled back, and | |
1647 the data for the changesets is erased. | |
1648 | |
1649 This hook can access the metadata associated with the almost-added | |
1650 changesets, but it should not do anything permanent with this data. | |
1651 It must also not modify the working directory. | |
1652 | |
1653 While this hook is running, if other Mercurial processes access this | |
1654 repository, they will be able to see the almost-added changesets as if | |
1655 they are permanent. This may lead to race conditions if you do not | |
1656 take steps to avoid them. | |
1657 | |
1658 This hook can be used to automatically vet a group of changesets. If | |
1659 the hook fails, all of the changesets are ``rejected'' when the | |
1660 transaction rolls back. | |
1661 | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1662 Parameters to this hook: |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1663 \begin{itemize} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1664 \item[\texttt{node}] A changeset ID. The changeset ID of the first |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1665 changeset in the group that was added. All changesets between this |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1666 and \index{tags!\texttt{tip}}\texttt{tip}, inclusive, were added by |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1667 a single \hgcmd{pull}, \hgcmd{push} or \hgcmd{unbundle}. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1668 \item[\texttt{source}] A string. The source of these changes. See |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1669 section~\ref{sec:hook:sources} for details. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1670 \item[\texttt{url}] A URL. The location of the remote repository, if |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1671 known. See section~\ref{sec:hook:url} for more information. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1672 \end{itemize} |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1673 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1674 See also: \hook{changegroup} (section~\ref{sec:hook:changegroup}), |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1675 \hook{incoming} (section~\ref{sec:hook:incoming}), |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1676 \hook{prechangegroup} (section~\ref{sec:hook:prechangegroup}) |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1677 |
374 | 1678 %\subsection{\hook{pretxncommit}---before completing commit of new |
1679 %changeset} | |
1680 \subsection{\hook{pretxncommit}---$B?7$7$$%A%'%s%8%;%C%H$N%3%_%C%H$r40N;$9(B | |
1681 $B$kA0$K(B} | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1682 \label{sec:hook:pretxncommit} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1683 |
41 | 1684 This controlling hook is run before a transaction---that manages a new |
1685 commit---completes. If the hook succeeds, the transaction completes | |
1686 and the changeset becomes permanent within this repository. If the | |
1687 hook fails, the transaction is rolled back, and the commit data is | |
1688 erased. | |
1689 | |
1690 This hook can access the metadata associated with the almost-new | |
1691 changeset, but it should not do anything permanent with this data. It | |
1692 must also not modify the working directory. | |
1693 | |
1694 While this hook is running, if other Mercurial processes access this | |
1695 repository, they will be able to see the almost-new changeset as if it | |
1696 is permanent. This may lead to race conditions if you do not take | |
1697 steps to avoid them. | |
1698 | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1699 Parameters to this hook: |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1700 \begin{itemize} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1701 \item[\texttt{node}] A changeset ID. The changeset ID of the newly |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1702 committed changeset. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1703 \item[\texttt{parent1}] A changeset ID. The changeset ID of the first |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1704 parent of the newly committed changeset. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1705 \item[\texttt{parent2}] A changeset ID. The changeset ID of the second |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1706 parent of the newly committed changeset. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1707 \end{itemize} |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1708 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1709 See also: \hook{precommit} (section~\ref{sec:hook:precommit}) |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1710 |
374 | 1711 %\subsection{\hook{preupdate}---before updating or merging working |
1712 %directory} | |
1713 \subsection{\hook{preupdate}---$B%o!<%-%s%0%G%#%l%/%H%j$N%"%C%W%G!<%H$^$?(B | |
1714 $B$O%^!<%8$NA0$K(B} | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1715 \label{sec:hook:preupdate} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1716 |
41 | 1717 This controlling hook is run before an update or merge of the working |
1718 directory begins. It is run only if Mercurial's normal pre-update | |
1719 checks determine that the update or merge can proceed. If the hook | |
1720 succeeds, the update or merge may proceed; if it fails, the update or | |
1721 merge does not start. | |
1722 | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1723 Parameters to this hook: |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1724 \begin{itemize} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1725 \item[\texttt{parent1}] A changeset ID. The ID of the parent that the |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1726 working directory is to be updated to. If the working directory is |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1727 being merged, it will not change this parent. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1728 \item[\texttt{parent2}] A changeset ID. Only set if the working |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1729 directory is being merged. The ID of the revision that the working |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1730 directory is being merged with. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1731 \end{itemize} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1732 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1733 See also: \hook{update} (section~\ref{sec:hook:update}) |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1734 |
374 | 1735 %\subsection{\hook{tag}---after tagging a changeset} |
1736 \subsection{\hook{tag}---$B%A%'%s%8%;%C%H$K%?%0IU$1$7$?8e$K(B} | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1737 \label{sec:hook:tag} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1738 |
41 | 1739 This hook is run after a tag has been created. |
1740 | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1741 Parameters to this hook: |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1742 \begin{itemize} |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1743 \item[\texttt{local}] A boolean. Whether the new tag is local to this |
244
980393101109
Fix up some incorrect and stale directory names.
Bryan O'Sullivan <bos@serpentine.com>
parents:
155
diff
changeset
|
1744 repository instance (i.e.~stored in \sfilename{.hg/localtags}) or |
980393101109
Fix up some incorrect and stale directory names.
Bryan O'Sullivan <bos@serpentine.com>
parents:
155
diff
changeset
|
1745 managed by Mercurial (stored in \sfilename{.hgtags}). |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1746 \item[\texttt{node}] A changeset ID. The ID of the changeset that was |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1747 tagged. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1748 \item[\texttt{tag}] A string. The name of the tag that was created. |
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
54
diff
changeset
|
1749 \end{itemize} |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1750 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1751 If the created tag is revision-controlled, the \hook{commit} hook |
41 | 1752 (section~\ref{sec:hook:commit}) is run before this hook. |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1753 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1754 See also: \hook{pretag} (section~\ref{sec:hook:pretag}) |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1755 |
374 | 1756 %\subsection{\hook{update}---after updating or merging working |
1757 %directory} | |
1758 \subsection{\hook{update}---$B%o!<%-%s%0%G%#%l%/%H%j$r99?7$^$?$O%^!<%8$7$?(B | |
1759 $B8e$K(B} | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1760 \label{sec:hook:update} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1761 |
41 | 1762 This hook is run after an update or merge of the working directory |
1763 completes. Since a merge can fail (if the external \command{hgmerge} | |
1764 command fails to resolve conflicts in a file), this hook communicates | |
1765 whether the update or merge completed cleanly. | |
1766 | |
40
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1767 \begin{itemize} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1768 \item[\texttt{error}] A boolean. Indicates whether the update or |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1769 merge completed successfully. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1770 \item[\texttt{parent1}] A changeset ID. The ID of the parent that the |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1771 working directory was updated to. If the working directory was |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1772 merged, it will not have changed this parent. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1773 \item[\texttt{parent2}] A changeset ID. Only set if the working |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1774 directory was merged. The ID of the revision that the working |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1775 directory was merged with. |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1776 \end{itemize} |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1777 |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1778 See also: \hook{preupdate} (section~\ref{sec:hook:preupdate}) |
b2fe9964b21b
More content for hook reference.
Bryan O'Sullivan <bos@serpentine.com>
parents:
39
diff
changeset
|
1779 |
374 | 1780 %%% Local Variables: |
293
3b1291f24c0d
- replaved latex-mode to yatex-mode
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
290
diff
changeset
|
1781 %%% mode: yatex |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
1782 %%% TeX-master: "00book" |
374 | 1783 %%% End: |