74
75
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
77
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
78
78
def tree_files(file_list, default_branch=u'.', canonicalize=True,
80
return internal_tree_files(file_list, default_branch, canonicalize,
81
return internal_tree_files(file_list, default_branch, canonicalize,
83
except errors.FileInWrongBranch, e:
84
raise errors.BzrCommandError("%s is not in the same branch as %s" %
85
(e.path, file_list[0]))
84
88
def tree_files_for_add(file_list):
149
153
# XXX: Bad function name; should possibly also be a class method of
150
154
# WorkingTree rather than a function.
151
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
152
155
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
153
156
apply_view=True):
154
157
"""Convert command-line paths to a WorkingTree and relative paths.
156
Deprecated: use WorkingTree.open_containing_paths instead.
158
159
This is typically used for command-line processors that take one or
159
160
more filenames, and infer the workingtree that contains them.
171
172
:return: workingtree, [relative_paths]
173
return WorkingTree.open_containing_paths(
174
file_list, default_directory='.',
174
if file_list is None or len(file_list) == 0:
175
tree = WorkingTree.open_containing(default_branch)[0]
176
if tree.supports_views() and apply_view:
177
view_files = tree.views.lookup_view()
179
file_list = view_files
180
view_str = views.view_display_str(view_files)
181
note("Ignoring files outside view. View is %s" % view_str)
182
return tree, file_list
183
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
184
return tree, safe_relpath_files(tree, file_list, canonicalize,
185
apply_view=apply_view)
188
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
189
"""Convert file_list into a list of relpaths in tree.
191
:param tree: A tree to operate on.
192
:param file_list: A list of user provided paths or None.
193
:param apply_view: if True and a view is set, apply it or check that
194
specified files are within it
195
:return: A list of relative paths.
196
:raises errors.PathNotChild: When a provided path is in a different tree
199
if file_list is None:
201
if tree.supports_views() and apply_view:
202
view_files = tree.views.lookup_view()
206
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
207
# doesn't - fix that up here before we enter the loop.
209
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
212
for filename in file_list:
214
relpath = fixer(osutils.dereference_path(filename))
215
if view_files and not osutils.is_inside_any(view_files, relpath):
216
raise errors.FileOutsideView(filename, view_files)
217
new_list.append(relpath)
218
except errors.PathNotChild:
219
raise errors.FileInWrongBranch(tree.branch, filename)
179
223
def _get_view_info_for_change_reporter(tree):
191
def _open_directory_or_containing_tree_or_branch(filename, directory):
192
"""Open the tree or branch containing the specified file, unless
193
the --directory option is used to specify a different branch."""
194
if directory is not None:
195
return (None, Branch.open(directory), filename)
196
return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
199
235
# TODO: Make sure no commands unconditionally use the working directory as a
200
236
# branch. If a filename argument is used, the first of them should be used to
201
237
# specify the branch. (Perhaps this can be factored out into some kind of
250
286
To skip the display of pending merge information altogether, use
251
287
the no-pending option or specify a file/directory.
253
To compare the working directory to a specific revision, pass a
254
single revision to the revision argument.
256
To see which files have changed in a specific revision, or between
257
two revisions, pass a revision range to the revision argument.
258
This will produce the same results as calling 'bzr diff --summarize'.
289
If a revision argument is given, the status is calculated against
290
that revision, or between two revisions if two are provided.
261
293
# TODO: --no-recurse, --recurse options
321
353
self.outf.write(revtext.decode('utf-8'))
324
def run(self, revision_id=None, revision=None, directory=u'.'):
356
def run(self, revision_id=None, revision=None):
325
357
if revision_id is not None and revision is not None:
326
358
raise errors.BzrCommandError('You can only supply one of'
327
359
' revision_id or --revision')
328
360
if revision_id is None and revision is None:
329
361
raise errors.BzrCommandError('You must supply either'
330
362
' --revision or a revision_id')
332
b = bzrdir.BzrDir.open_containing_tree_or_branch(directory)[1]
363
b = WorkingTree.open_containing(u'.')[0].branch
334
365
revisions = b.repository.revisions
335
366
if revisions is None:
485
511
d.destroy_workingtree()
488
class cmd_repair_workingtree(Command):
489
__doc__ = """Reset the working tree state file.
491
This is not meant to be used normally, but more as a way to recover from
492
filesystem corruption, etc. This rebuilds the working inventory back to a
493
'known good' state. Any new modifications (adding a file, renaming, etc)
494
will be lost, though modified files will still be detected as such.
496
Most users will want something more like "bzr revert" or "bzr update"
497
unless the state file has become corrupted.
499
By default this attempts to recover the current state by looking at the
500
headers of the state file. If the state file is too corrupted to even do
501
that, you can supply --revision to force the state of the tree.
504
takes_options = ['revision', 'directory',
506
help='Reset the tree even if it doesn\'t appear to be'
511
def run(self, revision=None, directory='.', force=False):
512
tree, _ = WorkingTree.open_containing(directory)
513
self.add_cleanup(tree.lock_tree_write().unlock)
517
except errors.BzrError:
518
pass # There seems to be a real error here, so we'll reset
521
raise errors.BzrCommandError(
522
'The tree does not appear to be corrupt. You probably'
523
' want "bzr revert" instead. Use "--force" if you are'
524
' sure you want to reset the working tree.')
528
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
530
tree.reset_state(revision_ids)
531
except errors.BzrError, e:
532
if revision_ids is None:
533
extra = (', the header appears corrupt, try passing -r -1'
534
' to set the state to the last commit')
537
raise errors.BzrCommandError('failed to reset the tree state'
541
514
class cmd_revno(Command):
542
515
__doc__ = """Show current revision number.
778
759
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
780
761
revision = _get_one_revision('inventory', revision)
781
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
782
self.add_cleanup(work_tree.lock_read().unlock)
762
work_tree, file_list = tree_files(file_list)
763
work_tree.lock_read()
764
self.add_cleanup(work_tree.unlock)
783
765
if revision is not None:
784
766
tree = revision.as_tree(work_tree.branch)
786
768
extra_trees = [work_tree]
787
self.add_cleanup(tree.lock_read().unlock)
770
self.add_cleanup(tree.unlock)
850
833
if len(names_list) < 2:
851
834
raise errors.BzrCommandError("missing file argument")
852
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
853
self.add_cleanup(tree.lock_tree_write().unlock)
835
tree, rel_names = tree_files(names_list, canonicalize=False)
836
tree.lock_tree_write()
837
self.add_cleanup(tree.unlock)
854
838
self._run(tree, names_list, rel_names, after)
856
840
def run_auto(self, names_list, after, dry_run):
861
845
raise errors.BzrCommandError('--after cannot be specified with'
863
work_tree, file_list = WorkingTree.open_containing_paths(
864
names_list, default_directory='.')
865
self.add_cleanup(work_tree.lock_tree_write().unlock)
847
work_tree, file_list = tree_files(names_list, default_branch='.')
848
work_tree.lock_tree_write()
849
self.add_cleanup(work_tree.unlock)
866
850
rename_map.RenameMap.guess_renames(work_tree, dry_run)
868
852
def _run(self, tree, names_list, rel_names, after):
976
960
takes_options = ['remember', 'overwrite', 'revision',
977
961
custom_help('verbose',
978
962
help='Show logs of pulled revisions.'),
979
custom_help('directory',
980
964
help='Branch to pull into, '
981
'rather than the one containing the working directory.'),
965
'rather than the one containing the working directory.',
983
970
help="Perform a local pull in a bound "
984
971
"branch. Local pulls are not applied to "
985
972
"the master branch."
988
help="Show base revision text in conflicts.")
990
975
takes_args = ['location?']
991
976
encoding_type = 'replace'
993
978
def run(self, location=None, remember=False, overwrite=False,
994
979
revision=None, verbose=False,
995
directory=None, local=False,
980
directory=None, local=False):
997
981
# FIXME: too much stuff is in the command class
998
982
revision_id = None
1003
987
tree_to = WorkingTree.open_containing(directory)[0]
1004
988
branch_to = tree_to.branch
1005
self.add_cleanup(tree_to.lock_write().unlock)
990
self.add_cleanup(tree_to.unlock)
1006
991
except errors.NoWorkingTree:
1008
993
branch_to = Branch.open_containing(directory)[0]
1009
self.add_cleanup(branch_to.lock_write().unlock)
1011
if tree_to is None and show_base:
1012
raise errors.BzrCommandError("Need working tree for --show-base.")
994
branch_to.lock_write()
995
self.add_cleanup(branch_to.unlock)
1014
997
if local and not branch_to.get_bound_location():
1015
998
raise errors.LocalRequiresBoundBranch()
1109
1088
Option('create-prefix',
1110
1089
help='Create the path leading up to the branch '
1111
1090
'if it does not already exist.'),
1112
custom_help('directory',
1113
1092
help='Branch to push from, '
1114
'rather than the one containing the working directory.'),
1093
'rather than the one containing the working directory.',
1115
1097
Option('use-existing-dir',
1116
1098
help='By default push will fail if the target'
1117
1099
' directory exists, but does not already'
1138
1117
def run(self, location=None, remember=False, overwrite=False,
1139
1118
create_prefix=False, verbose=False, revision=None,
1140
1119
use_existing_dir=False, directory=None, stacked_on=None,
1141
stacked=False, strict=None, no_tree=False):
1120
stacked=False, strict=None):
1142
1121
from bzrlib.push import _show_push_branch
1144
1123
if directory is None:
1190
1169
_show_push_branch(br_from, revision_id, location, self.outf,
1191
1170
verbose=verbose, overwrite=overwrite, remember=remember,
1192
1171
stacked_on=stacked_on, create_prefix=create_prefix,
1193
use_existing_dir=use_existing_dir, no_tree=no_tree)
1172
use_existing_dir=use_existing_dir)
1196
1175
class cmd_branch(Command):
1206
1185
To retrieve the branch as of a particular revision, supply the --revision
1207
1186
parameter, as in "branch foo/bar -r 5".
1209
The synonyms 'clone' and 'get' for this command are deprecated.
1212
1189
_see_also = ['checkout']
1213
1190
takes_args = ['from_location', 'to_location?']
1214
takes_options = ['revision',
1215
Option('hardlink', help='Hard-link working tree files where possible.'),
1216
Option('files-from', type=str,
1217
help="Get file contents from this tree."),
1191
takes_options = ['revision', Option('hardlink',
1192
help='Hard-link working tree files where possible.'),
1218
1193
Option('no-tree',
1219
1194
help="Create a branch without a working-tree."),
1220
1195
Option('switch',
1239
1214
def run(self, from_location, to_location=None, revision=None,
1240
1215
hardlink=False, stacked=False, standalone=False, no_tree=False,
1241
use_existing_dir=False, switch=False, bind=False,
1216
use_existing_dir=False, switch=False, bind=False):
1243
1217
from bzrlib import switch as _mod_switch
1244
1218
from bzrlib.tag import _merge_tags_if_possible
1245
if self.invoked_as in ['get', 'clone']:
1246
ui.ui_factory.show_user_warning(
1247
'deprecated_command',
1248
deprecated_name=self.invoked_as,
1249
recommended_name='branch',
1250
deprecated_in_version='2.4')
1251
1219
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1253
if not (hardlink or files_from):
1254
# accelerator_tree is usually slower because you have to read N
1255
# files (no readahead, lots of seeks, etc), but allow the user to
1256
# explicitly request it
1257
accelerator_tree = None
1258
if files_from is not None and files_from != from_location:
1259
accelerator_tree = WorkingTree.open(files_from)
1260
1221
revision = _get_one_revision('branch', revision)
1261
self.add_cleanup(br_from.lock_read().unlock)
1223
self.add_cleanup(br_from.unlock)
1262
1224
if revision is not None:
1263
1225
revision_id = revision.as_revision_id(br_from)
1369
1331
to_location = branch_location
1370
1332
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1371
1333
branch_location)
1372
if not (hardlink or files_from):
1373
# accelerator_tree is usually slower because you have to read N
1374
# files (no readahead, lots of seeks, etc), but allow the user to
1375
# explicitly request it
1376
accelerator_tree = None
1377
1334
revision = _get_one_revision('checkout', revision)
1378
if files_from is not None and files_from != branch_location:
1335
if files_from is not None:
1379
1336
accelerator_tree = WorkingTree.open(files_from)
1380
1337
if revision is not None:
1381
1338
revision_id = revision.as_revision_id(source)
1437
1396
If you want to discard your local changes, you can just do a
1438
1397
'bzr revert' instead of 'bzr commit' after the update.
1440
If you want to restore a file that has been removed locally, use
1441
'bzr revert' instead of 'bzr update'.
1443
1399
If the tree's branch is bound to a master branch, it will also update
1444
1400
the branch from the master.
1447
1403
_see_also = ['pull', 'working-trees', 'status-flags']
1448
1404
takes_args = ['dir?']
1449
takes_options = ['revision',
1451
help="Show base revision text in conflicts."),
1405
takes_options = ['revision']
1453
1406
aliases = ['up']
1455
def run(self, dir='.', revision=None, show_base=None):
1408
def run(self, dir='.', revision=None):
1456
1409
if revision is not None and len(revision) != 1:
1457
1410
raise errors.BzrCommandError(
1458
1411
"bzr update --revision takes exactly one revision")
1567
1519
class cmd_remove(Command):
1568
1520
__doc__ = """Remove files or directories.
1570
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1571
delete them if they can easily be recovered using revert otherwise they
1572
will be backed up (adding an extention of the form .~#~). If no options or
1573
parameters are given Bazaar will scan for files that are being tracked by
1574
Bazaar but missing in your tree and stop tracking them for you.
1522
This makes bzr stop tracking changes to the specified files. bzr will delete
1523
them if they can easily be recovered using revert. If no options or
1524
parameters are given bzr will scan for files that are being tracked by bzr
1525
but missing in your tree and stop tracking them for you.
1576
1527
takes_args = ['file*']
1577
1528
takes_options = ['verbose',
1579
1530
RegistryOption.from_kwargs('file-deletion-strategy',
1580
1531
'The file deletion mode to be used.',
1581
1532
title='Deletion Strategy', value_switches=True, enum_switch=False,
1582
safe='Backup changed files (default).',
1533
safe='Only delete files if they can be'
1534
' safely recovered (default).',
1583
1535
keep='Delete from bzr but leave the working copy.',
1584
no_backup='Don\'t backup changed files.',
1585
1536
force='Delete all the specified files, even if they can not be '
1586
'recovered and even if they are non-empty directories. '
1587
'(deprecated, use no-backup)')]
1537
'recovered and even if they are non-empty directories.')]
1588
1538
aliases = ['rm', 'del']
1589
1539
encoding_type = 'replace'
1591
1541
def run(self, file_list, verbose=False, new=False,
1592
1542
file_deletion_strategy='safe'):
1593
if file_deletion_strategy == 'force':
1594
note("(The --force option is deprecated, rather use --no-backup "
1596
file_deletion_strategy = 'no-backup'
1598
tree, file_list = WorkingTree.open_containing_paths(file_list)
1543
tree, file_list = tree_files(file_list)
1600
1545
if file_list is not None:
1601
1546
file_list = [f for f in file_list]
1603
self.add_cleanup(tree.lock_write().unlock)
1549
self.add_cleanup(tree.unlock)
1604
1550
# Heuristics should probably all move into tree.remove_smart or
1690
1636
_see_also = ['check']
1691
1637
takes_args = ['branch?']
1693
Option('canonicalize-chks',
1694
help='Make sure CHKs are in canonical form (repairs '
1699
def run(self, branch=".", canonicalize_chks=False):
1639
def run(self, branch="."):
1700
1640
from bzrlib.reconcile import reconcile
1701
1641
dir = bzrdir.BzrDir.open(branch)
1702
reconcile(dir, canonicalize_chks=canonicalize_chks)
1705
1645
class cmd_revision_history(Command):
1783
1723
Option('append-revisions-only',
1784
1724
help='Never change revnos or the existing log.'
1785
' Append revisions to it only.'),
1787
'Create a branch without a working tree.')
1725
' Append revisions to it only.')
1789
1727
def run(self, location=None, format=None, append_revisions_only=False,
1790
create_prefix=False, no_tree=False):
1728
create_prefix=False):
1791
1729
if format is None:
1792
1730
format = bzrdir.format_registry.make_bzrdir('default')
1793
1731
if location is None:
2070
1985
old_branch, new_branch,
2071
1986
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2072
1987
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2073
# GNU diff on Windows uses ANSI encoding for filenames
2074
path_encoding = osutils.get_diff_header_encoding()
2075
1988
return show_diff_trees(old_tree, new_tree, sys.stdout,
2076
1989
specific_files=specific_files,
2077
1990
external_diff_options=diff_options,
2078
1991
old_label=old_label, new_label=new_label,
2079
extra_trees=extra_trees,
2080
path_encoding=path_encoding,
1992
extra_trees=extra_trees, using=using,
2082
1993
format_cls=format)
2092
2003
# level of effort but possibly much less IO. (Or possibly not,
2093
2004
# if the directories are very large...)
2094
2005
_see_also = ['status', 'ls']
2095
takes_options = ['directory', 'show-ids']
2006
takes_options = ['show-ids']
2097
2008
@display_command
2098
def run(self, show_ids=False, directory=u'.'):
2099
tree = WorkingTree.open_containing(directory)[0]
2100
self.add_cleanup(tree.lock_read().unlock)
2009
def run(self, show_ids=False):
2010
tree = WorkingTree.open_containing(u'.')[0]
2012
self.add_cleanup(tree.unlock)
2101
2013
old = tree.basis_tree()
2102
self.add_cleanup(old.lock_read().unlock)
2015
self.add_cleanup(old.unlock)
2103
2016
for path, ie in old.inventory.iter_entries():
2104
2017
if not tree.has_id(ie.file_id):
2105
2018
self.outf.write(path)
2117
2030
_see_also = ['status', 'ls']
2118
takes_options = ['directory', 'null']
2033
help='Write an ascii NUL (\\0) separator '
2034
'between files rather than a newline.')
2120
2037
@display_command
2121
def run(self, null=False, directory=u'.'):
2122
tree = WorkingTree.open_containing(directory)[0]
2123
self.add_cleanup(tree.lock_read().unlock)
2038
def run(self, null=False):
2039
tree = WorkingTree.open_containing(u'.')[0]
2124
2040
td = tree.changes_from(tree.basis_tree())
2126
2041
for path, id, kind, text_modified, meta_modified in td.modified:
2128
2043
self.outf.write(path + '\0')
2138
2053
_see_also = ['status', 'ls']
2139
takes_options = ['directory', 'null']
2056
help='Write an ascii NUL (\\0) separator '
2057
'between files rather than a newline.')
2141
2060
@display_command
2142
def run(self, null=False, directory=u'.'):
2143
wt = WorkingTree.open_containing(directory)[0]
2144
self.add_cleanup(wt.lock_read().unlock)
2061
def run(self, null=False):
2062
wt = WorkingTree.open_containing(u'.')[0]
2064
self.add_cleanup(wt.unlock)
2145
2065
basis = wt.basis_tree()
2146
self.add_cleanup(basis.lock_read().unlock)
2067
self.add_cleanup(basis.unlock)
2147
2068
basis_inv = basis.inventory
2148
2069
inv = wt.inventory
2149
2070
for file_id in inv:
2611
2528
help='Recurse into subdirectories.'),
2612
2529
Option('from-root',
2613
2530
help='Print paths relative to the root of the branch.'),
2614
Option('unknown', short_name='u',
2615
help='Print unknown files.'),
2531
Option('unknown', help='Print unknown files.'),
2616
2532
Option('versioned', help='Print versioned files.',
2617
2533
short_name='V'),
2618
Option('ignored', short_name='i',
2619
help='Print ignored files.'),
2620
Option('kind', short_name='k',
2534
Option('ignored', help='Print ignored files.'),
2536
help='Write an ascii NUL (\\0) separator '
2537
'between files rather than a newline.'),
2621
2539
help='List entries of a particular kind: file, directory, symlink.',
2627
2543
@display_command
2628
2544
def run(self, revision=None, verbose=False,
2629
2545
recursive=False, from_root=False,
2630
2546
unknown=False, versioned=False, ignored=False,
2631
null=False, kind=None, show_ids=False, path=None, directory=None):
2547
null=False, kind=None, show_ids=False, path=None):
2633
2549
if kind and kind not in ('file', 'directory', 'symlink'):
2634
2550
raise errors.BzrCommandError('invalid kind specified')
2806
2713
_see_also = ['status', 'ignored', 'patterns']
2807
2714
takes_args = ['name_pattern*']
2808
takes_options = ['directory',
2809
2716
Option('default-rules',
2810
2717
help='Display the default ignore rules that bzr uses.')
2813
def run(self, name_pattern_list=None, default_rules=None,
2720
def run(self, name_pattern_list=None, default_rules=None):
2815
2721
from bzrlib import ignores
2816
2722
if default_rules is not None:
2817
2723
# dump the default rules and exit
2823
2729
"NAME_PATTERN or --default-rules.")
2824
2730
name_pattern_list = [globbing.normalize_pattern(p)
2825
2731
for p in name_pattern_list]
2827
for p in name_pattern_list:
2828
if not globbing.Globster.is_pattern_valid(p):
2829
bad_patterns += ('\n %s' % p)
2831
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2832
ui.ui_factory.show_error(msg)
2833
raise errors.InvalidPattern('')
2834
2732
for name_pattern in name_pattern_list:
2835
2733
if (name_pattern[0] == '/' or
2836
2734
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2837
2735
raise errors.BzrCommandError(
2838
2736
"NAME_PATTERN should not be an absolute path")
2839
tree, relpath = WorkingTree.open_containing(directory)
2737
tree, relpath = WorkingTree.open_containing(u'.')
2840
2738
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2841
2739
ignored = globbing.Globster(name_pattern_list)
2843
self.add_cleanup(tree.lock_read().unlock)
2844
2742
for entry in tree.list_files():
2846
2744
if id is not None:
2847
2745
filename = entry[0]
2848
2746
if ignored.match(filename):
2849
2747
matches.append(filename)
2850
2749
if len(matches) > 0:
2851
2750
self.outf.write("Warning: the following files are version controlled and"
2852
2751
" match your ignore pattern:\n%s"
2868
2767
encoding_type = 'replace'
2869
2768
_see_also = ['ignore', 'ls']
2870
takes_options = ['directory']
2872
2770
@display_command
2873
def run(self, directory=u'.'):
2874
tree = WorkingTree.open_containing(directory)[0]
2875
self.add_cleanup(tree.lock_read().unlock)
2772
tree = WorkingTree.open_containing(u'.')[0]
2774
self.add_cleanup(tree.unlock)
2876
2775
for path, file_class, kind, file_id, entry in tree.list_files():
2877
2776
if file_class != 'I':
2947
2844
'revision in which it was changed.'),
2949
2846
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2950
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2847
root=None, filters=False, per_file_timestamps=False):
2951
2848
from bzrlib.export import export
2953
2850
if branch_or_subdir is None:
2954
tree = WorkingTree.open_containing(directory)[0]
2851
tree = WorkingTree.open_containing(u'.')[0]
2955
2852
b = tree.branch
2988
2885
@display_command
2989
2886
def run(self, filename, revision=None, name_from_revision=False,
2990
filters=False, directory=None):
2991
2888
if revision is not None and len(revision) != 1:
2992
2889
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2993
2890
" one revision specifier")
2994
2891
tree, branch, relpath = \
2995
_open_directory_or_containing_tree_or_branch(filename, directory)
2996
self.add_cleanup(branch.lock_read().unlock)
2892
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2894
self.add_cleanup(branch.unlock)
2997
2895
return self._run(tree, branch, relpath, filename, revision,
2998
2896
name_from_revision, filters)
3114
3013
to trigger updates to external systems like bug trackers. The --fixes
3115
3014
option can be used to record the association between a revision and
3116
3015
one or more bugs. See ``bzr help bugs`` for details.
3017
A selective commit may fail in some cases where the committed
3018
tree would be invalid. Consider::
3023
bzr commit foo -m "committing foo"
3024
bzr mv foo/bar foo/baz
3027
bzr commit foo/bar -m "committing bar but not baz"
3029
In the example above, the last commit will fail by design. This gives
3030
the user the opportunity to decide whether they want to commit the
3031
rename at the same time, separately first, or not at all. (As a general
3032
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3034
# TODO: Run hooks on tree to-be-committed, and after commit.
3036
# TODO: Strict commit that fails if there are deleted files.
3037
# (what does "deleted files" mean ??)
3039
# TODO: Give better message for -s, --summary, used by tla people
3041
# XXX: verbose currently does nothing
3119
3043
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3120
3044
takes_args = ['selected*']
3181
3101
def run(self, message=None, file=None, verbose=False, selected_list=None,
3182
3102
unchanged=False, strict=False, local=False, fixes=None,
3183
author=None, show_diff=False, exclude=None, commit_time=None,
3103
author=None, show_diff=False, exclude=None, commit_time=None):
3185
3104
from bzrlib.errors import (
3186
3105
PointlessCommit,
3187
3106
ConflictsInTree,
3201
3120
raise errors.BzrCommandError(
3202
3121
"Could not parse --commit-time: " + str(e))
3123
# TODO: Need a blackbox test for invoking the external editor; may be
3124
# slightly problematic to run this cross-platform.
3126
# TODO: do more checks that the commit will succeed before
3127
# spending the user's valuable time typing a commit message.
3204
3129
properties = {}
3206
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3131
tree, selected_list = tree_files(selected_list)
3207
3132
if selected_list == ['']:
3208
3133
# workaround - commit of root of tree should be exactly the same
3209
3134
# as just default commit in that tree, and succeed even though
3283
3205
reporter=None, verbose=verbose, revprops=properties,
3284
3206
authors=author, timestamp=commit_stamp,
3285
3207
timezone=offset,
3286
exclude=tree.safe_relpath_files(exclude),
3208
exclude=safe_relpath_files(tree, exclude))
3288
3209
except PointlessCommit:
3289
3210
raise errors.BzrCommandError("No changes to commit."
3290
" Please 'bzr add' the files you want to commit, or use"
3291
" --unchanged to force an empty commit.")
3211
" Use --unchanged to commit anyhow.")
3292
3212
except ConflictsInTree:
3293
3213
raise errors.BzrCommandError('Conflicts detected in working '
3294
3214
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3377
3297
class cmd_upgrade(Command):
3378
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3380
When the default format has changed after a major new release of
3381
Bazaar, you may be informed during certain operations that you
3382
should upgrade. Upgrading to a newer format may improve performance
3383
or make new features available. It may however limit interoperability
3384
with older repositories or with older versions of Bazaar.
3386
If you wish to upgrade to a particular format rather than the
3387
current default, that can be specified using the --format option.
3388
As a consequence, you can use the upgrade command this way to
3389
"downgrade" to an earlier format, though some conversions are
3390
a one way process (e.g. changing from the 1.x default to the
3391
2.x default) so downgrading is not always possible.
3393
A backup.bzr.~#~ directory is created at the start of the conversion
3394
process (where # is a number). By default, this is left there on
3395
completion. If the conversion fails, delete the new .bzr directory
3396
and rename this one back in its place. Use the --clean option to ask
3397
for the backup.bzr directory to be removed on successful conversion.
3398
Alternatively, you can delete it by hand if everything looks good
3401
If the location given is a shared repository, dependent branches
3402
are also converted provided the repository converts successfully.
3403
If the conversion of a branch fails, remaining branches are still
3406
For more information on upgrades, see the Bazaar Upgrade Guide,
3407
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3298
__doc__ = """Upgrade branch storage to current format.
3300
The check command or bzr developers may sometimes advise you to run
3301
this command. When the default format has changed you may also be warned
3302
during other operations to upgrade.
3410
_see_also = ['check', 'reconcile', 'formats']
3305
_see_also = ['check']
3411
3306
takes_args = ['url?']
3412
3307
takes_options = [
3413
RegistryOption('format',
3414
help='Upgrade to a specific format. See "bzr help'
3415
' formats" for details.',
3416
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3417
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3418
value_switches=True, title='Branch format'),
3420
help='Remove the backup.bzr directory if successful.'),
3422
help="Show what would be done, but don't actually do anything."),
3308
RegistryOption('format',
3309
help='Upgrade to a specific format. See "bzr help'
3310
' formats" for details.',
3311
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3312
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3313
value_switches=True, title='Branch format'),
3425
def run(self, url='.', format=None, clean=False, dry_run=False):
3316
def run(self, url='.', format=None):
3426
3317
from bzrlib.upgrade import upgrade
3427
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3429
if len(exceptions) == 1:
3430
# Compatibility with historical behavior
3318
upgrade(url, format)
3436
3321
class cmd_whoami(Command):
3456
3340
encoding_type = 'replace'
3458
3342
@display_command
3459
def run(self, email=False, branch=False, name=None, directory=None):
3343
def run(self, email=False, branch=False, name=None):
3460
3344
if name is None:
3461
if directory is None:
3462
# use branch if we're inside one; otherwise global config
3464
c = Branch.open_containing(u'.')[0].get_config()
3465
except errors.NotBranchError:
3466
c = _mod_config.GlobalConfig()
3468
c = Branch.open(directory).get_config()
3345
# use branch if we're inside one; otherwise global config
3347
c = Branch.open_containing('.')[0].get_config()
3348
except errors.NotBranchError:
3349
c = config.GlobalConfig()
3470
3351
self.outf.write(c.user_email() + '\n')
3472
3353
self.outf.write(c.username() + '\n')
3476
raise errors.BzrCommandError("--email can only be used to display existing "
3479
3356
# display a warning if an email address isn't included in the given name.
3481
_mod_config.extract_email_address(name)
3358
config.extract_email_address(name)
3482
3359
except errors.NoEmailInUsername, e:
3483
3360
warning('"%s" does not seem to contain an email address. '
3484
3361
'This is allowed, but not recommended.', name)
3486
3363
# use global config unless --branch given
3488
if directory is None:
3489
c = Branch.open_containing(u'.')[0].get_config()
3491
c = Branch.open(directory).get_config()
3365
c = Branch.open_containing('.')[0].get_config()
3493
c = _mod_config.GlobalConfig()
3367
c = config.GlobalConfig()
3494
3368
c.set_user_option('email', name)
3563
3436
'bzr alias --remove expects an alias to remove.')
3564
3437
# If alias is not found, print something like:
3565
3438
# unalias: foo: not found
3566
c = _mod_config.GlobalConfig()
3439
c = config.GlobalConfig()
3567
3440
c.unset_alias(alias_name)
3569
3442
@display_command
3570
3443
def print_aliases(self):
3571
3444
"""Print out the defined aliases in a similar format to bash."""
3572
aliases = _mod_config.GlobalConfig().get_aliases()
3445
aliases = config.GlobalConfig().get_aliases()
3573
3446
for key, value in sorted(aliases.iteritems()):
3574
3447
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3667
3537
'throughout the test suite.',
3668
3538
type=get_transport_type),
3669
3539
Option('benchmark',
3670
help='Run the benchmarks rather than selftests.',
3540
help='Run the benchmarks rather than selftests.'),
3672
3541
Option('lsprof-timed',
3673
3542
help='Generate lsprof output for benchmarked'
3674
3543
' sections of code.'),
3675
3544
Option('lsprof-tests',
3676
3545
help='Generate lsprof output for each test.'),
3546
Option('cache-dir', type=str,
3547
help='Cache intermediate benchmark output in this '
3677
3549
Option('first',
3678
3550
help='Run all tests, but run specified tests first.',
3679
3551
short_name='f',
3714
3586
def run(self, testspecs_list=None, verbose=False, one=False,
3715
3587
transport=None, benchmark=None,
3588
lsprof_timed=None, cache_dir=None,
3717
3589
first=False, list_only=False,
3718
3590
randomize=None, exclude=None, strict=False,
3719
3591
load_list=None, debugflag=None, starting_with=None, subunit=False,
3720
3592
parallel=None, lsprof_tests=False):
3721
from bzrlib import tests
3593
from bzrlib.tests import selftest
3594
import bzrlib.benchmarks as benchmarks
3595
from bzrlib.benchmarks import tree_creator
3597
# Make deprecation warnings visible, unless -Werror is set
3598
symbol_versioning.activate_deprecation_warnings(override=False)
3600
if cache_dir is not None:
3601
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3723
3602
if testspecs_list is not None:
3724
3603
pattern = '|'.join(testspecs_list)
3733
3612
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3734
3613
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3735
3614
# stdout, which would corrupt the subunit stream.
3736
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3737
# following code can be deleted when it's sufficiently deployed
3738
# -- vila/mgz 20100514
3739
if (sys.platform == "win32"
3740
and getattr(sys.stdout, 'fileno', None) is not None):
3615
if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3742
3617
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3744
3619
self.additional_selftest_args.setdefault(
3745
3620
'suite_decorators', []).append(parallel)
3747
raise errors.BzrCommandError(
3748
"--benchmark is no longer supported from bzr 2.2; "
3749
"use bzr-usertest instead")
3750
test_suite_factory = None
3622
test_suite_factory = benchmarks.test_suite
3623
# Unless user explicitly asks for quiet, be verbose in benchmarks
3624
verbose = not is_quiet()
3625
# TODO: should possibly lock the history file...
3626
benchfile = open(".perf_history", "at", buffering=1)
3627
self.add_cleanup(benchfile.close)
3629
test_suite_factory = None
3751
3631
selftest_kwargs = {"verbose": verbose,
3752
3632
"pattern": pattern,
3753
3633
"stop_on_failure": one,
3835
3711
with bzr send. If neither is specified, the default is the upstream branch
3836
3712
or the branch most recently merged using --remember.
3838
When merging from a branch, by default bzr will try to merge in all new
3839
work from the other branch, automatically determining an appropriate base
3840
revision. If this fails, you may need to give an explicit base.
3842
To pick a different ending revision, pass "--revision OTHER". bzr will
3843
try to merge in all new work up to and including revision OTHER.
3845
If you specify two values, "--revision BASE..OTHER", only revisions BASE
3846
through OTHER, excluding BASE but including OTHER, will be merged. If this
3847
causes some revisions to be skipped, i.e. if the destination branch does
3848
not already contain revision BASE, such a merge is commonly referred to as
3851
Revision numbers are always relative to the source branch.
3714
When merging a branch, by default the tip will be merged. To pick a different
3715
revision, pass --revision. If you specify two values, the first will be used as
3716
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3717
available revisions, like this is commonly referred to as "cherrypicking".
3719
Revision numbers are always relative to the branch being merged.
3721
By default, bzr will try to merge in all new work from the other
3722
branch, automatically determining an appropriate base. If this
3723
fails, you may need to give an explicit base.
3853
3725
Merge will do its best to combine the changes in two branches, but there
3854
3726
are some kinds of problems only a human can fix. When it encounters those,
3921
3793
' completely merged into the source, pull from the'
3922
3794
' source rather than merging. When this happens,'
3923
3795
' you do not need to commit the result.'),
3924
custom_help('directory',
3925
3797
help='Branch to merge into, '
3926
'rather than the one containing the working directory.'),
3798
'rather than the one containing the working directory.',
3927
3802
Option('preview', help='Instead of merging, show a diff of the'
3929
3804
Option('interactive', help='Select changes interactively.',
4029
3905
def _do_preview(self, merger):
4030
3906
from bzrlib.diff import show_diff_trees
4031
3907
result_tree = self._get_preview(merger)
4032
path_encoding = osutils.get_diff_header_encoding()
4033
3908
show_diff_trees(merger.this_tree, result_tree, self.outf,
4034
old_label='', new_label='',
4035
path_encoding=path_encoding)
3909
old_label='', new_label='')
4037
3911
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4038
3912
merger.change_reporter = change_reporter
4118
3992
if ((remember or tree.branch.get_submit_branch() is None) and
4119
3993
user_location is not None):
4120
3994
tree.branch.set_submit_branch(other_branch.base)
4121
# Merge tags (but don't set them in the master branch yet, the user
4122
# might revert this merge). Commit will propagate them.
4123
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
3995
_merge_tags_if_possible(other_branch, tree.branch)
4124
3996
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4125
3997
other_revision_id, base_revision_id, other_branch, base_branch)
4126
3998
if other_path != '':
4294
4167
last committed revision is used.
4296
4169
To remove only some changes, without reverting to a prior version, use
4297
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4298
will remove the changes introduced by the second last commit (-2), without
4299
affecting the changes introduced by the last commit (-1). To remove
4300
certain changes on a hunk-by-hunk basis, see the shelve command.
4170
merge instead. For example, "merge . --revision -2..-3" will remove the
4171
changes introduced by -2, without affecting the changes introduced by -1.
4172
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4302
4174
By default, any files that have been manually changed will be backed up
4303
4175
first. (Files changed only by merge are not backed up.) Backup files have
4468
4340
theirs_only=False,
4469
4341
log_format=None, long=False, short=False, line=False,
4470
4342
show_ids=False, verbose=False, this=False, other=False,
4471
include_merges=False, revision=None, my_revision=None,
4343
include_merges=False, revision=None, my_revision=None):
4473
4344
from bzrlib.missing import find_unmerged, iter_log_revisions
4474
4345
def message(s):
4475
4346
if not is_quiet():
4633
4507
@display_command
4634
4508
def run(self, verbose=False):
4635
from bzrlib import plugin
4636
self.outf.writelines(
4637
plugin.describe_plugins(show_paths=verbose))
4509
import bzrlib.plugin
4510
from inspect import getdoc
4512
for name, plugin in bzrlib.plugin.plugins().items():
4513
version = plugin.__version__
4514
if version == 'unknown':
4516
name_ver = '%s %s' % (name, version)
4517
d = getdoc(plugin.module)
4519
doc = d.split('\n')[0]
4521
doc = '(no description)'
4522
result.append((name_ver, doc, plugin.path()))
4523
for name_ver, doc, path in sorted(result):
4524
self.outf.write("%s\n" % name_ver)
4525
self.outf.write(" %s\n" % doc)
4527
self.outf.write(" %s\n" % path)
4528
self.outf.write("\n")
4640
4531
class cmd_testament(Command):
4686
4578
Option('long', help='Show commit date in annotations.'),
4691
4582
encoding_type = 'exact'
4693
4584
@display_command
4694
4585
def run(self, filename, all=False, long=False, revision=None,
4695
show_ids=False, directory=None):
4696
4587
from bzrlib.annotate import annotate_file, annotate_file_tree
4697
4588
wt, branch, relpath = \
4698
_open_directory_or_containing_tree_or_branch(filename, directory)
4589
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4699
4590
if wt is not None:
4700
self.add_cleanup(wt.lock_read().unlock)
4592
self.add_cleanup(wt.unlock)
4702
self.add_cleanup(branch.lock_read().unlock)
4595
self.add_cleanup(branch.unlock)
4703
4596
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4704
self.add_cleanup(tree.lock_read().unlock)
4705
if wt is not None and revision is None:
4598
self.add_cleanup(tree.unlock)
4706
4600
file_id = wt.path2id(relpath)
4708
4602
file_id = tree.path2id(relpath)
4709
4603
if file_id is None:
4710
4604
raise errors.NotVersionedError(filename)
4605
file_version = tree.inventory[file_id].revision
4711
4606
if wt is not None and revision is None:
4712
4607
# If there is a tree and we're not annotating historical
4713
4608
# versions, annotate the working tree's content.
4714
4609
annotate_file_tree(wt, file_id, self.outf, long, all,
4715
4610
show_ids=show_ids)
4717
file_version = tree.get_file_revision(file_id)
4718
4612
annotate_file(branch, file_version, file_id, long, all, self.outf,
4719
4613
show_ids=show_ids)
4726
4620
hidden = True # is this right ?
4727
4621
takes_args = ['revision_id*']
4728
takes_options = ['directory', 'revision']
4622
takes_options = ['revision']
4730
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4624
def run(self, revision_id_list=None, revision=None):
4731
4625
if revision_id_list is not None and revision is not None:
4732
4626
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4733
4627
if revision_id_list is None and revision is None:
4734
4628
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4735
b = WorkingTree.open_containing(directory)[0].branch
4736
self.add_cleanup(b.lock_write().unlock)
4629
b = WorkingTree.open_containing(u'.')[0].branch
4631
self.add_cleanup(b.unlock)
4737
4632
return self._run(b, revision_id_list, revision)
4739
4634
def _run(self, b, revision_id_list, revision):
4799
4694
_see_also = ['checkouts', 'unbind']
4800
4695
takes_args = ['location?']
4801
takes_options = ['directory']
4803
def run(self, location=None, directory=u'.'):
4804
b, relpath = Branch.open_containing(directory)
4698
def run(self, location=None):
4699
b, relpath = Branch.open_containing(u'.')
4805
4700
if location is None:
4807
4702
location = b.get_old_bound_location()
4889
4784
b = control.open_branch()
4891
4786
if tree is not None:
4892
self.add_cleanup(tree.lock_write().unlock)
4788
self.add_cleanup(tree.unlock)
4894
self.add_cleanup(b.lock_write().unlock)
4791
self.add_cleanup(b.unlock)
4895
4792
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4897
4794
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4968
4859
bzr break-lock bzr+ssh://example.com/bzr/foo
4969
bzr break-lock --conf ~/.bazaar
4972
4861
takes_args = ['location?']
4975
help='LOCATION is the directory where the config lock is.'),
4977
help='Do not ask for confirmation before breaking the lock.'),
4980
def run(self, location=None, config=False, force=False):
4863
def run(self, location=None, show=False):
4981
4864
if location is None:
4982
4865
location = u'.'
4984
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
4986
{'bzrlib.lockdir.break': True})
4988
conf = _mod_config.LockableConfig(file_name=location)
4991
control, relpath = bzrdir.BzrDir.open_containing(location)
4993
control.break_lock()
4994
except NotImplementedError:
4866
control, relpath = bzrdir.BzrDir.open_containing(location)
4868
control.break_lock()
4869
except NotImplementedError:
4998
4873
class cmd_wait_until_signalled(Command):
5062
4938
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5063
4939
protocol=None):
5064
from bzrlib import transport
4940
from bzrlib.transport import get_transport, transport_server_registry
5065
4941
if directory is None:
5066
4942
directory = os.getcwd()
5067
4943
if protocol is None:
5068
protocol = transport.transport_server_registry.get()
4944
protocol = transport_server_registry.get()
5069
4945
host, port = self.get_host_and_port(port)
5070
4946
url = urlutils.local_path_to_url(directory)
5071
4947
if not allow_writes:
5072
4948
url = 'readonly+' + url
5073
t = transport.get_transport(url)
5074
protocol(t, host, port, inet)
4949
transport = get_transport(url)
4950
protocol(transport, host, port, inet)
5077
4953
class cmd_join(Command):
5189
5064
encoding_type = 'exact'
5191
5066
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5192
sign=False, revision=None, mail_to=None, message=None,
5067
sign=False, revision=None, mail_to=None, message=None):
5194
5068
from bzrlib.revision import ensure_null, NULL_REVISION
5195
5069
include_patch, include_bundle = {
5196
5070
'plain': (False, False),
5197
5071
'diff': (True, False),
5198
5072
'bundle': (True, True),
5200
branch = Branch.open(directory)
5074
branch = Branch.open('.')
5201
5075
stored_submit_branch = branch.get_submit_branch()
5202
5076
if submit_branch is None:
5203
5077
submit_branch = stored_submit_branch
5515
5393
_see_also = ['tag']
5516
5394
takes_options = [
5517
custom_help('directory',
5518
help='Branch whose tags should be displayed.'),
5519
RegistryOption('sort',
5396
help='Branch whose tags should be displayed.',
5400
RegistryOption.from_kwargs('sort',
5520
5401
'Sort tags by different criteria.', title='Sorting',
5521
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5402
alpha='Sort tags lexicographically (default).',
5403
time='Sort tags chronologically.',
5527
5409
@display_command
5528
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5529
from bzrlib.tag import tag_sort_methods
5530
5416
branch, relpath = Branch.open_containing(directory)
5532
5418
tags = branch.tags.get_tag_dict().items()
5536
self.add_cleanup(branch.lock_read().unlock)
5423
self.add_cleanup(branch.unlock)
5538
5425
graph = branch.repository.get_graph()
5539
5426
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5541
5428
# only show revisions between revid1 and revid2 (inclusive)
5542
5429
tags = [(tag, revid) for tag, revid in tags if
5543
5430
graph.is_between(revid, revid1, revid2)]
5545
sort = tag_sort_methods.get()
5433
elif sort == 'time':
5435
for tag, revid in tags:
5437
revobj = branch.repository.get_revision(revid)
5438
except errors.NoSuchRevision:
5439
timestamp = sys.maxint # place them at the end
5441
timestamp = revobj.timestamp
5442
timestamps[revid] = timestamp
5443
tags.sort(key=lambda x: timestamps[x[1]])
5547
5444
if not show_ids:
5548
5445
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5549
5446
for index, (tag, revid) in enumerate(tags):
5688
5584
def run(self, to_location=None, force=False, create_branch=False,
5689
revision=None, directory=u'.'):
5690
5586
from bzrlib import switch
5691
tree_location = directory
5692
5588
revision = _get_one_revision('switch', revision)
5693
5589
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5694
5590
if to_location is None:
5695
5591
if revision is None:
5696
5592
raise errors.BzrCommandError('You must supply either a'
5697
5593
' revision or a location')
5698
to_location = tree_location
5700
5596
branch = control_dir.open_branch()
5701
5597
had_explicit_nick = branch.get_config().has_explicit_nickname()
5973
5868
You can put multiple items on the shelf, and by default, 'unshelve' will
5974
5869
restore the most recently shelved changes.
5976
For complicated changes, it is possible to edit the changes in a separate
5977
editor program to decide what the file remaining in the working copy
5978
should look like. To do this, add the configuration option
5980
change_editor = PROGRAM @new_path @old_path
5982
where @new_path is replaced with the path of the new version of the
5983
file and @old_path is replaced with the path of the old version of
5984
the file. The PROGRAM should save the new file with the desired
5985
contents of the file in the working tree.
5989
5872
takes_args = ['file*']
5991
5874
takes_options = [
5994
5876
Option('all', help='Shelve all changes.'),
6001
5883
Option('destroy',
6002
5884
help='Destroy removed changes instead of shelving them.'),
6004
_see_also = ['unshelve', 'configuration']
5886
_see_also = ['unshelve']
6006
5888
def run(self, revision=None, all=False, file_list=None, message=None,
6007
writer=None, list=False, destroy=False, directory=None):
5889
writer=None, list=False, destroy=False):
6009
return self.run_for_list(directory=directory)
5891
return self.run_for_list()
6010
5892
from bzrlib.shelf_ui import Shelver
6011
5893
if writer is None:
6012
5894
writer = bzrlib.option.diff_writer_registry.get()
6014
5896
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6015
file_list, message, destroy=destroy, directory=directory)
5897
file_list, message, destroy=destroy)
6087
5967
To check what clean-tree will do, use --dry-run.
6089
takes_options = ['directory',
6090
Option('ignored', help='Delete all ignored files.'),
6091
Option('detritus', help='Delete conflict files, merge and revert'
5969
takes_options = [Option('ignored', help='Delete all ignored files.'),
5970
Option('detritus', help='Delete conflict files, merge'
6092
5971
' backups, and failed selftest dirs.'),
6093
5972
Option('unknown',
6094
5973
help='Delete files unknown to bzr (default).'),
6096
5975
' deleting them.'),
6097
5976
Option('force', help='Do not prompt before deleting.')]
6098
5977
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6099
force=False, directory=u'.'):
6100
5979
from bzrlib.clean_tree import clean_tree
6101
5980
if not (unknown or ignored or detritus):
6105
clean_tree(directory, unknown=unknown, ignored=ignored,
6106
detritus=detritus, dry_run=dry_run, no_prompt=force)
5984
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5985
dry_run=dry_run, no_prompt=force)
6109
5988
class cmd_reference(Command):
6158
6037
# be only called once.
6159
6038
for (name, aliases, module_name) in [
6160
6039
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6161
('cmd_config', [], 'bzrlib.config'),
6162
6040
('cmd_dpush', [], 'bzrlib.foreign'),
6163
6041
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6164
6042
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6165
6043
('cmd_conflicts', [], 'bzrlib.conflicts'),
6166
6044
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6167
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6169
6046
builtin_command_registry.register_lazy(name, aliases, module_name)