comparison en/ch12-mq.xml @ 681:5bfa0df6aaed

Automated merge with ssh://ssh.serpentine.com/hg/share/mercurial/book

678:1879ec732a28

      download anything; MQ ships with the standard Mercurial
      distribution.)  To enable MQ, edit your <filename
	role="home">~/.hgrc</filename> file, and add the lines
      below.</para>

    <programlisting>[extensions] hgext.mq =</programlisting>

    <para>Once the extension is enabled, it will make a number of new
      commands available.  To verify that the extension is working,
      you can use <command role="hg-cmd">hg help</command> to see if
      the <command role="hg-ext-mq">qinit</command> command is now

      <listitem><para>Update to the new tip revision, using <command
	    role="hg-cmd">hg update <option
	      role="hg-opt-update">-C</option></command> to override
	  the patches you have pushed.</para>
      </listitem>
      <listitem><para>Merge all patches using
	  \hgcmdargs{qpush}{<option role="hg-ext-mq-cmd-qpush-opt">hg
	    -m</option> <option role="hg-ext-mq-cmd-qpush-opt">hg
	    -a</option>}.  The <option
	    role="hg-ext-mq-cmd-qpush-opt">hg -m</option> option to
	  <command role="hg-ext-mq">qpush</command> tells MQ to
	  perform a three-way merge if the patch fails to
	  apply.</para>
      </listitem></orderedlist>

    <para>MQ also makes it easy to work with patches when you are
      using normal Mercurial commands.  Every command that accepts a
      changeset ID will also accept the name of an applied patch.  MQ
      augments the tags normally in the repository with an eponymous
      one for each applied patch.  In addition, the special tags
      \index{tags!special tag
      names!<literal>qbase</literal>}<literal>qbase</literal> and
      \index{tags!special tag
      names!<literal>qtip</literal>}<literal>qtip</literal> identify
      the <quote>bottom-most</quote> and topmost applied patches,
      respectively.</para>

    <para>These additions to Mercurial's normal tagging capabilities
      make dealing with patches even more of a breeze.</para>
    <itemizedlist>
      <listitem><para>Want to patchbomb a mailing list with your
	  latest series of changes?</para>
	<programlisting>hg email qbase:qtip
	</programlisting>
	<para>  (Don't know what <quote>patchbombing</quote> is?  See
	  section <xref linkend="sec:hgext:patchbomb"/>.)</para>
      </listitem>
      <listitem><para>Need to see all of the patches since
	  <literal>foo.patch</literal> that have touched files in a
	  subdirectory of your tree?</para>
	<programlisting>
	  hg log -r foo.patch:qtip <emphasis>subdir</emphasis>
	</programlisting>
      </listitem>
    </itemizedlist>

    <para>Because MQ makes the names of patches available to the rest
      of Mercurial through its normal internal tag machinery, you

	systems. For example, on Linux systems using the
	<command>bash</command> shell, you can include the following
	snippet in your <filename
	  role="home">~/.bashrc</filename>.</para>

      <programlisting>alias mq=`hg -R $(hg
	root)/.hg/patches'</programlisting>

      <para>You can then issue commands of the form <command>mq
	  pull</command> from the main repository.</para>

    </sect2>

681:5bfa0df6aaed

      download anything; MQ ships with the standard Mercurial
      distribution.)  To enable MQ, edit your <filename
	role="home">~/.hgrc</filename> file, and add the lines
      below.</para>

    <programlisting>[extensions]
hgext.mq =</programlisting>

    <para>Once the extension is enabled, it will make a number of new
      commands available.  To verify that the extension is working,
      you can use <command role="hg-cmd">hg help</command> to see if
      the <command role="hg-ext-mq">qinit</command> command is now

      <listitem><para>Update to the new tip revision, using <command
	    role="hg-cmd">hg update <option
	      role="hg-opt-update">-C</option></command> to override
	  the patches you have pushed.</para>
      </listitem>
      <listitem><para>Merge all patches using <command>hg qpush -m
	    -a</command>.  The <option
	    role="hg-ext-mq-cmd-qpush-opt">-m</option> option to
	  <command role="hg-ext-mq">qpush</command> tells MQ to
	  perform a three-way merge if the patch fails to
	  apply.</para>
      </listitem></orderedlist>

    <para>MQ also makes it easy to work with patches when you are
      using normal Mercurial commands.  Every command that accepts a
      changeset ID will also accept the name of an applied patch.  MQ
      augments the tags normally in the repository with an eponymous
      one for each applied patch.  In addition, the special tags
      <literal role="tag">qbase</literal> and
      <literal role="tag">qtip</literal> identify
      the <quote>bottom-most</quote> and topmost applied patches,
      respectively.</para>

    <para>These additions to Mercurial's normal tagging capabilities
      make dealing with patches even more of a breeze.</para>
    <itemizedlist>
      <listitem><para>Want to patchbomb a mailing list with your
	  latest series of changes?</para>
	<programlisting>hg email qbase:qtip</programlisting>
	<para>  (Don't know what <quote>patchbombing</quote> is?  See
	  section <xref linkend="sec:hgext:patchbomb"/>.)</para>
      </listitem>
      <listitem><para>Need to see all of the patches since
	  <literal>foo.patch</literal> that have touched files in a
	  subdirectory of your tree?</para>
	<programlisting>hg log -r foo.patch:qtip subdir</programlisting>
      </listitem>
    </itemizedlist>

    <para>Because MQ makes the names of patches available to the rest
      of Mercurial through its normal internal tag machinery, you

	systems. For example, on Linux systems using the
	<command>bash</command> shell, you can include the following
	snippet in your <filename
	  role="home">~/.bashrc</filename>.</para>

      <programlisting>alias mq=`hg -R $(hg root)/.hg/patches'</programlisting>

      <para>You can then issue commands of the form <command>mq
	  pull</command> from the main repository.</para>

    </sect2>