Mercurial > hgbook
diff en/appB-mq-ref.xml @ 683:c838b3975bc6
Add IDs to paragraphs.
author | Bryan O'Sullivan <bos@serpentine.com> |
---|---|
date | Thu, 19 Mar 2009 21:18:52 -0700 |
parents | 8366882f67f2 |
children | 1c13ed2130a7 |
line wrap: on
line diff
--- a/en/appB-mq-ref.xml Thu Mar 19 20:54:12 2009 -0700 +++ b/en/appB-mq-ref.xml Thu Mar 19 21:18:52 2009 -0700 @@ -7,14 +7,14 @@ <sect1 id="sec:mqref:cmdref"> <title>MQ command reference</title> - <para>For an overview of the commands provided by MQ, use the + <para id="x_5e8">For an overview of the commands provided by MQ, use the command <command role="hg-cmd">hg help mq</command>.</para> <sect2> <title><command role="hg-ext-mq">qapplied</command>&emdash;print applied patches</title> - <para>The <command role="hg-ext-mq">qapplied</command> command + <para id="x_5e9">The <command role="hg-ext-mq">qapplied</command> command prints the current stack of applied patches. Patches are printed in oldest-to-newest order, so the last patch in the list is the <quote>top</quote> patch.</para> @@ -24,7 +24,7 @@ <title><command role="hg-ext-mq">qcommit</command>&emdash;commit changes in the queue repository</title> - <para>The <command role="hg-ext-mq">qcommit</command> command + <para id="x_5ea">The <command role="hg-ext-mq">qcommit</command> command commits any outstanding changes in the <filename role="special" class="directory">.hg/patches</filename> repository. This command only works if the <filename @@ -36,7 +36,7 @@ after running <command role="hg-ext-mq">qinit</command>.</para> - <para>This command is shorthand for <command role="hg-cmd">hg + <para id="x_5eb">This command is shorthand for <command role="hg-cmd">hg commit --cwd .hg/patches</command>.</para> </sect2> <sect2> @@ -45,7 +45,7 @@ from the <filename role="special">series</filename> file}</title> - <para>The <command role="hg-ext-mq">qdelete</command> command + <para id="x_5ec">The <command role="hg-ext-mq">qdelete</command> command removes the entry for a patch from the <filename role="special">series</filename> file in the <filename role="special" class="directory">.hg/patches</filename> @@ -54,9 +54,9 @@ the <option role="hg-ext-mq-cmd-qdel-opt">-f</option> option to do that.</para> - <para>Options:</para> + <para id="x_5ed">Options:</para> <itemizedlist> - <listitem><para><option + <listitem><para id="x_5ee"><option role="hg-ext-mq-cmd-qdel-opt">-f</option>: Delete the patch file.</para> </listitem></itemizedlist> @@ -66,7 +66,7 @@ <title><command role="hg-ext-mq">qdiff</command>&emdash;print a diff of the topmost applied patch</title> - <para>The <command role="hg-ext-mq">qdiff</command> command + <para id="x_5ef">The <command role="hg-ext-mq">qdiff</command> command prints a diff of the topmost applied patch. It is equivalent to <command role="hg-cmd">hg diff -r-2:-1</command>.</para> @@ -75,12 +75,12 @@ <title><command role="hg-ext-mq">qfold</command>&emdash;merge (<quote>fold</quote>) several patches into one</title> - <para>The <command role="hg-ext-mq">qfold</command> command + <para id="x_5f0">The <command role="hg-ext-mq">qfold</command> command merges multiple patches into the topmost applied patch, so that the topmost applied patch makes the union of all of the changes in the patches in question.</para> - <para>The patches to fold must not be applied; <command + <para id="x_5f1">The patches to fold must not be applied; <command role="hg-ext-mq">qfold</command> will exit with an error if any is. The order in which patches are folded is significant; <command role="hg-cmd">hg qfold a b</command> means @@ -88,7 +88,7 @@ <literal>a</literal>, followed by <literal>b</literal></quote>.</para> - <para>The comments from the folded patches are appended to the + <para id="x_5f2">The comments from the folded patches are appended to the comments of the destination patch, with each block of comments separated by three asterisk (<quote><literal>*</literal></quote>) characters. Use the @@ -96,19 +96,19 @@ edit the commit message for the combined patch/changeset after the folding has completed.</para> - <para>Options:</para> + <para id="x_5f3">Options:</para> <itemizedlist> - <listitem><para><option + <listitem><para id="x_5f4"><option role="hg-ext-mq-cmd-qfold-opt">-e</option>: Edit the commit message and patch description for the newly folded patch.</para> </listitem> - <listitem><para><option + <listitem><para id="x_5f5"><option role="hg-ext-mq-cmd-qfold-opt">-l</option>: Use the contents of the given file as the new commit message and patch description for the folded patch.</para> </listitem> - <listitem><para><option + <listitem><para id="x_5f6"><option role="hg-ext-mq-cmd-qfold-opt">-m</option>: Use the given text as the new commit message and patch description for the folded patch.</para> @@ -120,7 +120,7 @@ role="hg-ext-mq">qheader</command>&emdash;display the header/description of a patch</title> - <para>The <command role="hg-ext-mq">qheader</command> command + <para id="x_5f7">The <command role="hg-ext-mq">qheader</command> command prints the header, or description, of a patch. By default, it prints the header of the topmost applied patch. Given an argument, it prints the header of the named patch.</para> @@ -130,7 +130,7 @@ <title><command role="hg-ext-mq">qimport</command>&emdash;import a third-party patch into the queue</title> - <para>The <command role="hg-ext-mq">qimport</command> command + <para id="x_5f8">The <command role="hg-ext-mq">qimport</command> command adds an entry for an external patch to the <filename role="special">series</filename> file, and copies the patch into the <filename role="special" @@ -138,7 +138,7 @@ the entry immediately after the topmost applied patch, but does not push the patch.</para> - <para>If the <filename role="special" + <para id="x_5f9">If the <filename role="special" class="directory">.hg/patches</filename> directory is a repository, <command role="hg-ext-mq">qimport</command> automatically does an <command role="hg-cmd">hg add</command> @@ -149,14 +149,14 @@ <title><command role="hg-ext-mq">qinit</command>&emdash;prepare a repository to work with MQ</title> - <para>The <command role="hg-ext-mq">qinit</command> command + <para id="x_5fa">The <command role="hg-ext-mq">qinit</command> command prepares a repository to work with MQ. It creates a directory called <filename role="special" class="directory">.hg/patches</filename>.</para> - <para>Options:</para> + <para id="x_5fb">Options:</para> <itemizedlist> - <listitem><para><option + <listitem><para id="x_5fc"><option role="hg-ext-mq-cmd-qinit-opt">-c</option>: Create <filename role="special" class="directory">.hg/patches</filename> as a repository @@ -166,7 +166,7 @@ file.</para> </listitem></itemizedlist> - <para>When the <filename role="special" + <para id="x_5fd">When the <filename role="special" class="directory">.hg/patches</filename> directory is a repository, the <command role="hg-ext-mq">qimport</command> and <command role="hg-ext-mq">qnew</command> commands @@ -178,7 +178,7 @@ <title><command role="hg-ext-mq">qnew</command>&emdash;create a new patch</title> - <para>The <command role="hg-ext-mq">qnew</command> command + <para id="x_5fe">The <command role="hg-ext-mq">qnew</command> command creates a new patch. It takes one mandatory argument, the name to use for the patch file. The newly created patch is created empty by default. It is added to the <filename @@ -186,7 +186,7 @@ topmost applied patch, and is immediately pushed on top of that patch.</para> - <para>If <command role="hg-ext-mq">qnew</command> finds modified + <para id="x_5ff">If <command role="hg-ext-mq">qnew</command> finds modified files in the working directory, it will refuse to create a new patch unless the <option role="hg-ext-mq-cmd-qnew-opt">-f</option> option is used @@ -194,16 +194,16 @@ role="hg-ext-mq">qrefresh</command> your topmost applied patch before you apply a new patch on top of it.</para> - <para>Options:</para> + <para id="x_600">Options:</para> <itemizedlist> - <listitem><para><option + <listitem><para id="x_601"><option role="hg-ext-mq-cmd-qnew-opt">-f</option>: Create a new patch if the contents of the working directory are modified. Any outstanding modifications are added to the newly created patch, so after this command completes, the working directory will no longer be modified.</para> </listitem> - <listitem><para><option + <listitem><para id="x_602"><option role="hg-ext-mq-cmd-qnew-opt">-m</option>: Use the given text as the commit message. This text will be stored at the beginning of the patch file, before the patch @@ -215,7 +215,7 @@ <title><command role="hg-ext-mq">qnext</command>&emdash;print the name of the next patch</title> - <para>The <command role="hg-ext-mq">qnext</command> command + <para id="x_603">The <command role="hg-ext-mq">qnext</command> command prints the name name of the next patch in the <filename role="special">series</filename> file after the topmost applied patch. This patch will become the topmost applied @@ -227,15 +227,15 @@ <title><command role="hg-ext-mq">qpop</command>&emdash;pop patches off the stack</title> - <para>The <command role="hg-ext-mq">qpop</command> command + <para id="x_604">The <command role="hg-ext-mq">qpop</command> command removes applied patches from the top of the stack of applied patches. By default, it removes only one patch.</para> - <para>This command removes the changesets that represent the + <para id="x_605">This command removes the changesets that represent the popped patches from the repository, and updates the working directory to undo the effects of the patches.</para> - <para>This command takes an optional argument, which it uses as + <para id="x_606">This command takes an optional argument, which it uses as the name or index of the patch to pop to. If given a name, it will pop patches until the named patch is the topmost applied patch. If given a number, <command @@ -245,7 +245,7 @@ It pops patches until the patch identified by the given index is the topmost applied patch.</para> - <para>The <command role="hg-ext-mq">qpop</command> command does + <para id="x_607">The <command role="hg-ext-mq">qpop</command> command does not read or write patches or the <filename role="special">series</filename> file. It is thus safe to <command role="hg-ext-mq">qpop</command> a patch that you have @@ -254,31 +254,31 @@ In the latter two cases, use the name of the patch as it was when you applied it.</para> - <para>By default, the <command role="hg-ext-mq">qpop</command> + <para id="x_608">By default, the <command role="hg-ext-mq">qpop</command> command will not pop any patches if the working directory has been modified. You can override this behaviour using the <option role="hg-ext-mq-cmd-qpop-opt">-f</option> option, which reverts all modifications in the working directory.</para> - <para>Options:</para> + <para id="x_609">Options:</para> <itemizedlist> - <listitem><para><option + <listitem><para id="x_60a"><option role="hg-ext-mq-cmd-qpop-opt">-a</option>: Pop all applied patches. This returns the repository to its state before you applied any patches.</para> </listitem> - <listitem><para><option + <listitem><para id="x_60b"><option role="hg-ext-mq-cmd-qpop-opt">-f</option>: Forcibly revert any modifications to the working directory when popping.</para> </listitem> - <listitem><para><option + <listitem><para id="x_60c"><option role="hg-ext-mq-cmd-qpop-opt">-n</option>: Pop a patch from the named queue.</para> </listitem></itemizedlist> - <para>The <command role="hg-ext-mq">qpop</command> command + <para id="x_60d">The <command role="hg-ext-mq">qpop</command> command removes one line from the end of the <filename role="special">status</filename> file for each patch that it pops.</para> @@ -288,7 +288,7 @@ <title><command role="hg-ext-mq">qprev</command>&emdash;print the name of the previous patch</title> - <para>The <command role="hg-ext-mq">qprev</command> command + <para id="x_60e">The <command role="hg-ext-mq">qprev</command> command prints the name of the patch in the <filename role="special">series</filename> file that comes before the topmost applied patch. This will become the topmost applied @@ -300,18 +300,18 @@ <title><command role="hg-ext-mq">qpush</command>&emdash;push patches onto the stack</title> - <para>The <command role="hg-ext-mq">qpush</command> command adds + <para id="x_60f">The <command role="hg-ext-mq">qpush</command> command adds patches onto the applied stack. By default, it adds only one patch.</para> - <para>This command creates a new changeset to represent each + <para id="x_610">This command creates a new changeset to represent each applied patch, and updates the working directory to apply the effects of the patches.</para> - <para>The default data used when creating a changeset are as + <para id="x_611">The default data used when creating a changeset are as follows:</para> <itemizedlist> - <listitem><para>The commit date and time zone are the current + <listitem><para id="x_612">The commit date and time zone are the current date and time zone. Because these data are used to compute the identity of a changeset, this means that if you <command role="hg-ext-mq">qpop</command> a patch and @@ -319,32 +319,32 @@ changeset that you push will have a different identity than the changeset you popped.</para> </listitem> - <listitem><para>The author is the same as the default used by + <listitem><para id="x_613">The author is the same as the default used by the <command role="hg-cmd">hg commit</command> command.</para> </listitem> - <listitem><para>The commit message is any text from the patch + <listitem><para id="x_614">The commit message is any text from the patch file that comes before the first diff header. If there is no such text, a default commit message is used that identifies the name of the patch.</para> </listitem></itemizedlist> - <para>If a patch contains a Mercurial patch header (XXX add + <para id="x_615">If a patch contains a Mercurial patch header (XXX add link), the information in the patch header overrides these defaults.</para> - <para>Options:</para> + <para id="x_616">Options:</para> <itemizedlist> - <listitem><para><option + <listitem><para id="x_617"><option role="hg-ext-mq-cmd-qpush-opt">-a</option>: Push all unapplied patches from the <filename role="special">series</filename> file until there are none left to push.</para> </listitem> - <listitem><para><option + <listitem><para id="x_618"><option role="hg-ext-mq-cmd-qpush-opt">-l</option>: Add the name of the patch to the end of the commit message.</para> </listitem> - <listitem><para><option + <listitem><para id="x_619"><option role="hg-ext-mq-cmd-qpush-opt">-m</option>: If a patch fails to apply cleanly, use the entry for the patch in another saved queue to compute the parameters for a @@ -352,12 +352,12 @@ normal Mercurial merge machinery. Use the resolution of the merge as the new patch content.</para> </listitem> - <listitem><para><option + <listitem><para id="x_61a"><option role="hg-ext-mq-cmd-qpush-opt">-n</option>: Use the named queue if merging while pushing.</para> </listitem></itemizedlist> - <para>The <command role="hg-ext-mq">qpush</command> command + <para id="x_61b">The <command role="hg-ext-mq">qpush</command> command reads, but does not modify, the <filename role="special">series</filename> file. It appends one line to the <command role="hg-cmd">hg status</command> file for @@ -369,24 +369,24 @@ role="hg-ext-mq">qrefresh</command>&emdash;update the topmost applied patch</title> - <para>The <command role="hg-ext-mq">qrefresh</command> command + <para id="x_61c">The <command role="hg-ext-mq">qrefresh</command> command updates the topmost applied patch. It modifies the patch, removes the old changeset that represented the patch, and creates a new changeset to represent the modified patch.</para> - <para>The <command role="hg-ext-mq">qrefresh</command> command + <para id="x_61d">The <command role="hg-ext-mq">qrefresh</command> command looks for the following modifications:</para> <itemizedlist> - <listitem><para>Changes to the commit message, i.e. the text + <listitem><para id="x_61e">Changes to the commit message, i.e. the text before the first diff header in the patch file, are reflected in the new changeset that represents the patch.</para> </listitem> - <listitem><para>Modifications to tracked files in the working + <listitem><para id="x_61f">Modifications to tracked files in the working directory are added to the patch.</para> </listitem> - <listitem><para>Changes to the files tracked using <command + <listitem><para id="x_620">Changes to the files tracked using <command role="hg-cmd">hg add</command>, <command role="hg-cmd">hg copy</command>, <command role="hg-cmd">hg remove</command>, or <command @@ -395,25 +395,25 @@ removed files and rename sources are removed.</para> </listitem></itemizedlist> - <para>Even if <command role="hg-ext-mq">qrefresh</command> + <para id="x_621">Even if <command role="hg-ext-mq">qrefresh</command> detects no changes, it still recreates the changeset that represents the patch. This causes the identity of the changeset to differ from the previous changeset that identified the patch.</para> - <para>Options:</para> + <para id="x_622">Options:</para> <itemizedlist> - <listitem><para><option + <listitem><para id="x_623"><option role="hg-ext-mq-cmd-qrefresh-opt">-e</option>: Modify the commit and patch description, using the preferred text editor.</para> </listitem> - <listitem><para><option + <listitem><para id="x_624"><option role="hg-ext-mq-cmd-qrefresh-opt">-m</option>: Modify the commit message and patch description, using the given text.</para> </listitem> - <listitem><para><option + <listitem><para id="x_625"><option role="hg-ext-mq-cmd-qrefresh-opt">-l</option>: Modify the commit message and patch description, using text from the given file.</para> @@ -424,11 +424,11 @@ <title><command role="hg-ext-mq">qrename</command>&emdash;rename a patch</title> - <para>The <command role="hg-ext-mq">qrename</command> command + <para id="x_626">The <command role="hg-ext-mq">qrename</command> command renames a patch, and changes the entry for the patch in the <filename role="special">series</filename> file.</para> - <para>With a single argument, <command + <para id="x_627">With a single argument, <command role="hg-ext-mq">qrename</command> renames the topmost applied patch. With two arguments, it renames its first argument to its second.</para> @@ -439,21 +439,21 @@ role="hg-ext-mq">qrestore</command>&emdash;restore saved queue state</title> - <para>XXX No idea what this does.</para> + <para id="x_628">XXX No idea what this does.</para> </sect2> <sect2> <title><command role="hg-ext-mq">qsave</command>&emdash;save current queue state</title> - <para>XXX Likewise.</para> + <para id="x_629">XXX Likewise.</para> </sect2> <sect2> <title><command role="hg-ext-mq">qseries</command>&emdash;print the entire patch series</title> - <para>The <command role="hg-ext-mq">qseries</command> command + <para id="x_62a">The <command role="hg-ext-mq">qseries</command> command prints the entire patch series from the <filename role="special">series</filename> file. It prints only patch names, not empty lines or comments. It prints in order from @@ -464,7 +464,7 @@ <title><command role="hg-ext-mq">qtop</command>&emdash;print the name of the current patch</title> - <para>The <command role="hg-ext-mq">qtop</command> prints the + <para id="x_62b">The <command role="hg-ext-mq">qtop</command> prints the name of the topmost currently applied patch.</para> </sect2> @@ -473,7 +473,7 @@ role="hg-ext-mq">qunapplied</command>&emdash;print patches not yet applied</title> - <para>The <command role="hg-ext-mq">qunapplied</command> command + <para id="x_62c">The <command role="hg-ext-mq">qunapplied</command> command prints the names of patches from the <filename role="special">series</filename> file that are not yet applied. It prints them in order from the next patch that @@ -484,28 +484,28 @@ <title><command role="hg-cmd">hg strip</command>&emdash;remove a revision and descendants</title> - <para>The <command role="hg-cmd">hg strip</command> command + <para id="x_62d">The <command role="hg-cmd">hg strip</command> command removes a revision, and all of its descendants, from the repository. It undoes the effects of the removed revisions from the repository, and updates the working directory to the first parent of the removed revision.</para> - <para>The <command role="hg-cmd">hg strip</command> command + <para id="x_62e">The <command role="hg-cmd">hg strip</command> command saves a backup of the removed changesets in a bundle, so that they can be reapplied if removed in error.</para> - <para>Options:</para> + <para id="x_62f">Options:</para> <itemizedlist> - <listitem><para><option role="hg-opt-strip">-b</option>: Save + <listitem><para id="x_630"><option role="hg-opt-strip">-b</option>: Save unrelated changesets that are intermixed with the stripped changesets in the backup bundle.</para> </listitem> - <listitem><para><option role="hg-opt-strip">-f</option>: If a + <listitem><para id="x_631"><option role="hg-opt-strip">-f</option>: If a branch has multiple heads, remove all heads. XXX This should be renamed, and use <literal>-f</literal> to strip revs when there are pending changes.</para> </listitem> - <listitem><para><option role="hg-opt-strip">-n</option>: Do + <listitem><para id="x_632"><option role="hg-opt-strip">-n</option>: Do not save a backup bundle.</para> </listitem></itemizedlist> @@ -518,18 +518,18 @@ <title>The <filename role="special">series</filename> file</title> - <para>The <filename role="special">series</filename> file + <para id="x_633">The <filename role="special">series</filename> file contains a list of the names of all patches that MQ can apply. It is represented as a list of names, with one name saved per line. Leading and trailing white space in each line are ignored.</para> - <para>Lines may contain comments. A comment begins with the + <para id="x_634">Lines may contain comments. A comment begins with the <quote><literal>#</literal></quote> character, and extends to the end of the line. Empty lines, and lines that contain only comments, are ignored.</para> - <para>You will often need to edit the <filename + <para id="x_635">You will often need to edit the <filename role="special">series</filename> file by hand, hence the support for comments and empty lines noted above. For example, you can comment out a patch temporarily, and <command @@ -538,7 +538,7 @@ patches are applied by reordering their entries in the <filename role="special">series</filename> file.</para> - <para>Placing the <filename role="special">series</filename> + <para id="x_636">Placing the <filename role="special">series</filename> file under revision control is also supported; it is a good idea to place all of the patches that it refers to under revision control, as well. If you create a patch directory @@ -551,7 +551,7 @@ <title>The <filename role="special">status</filename> file</title> - <para>The <filename role="special">status</filename> file + <para id="x_637">The <filename role="special">status</filename> file contains the names and changeset hashes of all patches that MQ currently has applied. Unlike the <filename role="special">series</filename> file, this file is not