hgbook
diff en/ch09-hook.xml @ 604:39b7a21c490b
Drop another dead file
author | Bryan O'Sullivan <bos@serpentine.com> |
---|---|
date | Fri Mar 27 10:04:49 2009 -0700 (2009-03-27) |
parents | c838b3975bc6 |
children | 1c13ed2130a7 |
line diff
1.1 --- a/en/ch09-hook.xml Thu Mar 19 21:18:52 2009 -0700 1.2 +++ b/en/ch09-hook.xml Fri Mar 27 10:04:49 2009 -0700 1.3 @@ -17,9 +17,9 @@ 1.4 <sect1> 1.5 <title>An overview of hooks in Mercurial</title> 1.6 1.7 - <para id="x_1e8">Here is a brief list of the hooks that Mercurial supports. 1.8 - We will revisit each of these hooks in more detail later, in 1.9 - section <xref linkend="sec:hook:ref"/>.</para> 1.10 + <para id="x_1e8">Here is a brief list of the hooks that Mercurial 1.11 + supports. We will revisit each of these hooks in more detail 1.12 + later, in <xref linkend="sec:hook:ref"/>.</para> 1.13 1.14 <itemizedlist> 1.15 <listitem><para id="x_1e9"><literal role="hook">changegroup</literal>: This 1.16 @@ -393,12 +393,12 @@ 1.17 before both. 1.18 </para> 1.19 1.20 - <para id="x_218">It is a good idea to use a somewhat descriptive extension 1.21 - when you define a new hook. This will help you to remember 1.22 - what the hook was for. If the hook fails, you'll get an error 1.23 - message that contains the hook name and extension, so using a 1.24 - descriptive extension could give you an immediate hint as to 1.25 - why the hook failed (see section <xref 1.26 + <para id="x_218">It is a good idea to use a somewhat descriptive 1.27 + extension when you define a new hook. This will help you to 1.28 + remember what the hook was for. If the hook fails, you'll get 1.29 + an error message that contains the hook name and extension, so 1.30 + using a descriptive extension could give you an immediate hint 1.31 + as to why the hook failed (see <xref 1.32 linkend="sec:hook:perm"/> for an example). 1.33 </para> 1.34 1.35 @@ -1094,7 +1094,7 @@ 1.36 mapping committer names to user names. 1.37 </para> 1.38 1.39 - <para id="x_263">Recall from section <xref 1.40 + <para id="x_263">Recall from <xref 1.41 linkend="sec:hook:bugzilla:config"/> above that the user 1.42 that runs the Mercurial process on the server is also the 1.43 one that will run the <filename>processmail</filename> 1.44 @@ -1250,10 +1250,9 @@ 1.45 sources of changesets to consider. This lets you limit 1.46 <literal role="hg-ext">notify</literal> to only sending 1.47 out email about changes that remote users pushed into 1.48 - this repository via a server, for example. See section 1.49 - <xref 1.50 - linkend="sec:hook:sources"/> for the sources you can 1.51 - specify here. 1.52 + this repository via a server, for example. See 1.53 + <xref linkend="sec:hook:sources"/> for the sources you 1.54 + can specify here. 1.55 </para> 1.56 </listitem></itemizedlist> 1.57 1.58 @@ -1502,23 +1501,23 @@ 1.59 role="hg-cmd">hg unbundle</command>. 1.60 </para> 1.61 </listitem> 1.62 - <listitem><para id="x_294"><literal>source</literal>: A string. The 1.63 - source of these changes. See section <xref 1.64 + <listitem><para id="x_294"><literal>source</literal>: A 1.65 + string. The source of these changes. See <xref 1.66 linkend="sec:hook:sources"/> for details. 1.67 </para> 1.68 </listitem> 1.69 - <listitem><para id="x_295"><literal>url</literal>: A URL. The location 1.70 - of the remote repository, if known. See section <xref 1.71 - linkend="sec:hook:url"/> for more 1.72 - information. 1.73 + <listitem><para id="x_295"><literal>url</literal>: A URL. The 1.74 + location of the remote repository, if known. See <xref 1.75 + linkend="sec:hook:url"/> for more information. 1.76 </para> 1.77 </listitem></itemizedlist> 1.78 1.79 - <para id="x_296">See also: <literal role="hook">incoming</literal> (section 1.80 - <xref linkend="sec:hook:incoming"/>), <literal 1.81 - role="hook">prechangegroup</literal> (section <xref 1.82 + <para id="x_296">See also: <literal 1.83 + role="hook">incoming</literal> (<xref 1.84 + linkend="sec:hook:incoming"/>), <literal 1.85 + role="hook">prechangegroup</literal> (<xref 1.86 linkend="sec:hook:prechangegroup"/>), <literal 1.87 - role="hook">pretxnchangegroup</literal> (section <xref 1.88 + role="hook">pretxnchangegroup</literal> (<xref 1.89 linkend="sec:hook:pretxnchangegroup"/>) 1.90 </para> 1.91 1.92 @@ -1548,9 +1547,10 @@ 1.93 </para> 1.94 </listitem></itemizedlist> 1.95 1.96 - <para id="x_29c">See also: <literal role="hook">precommit</literal> 1.97 - (section <xref linkend="sec:hook:precommit"/>), <literal 1.98 - role="hook">pretxncommit</literal> (section <xref 1.99 + <para id="x_29c">See also: <literal 1.100 + role="hook">precommit</literal> (<xref 1.101 + linkend="sec:hook:precommit"/>), <literal 1.102 + role="hook">pretxncommit</literal> (<xref 1.103 linkend="sec:hook:pretxncommit"/>) 1.104 </para> 1.105 1.106 @@ -1566,10 +1566,10 @@ 1.107 each added changeset. 1.108 </para> 1.109 1.110 - <para id="x_29e">You can use this hook for the same purposes as the 1.111 - <literal role="hook">changegroup</literal> hook (section <xref 1.112 - linkend="sec:hook:changegroup"/>); it's simply 1.113 - more convenient sometimes to run a hook once per group of 1.114 + <para id="x_29e">You can use this hook for the same purposes as 1.115 + the <literal role="hook">changegroup</literal> hook (<xref 1.116 + linkend="sec:hook:changegroup"/>); it's simply more 1.117 + convenient sometimes to run a hook once per group of 1.118 changesets, while other times it's handier once per changeset. 1.119 </para> 1.120 1.121 @@ -1580,23 +1580,23 @@ 1.122 ID of the newly added changeset. 1.123 </para> 1.124 </listitem> 1.125 - <listitem><para id="x_2a1"><literal>source</literal>: A string. The 1.126 - source of these changes. See section <xref 1.127 + <listitem><para id="x_2a1"><literal>source</literal>: A 1.128 + string. The source of these changes. See <xref 1.129 linkend="sec:hook:sources"/> for details. 1.130 </para> 1.131 </listitem> 1.132 - <listitem><para id="x_2a2"><literal>url</literal>: A URL. The location 1.133 - of the remote repository, if known. See section <xref 1.134 - linkend="sec:hook:url"/> for more 1.135 - information. 1.136 + <listitem><para id="x_2a2"><literal>url</literal>: A URL. The 1.137 + location of the remote repository, if known. See <xref 1.138 + linkend="sec:hook:url"/> for more information. 1.139 </para> 1.140 </listitem></itemizedlist> 1.141 1.142 - <para id="x_2a3">See also: <literal role="hook">changegroup</literal> 1.143 - (section <xref linkend="sec:hook:changegroup"/>) <literal 1.144 - role="hook">prechangegroup</literal> (section <xref 1.145 + <para id="x_2a3">See also: <literal 1.146 + role="hook">changegroup</literal> (<xref 1.147 + linkend="sec:hook:changegroup"/>) <literal 1.148 + role="hook">prechangegroup</literal> (<xref 1.149 linkend="sec:hook:prechangegroup"/>), <literal 1.150 - role="hook">pretxnchangegroup</literal> (section <xref 1.151 + role="hook">pretxnchangegroup</literal> (<xref 1.152 linkend="sec:hook:pretxnchangegroup"/>) 1.153 </para> 1.154 1.155 @@ -1624,7 +1624,7 @@ 1.156 </para> 1.157 </listitem> 1.158 <listitem><para id="x_2a8"><literal>source</literal>: A string. The 1.159 - source of the of the operation (see section <xref 1.160 + source of the of the operation (see <xref 1.161 linkend="sec:hook:sources"/>). If a remote 1.162 client pulled changes from this repository, 1.163 <literal>source</literal> will be 1.164 @@ -1636,15 +1636,15 @@ 1.165 client performed. 1.166 </para> 1.167 </listitem> 1.168 - <listitem><para id="x_2a9"><literal>url</literal>: A URL. The location 1.169 - of the remote repository, if known. See section <xref 1.170 - linkend="sec:hook:url"/> for more 1.171 - information. 1.172 + <listitem><para id="x_2a9"><literal>url</literal>: A URL. The 1.173 + location of the remote repository, if known. See <xref 1.174 + linkend="sec:hook:url"/> for more information. 1.175 </para> 1.176 </listitem></itemizedlist> 1.177 1.178 - <para id="x_2aa">See also: <literal role="hook">preoutgoing</literal> 1.179 - (section <xref linkend="sec:hook:preoutgoing"/>) 1.180 + <para id="x_2aa">See also: <literal 1.181 + role="hook">preoutgoing</literal> (<xref 1.182 + linkend="sec:hook:preoutgoing"/>) 1.183 </para> 1.184 1.185 </sect2> 1.186 @@ -1674,22 +1674,22 @@ 1.187 </para> 1.188 <itemizedlist> 1.189 <listitem><para id="x_2af"><literal>source</literal>: A string. The 1.190 - source of these changes. See section <xref 1.191 + source of these changes. See <xref 1.192 linkend="sec:hook:sources"/> for details. 1.193 </para> 1.194 </listitem> 1.195 - <listitem><para id="x_2b0"><literal>url</literal>: A URL. The location 1.196 - of the remote repository, if known. See section <xref 1.197 - linkend="sec:hook:url"/> for more 1.198 - information. 1.199 + <listitem><para id="x_2b0"><literal>url</literal>: A URL. The 1.200 + location of the remote repository, if known. See <xref 1.201 + linkend="sec:hook:url"/> for more information. 1.202 </para> 1.203 </listitem></itemizedlist> 1.204 1.205 - <para id="x_2b1">See also: <literal role="hook">changegroup</literal> 1.206 - (section <xref linkend="sec:hook:changegroup"/>), <literal 1.207 - role="hook">incoming</literal> (section <xref 1.208 - linkend="sec:hook:incoming"/>), , <literal 1.209 - role="hook">pretxnchangegroup</literal> (section <xref 1.210 + <para id="x_2b1">See also: <literal 1.211 + role="hook">changegroup</literal> (<xref 1.212 + linkend="sec:hook:changegroup"/>), <literal 1.213 + role="hook">incoming</literal> (<xref 1.214 + linkend="sec:hook:incoming"/>), <literal 1.215 + role="hook">pretxnchangegroup</literal> (<xref 1.216 linkend="sec:hook:pretxnchangegroup"/>) 1.217 </para> 1.218 1.219 @@ -1727,9 +1727,9 @@ 1.220 directory will become the parents of the new changeset. 1.221 </para> 1.222 1.223 - <para id="x_2b8">See also: <literal role="hook">commit</literal> (section 1.224 - <xref linkend="sec:hook:commit"/>), <literal 1.225 - role="hook">pretxncommit</literal> (section <xref 1.226 + <para id="x_2b8">See also: <literal role="hook">commit</literal> 1.227 + (<xref linkend="sec:hook:commit"/>), <literal 1.228 + role="hook">pretxncommit</literal> (<xref 1.229 linkend="sec:hook:pretxncommit"/>) 1.230 </para> 1.231 1.232 @@ -1749,26 +1749,25 @@ 1.233 <para id="x_2bb">Parameters to this hook: 1.234 </para> 1.235 <itemizedlist> 1.236 - <listitem><para id="x_2bc"><literal>source</literal>: A string. The 1.237 - source of the operation that is attempting to obtain 1.238 - changes from this repository (see section <xref 1.239 + <listitem><para id="x_2bc"><literal>source</literal>: A 1.240 + string. The source of the operation that is attempting to 1.241 + obtain changes from this repository (see <xref 1.242 linkend="sec:hook:sources"/>). See the documentation 1.243 for the <literal>source</literal> parameter to the 1.244 - <literal role="hook">outgoing</literal> hook, in section 1.245 + <literal role="hook">outgoing</literal> hook, in 1.246 <xref linkend="sec:hook:outgoing"/>, for possible values 1.247 - of 1.248 - this parameter. 1.249 - </para> 1.250 - </listitem> 1.251 - <listitem><para id="x_2bd"><literal>url</literal>: A URL. The location 1.252 - of the remote repository, if known. See section <xref 1.253 - linkend="sec:hook:url"/> for more 1.254 - information. 1.255 + of this parameter. 1.256 + </para> 1.257 + </listitem> 1.258 + <listitem><para id="x_2bd"><literal>url</literal>: A URL. The 1.259 + location of the remote repository, if known. See <xref 1.260 + linkend="sec:hook:url"/> for more information. 1.261 </para> 1.262 </listitem></itemizedlist> 1.263 1.264 - <para id="x_2be">See also: <literal role="hook">outgoing</literal> (section 1.265 - <xref linkend="sec:hook:outgoing"/>) 1.266 + <para id="x_2be">See also: <literal 1.267 + role="hook">outgoing</literal> (<xref 1.268 + linkend="sec:hook:outgoing"/>) 1.269 </para> 1.270 1.271 </sect2> 1.272 @@ -1800,15 +1799,16 @@ 1.273 </para> 1.274 </listitem></itemizedlist> 1.275 1.276 - <para id="x_2c4">If the tag to be created is revision-controlled, the 1.277 - <literal role="hook">precommit</literal> and <literal 1.278 - role="hook">pretxncommit</literal> hooks (sections <xref 1.279 + <para id="x_2c4">If the tag to be created is 1.280 + revision-controlled, the <literal 1.281 + role="hook">precommit</literal> and <literal 1.282 + role="hook">pretxncommit</literal> hooks (<xref 1.283 linkend="sec:hook:commit"/> and <xref 1.284 linkend="sec:hook:pretxncommit"/>) will also be run. 1.285 </para> 1.286 1.287 - <para id="x_2c5">See also: <literal role="hook">tag</literal> (section 1.288 - <xref linkend="sec:hook:tag"/>) 1.289 + <para id="x_2c5">See also: <literal role="hook">tag</literal> 1.290 + (<xref linkend="sec:hook:tag"/>) 1.291 </para> 1.292 </sect2> 1.293 <sect2 id="sec:hook:pretxnchangegroup"> 1.294 @@ -1856,23 +1856,23 @@ 1.295 role="hg-cmd">hg unbundle</command>. 1.296 </para> 1.297 </listitem> 1.298 - <listitem><para id="x_2cc"><literal>source</literal>: A string. The 1.299 - source of these changes. See section <xref 1.300 + <listitem><para id="x_2cc"><literal>source</literal>: A 1.301 + string. The source of these changes. See <xref 1.302 linkend="sec:hook:sources"/> for details. 1.303 </para> 1.304 </listitem> 1.305 - <listitem><para id="x_2cd"><literal>url</literal>: A URL. The location 1.306 - of the remote repository, if known. See section <xref 1.307 - linkend="sec:hook:url"/> for more 1.308 - information. 1.309 + <listitem><para id="x_2cd"><literal>url</literal>: A URL. The 1.310 + location of the remote repository, if known. See <xref 1.311 + linkend="sec:hook:url"/> for more information. 1.312 </para> 1.313 </listitem></itemizedlist> 1.314 1.315 - <para id="x_2ce">See also: <literal role="hook">changegroup</literal> 1.316 - (section <xref linkend="sec:hook:changegroup"/>), <literal 1.317 - role="hook">incoming</literal> (section <xref 1.318 + <para id="x_2ce">See also: <literal 1.319 + role="hook">changegroup</literal> (<xref 1.320 + linkend="sec:hook:changegroup"/>), <literal 1.321 + role="hook">incoming</literal> (<xref 1.322 linkend="sec:hook:incoming"/>), <literal 1.323 - role="hook">prechangegroup</literal> (section <xref 1.324 + role="hook">prechangegroup</literal> (<xref 1.325 linkend="sec:hook:prechangegroup"/>) 1.326 </para> 1.327 1.328 @@ -1919,8 +1919,9 @@ 1.329 </para> 1.330 </listitem></itemizedlist> 1.331 1.332 - <para id="x_2d6">See also: <literal role="hook">precommit</literal> 1.333 - (section <xref linkend="sec:hook:precommit"/>) 1.334 + <para id="x_2d6">See also: <literal 1.335 + role="hook">precommit</literal> (<xref 1.336 + linkend="sec:hook:precommit"/>) 1.337 </para> 1.338 1.339 </sect2> 1.340 @@ -1928,32 +1929,32 @@ 1.341 <title><literal role="hook">preupdate</literal>&emdash;before 1.342 updating or merging working directory</title> 1.343 1.344 - <para id="x_2d7">This controlling hook is run before an update or merge of 1.345 - the working directory begins. It is run only if Mercurial's 1.346 - normal pre-update checks determine that the update or merge 1.347 - can proceed. If the hook succeeds, the update or merge may 1.348 - proceed; if it fails, the update or merge does not start. 1.349 + <para id="x_2d7">This controlling hook is run before an update 1.350 + or merge of the working directory begins. It is run only if 1.351 + Mercurial's normal pre-update checks determine that the update 1.352 + or merge can proceed. If the hook succeeds, the update or 1.353 + merge may proceed; if it fails, the update or merge does not 1.354 + start. 1.355 </para> 1.356 1.357 <para id="x_2d8">Parameters to this hook: 1.358 </para> 1.359 <itemizedlist> 1.360 - <listitem><para id="x_2d9"><literal>parent1</literal>: A changeset ID. 1.361 - The ID of the parent that the working directory is to be 1.362 - updated to. If the working directory is being merged, it 1.363 - will not change this parent. 1.364 - </para> 1.365 - </listitem> 1.366 - <listitem><para id="x_2da"><literal>parent2</literal>: A changeset ID. 1.367 - Only set if the working directory is being merged. The ID 1.368 - of the revision that the working directory is being merged 1.369 - with. 1.370 + <listitem><para id="x_2d9"><literal>parent1</literal>: A 1.371 + changeset ID. The ID of the parent that the working 1.372 + directory is to be updated to. If the working directory 1.373 + is being merged, it will not change this parent. 1.374 + </para> 1.375 + </listitem> 1.376 + <listitem><para id="x_2da"><literal>parent2</literal>: A 1.377 + changeset ID. Only set if the working directory is being 1.378 + merged. The ID of the revision that the working directory 1.379 + is being merged with. 1.380 </para> 1.381 </listitem></itemizedlist> 1.382 1.383 - <para id="x_2db">See also: <literal role="hook">update</literal> (section 1.384 - <xref linkend="sec:hook:update"/>) 1.385 - </para> 1.386 + <para id="x_2db">See also: <literal role="hook">update</literal> 1.387 + (<xref linkend="sec:hook:update"/>)</para> 1.388 1.389 </sect2> 1.390 <sect2 id="sec:hook:tag"> 1.391 @@ -1988,8 +1989,8 @@ 1.392 linkend="sec:hook:commit"/>) is run before this hook. 1.393 </para> 1.394 1.395 - <para id="x_2e2">See also: <literal role="hook">pretag</literal> (section 1.396 - <xref linkend="sec:hook:pretag"/>) 1.397 + <para id="x_2e2">See also: <literal role="hook">pretag</literal> 1.398 + (<xref linkend="sec:hook:pretag"/>) 1.399 </para> 1.400 1.401 </sect2> 1.402 @@ -2023,7 +2024,7 @@ 1.403 </listitem></itemizedlist> 1.404 1.405 <para id="x_2e7">See also: <literal role="hook">preupdate</literal> 1.406 - (section <xref linkend="sec:hook:preupdate"/>) 1.407 + (<xref linkend="sec:hook:preupdate"/>) 1.408 </para> 1.409 1.410 </sect2>