hgbook
diff en/ch11-mq.xml @ 668:55e2953f82d6
Update Chinese translation
author | Dongsheng Song <songdongsheng@live.cn> |
---|---|
date | Sun Apr 05 12:12:00 2009 +0800 (2009-04-05) |
parents | 7e7c47481e4f 0b45854f0b7b |
children | b338f5490029 |
line diff
1.1 --- a/en/ch11-mq.xml Fri Mar 20 16:43:35 2009 +0800 1.2 +++ b/en/ch11-mq.xml Sun Apr 05 12:12:00 2009 +0800 1.3 @@ -1,13 +1,13 @@ 1.4 <!-- vim: set filetype=docbkxml shiftwidth=2 autoindent expandtab tw=77 : --> 1.5 1.6 -<chapter id="chap.mq"> 1.7 +<chapter id="chap:mq"> 1.8 <?dbhtml filename="managing-change-with-mercurial-queues.html"?> 1.9 <title>Managing change with Mercurial Queues</title> 1.10 1.11 - <sect1 id="sec.mq.patch-mgmt"> 1.12 + <sect1 id="sec:mq:patch-mgmt"> 1.13 <title>The patch management problem</title> 1.14 1.15 - <para>Here is a common scenario: you need to install a software 1.16 + <para id="x_3ac">Here is a common scenario: you need to install a software 1.17 package from source, but you find a bug that you must fix in the 1.18 source before you can start using the package. You make your 1.19 changes, forget about the package for a while, and a few months 1.20 @@ -17,27 +17,27 @@ 1.21 the newer version. This is a tedious task, and it's easy to 1.22 make mistakes.</para> 1.23 1.24 - <para>This is a simple case of the <quote>patch management</quote> 1.25 + <para id="x_3ad">This is a simple case of the <quote>patch management</quote> 1.26 problem. You have an <quote>upstream</quote> source tree that 1.27 you can't change; you need to make some local changes on top of 1.28 the upstream tree; and you'd like to be able to keep those 1.29 changes separate, so that you can apply them to newer versions 1.30 of the upstream source.</para> 1.31 1.32 - <para>The patch management problem arises in many situations. 1.33 + <para id="x_3ae">The patch management problem arises in many situations. 1.34 Probably the most visible is that a user of an open source 1.35 software project will contribute a bug fix or new feature to the 1.36 project's maintainers in the form of a patch.</para> 1.37 1.38 - <para>Distributors of operating systems that include open source 1.39 + <para id="x_3af">Distributors of operating systems that include open source 1.40 software often need to make changes to the packages they 1.41 distribute so that they will build properly in their 1.42 environments.</para> 1.43 1.44 - <para>When you have few changes to maintain, it is easy to manage 1.45 + <para id="x_3b0">When you have few changes to maintain, it is easy to manage 1.46 a single patch using the standard <command>diff</command> and 1.47 - <command>patch</command> programs (see section <xref 1.48 - linkend="sec.mq.patch"/> for a discussion of these 1.49 + <command>patch</command> programs (see <xref 1.50 + linkend="sec:mq:patch"/> for a discussion of these 1.51 tools). Once the number of changes grows, it starts to make 1.52 sense to maintain patches as discrete <quote>chunks of 1.53 work,</quote> so that for example a single patch will contain 1.54 @@ -49,37 +49,37 @@ 1.55 your fix in a subsequent release, you can simply drop that 1.56 single patch when you're updating to the newer release.</para> 1.57 1.58 - <para>Maintaining a single patch against an upstream tree is a 1.59 + <para id="x_3b1">Maintaining a single patch against an upstream tree is a 1.60 little tedious and error-prone, but not difficult. However, the 1.61 complexity of the problem grows rapidly as the number of patches 1.62 you have to maintain increases. With more than a tiny number of 1.63 patches in hand, understanding which ones you have applied and 1.64 maintaining them moves from messy to overwhelming.</para> 1.65 1.66 - <para>Fortunately, Mercurial includes a powerful extension, 1.67 + <para id="x_3b2">Fortunately, Mercurial includes a powerful extension, 1.68 Mercurial Queues (or simply <quote>MQ</quote>), that massively 1.69 simplifies the patch management problem.</para> 1.70 1.71 </sect1> 1.72 - <sect1 id="sec.mq.history"> 1.73 + <sect1 id="sec:mq:history"> 1.74 <title>The prehistory of Mercurial Queues</title> 1.75 1.76 - <para>During the late 1990s, several Linux kernel developers 1.77 + <para id="x_3b3">During the late 1990s, several Linux kernel developers 1.78 started to maintain <quote>patch series</quote> that modified 1.79 the behaviour of the Linux kernel. Some of these series were 1.80 focused on stability, some on feature coverage, and others were 1.81 more speculative.</para> 1.82 1.83 - <para>The sizes of these patch series grew rapidly. In 2002, 1.84 + <para id="x_3b4">The sizes of these patch series grew rapidly. In 2002, 1.85 Andrew Morton published some shell scripts he had been using to 1.86 automate the task of managing his patch queues. Andrew was 1.87 successfully using these scripts to manage hundreds (sometimes 1.88 thousands) of patches on top of the Linux kernel.</para> 1.89 1.90 - <sect2 id="sec.mq.quilt"> 1.91 + <sect2 id="sec:mq:quilt"> 1.92 <title>A patchwork quilt</title> 1.93 1.94 - <para>In early 2003, Andreas Gruenbacher and Martin Quinson 1.95 + <para id="x_3b5">In early 2003, Andreas Gruenbacher and Martin Quinson 1.96 borrowed the approach of Andrew's scripts and published a tool 1.97 called <quote>patchwork quilt</quote> 1.98 <citation>web:quilt</citation>, or simply <quote>quilt</quote> 1.99 @@ -88,7 +88,7 @@ 1.100 management, it rapidly gained a large following among open 1.101 source software developers.</para> 1.102 1.103 - <para>Quilt manages a <emphasis>stack of patches</emphasis> on 1.104 + <para id="x_3b6">Quilt manages a <emphasis>stack of patches</emphasis> on 1.105 top of a directory tree. To begin, you tell quilt to manage a 1.106 directory tree, and tell it which files you want to manage; it 1.107 stores away the names and contents of those files. To fix a 1.108 @@ -96,14 +96,14 @@ 1.109 files you need to fix, then <quote>refresh</quote> the 1.110 patch.</para> 1.111 1.112 - <para>The refresh step causes quilt to scan the directory tree; 1.113 + <para id="x_3b7">The refresh step causes quilt to scan the directory tree; 1.114 it updates the patch with all of the changes you have made. 1.115 You can create another patch on top of the first, which will 1.116 track the changes required to modify the tree from <quote>tree 1.117 with one patch applied</quote> to <quote>tree with two 1.118 patches applied</quote>.</para> 1.119 1.120 - <para>You can <emphasis>change</emphasis> which patches are 1.121 + <para id="x_3b8">You can <emphasis>change</emphasis> which patches are 1.122 applied to the tree. If you <quote>pop</quote> a patch, the 1.123 changes made by that patch will vanish from the directory 1.124 tree. Quilt remembers which patches you have popped, though, 1.125 @@ -115,25 +115,25 @@ 1.126 any time, change both which patches are applied and what 1.127 modifications those patches make.</para> 1.128 1.129 - <para>Quilt knows nothing about revision control tools, so it 1.130 + <para id="x_3b9">Quilt knows nothing about revision control tools, so it 1.131 works equally well on top of an unpacked tarball or a 1.132 Subversion working copy.</para> 1.133 1.134 </sect2> 1.135 - <sect2 id="sec.mq.quilt-mq"> 1.136 + <sect2 id="sec:mq:quilt-mq"> 1.137 <title>From patchwork quilt to Mercurial Queues</title> 1.138 1.139 - <para>In mid-2005, Chris Mason took the features of quilt and 1.140 + <para id="x_3ba">In mid-2005, Chris Mason took the features of quilt and 1.141 wrote an extension that he called Mercurial Queues, which 1.142 added quilt-like behaviour to Mercurial.</para> 1.143 1.144 - <para>The key difference between quilt and MQ is that quilt 1.145 + <para id="x_3bb">The key difference between quilt and MQ is that quilt 1.146 knows nothing about revision control systems, while MQ is 1.147 <emphasis>integrated</emphasis> into Mercurial. Each patch 1.148 that you push is represented as a Mercurial changeset. Pop a 1.149 patch, and the changeset goes away.</para> 1.150 1.151 - <para>Because quilt does not care about revision control tools, 1.152 + <para id="x_3bc">Because quilt does not care about revision control tools, 1.153 it is still a tremendously useful piece of software to know 1.154 about for situations where you cannot use Mercurial and 1.155 MQ.</para> 1.156 @@ -143,16 +143,16 @@ 1.157 <sect1> 1.158 <title>The huge advantage of MQ</title> 1.159 1.160 - <para>I cannot overstate the value that MQ offers through the 1.161 + <para id="x_3bd">I cannot overstate the value that MQ offers through the 1.162 unification of patches and revision control.</para> 1.163 1.164 - <para>A major reason that patches have persisted in the free 1.165 + <para id="x_3be">A major reason that patches have persisted in the free 1.166 software and open source world&emdash;in spite of the 1.167 availability of increasingly capable revision control tools over 1.168 the years&emdash;is the <emphasis>agility</emphasis> they 1.169 offer.</para> 1.170 1.171 - <para>Traditional revision control tools make a permanent, 1.172 + <para id="x_3bf">Traditional revision control tools make a permanent, 1.173 irreversible record of everything that you do. While this has 1.174 great value, it's also somewhat stifling. If you want to 1.175 perform a wild-eyed experiment, you have to be careful in how 1.176 @@ -160,7 +160,7 @@ 1.177 misleading or destabilising&emdash;traces of your missteps and 1.178 errors in the permanent revision record.</para> 1.179 1.180 - <para>By contrast, MQ's marriage of distributed revision control 1.181 + <para id="x_3c0">By contrast, MQ's marriage of distributed revision control 1.182 with patches makes it much easier to isolate your work. Your 1.183 patches live on top of normal revision history, and you can make 1.184 them disappear or reappear at will. If you don't like a patch, 1.185 @@ -168,7 +168,7 @@ 1.186 simply fix it&emdash;as many times as you need to, until you 1.187 have refined it into the form you desire.</para> 1.188 1.189 - <para>As an example, the integration of patches with revision 1.190 + <para id="x_3c1">As an example, the integration of patches with revision 1.191 control makes understanding patches and debugging their 1.192 effects&emdash;and their interplay with the code they're based 1.193 on&emdash;<emphasis>enormously</emphasis> easier. Since every 1.194 @@ -183,14 +183,14 @@ 1.195 And so on.</para> 1.196 1.197 </sect1> 1.198 - <sect1 id="sec.mq.patch"> 1.199 + <sect1 id="sec:mq:patch"> 1.200 <title>Understanding patches</title> 1.201 1.202 - <para>Because MQ doesn't hide its patch-oriented nature, it is 1.203 + <para id="x_3c2">Because MQ doesn't hide its patch-oriented nature, it is 1.204 helpful to understand what patches are, and a little about the 1.205 tools that work with them.</para> 1.206 1.207 - <para>The traditional Unix <command>diff</command> command 1.208 + <para id="x_3c3">The traditional Unix <command>diff</command> command 1.209 compares two files, and prints a list of differences between 1.210 them. The <command>patch</command> command understands these 1.211 differences as <emphasis>modifications</emphasis> to make to a 1.212 @@ -199,20 +199,20 @@ 1.213 1.214 &interaction.mq.dodiff.diff; 1.215 1.216 - <para>The type of file that <command>diff</command> generates (and 1.217 + <para id="x_3c4">The type of file that <command>diff</command> generates (and 1.218 <command>patch</command> takes as input) is called a 1.219 <quote>patch</quote> or a <quote>diff</quote>; there is no 1.220 difference between a patch and a diff. (We'll use the term 1.221 <quote>patch</quote>, since it's more commonly used.)</para> 1.222 1.223 - <para>A patch file can start with arbitrary text; the 1.224 + <para id="x_3c5">A patch file can start with arbitrary text; the 1.225 <command>patch</command> command ignores this text, but MQ uses 1.226 it as the commit message when creating changesets. To find the 1.227 beginning of the patch content, <command>patch</command> 1.228 searches for the first line that starts with the string 1.229 <quote><literal>diff -</literal></quote>.</para> 1.230 1.231 - <para>MQ works with <emphasis>unified</emphasis> diffs 1.232 + <para id="x_3c6">MQ works with <emphasis>unified</emphasis> diffs 1.233 (<command>patch</command> can accept several other diff formats, 1.234 but MQ doesn't). A unified diff contains two kinds of header. 1.235 The <emphasis>file header</emphasis> describes the file being 1.236 @@ -220,7 +220,7 @@ 1.237 <command>patch</command> sees a new file header, it looks for a 1.238 file with that name to start modifying.</para> 1.239 1.240 - <para>After the file header comes a series of 1.241 + <para id="x_3c7">After the file header comes a series of 1.242 <emphasis>hunks</emphasis>. Each hunk starts with a header; 1.243 this identifies the range of line numbers within the file that 1.244 the hunk should modify. Following the header, a hunk starts and 1.245 @@ -232,7 +232,7 @@ 1.246 runs the hunks together, with a few lines of context between 1.247 modifications.</para> 1.248 1.249 - <para>Each line of context begins with a space character. Within 1.250 + <para id="x_3c8">Each line of context begins with a space character. Within 1.251 the hunk, a line that begins with 1.252 <quote><literal>-</literal></quote> means <quote>remove this 1.253 line,</quote> while a line that begins with 1.254 @@ -240,16 +240,16 @@ 1.255 line.</quote> For example, a line that is modified is 1.256 represented by one deletion and one insertion.</para> 1.257 1.258 - <para>We will return to some of the more subtle aspects of patches 1.259 - later (in section <xref linkend="sec.mq.adv-patch"/>), but you 1.260 + <para id="x_3c9">We will return to some of the more subtle aspects of patches 1.261 + later (in <xref linkend="sec:mq:adv-patch"/>), but you 1.262 should have 1.263 enough information now to use MQ.</para> 1.264 1.265 </sect1> 1.266 - <sect1 id="sec.mq.start"> 1.267 + <sect1 id="sec:mq:start"> 1.268 <title>Getting started with Mercurial Queues</title> 1.269 1.270 - <para>Because MQ is implemented as an extension, you must 1.271 + <para id="x_3ca">Because MQ is implemented as an extension, you must 1.272 explicitly enable before you can use it. (You don't need to 1.273 download anything; MQ ships with the standard Mercurial 1.274 distribution.) To enable MQ, edit your <filename 1.275 @@ -259,7 +259,7 @@ 1.276 <programlisting>[extensions] 1.277 hgext.mq =</programlisting> 1.278 1.279 - <para>Once the extension is enabled, it will make a number of new 1.280 + <para id="x_3cb">Once the extension is enabled, it will make a number of new 1.281 commands available. To verify that the extension is working, 1.282 you can use <command role="hg-cmd">hg help</command> to see if 1.283 the <command role="hg-ext-mq">qinit</command> command is now 1.284 @@ -267,14 +267,14 @@ 1.285 1.286 &interaction.mq.qinit-help.help; 1.287 1.288 - <para>You can use MQ with <emphasis>any</emphasis> Mercurial 1.289 + <para id="x_3cc">You can use MQ with <emphasis>any</emphasis> Mercurial 1.290 repository, and its commands only operate within that 1.291 repository. To get started, simply prepare the repository using 1.292 the <command role="hg-ext-mq">qinit</command> command.</para> 1.293 1.294 &interaction.mq.tutorial.qinit; 1.295 1.296 - <para>This command creates an empty directory called <filename 1.297 + <para id="x_3cd">This command creates an empty directory called <filename 1.298 role="special" class="directory">.hg/patches</filename>, where 1.299 MQ will keep its metadata. As with many Mercurial commands, the 1.300 <command role="hg-ext-mq">qinit</command> command prints nothing 1.301 @@ -283,18 +283,18 @@ 1.302 <sect2> 1.303 <title>Creating a new patch</title> 1.304 1.305 - <para>To begin work on a new patch, use the <command 1.306 + <para id="x_3ce">To begin work on a new patch, use the <command 1.307 role="hg-ext-mq">qnew</command> command. This command takes 1.308 one argument, the name of the patch to create.</para> 1.309 1.310 - <para>MQ will use this as the name of an actual file in the 1.311 + <para id="x_3cf">MQ will use this as the name of an actual file in the 1.312 <filename role="special" 1.313 class="directory">.hg/patches</filename> directory, as you 1.314 can see below.</para> 1.315 1.316 &interaction.mq.tutorial.qnew; 1.317 1.318 - <para>Also newly present in the <filename role="special" 1.319 + <para id="x_3d0">Also newly present in the <filename role="special" 1.320 class="directory">.hg/patches</filename> directory are two 1.321 other files, <filename role="special">series</filename> and 1.322 <filename role="special">status</filename>. The <filename 1.323 @@ -306,7 +306,7 @@ 1.324 <emphasis>applied</emphasis> in this repository.</para> 1.325 1.326 <note> 1.327 - <para> You may sometimes want to edit the <filename 1.328 + <para id="x_3d1"> You may sometimes want to edit the <filename 1.329 role="special">series</filename> file by hand; for 1.330 example, to change the sequence in which some patches are 1.331 applied. However, manually editing the <filename 1.332 @@ -315,7 +315,7 @@ 1.333 happening.</para> 1.334 </note> 1.335 1.336 - <para>Once you have created your new patch, you can edit files 1.337 + <para id="x_3d2">Once you have created your new patch, you can edit files 1.338 in the working directory as you usually would. All of the 1.339 normal Mercurial commands, such as <command role="hg-cmd">hg 1.340 diff</command> and <command role="hg-cmd">hg 1.341 @@ -325,17 +325,17 @@ 1.342 <sect2> 1.343 <title>Refreshing a patch</title> 1.344 1.345 - <para>When you reach a point where you want to save your work, 1.346 + <para id="x_3d3">When you reach a point where you want to save your work, 1.347 use the <command role="hg-ext-mq">qrefresh</command> command 1.348 to update the patch you are working on.</para> 1.349 1.350 &interaction.mq.tutorial.qrefresh; 1.351 1.352 - <para>This command folds the changes you have made in the 1.353 + <para id="x_3d4">This command folds the changes you have made in the 1.354 working directory into your patch, and updates its 1.355 corresponding changeset to contain those changes.</para> 1.356 1.357 - <para>You can run <command role="hg-ext-mq">qrefresh</command> 1.358 + <para id="x_3d5">You can run <command role="hg-ext-mq">qrefresh</command> 1.359 as often as you like, so it's a good way to 1.360 <quote>checkpoint</quote> your work. Refresh your patch at an 1.361 opportune time; try an experiment; and if the experiment 1.362 @@ -348,19 +348,19 @@ 1.363 <sect2> 1.364 <title>Stacking and tracking patches</title> 1.365 1.366 - <para>Once you have finished working on a patch, or need to work 1.367 + <para id="x_3d6">Once you have finished working on a patch, or need to work 1.368 on another, you can use the <command 1.369 role="hg-ext-mq">qnew</command> command again to create a 1.370 new patch. Mercurial will apply this patch on top of your 1.371 existing patch.</para> 1.372 1.373 &interaction.mq.tutorial.qnew2; 1.374 - <para>Notice that the patch contains the changes in our prior 1.375 + <para id="x_3d7">Notice that the patch contains the changes in our prior 1.376 patch as part of its context (you can see this more clearly in 1.377 the output of <command role="hg-cmd">hg 1.378 annotate</command>).</para> 1.379 1.380 - <para>So far, with the exception of <command 1.381 + <para id="x_3d8">So far, with the exception of <command 1.382 role="hg-ext-mq">qnew</command> and <command 1.383 role="hg-ext-mq">qrefresh</command>, we've been careful to 1.384 only use regular Mercurial commands. However, MQ provides 1.385 @@ -370,13 +370,13 @@ 1.386 &interaction.mq.tutorial.qseries; 1.387 1.388 <itemizedlist> 1.389 - <listitem><para>The <command 1.390 + <listitem><para id="x_3d9">The <command 1.391 role="hg-ext-mq">qseries</command> command lists every 1.392 patch that MQ knows about in this repository, from oldest 1.393 to newest (most recently 1.394 <emphasis>created</emphasis>).</para> 1.395 </listitem> 1.396 - <listitem><para>The <command 1.397 + <listitem><para id="x_3da">The <command 1.398 role="hg-ext-mq">qapplied</command> command lists every 1.399 patch that MQ has <emphasis>applied</emphasis> in this 1.400 repository, again from oldest to newest (most recently 1.401 @@ -387,12 +387,12 @@ 1.402 <sect2> 1.403 <title>Manipulating the patch stack</title> 1.404 1.405 - <para>The previous discussion implied that there must be a 1.406 + <para id="x_3db">The previous discussion implied that there must be a 1.407 difference between <quote>known</quote> and 1.408 <quote>applied</quote> patches, and there is. MQ can manage a 1.409 patch without it being applied in the repository.</para> 1.410 1.411 - <para>An <emphasis>applied</emphasis> patch has a corresponding 1.412 + <para id="x_3dc">An <emphasis>applied</emphasis> patch has a corresponding 1.413 changeset in the repository, and the effects of the patch and 1.414 changeset are visible in the working directory. You can undo 1.415 the application of a patch using the <command 1.416 @@ -400,20 +400,20 @@ 1.417 <emphasis>knows about</emphasis>, or manages, a popped patch, 1.418 but the patch no longer has a corresponding changeset in the 1.419 repository, and the working directory does not contain the 1.420 - changes made by the patch. Figure <xref 1.421 - endterm="fig.mq.stack.caption" linkend="fig.mq.stack"/> illustrates 1.422 + changes made by the patch. <xref 1.423 + linkend="fig:mq:stack"/> illustrates 1.424 the difference between applied and tracked patches.</para> 1.425 1.426 - <informalfigure id="fig.mq.stack"> 1.427 - <mediaobject> 1.428 - <imageobject><imagedata fileref="images/mq-stack.png"/></imageobject> 1.429 - <textobject><phrase>XXX add text</phrase></textobject> 1.430 - <caption><para id="fig.mq.stack.caption">Applied and unapplied patches 1.431 - in the MQ patch stack</para></caption> 1.432 - </mediaobject> 1.433 - </informalfigure> 1.434 - 1.435 - <para>You can reapply an unapplied, or popped, patch using the 1.436 + <figure id="fig:mq:stack"> 1.437 + <title>Applied and unapplied patches in the MQ patch 1.438 + stack</title> 1.439 + <mediaobject> 1.440 + <imageobject><imagedata fileref="figs/mq-stack.png"/></imageobject> 1.441 + <textobject><phrase>XXX add text</phrase></textobject> 1.442 + </mediaobject> 1.443 + </figure> 1.444 + 1.445 + <para id="x_3de">You can reapply an unapplied, or popped, patch using the 1.446 <command role="hg-ext-mq">qpush</command> command. This 1.447 creates a new changeset to correspond to the patch, and the 1.448 patch's changes once again become present in the working 1.449 @@ -422,7 +422,7 @@ 1.450 role="hg-ext-mq">qpush</command> in action.</para> 1.451 &interaction.mq.tutorial.qpop; 1.452 1.453 - <para>Notice that once we have popped a patch or two patches, 1.454 + <para id="x_3df">Notice that once we have popped a patch or two patches, 1.455 the output of <command role="hg-ext-mq">qseries</command> 1.456 remains the same, while that of <command 1.457 role="hg-ext-mq">qapplied</command> has changed.</para> 1.458 @@ -432,7 +432,7 @@ 1.459 <sect2> 1.460 <title>Pushing and popping many patches</title> 1.461 1.462 - <para>While <command role="hg-ext-mq">qpush</command> and 1.463 + <para id="x_3e0">While <command role="hg-ext-mq">qpush</command> and 1.464 <command role="hg-ext-mq">qpop</command> each operate on a 1.465 single patch at a time by default, you can push and pop many 1.466 patches in one go. The <option 1.467 @@ -442,8 +442,7 @@ 1.468 role="hg-ext-mq-cmd-qpop-opt">-a</option> option to <command 1.469 role="hg-ext-mq">qpop</command> causes it to pop all applied 1.470 patches. (For some more ways to push and pop many patches, 1.471 - see section <xref linkend="sec.mq.perf"/> 1.472 - below.)</para> 1.473 + see <xref linkend="sec:mq:perf"/> below.)</para> 1.474 1.475 &interaction.mq.tutorial.qpush-a; 1.476 1.477 @@ -451,7 +450,7 @@ 1.478 <sect2> 1.479 <title>Safety checks, and overriding them</title> 1.480 1.481 - <para>Several MQ commands check the working directory before 1.482 + <para id="x_3e1">Several MQ commands check the working directory before 1.483 they do anything, and fail if they find any modifications. 1.484 They do this to ensure that you won't lose any changes that 1.485 you have made, but not yet incorporated into a patch. The 1.486 @@ -463,7 +462,7 @@ 1.487 1.488 &interaction.mq.tutorial.add; 1.489 1.490 - <para>Commands that check the working directory all take an 1.491 + <para id="x_3e2">Commands that check the working directory all take an 1.492 <quote>I know what I'm doing</quote> option, which is always 1.493 named <option>-f</option>. The exact meaning of 1.494 <option>-f</option> depends on the command. For example, 1.495 @@ -480,14 +479,14 @@ 1.496 <sect2> 1.497 <title>Working on several patches at once</title> 1.498 1.499 - <para>The <command role="hg-ext-mq">qrefresh</command> command 1.500 + <para id="x_3e3">The <command role="hg-ext-mq">qrefresh</command> command 1.501 always refreshes the <emphasis>topmost</emphasis> applied 1.502 patch. This means that you can suspend work on one patch (by 1.503 refreshing it), pop or push to make a different patch the top, 1.504 and work on <emphasis>that</emphasis> patch for a 1.505 while.</para> 1.506 1.507 - <para>Here's an example that illustrates how you can use this 1.508 + <para id="x_3e4">Here's an example that illustrates how you can use this 1.509 ability. Let's say you're developing a new feature as two 1.510 patches. The first is a change to the core of your software, 1.511 and the second&emdash;layered on top of the 1.512 @@ -503,10 +502,10 @@ 1.513 1.514 </sect2> 1.515 </sect1> 1.516 - <sect1 id="sec.mq.adv-patch"> 1.517 + <sect1 id="sec:mq:adv-patch"> 1.518 <title>More about patches</title> 1.519 1.520 - <para>MQ uses the GNU <command>patch</command> command to apply 1.521 + <para id="x_3e5">MQ uses the GNU <command>patch</command> command to apply 1.522 patches, so it's helpful to know a few more detailed aspects of 1.523 how <command>patch</command> works, and about patches 1.524 themselves.</para> 1.525 @@ -514,14 +513,14 @@ 1.526 <sect2> 1.527 <title>The strip count</title> 1.528 1.529 - <para>If you look at the file headers in a patch, you will 1.530 + <para id="x_3e6">If you look at the file headers in a patch, you will 1.531 notice that the pathnames usually have an extra component on 1.532 the front that isn't present in the actual path name. This is 1.533 a holdover from the way that people used to generate patches 1.534 (people still do this, but it's somewhat rare with modern 1.535 revision control tools).</para> 1.536 1.537 - <para>Alice would unpack a tarball, edit her files, then decide 1.538 + <para id="x_3e7">Alice would unpack a tarball, edit her files, then decide 1.539 that she wanted to create a patch. So she'd rename her 1.540 working directory, unpack the tarball again (hence the need 1.541 for the rename), and use the <option 1.542 @@ -534,7 +533,7 @@ 1.543 header, and the name of the modified directory would be at the 1.544 front of the right-hand path.</para> 1.545 1.546 - <para>Since someone receiving a patch from the Alices of the net 1.547 + <para id="x_3e8">Since someone receiving a patch from the Alices of the net 1.548 would be unlikely to have unmodified and modified directories 1.549 with exactly the same names, the <command>patch</command> 1.550 command has a <option role="cmd-opt-patch">-p</option> option 1.551 @@ -542,7 +541,7 @@ 1.552 strip when trying to apply a patch. This number is called the 1.553 <emphasis>strip count</emphasis>.</para> 1.554 1.555 - <para>An option of <quote><literal>-p1</literal></quote> means 1.556 + <para id="x_3e9">An option of <quote><literal>-p1</literal></quote> means 1.557 <quote>use a strip count of one</quote>. If 1.558 <command>patch</command> sees a file name 1.559 <filename>foo/bar/baz</filename> in a file header, it will 1.560 @@ -555,7 +554,7 @@ 1.561 but <filename>/foo/bar</filename> (notice the extra leading 1.562 slash) into <filename>foo/bar</filename>.)</para> 1.563 1.564 - <para>The <quote>standard</quote> strip count for patches is 1.565 + <para id="x_3ea">The <quote>standard</quote> strip count for patches is 1.566 one; almost all patches contain one leading path name 1.567 component that needs to be stripped. Mercurial's <command 1.568 role="hg-cmd">hg diff</command> command generates path names 1.569 @@ -563,7 +562,7 @@ 1.570 import</command> command and MQ expect patches to have a 1.571 strip count of one.</para> 1.572 1.573 - <para>If you receive a patch from someone that you want to add 1.574 + <para id="x_3eb">If you receive a patch from someone that you want to add 1.575 to your patch queue, and the patch needs a strip count other 1.576 than one, you cannot just <command 1.577 role="hg-ext-mq">qimport</command> the patch, because 1.578 @@ -584,14 +583,14 @@ 1.579 <sect2> 1.580 <title>Strategies for applying a patch</title> 1.581 1.582 - <para>When <command>patch</command> applies a hunk, it tries a 1.583 + <para id="x_3ec">When <command>patch</command> applies a hunk, it tries a 1.584 handful of successively less accurate strategies to try to 1.585 make the hunk apply. This falling-back technique often makes 1.586 it possible to take a patch that was generated against an old 1.587 version of a file, and apply it against a newer version of 1.588 that file.</para> 1.589 1.590 - <para>First, <command>patch</command> tries an exact match, 1.591 + <para id="x_3ed">First, <command>patch</command> tries an exact match, 1.592 where the line numbers, the context, and the text to be 1.593 modified must apply exactly. If it cannot make an exact 1.594 match, it tries to find an exact match for the context, 1.595 @@ -600,7 +599,7 @@ 1.596 applied, but at some <emphasis>offset</emphasis> from the 1.597 original line number.</para> 1.598 1.599 - <para>If a context-only match fails, <command>patch</command> 1.600 + <para id="x_3ee">If a context-only match fails, <command>patch</command> 1.601 removes the first and last lines of the context, and tries a 1.602 <emphasis>reduced</emphasis> context-only match. If the hunk 1.603 with reduced context succeeds, it prints a message saying that 1.604 @@ -609,7 +608,7 @@ 1.605 context <command>patch</command> had to trim before the patch 1.606 applied).</para> 1.607 1.608 - <para>When neither of these techniques works, 1.609 + <para id="x_3ef">When neither of these techniques works, 1.610 <command>patch</command> prints a message saying that the hunk 1.611 in question was rejected. It saves rejected hunks (also 1.612 simply called <quote>rejects</quote>) to a file with the same 1.613 @@ -629,36 +628,36 @@ 1.614 <sect2> 1.615 <title>Some quirks of patch representation</title> 1.616 1.617 - <para>There are a few useful things to know about how 1.618 + <para id="x_3f0">There are a few useful things to know about how 1.619 <command>patch</command> works with files.</para> 1.620 <itemizedlist> 1.621 - <listitem><para>This should already be obvious, but 1.622 + <listitem><para id="x_3f1">This should already be obvious, but 1.623 <command>patch</command> cannot handle binary 1.624 files.</para> 1.625 </listitem> 1.626 - <listitem><para>Neither does it care about the executable bit; 1.627 + <listitem><para id="x_3f2">Neither does it care about the executable bit; 1.628 it creates new files as readable, but not 1.629 executable.</para> 1.630 </listitem> 1.631 - <listitem><para><command>patch</command> treats the removal of 1.632 + <listitem><para id="x_3f3"><command>patch</command> treats the removal of 1.633 a file as a diff between the file to be removed and the 1.634 empty file. So your idea of <quote>I deleted this 1.635 file</quote> looks like <quote>every line of this file 1.636 was deleted</quote> in a patch.</para> 1.637 </listitem> 1.638 - <listitem><para>It treats the addition of a file as a diff 1.639 + <listitem><para id="x_3f4">It treats the addition of a file as a diff 1.640 between the empty file and the file to be added. So in a 1.641 patch, your idea of <quote>I added this file</quote> looks 1.642 like <quote>every line of this file was 1.643 added</quote>.</para> 1.644 </listitem> 1.645 - <listitem><para>It treats a renamed file as the removal of the 1.646 + <listitem><para id="x_3f5">It treats a renamed file as the removal of the 1.647 old name, and the addition of the new name. This means 1.648 that renamed files have a big footprint in patches. (Note 1.649 also that Mercurial does not currently try to infer when 1.650 files have been renamed or copied in a patch.)</para> 1.651 </listitem> 1.652 - <listitem><para><command>patch</command> cannot represent 1.653 + <listitem><para id="x_3f6"><command>patch</command> cannot represent 1.654 empty files, so you cannot use a patch to represent the 1.655 notion <quote>I added this empty file to the 1.656 tree</quote>.</para> 1.657 @@ -667,7 +666,7 @@ 1.658 <sect2> 1.659 <title>Beware the fuzz</title> 1.660 1.661 - <para>While applying a hunk at an offset, or with a fuzz factor, 1.662 + <para id="x_3f7">While applying a hunk at an offset, or with a fuzz factor, 1.663 will often be completely successful, these inexact techniques 1.664 naturally leave open the possibility of corrupting the patched 1.665 file. The most common cases typically involve applying a 1.666 @@ -677,7 +676,7 @@ 1.667 fuzz factor, you should make sure that the modified files are 1.668 correct afterwards.</para> 1.669 1.670 - <para>It's often a good idea to refresh a patch that has applied 1.671 + <para id="x_3f8">It's often a good idea to refresh a patch that has applied 1.672 with an offset or fuzz factor; refreshing the patch generates 1.673 new context information that will make it apply cleanly. I 1.674 say <quote>often,</quote> not <quote>always,</quote> because 1.675 @@ -692,30 +691,29 @@ 1.676 <sect2> 1.677 <title>Handling rejection</title> 1.678 1.679 - <para>If <command role="hg-ext-mq">qpush</command> fails to 1.680 + <para id="x_3f9">If <command role="hg-ext-mq">qpush</command> fails to 1.681 apply a patch, it will print an error message and exit. If it 1.682 has left <filename role="special">.rej</filename> files 1.683 behind, it is usually best to fix up the rejected hunks before 1.684 you push more patches or do any further work.</para> 1.685 1.686 - <para>If your patch <emphasis>used to</emphasis> apply cleanly, 1.687 + <para id="x_3fa">If your patch <emphasis>used to</emphasis> apply cleanly, 1.688 and no longer does because you've changed the underlying code 1.689 that your patches are based on, Mercurial Queues can help; see 1.690 - section <xref 1.691 - linkend="sec.mq.merge"/> for details.</para> 1.692 - 1.693 - <para>Unfortunately, there aren't any great techniques for 1.694 + <xref linkend="sec:mq:merge"/> for details.</para> 1.695 + 1.696 + <para id="x_3fb">Unfortunately, there aren't any great techniques for 1.697 dealing with rejected hunks. Most often, you'll need to view 1.698 the <filename role="special">.rej</filename> file and edit the 1.699 target file, applying the rejected hunks by hand.</para> 1.700 1.701 - <para>If you're feeling adventurous, Neil Brown, a Linux kernel 1.702 + <para id="x_3fc">If you're feeling adventurous, Neil Brown, a Linux kernel 1.703 hacker, wrote a tool called <command>wiggle</command> 1.704 <citation>web:wiggle</citation>, which is more vigorous than 1.705 <command>patch</command> in its attempts to make a patch 1.706 apply.</para> 1.707 1.708 - <para>Another Linux kernel hacker, Chris Mason (the author of 1.709 + <para id="x_3fd">Another Linux kernel hacker, Chris Mason (the author of 1.710 Mercurial Queues), wrote a similar tool called 1.711 <command>mpatch</command> <citation>web:mpatch</citation>, 1.712 which takes a simple approach to automating the application of 1.713 @@ -724,21 +722,21 @@ 1.714 reasons that a hunk may be rejected:</para> 1.715 1.716 <itemizedlist> 1.717 - <listitem><para>The context in the middle of a hunk has 1.718 + <listitem><para id="x_3fe">The context in the middle of a hunk has 1.719 changed.</para> 1.720 </listitem> 1.721 - <listitem><para>A hunk is missing some context at the 1.722 + <listitem><para id="x_3ff">A hunk is missing some context at the 1.723 beginning or end.</para> 1.724 </listitem> 1.725 - <listitem><para>A large hunk might apply better&emdash;either 1.726 + <listitem><para id="x_400">A large hunk might apply better&emdash;either 1.727 entirely or in part&emdash;if it was broken up into 1.728 smaller hunks.</para> 1.729 </listitem> 1.730 - <listitem><para>A hunk removes lines with slightly different 1.731 + <listitem><para id="x_401">A hunk removes lines with slightly different 1.732 content than those currently present in the file.</para> 1.733 </listitem></itemizedlist> 1.734 1.735 - <para>If you use <command>wiggle</command> or 1.736 + <para id="x_402">If you use <command>wiggle</command> or 1.737 <command>mpatch</command>, you should be doubly careful to 1.738 check your results when you're done. In fact, 1.739 <command>mpatch</command> enforces this method of 1.740 @@ -749,10 +747,10 @@ 1.741 1.742 </sect2> 1.743 </sect1> 1.744 - <sect1 id="sec.mq.perf"> 1.745 + <sect1 id="sec:mq:perf"> 1.746 <title>Getting the best performance out of MQ</title> 1.747 1.748 - <para>MQ is very efficient at handling a large number of patches. 1.749 + <para id="x_403">MQ is very efficient at handling a large number of patches. 1.750 I ran some performance experiments in mid-2006 for a talk that I 1.751 gave at the 2006 EuroPython conference 1.752 <citation>web:europython</citation>. I used as my data set the 1.753 @@ -761,7 +759,7 @@ 1.754 all 27,472 revisions between Linux 2.6.12-rc2 and Linux 1.755 2.6.17.</para> 1.756 1.757 - <para>On my old, slow laptop, I was able to <command 1.758 + <para id="x_404">On my old, slow laptop, I was able to <command 1.759 role="hg-cmd">hg qpush <option 1.760 role="hg-ext-mq-cmd-qpush-opt">hg -a</option></command> all 1.761 1,738 patches in 3.5 minutes, and <command role="hg-cmd">hg qpop 1.762 @@ -772,11 +770,11 @@ 1.763 (which made 22,779 lines of changes to 287 files) in 6.6 1.764 seconds.</para> 1.765 1.766 - <para>Clearly, MQ is well suited to working in large trees, but 1.767 + <para id="x_405">Clearly, MQ is well suited to working in large trees, but 1.768 there are a few tricks you can use to get the best performance 1.769 of it.</para> 1.770 1.771 - <para>First of all, try to <quote>batch</quote> operations 1.772 + <para id="x_406">First of all, try to <quote>batch</quote> operations 1.773 together. Every time you run <command 1.774 role="hg-ext-mq">qpush</command> or <command 1.775 role="hg-ext-mq">qpop</command>, these commands scan the 1.776 @@ -787,7 +785,7 @@ 1.777 medium-sized tree (containing tens of thousands of files), it 1.778 can take a second or more.</para> 1.779 1.780 - <para>The <command role="hg-ext-mq">qpush</command> and <command 1.781 + <para id="x_407">The <command role="hg-ext-mq">qpush</command> and <command 1.782 role="hg-ext-mq">qpop</command> commands allow you to push and 1.783 pop multiple patches at a time. You can identify the 1.784 <quote>destination patch</quote> that you want to end up at. 1.785 @@ -797,17 +795,17 @@ 1.786 role="hg-ext-mq">qpop</command> to a destination, MQ will pop 1.787 patches until the destination patch is at the top.</para> 1.788 1.789 - <para>You can identify a destination patch using either the name 1.790 + <para id="x_408">You can identify a destination patch using either the name 1.791 of the patch, or by number. If you use numeric addressing, 1.792 patches are counted from zero; this means that the first patch 1.793 is zero, the second is one, and so on.</para> 1.794 1.795 </sect1> 1.796 - <sect1 id="sec.mq.merge"> 1.797 + <sect1 id="sec:mq:merge"> 1.798 <title>Updating your patches when the underlying code 1.799 changes</title> 1.800 1.801 - <para>It's common to have a stack of patches on top of an 1.802 + <para id="x_409">It's common to have a stack of patches on top of an 1.803 underlying repository that you don't modify directly. If you're 1.804 working on changes to third-party code, or on a feature that is 1.805 taking longer to develop than the rate of change of the code 1.806 @@ -816,7 +814,7 @@ 1.807 This is called <emphasis>rebasing</emphasis> your patch 1.808 series.</para> 1.809 1.810 - <para>The simplest way to do this is to <command role="hg-cmd">hg 1.811 + <para id="x_40a">The simplest way to do this is to <command role="hg-cmd">hg 1.812 qpop <option role="hg-ext-mq-cmd-qpop-opt">hg 1.813 -a</option></command> your patches, then <command 1.814 role="hg-cmd">hg pull</command> changes into the underlying 1.815 @@ -828,26 +826,26 @@ 1.816 affected patch, and continue pushing until you have fixed your 1.817 entire stack.</para> 1.818 1.819 - <para>This approach is easy to use and works well if you don't 1.820 + <para id="x_40b">This approach is easy to use and works well if you don't 1.821 expect changes to the underlying code to affect how well your 1.822 patches apply. If your patch stack touches code that is modified 1.823 frequently or invasively in the underlying repository, however, 1.824 fixing up rejected hunks by hand quickly becomes 1.825 tiresome.</para> 1.826 1.827 - <para>It's possible to partially automate the rebasing process. 1.828 + <para id="x_40c">It's possible to partially automate the rebasing process. 1.829 If your patches apply cleanly against some revision of the 1.830 underlying repo, MQ can use this information to help you to 1.831 resolve conflicts between your patches and a different 1.832 revision.</para> 1.833 1.834 - <para>The process is a little involved.</para> 1.835 + <para id="x_40d">The process is a little involved.</para> 1.836 <orderedlist> 1.837 - <listitem><para>To begin, <command role="hg-cmd">hg qpush 1.838 + <listitem><para id="x_40e">To begin, <command role="hg-cmd">hg qpush 1.839 -a</command> all of your patches on top of the revision 1.840 where you know that they apply cleanly.</para> 1.841 </listitem> 1.842 - <listitem><para>Save a backup copy of your patch directory using 1.843 + <listitem><para id="x_40f">Save a backup copy of your patch directory using 1.844 <command role="hg-cmd">hg qsave <option 1.845 role="hg-ext-mq-cmd-qsave-opt">hg -e</option> <option 1.846 role="hg-ext-mq-cmd-qsave-opt">hg -c</option></command>. 1.847 @@ -861,17 +859,17 @@ 1.848 states of the <filename role="special">series</filename> and 1.849 <filename role="special">status</filename> files.</para> 1.850 </listitem> 1.851 - <listitem><para>Use <command role="hg-cmd">hg pull</command> to 1.852 + <listitem><para id="x_410">Use <command role="hg-cmd">hg pull</command> to 1.853 bring new changes into the underlying repository. (Don't 1.854 run <command role="hg-cmd">hg pull -u</command>; see below 1.855 for why.)</para> 1.856 </listitem> 1.857 - <listitem><para>Update to the new tip revision, using <command 1.858 + <listitem><para id="x_411">Update to the new tip revision, using <command 1.859 role="hg-cmd">hg update <option 1.860 role="hg-opt-update">-C</option></command> to override 1.861 the patches you have pushed.</para> 1.862 </listitem> 1.863 - <listitem><para>Merge all patches using <command>hg qpush -m 1.864 + <listitem><para id="x_412">Merge all patches using <command>hg qpush -m 1.865 -a</command>. The <option 1.866 role="hg-ext-mq-cmd-qpush-opt">-m</option> option to 1.867 <command role="hg-ext-mq">qpush</command> tells MQ to 1.868 @@ -879,7 +877,7 @@ 1.869 apply.</para> 1.870 </listitem></orderedlist> 1.871 1.872 - <para>During the <command role="hg-cmd">hg qpush <option 1.873 + <para id="x_413">During the <command role="hg-cmd">hg qpush <option 1.874 role="hg-ext-mq-cmd-qpush-opt">hg -m</option></command>, 1.875 each patch in the <filename role="special">series</filename> 1.876 file is applied normally. If a patch applies with fuzz or 1.877 @@ -889,10 +887,10 @@ 1.878 Mercurial's normal merge machinery, so it may pop up a GUI merge 1.879 tool to help you to resolve problems.</para> 1.880 1.881 - <para>When you finish resolving the effects of a patch, MQ 1.882 + <para id="x_414">When you finish resolving the effects of a patch, MQ 1.883 refreshes your patch based on the result of the merge.</para> 1.884 1.885 - <para>At the end of this process, your repository will have one 1.886 + <para id="x_415">At the end of this process, your repository will have one 1.887 extra head from the old patch queue, and a copy of the old patch 1.888 queue will be in <filename role="special" 1.889 class="directory">.hg/patches.N</filename>. You can remove the 1.890 @@ -906,26 +904,26 @@ 1.891 <sect1> 1.892 <title>Identifying patches</title> 1.893 1.894 - <para>MQ commands that work with patches let you refer to a patch 1.895 + <para id="x_416">MQ commands that work with patches let you refer to a patch 1.896 either by using its name or by a number. By name is obvious 1.897 enough; pass the name <filename>foo.patch</filename> to <command 1.898 role="hg-ext-mq">qpush</command>, for example, and it will 1.899 push patches until <filename>foo.patch</filename> is 1.900 applied.</para> 1.901 1.902 - <para>As a shortcut, you can refer to a patch using both a name 1.903 + <para id="x_417">As a shortcut, you can refer to a patch using both a name 1.904 and a numeric offset; <literal>foo.patch-2</literal> means 1.905 <quote>two patches before <literal>foo.patch</literal></quote>, 1.906 while <literal>bar.patch+4</literal> means <quote>four patches 1.907 after <literal>bar.patch</literal></quote>.</para> 1.908 1.909 - <para>Referring to a patch by index isn't much different. The 1.910 + <para id="x_418">Referring to a patch by index isn't much different. The 1.911 first patch printed in the output of <command 1.912 role="hg-ext-mq">qseries</command> is patch zero (yes, it's 1.913 one of those start-at-zero counting systems); the second is 1.914 patch one; and so on.</para> 1.915 1.916 - <para>MQ also makes it easy to work with patches when you are 1.917 + <para id="x_419">MQ also makes it easy to work with patches when you are 1.918 using normal Mercurial commands. Every command that accepts a 1.919 changeset ID will also accept the name of an applied patch. MQ 1.920 augments the tags normally in the repository with an eponymous 1.921 @@ -935,28 +933,28 @@ 1.922 the <quote>bottom-most</quote> and topmost applied patches, 1.923 respectively.</para> 1.924 1.925 - <para>These additions to Mercurial's normal tagging capabilities 1.926 + <para id="x_41a">These additions to Mercurial's normal tagging capabilities 1.927 make dealing with patches even more of a breeze.</para> 1.928 <itemizedlist> 1.929 - <listitem><para>Want to patchbomb a mailing list with your 1.930 + <listitem><para id="x_41b">Want to patchbomb a mailing list with your 1.931 latest series of changes?</para> 1.932 <programlisting>hg email qbase:qtip</programlisting> 1.933 - <para> (Don't know what <quote>patchbombing</quote> is? See 1.934 - section <xref linkend="sec.hgext.patchbomb"/>.)</para> 1.935 + <para id="x_41c"> (Don't know what <quote>patchbombing</quote> is? See 1.936 + <xref linkend="sec:hgext:patchbomb"/>.)</para> 1.937 </listitem> 1.938 - <listitem><para>Need to see all of the patches since 1.939 + <listitem><para id="x_41d">Need to see all of the patches since 1.940 <literal>foo.patch</literal> that have touched files in a 1.941 subdirectory of your tree?</para> 1.942 <programlisting>hg log -r foo.patch:qtip subdir</programlisting> 1.943 </listitem> 1.944 </itemizedlist> 1.945 1.946 - <para>Because MQ makes the names of patches available to the rest 1.947 + <para id="x_41e">Because MQ makes the names of patches available to the rest 1.948 of Mercurial through its normal internal tag machinery, you 1.949 don't need to type in the entire name of a patch when you want 1.950 to identify it by name.</para> 1.951 1.952 - <para>Another nice consequence of representing patch names as tags 1.953 + <para id="x_41f">Another nice consequence of representing patch names as tags 1.954 is that when you run the <command role="hg-cmd">hg log</command> 1.955 command, it will display a patch's name as a tag, simply as part 1.956 of its normal output. This makes it easy to visually 1.957 @@ -971,21 +969,21 @@ 1.958 <sect1> 1.959 <title>Useful things to know about</title> 1.960 1.961 - <para>There are a number of aspects of MQ usage that don't fit 1.962 + <para id="x_420">There are a number of aspects of MQ usage that don't fit 1.963 tidily into sections of their own, but that are good to know. 1.964 Here they are, in one place.</para> 1.965 1.966 <itemizedlist> 1.967 - <listitem><para>Normally, when you <command 1.968 + <listitem><para id="x_421">Normally, when you <command 1.969 role="hg-ext-mq">qpop</command> a patch and <command 1.970 role="hg-ext-mq">qpush</command> it again, the changeset 1.971 that represents the patch after the pop/push will have a 1.972 <emphasis>different identity</emphasis> than the changeset 1.973 - that represented the hash beforehand. See section <xref 1.974 - linkend="sec.mqref.cmd.qpush"/> for 1.975 + that represented the hash beforehand. See <xref 1.976 + linkend="sec:mqref:cmd:qpush"/> for 1.977 information as to why this is.</para> 1.978 </listitem> 1.979 - <listitem><para>It's not a good idea to <command 1.980 + <listitem><para id="x_422">It's not a good idea to <command 1.981 role="hg-cmd">hg merge</command> changes from another 1.982 branch with a patch changeset, at least if you want to 1.983 maintain the <quote>patchiness</quote> of that changeset and 1.984 @@ -995,16 +993,16 @@ 1.985 </listitem></itemizedlist> 1.986 1.987 </sect1> 1.988 - <sect1 id="sec.mq.repo"> 1.989 + <sect1 id="sec:mq:repo"> 1.990 <title>Managing patches in a repository</title> 1.991 1.992 - <para>Because MQ's <filename role="special" 1.993 + <para id="x_423">Because MQ's <filename role="special" 1.994 class="directory">.hg/patches</filename> directory resides 1.995 outside a Mercurial repository's working directory, the 1.996 <quote>underlying</quote> Mercurial repository knows nothing 1.997 about the management or presence of patches.</para> 1.998 1.999 - <para>This presents the interesting possibility of managing the 1.1000 + <para id="x_424">This presents the interesting possibility of managing the 1.1001 contents of the patch directory as a Mercurial repository in its 1.1002 own right. This can be a useful way to work. For example, you 1.1003 can work on a patch for a while, <command 1.1004 @@ -1013,7 +1011,7 @@ 1.1005 patch. This lets you <quote>roll back</quote> to that version 1.1006 of the patch later on.</para> 1.1007 1.1008 - <para>You can then share different versions of the same patch 1.1009 + <para id="x_425">You can then share different versions of the same patch 1.1010 stack among multiple underlying repositories. I use this when I 1.1011 am developing a Linux kernel feature. I have a pristine copy of 1.1012 my kernel sources for each of several CPU architectures, and a 1.1013 @@ -1023,7 +1021,7 @@ 1.1014 associated with that kernel tree, pop and push all of my 1.1015 patches, and build and test that kernel.</para> 1.1016 1.1017 - <para>Managing patches in a repository makes it possible for 1.1018 + <para id="x_426">Managing patches in a repository makes it possible for 1.1019 multiple developers to work on the same patch series without 1.1020 colliding with each other, all on top of an underlying source 1.1021 base that they may or may not control.</para> 1.1022 @@ -1031,7 +1029,7 @@ 1.1023 <sect2> 1.1024 <title>MQ support for patch repositories</title> 1.1025 1.1026 - <para>MQ helps you to work with the <filename role="special" 1.1027 + <para id="x_427">MQ helps you to work with the <filename role="special" 1.1028 class="directory">.hg/patches</filename> directory as a 1.1029 repository; when you prepare a repository for working with 1.1030 patches using <command role="hg-ext-mq">qinit</command>, you 1.1031 @@ -1041,7 +1039,7 @@ 1.1032 Mercurial repository.</para> 1.1033 1.1034 <note> 1.1035 - <para> If you forget to use the <option 1.1036 + <para id="x_428"> If you forget to use the <option 1.1037 role="hg-ext-mq-cmd-qinit-opt">hg -c</option> option, you 1.1038 can simply go into the <filename role="special" 1.1039 class="directory">.hg/patches</filename> directory at any 1.1040 @@ -1050,25 +1048,25 @@ 1.1041 role="special">status</filename> file to the <filename 1.1042 role="special">.hgignore</filename> file, though</para> 1.1043 1.1044 - <para> (<command role="hg-cmd">hg qinit <option 1.1045 + <para id="x_429"> (<command role="hg-cmd">hg qinit <option 1.1046 role="hg-ext-mq-cmd-qinit-opt">hg -c</option></command> 1.1047 does this for you automatically); you 1.1048 <emphasis>really</emphasis> don't want to manage the 1.1049 <filename role="special">status</filename> file.</para> 1.1050 </note> 1.1051 1.1052 - <para>As a convenience, if MQ notices that the <filename 1.1053 + <para id="x_42a">As a convenience, if MQ notices that the <filename 1.1054 class="directory">.hg/patches</filename> directory is a 1.1055 repository, it will automatically <command role="hg-cmd">hg 1.1056 add</command> every patch that you create and import.</para> 1.1057 1.1058 - <para>MQ provides a shortcut command, <command 1.1059 + <para id="x_42b">MQ provides a shortcut command, <command 1.1060 role="hg-ext-mq">qcommit</command>, that runs <command 1.1061 role="hg-cmd">hg commit</command> in the <filename 1.1062 role="special" class="directory">.hg/patches</filename> 1.1063 directory. This saves some bothersome typing.</para> 1.1064 1.1065 - <para>Finally, as a convenience to manage the patch directory, 1.1066 + <para id="x_42c">Finally, as a convenience to manage the patch directory, 1.1067 you can define the alias <command>mq</command> on Unix 1.1068 systems. For example, on Linux systems using the 1.1069 <command>bash</command> shell, you can include the following 1.1070 @@ -1077,17 +1075,17 @@ 1.1071 1.1072 <programlisting>alias mq=`hg -R $(hg root)/.hg/patches'</programlisting> 1.1073 1.1074 - <para>You can then issue commands of the form <command>mq 1.1075 + <para id="x_42d">You can then issue commands of the form <command>mq 1.1076 pull</command> from the main repository.</para> 1.1077 1.1078 </sect2> 1.1079 <sect2> 1.1080 <title>A few things to watch out for</title> 1.1081 1.1082 - <para>MQ's support for working with a repository full of patches 1.1083 + <para id="x_42e">MQ's support for working with a repository full of patches 1.1084 is limited in a few small respects.</para> 1.1085 1.1086 - <para>MQ cannot automatically detect changes that you make to 1.1087 + <para id="x_42f">MQ cannot automatically detect changes that you make to 1.1088 the patch directory. If you <command role="hg-cmd">hg 1.1089 pull</command>, manually edit, or <command role="hg-cmd">hg 1.1090 update</command> changes to patches or the <filename 1.1091 @@ -1102,14 +1100,14 @@ 1.1092 1.1093 </sect2> 1.1094 </sect1> 1.1095 - <sect1 id="sec.mq.tools"> 1.1096 + <sect1 id="sec:mq:tools"> 1.1097 <title>Third party tools for working with patches</title> 1.1098 1.1099 - <para>Once you've been working with patches for a while, you'll 1.1100 + <para id="x_430">Once you've been working with patches for a while, you'll 1.1101 find yourself hungry for tools that will help you to understand 1.1102 and manipulate the patches you're dealing with.</para> 1.1103 1.1104 - <para>The <command>diffstat</command> command 1.1105 + <para id="x_431">The <command>diffstat</command> command 1.1106 <citation>web:diffstat</citation> generates a histogram of the 1.1107 modifications made to each file in a patch. It provides a good 1.1108 way to <quote>get a sense of</quote> a patch&emdash;which files 1.1109 @@ -1123,7 +1121,7 @@ 1.1110 1.1111 &interaction.mq.tools.tools; 1.1112 1.1113 - <para>The <literal role="package">patchutils</literal> package 1.1114 + <para id="x_432">The <literal role="package">patchutils</literal> package 1.1115 <citation>web:patchutils</citation> is invaluable. It provides a 1.1116 set of small utilities that follow the <quote>Unix 1.1117 philosophy;</quote> each does one useful thing with a patch. 1.1118 @@ -1133,21 +1131,21 @@ 1.1119 hundreds of files across dozens of directories, a single 1.1120 invocation of <command>filterdiff</command> can generate a 1.1121 smaller patch that only touches files whose names match a 1.1122 - particular glob pattern. See section <xref 1.1123 - linkend="mq-collab.tips.interdiff"/> for another 1.1124 + particular glob pattern. See <xref 1.1125 + linkend="mq-collab:tips:interdiff"/> for another 1.1126 example.</para> 1.1127 1.1128 </sect1> 1.1129 <sect1> 1.1130 <title>Good ways to work with patches</title> 1.1131 1.1132 - <para>Whether you are working on a patch series to submit to a 1.1133 + <para id="x_433">Whether you are working on a patch series to submit to a 1.1134 free software or open source project, or a series that you 1.1135 intend to treat as a sequence of regular changesets when you're 1.1136 done, you can use some simple techniques to keep your work well 1.1137 organised.</para> 1.1138 1.1139 - <para>Give your patches descriptive names. A good name for a 1.1140 + <para id="x_434">Give your patches descriptive names. A good name for a 1.1141 patch might be <filename>rework-device-alloc.patch</filename>, 1.1142 because it will immediately give you a hint what the purpose of 1.1143 the patch is. Long names shouldn't be a problem; you won't be 1.1144 @@ -1159,7 +1157,7 @@ 1.1145 to work with, or if you are juggling a number of different tasks 1.1146 and your patches only get a fraction of your attention.</para> 1.1147 1.1148 - <para>Be aware of what patch you're working on. Use the <command 1.1149 + <para id="x_435">Be aware of what patch you're working on. Use the <command 1.1150 role="hg-ext-mq">qtop</command> command and skim over the text 1.1151 of your patches frequently&emdash;for example, using <command 1.1152 role="hg-cmd">hg tip <option 1.1153 @@ -1169,9 +1167,9 @@ 1.1154 one I intended, and it's often tricky to migrate changes into 1.1155 the right patch after making them in the wrong one.</para> 1.1156 1.1157 - <para>For this reason, it is very much worth investing a little 1.1158 + <para id="x_436">For this reason, it is very much worth investing a little 1.1159 time to learn how to use some of the third-party tools I 1.1160 - described in section <xref linkend="sec.mq.tools"/>, 1.1161 + described in <xref linkend="sec:mq:tools"/>, 1.1162 particularly 1.1163 <command>diffstat</command> and <command>filterdiff</command>. 1.1164 The former will give you a quick idea of what changes your patch 1.1165 @@ -1185,28 +1183,28 @@ 1.1166 <sect2> 1.1167 <title>Manage <quote>trivial</quote> patches</title> 1.1168 1.1169 - <para>Because the overhead of dropping files into a new 1.1170 + <para id="x_437">Because the overhead of dropping files into a new 1.1171 Mercurial repository is so low, it makes a lot of sense to 1.1172 manage patches this way even if you simply want to make a few 1.1173 changes to a source tarball that you downloaded.</para> 1.1174 1.1175 - <para>Begin by downloading and unpacking the source tarball, and 1.1176 + <para id="x_438">Begin by downloading and unpacking the source tarball, and 1.1177 turning it into a Mercurial repository.</para> 1.1178 1.1179 &interaction.mq.tarball.download; 1.1180 1.1181 - <para>Continue by creating a patch stack and making your 1.1182 + <para id="x_439">Continue by creating a patch stack and making your 1.1183 changes.</para> 1.1184 1.1185 &interaction.mq.tarball.qinit; 1.1186 1.1187 - <para>Let's say a few weeks or months pass, and your package 1.1188 + <para id="x_43a">Let's say a few weeks or months pass, and your package 1.1189 author releases a new version. First, bring their changes 1.1190 into the repository.</para> 1.1191 1.1192 &interaction.mq.tarball.newsource; 1.1193 1.1194 - <para>The pipeline starting with <command role="hg-cmd">hg 1.1195 + <para id="x_43b">The pipeline starting with <command role="hg-cmd">hg 1.1196 locate</command> above deletes all files in the working 1.1197 directory, so that <command role="hg-cmd">hg 1.1198 commit</command>'s <option 1.1199 @@ -1214,16 +1212,16 @@ 1.1200 actually tell which files have really been removed in the 1.1201 newer version of the source.</para> 1.1202 1.1203 - <para>Finally, you can apply your patches on top of the new 1.1204 + <para id="x_43c">Finally, you can apply your patches on top of the new 1.1205 tree.</para> 1.1206 1.1207 &interaction.mq.tarball.repush; 1.1208 1.1209 </sect2> 1.1210 - <sect2 id="sec.mq.combine"> 1.1211 + <sect2 id="sec:mq:combine"> 1.1212 <title>Combining entire patches</title> 1.1213 1.1214 - <para>MQ provides a command, <command 1.1215 + <para id="x_43d">MQ provides a command, <command 1.1216 role="hg-ext-mq">qfold</command> that lets you combine 1.1217 entire patches. This <quote>folds</quote> the patches you 1.1218 name, in the order you name them, into the topmost applied 1.1219 @@ -1231,7 +1229,7 @@ 1.1220 description. The patches that you fold must be unapplied 1.1221 before you fold them.</para> 1.1222 1.1223 - <para>The order in which you fold patches matters. If your 1.1224 + <para id="x_43e">The order in which you fold patches matters. If your 1.1225 topmost applied patch is <literal>foo</literal>, and you 1.1226 <command role="hg-ext-mq">qfold</command> 1.1227 <literal>bar</literal> and <literal>quux</literal> into it, 1.1228 @@ -1244,11 +1242,11 @@ 1.1229 <sect2> 1.1230 <title>Merging part of one patch into another</title> 1.1231 1.1232 - <para>Merging <emphasis>part</emphasis> of one patch into 1.1233 + <para id="x_43f">Merging <emphasis>part</emphasis> of one patch into 1.1234 another is more difficult than combining entire 1.1235 patches.</para> 1.1236 1.1237 - <para>If you want to move changes to entire files, you can use 1.1238 + <para id="x_440">If you want to move changes to entire files, you can use 1.1239 <command>filterdiff</command>'s <option 1.1240 role="cmd-opt-filterdiff">-i</option> and <option 1.1241 role="cmd-opt-filterdiff">-x</option> options to choose the 1.1242 @@ -1261,7 +1259,7 @@ 1.1243 <command role="hg-ext-mq">qrefresh</command> the patch to drop 1.1244 the duplicate hunks.</para> 1.1245 1.1246 - <para>If you have a patch that has multiple hunks modifying a 1.1247 + <para id="x_441">If you have a patch that has multiple hunks modifying a 1.1248 file, and you only want to move a few of those hunks, the job 1.1249 becomes more messy, but you can still partly automate it. Use 1.1250 <command>lsdiff -nvv</command> to print some metadata about 1.1251 @@ -1269,21 +1267,21 @@ 1.1252 1.1253 &interaction.mq.tools.lsdiff; 1.1254 1.1255 - <para>This command prints three different kinds of 1.1256 + <para id="x_442">This command prints three different kinds of 1.1257 number:</para> 1.1258 <itemizedlist> 1.1259 - <listitem><para>(in the first column) a <emphasis>file 1.1260 + <listitem><para id="x_443">(in the first column) a <emphasis>file 1.1261 number</emphasis> to identify each file modified in the 1.1262 patch;</para> 1.1263 </listitem> 1.1264 - <listitem><para>(on the next line, indented) the line number 1.1265 + <listitem><para id="x_444">(on the next line, indented) the line number 1.1266 within a modified file where a hunk starts; and</para> 1.1267 </listitem> 1.1268 - <listitem><para>(on the same line) a <emphasis>hunk 1.1269 + <listitem><para id="x_445">(on the same line) a <emphasis>hunk 1.1270 number</emphasis> to identify that hunk.</para> 1.1271 </listitem></itemizedlist> 1.1272 1.1273 - <para>You'll have to use some visual inspection, and reading of 1.1274 + <para id="x_446">You'll have to use some visual inspection, and reading of 1.1275 the patch, to identify the file and hunk numbers you'll want, 1.1276 but you can then pass them to to 1.1277 <command>filterdiff</command>'s <option 1.1278 @@ -1291,20 +1289,20 @@ 1.1279 role="cmd-opt-filterdiff">--hunks</option> options, to 1.1280 select exactly the file and hunk you want to extract.</para> 1.1281 1.1282 - <para>Once you have this hunk, you can concatenate it onto the 1.1283 + <para id="x_447">Once you have this hunk, you can concatenate it onto the 1.1284 end of your destination patch and continue with the remainder 1.1285 - of section <xref linkend="sec.mq.combine"/>.</para> 1.1286 + of <xref linkend="sec:mq:combine"/>.</para> 1.1287 1.1288 </sect2> 1.1289 </sect1> 1.1290 <sect1> 1.1291 <title>Differences between quilt and MQ</title> 1.1292 1.1293 - <para>If you are already familiar with quilt, MQ provides a 1.1294 + <para id="x_448">If you are already familiar with quilt, MQ provides a 1.1295 similar command set. There are a few differences in the way 1.1296 that it works.</para> 1.1297 1.1298 - <para>You will already have noticed that most quilt commands have 1.1299 + <para id="x_449">You will already have noticed that most quilt commands have 1.1300 MQ counterparts that simply begin with a 1.1301 <quote><literal>q</literal></quote>. The exceptions are quilt's 1.1302 <literal>add</literal> and <literal>remove</literal> commands,