| rev |
line source |
|
bos@559
|
1 <!-- vim: set filetype=docbkxml shiftwidth=2 autoindent expandtab tw=77 : -->
|
|
bos@559
|
2
|
|
bos@559
|
3 <appendix id="chap:mqref">
|
|
bos@559
|
4 <title>Mercurial Queues reference</title>
|
|
bos@559
|
5
|
|
bos@559
|
6 <sect1 id="sec:mqref:cmdref">
|
|
bos@559
|
7 <title>MQ command reference</title>
|
|
bos@559
|
8
|
|
bos@559
|
9 <para>For an overview of the commands provided by MQ, use the
|
|
bos@559
|
10 command <command role="hg-cmd">hg help mq</command>.</para>
|
|
bos@559
|
11
|
|
bos@559
|
12 <sect2>
|
|
bos@559
|
13 <title><command role="hg-ext-mq">qapplied</command>&emdash;print
|
|
bos@559
|
14 applied patches</title>
|
|
bos@559
|
15
|
|
bos@559
|
16 <para>The <command role="hg-ext-mq">qapplied</command> command
|
|
bos@559
|
17 prints the current stack of applied patches. Patches are
|
|
bos@559
|
18 printed in oldest-to-newest order, so the last patch in the
|
|
bos@559
|
19 list is the <quote>top</quote> patch.</para>
|
|
bos@559
|
20
|
|
bos@559
|
21 </sect2>
|
|
bos@559
|
22 <sect2>
|
|
bos@559
|
23 <title><command role="hg-ext-mq">qcommit</command>&emdash;commit
|
|
bos@559
|
24 changes in the queue repository</title>
|
|
bos@559
|
25
|
|
bos@559
|
26 <para>The <command role="hg-ext-mq">qcommit</command> command
|
|
bos@559
|
27 commits any outstanding changes in the <filename
|
|
bos@559
|
28 role="special" class="directory">.hg/patches</filename>
|
|
bos@559
|
29 repository. This command only works if the <filename
|
|
bos@559
|
30 role="special" class="directory">.hg/patches</filename>
|
|
bos@559
|
31 directory is a repository, i.e. you created the directory
|
|
bos@559
|
32 using <command role="hg-cmd">hg qinit <option
|
|
bos@559
|
33 role="hg-ext-mq-cmd-qinit-opt">-c</option></command> or
|
|
bos@559
|
34 ran <command role="hg-cmd">hg init</command> in the directory
|
|
bos@559
|
35 after running <command
|
|
bos@559
|
36 role="hg-ext-mq">qinit</command>.</para>
|
|
bos@559
|
37
|
|
bos@559
|
38 <para>This command is shorthand for <command role="hg-cmd">hg
|
|
bos@559
|
39 commit --cwd .hg/patches</command>.</para>
|
|
bos@559
|
40
|
|
bos@559
|
41 <para>\subsection{<command
|
|
bos@559
|
42 role="hg-ext-mq">qdelete</command>&emdash;delete a patch
|
|
bos@559
|
43 from the <filename role="special">series</filename>
|
|
bos@559
|
44 file}</para>
|
|
bos@559
|
45
|
|
bos@559
|
46 <para>The <command role="hg-ext-mq">qdelete</command> command
|
|
bos@559
|
47 removes the entry for a patch from the <filename
|
|
bos@559
|
48 role="special">series</filename> file in the <filename
|
|
bos@559
|
49 role="special" class="directory">.hg/patches</filename>
|
|
bos@559
|
50 directory. It does not pop the patch if the patch is already
|
|
bos@559
|
51 applied. By default, it does not delete the patch file; use
|
|
bos@559
|
52 the <option role="hg-ext-mq-cmd-qdel-opt">-f</option> option
|
|
bos@559
|
53 to do that.</para>
|
|
bos@559
|
54
|
|
bos@559
|
55 <para>Options:</para>
|
|
bos@559
|
56 <itemizedlist>
|
|
bos@559
|
57 <listitem><para><option
|
|
bos@559
|
58 role="hg-ext-mq-cmd-qdel-opt">-f</option>: Delete the
|
|
bos@559
|
59 patch file.</para>
|
|
bos@559
|
60 </listitem></itemizedlist>
|
|
bos@559
|
61
|
|
bos@559
|
62 </sect2>
|
|
bos@559
|
63 <sect2>
|
|
bos@559
|
64 <title><command role="hg-ext-mq">qdiff</command>&emdash;print a
|
|
bos@559
|
65 diff of the topmost applied patch</title>
|
|
bos@559
|
66
|
|
bos@559
|
67 <para>The <command role="hg-ext-mq">qdiff</command> command
|
|
bos@559
|
68 prints a diff of the topmost applied patch. It is equivalent
|
|
bos@559
|
69 to <command role="hg-cmd">hg diff -r-2:-1</command>.</para>
|
|
bos@559
|
70
|
|
bos@559
|
71 </sect2>
|
|
bos@559
|
72 <sect2>
|
|
bos@559
|
73 <title><command role="hg-ext-mq">qfold</command>&emdash;merge
|
|
bos@559
|
74 (<quote>fold</quote>) several patches into one</title>
|
|
bos@559
|
75
|
|
bos@559
|
76 <para>The <command role="hg-ext-mq">qfold</command> command
|
|
bos@559
|
77 merges multiple patches into the topmost applied patch, so
|
|
bos@559
|
78 that the topmost applied patch makes the union of all of the
|
|
bos@559
|
79 changes in the patches in question.</para>
|
|
bos@559
|
80
|
|
bos@559
|
81 <para>The patches to fold must not be applied; <command
|
|
bos@559
|
82 role="hg-ext-mq">qfold</command> will exit with an error if
|
|
bos@559
|
83 any is. The order in which patches are folded is significant;
|
|
bos@559
|
84 <command role="hg-cmd">hg qfold a b</command> means
|
|
bos@559
|
85 <quote>apply the current topmost patch, followed by
|
|
bos@559
|
86 <literal>a</literal>, followed by
|
|
bos@559
|
87 <literal>b</literal></quote>.</para>
|
|
bos@559
|
88
|
|
bos@559
|
89 <para>The comments from the folded patches are appended to the
|
|
bos@559
|
90 comments of the destination patch, with each block of comments
|
|
bos@559
|
91 separated by three asterisk
|
|
bos@559
|
92 (<quote><literal>*</literal></quote>) characters. Use the
|
|
bos@559
|
93 <option role="hg-ext-mq-cmd-qfold-opt">-e</option> option to
|
|
bos@559
|
94 edit the commit message for the combined patch/changeset after
|
|
bos@559
|
95 the folding has completed.</para>
|
|
bos@559
|
96
|
|
bos@559
|
97 <para>Options:</para>
|
|
bos@559
|
98 <itemizedlist>
|
|
bos@559
|
99 <listitem><para><option
|
|
bos@559
|
100 role="hg-ext-mq-cmd-qfold-opt">-e</option>: Edit the
|
|
bos@559
|
101 commit message and patch description for the newly folded
|
|
bos@559
|
102 patch.</para>
|
|
bos@559
|
103 </listitem>
|
|
bos@559
|
104 <listitem><para><option
|
|
bos@559
|
105 role="hg-ext-mq-cmd-qfold-opt">-l</option>: Use the
|
|
bos@559
|
106 contents of the given file as the new commit message and
|
|
bos@559
|
107 patch description for the folded patch.</para>
|
|
bos@559
|
108 </listitem>
|
|
bos@559
|
109 <listitem><para><option
|
|
bos@559
|
110 role="hg-ext-mq-cmd-qfold-opt">-m</option>: Use the
|
|
bos@559
|
111 given text as the new commit message and patch description
|
|
bos@559
|
112 for the folded patch.</para>
|
|
bos@559
|
113 </listitem></itemizedlist>
|
|
bos@559
|
114
|
|
bos@559
|
115 </sect2>
|
|
bos@559
|
116 <sect2>
|
|
bos@559
|
117 <title><command
|
|
bos@559
|
118 role="hg-ext-mq">qheader</command>&emdash;display the
|
|
bos@559
|
119 header/description of a patch</title>
|
|
bos@559
|
120
|
|
bos@559
|
121 <para>The <command role="hg-ext-mq">qheader</command> command
|
|
bos@559
|
122 prints the header, or description, of a patch. By default, it
|
|
bos@559
|
123 prints the header of the topmost applied patch. Given an
|
|
bos@559
|
124 argument, it prints the header of the named patch.</para>
|
|
bos@559
|
125
|
|
bos@559
|
126 </sect2>
|
|
bos@559
|
127 <sect2>
|
|
bos@559
|
128 <title><command role="hg-ext-mq">qimport</command>&emdash;import
|
|
bos@559
|
129 a third-party patch into the queue</title>
|
|
bos@559
|
130
|
|
bos@559
|
131 <para>The <command role="hg-ext-mq">qimport</command> command
|
|
bos@559
|
132 adds an entry for an external patch to the <filename
|
|
bos@559
|
133 role="special">series</filename> file, and copies the patch
|
|
bos@559
|
134 into the <filename role="special"
|
|
bos@559
|
135 class="directory">.hg/patches</filename> directory. It adds
|
|
bos@559
|
136 the entry immediately after the topmost applied patch, but
|
|
bos@559
|
137 does not push the patch.</para>
|
|
bos@559
|
138
|
|
bos@559
|
139 <para>If the <filename role="special"
|
|
bos@559
|
140 class="directory">.hg/patches</filename> directory is a
|
|
bos@559
|
141 repository, <command role="hg-ext-mq">qimport</command>
|
|
bos@559
|
142 automatically does an <command role="hg-cmd">hg add</command>
|
|
bos@559
|
143 of the imported patch.</para>
|
|
bos@559
|
144
|
|
bos@559
|
145 </sect2>
|
|
bos@559
|
146 <sect2>
|
|
bos@559
|
147 <title><command role="hg-ext-mq">qinit</command>&emdash;prepare
|
|
bos@559
|
148 a repository to work with MQ</title>
|
|
bos@559
|
149
|
|
bos@559
|
150 <para>The <command role="hg-ext-mq">qinit</command> command
|
|
bos@559
|
151 prepares a repository to work with MQ. It creates a directory
|
|
bos@559
|
152 called <filename role="special"
|
|
bos@559
|
153 class="directory">.hg/patches</filename>.</para>
|
|
bos@559
|
154
|
|
bos@559
|
155 <para>Options:</para>
|
|
bos@559
|
156 <itemizedlist>
|
|
bos@559
|
157 <listitem><para><option
|
|
bos@559
|
158 role="hg-ext-mq-cmd-qinit-opt">-c</option>: Create
|
|
bos@559
|
159 <filename role="special"
|
|
bos@559
|
160 class="directory">.hg/patches</filename> as a repository
|
|
bos@559
|
161 in its own right. Also creates a <filename
|
|
bos@559
|
162 role="special">.hgignore</filename> file that will
|
|
bos@559
|
163 ignore the <filename role="special">status</filename>
|
|
bos@559
|
164 file.</para>
|
|
bos@559
|
165 </listitem></itemizedlist>
|
|
bos@559
|
166
|
|
bos@559
|
167 <para>When the <filename role="special"
|
|
bos@559
|
168 class="directory">.hg/patches</filename> directory is a
|
|
bos@559
|
169 repository, the <command role="hg-ext-mq">qimport</command>
|
|
bos@559
|
170 and <command role="hg-ext-mq">qnew</command> commands
|
|
bos@559
|
171 automatically <command role="hg-cmd">hg add</command> new
|
|
bos@559
|
172 patches.</para>
|
|
bos@559
|
173
|
|
bos@559
|
174 </sect2>
|
|
bos@559
|
175 <sect2>
|
|
bos@559
|
176 <title><command role="hg-ext-mq">qnew</command>&emdash;create a
|
|
bos@559
|
177 new patch</title>
|
|
bos@559
|
178
|
|
bos@559
|
179 <para>The <command role="hg-ext-mq">qnew</command> command
|
|
bos@559
|
180 creates a new patch. It takes one mandatory argument, the
|
|
bos@559
|
181 name to use for the patch file. The newly created patch is
|
|
bos@559
|
182 created empty by default. It is added to the <filename
|
|
bos@559
|
183 role="special">series</filename> file after the current
|
|
bos@559
|
184 topmost applied patch, and is immediately pushed on top of
|
|
bos@559
|
185 that patch.</para>
|
|
bos@559
|
186
|
|
bos@559
|
187 <para>If <command role="hg-ext-mq">qnew</command> finds modified
|
|
bos@559
|
188 files in the working directory, it will refuse to create a new
|
|
bos@559
|
189 patch unless the <option
|
|
bos@559
|
190 role="hg-ext-mq-cmd-qnew-opt">-f</option> option is used
|
|
bos@559
|
191 (see below). This behaviour allows you to <command
|
|
bos@559
|
192 role="hg-ext-mq">qrefresh</command> your topmost applied
|
|
bos@559
|
193 patch before you apply a new patch on top of it.</para>
|
|
bos@559
|
194
|
|
bos@559
|
195 <para>Options:</para>
|
|
bos@559
|
196 <itemizedlist>
|
|
bos@559
|
197 <listitem><para><option
|
|
bos@559
|
198 role="hg-ext-mq-cmd-qnew-opt">-f</option>: Create a new
|
|
bos@559
|
199 patch if the contents of the working directory are
|
|
bos@559
|
200 modified. Any outstanding modifications are added to the
|
|
bos@559
|
201 newly created patch, so after this command completes, the
|
|
bos@559
|
202 working directory will no longer be modified.</para>
|
|
bos@559
|
203 </listitem>
|
|
bos@559
|
204 <listitem><para><option
|
|
bos@559
|
205 role="hg-ext-mq-cmd-qnew-opt">-m</option>: Use the given
|
|
bos@559
|
206 text as the commit message. This text will be stored at
|
|
bos@559
|
207 the beginning of the patch file, before the patch
|
|
bos@559
|
208 data.</para>
|
|
bos@559
|
209 </listitem></itemizedlist>
|
|
bos@559
|
210
|
|
bos@559
|
211 </sect2>
|
|
bos@559
|
212 <sect2>
|
|
bos@559
|
213 <title><command role="hg-ext-mq">qnext</command>&emdash;print
|
|
bos@559
|
214 the name of the next patch</title>
|
|
bos@559
|
215
|
|
bos@559
|
216 <para>The <command role="hg-ext-mq">qnext</command> command
|
|
bos@559
|
217 prints the name name of the next patch in the <filename
|
|
bos@559
|
218 role="special">series</filename> file after the topmost
|
|
bos@559
|
219 applied patch. This patch will become the topmost applied
|
|
bos@559
|
220 patch if you run <command
|
|
bos@559
|
221 role="hg-ext-mq">qpush</command>.</para>
|
|
bos@559
|
222
|
|
bos@559
|
223 </sect2>
|
|
bos@559
|
224 <sect2>
|
|
bos@559
|
225 <title><command role="hg-ext-mq">qpop</command>&emdash;pop
|
|
bos@559
|
226 patches off the stack</title>
|
|
bos@559
|
227
|
|
bos@559
|
228 <para>The <command role="hg-ext-mq">qpop</command> command
|
|
bos@559
|
229 removes applied patches from the top of the stack of applied
|
|
bos@559
|
230 patches. By default, it removes only one patch.</para>
|
|
bos@559
|
231
|
|
bos@559
|
232 <para>This command removes the changesets that represent the
|
|
bos@559
|
233 popped patches from the repository, and updates the working
|
|
bos@559
|
234 directory to undo the effects of the patches.</para>
|
|
bos@559
|
235
|
|
bos@559
|
236 <para>This command takes an optional argument, which it uses as
|
|
bos@559
|
237 the name or index of the patch to pop to. If given a name, it
|
|
bos@559
|
238 will pop patches until the named patch is the topmost applied
|
|
bos@559
|
239 patch. If given a number, <command
|
|
bos@559
|
240 role="hg-ext-mq">qpop</command> treats the number as an
|
|
bos@559
|
241 index into the entries in the series file, counting from zero
|
|
bos@559
|
242 (empty lines and lines containing only comments do not count).
|
|
bos@559
|
243 It pops patches until the patch identified by the given index
|
|
bos@559
|
244 is the topmost applied patch.</para>
|
|
bos@559
|
245
|
|
bos@559
|
246 <para>The <command role="hg-ext-mq">qpop</command> command does
|
|
bos@559
|
247 not read or write patches or the <filename
|
|
bos@559
|
248 role="special">series</filename> file. It is thus safe to
|
|
bos@559
|
249 <command role="hg-ext-mq">qpop</command> a patch that you have
|
|
bos@559
|
250 removed from the <filename role="special">series</filename>
|
|
bos@559
|
251 file, or a patch that you have renamed or deleted entirely.
|
|
bos@559
|
252 In the latter two cases, use the name of the patch as it was
|
|
bos@559
|
253 when you applied it.</para>
|
|
bos@559
|
254
|
|
bos@559
|
255 <para>By default, the <command role="hg-ext-mq">qpop</command>
|
|
bos@559
|
256 command will not pop any patches if the working directory has
|
|
bos@559
|
257 been modified. You can override this behaviour using the
|
|
bos@559
|
258 <option role="hg-ext-mq-cmd-qpop-opt">-f</option> option,
|
|
bos@559
|
259 which reverts all modifications in the working
|
|
bos@559
|
260 directory.</para>
|
|
bos@559
|
261
|
|
bos@559
|
262 <para>Options:</para>
|
|
bos@559
|
263 <itemizedlist>
|
|
bos@559
|
264 <listitem><para><option
|
|
bos@559
|
265 role="hg-ext-mq-cmd-qpop-opt">-a</option>: Pop all
|
|
bos@559
|
266 applied patches. This returns the repository to its state
|
|
bos@559
|
267 before you applied any patches.</para>
|
|
bos@559
|
268 </listitem>
|
|
bos@559
|
269 <listitem><para><option
|
|
bos@559
|
270 role="hg-ext-mq-cmd-qpop-opt">-f</option>: Forcibly
|
|
bos@559
|
271 revert any modifications to the working directory when
|
|
bos@559
|
272 popping.</para>
|
|
bos@559
|
273 </listitem>
|
|
bos@559
|
274 <listitem><para><option
|
|
bos@559
|
275 role="hg-ext-mq-cmd-qpop-opt">-n</option>: Pop a patch
|
|
bos@559
|
276 from the named queue.</para>
|
|
bos@559
|
277 </listitem></itemizedlist>
|
|
bos@559
|
278
|
|
bos@559
|
279 <para>The <command role="hg-ext-mq">qpop</command> command
|
|
bos@559
|
280 removes one line from the end of the <filename
|
|
bos@559
|
281 role="special">status</filename> file for each patch that it
|
|
bos@559
|
282 pops.</para>
|
|
bos@559
|
283
|
|
bos@559
|
284 </sect2>
|
|
bos@559
|
285 <sect2>
|
|
bos@559
|
286 <title><command role="hg-ext-mq">qprev</command>&emdash;print
|
|
bos@559
|
287 the name of the previous patch</title>
|
|
bos@559
|
288
|
|
bos@559
|
289 <para>The <command role="hg-ext-mq">qprev</command> command
|
|
bos@559
|
290 prints the name of the patch in the <filename
|
|
bos@559
|
291 role="special">series</filename> file that comes before the
|
|
bos@559
|
292 topmost applied patch. This will become the topmost applied
|
|
bos@559
|
293 patch if you run <command
|
|
bos@559
|
294 role="hg-ext-mq">qpop</command>.</para>
|
|
bos@559
|
295
|
|
bos@559
|
296 </sect2>
|
|
bos@559
|
297 <sect2 id="sec:mqref:cmd:qpush">
|
|
bos@559
|
298 <title><command role="hg-ext-mq">qpush</command>&emdash;push
|
|
bos@559
|
299 patches onto the stack</title>
|
|
bos@559
|
300
|
|
bos@559
|
301 <para>The <command role="hg-ext-mq">qpush</command> command adds
|
|
bos@559
|
302 patches onto the applied stack. By default, it adds only one
|
|
bos@559
|
303 patch.</para>
|
|
bos@559
|
304
|
|
bos@559
|
305 <para>This command creates a new changeset to represent each
|
|
bos@559
|
306 applied patch, and updates the working directory to apply the
|
|
bos@559
|
307 effects of the patches.</para>
|
|
bos@559
|
308
|
|
bos@559
|
309 <para>The default data used when creating a changeset are as
|
|
bos@559
|
310 follows:</para>
|
|
bos@559
|
311 <itemizedlist>
|
|
bos@559
|
312 <listitem><para>The commit date and time zone are the current
|
|
bos@559
|
313 date and time zone. Because these data are used to
|
|
bos@559
|
314 compute the identity of a changeset, this means that if
|
|
bos@559
|
315 you <command role="hg-ext-mq">qpop</command> a patch and
|
|
bos@559
|
316 <command role="hg-ext-mq">qpush</command> it again, the
|
|
bos@559
|
317 changeset that you push will have a different identity
|
|
bos@559
|
318 than the changeset you popped.</para>
|
|
bos@559
|
319 </listitem>
|
|
bos@559
|
320 <listitem><para>The author is the same as the default used by
|
|
bos@559
|
321 the <command role="hg-cmd">hg commit</command>
|
|
bos@559
|
322 command.</para>
|
|
bos@559
|
323 </listitem>
|
|
bos@559
|
324 <listitem><para>The commit message is any text from the patch
|
|
bos@559
|
325 file that comes before the first diff header. If there is
|
|
bos@559
|
326 no such text, a default commit message is used that
|
|
bos@559
|
327 identifies the name of the patch.</para>
|
|
bos@559
|
328 </listitem></itemizedlist>
|
|
bos@559
|
329 <para>If a patch contains a Mercurial patch header (XXX add
|
|
bos@559
|
330 link), the information in the patch header overrides these
|
|
bos@559
|
331 defaults.</para>
|
|
bos@559
|
332
|
|
bos@559
|
333 <para>Options:</para>
|
|
bos@559
|
334 <itemizedlist>
|
|
bos@559
|
335 <listitem><para><option
|
|
bos@559
|
336 role="hg-ext-mq-cmd-qpush-opt">-a</option>: Push all
|
|
bos@559
|
337 unapplied patches from the <filename
|
|
bos@559
|
338 role="special">series</filename> file until there are
|
|
bos@559
|
339 none left to push.</para>
|
|
bos@559
|
340 </listitem>
|
|
bos@559
|
341 <listitem><para><option
|
|
bos@559
|
342 role="hg-ext-mq-cmd-qpush-opt">-l</option>: Add the name
|
|
bos@559
|
343 of the patch to the end of the commit message.</para>
|
|
bos@559
|
344 </listitem>
|
|
bos@559
|
345 <listitem><para><option
|
|
bos@559
|
346 role="hg-ext-mq-cmd-qpush-opt">-m</option>: If a patch
|
|
bos@559
|
347 fails to apply cleanly, use the entry for the patch in
|
|
bos@559
|
348 another saved queue to compute the parameters for a
|
|
bos@559
|
349 three-way merge, and perform a three-way merge using the
|
|
bos@559
|
350 normal Mercurial merge machinery. Use the resolution of
|
|
bos@559
|
351 the merge as the new patch content.</para>
|
|
bos@559
|
352 </listitem>
|
|
bos@559
|
353 <listitem><para><option
|
|
bos@559
|
354 role="hg-ext-mq-cmd-qpush-opt">-n</option>: Use the
|
|
bos@559
|
355 named queue if merging while pushing.</para>
|
|
bos@559
|
356 </listitem></itemizedlist>
|
|
bos@559
|
357
|
|
bos@559
|
358 <para>The <command role="hg-ext-mq">qpush</command> command
|
|
bos@559
|
359 reads, but does not modify, the <filename
|
|
bos@559
|
360 role="special">series</filename> file. It appends one line
|
|
bos@559
|
361 to the <command role="hg-cmd">hg status</command> file for
|
|
bos@559
|
362 each patch that it pushes.</para>
|
|
bos@559
|
363
|
|
bos@559
|
364 </sect2>
|
|
bos@559
|
365 <sect2>
|
|
bos@559
|
366 <title><command
|
|
bos@559
|
367 role="hg-ext-mq">qrefresh</command>&emdash;update the
|
|
bos@559
|
368 topmost applied patch</title>
|
|
bos@559
|
369
|
|
bos@559
|
370 <para>The <command role="hg-ext-mq">qrefresh</command> command
|
|
bos@559
|
371 updates the topmost applied patch. It modifies the patch,
|
|
bos@559
|
372 removes the old changeset that represented the patch, and
|
|
bos@559
|
373 creates a new changeset to represent the modified
|
|
bos@559
|
374 patch.</para>
|
|
bos@559
|
375
|
|
bos@559
|
376 <para>The <command role="hg-ext-mq">qrefresh</command> command
|
|
bos@559
|
377 looks for the following modifications:</para>
|
|
bos@559
|
378 <itemizedlist>
|
|
bos@559
|
379 <listitem><para>Changes to the commit message, i.e. the text
|
|
bos@559
|
380 before the first diff header in the patch file, are
|
|
bos@559
|
381 reflected in the new changeset that represents the
|
|
bos@559
|
382 patch.</para>
|
|
bos@559
|
383 </listitem>
|
|
bos@559
|
384 <listitem><para>Modifications to tracked files in the working
|
|
bos@559
|
385 directory are added to the patch.</para>
|
|
bos@559
|
386 </listitem>
|
|
bos@559
|
387 <listitem><para>Changes to the files tracked using <command
|
|
bos@559
|
388 role="hg-cmd">hg add</command>, <command
|
|
bos@559
|
389 role="hg-cmd">hg copy</command>, <command
|
|
bos@559
|
390 role="hg-cmd">hg remove</command>, or <command
|
|
bos@559
|
391 role="hg-cmd">hg rename</command>. Added files and copy
|
|
bos@559
|
392 and rename destinations are added to the patch, while
|
|
bos@559
|
393 removed files and rename sources are removed.</para>
|
|
bos@559
|
394 </listitem></itemizedlist>
|
|
bos@559
|
395
|
|
bos@559
|
396 <para>Even if <command role="hg-ext-mq">qrefresh</command>
|
|
bos@559
|
397 detects no changes, it still recreates the changeset that
|
|
bos@559
|
398 represents the patch. This causes the identity of the
|
|
bos@559
|
399 changeset to differ from the previous changeset that
|
|
bos@559
|
400 identified the patch.</para>
|
|
bos@559
|
401
|
|
bos@559
|
402 <para>Options:</para>
|
|
bos@559
|
403 <itemizedlist>
|
|
bos@559
|
404 <listitem><para><option
|
|
bos@559
|
405 role="hg-ext-mq-cmd-qrefresh-opt">-e</option>: Modify
|
|
bos@559
|
406 the commit and patch description, using the preferred text
|
|
bos@559
|
407 editor.</para>
|
|
bos@559
|
408 </listitem>
|
|
bos@559
|
409 <listitem><para><option
|
|
bos@559
|
410 role="hg-ext-mq-cmd-qrefresh-opt">-m</option>: Modify
|
|
bos@559
|
411 the commit message and patch description, using the given
|
|
bos@559
|
412 text.</para>
|
|
bos@559
|
413 </listitem>
|
|
bos@559
|
414 <listitem><para><option
|
|
bos@559
|
415 role="hg-ext-mq-cmd-qrefresh-opt">-l</option>: Modify
|
|
bos@559
|
416 the commit message and patch description, using text from
|
|
bos@559
|
417 the given file.</para>
|
|
bos@559
|
418 </listitem></itemizedlist>
|
|
bos@559
|
419
|
|
bos@559
|
420 </sect2>
|
|
bos@559
|
421 <sect2>
|
|
bos@559
|
422 <title><command role="hg-ext-mq">qrename</command>&emdash;rename
|
|
bos@559
|
423 a patch</title>
|
|
bos@559
|
424
|
|
bos@559
|
425 <para>The <command role="hg-ext-mq">qrename</command> command
|
|
bos@559
|
426 renames a patch, and changes the entry for the patch in the
|
|
bos@559
|
427 <filename role="special">series</filename> file.</para>
|
|
bos@559
|
428
|
|
bos@559
|
429 <para>With a single argument, <command
|
|
bos@559
|
430 role="hg-ext-mq">qrename</command> renames the topmost
|
|
bos@559
|
431 applied patch. With two arguments, it renames its first
|
|
bos@559
|
432 argument to its second.</para>
|
|
bos@559
|
433
|
|
bos@559
|
434 </sect2>
|
|
bos@559
|
435 <sect2>
|
|
bos@559
|
436 <title><command
|
|
bos@559
|
437 role="hg-ext-mq">qrestore</command>&emdash;restore saved
|
|
bos@559
|
438 queue state</title>
|
|
bos@559
|
439
|
|
bos@559
|
440 <para>XXX No idea what this does.</para>
|
|
bos@559
|
441
|
|
bos@559
|
442 </sect2>
|
|
bos@559
|
443 <sect2>
|
|
bos@559
|
444 <title><command role="hg-ext-mq">qsave</command>&emdash;save
|
|
bos@559
|
445 current queue state</title>
|
|
bos@559
|
446
|
|
bos@559
|
447 <para>XXX Likewise.</para>
|
|
bos@559
|
448
|
|
bos@559
|
449 </sect2>
|
|
bos@559
|
450 <sect2>
|
|
bos@559
|
451 <title><command role="hg-ext-mq">qseries</command>&emdash;print
|
|
bos@559
|
452 the entire patch series</title>
|
|
bos@559
|
453
|
|
bos@559
|
454 <para>The <command role="hg-ext-mq">qseries</command> command
|
|
bos@559
|
455 prints the entire patch series from the <filename
|
|
bos@559
|
456 role="special">series</filename> file. It prints only patch
|
|
bos@559
|
457 names, not empty lines or comments. It prints in order from
|
|
bos@559
|
458 first to be applied to last.</para>
|
|
bos@559
|
459
|
|
bos@559
|
460 </sect2>
|
|
bos@559
|
461 <sect2>
|
|
bos@559
|
462 <title><command role="hg-ext-mq">qtop</command>&emdash;print the
|
|
bos@559
|
463 name of the current patch</title>
|
|
bos@559
|
464
|
|
bos@559
|
465 <para>The <command role="hg-ext-mq">qtop</command> prints the
|
|
bos@559
|
466 name of the topmost currently applied patch.</para>
|
|
bos@559
|
467
|
|
bos@559
|
468 </sect2>
|
|
bos@559
|
469 <sect2>
|
|
bos@559
|
470 <title><command
|
|
bos@559
|
471 role="hg-ext-mq">qunapplied</command>&emdash;print patches
|
|
bos@559
|
472 not yet applied</title>
|
|
bos@559
|
473
|
|
bos@559
|
474 <para>The <command role="hg-ext-mq">qunapplied</command> command
|
|
bos@559
|
475 prints the names of patches from the <filename
|
|
bos@559
|
476 role="special">series</filename> file that are not yet
|
|
bos@559
|
477 applied. It prints them in order from the next patch that
|
|
bos@559
|
478 will be pushed to the last.</para>
|
|
bos@559
|
479
|
|
bos@559
|
480 </sect2>
|
|
bos@559
|
481 <sect2>
|
|
bos@559
|
482 <title><command role="hg-cmd">hg strip</command>&emdash;remove a
|
|
bos@559
|
483 revision and descendants</title>
|
|
bos@559
|
484
|
|
bos@559
|
485 <para>The <command role="hg-cmd">hg strip</command> command
|
|
bos@559
|
486 removes a revision, and all of its descendants, from the
|
|
bos@559
|
487 repository. It undoes the effects of the removed revisions
|
|
bos@559
|
488 from the repository, and updates the working directory to the
|
|
bos@559
|
489 first parent of the removed revision.</para>
|
|
bos@559
|
490
|
|
bos@559
|
491 <para>The <command role="hg-cmd">hg strip</command> command
|
|
bos@559
|
492 saves a backup of the removed changesets in a bundle, so that
|
|
bos@559
|
493 they can be reapplied if removed in error.</para>
|
|
bos@559
|
494
|
|
bos@559
|
495 <para>Options:</para>
|
|
bos@559
|
496 <itemizedlist>
|
|
bos@559
|
497 <listitem><para><option role="hg-opt-strip">-b</option>: Save
|
|
bos@559
|
498 unrelated changesets that are intermixed with the stripped
|
|
bos@559
|
499 changesets in the backup bundle.</para>
|
|
bos@559
|
500 </listitem>
|
|
bos@559
|
501 <listitem><para><option role="hg-opt-strip">-f</option>: If a
|
|
bos@559
|
502 branch has multiple heads, remove all heads. XXX This
|
|
bos@559
|
503 should be renamed, and use <literal>-f</literal> to strip
|
|
bos@559
|
504 revs when there are pending changes.</para>
|
|
bos@559
|
505 </listitem>
|
|
bos@559
|
506 <listitem><para><option role="hg-opt-strip">-n</option>: Do
|
|
bos@559
|
507 not save a backup bundle.</para>
|
|
bos@559
|
508 </listitem></itemizedlist>
|
|
bos@559
|
509
|
|
bos@559
|
510 </sect2>
|
|
bos@559
|
511 </sect1>
|
|
bos@559
|
512 <sect1>
|
|
bos@559
|
513 <title>MQ file reference</title>
|
|
bos@559
|
514
|
|
bos@559
|
515 <sect2>
|
|
bos@559
|
516 <title>The <filename role="special">series</filename>
|
|
bos@559
|
517 file</title>
|
|
bos@559
|
518
|
|
bos@559
|
519 <para>The <filename role="special">series</filename> file
|
|
bos@559
|
520 contains a list of the names of all patches that MQ can apply.
|
|
bos@559
|
521 It is represented as a list of names, with one name saved per
|
|
bos@559
|
522 line. Leading and trailing white space in each line are
|
|
bos@559
|
523 ignored.</para>
|
|
bos@559
|
524
|
|
bos@559
|
525 <para>Lines may contain comments. A comment begins with the
|
|
bos@559
|
526 <quote><literal>#</literal></quote> character, and extends to
|
|
bos@559
|
527 the end of the line. Empty lines, and lines that contain only
|
|
bos@559
|
528 comments, are ignored.</para>
|
|
bos@559
|
529
|
|
bos@559
|
530 <para>You will often need to edit the <filename
|
|
bos@559
|
531 role="special">series</filename> file by hand, hence the
|
|
bos@559
|
532 support for comments and empty lines noted above. For
|
|
bos@559
|
533 example, you can comment out a patch temporarily, and <command
|
|
bos@559
|
534 role="hg-ext-mq">qpush</command> will skip over that patch
|
|
bos@559
|
535 when applying patches. You can also change the order in which
|
|
bos@559
|
536 patches are applied by reordering their entries in the
|
|
bos@559
|
537 <filename role="special">series</filename> file.</para>
|
|
bos@559
|
538
|
|
bos@559
|
539 <para>Placing the <filename role="special">series</filename>
|
|
bos@559
|
540 file under revision control is also supported; it is a good
|
|
bos@559
|
541 idea to place all of the patches that it refers to under
|
|
bos@559
|
542 revision control, as well. If you create a patch directory
|
|
bos@559
|
543 using the <option role="hg-ext-mq-cmd-qinit-opt">-c</option>
|
|
bos@559
|
544 option to <command role="hg-ext-mq">qinit</command>, this will
|
|
bos@559
|
545 be done for you automatically.</para>
|
|
bos@559
|
546
|
|
bos@559
|
547 </sect2>
|
|
bos@559
|
548 <sect2>
|
|
bos@559
|
549 <title>The <filename role="special">status</filename>
|
|
bos@559
|
550 file</title>
|
|
bos@559
|
551
|
|
bos@559
|
552 <para>The <filename role="special">status</filename> file
|
|
bos@559
|
553 contains the names and changeset hashes of all patches that MQ
|
|
bos@559
|
554 currently has applied. Unlike the <filename
|
|
bos@559
|
555 role="special">series</filename> file, this file is not
|
|
bos@559
|
556 intended for editing. You should not place this file under
|
|
bos@559
|
557 revision control, or modify it in any way. It is used by MQ
|
|
bos@559
|
558 strictly for internal book-keeping.</para>
|
|
bos@559
|
559
|
|
bos@559
|
560 </sect2>
|
|
bos@559
|
561 </sect1>
|
|
bos@559
|
562 </appendix>
|
|
bos@559
|
563
|
|
bos@559
|
564 <!--
|
|
bos@559
|
565 local variables:
|
|
bos@559
|
566 sgml-parent-document: ("00book.xml" "book" "appendix")
|
|
bos@559
|
567 end:
|
|
bos@559
|
568 -->
|
