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