Commits

Rafael Villar Burke committed 3ab9931

Reword docstrings for command help

Comments (0)

Files changed (1)

     return cmdutil.commit(ui, repo, shelvefunc, pats, opts)
 
 def shelve(ui, repo, name=None, *pats, **opts):
-    '''saves a patch to the attic from the current changes
-    and removes them from the working copy'''
+    """saves a patch to the attic from the current changes
+    and removes them from the working copy.
+
+    Note that only those changes done in tracked files will be considered
+    so you may wanto to hg add untracked files with desired changes.
+    """
     s = repo.attic
     if opts['interactive']:
         interactiveshelve(ui, repo, name, pats, opts)
             repo.ui.status(_('Patch %s shelved\n' % (s.currentpatch)))
 
 def unshelve(ui, repo, name = None, **opts):
-    """activates a patch from the attic"""
+    """applies a patch from the attic to the working copy"""
     s = repo.attic
     force = opts['force']
     if s.applied and not force:
         unshelve, [
             ('f', 'force', None, _('force patch over existing changes')),
             ('n', 'dry-run', None,
-                _('do not add or remove, just print output')),
+                _('do not mark files as added or removed, and print changes')),
             ('', 'delete', None,
-                _('delete the patch from the attic while unshelving it')),
+                _("don't keep the patch in the attic after applying it")),
             ('s', 'similarity', '',
                 _('guess renamed files by similarity (0<=s<=100)'))],
         _('hg attic-unshelve [-f] [-n] [-s #] [name]'))
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.