commands: revised documentation of 'default' and 'default-push' stable
authorFaheem Mitha <faheem@email.unc.edu>
Tue, 27 Apr 2010 00:44:06 +0530
branchstable
changeset 11007 a0102da324ab
parent 10990 bb377a311109
child 11008 af2a58ab4182
child 11010 18e81d42ee5c
commands: revised documentation of 'default' and 'default-push' This patch was a collaborative effort between faheem, mg, timeless and ilowe.
mercurial/commands.py
--- a/mercurial/commands.py	Mon Apr 26 14:40:34 2010 +0200
+++ b/mercurial/commands.py	Tue Apr 27 00:44:06 2010 +0530
@@ -2349,10 +2349,16 @@
     Path names are defined in the [paths] section of /etc/mercurial/hgrc
     and $HOME/.hgrc. If run inside a repository, .hg/hgrc is used, too.
 
-    The names 'default' and 'default-push' have a special meaning.
-    They are the locations used when pulling and pushing respectively
-    unless a location is specified. When cloning a repository, the
-    clone source is written as 'default' in .hg/hgrc.
+    The path names ``default`` and ``default-push`` have a special
+    meaning.  When performing a push or pull operation, they are used
+    as fallbacks if no location is specified on the command-line.
+    When ``default-push`` is set, it will be used for push and
+    ``default`` will be used for pull; otherwise ``default`` is used
+    as the fallback for both.  When cloning a repository, the clone
+    source is written as ``default`` in ``.hg/hgrc``.  Note that
+    ``default`` and ``default-push`` apply to all inbound (e.g. ``hg
+    incoming``) and outbound (e.g. ``hg outgoing``, ``hg email`` and
+    ``hg bundle``) operations.
 
     See 'hg help urls' for more information.
     """