This is an archive of the discontinued Mercurial Phabricator instance.

Differential D7365

unshelve: correct help string; unshelve does not accept file list
ClosedPublic

Authored by spectral on Nov 8 2019, 5:28 PM.

Details

Reviewers
indygreg
Group Reviewers
hg-reviewers
Commits
rHG8e175a3d64bd: unshelve: correct help string; unshelve does not accept file list
rHGe0dcfdd1731b: unshelve: correct help string; unshelve does not accept file list
Summary

The non-option arguments to hg unshelve are interpreted as the name of the
shelve to unshelve, not the list of files to unshelve. While that functionality
would probably be nice to have, that's well beyond the scope of this
documentation fix.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Revision Contents
Changeset List

PathPackages
Mmercurial/commands.py (8 lines)

Diff 17804

mercurial/commands.py

( (
b'', b'',
b'date', b'date',
b'', b'',
_(b'set date for temporary commits (DEPRECATED)'), _(b'set date for temporary commits (DEPRECATED)'),
_(b'DATE'), _(b'DATE'),
), ),
], ],
_(b'hg unshelve [OPTION]... [FILE]... [-n SHELVED]'), _(b'hg unshelve [OPTION]... [[-n] SHELVED]'),
helpcategory=command.CATEGORY_WORKING_DIRECTORY, helpcategory=command.CATEGORY_WORKING_DIRECTORY,
) )
def unshelve(ui, repo, *shelved, **opts): def unshelve(ui, repo, *shelved, **opts):
"""restore a shelved change to the working directory """restore a shelved change to the working directory
This command accepts an optional name of a shelved change to This command accepts an optional name of a shelved change to
restore. If none is given, the most recent shelved change is used. restore. If none is given, the most recent shelved change is used.
If a shelved change is applied successfully, the bundle that If a shelved change is applied successfully, the bundle that
contains the shelved changes is moved to a backup location contains the shelved changes is moved to a backup location
(.hg/shelve-backup). (.hg/shelve-backup).
Since you can restore a shelved change on top of an arbitrary Since you can restore a shelved change on top of an arbitrary
commit, it is possible that unshelving will result in a conflict commit, it is possible that unshelving will result in a conflict
between your changes and the commits you are unshelving onto. If between your changes and the commits you are unshelving onto. If
this occurs, you must resolve the conflict, then use this occurs, you must resolve the conflict, then use
``--continue`` to complete the unshelve operation. (The bundle ``--continue`` to complete the unshelve operation. (The bundle
will not be moved until you successfully complete the unshelve.) will not be moved until you successfully complete the unshelve.)
(Alternatively, you can use ``--abort`` to abandon an unshelve (Alternatively, you can use ``--abort`` to abandon an unshelve
that causes a conflict. This reverts the unshelved changes, and that causes a conflict. This reverts the unshelved changes, and
leaves the bundle in place.) leaves the bundle in place.)
If bare shelved change (when no files are specified, without interactive, If bare shelved change (without interactive, include and exclude
include and exclude option) was done on newly created branch it would option) was done on newly created branch it would restore branch
restore branch information to the working directory. information to the working directory.
After a successful unshelve, the shelved changes are stored in a After a successful unshelve, the shelved changes are stored in a
backup directory. Only the N most recent backups are kept. N backup directory. Only the N most recent backups are kept. N
defaults to 10 but can be overridden using the ``shelve.maxbackups`` defaults to 10 but can be overridden using the ``shelve.maxbackups``
configuration option. configuration option.
.. container:: verbose .. container:: verbose