Mercurial > hgbook
changeset 233:696b1e0c01df
Tag all MQ commands as belonging to the mq extension.
| author | Bryan O'Sullivan <bos@serpentine.com> |
|---|---|
| date | Sun, 27 May 2007 09:41:55 -0700 |
| parents | 2469608b4a08 |
| children | 30e97616d808 |
| files | en/mq-collab.tex en/mq-ref.tex en/mq.tex |
| diffstat | 3 files changed, 121 insertions(+), 121 deletions(-) [+] |
line wrap: on
line diff
--- a/en/mq-collab.tex Sun May 27 09:40:12 2007 -0700 +++ b/en/mq-collab.tex Sun May 27 09:41:55 2007 -0700 @@ -108,7 +108,7 @@ \section{Controlling the guards on a patch} -The \hgcmd{qguard} command lets you determine which guards should +The \hgxcmd{mq}{qguard} command lets you determine which guards should apply to a patch, or display the guards that are already in effect. Without any arguments, it displays the guards on the current topmost patch. @@ -121,7 +121,7 @@ \interaction{mq.guards.qguard.neg} \begin{note} - The \hgcmd{qguard} command \emph{sets} the guards on a patch; it + The \hgxcmd{mq}{qguard} command \emph{sets} the guards on a patch; it doesn't \emph{modify} them. What this means is that if you run \hgcmdargs{qguard}{+a +b} on a patch, then \hgcmdargs{qguard}{+c} on the same patch, the \emph{only} guard that will be set on it @@ -130,20 +130,20 @@ Mercurial stores guards in the \sfilename{series} file; the form in which they are stored is easy both to understand and to edit by hand. -(In other words, you don't have to use the \hgcmd{qguard} command if +(In other words, you don't have to use the \hgxcmd{mq}{qguard} command if you don't want to; it's okay to simply edit the \sfilename{series} file.) \interaction{mq.guards.series} \section{Selecting the guards to use} -The \hgcmd{qselect} command determines which guards are active at a +The \hgxcmd{mq}{qselect} command determines which guards are active at a given time. The effect of this is to determine which patches MQ will -apply the next time you run \hgcmd{qpush}. It has no other effect; in +apply the next time you run \hgxcmd{mq}{qpush}. It has no other effect; in particular, it doesn't do anything to patches that are already applied. -With no arguments, the \hgcmd{qselect} command lists the guards +With no arguments, the \hgxcmd{mq}{qselect} command lists the guards currently in effect, one per line of output. Each argument is treated as the name of a guard to apply. \interaction{mq.guards.qselect.foo} @@ -151,7 +151,7 @@ the \sfilename{guards} file. \interaction{mq.guards.qselect.cat} We can see the effect the selected guards have when we run -\hgcmd{qpush}. +\hgxcmd{mq}{qpush}. \interaction{mq.guards.qselect.qpush} A guard cannot start with a ``\texttt{+}'' or ``\texttt{-}''
--- a/en/mq-ref.tex Sun May 27 09:40:12 2007 -0700 +++ b/en/mq-ref.tex Sun May 27 09:41:55 2007 -0700 @@ -7,26 +7,26 @@ For an overview of the commands provided by MQ, use the command \hgcmdargs{help}{mq}. -\subsection{\hgcmd{qapplied}---print applied patches} +\subsection{\hgxcmd{mq}{qapplied}---print applied patches} -The \hgcmd{qapplied} command prints the current stack of applied +The \hgxcmd{mq}{qapplied} 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 ``top'' patch. -\subsection{\hgcmd{qcommit}---commit changes in the queue repository} +\subsection{\hgxcmd{mq}{qcommit}---commit changes in the queue repository} -The \hgcmd{qcommit} command commits any outstanding changes in the +The \hgxcmd{mq}{qcommit} command commits any outstanding changes in the \sdirname{.hg/patches} repository. This command only works if the \sdirname{.hg/patches} directory is a repository, i.e.~you created the directory using \hgcmdargs{qinit}{\hgopt{qinit}{-c}} or ran -\hgcmd{init} in the directory after running \hgcmd{qinit}. +\hgcmd{init} in the directory after running \hgxcmd{mq}{qinit}. This command is shorthand for \hgcmdargs{commit}{--cwd .hg/patches}. -\subsection{\hgcmd{qdelete}---delete a patch from the +\subsection{\hgxcmd{mq}{qdelete}---delete a patch from the \sfilename{series} file} -The \hgcmd{qdelete} command removes the entry for a patch from the +The \hgxcmd{mq}{qdelete} command removes the entry for a patch from the \sfilename{series} file in the \sdirname{.hg/patches} directory. It does not pop the patch if the patch is already applied. By default, it does not delete the patch file; use the \hgopt{qdel}{-f} option to @@ -37,18 +37,18 @@ \item[\hgopt{qdel}{-f}] Delete the patch file. \end{itemize} -\subsection{\hgcmd{qdiff}---print a diff of the topmost applied patch} +\subsection{\hgxcmd{mq}{qdiff}---print a diff of the topmost applied patch} -The \hgcmd{qdiff} command prints a diff of the topmost applied patch. +The \hgxcmd{mq}{qdiff} command prints a diff of the topmost applied patch. It is equivalent to \hgcmdargs{diff}{-r-2:-1}. -\subsection{\hgcmd{qfold}---merge (``fold'') several patches into one} +\subsection{\hgxcmd{mq}{qfold}---merge (``fold'') several patches into one} -The \hgcmd{qfold} command merges multiple patches into the topmost +The \hgxcmd{mq}{qfold} 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. -The patches to fold must not be applied; \hgcmd{qfold} will exit with +The patches to fold must not be applied; \hgxcmd{mq}{qfold} will exit with an error if any is. The order in which patches are folded is significant; \hgcmdargs{qfold}{a b} means ``apply the current topmost patch, followed by \texttt{a}, followed by \texttt{b}''. @@ -69,26 +69,26 @@ and patch description for the folded patch. \end{itemize} -\subsection{\hgcmd{qheader}---display the header/description of a patch} +\subsection{\hgxcmd{mq}{qheader}---display the header/description of a patch} -The \hgcmd{qheader} command prints the header, or description, of a +The \hgxcmd{mq}{qheader} 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. -\subsection{\hgcmd{qimport}---import a third-party patch into the queue} +\subsection{\hgxcmd{mq}{qimport}---import a third-party patch into the queue} -The \hgcmd{qimport} command adds an entry for an external patch to the +The \hgxcmd{mq}{qimport} command adds an entry for an external patch to the \sfilename{series} file, and copies the patch into the \sdirname{.hg/patches} directory. It adds the entry immediately after the topmost applied patch, but does not push the patch. If the \sdirname{.hg/patches} directory is a repository, -\hgcmd{qimport} automatically does an \hgcmd{add} of the imported +\hgxcmd{mq}{qimport} automatically does an \hgcmd{add} of the imported patch. -\subsection{\hgcmd{qinit}---prepare a repository to work with MQ} +\subsection{\hgxcmd{mq}{qinit}---prepare a repository to work with MQ} -The \hgcmd{qinit} command prepares a repository to work with MQ. It +The \hgxcmd{mq}{qinit} command prepares a repository to work with MQ. It creates a directory called \sdirname{.hg/patches}. Options: @@ -99,20 +99,20 @@ \end{itemize} When the \sdirname{.hg/patches} directory is a repository, the -\hgcmd{qimport} and \hgcmd{qnew} commands automatically \hgcmd{add} +\hgxcmd{mq}{qimport} and \hgxcmd{mq}{qnew} commands automatically \hgcmd{add} new patches. -\subsection{\hgcmd{qnew}---create a new patch} +\subsection{\hgxcmd{mq}{qnew}---create a new patch} -The \hgcmd{qnew} command creates a new patch. It takes one mandatory +The \hgxcmd{mq}{qnew} 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 \sfilename{series} file after the current topmost applied patch, and is immediately pushed on top of that patch. -If \hgcmd{qnew} finds modified files in the working directory, it will +If \hgxcmd{mq}{qnew} finds modified files in the working directory, it will refuse to create a new patch unless the \hgopt{qnew}{-f} option is -used (see below). This behaviour allows you to \hgcmd{qrefresh} your +used (see below). This behaviour allows you to \hgxcmd{mq}{qrefresh} your topmost applied patch before you apply a new patch on top of it. Options: @@ -126,15 +126,15 @@ the patch data. \end{itemize} -\subsection{\hgcmd{qnext}---print the name of the next patch} +\subsection{\hgxcmd{mq}{qnext}---print the name of the next patch} -The \hgcmd{qnext} command prints the name name of the next patch in +The \hgxcmd{mq}{qnext} command prints the name name of the next patch in the \sfilename{series} file after the topmost applied patch. This -patch will become the topmost applied patch if you run \hgcmd{qpush}. +patch will become the topmost applied patch if you run \hgxcmd{mq}{qpush}. -\subsection{\hgcmd{qpop}---pop patches off the stack} +\subsection{\hgxcmd{mq}{qpop}---pop patches off the stack} -The \hgcmd{qpop} command removes applied patches from the top of the +The \hgxcmd{mq}{qpop} command removes applied patches from the top of the stack of applied patches. By default, it removes only one patch. This command removes the changesets that represent the popped patches @@ -144,18 +144,18 @@ 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, \hgcmd{qpop} treats the number as an index into the entries in +number, \hgxcmd{mq}{qpop} treats the number as an index into the entries in the series file, counting from zero (empty lines and lines containing only comments do not count). It pops patches until the patch identified by the given index is the topmost applied patch. -The \hgcmd{qpop} command does not read or write patches or the -\sfilename{series} file. It is thus safe to \hgcmd{qpop} a patch that +The \hgxcmd{mq}{qpop} command does not read or write patches or the +\sfilename{series} file. It is thus safe to \hgxcmd{mq}{qpop} a patch that you have removed from the \sfilename{series} file, or a patch that you have renamed or deleted entirely. In the latter two cases, use the name of the patch as it was when you applied it. -By default, the \hgcmd{qpop} command will not pop any patches if the +By default, the \hgxcmd{mq}{qpop} command will not pop any patches if the working directory has been modified. You can override this behaviour using the \hgopt{qpop}{-f} option, which reverts all modifications in the working directory. @@ -169,19 +169,19 @@ \item[\hgopt{qpop}{-n}] Pop a patch from the named queue. \end{itemize} -The \hgcmd{qpop} command removes one line from the end of the +The \hgxcmd{mq}{qpop} command removes one line from the end of the \sfilename{status} file for each patch that it pops. -\subsection{\hgcmd{qprev}---print the name of the previous patch} +\subsection{\hgxcmd{mq}{qprev}---print the name of the previous patch} -The \hgcmd{qprev} command prints the name of the patch in the +The \hgxcmd{mq}{qprev} command prints the name of the patch in the \sfilename{series} file that comes before the topmost applied patch. -This will become the topmost applied patch if you run \hgcmd{qpop}. +This will become the topmost applied patch if you run \hgxcmd{mq}{qpop}. -\subsection{\hgcmd{qpush}---push patches onto the stack} +\subsection{\hgxcmd{mq}{qpush}---push patches onto the stack} \label{sec:mqref:cmd:qpush} -The \hgcmd{qpush} command adds patches onto the applied stack. By +The \hgxcmd{mq}{qpush} command adds patches onto the applied stack. By default, it adds only one patch. This command creates a new changeset to represent each applied patch, @@ -191,8 +191,8 @@ \begin{itemize} \item 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 \hgcmd{qpop} a patch and - \hgcmd{qpush} it again, the changeset that you push will have a + changeset, this means that if you \hgxcmd{mq}{qpop} a patch and + \hgxcmd{mq}{qpush} it again, the changeset that you push will have a different identity than the changeset you popped. \item The author is the same as the default used by the \hgcmd{commit} command. @@ -217,17 +217,17 @@ \item[\hgopt{qpush}{-n}] Use the named queue if merging while pushing. \end{itemize} -The \hgcmd{qpush} command reads, but does not modify, the +The \hgxcmd{mq}{qpush} command reads, but does not modify, the \sfilename{series} file. It appends one line to the \hgcmd{status} file for each patch that it pushes. -\subsection{\hgcmd{qrefresh}---update the topmost applied patch} +\subsection{\hgxcmd{mq}{qrefresh}---update the topmost applied patch} -The \hgcmd{qrefresh} command updates the topmost applied patch. It +The \hgxcmd{mq}{qrefresh} 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. -The \hgcmd{qrefresh} command looks for the following modifications: +The \hgxcmd{mq}{qrefresh} command looks for the following modifications: \begin{itemize} \item Changes to the commit message, i.e.~the text before the first diff header in the patch file, are reflected in the new changeset @@ -240,7 +240,7 @@ sources are removed. \end{itemize} -Even if \hgcmd{qrefresh} detects no changes, it still recreates the +Even if \hgxcmd{mq}{qrefresh} 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. @@ -255,43 +255,43 @@ description, using text from the given file. \end{itemize} -\subsection{\hgcmd{qrename}---rename a patch} +\subsection{\hgxcmd{mq}{qrename}---rename a patch} -The \hgcmd{qrename} command renames a patch, and changes the entry for +The \hgxcmd{mq}{qrename} command renames a patch, and changes the entry for the patch in the \sfilename{series} file. -With a single argument, \hgcmd{qrename} renames the topmost applied +With a single argument, \hgxcmd{mq}{qrename} renames the topmost applied patch. With two arguments, it renames its first argument to its second. -\subsection{\hgcmd{qrestore}---restore saved queue state} +\subsection{\hgxcmd{mq}{qrestore}---restore saved queue state} XXX No idea what this does. -\subsection{\hgcmd{qsave}---save current queue state} +\subsection{\hgxcmd{mq}{qsave}---save current queue state} XXX Likewise. -\subsection{\hgcmd{qseries}---print the entire patch series} +\subsection{\hgxcmd{mq}{qseries}---print the entire patch series} -The \hgcmd{qseries} command prints the entire patch series from the +The \hgxcmd{mq}{qseries} command prints the entire patch series from the \sfilename{series} file. It prints only patch names, not empty lines or comments. It prints in order from first to be applied to last. -\subsection{\hgcmd{qtop}---print the name of the current patch} +\subsection{\hgxcmd{mq}{qtop}---print the name of the current patch} -The \hgcmd{qtop} prints the name of the topmost currently applied +The \hgxcmd{mq}{qtop} prints the name of the topmost currently applied patch. -\subsection{\hgcmd{qunapplied}---print patches not yet applied} +\subsection{\hgxcmd{mq}{qunapplied}---print patches not yet applied} -The \hgcmd{qunapplied} command prints the names of patches from the +The \hgxcmd{mq}{qunapplied} command prints the names of patches from the \sfilename{series} file that are not yet applied. It prints them in order from the next patch that will be pushed to the last. -\subsection{\hgcmd{qversion}} +\subsection{\hgxcmd{mq}{qversion}} -The \hgcmd{qversion} command prints the version of MQ that is in use. +The \hgxcmd{mq}{qversion} command prints the version of MQ that is in use. \subsection{\hgcmd{strip}---remove a revision and descendants} @@ -328,7 +328,7 @@ You will often need to edit the \sfilename{series} file by hand, hence the support for comments and empty lines noted above. For example, -you can comment out a patch temporarily, and \hgcmd{qpush} will skip +you can comment out a patch temporarily, and \hgxcmd{mq}{qpush} will skip over that patch when applying patches. You can also change the order in which patches are applied by reordering their entries in the \sfilename{series} file. @@ -336,7 +336,7 @@ Placing the \sfilename{series} 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 using the \hgopt{qinit}{-c} option to \hgcmd{qinit}, this +directory using the \hgopt{qinit}{-c} option to \hgxcmd{mq}{qinit}, this will be done for you automatically. \subsection{The \sfilename{status} file}
--- a/en/mq.tex Sun May 27 09:40:12 2007 -0700 +++ b/en/mq.tex Sun May 27 09:41:55 2007 -0700 @@ -227,7 +227,7 @@ Once the extension is enabled, it will make a number of new commands available. To verify that the extension is working, you can use -\hgcmd{help} to see if the \hgcmd{qinit} command is now available; see +\hgcmd{help} to see if the \hgxcmd{mq}{qinit} command is now available; see the example in figure~\ref{ex:mq:enabled}. \begin{figure}[ht] @@ -238,10 +238,10 @@ You can use MQ with \emph{any} Mercurial repository, and its commands only operate within that repository. To get started, simply prepare -the repository using the \hgcmd{qinit} command (see +the repository using the \hgxcmd{mq}{qinit} command (see figure~\ref{ex:mq:qinit}). This command creates an empty directory called \sdirname{.hg/patches}, where MQ will keep its metadata. As -with many Mercurial commands, the \hgcmd{qinit} command prints nothing +with many Mercurial commands, the \hgxcmd{mq}{qinit} command prints nothing if it succeeds. \begin{figure}[ht] @@ -258,7 +258,7 @@ \subsection{Creating a new patch} -To begin work on a new patch, use the \hgcmd{qnew} command. This +To begin work on a new patch, use the \hgxcmd{mq}{qnew} command. This command takes one argument, the name of the patch to create. MQ will use this as the name of an actual file in the \sdirname{.hg/patches} directory, as you can see in figure~\ref{ex:mq:qnew}. @@ -286,7 +286,7 @@ \subsection{Refreshing a patch} When you reach a point where you want to save your work, use the -\hgcmd{qrefresh} command (figure~\ref{ex:mq:qnew}) to update the patch +\hgxcmd{mq}{qrefresh} command (figure~\ref{ex:mq:qnew}) to update the patch you are working on. This command folds the changes you have made in the working directory into your patch, and updates its corresponding changeset to contain those changes. @@ -297,7 +297,7 @@ \label{ex:mq:qrefresh} \end{figure} -You can run \hgcmd{qrefresh} as often as you like, so it's a good way +You can run \hgxcmd{mq}{qrefresh} as often as you like, so it's a good way to ``checkpoint'' your work. Refresh your patch at an opportune time; try an experiment; and if the experiment doesn't work out, \hgcmd{revert} your modifications back to the last time you refreshed. @@ -311,7 +311,7 @@ \subsection{Stacking and tracking patches} Once you have finished working on a patch, or need to work on another, -you can use the \hgcmd{qnew} command again to create a new patch. +you can use the \hgxcmd{mq}{qnew} command again to create a new patch. Mercurial will apply this patch on top of your existing patch. See figure~\ref{ex:mq:qnew2} for an example. Notice that the patch contains the changes in our prior patch as part of its context (you @@ -323,24 +323,24 @@ \label{ex:mq:qnew2} \end{figure} -So far, with the exception of \hgcmd{qnew} and \hgcmd{qrefresh}, we've +So far, with the exception of \hgxcmd{mq}{qnew} and \hgxcmd{mq}{qrefresh}, we've been careful to only use regular Mercurial commands. However, MQ provides many commands that are easier to use when you are thinking about patches, as illustrated in figure~\ref{ex:mq:qseries}: \begin{itemize} -\item The \hgcmd{qseries} command lists every patch that MQ knows +\item The \hgxcmd{mq}{qseries} command lists every patch that MQ knows about in this repository, from oldest to newest (most recently \emph{created}). -\item The \hgcmd{qapplied} command lists every patch that MQ has +\item The \hgxcmd{mq}{qapplied} command lists every patch that MQ has \emph{applied} in this repository, again from oldest to newest (most recently applied). \end{itemize} \begin{figure}[ht] \interaction{mq.tutorial.qseries} - \caption{Understanding the patch stack with \hgcmd{qseries} and - \hgcmd{qapplied}} + \caption{Understanding the patch stack with \hgxcmd{mq}{qseries} and + \hgxcmd{mq}{qapplied}} \label{ex:mq:qseries} \end{figure} @@ -353,7 +353,7 @@ An \emph{applied} patch has a corresponding changeset in the repository, and the effects of the patch and changeset are visible in the working directory. You can undo the application of a patch using -the \hgcmd{qpop} command. MQ still \emph{knows about}, or manages, a +the \hgxcmd{mq}{qpop} command. MQ still \emph{knows about}, or manages, a popped patch, but the patch no longer has a corresponding changeset in the repository, and the working directory does not contain the changes made by the patch. Figure~\ref{fig:mq:stack} illustrates the @@ -366,13 +366,13 @@ \label{fig:mq:stack} \end{figure} -You can reapply an unapplied, or popped, patch using the \hgcmd{qpush} +You can reapply an unapplied, or popped, patch using the \hgxcmd{mq}{qpush} command. This creates a new changeset to correspond to the patch, and the patch's changes once again become present in the working -directory. See figure~\ref{ex:mq:qpop} for examples of \hgcmd{qpop} -and \hgcmd{qpush} in action. Notice that once we have popped a patch -or two patches, the output of \hgcmd{qseries} remains the same, while -that of \hgcmd{qapplied} has changed. +directory. See figure~\ref{ex:mq:qpop} for examples of \hgxcmd{mq}{qpop} +and \hgxcmd{mq}{qpush} in action. Notice that once we have popped a patch +or two patches, the output of \hgxcmd{mq}{qseries} remains the same, while +that of \hgxcmd{mq}{qapplied} has changed. \begin{figure}[ht] \interaction{mq.tutorial.qpop} @@ -382,10 +382,10 @@ \subsection{Pushing and popping many patches} -While \hgcmd{qpush} and \hgcmd{qpop} each operate on a single patch at +While \hgxcmd{mq}{qpush} and \hgxcmd{mq}{qpop} each operate on a single patch at a time by default, you can push and pop many patches in one go. The -\hgopt{qpush}{-a} option to \hgcmd{qpush} causes it to push all -unapplied patches, while the \hgopt{qpop}{-a} option to \hgcmd{qpop} +\hgopt{qpush}{-a} option to \hgxcmd{mq}{qpush} causes it to push all +unapplied patches, while the \hgopt{qpop}{-a} option to \hgxcmd{mq}{qpop} causes it to pop all applied patches. (For some more ways to push and pop many patches, see section~\ref{sec:mq:perf} below.) @@ -401,7 +401,7 @@ anything, and fail if they find any modifications. They do this to ensure that you won't lose any changes that you have made, but not yet incorporated into a patch. Figure~\ref{ex:mq:add} illustrates this; -the \hgcmd{qnew} command will not create a new patch if there are +the \hgxcmd{mq}{qnew} command will not create a new patch if there are outstanding changes, caused in this case by the \hgcmd{add} of \filename{file3}. @@ -422,7 +422,7 @@ \subsection{Working on several patches at once} -The \hgcmd{qrefresh} command always refreshes the \emph{topmost} +The \hgxcmd{mq}{qrefresh} command always refreshes the \emph{topmost} applied patch. This means that you can suspend work on one patch (by refreshing it), pop or push to make a different patch the top, and work on \emph{that} patch for a while. @@ -433,9 +433,9 @@ top of the first---changes the user interface to use the code you just added to the core. If you notice a bug in the core while you're working on the UI patch, it's easy to fix the core. Simply -\hgcmd{qrefresh} the UI patch to save your in-progress changes, and -\hgcmd{qpop} down to the core patch. Fix the core bug, -\hgcmd{qrefresh} the core patch, and \hgcmd{qpush} back to the UI +\hgxcmd{mq}{qrefresh} the UI patch to save your in-progress changes, and +\hgxcmd{mq}{qpop} down to the core patch. Fix the core bug, +\hgxcmd{mq}{qrefresh} the core patch, and \hgxcmd{mq}{qpush} back to the UI patch to continue where you left off. \section{More about patches} @@ -487,11 +487,11 @@ If you receive a patch from someone that you want to add to your patch queue, and the patch needs a strip count other than one, you cannot -just \hgcmd{qimport} the patch, because \hgcmd{qimport} does not yet +just \hgxcmd{mq}{qimport} the patch, because \hgxcmd{mq}{qimport} does not yet have a \texttt{-p} option (see~\bug{311}). Your best bet is to -\hgcmd{qnew} a patch of your own, then use \cmdargs{patch}{-p\emph{N}} +\hgxcmd{mq}{qnew} a patch of your own, then use \cmdargs{patch}{-p\emph{N}} to apply their patch, followed by \hgcmd{addremove} to pick up any -files added or removed by the patch, followed by \hgcmd{qrefresh}. +files added or removed by the patch, followed by \hgxcmd{mq}{qrefresh}. This complexity may become unnecessary; see~\bug{311} for details. \subsection{Strategies for applying a patch} @@ -557,7 +557,7 @@ be completely successful, these inexact techniques naturally leave open the possibility of corrupting the patched file. The most common cases typically involve applying a patch twice, or at an incorrect -location in the file. If \command{patch} or \hgcmd{qpush} ever +location in the file. If \command{patch} or \hgxcmd{mq}{qpush} ever mentions an offset or fuzz factor, you should make sure that the modified files are correct afterwards. @@ -573,7 +573,7 @@ \subsection{Handling rejection} -If \hgcmd{qpush} fails to apply a patch, it will print an error +If \hgxcmd{mq}{qpush} fails to apply a patch, it will print an error message and exit. If it has left \sfilename{.rej} files behind, it is usually best to fix up the rejected hunks before you push more patches or do any further work. @@ -627,24 +627,24 @@ \hgcmdargs{qpush}{\hgopt{qpush}{-a}} all 1,738 patches in 3.5 minutes, and \hgcmdargs{qpop}{\hgopt{qpop}{-a}} them all in 30 seconds. (On a newer laptop, the time to push all patches dropped to two minutes.) I -could \hgcmd{qrefresh} one of the biggest patches (which made 22,779 +could \hgxcmd{mq}{qrefresh} one of the biggest patches (which made 22,779 lines of changes to 287 files) in 6.6 seconds. Clearly, MQ is well suited to working in large trees, but there are a few tricks you can use to get the best performance of it. First of all, try to ``batch'' operations together. Every time you -run \hgcmd{qpush} or \hgcmd{qpop}, these commands scan the working +run \hgxcmd{mq}{qpush} or \hgxcmd{mq}{qpop}, these commands scan the working directory once to make sure you haven't made some changes and then -forgotten to run \hgcmd{qrefresh}. On a small tree, the time that +forgotten to run \hgxcmd{mq}{qrefresh}. On a small tree, the time that this scan takes is unnoticeable. However, on a medium-sized tree (containing tens of thousands of files), it can take a second or more. -The \hgcmd{qpush} and \hgcmd{qpop} commands allow you to push and pop +The \hgxcmd{mq}{qpush} and \hgxcmd{mq}{qpop} commands allow you to push and pop multiple patches at a time. You can identify the ``destination -patch'' that you want to end up at. When you \hgcmd{qpush} with a +patch'' that you want to end up at. When you \hgxcmd{mq}{qpush} with a destination specified, it will push patches until that patch is at the -top of the applied stack. When you \hgcmd{qpop} to a destination, MQ +top of the applied stack. When you \hgxcmd{mq}{qpop} to a destination, MQ will pop patches until the destination patch is at the top. You can identify a destination patch using either the name of the @@ -668,7 +668,7 @@ repository, and finally \hgcmdargs{qpush}{\hgopt{qpop}{-a}} your patches again. MQ will stop pushing any time it runs across a patch that fails to apply during conflicts, allowing you to fix your -conflicts, \hgcmd{qrefresh} the affected patch, and continue pushing +conflicts, \hgxcmd{mq}{qrefresh} the affected patch, and continue pushing until you have fixed your entire stack. This approach is easy to use and works well if you don't expect @@ -700,13 +700,13 @@ \hgcmdargs{update}{\hgopt{update}{-C}} to override the patches you have pushed. \item Merge all patches using \hgcmdargs{qpush}{\hgopt{qpush}{-m} - \hgopt{qpush}{-a}}. The \hgopt{qpush}{-m} option to \hgcmd{qpush} + \hgopt{qpush}{-a}}. The \hgopt{qpush}{-m} option to \hgxcmd{mq}{qpush} tells MQ to perform a three-way merge if the patch fails to apply. \end{enumerate} During the \hgcmdargs{qpush}{\hgopt{qpush}{-m}}, each patch in the \sfilename{series} file is applied normally. If a patch applies with -fuzz or rejects, MQ looks at the queue you \hgcmd{qsave}d, and +fuzz or rejects, MQ looks at the queue you \hgxcmd{mq}{qsave}d, and performs a three-way merge with the corresponding changeset. This merge uses Mercurial's normal merge machinery, so it may pop up a GUI merge tool to help you to resolve problems. @@ -725,7 +725,7 @@ MQ commands that work with patches let you refer to a patch either by using its name or by a number. By name is obvious enough; pass the -name \filename{foo.patch} to \hgcmd{qpush}, for example, and it will +name \filename{foo.patch} to \hgxcmd{mq}{qpush}, for example, and it will push patches until \filename{foo.patch} is applied. As a shortcut, you can refer to a patch using both a name and a @@ -734,7 +734,7 @@ after \texttt{bar.patch}''. Referring to a patch by index isn't much different. The first patch -printed in the output of \hgcmd{qseries} is patch zero (yes, it's one +printed in the output of \hgxcmd{mq}{qseries} is patch zero (yes, it's one of those start-at-zero counting systems); the second is patch one; and so on @@ -789,7 +789,7 @@ one place. \begin{itemize} -\item Normally, when you \hgcmd{qpop} a patch and \hgcmd{qpush} it +\item Normally, when you \hgxcmd{mq}{qpop} a patch and \hgxcmd{mq}{qpush} it again, the changeset that represents the patch after the pop/push will have a \emph{different identity} than the changeset that represented the hash beforehand. See @@ -811,7 +811,7 @@ This presents the interesting possibility of managing the contents of the patch directory as a Mercurial repository in its own right. This can be a useful way to work. For example, you can work on a patch for -a while, \hgcmd{qrefresh} it, then \hgcmd{commit} the current state of +a while, \hgxcmd{mq}{qrefresh} it, then \hgcmd{commit} the current state of the patch. This lets you ``roll back'' to that version of the patch later on. @@ -833,7 +833,7 @@ MQ helps you to work with the \sdirname{.hg/patches} directory as a repository; when you prepare a repository for working with patches -using \hgcmd{qinit}, you can pass the \hgopt{qinit}{-c} option to +using \hgxcmd{mq}{qinit}, you can pass the \hgopt{qinit}{-c} option to create the \sdirname{.hg/patches} directory as a Mercurial repository. \begin{note} @@ -851,7 +851,7 @@ directory is a repository, it will automatically \hgcmd{add} every patch that you create and import. -Finally, MQ provides a shortcut command, \hgcmd{qcommit}, that runs +Finally, MQ provides a shortcut command, \hgxcmd{mq}{qcommit}, that runs \hgcmd{commit} in the \sdirname{.hg/patches} directory. This saves some cumbersome typing. @@ -911,15 +911,15 @@ \filename{rework-device-alloc.patch}, because it will immediately give you a hint what the purpose of the patch is. Long names shouldn't be a problem; you won't be typing the names often, but you \emph{will} be -running commands like \hgcmd{qapplied} and \hgcmd{qtop} over and over. +running commands like \hgxcmd{mq}{qapplied} and \hgxcmd{mq}{qtop} over and over. Good naming becomes especially important when you have a number of patches to work with, or if you are juggling a number of different tasks and your patches only get a fraction of your attention. -Be aware of what patch you're working on. Use the \hgcmd{qtop} +Be aware of what patch you're working on. Use the \hgxcmd{mq}{qtop} command and skim over the text of your patches frequently---for example, using \hgcmdargs{tip}{\hgopt{tip}{-p}})---to be sure of where -you stand. I have several times worked on and \hgcmd{qrefresh}ed a +you stand. I have several times worked on and \hgxcmd{mq}{qrefresh}ed a patch other than the one I intended, and it's often tricky to migrate changes into the right patch after making them in the wrong one. @@ -960,14 +960,14 @@ \subsection{Combining entire patches} \label{sec:mq:combine} -MQ provides a command, \hgcmd{qfold} that lets you combine entire +MQ provides a command, \hgxcmd{mq}{qfold} that lets you combine entire patches. This ``folds'' the patches you name, in the order you name them, into the topmost applied patch, and concatenates their descriptions onto the end of its description. The patches that you fold must be unapplied before you fold them. The order in which you fold patches matters. If your topmost applied -patch is \texttt{foo}, and you \hgcmd{qfold} \texttt{bar} and +patch is \texttt{foo}, and you \hgxcmd{mq}{qfold} \texttt{bar} and \texttt{quux} into it, you will end up with a patch that has the same effect as if you applied first \texttt{foo}, then \texttt{bar}, followed by \texttt{quux}. @@ -983,8 +983,8 @@ out of one patch, concatenating its output onto the end of the patch you want to merge into. You usually won't need to modify the patch you've merged the changes from. Instead, MQ will report some rejected -hunks when you \hgcmd{qpush} it (from the hunks you moved into the -other patch), and you can simply \hgcmd{qrefresh} the patch to drop +hunks when you \hgxcmd{mq}{qpush} it (from the hunks you moved into the +other patch), and you can simply \hgxcmd{mq}{qrefresh} the patch to drop the duplicate hunks. If you have a patch that has multiple hunks modifying a file, and you