Mercurial > hgbook

changeset 189:3c6c5b551c96

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge backout.
author Bryan O'Sullivan <bos@serpentine.com>
date Mon, 16 Apr 2007 14:23:11 -0700
parents d3dd1bedba3c (current diff) b60e2de6dbc3 (diff)
children cd066590e2e3
files en/examples/tour.commit-no-user.out
diffstat 36 files changed, 727 insertions(+), 79 deletions(-) [+]
line wrap: on
line diff
--- a/.hgignore	Mon Apr 16 14:22:25 2007 -0700
+++ b/.hgignore	Mon Apr 16 14:23:11 2007 -0700
@@ -6,6 +6,7 @@
 
 beta/*.tex
 build_id.tex
+hg_id.tex
 *.4[ct][ct]
 *.aux
 *.bbl
--- a/en/00book.tex	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/00book.tex	Mon Apr 16 14:23:11 2007 -0700
@@ -13,13 +13,14 @@
 
 \include{99defs}
 
-\title{Distributed revision control with Mercurial}
-\author{Bryan O'Sullivan}
+\title{Distributed revision control with Mercurial} \author{Bryan
+  O'Sullivan}
 \date{Copyright \copyright\ 2006, 2007 Bryan O'Sullivan.\\
   This material may be distributed only subject to the terms and
   conditions set forth in version 1.0 of the Open Publication License.
   Please refer to Appendix~\ref{cha:opl} for the license text.\\
-  This book was prepared from revision \input{build_id}.}
+  This book was prepared from revision \input{build_id} of its sources
+  using revision \input{hg_id} of Mercurial.}
 
 \makeindex
 
@@ -43,6 +44,7 @@
 \include{daily}
 \include{collab}
 \include{filenames}
+\include{branch}
 \include{undo}
 \include{hook}
 \include{template}
--- a/en/99book.bib	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/99book.bib	Mon Apr 16 14:23:11 2007 -0700
@@ -62,3 +62,9 @@
   title =	 {Universal MacPython},
   note =	 {\url{http://bob.pythonmac.org/archives/2006/04/10/python-and-universal-binaries-on-mac-os-x/}},
 }
+
+@Misc{web:putty,
+  author =	 {Simon Tatham},
+  title =	 {PuTTY---open source ssh client for Windows},
+  note =	 {\url{http://www.chiark.greenend.org.uk/~sgtatham/putty/}},
+}
--- a/en/99defs.tex	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/99defs.tex	Mon Apr 16 14:23:11 2007 -0700
@@ -68,7 +68,12 @@
     section!\texttt{#2} entry}\texttt{#2}}
 
 % hgrc file.
-\newcommand{\hgrc}{\index{\texttt{hgrc} file}\texttt{hgrc}}
+\newcommand{\hgrc}{\index{configuration file!\texttt{hgrc}
+    (Linux/Unix)}\index{\texttt{hgrc} configuration file}\texttt{hgrc}}
+
+% Mercurial.ini file.
+\newcommand{\hgini}{\index{configuration file!\texttt{Mercurial.ini}
+    (Windows)}\index{\texttt{Mercurial.ini} configuration file}\texttt{Mercurial.ini}}
 
 % Hook name.
 \newcommand{\hook}[1]{\index{\texttt{#1} hook}\index{hooks!\texttt{#1}}\texttt{#1}}
--- a/en/Makefile	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/Makefile	Mon Apr 16 14:23:11 2007 -0700
@@ -1,17 +1,17 @@
 # This makefile requires GNU make.
 
-hg_id := $(shell hg parents --template '{node|short}\n')
-
 sources := \
 	00book.tex \
 	99book.bib \
 	99defs.tex \
 	build_id.tex \
+	branch.tex \
 	cmdref.tex \
 	collab.tex \
 	concepts.tex \
 	daily.tex \
 	filenames.tex \
+	hg_id.tex \
 	hook.tex \
 	intro.tex \
 	mq.tex \
@@ -25,6 +25,7 @@
 	undo.tex
 
 image-sources := \
+	feature-branches.dot \
 	filelog.svg \
 	kdiff3.png \
 	metadata.svg \
@@ -54,6 +55,7 @@
 example-sources := \
 	backout \
 	bisect \
+	branching \
 	cmdref \
 	daily.copy \
 	daily.files \
@@ -78,6 +80,9 @@
 	tour \
 	tour-merge-conflict
 
+example-prereqs := \
+	/usr/bin/merge
+
 dist-sources := \
 	../html/hgicon.png \
 	../html/index.html.var \
@@ -88,6 +93,13 @@
 	-output-directory $(dir $(1)) \
 	-jobname $(basename $(notdir $(1)))
 
+hg = $(shell which hg)
+
+hg-id = $(shell hg parents --template '{node|short}\n')
+
+hg-version = $(shell hg version -q | \
+		     sed 's,.*(version \(unknown\|[a-f0-9]*\)),\1,')
+
 all: pdf html
 
 pdf: pdf/hgbook.pdf
@@ -110,25 +122,21 @@
 
 html: onepage split
 
-onepage: html/onepage/hgbook.html
+htlatex := /usr/bin/htlatex
 
-split: html/split/hgbook.html
+onepage: $(htlatex) html/onepage/hgbook.html
+
+split: $(htlatex) html/split/hgbook.html
 
 # This is a horrible hack to work around the fact that the htlatex
 # command in tex4ht is itself a horrible hack.  I really don't want to
 # include verbatim the big wad of TeX that is repeated in that script,
-# so instead I mangle the script itself.
+# but I've given up and run a hacked copy as htlatex.book here.
 
 define htlatex
 	mkdir -p $(dir $(1))
-	head -2 $(shell which htlatex) > $(dir $(1))/htlatex.book
-	cp 99book.bib $(dir $@)
-	echo '(cd $(dir $@) && bibtex $(basename $(notdir $@)))' >> $(dir $(1))/htlatex.book
-	echo '(cd $(dir $@) && makeindex $(basename $(notdir $@)))' >> $(dir $(1))/htlatex.book
-	head -3 $(shell which htlatex) >> $(dir $(1))/htlatex.book
-	echo 'echo status $$$$' >>  $(dir $(1))/htlatex.book
-	chmod 755 $(dir $(1))/htlatex.book
-	TEXINPUTS=$(dir $(2)): $(dir $(1))/htlatex.book $(2) "bookhtml,html4-uni,$(3)" " -cunihtf -utf8" "" "$(call latex-options,$(1))" || (rm -f $(1); exit 1)
+	cp 99book.bib $(dir $(1))
+	TEXINPUTS=$(dir $(2)): ./htlatex.book $(2) "bookhtml,html4-uni,$(3)" " -cunihtf -utf8" "$(dir $(1))" "$(call latex-options,$(1))" || (rm -f $(1); exit 1)
 	cd $(dir $(1)) && tex4ht -f/$(basename $(notdir $(1))) -cvalidate -cunihtf
 	cd $(dir $(1)) && t4ht -f/$(basename $(notdir $(1)))
 	./fixhtml.py $(dir $(1))/*.html
@@ -165,7 +173,7 @@
 %.eps: %.dot
 	dot -Tps -o $@ $<
 
-examples: examples/.run
+examples: $(example-prereqs) examples/.run
 
 examples/.run: $(example-sources:%=examples/%.run)
 	touch examples/.run
@@ -174,7 +182,10 @@
 	cd examples && ./run-example $(notdir $<)
 
 build_id.tex: $(wildcard ../.hg/00changelog.[id])
-	echo -n $(hg_id) > build_id.tex
+	echo -n $(hg-id) > build_id.tex
+
+hg_id.tex: $(hg)
+	echo -n $(hg-version) > hg_id.tex
 
 clean:
 	rm -rf dist html pdf \
@@ -182,7 +193,7 @@
 		$(image-dot:%.dot=%.png) \
 		$(image-svg:%.svg=%.pdf) \
 		$(image-svg:%.svg=%.png) \
-		examples/*.{lxo,run} examples/.run build_id.tex
+		examples/*.{lxo,run} examples/.run build_id.tex hg_id.tex
 
 install: pdf split $(dist-sources)
 	rm -rf dist
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/en/branch.tex	Mon Apr 16 14:23:11 2007 -0700
@@ -0,0 +1,9 @@
+\chapter{Managing branchy development}
+\label{chap:branch}
+
+
+
+%%% Local Variables: 
+%%% mode: latex
+%%% TeX-master: "00book"
+%%% End: 
--- a/en/collab.tex	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/collab.tex	Mon Apr 16 14:23:11 2007 -0700
@@ -74,7 +74,7 @@
 
 \subsection{A single central repository}
 
-For smaller projects, migrating from a centralised revision control
+For smaller projects migrating from a centralised revision control
 tool, perhaps the easiest way to get started is to have changes flow
 through a single shared central repository.  This is also the
 most common ``building block'' for more ambitious workflow schemes.
@@ -84,7 +84,7 @@
 developers have permission to push a change back when they're ready
 for other people to see it.
 
-Under this model, it can still sometimes make sense for people to pull
+Under this model, it can still often make sense for people to pull
 changes directly from each other, without going through the central
 repository.  Consider a case in which I have a tentative bug fix, but
 I am worried that if I were to publish it to the central repository,
@@ -102,6 +102,97 @@
 needs of people who don't have push access, and those who want to use
 web browsers to browse the repository's history.
 
+\subsection{Working with multiple branches}
+
+Projects of any significant size naturally tend to make progress on
+several fronts simultaneously.  In the case of software, it's common
+for a project to go through periodic official releases.  A release
+might then go into ``maintenance mode'' for a while after its first
+publication; maintenance releases tend to contain only bug fixes, not
+new features.  In parallel with these maintenance releases, one or
+more future releases may be under development.  People normally use
+the word ``branch'' to refer to one of these many slightly different
+directions in which development is proceeding.
+
+Mercurial is particularly well suited to managing a number of
+simultaneous, but not identical, branches.  Each ``development
+direction'' can live in its own central repository, and you can merge
+changes from one to another as the need arises.  Because repositories
+are independent of each other, unstable changes in a development
+branch will never affect a stable branch unless someone explicitly
+merges those changes in.
+
+Here's an example of how this can work in practice.  Let's say you
+have one ``main branch'' on a central server.
+\interaction{branching.init}
+People clone it, make changes locally, test them, and push them back.
+
+Once the main branch reaches a release milestone, you can use the
+\hgcmd{tag} command to give a permanent name to the milestone
+revision.
+\interaction{branching.tag}
+Let's say some ongoing development occurs on the main branch.
+\interaction{branching.main}
+Using the tag that was recorded at the milestone, people who clone
+that repository at any time in the future can use \hgcmd{update} to
+get a copy of the working directory exactly as it was when that tagged
+revision was committed.  
+\interaction{branching.update}
+
+In addition, immediately after the main branch is tagged, someone can
+then clone the main branch on the server to a new ``stable'' branch,
+also on the server.
+\interaction{branching.clone}
+
+Someone who needs to make a change to the stable branch can then clone
+\emph{that} repository, make their changes, commit, and push their
+changes back there.
+\interaction{branching.stable}
+Because Mercurial repositories are independent, and Mercurial doesn't
+move changes around automatically, the stable and main branches are
+\emph{isolated} from each other.  The changes that you made on the
+main branch don't ``leak'' to the stable branch, and vice versa.
+
+You'll often want all of your bugfixes on the stable branch to show up
+on the main branch, too.  Rather than rewrite a bugfix on the main
+branch, you can simply pull and merge changes from the stable to the
+main branch, and Mercurial will bring those bugfixes in for you.
+\interaction{branching.merge}
+The main branch will still contain changes that are not on the stable
+branch, but it will also contain all of the bugfixes from the stable
+branch.  The stable branch remains unaffected by these changes.
+
+\subsection{Feature branches}
+
+For larger projects, an effective way to manage change is to break up
+a team into smaller groups.  Each group has a shared branch of its
+own, cloned from a single ``master'' branch used by the entire
+project.  People working on an individual branch are typically quite
+isolated from developments on other branches.
+
+\begin{figure}[ht]
+  \centering
+  \grafix{feature-branches}
+  \caption{Feature branches}
+  \label{fig:collab:feature-branches}
+\end{figure}
+
+When a particular feature is deemed to be in suitable shape, someone
+on that feature team pulls and merges from the master branch into the
+feature branch, then pushes back up to the master branch.
+
+\subsection{The release train}
+
+Some projects are organised on a ``train'' basis: a release is
+scheduled to happen every few months, and whatever features are ready
+when the ``train'' is ready to leave are allowed in.
+
+This model resembles working with feature branches.  The difference is
+that when a feature branch misses a train, someone on the feature team
+pulls and merges the changes that went out on that train release into
+the feature branch, and the team continues its work on top of that
+release so that their feature can make the next release.
+
 \subsection{The Linux kernel model}
 
 The development of the Linux kernel has a shallow hierarchical
@@ -132,12 +223,16 @@
 to Linus.  In addition, there are several well known branches that
 people use for different purposes.  For example, a few people maintain
 ``stable'' repositories of older versions of the kernel, to which they
-apply critical fixes as needed.
+apply critical fixes as needed.  Some maintainers publish multiple
+trees: one for experimental changes; one for changes that they are
+about to feed upstream; and so on.  Others just publish a single
+tree.
 
 This model has two notable features.  The first is that it's ``pull
 only''.  You have to ask, convince, or beg another developer to take a
-change from you, because there are no shared trees, and there's no way
-to push changes into a tree that someone else controls.
+change from you, because there are almost no trees to which more than
+one person can push, and there's no way to push changes into a tree
+that someone else controls.
 
 The second is that it's based on reputation and acclaim.  If you're an
 unknown, Linus will probably ignore changes from you without even
@@ -162,6 +257,35 @@
 of development is astounding.  And yet Linux is a highly successful,
 well-regarded piece of software.
 
+\subsection{Pull-only versus shared-push collaboration}
+
+A perpetual source of heat in the open source community is whether a
+development model in which people only ever pull changes from others
+is ``better than'' one in which multiple people can push changes to a
+shared repository.
+
+Typically, the backers of the shared-push model use tools that
+actively enforce this approach.  If you're using a centralised
+revision control tool such as Subversion, there's no way to make a
+choice over which model you'll use: the tool gives you shared-push,
+and if you want to do anything else, you'll have to roll your own
+approach on top (such as applying a patch by hand).
+
+A good distributed revision control tool, such as Mercurial, will
+support both models.  You and your collaborators can then structure
+how you work together based on your own needs and preferences, not on
+what contortions your tools force you into.
+
+\subsection{Where collaboration meets branch management}
+
+Once you and your team set up some shared repositories and start
+propagating changes back and forth between local and shared repos, you
+begin to face a related, but slightly different challenge: that of
+managing the multiple directions in which your team may be moving at
+once.  Even though this subject is intimately related to how your team
+collaborates, it's dense enough to merit treatment of its own, in
+chapter~\ref{chap:branch}.
+
 \section{The technical side of sharing}
 
 \subsection{Informal sharing with \hgcmd{serve}}
@@ -222,10 +346,287 @@
 correctly, and find out what URL you should send to your
 collaborators, start it with the \hggopt{-v} option.
 
-\subsection{Using \command{ssh} as a tunnel}
+\subsection{Using the Secure Shell (ssh) protocol}
 \label{sec:collab:ssh}
 
-\subsection{Serving HTTP with a CGI script}
+You can pull and push changes securely over a network connection using
+the Secure Shell (\texttt{ssh}) protocol.  To use this successfully,
+you may have to do a little bit of configuration on the client or
+server sides.
+
+If you're not familiar with ssh, it's a network protocol that lets you
+securely communicate with another computer.  To use it with Mercurial,
+you'll be setting up one or more user accounts on a server so that
+remote users can log in and execute commands.
+
+(If you \emph{are} familiar with ssh, you'll probably find some of the
+material that follows to be elementary in nature.)
+
+\subsubsection{How to read and write ssh URLs}
+
+An ssh URL tends to look like this:
+\begin{codesample2}
+  ssh://bos@hg.serpentine.com:22/hg/hgbook
+\end{codesample2}
+\begin{enumerate}
+\item The ``\texttt{ssh://}'' part tells Mercurial to use the ssh
+  protocol.
+\item The ``\texttt{bos@}'' component indicates what username to log
+  into the server as.  You can leave this out if the remote username
+  is the same as your local username.
+\item The ``\texttt{hg.serpentine.com}'' gives the hostname of the
+  server to log into.
+\item The ``:22'' identifies the port number to connect to the server
+  on.  The default port is~22, so you only need to specify this part
+  if you're \emph{not} using port~22.
+\item The remainder of the URL is the local path to the repository on
+  the server.
+\end{enumerate}
+
+There's plenty of scope for confusion with the path component of ssh
+URLs, as there is no standard way for tools to interpret it.  Some
+programs behave differently than others when dealing with these paths.
+This isn't an ideal situation, but it's unlikely to change.  Please
+read the following paragraphs carefully.
+
+Mercurial treats the path to a repository on the server as relative to
+the remote user's home directory.  For example, if user \texttt{foo}
+on the server has a home directory of \dirname{/home/foo}, then an ssh
+URL that contains a path component of \dirname{bar}
+\emph{really} refers to the directory \dirname{/home/foo/bar}.
+
+If you want to specify a path relative to another user's home
+directory, you can use a path that starts with a tilde character
+followed by the user's name (let's call them \texttt{otheruser}), like
+this.
+\begin{codesample2}
+  ssh://server/~otheruser/hg/repo
+\end{codesample2}
+
+And if you really want to specify an \emph{absolute} path on the
+server, begin the path component with two slashes, as in this example.
+\begin{codesample2}
+  ssh://server//absolute/path
+\end{codesample2}
+
+\subsubsection{Finding an ssh client for your system}
+
+Almost every Unix-like system comes with OpenSSH preinstalled.  If
+you're using such a system, run \Verb|which ssh| to find out if
+the \command{ssh} command is installed (it's usually in
+\dirname{/usr/bin}).  In the unlikely event that it isn't present,
+take a look at your system documentation to figure out how to install
+it.
+
+On Windows, you'll first need to choose download a suitable ssh
+client.  There are two alternatives.
+\begin{itemize}
+\item Simon Tatham's excellent PuTTY package~\cite{web:putty} provides
+  a complete suite of ssh client commands.
+\item If you have a high tolerance for pain, you can use the Cygwin
+  port of OpenSSH.
+\end{itemize}
+In either case, you'll need to edit your \hgini\ file to tell
+Mercurial where to find the actual client command.  For example, if
+you're using PuTTY, you'll need to use the \command{plink} command as
+a command-line ssh client.
+\begin{codesample2}
+  [ui]
+  ssh = C:/path/to/plink.exe -ssh -i "C:/path/to/my/private/key"
+\end{codesample2}
+
+\begin{note}
+  The path to \command{plink} shouldn't contain any whitespace
+  characters, or Mercurial may not be able to run it correctly (so
+  putting it in \dirname{C:\\Program Files} is probably not be a good
+  idea).
+\end{note}
+
+\subsubsection{Generating a key pair}
+
+To avoid the need to repetitively type a password every time you need
+to use your ssh client, I recommend generating a key pair.  On a
+Unix-like system, the \command{ssh-keygen} command will do the trick.
+On Windows, if you're using PuTTY, the \command{puttygen} command is
+what you'll need.
+
+When you generate a key pair, it's usually \emph{highly} advisable to
+protect it with a passphrase.  (The only time that you might not want
+to do this id when you're using the ssh protocol for automated tasks
+on a secure network.)
+
+Simply generating a key pair isn't enough, however.  You'll need to
+add the public key to the set of authorised keys for whatever user
+you're logging in remotely as.  For servers using OpenSSH (the vast
+majority), this will mean adding the public key to a list in a file
+called \sfilename{authorized\_keys} in their \sdirname{.ssh}
+directory.
+
+On a Unix-like system, your public key will have a \filename{.pub}
+extension.  If you're using \command{puttygen} on Windows, you can
+save the public key to a file of your choosing, or paste it from the
+window it's displayed in straight into the
+\sfilename{authorized\_keys} file.
+
+\subsubsection{Using an authentication agent}
+
+An authentication agent is a daemon that stores passphrases in memory
+(so it will forget passphrases if you log out and log back in again).
+An ssh client will notice if it's running, and query it for a
+passphrase.  If there's no authentication agent running, or the agent
+doesn't store the necessary passphrase, you'll have to type your
+passphrase every time Mercurial tries to communicate with a server on
+your behalf (e.g.~whenever you pull or push changes).
+
+The downside of storing passphrases in an agent is that it's possible
+for a well-prepared attacker to recover the plain text of your
+passphrases, in some cases even if your system has been power-cycled.
+You should make your own judgment as to whether this is an acceptable
+risk.  It certainly saves a lot of repeated typing.
+
+On Unix-like systems, the agent is called \command{ssh-agent}, and
+it's often run automatically for you when you log in.  You'll need to
+use the \command{ssh-add} command to add passphrases to the agent's
+store.  On Windows, if you're using PuTTY, the \command{pageant}
+command acts as the agent.  It adds an icon to your system tray that
+will let you manage stored passphrases.
+
+\subsubsection{Configuring the server side properly}
+
+Because ssh can be fiddly to set up if you're new to it, there's a
+variety of things that can go wrong.  Add Mercurial on top, and
+there's plenty more scope for head-scratching.  Most of these
+potential problems occur on the server side, not the client side.  The
+good news is that once you've gotten a configuration working, it will
+usually continue to work indefinitely.
+
+Before you try using Mercurial to talk to an ssh server, it's best to
+make sure that you can use the normal \command{ssh} or \command{putty}
+command to talk to the server first.  If you run into problems with
+using these commands directly, Mercurial surely won't work.  Worse, it
+will obscure the underlying problem.  Any time you want to debug
+ssh-related Mercurial problems, you should drop back to making sure
+that plain ssh client commands work first, \emph{before} you worry
+about whether there's a problem with Mercurial.
+
+The first thing to be sure of on the server side is that you can
+actually log in from another machine at all.  If you can't use
+\command{ssh} or \command{putty} to log in, the error message you get
+may give you a few hints as to what's wrong.  The most common problems
+are as follows.
+\begin{itemize}
+\item If you get a ``connection refused'' error, either there isn't an
+  SSH daemon running on the server at all, or it's inaccessible due to
+  firewall configuration.
+\item If you get a ``no route to host'' error, you either have an
+  incorrect address for the server or a seriously locked down firewall
+  that won't admit its existence at all.
+\item If you get a ``permission denied'' error, you may have mistyped
+  the username on the server, or you could have mistyped your key's
+  passphrase or the remote user's password.
+\end{itemize}
+In summary, if you're having trouble talking to the server's ssh
+daemon, first make sure that one is running at all.  On many systems
+it will be installed, but disabled, by default.  Once you're done with
+this step, you should then check that the server's firewall is
+configured to allow incoming connections on the port the ssh daemon is
+listening on (usually~22).  Don't worry about more exotic
+possibilities for misconfiguration until you've checked these two
+first.
+
+If you're using an authentication agent on the client side to store
+passphrases for your keys, you ought to be able to log into the server
+without being prompted for a passphrase or a password.  If you're
+prompted for a passphrase, there are a few possible culprits.
+\begin{itemize}
+\item You might have forgotten to use \command{ssh-add} or
+  \command{pageant} to store the passphrase.
+\item You might have stored the passphrase for the wrong key.
+\end{itemize}
+If you're being prompted for the remote user's password, there are
+another few possible problems to check.
+\begin{itemize}
+\item Either the user's home directory or their \sdirname{.ssh}
+  directory might have excessively liberal permissions.  As a result,
+  the ssh daemon will not trust or read their
+  \sfilename{authorized\_keys} file.  For example, a group-writable
+  home or \sdirname{.ssh} directory will often cause this symptom.
+\item The user's \sfilename{authorized\_keys} file may have a problem.
+  If anyone other than the user owns or can write to that file, the
+  ssh daemon will not trust or read it.
+\end{itemize}
+
+In the ideal world, you should be able to run the following command
+successfully, and it should print exactly one line of output, the
+current date and time.
+\begin{codesample2}
+  ssh myserver date
+\end{codesample2}
+
+If on your server you have login scripts that print banners or other
+junk even when running non-interactive commands like this, you should
+fix them before you continue, so that they only print output if
+they're run interactively.  Otherwise these banners will at least
+clutter up Mercurial's output.  Worse, they could potentially cause
+problems with running Mercurial commands remotely.  (The usual way to
+see if a login script is running in an interactive shell is to check
+the return code from the command \Verb|tty -s|.)
+
+Once you've verified that plain old ssh is working with your server,
+the next step is to ensure that Mercurial runs on the server.  The
+following command should run successfully:
+\begin{codesample2}
+  ssh myserver hg version
+\end{codesample2}
+If you see an error message instead of normal \hgcmd{version} output,
+this is usually because you haven't installed Mercurial to
+\dirname{/usr/bin}.  Don't worry if this is the case; you don't need
+to do that.  But you should check for a few possible problems.
+\begin{itemize}
+\item Is Mercurial really installed on the server at all?  I know this
+  sounds trivial, but it's worth checking!
+\item Maybe your shell's search path (usually set via the \envar{PATH}
+  environment variable) is simply misconfigured.
+\item Perhaps your \envar{PATH} environment variable is only being set
+  to point to the location of the \command{hg} executable if the login
+  session is interactive.  This can happen if you're setting the path
+  in the wrong shell login script.  See your shell's documentation for
+  details.
+\item The \envar{PYTHONPATH} environment variable may need to contain
+  the path to the Mercurial Python modules.  It might not be set at
+  all; it could be incorrect; or it may be set only if the login is
+  interactive.
+\end{itemize}
+
+If you can run \hgcmd{version} over an ssh connection, well done!
+You've got the server and client sorted out.  You should now be able
+to use Mercurial to access repositories hosted by that username on
+that server.  If you run into problems with Mercurial and ssh at this
+point, try using the \hggopt{--debug} option to get a clearer picture
+of what's going on.
+
+\subsubsection{Using compression with ssh}
+
+Mercurial does not compress data when it uses the ssh protocol,
+because the ssh protocol can transparently compress data.  However,
+the default behaviour of ssh clients is \emph{not} to request
+compression.
+
+Over any network other than a fast LAN (even a wireless network),
+using compression is likely to significantly speed up Mercurial's
+network operations.  For example, over a WAN, someone measured
+compression as reducing the amount of time required to clone a
+particularly large repository from~51 minutes to~17 minutes.
+
+Both \command{ssh} and \command{plink} accept a \cmdopt{ssh}{-C}
+option which turns on compression.  You can easily edit your \hgrc\ to
+enable compression for all of Mercurial's uses of the ssh protocol.
+\begin{codesample2}
+  [ui]
+  ssh = ssh -C
+\end{codesample2}
+
+\subsection{Serving over HTTP with a CGI script}
 \label{sec:collab:cgi}
 
 
--- a/en/daily.tex	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/daily.tex	Mon Apr 16 14:23:11 2007 -0700
@@ -41,7 +41,7 @@
 
 What's going on is that in the former case, we explicitly named the
 file to add on the command line, so the assumption that Mercurial
-makes in such cases is that we know what you were doing, and it
+makes in such cases is that you know what you were doing, and it
 doesn't print any output.
 
 However, when we \emph{imply} the names of files by giving the name of
@@ -247,9 +247,11 @@
 
 When you use the \hgcmd{copy} command, Mercurial makes a copy of each
 source file as it currently stands in the working directory.  This
-means that if you make some modifications to a file, then copy it
-without first having committed those changes, the new copy will
-contain your modifications.
+means that if you make some modifications to a file, then \hgcmd{copy}
+it without first having committed those changes, the new copy will
+also contain the modifications you have made up until that point.  (I
+find this behaviour a little counterintuitive, which is why I mention
+it here.)
 
 The \hgcmd{copy} command acts similarly to the Unix \command{cp}
 command (you can use the \hgcmd{cp} alias if you prefer).  The last
@@ -366,6 +368,27 @@
 directory with the same name.  This is documented as~\bug{29}.
 \interaction{issue29.go}
 
+\section{Recovering from mistakes}
+
+Mercurial has some useful commands that will help you to recover from
+some common mistakes.
+
+The \hgcmd{revert} command lets you undo changes that you have made to
+your working directory.  For example, if you \hgcmd{add} a file by
+accident, just run \hgcmd{revert} with the name of the file you added,
+and while the file won't be touched in any way, it won't be tracked
+for adding by Mercurial any longer, either.  You can also use
+\hgcmd{revert} to get rid of erroneous changes to a file.
+
+It's useful to remember that the \hgcmd{revert} command is useful for
+changes that you have not yet committed.  Once you've committed a
+change, if you decide it was a mistake, you can still do something
+about it, though your options may be more limited.
+
+For more information about the \hgcmd{revert} command, and details
+about how to deal with changes you have already committed, see
+chapter~\ref{chap:undo}.
+
 %%% Local Variables: 
 %%% mode: latex
 %%% TeX-master: "00book"
--- a/en/examples/backout	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/examples/backout	Mon Apr 16 14:23:11 2007 -0700
@@ -6,7 +6,7 @@
 export HGMERGE=$(mktemp)
 echo '#!/bin/sh' >> $HGMERGE
 echo 'echo first change > "$1"' >> $HGMERGE
-echo 'echo third change > "$1"' >> $HGMERGE
+echo 'echo third change >> "$1"' >> $HGMERGE
 chmod 700 $HGMERGE
 
 #$ name: init
--- a/en/examples/backout.manual.merge.out	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/examples/backout.manual.merge.out	Mon Apr 16 14:23:11 2007 -0700
@@ -4,4 +4,5 @@
 (branch merge, don't forget to commit)
 $ \textbf{hg commit -m 'merged backout with previous tip'}
 $ \textbf{cat myfile}
+first change
 third change
--- a/en/examples/backout.non-tip.cat.out	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/examples/backout.non-tip.cat.out	Mon Apr 16 14:23:11 2007 -0700
@@ -1,2 +1,3 @@
 $ \textbf{cat myfile}
+first change
 third change
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/en/examples/branching	Mon Apr 16 14:23:11 2007 -0700
@@ -0,0 +1,62 @@
+#!/bin/bash
+
+#$ name: init
+
+hg init main
+cd main
+echo 'This is a boring feature.' > myfile
+hg commit -A -m 'We have reached an important milestone!'
+
+#$ name: tag
+
+hg tag v1.0
+hg tip
+hg tags
+
+#$ name: main
+
+cd ../main
+echo 'This is exciting and new!' >> myfile
+hg commit -m 'Add a new feature'
+cat myfile
+
+#$ name: update
+
+cd ..
+hg clone -U main main-old
+cd main-old
+hg update v1.0
+cat myfile
+
+#$ name: clone
+
+cd ..
+hg clone -rv1.0 main stable
+
+#$ name: stable
+
+hg clone stable stable-fix
+cd stable-fix
+echo 'This is a fix to a boring feature.' > myfile
+hg commit -m 'Fix a bug'
+hg push
+
+#$ name:
+
+export HGMERGE=$(mktemp)
+echo '#!/bin/sh' > $HGMERGE
+echo 'echo "This is a fix to a boring feature." > "$1"' >> $HGMERGE
+echo 'echo "This is exciting and new!" >> "$1"' >> $HGMERGE
+chmod 700 $HGMERGE
+
+#$ name: merge
+
+cd ../main
+hg pull ../stable
+hg merge
+hg commit -m 'Bring in bugfix from stable branch'
+cat myfile
+
+#$ name:
+
+rm $HGMERGE
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/en/examples/branching.clone.out	Mon Apr 16 14:23:11 2007 -0700
@@ -0,0 +1,8 @@
+$ \textbf{cd ..}
+$ \textbf{hg clone -rv1.0 main stable}
+requesting all changes
+adding changesets
+adding manifests
+adding file changes
+added 1 changesets with 1 changes to 1 files
+1 files updated, 0 files merged, 0 files removed, 0 files unresolved
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/en/examples/branching.init.out	Mon Apr 16 14:23:11 2007 -0700
@@ -0,0 +1,5 @@
+$ \textbf{hg init main}
+$ \textbf{cd main}
+$ \textbf{echo 'This is a boring feature.' > myfile}
+$ \textbf{hg commit -A -m 'We have reached an important milestone!'}
+adding myfile
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/en/examples/branching.main.out	Mon Apr 16 14:23:11 2007 -0700
@@ -0,0 +1,6 @@
+$ \textbf{cd ../main}
+$ \textbf{echo 'This is exciting and new!' >> myfile}
+$ \textbf{hg commit -m 'Add a new feature'}
+$ \textbf{cat myfile}
+This is a boring feature.
+This is exciting and new!
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/en/examples/branching.merge.out	Mon Apr 16 14:23:11 2007 -0700
@@ -0,0 +1,17 @@
+$ \textbf{cd ../main}
+$ \textbf{hg pull ../stable}
+pulling from ../stable
+searching for changes
+adding changesets
+adding manifests
+adding file changes
+added 1 changesets with 1 changes to 1 files (+1 heads)
+(run 'hg heads' to see heads, 'hg merge' to merge)
+$ \textbf{hg merge}
+merging myfile
+0 files updated, 1 files merged, 0 files removed, 0 files unresolved
+(branch merge, don't forget to commit)
+$ \textbf{hg commit -m 'Bring in bugfix from stable branch'}
+$ \textbf{cat myfile}
+This is a fix to a boring feature.
+This is exciting and new!
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/en/examples/branching.stable.out	Mon Apr 16 14:23:11 2007 -0700
@@ -0,0 +1,12 @@
+$ \textbf{hg clone stable stable-fix}
+1 files updated, 0 files merged, 0 files removed, 0 files unresolved
+$ \textbf{cd stable-fix}
+$ \textbf{echo 'This is a fix to a boring feature.' > myfile}
+$ \textbf{hg commit -m 'Fix a bug'}
+$ \textbf{hg push}
+pushing to /tmp/branchingfJgZac/stable
+searching for changes
+adding changesets
+adding manifests
+adding file changes
+added 1 changesets with 1 changes to 1 files
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/en/examples/branching.tag.out	Mon Apr 16 14:23:11 2007 -0700
@@ -0,0 +1,11 @@
+$ \textbf{hg tag v1.0}
+$ \textbf{hg tip}
+changeset:   
+tag:         tip
+user:        Bryan O'Sullivan <bos@serpentine.com>
+
+summary:     Added tag v1.0 for changeset 
+
+$ \textbf{hg tags}
+tip                                
+v1.0                               
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/en/examples/branching.update.out	Mon Apr 16 14:23:11 2007 -0700
@@ -0,0 +1,7 @@
+$ \textbf{cd ..}
+$ \textbf{hg clone -U main main-old}
+$ \textbf{cd main-old}
+$ \textbf{hg update v1.0}
+1 files updated, 0 files merged, 0 files removed, 0 files unresolved
+$ \textbf{cat myfile}
+This is a boring feature.
--- a/en/examples/daily.copy	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/examples/daily.copy	Mon Apr 16 14:23:11 2007 -0700
@@ -58,7 +58,9 @@
 
 #$ name: simple
 
-hg copy a c
+mkdir k
+hg copy a k
+ls k
 
 #$ name: dir-dest
 
--- a/en/examples/daily.copy.simple.out	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/examples/daily.copy.simple.out	Mon Apr 16 14:23:11 2007 -0700
@@ -1,2 +1,4 @@
-$ \textbf{hg copy a c}
-c/a: not overwriting - file exists
+$ \textbf{mkdir k}
+$ \textbf{hg copy a k}
+$ \textbf{ls k}
+a
--- a/en/examples/hook.ws	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/examples/hook.ws	Mon Apr 16 14:23:11 2007 -0700
@@ -3,7 +3,7 @@
 hg init a
 cd a
 echo '[hooks]' > .hg/hgrc
-echo "pretxncommit.whitespace = hg export tip | (! grep -qP '^\\+.*[ \\t]$')" >> .hg/hgrc
+echo "pretxncommit.whitespace = hg export tip | (! egrep -q '^\\+.*[ \\t]$')" >> .hg/hgrc
 
 #$ name: simple
 
@@ -24,7 +24,7 @@
 cat .hg/hgrc
 echo 'a ' >> a
 hg commit -A -m 'add new line with trailing whitespace'
-perl -pi -e 's,\s+$,,' a
+sed -i 's, *$,,' a
 hg commit -A -m 'trimmed trailing whitespace'
 
 #$ name:
--- a/en/examples/hook.ws.better.out	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/examples/hook.ws.better.out	Mon Apr 16 14:23:11 2007 -0700
@@ -8,9 +8,9 @@
 abort: pretxncommit.whitespace hook exited with status 1
 transaction abort!
 rollback completed
-$ \textbf{perl -pi -e 's,\textbackslash{}s+$,,' a}
+$ \textbf{sed -i 's, *$,,' a}
 $ \textbf{hg commit -A -m 'trimmed trailing whitespace'}
-a, line 1: trailing whitespace added
+a, line 2: trailing whitespace added
 commit message saved to .hg/commit.save
 abort: pretxncommit.whitespace hook exited with status 1
 transaction abort!
--- a/en/examples/hook.ws.simple.out	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/examples/hook.ws.simple.out	Mon Apr 16 14:23:11 2007 -0700
@@ -1,6 +1,6 @@
 $ \textbf{cat .hg/hgrc}
 [hooks]
-pretxncommit.whitespace = hg export tip | (! grep -qP '^\textbackslash{}+.*[ \textbackslash{}t]$')
+pretxncommit.whitespace = hg export tip | (! egrep -q '^\textbackslash{}+.*[ \textbackslash{}t]$')
 $ \textbf{echo 'a ' > a}
 $ \textbf{hg commit -A -m 'test with trailing whitespace'}
 adding a
--- a/en/examples/mq.tarball	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/examples/mq.tarball	Mon Apr 16 14:23:11 2007 -0700
@@ -2,6 +2,7 @@
 
 cp $EXAMPLE_DIR/data/netplug-*.tar.bz2 .
 ln -s /bin/true download
+export PATH=`pwd`:$PATH
 
 #$ name: download
 
--- a/en/examples/mq.tutorial.qnew2.out	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/examples/mq.tutorial.qnew2.out	Mon Apr 16 14:23:11 2007 -0700
@@ -1,6 +1,6 @@
 $ \textbf{hg qnew second.patch}
 $ \textbf{hg log --style=compact --limit=2}
-2[second.patch,qtip,tip]   
+2[qtip,second.patch,tip]   
   New patch: second.patch
 
 1[first.patch,qbase]   
@@ -9,7 +9,7 @@
 $ \textbf{echo 'line 4' >> file1}
 $ \textbf{hg qrefresh}
 $ \textbf{hg tip --style=compact --patch}
-2[second.patch,qtip,tip]   
+2[qtip,second.patch,tip]   
   patch queue: second.patch
 
 diff -r  -r  file1
--- a/en/examples/run-example	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/examples/run-example	Mon Apr 16 14:23:11 2007 -0700
@@ -46,6 +46,13 @@
             raise
     return False
 
+def find_path_to(program):
+    for p in os.environ.get('PATH', os.defpath).split(os.pathsep):
+        name = os.path.join(p, program)
+        if os.access(name, os.X_OK):
+            return p
+    return None
+        
 class example:
     shell = '/usr/bin/env bash'
     ps1 = '__run_example_ps1__ '
@@ -92,21 +99,22 @@
             
     timeout = 5
 
-    def read(self):
+    def read(self, hint):
         events = self.poll.poll(self.timeout * 1000)
         if not events:
-            print >> sys.stderr, '[timed out after %d seconds]' % self.timeout
+            print >> sys.stderr, ('[%stimed out after %d seconds]' %
+                                  (hint, self.timeout))
             os.kill(self.pid, signal.SIGHUP)
             return ''
         return os.read(self.cfd, 1024)
         
-    def receive(self):
+    def receive(self, hint):
         out = cStringIO.StringIO()
         while True:
             try:
                 if self.verbose:
                     sys.stderr.write('< ')
-                s = self.read()
+                s = self.read(hint)
             except OSError, err:
                 if err.errno == errno.EIO:
                     return '', ''
@@ -120,9 +128,9 @@
             if s.endswith(self.ps2):
                 return self.ps2, s.replace('\r\n', '\n')[:-len(self.ps2)]
         
-    def sendreceive(self, s):
+    def sendreceive(self, s, hint):
         self.send(s)
-        ps, r = self.receive()
+        ps, r = self.receive(hint)
         if r.startswith(s):
             r = r[len(s):]
         return ps, r
@@ -147,6 +155,16 @@
         print >> rcfp, 'PS1="%s"' % self.ps1
         print >> rcfp, 'PS2="%s"' % self.ps2
         print >> rcfp, 'unset HISTFILE'
+        path = ['/usr/bin', '/bin']
+        hg = find_path_to('hg')
+        if hg and hg not in path:
+            path.append(hg)
+        def re_export(envar):
+            v = os.getenv(envar)
+            if v is not None:
+                print >> rcfp, 'export ' + envar + '=' + v
+        print >> rcfp, 'export PATH=' + ':'.join(path)
+        re_export('PYTHONPATH')
         print >> rcfp, 'export EXAMPLE_DIR="%s"' % os.getcwd()
         print >> rcfp, 'export HGMERGE=merge'
         print >> rcfp, 'export LANG=C'
@@ -160,8 +178,8 @@
         sys.stderr.flush()
         self.pid, self.cfd = pty.fork()
         if self.pid == 0:
-            cmdline = ['/usr/bin/env', 'bash', '--noediting', '--noprofile',
-                       '--norc']
+            cmdline = ['/usr/bin/env', '-i', 'bash', '--noediting',
+                       '--noprofile', '--norc']
             try:
                 os.execv(cmdline[0], cmdline)
             except OSError, err:
@@ -188,13 +206,15 @@
             ]
 
         err = False
+        read_hint = ''
 
         try:
             try:
                 # eat first prompt string from shell
-                self.read()
+                self.read(read_hint)
                 # setup env and prompt
-                ps, output = self.sendreceive('source %s\n' % rcfile)
+                ps, output = self.sendreceive('source %s\n' % rcfile,
+                                              read_hint)
                 for hunk in self.parse():
                     # is this line a processing instruction?
                     m = self.pi_re.match(hunk)
@@ -214,6 +234,7 @@
                                 err |= self.rename_output(ofp_basename, ignore)
                             if out:
                                 ofp_basename = '%s.%s' % (self.name, out)
+                                read_hint = ofp_basename + ' '
                                 ofp = open(ofp_basename + '.tmp', 'w')
                             else:
                                 ofp = None
@@ -221,7 +242,7 @@
                             ignore.append(rest)
                     elif hunk.strip():
                         # it's something we should execute
-                        newps, output = self.sendreceive(hunk)
+                        newps, output = self.sendreceive(hunk, read_hint)
                         if not ofp:
                             continue
                         # first, print the command we ran
@@ -243,7 +264,7 @@
                 raise
             else:
                 try:
-                    ps, output = self.sendreceive('exit\n')
+                    ps, output = self.sendreceive('exit\n', read_hint)
                     if ofp is not None:
                         ofp.write(output)
                         ofp.close()
@@ -324,7 +345,9 @@
                 print >> sys.stderr, '%s: not a file, or not executable' % a
                 errs += 1
         return errs
-    for name in os.listdir(path):
+    names = os.listdir(path)
+    names.sort()
+    for name in names:
         if name == 'run-example' or name.startswith('.'): continue
         if name.endswith('.out') or name.endswith('~'): continue
         if name.endswith('.run'): continue
--- a/en/examples/tour	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/examples/tour	Mon Apr 16 14:23:11 2007 -0700
@@ -14,6 +14,7 @@
 
 #$ name: ls
 #$ ignore: ^drwx.*
+#$ ignore: ^total \d+
 
 ls -l
 ls hello
@@ -67,16 +68,6 @@
 #$ name:
 
 export HGEDITOR='echo Added an extra line of output >'
-HGRCPATH_ORIG=$HGRCPATH
-export HGRCPATH=
-
-#$ name: commit-no-user
-
-hg commit
-
-#$ name:
-
-export HGRCPATH=$HGRCPATH_ORIG
 
 #$ name: commit
 
--- a/en/examples/tour.commit-no-user.out	Mon Apr 16 14:22:25 2007 -0700
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,1 +0,0 @@
-$ \textbf{hg commit}
--- a/en/examples/tour.commit.out	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/examples/tour.commit.out	Mon Apr 16 14:23:11 2007 -0700
@@ -1,2 +1,1 @@
 $ \textbf{hg commit}
-nothing changed
--- a/en/examples/tour.incoming.out	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/examples/tour.incoming.out	Mon Apr 16 14:23:11 2007 -0700
@@ -1,5 +1,6 @@
 $ \textbf{cd hello-pull}
 $ \textbf{hg incoming ../my-hello}
+comparing with ../my-hello
 searching for changes
 changeset:   
 tag:         tip
--- a/en/examples/tour.outgoing.net.out	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/examples/tour.outgoing.net.out	Mon Apr 16 14:23:11 2007 -0700
@@ -1,4 +1,5 @@
 $ \textbf{hg outgoing http://hg.serpentine.com/tutorial/hello}
+comparing with http://hg.serpentine.com/tutorial/hello
 searching for changes
 changeset:   
 tag:         tip
--- a/en/examples/tour.outgoing.out	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/examples/tour.outgoing.out	Mon Apr 16 14:23:11 2007 -0700
@@ -1,5 +1,6 @@
 $ \textbf{cd my-hello}
 $ \textbf{hg outgoing ../hello-push}
+comparing with ../hello-push
 searching for changes
 changeset:   
 tag:         tip
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/en/feature-branches.dot	Mon Apr 16 14:23:11 2007 -0700
@@ -0,0 +1,8 @@
+digraph feature_branches {
+	master -> crypto;
+	master -> filesystems;
+	master -> ipc;
+	master -> memory;
+	master -> network;
+	master -> security;
+}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/en/htlatex.book	Mon Apr 16 14:23:11 2007 -0700
@@ -0,0 +1,12 @@
+#!/bin/bash
+#
+# This script is horrible.  It's essentially a hacked copy of
+# /usr/bin/htlatex from Fedora Core 6.  I apologise for any lasting
+# pain reading it causes.
+
+latex $5 '\makeatletter\def\HCode{\futurelet\HCode\HChar}\def\HChar{\ifx"\HCode\def\HCode"##1"{\Link##1}\expandafter\HCode\else\expandafter\Link\fi}\def\Link#1.a.b.c.{\g@addto@macro\@documentclasshook{\RequirePackage[#1,html]{tex4ht}}\let\HCode\documentstyle\def\documentstyle{\let\documentstyle\HCode\expandafter\def\csname tex4ht\endcsname{#1,html}\def\HCode####1{\documentstyle[tex4ht,}\@ifnextchar[{\HCode}{\documentstyle[tex4ht]}}}\makeatother\HCode '$2'.a.b.c.\input ' $1
+(cd $4 && bibtex hgbook)
+(cd $4 && makeindex hgbook)
+latex $5 '\makeatletter\def\HCode{\futurelet\HCode\HChar}\def\HChar{\ifx"\HCode\def\HCode"##1"{\Link##1}\expandafter\HCode\else\expandafter\Link\fi}\def\Link#1.a.b.c.{\g@addto@macro\@documentclasshook{\RequirePackage[#1,html]{tex4ht}}\let\HCode\documentstyle\def\documentstyle{\let\documentstyle\HCode\expandafter\def\csname tex4ht\endcsname{#1,html}\def\HCode####1{\documentstyle[tex4ht,}\@ifnextchar[{\HCode}{\documentstyle[tex4ht]}}}\makeatother\HCode '$2'.a.b.c.\input ' $1
+latex $5 '\makeatletter\def\HCode{\futurelet\HCode\HChar}\def\HChar{\ifx"\HCode\def\HCode"##1"{\Link##1}\expandafter\HCode\else\expandafter\Link\fi}\def\Link#1.a.b.c.{\g@addto@macro\@documentclasshook{\RequirePackage[#1,html]{tex4ht}}\let\HCode\documentstyle\def\documentstyle{\let\documentstyle\HCode\expandafter\def\csname tex4ht\endcsname{#1,html}\def\HCode####1{\documentstyle[tex4ht,}\@ifnextchar[{\HCode}{\documentstyle[tex4ht]}}}\makeatother\HCode '$2'.a.b.c.\input ' $1
+echo status $$
--- a/en/tour-basic.tex	Mon Apr 16 14:22:25 2007 -0700
+++ b/en/tour-basic.tex	Mon Apr 16 14:23:11 2007 -0700
@@ -358,21 +358,41 @@
 
 \subsection{Setting up a username}
 
-When you try to run \hgcmd{commit} for the first time, it may succeed
-immediately, or it may fail with an error message that looks like
-this.
-\interaction{tour.commit-no-user}
-If it succeeds for you, the chances are that either you already have a
-file called \sfilename{.hgrc} in your home directory, or an
-environment variable set named \envar{EMAIL}.
+When you try to run \hgcmd{commit} for the first time, it is not
+guaranteed to succeed.  Mercurial records your name and address with
+each change that you commit, so that you and others will later be able
+to tell who made each change.  Mercurial tries to automatically figure
+out a sensible username to commit the change with.  It will attempt
+each of the following methods, in order:
+\begin{enumerate}
+\item If you specify a \hgopt{commit}{-u} option to the \hgcmd{commit}
+  command on the command line, followed by a username, this is always
+  given the highest precedence.
+\item If you have set the \envar{HGUSER} environment variable, this is
+  checked next.
+\item If you create a file in your home directory called
+  \sfilename{.hgrc}, with a \rcitem{ui}{username} entry, that will be
+  used next.  To see what the contents of this file should look like,
+  refer to section~\ref{sec:tour-basic:username} below.
+\item If you have set the \envar{EMAIL} environment variable, this
+  will be used next.
+\item Mercurial will query your system to find out your local user
+  name and host name, and construct a username from these components.
+  Since this often results in a username that is not very useful, it
+  will print a warning if it has to do this.
+\end{enumerate}
+If all of these mechanisms fail, Mercurial will fail, printing an
+error message.  In this case, it will not let you commit until you set
+up a username.
 
-When you commit, Mercurial wants to know what your name is, so that it
-can record it.  If you have created a \sfilename{.hgrc} file, it will
-look in there.  If it doesn't find something suitable, it will see if
-your \envar{EMAIL} address is set.  If neither of these is present, it
-will produce the error message you can see above.
+You should think of the \envar{HGUSER} environment variable and the
+\hgopt{commit}{-u} option to the \hgcmd{commit} command as ways to
+\emph{override} Mercurial's default selection of username.  For normal
+use, the simplest and most robust way to set a username for yourself
+is by creating a \sfilename{.hgrc} file; see below for details.
 
 \subsubsection{Creating a Mercurial configuration file}
+\label{sec:tour-basic:username}
 
 To set a user name, use your favourite editor to create a file called
 \sfilename{.hgrc} in your home directory.  Mercurial will use this