archive: add help examples
authorMatt Mackall <mpm@selenic.com>
Fri, 16 Sep 2011 15:31:21 -0500
changeset 15109 f7993be2c32f
parent 15108 4c1ec0fe59d6
child 15110 7ebf60dbfa46
archive: add help examples
mercurial/commands.py
--- a/mercurial/commands.py	Wed Sep 14 22:01:39 2011 -0400
+++ b/mercurial/commands.py	Fri Sep 16 15:31:21 2011 -0500
@@ -307,6 +307,18 @@
     The archive type is automatically detected based on file
     extension (or override using -t/--type).
 
+    .. container:: verbose
+
+      Examples:
+
+      - create a zip file containing the 1.0 release::
+
+          hg archive -r 1.0 project-1.0.zip
+
+      - create a tarball excluding .hg files::
+
+          hg archive project.tar.gz -X ".hg*"
+
     Valid types are:
 
     :``files``: a directory full of files (default)