[PATCH 3 of 3] Improve documentation for patchbomb and email

[John Goerzen]

# HG changeset patch
# User John Goerzen <jgoerzen at complete.org>
# Date 1174590159 18000
# Node ID 300b64b1aef1c96a191d9e4bd5c0d8e73852a082
# Parent  4a25b21718d95ba251c3d7d0386815b2b8a3683a
Improve documentation for patchbomb and email

diff -r 4a25b21718d9 -r 300b64b1aef1 hgext/patchbomb.py
--- a/hgext/patchbomb.py	Thu Mar 22 13:52:20 2007 -0500
+++ b/hgext/patchbomb.py	Thu Mar 22 14:02:39 2007 -0500
@@ -79,7 +79,7 @@ def patchbomb(ui, repo, *revs, **opts):
 def patchbomb(ui, repo, *revs, **opts):
     '''send changesets as a series of patch emails
 
-    The series starts with a "[PATCH 0 of N]" introduction, which
+    By default, the series starts with a "[PATCH 0 of N]" introduction, which
     describes the series as a whole.
 
     Each patch email has a Subject line of "[PATCH M of N] ...", using
@@ -90,8 +90,32 @@ def patchbomb(ui, repo, *revs, **opts):
     Finally, the patch itself, as generated by "hg export".
 
     With --outgoing, emails will be generated for patches not
-    found in the target repository (or only those which are
+    found in the destination repository (or only those which are
     ancestors of the specified revisions if any are provided)
+
+    With --bundle, changesets are selected as for --outgoing,
+    but a single email containing a binary Mercurial bundle as an
+    attachment will be sent.
+
+    Examples:
+
+    hg email -r 3000          # send patch 3000 only
+    hg email -r 3000 -r 3001  # send patches 3000 and 3001
+    hg email -r 3000:3005     # send patches 3000 through 3005
+    hg email 3000             # send patch 3000 (deprecated)
+
+    hg email -o               # send all patches not in default
+    hg email -o DEST          # send all patches not in DEST
+    hg email -o -r 3000       # send all ancestors of 3000 not in default
+    hg email -o -r 3000 DEST  # send all ancestors of 3000 not in DEST
+
+    hg email -b               # send bundle of all patches not in default
+    hg email -b DEST          # send bundle of all patches not in DEST
+    hg email -b -r 3000       # bundle of all ancestors of 3000 not in default
+    hg email -b -r 3000 DEST  # bundle of all ancestors of 3000 not in DEST
+
+    Before using this command, you will need to enable email in your hgrc.
+    See hgrc(5) for details.
     '''
 
     def prompt(prompt, default = None, rest = ': ', empty_ok = False):