Add more verbose help text to mq commands.
authorBrendan Cully <brendan@kublai.com>
Tue, 01 Aug 2006 15:24:12 -0700
changeset 2754 19041b8cbc86
parent 2753 84218111e80f
child 2755 6c2c10cedf7a
Add more verbose help text to mq commands.
hgext/mq.py
--- a/hgext/mq.py	Tue Aug 01 15:24:11 2006 -0700
+++ b/hgext/mq.py	Tue Aug 01 15:24:12 2006 -0700
@@ -1184,7 +1184,12 @@
     return 0
 
 def init(ui, repo, **opts):
-    """init a new queue repository"""
+    """init a new queue repository
+
+    The queue repository is unversioned by default. If -c is
+    specified, qinit will create a separate nested repository
+    for patches. Use qcommit to commit changes to this queue
+    repository."""
     q = repo.mq
     r = q.init(repo, create=opts['create_repo'])
     q.save_dirty()
@@ -1269,7 +1274,19 @@
     return 0
 
 def new(ui, repo, patch, **opts):
-    """create a new patch"""
+    """create a new patch
+
+    qnew creates a new patch on top of the currently-applied patch
+    (if any). It will refuse to run if there are any outstanding
+    changes unless -f is specified, in which case the patch will
+    be initialised with them.
+
+    -m or -l set the patch header as well as the commit message.
+    If neither is specified, the patch header is empty and the
+    commit message is 'New patch: PATCH'
+
+    If -f is specified, the patch will be initialized with any
+    uncommitted changes. Otherwise, if there outsta"""
     q = repo.mq
     message=commands.logmessage(**opts)
     q.new(repo, patch, msg=message, force=opts['force'])
@@ -1476,7 +1493,7 @@
     return 0
 
 def version(ui, q=None):
-    """print the version number"""
+    """print the version number of the mq extension"""
     ui.write("mq version %s\n" % versionstr)
     return 0
 
@@ -1546,7 +1563,7 @@
         (new,
          [('m', 'message', '', _('use <text> as commit message')),
           ('l', 'logfile', '', _('read the commit message from <file>')),
-          ('f', 'force', None, 'force')],
+          ('f', 'force', None, _('import uncommitted changes into patch'))],
          'hg qnew [-m TEXT] [-l FILE] [-f] PATCH'),
     "qnext": (next, [], 'hg qnext'),
     "qprev": (prev, [], 'hg qprev'),