75
74
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,
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]))
80
return internal_tree_files(file_list, default_branch, canonicalize,
88
84
def tree_files_for_add(file_list):
153
149
# XXX: Bad function name; should possibly also be a class method of
154
150
# WorkingTree rather than a function.
151
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
155
152
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
156
153
apply_view=True):
157
154
"""Convert command-line paths to a WorkingTree and relative paths.
156
Deprecated: use WorkingTree.open_containing_paths instead.
159
158
This is typically used for command-line processors that take one or
160
159
more filenames, and infer the workingtree that contains them.
172
171
:return: workingtree, [relative_paths]
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)
173
return WorkingTree.open_containing_paths(
174
file_list, default_directory='.',
223
179
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)
235
199
# TODO: Make sure no commands unconditionally use the working directory as a
236
200
# branch. If a filename argument is used, the first of them should be used to
237
201
# specify the branch. (Perhaps this can be factored out into some kind of
286
250
To skip the display of pending merge information altogether, use
287
251
the no-pending option or specify a file/directory.
289
If a revision argument is given, the status is calculated against
290
that revision, or between two revisions if two are provided.
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'.
293
261
# TODO: --no-recurse, --recurse options
353
321
self.outf.write(revtext.decode('utf-8'))
356
def run(self, revision_id=None, revision=None):
324
def run(self, revision_id=None, revision=None, directory=u'.'):
357
325
if revision_id is not None and revision is not None:
358
326
raise errors.BzrCommandError('You can only supply one of'
359
327
' revision_id or --revision')
360
328
if revision_id is None and revision is None:
361
329
raise errors.BzrCommandError('You must supply either'
362
330
' --revision or a revision_id')
363
b = WorkingTree.open_containing(u'.')[0].branch
332
b = bzrdir.BzrDir.open_containing_tree_or_branch(directory)[1]
365
334
revisions = b.repository.revisions
366
335
if revisions is None:
511
485
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'
514
541
class cmd_revno(Command):
515
542
__doc__ = """Show current revision number.
759
778
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
761
780
revision = _get_one_revision('inventory', revision)
762
work_tree, file_list = tree_files(file_list)
763
work_tree.lock_read()
764
self.add_cleanup(work_tree.unlock)
781
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
782
self.add_cleanup(work_tree.lock_read().unlock)
765
783
if revision is not None:
766
784
tree = revision.as_tree(work_tree.branch)
768
786
extra_trees = [work_tree]
770
self.add_cleanup(tree.unlock)
787
self.add_cleanup(tree.lock_read().unlock)
833
850
if len(names_list) < 2:
834
851
raise errors.BzrCommandError("missing file argument")
835
tree, rel_names = tree_files(names_list, canonicalize=False)
836
tree.lock_tree_write()
837
self.add_cleanup(tree.unlock)
852
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
853
self.add_cleanup(tree.lock_tree_write().unlock)
838
854
self._run(tree, names_list, rel_names, after)
840
856
def run_auto(self, names_list, after, dry_run):
845
861
raise errors.BzrCommandError('--after cannot be specified with'
847
work_tree, file_list = tree_files(names_list, default_branch='.')
848
work_tree.lock_tree_write()
849
self.add_cleanup(work_tree.unlock)
863
work_tree, file_list = WorkingTree.open_containing_paths(
864
names_list, default_directory='.')
865
self.add_cleanup(work_tree.lock_tree_write().unlock)
850
866
rename_map.RenameMap.guess_renames(work_tree, dry_run)
852
868
def _run(self, tree, names_list, rel_names, after):
960
976
takes_options = ['remember', 'overwrite', 'revision',
961
977
custom_help('verbose',
962
978
help='Show logs of pulled revisions.'),
979
custom_help('directory',
964
980
help='Branch to pull into, '
965
'rather than the one containing the working directory.',
981
'rather than the one containing the working directory.'),
970
983
help="Perform a local pull in a bound "
971
984
"branch. Local pulls are not applied to "
972
985
"the master branch."
988
help="Show base revision text in conflicts.")
975
990
takes_args = ['location?']
976
991
encoding_type = 'replace'
978
993
def run(self, location=None, remember=False, overwrite=False,
979
994
revision=None, verbose=False,
980
directory=None, local=False):
995
directory=None, local=False,
981
997
# FIXME: too much stuff is in the command class
982
998
revision_id = None
987
1003
tree_to = WorkingTree.open_containing(directory)[0]
988
1004
branch_to = tree_to.branch
990
self.add_cleanup(tree_to.unlock)
1005
self.add_cleanup(tree_to.lock_write().unlock)
991
1006
except errors.NoWorkingTree:
993
1008
branch_to = Branch.open_containing(directory)[0]
994
branch_to.lock_write()
995
self.add_cleanup(branch_to.unlock)
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.")
997
1014
if local and not branch_to.get_bound_location():
998
1015
raise errors.LocalRequiresBoundBranch()
1088
1109
Option('create-prefix',
1089
1110
help='Create the path leading up to the branch '
1090
1111
'if it does not already exist.'),
1112
custom_help('directory',
1092
1113
help='Branch to push from, '
1093
'rather than the one containing the working directory.',
1114
'rather than the one containing the working directory.'),
1097
1115
Option('use-existing-dir',
1098
1116
help='By default push will fail if the target'
1099
1117
' directory exists, but does not already'
1117
1138
def run(self, location=None, remember=False, overwrite=False,
1118
1139
create_prefix=False, verbose=False, revision=None,
1119
1140
use_existing_dir=False, directory=None, stacked_on=None,
1120
stacked=False, strict=None):
1141
stacked=False, strict=None, no_tree=False):
1121
1142
from bzrlib.push import _show_push_branch
1123
1144
if directory is None:
1169
1190
_show_push_branch(br_from, revision_id, location, self.outf,
1170
1191
verbose=verbose, overwrite=overwrite, remember=remember,
1171
1192
stacked_on=stacked_on, create_prefix=create_prefix,
1172
use_existing_dir=use_existing_dir)
1193
use_existing_dir=use_existing_dir, no_tree=no_tree)
1175
1196
class cmd_branch(Command):
1185
1206
To retrieve the branch as of a particular revision, supply the --revision
1186
1207
parameter, as in "branch foo/bar -r 5".
1209
The synonyms 'clone' and 'get' for this command are deprecated.
1189
1212
_see_also = ['checkout']
1190
1213
takes_args = ['from_location', 'to_location?']
1191
takes_options = ['revision', Option('hardlink',
1192
help='Hard-link working tree files where possible.'),
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."),
1193
1218
Option('no-tree',
1194
1219
help="Create a branch without a working-tree."),
1195
1220
Option('switch',
1214
1239
def run(self, from_location, to_location=None, revision=None,
1215
1240
hardlink=False, stacked=False, standalone=False, no_tree=False,
1216
use_existing_dir=False, switch=False, bind=False):
1241
use_existing_dir=False, switch=False, bind=False,
1217
1243
from bzrlib import switch as _mod_switch
1218
1244
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')
1219
1251
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)
1221
1260
revision = _get_one_revision('branch', revision)
1223
self.add_cleanup(br_from.unlock)
1261
self.add_cleanup(br_from.lock_read().unlock)
1224
1262
if revision is not None:
1225
1263
revision_id = revision.as_revision_id(br_from)
1331
1369
to_location = branch_location
1332
1370
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1333
1371
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
1334
1377
revision = _get_one_revision('checkout', revision)
1335
if files_from is not None:
1378
if files_from is not None and files_from != branch_location:
1336
1379
accelerator_tree = WorkingTree.open(files_from)
1337
1380
if revision is not None:
1338
1381
revision_id = revision.as_revision_id(source)
1396
1437
If you want to discard your local changes, you can just do a
1397
1438
'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'.
1399
1443
If the tree's branch is bound to a master branch, it will also update
1400
1444
the branch from the master.
1403
1447
_see_also = ['pull', 'working-trees', 'status-flags']
1404
1448
takes_args = ['dir?']
1405
takes_options = ['revision']
1449
takes_options = ['revision',
1451
help="Show base revision text in conflicts."),
1406
1453
aliases = ['up']
1408
def run(self, dir='.', revision=None):
1455
def run(self, dir='.', revision=None, show_base=None):
1409
1456
if revision is not None and len(revision) != 1:
1410
1457
raise errors.BzrCommandError(
1411
1458
"bzr update --revision takes exactly one revision")
1519
1567
class cmd_remove(Command):
1520
1568
__doc__ = """Remove files or directories.
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.
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.
1527
1576
takes_args = ['file*']
1528
1577
takes_options = ['verbose',
1530
1579
RegistryOption.from_kwargs('file-deletion-strategy',
1531
1580
'The file deletion mode to be used.',
1532
1581
title='Deletion Strategy', value_switches=True, enum_switch=False,
1533
safe='Only delete files if they can be'
1534
' safely recovered (default).',
1582
safe='Backup changed files (default).',
1535
1583
keep='Delete from bzr but leave the working copy.',
1584
no_backup='Don\'t backup changed files.',
1536
1585
force='Delete all the specified files, even if they can not be '
1537
'recovered and even if they are non-empty directories.')]
1586
'recovered and even if they are non-empty directories. '
1587
'(deprecated, use no-backup)')]
1538
1588
aliases = ['rm', 'del']
1539
1589
encoding_type = 'replace'
1541
1591
def run(self, file_list, verbose=False, new=False,
1542
1592
file_deletion_strategy='safe'):
1543
tree, file_list = tree_files(file_list)
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)
1545
1600
if file_list is not None:
1546
1601
file_list = [f for f in file_list]
1549
self.add_cleanup(tree.unlock)
1603
self.add_cleanup(tree.lock_write().unlock)
1550
1604
# Heuristics should probably all move into tree.remove_smart or
1636
1690
_see_also = ['check']
1637
1691
takes_args = ['branch?']
1693
Option('canonicalize-chks',
1694
help='Make sure CHKs are in canonical form (repairs '
1639
def run(self, branch="."):
1699
def run(self, branch=".", canonicalize_chks=False):
1640
1700
from bzrlib.reconcile import reconcile
1641
1701
dir = bzrdir.BzrDir.open(branch)
1702
reconcile(dir, canonicalize_chks=canonicalize_chks)
1645
1705
class cmd_revision_history(Command):
1723
1783
Option('append-revisions-only',
1724
1784
help='Never change revnos or the existing log.'
1725
' Append revisions to it only.')
1785
' Append revisions to it only.'),
1787
'Create a branch without a working tree.')
1727
1789
def run(self, location=None, format=None, append_revisions_only=False,
1728
create_prefix=False):
1790
create_prefix=False, no_tree=False):
1729
1791
if format is None:
1730
1792
format = bzrdir.format_registry.make_bzrdir('default')
1731
1793
if location is None:
1985
2070
old_branch, new_branch,
1986
2071
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
2072
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()
1988
2075
return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
2076
specific_files=specific_files,
1990
2077
external_diff_options=diff_options,
1991
2078
old_label=old_label, new_label=new_label,
1992
extra_trees=extra_trees, using=using,
2079
extra_trees=extra_trees,
2080
path_encoding=path_encoding,
1993
2082
format_cls=format)
2003
2092
# level of effort but possibly much less IO. (Or possibly not,
2004
2093
# if the directories are very large...)
2005
2094
_see_also = ['status', 'ls']
2006
takes_options = ['show-ids']
2095
takes_options = ['directory', 'show-ids']
2008
2097
@display_command
2009
def run(self, show_ids=False):
2010
tree = WorkingTree.open_containing(u'.')[0]
2012
self.add_cleanup(tree.unlock)
2098
def run(self, show_ids=False, directory=u'.'):
2099
tree = WorkingTree.open_containing(directory)[0]
2100
self.add_cleanup(tree.lock_read().unlock)
2013
2101
old = tree.basis_tree()
2015
self.add_cleanup(old.unlock)
2102
self.add_cleanup(old.lock_read().unlock)
2016
2103
for path, ie in old.inventory.iter_entries():
2017
2104
if not tree.has_id(ie.file_id):
2018
2105
self.outf.write(path)
2030
2117
_see_also = ['status', 'ls']
2033
help='Write an ascii NUL (\\0) separator '
2034
'between files rather than a newline.')
2118
takes_options = ['directory', 'null']
2037
2120
@display_command
2038
def run(self, null=False):
2039
tree = WorkingTree.open_containing(u'.')[0]
2121
def run(self, null=False, directory=u'.'):
2122
tree = WorkingTree.open_containing(directory)[0]
2123
self.add_cleanup(tree.lock_read().unlock)
2040
2124
td = tree.changes_from(tree.basis_tree())
2041
2126
for path, id, kind, text_modified, meta_modified in td.modified:
2043
2128
self.outf.write(path + '\0')
2053
2138
_see_also = ['status', 'ls']
2056
help='Write an ascii NUL (\\0) separator '
2057
'between files rather than a newline.')
2139
takes_options = ['directory', 'null']
2060
2141
@display_command
2061
def run(self, null=False):
2062
wt = WorkingTree.open_containing(u'.')[0]
2064
self.add_cleanup(wt.unlock)
2142
def run(self, null=False, directory=u'.'):
2143
wt = WorkingTree.open_containing(directory)[0]
2144
self.add_cleanup(wt.lock_read().unlock)
2065
2145
basis = wt.basis_tree()
2067
self.add_cleanup(basis.unlock)
2146
self.add_cleanup(basis.lock_read().unlock)
2068
2147
basis_inv = basis.inventory
2069
2148
inv = wt.inventory
2070
2149
for file_id in inv:
2528
2611
help='Recurse into subdirectories.'),
2529
2612
Option('from-root',
2530
2613
help='Print paths relative to the root of the branch.'),
2531
Option('unknown', help='Print unknown files.'),
2614
Option('unknown', short_name='u',
2615
help='Print unknown files.'),
2532
2616
Option('versioned', help='Print versioned files.',
2533
2617
short_name='V'),
2534
Option('ignored', help='Print ignored files.'),
2536
help='Write an ascii NUL (\\0) separator '
2537
'between files rather than a newline.'),
2618
Option('ignored', short_name='i',
2619
help='Print ignored files.'),
2620
Option('kind', short_name='k',
2539
2621
help='List entries of a particular kind: file, directory, symlink.',
2543
2627
@display_command
2544
2628
def run(self, revision=None, verbose=False,
2545
2629
recursive=False, from_root=False,
2546
2630
unknown=False, versioned=False, ignored=False,
2547
null=False, kind=None, show_ids=False, path=None):
2631
null=False, kind=None, show_ids=False, path=None, directory=None):
2549
2633
if kind and kind not in ('file', 'directory', 'symlink'):
2550
2634
raise errors.BzrCommandError('invalid kind specified')
2713
2806
_see_also = ['status', 'ignored', 'patterns']
2714
2807
takes_args = ['name_pattern*']
2808
takes_options = ['directory',
2716
2809
Option('default-rules',
2717
2810
help='Display the default ignore rules that bzr uses.')
2720
def run(self, name_pattern_list=None, default_rules=None):
2813
def run(self, name_pattern_list=None, default_rules=None,
2721
2815
from bzrlib import ignores
2722
2816
if default_rules is not None:
2723
2817
# dump the default rules and exit
2729
2823
"NAME_PATTERN or --default-rules.")
2730
2824
name_pattern_list = [globbing.normalize_pattern(p)
2731
2825
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('')
2732
2834
for name_pattern in name_pattern_list:
2733
2835
if (name_pattern[0] == '/' or
2734
2836
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2735
2837
raise errors.BzrCommandError(
2736
2838
"NAME_PATTERN should not be an absolute path")
2737
tree, relpath = WorkingTree.open_containing(u'.')
2839
tree, relpath = WorkingTree.open_containing(directory)
2738
2840
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2739
2841
ignored = globbing.Globster(name_pattern_list)
2843
self.add_cleanup(tree.lock_read().unlock)
2742
2844
for entry in tree.list_files():
2744
2846
if id is not None:
2745
2847
filename = entry[0]
2746
2848
if ignored.match(filename):
2747
2849
matches.append(filename)
2749
2850
if len(matches) > 0:
2750
2851
self.outf.write("Warning: the following files are version controlled and"
2751
2852
" match your ignore pattern:\n%s"
2767
2868
encoding_type = 'replace'
2768
2869
_see_also = ['ignore', 'ls']
2870
takes_options = ['directory']
2770
2872
@display_command
2772
tree = WorkingTree.open_containing(u'.')[0]
2774
self.add_cleanup(tree.unlock)
2873
def run(self, directory=u'.'):
2874
tree = WorkingTree.open_containing(directory)[0]
2875
self.add_cleanup(tree.lock_read().unlock)
2775
2876
for path, file_class, kind, file_id, entry in tree.list_files():
2776
2877
if file_class != 'I':
2844
2947
'revision in which it was changed.'),
2846
2949
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
root=None, filters=False, per_file_timestamps=False):
2950
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2848
2951
from bzrlib.export import export
2850
2953
if branch_or_subdir is None:
2851
tree = WorkingTree.open_containing(u'.')[0]
2954
tree = WorkingTree.open_containing(directory)[0]
2852
2955
b = tree.branch
2885
2988
@display_command
2886
2989
def run(self, filename, revision=None, name_from_revision=False,
2990
filters=False, directory=None):
2888
2991
if revision is not None and len(revision) != 1:
2889
2992
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2890
2993
" one revision specifier")
2891
2994
tree, branch, relpath = \
2892
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2894
self.add_cleanup(branch.unlock)
2995
_open_directory_or_containing_tree_or_branch(filename, directory)
2996
self.add_cleanup(branch.lock_read().unlock)
2895
2997
return self._run(tree, branch, relpath, filename, revision,
2896
2998
name_from_revision, filters)
3013
3114
to trigger updates to external systems like bug trackers. The --fixes
3014
3115
option can be used to record the association between a revision and
3015
3116
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
3043
3119
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3044
3120
takes_args = ['selected*']
3101
3181
def run(self, message=None, file=None, verbose=False, selected_list=None,
3102
3182
unchanged=False, strict=False, local=False, fixes=None,
3103
author=None, show_diff=False, exclude=None, commit_time=None):
3183
author=None, show_diff=False, exclude=None, commit_time=None,
3104
3185
from bzrlib.errors import (
3105
3186
PointlessCommit,
3106
3187
ConflictsInTree,
3120
3201
raise errors.BzrCommandError(
3121
3202
"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.
3129
3204
properties = {}
3131
tree, selected_list = tree_files(selected_list)
3206
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3132
3207
if selected_list == ['']:
3133
3208
# workaround - commit of root of tree should be exactly the same
3134
3209
# as just default commit in that tree, and succeed even though
3205
3283
reporter=None, verbose=verbose, revprops=properties,
3206
3284
authors=author, timestamp=commit_stamp,
3207
3285
timezone=offset,
3208
exclude=safe_relpath_files(tree, exclude))
3286
exclude=tree.safe_relpath_files(exclude),
3209
3288
except PointlessCommit:
3210
3289
raise errors.BzrCommandError("No changes to commit."
3211
" Use --unchanged to commit anyhow.")
3290
" Please 'bzr add' the files you want to commit, or use"
3291
" --unchanged to force an empty commit.")
3212
3292
except ConflictsInTree:
3213
3293
raise errors.BzrCommandError('Conflicts detected in working '
3214
3294
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3297
3377
class cmd_upgrade(Command):
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.
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/.
3305
_see_also = ['check']
3410
_see_also = ['check', 'reconcile', 'formats']
3306
3411
takes_args = ['url?']
3307
3412
takes_options = [
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'),
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."),
3316
def run(self, url='.', format=None):
3425
def run(self, url='.', format=None, clean=False, dry_run=False):
3317
3426
from bzrlib.upgrade import upgrade
3318
upgrade(url, format)
3427
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3429
if len(exceptions) == 1:
3430
# Compatibility with historical behavior
3321
3436
class cmd_whoami(Command):
3340
3456
encoding_type = 'replace'
3342
3458
@display_command
3343
def run(self, email=False, branch=False, name=None):
3459
def run(self, email=False, branch=False, name=None, directory=None):
3344
3460
if name is None:
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()
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()
3351
3470
self.outf.write(c.user_email() + '\n')
3353
3472
self.outf.write(c.username() + '\n')
3476
raise errors.BzrCommandError("--email can only be used to display existing "
3356
3479
# display a warning if an email address isn't included in the given name.
3358
config.extract_email_address(name)
3481
_mod_config.extract_email_address(name)
3359
3482
except errors.NoEmailInUsername, e:
3360
3483
warning('"%s" does not seem to contain an email address. '
3361
3484
'This is allowed, but not recommended.', name)
3363
3486
# use global config unless --branch given
3365
c = Branch.open_containing('.')[0].get_config()
3488
if directory is None:
3489
c = Branch.open_containing(u'.')[0].get_config()
3491
c = Branch.open(directory).get_config()
3367
c = config.GlobalConfig()
3493
c = _mod_config.GlobalConfig()
3368
3494
c.set_user_option('email', name)
3436
3563
'bzr alias --remove expects an alias to remove.')
3437
3564
# If alias is not found, print something like:
3438
3565
# unalias: foo: not found
3439
c = config.GlobalConfig()
3566
c = _mod_config.GlobalConfig()
3440
3567
c.unset_alias(alias_name)
3442
3569
@display_command
3443
3570
def print_aliases(self):
3444
3571
"""Print out the defined aliases in a similar format to bash."""
3445
aliases = config.GlobalConfig().get_aliases()
3572
aliases = _mod_config.GlobalConfig().get_aliases()
3446
3573
for key, value in sorted(aliases.iteritems()):
3447
3574
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3537
3667
'throughout the test suite.',
3538
3668
type=get_transport_type),
3539
3669
Option('benchmark',
3540
help='Run the benchmarks rather than selftests.'),
3670
help='Run the benchmarks rather than selftests.',
3541
3672
Option('lsprof-timed',
3542
3673
help='Generate lsprof output for benchmarked'
3543
3674
' sections of code.'),
3544
3675
Option('lsprof-tests',
3545
3676
help='Generate lsprof output for each test.'),
3546
Option('cache-dir', type=str,
3547
help='Cache intermediate benchmark output in this '
3549
3677
Option('first',
3550
3678
help='Run all tests, but run specified tests first.',
3551
3679
short_name='f',
3586
3714
def run(self, testspecs_list=None, verbose=False, one=False,
3587
3715
transport=None, benchmark=None,
3588
lsprof_timed=None, cache_dir=None,
3589
3717
first=False, list_only=False,
3590
3718
randomize=None, exclude=None, strict=False,
3591
3719
load_list=None, debugflag=None, starting_with=None, subunit=False,
3592
3720
parallel=None, lsprof_tests=False):
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)
3721
from bzrlib import tests
3602
3723
if testspecs_list is not None:
3603
3724
pattern = '|'.join(testspecs_list)
3612
3733
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3613
3734
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3614
3735
# stdout, which would corrupt the subunit stream.
3615
if sys.platform == "win32" and sys.stdout.fileno() >= 0:
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):
3617
3742
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3619
3744
self.additional_selftest_args.setdefault(
3620
3745
'suite_decorators', []).append(parallel)
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
3747
raise errors.BzrCommandError(
3748
"--benchmark is no longer supported from bzr 2.2; "
3749
"use bzr-usertest instead")
3750
test_suite_factory = None
3631
3751
selftest_kwargs = {"verbose": verbose,
3632
3752
"pattern": pattern,
3633
3753
"stop_on_failure": one,
3711
3835
with bzr send. If neither is specified, the default is the upstream branch
3712
3836
or the branch most recently merged using --remember.
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.
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.
3725
3853
Merge will do its best to combine the changes in two branches, but there
3726
3854
are some kinds of problems only a human can fix. When it encounters those,
3793
3921
' completely merged into the source, pull from the'
3794
3922
' source rather than merging. When this happens,'
3795
3923
' you do not need to commit the result.'),
3924
custom_help('directory',
3797
3925
help='Branch to merge into, '
3798
'rather than the one containing the working directory.',
3926
'rather than the one containing the working directory.'),
3802
3927
Option('preview', help='Instead of merging, show a diff of the'
3804
3929
Option('interactive', help='Select changes interactively.',
3905
4029
def _do_preview(self, merger):
3906
4030
from bzrlib.diff import show_diff_trees
3907
4031
result_tree = self._get_preview(merger)
4032
path_encoding = osutils.get_diff_header_encoding()
3908
4033
show_diff_trees(merger.this_tree, result_tree, self.outf,
3909
old_label='', new_label='')
4034
old_label='', new_label='',
4035
path_encoding=path_encoding)
3911
4037
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3912
4038
merger.change_reporter = change_reporter
3992
4118
if ((remember or tree.branch.get_submit_branch() is None) and
3993
4119
user_location is not None):
3994
4120
tree.branch.set_submit_branch(other_branch.base)
3995
_merge_tags_if_possible(other_branch, tree.branch)
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)
3996
4124
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3997
4125
other_revision_id, base_revision_id, other_branch, base_branch)
3998
4126
if other_path != '':
4167
4294
last committed revision is used.
4169
4296
To remove only some changes, without reverting to a prior version, use
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.
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.
4174
4302
By default, any files that have been manually changed will be backed up
4175
4303
first. (Files changed only by merge are not backed up.) Backup files have
4340
4468
theirs_only=False,
4341
4469
log_format=None, long=False, short=False, line=False,
4342
4470
show_ids=False, verbose=False, this=False, other=False,
4343
include_merges=False, revision=None, my_revision=None):
4471
include_merges=False, revision=None, my_revision=None,
4344
4473
from bzrlib.missing import find_unmerged, iter_log_revisions
4345
4474
def message(s):
4346
4475
if not is_quiet():
4507
4633
@display_command
4508
4634
def run(self, verbose=False):
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")
4635
from bzrlib import plugin
4636
self.outf.writelines(
4637
plugin.describe_plugins(show_paths=verbose))
4531
4640
class cmd_testament(Command):
4578
4686
Option('long', help='Show commit date in annotations.'),
4582
4691
encoding_type = 'exact'
4584
4693
@display_command
4585
4694
def run(self, filename, all=False, long=False, revision=None,
4695
show_ids=False, directory=None):
4587
4696
from bzrlib.annotate import annotate_file, annotate_file_tree
4588
4697
wt, branch, relpath = \
4589
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4698
_open_directory_or_containing_tree_or_branch(filename, directory)
4590
4699
if wt is not None:
4592
self.add_cleanup(wt.unlock)
4700
self.add_cleanup(wt.lock_read().unlock)
4595
self.add_cleanup(branch.unlock)
4702
self.add_cleanup(branch.lock_read().unlock)
4596
4703
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4598
self.add_cleanup(tree.unlock)
4704
self.add_cleanup(tree.lock_read().unlock)
4705
if wt is not None and revision is None:
4600
4706
file_id = wt.path2id(relpath)
4602
4708
file_id = tree.path2id(relpath)
4603
4709
if file_id is None:
4604
4710
raise errors.NotVersionedError(filename)
4605
file_version = tree.inventory[file_id].revision
4606
4711
if wt is not None and revision is None:
4607
4712
# If there is a tree and we're not annotating historical
4608
4713
# versions, annotate the working tree's content.
4609
4714
annotate_file_tree(wt, file_id, self.outf, long, all,
4610
4715
show_ids=show_ids)
4717
file_version = tree.get_file_revision(file_id)
4612
4718
annotate_file(branch, file_version, file_id, long, all, self.outf,
4613
4719
show_ids=show_ids)
4620
4726
hidden = True # is this right ?
4621
4727
takes_args = ['revision_id*']
4622
takes_options = ['revision']
4728
takes_options = ['directory', 'revision']
4624
def run(self, revision_id_list=None, revision=None):
4730
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4625
4731
if revision_id_list is not None and revision is not None:
4626
4732
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4627
4733
if revision_id_list is None and revision is None:
4628
4734
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4629
b = WorkingTree.open_containing(u'.')[0].branch
4631
self.add_cleanup(b.unlock)
4735
b = WorkingTree.open_containing(directory)[0].branch
4736
self.add_cleanup(b.lock_write().unlock)
4632
4737
return self._run(b, revision_id_list, revision)
4634
4739
def _run(self, b, revision_id_list, revision):
4694
4799
_see_also = ['checkouts', 'unbind']
4695
4800
takes_args = ['location?']
4801
takes_options = ['directory']
4698
def run(self, location=None):
4699
b, relpath = Branch.open_containing(u'.')
4803
def run(self, location=None, directory=u'.'):
4804
b, relpath = Branch.open_containing(directory)
4700
4805
if location is None:
4702
4807
location = b.get_old_bound_location()
4784
4889
b = control.open_branch()
4786
4891
if tree is not None:
4788
self.add_cleanup(tree.unlock)
4892
self.add_cleanup(tree.lock_write().unlock)
4791
self.add_cleanup(b.unlock)
4894
self.add_cleanup(b.lock_write().unlock)
4792
4895
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4794
4897
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4859
4968
bzr break-lock bzr+ssh://example.com/bzr/foo
4969
bzr break-lock --conf ~/.bazaar
4861
4972
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.'),
4863
def run(self, location=None, show=False):
4980
def run(self, location=None, config=False, force=False):
4864
4981
if location is None:
4865
4982
location = u'.'
4866
control, relpath = bzrdir.BzrDir.open_containing(location)
4868
control.break_lock()
4869
except NotImplementedError:
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:
4873
4998
class cmd_wait_until_signalled(Command):
4938
5062
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4939
5063
protocol=None):
4940
from bzrlib.transport import get_transport, transport_server_registry
5064
from bzrlib import transport
4941
5065
if directory is None:
4942
5066
directory = os.getcwd()
4943
5067
if protocol is None:
4944
protocol = transport_server_registry.get()
5068
protocol = transport.transport_server_registry.get()
4945
5069
host, port = self.get_host_and_port(port)
4946
5070
url = urlutils.local_path_to_url(directory)
4947
5071
if not allow_writes:
4948
5072
url = 'readonly+' + url
4949
transport = get_transport(url)
4950
protocol(transport, host, port, inet)
5073
t = transport.get_transport(url)
5074
protocol(t, host, port, inet)
4953
5077
class cmd_join(Command):
5064
5189
encoding_type = 'exact'
5066
5191
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5067
sign=False, revision=None, mail_to=None, message=None):
5192
sign=False, revision=None, mail_to=None, message=None,
5068
5194
from bzrlib.revision import ensure_null, NULL_REVISION
5069
5195
include_patch, include_bundle = {
5070
5196
'plain': (False, False),
5071
5197
'diff': (True, False),
5072
5198
'bundle': (True, True),
5074
branch = Branch.open('.')
5200
branch = Branch.open(directory)
5075
5201
stored_submit_branch = branch.get_submit_branch()
5076
5202
if submit_branch is None:
5077
5203
submit_branch = stored_submit_branch
5393
5515
_see_also = ['tag']
5394
5516
takes_options = [
5396
help='Branch whose tags should be displayed.',
5400
RegistryOption.from_kwargs('sort',
5517
custom_help('directory',
5518
help='Branch whose tags should be displayed.'),
5519
RegistryOption('sort',
5401
5520
'Sort tags by different criteria.', title='Sorting',
5402
alpha='Sort tags lexicographically (default).',
5403
time='Sort tags chronologically.',
5521
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5409
5527
@display_command
5528
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5529
from bzrlib.tag import tag_sort_methods
5416
5530
branch, relpath = Branch.open_containing(directory)
5418
5532
tags = branch.tags.get_tag_dict().items()
5423
self.add_cleanup(branch.unlock)
5536
self.add_cleanup(branch.lock_read().unlock)
5425
5538
graph = branch.repository.get_graph()
5426
5539
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5428
5541
# only show revisions between revid1 and revid2 (inclusive)
5429
5542
tags = [(tag, revid) for tag, revid in tags if
5430
5543
graph.is_between(revid, revid1, revid2)]
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]])
5545
sort = tag_sort_methods.get()
5444
5547
if not show_ids:
5445
5548
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5446
5549
for index, (tag, revid) in enumerate(tags):
5584
5688
def run(self, to_location=None, force=False, create_branch=False,
5689
revision=None, directory=u'.'):
5586
5690
from bzrlib import switch
5691
tree_location = directory
5588
5692
revision = _get_one_revision('switch', revision)
5589
5693
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5590
5694
if to_location is None:
5591
5695
if revision is None:
5592
5696
raise errors.BzrCommandError('You must supply either a'
5593
5697
' revision or a location')
5698
to_location = tree_location
5596
5700
branch = control_dir.open_branch()
5597
5701
had_explicit_nick = branch.get_config().has_explicit_nickname()
5868
5973
You can put multiple items on the shelf, and by default, 'unshelve' will
5869
5974
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.
5872
5989
takes_args = ['file*']
5874
5991
takes_options = [
5876
5994
Option('all', help='Shelve all changes.'),
5883
6001
Option('destroy',
5884
6002
help='Destroy removed changes instead of shelving them.'),
5886
_see_also = ['unshelve']
6004
_see_also = ['unshelve', 'configuration']
5888
6006
def run(self, revision=None, all=False, file_list=None, message=None,
5889
writer=None, list=False, destroy=False):
6007
writer=None, list=False, destroy=False, directory=None):
5891
return self.run_for_list()
6009
return self.run_for_list(directory=directory)
5892
6010
from bzrlib.shelf_ui import Shelver
5893
6011
if writer is None:
5894
6012
writer = bzrlib.option.diff_writer_registry.get()
5896
6014
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5897
file_list, message, destroy=destroy)
6015
file_list, message, destroy=destroy, directory=directory)
5967
6087
To check what clean-tree will do, use --dry-run.
5969
takes_options = [Option('ignored', help='Delete all ignored files.'),
5970
Option('detritus', help='Delete conflict files, merge'
6089
takes_options = ['directory',
6090
Option('ignored', help='Delete all ignored files.'),
6091
Option('detritus', help='Delete conflict files, merge and revert'
5971
6092
' backups, and failed selftest dirs.'),
5972
6093
Option('unknown',
5973
6094
help='Delete files unknown to bzr (default).'),
5975
6096
' deleting them.'),
5976
6097
Option('force', help='Do not prompt before deleting.')]
5977
6098
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6099
force=False, directory=u'.'):
5979
6100
from bzrlib.clean_tree import clean_tree
5980
6101
if not (unknown or ignored or detritus):
5984
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5985
dry_run=dry_run, no_prompt=force)
6105
clean_tree(directory, unknown=unknown, ignored=ignored,
6106
detritus=detritus, dry_run=dry_run, no_prompt=force)
5988
6109
class cmd_reference(Command):
6037
6158
# be only called once.
6038
6159
for (name, aliases, module_name) in [
6039
6160
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6161
('cmd_config', [], 'bzrlib.config'),
6040
6162
('cmd_dpush', [], 'bzrlib.foreign'),
6041
6163
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6042
6164
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6043
6165
('cmd_conflicts', [], 'bzrlib.conflicts'),
6044
6166
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6167
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6046
6169
builtin_command_registry.register_lazy(name, aliases, module_name)