hgbook

diff en/mq.tex @ 7:339e75288632

More progress on MQ chapter and general support.

Added a note environment.

Fixed generated HTML so it wouldn't use huge escaped entities for everything.

Wrote a small amount of actual content.
author Bryan O'Sullivan <bos@serpentine.com>
date Mon Jun 26 12:25:11 2006 -0700 (2006-06-26)
parents 33a2e7b9978d
children a25335b56825
line diff
     1.1 --- a/en/mq.tex	Sun Jun 25 22:04:50 2006 -0700
     1.2 +++ b/en/mq.tex	Mon Jun 26 12:25:11 2006 -0700
     1.3 @@ -133,7 +133,7 @@
     1.4  with the standard Mercurial distribution.)  To enable MQ, edit your
     1.5  \tildefile{.hgrc} file, and add the lines in figure~\ref{ex:mq:config}.
     1.6  
     1.7 -\begin{figure}
     1.8 +\begin{figure}[h]
     1.9    \begin{codesample4}
    1.10      [extensions]
    1.11      hgext.mq =
    1.12 @@ -143,15 +143,54 @@
    1.13  \end{figure}
    1.14  
    1.15  Once the extension is enabled, it will make a number of new commands
    1.16 -available.  To verify that the extension is working, follow the
    1.17 -example in figure~\ref{ex:mq:enabled}.
    1.18 +available.  To verify that the extension is working, you can use
    1.19 +\hgcmd{help} to see if the \hgcmd{qinit} command is now available; see
    1.20 +the example in figure~\ref{ex:mq:enabled}.
    1.21  
    1.22 -\begin{figure}
    1.23 +\begin{figure}[h]
    1.24    \interaction{mq.qinit-help.help}
    1.25    \caption{How to verify that MQ is enabled}
    1.26    \label{ex:mq:enabled}
    1.27  \end{figure}
    1.28  
    1.29 +You can use MQ with \emph{any} Mercurial repository; to start, simply
    1.30 +prepare the repository using the \hgcmd{qinit} command (see
    1.31 +figure~\ref{ex:mq:qinit}).  This command creates an empty directory
    1.32 +called \filename{.hg/patches}, where MQ will keep its metadata.  As
    1.33 +with many Mercurial commands, the \hgcmd{qinit} command prints nothing
    1.34 +if it succeeds.
    1.35 +
    1.36 +\begin{figure}[h]
    1.37 +  \interaction{mq.tutorial.qinit}
    1.38 +  \caption{Preparing a repository for use with MQ}
    1.39 +  \label{ex:mq:qinit}
    1.40 +\end{figure}
    1.41 +
    1.42 +\begin{figure}[h]
    1.43 +  \interaction{mq.tutorial.qnew}
    1.44 +  \caption{Creating a new patch}
    1.45 +  \label{ex:mq:qnew}
    1.46 +\end{figure}
    1.47 +
    1.48 +To commence work on a new patch, use the \hgcmd{qnew} command.  This
    1.49 +command takes one argument, the name of the patch to create.  MQ will
    1.50 +use this as the name of an actual file in the \filename{.hg/patches}
    1.51 +directory, as you can see in figure~\ref{ex:mq:qnew}.
    1.52 +
    1.53 +Now also present in the \filename{.hg/patches} directory are two new
    1.54 +files, \filename{series} and \filename{status}.  The \filename{series}
    1.55 +file lists all of the patches that MQ knows about for this repository,
    1.56 +with one patch per line.  The \filename{status} file lists all of the
    1.57 +patches that MQ has \emph{applied} in this repository.
    1.58 +
    1.59 +\begin{note}
    1.60 +  You may sometimes want to edit the \filename{series} file by hand;
    1.61 +  for example, to change the sequence in which some patches are
    1.62 +  applied.  However, manually editing the \filename{status} file is
    1.63 +  almost always a bad idea, as it's easy to corrupt MQ's idea of what
    1.64 +  is happening.
    1.65 +\end{note}
    1.66 +
    1.67  %%% Local Variables: 
    1.68  %%% mode: latex
    1.69  %%% TeX-master: "00book"