hgbook

changeset 53:0c998750744f

Update mq chapter to cover new commands and options.
author Bryan O'Sullivan <bos@serpentine.com>
date Tue Aug 01 12:38:13 2006 -0700 (2006-08-01)
parents 3e8c9b32b03c
children e94202d88199
files en/mq.tex
line diff
     1.1 --- a/en/mq.tex	Thu Jul 27 15:10:58 2006 -0700
     1.2 +++ b/en/mq.tex	Tue Aug 01 12:38:13 2006 -0700
     1.3 @@ -1043,14 +1043,26 @@
     1.4  
     1.5  The \hgcmd{qdelete} command removes the entry for a patch from the
     1.6  \sfilename{series} file in the \sdirname{.hg/patches} directory.  It
     1.7 -does not delete the patch file, nor does it pop the patch if the patch
     1.8 -is already applied.
     1.9 +does not pop the patch if the patch is already applied.  By default,
    1.10 +it does not delete the patch file; use the \hgopt{qdel}{-f} option to
    1.11 +do that.
    1.12 +
    1.13 +Options:
    1.14 +\begin{itemize}
    1.15 +\item[\hgopt{qdel}{-f}] Delete the patch file.
    1.16 +\end{itemize}
    1.17  
    1.18  \subsection{\hgcmd{qdiff}---print a diff of the topmost applied patch}
    1.19  
    1.20  The \hgcmd{qdiff} command prints a diff of the topmost applied patch.
    1.21  It is equivalent to \hgcmdargs{diff}{-r-2:-1}.
    1.22  
    1.23 +\subsection{\hgcmd{qheader}---display the header/description of a patch}
    1.24 +
    1.25 +The \hgcmd{qheader} command prints the header, or description, of a
    1.26 +patch.  By default, it prints the header of the topmost applied patch.
    1.27 +Given an argument, it prints the header of the named patch.
    1.28 +
    1.29  \subsection{\hgcmd{qimport}---import a third-party patch into the queue}
    1.30  
    1.31  The \hgcmd{qimport} command adds an entry for an external patch to the
    1.32 @@ -1221,6 +1233,25 @@
    1.33  changeset to differ from the previous changeset that identified the
    1.34  patch.
    1.35  
    1.36 +Options:
    1.37 +\begin{itemize}
    1.38 +\item[\hgopt{qrefresh}{-e}] Modify the commit and patch description,
    1.39 +  using the preferred text editor.
    1.40 +\item[\hgopt{qrefresh}{-m}] Modify the commit message and patch
    1.41 +  description, using the given text.
    1.42 +\item[\hgopt{qrefresh}{-l}] Modify the commit message and patch
    1.43 +  description, using text from the given file.
    1.44 +\end{itemize}
    1.45 +
    1.46 +\subsection{\hgcmd{qrename}---rename a patch}
    1.47 +
    1.48 +The \hgcmd{qrename} command renames a patch, and changes the entry for
    1.49 +the patch in the \sfilename{series} file.
    1.50 +
    1.51 +With a single argument, \hgcmd{qrename} renames the topmost applied
    1.52 +patch.  With two arguments, it renames its first argument to its
    1.53 +second.
    1.54 +
    1.55  \subsection{\hgcmd{qrestore}---restore saved queue state}
    1.56  
    1.57  XXX No idea what this does.
    1.58 @@ -1269,9 +1300,9 @@
    1.59    when there are pending changes.
    1.60  \item[\hgopt{strip}{-n}] Do not save a backup bundle.
    1.61  \end{itemize}
    1.62 +
    1.63  \section{MQ file reference}
    1.64  
    1.65 -
    1.66  \subsection{The \sfilename{series} file}
    1.67  
    1.68  The \sfilename{series} file contains a list of the names of all
    1.69 @@ -1295,6 +1326,7 @@
    1.70  refers to under revision control, as well.  If you create a patch
    1.71  directory using the \hgopt{qinit}{-c} option to \hgcmd{qinit}, this
    1.72  will be done for you automatically.
    1.73 +
    1.74  \subsection{The \sfilename{status} file}
    1.75  
    1.76  The \sfilename{status} file contains the names and changeset hashes of