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:
482
511
d.destroy_workingtree()
485
class cmd_repair_workingtree(Command):
486
__doc__ = """Reset the working tree state file.
488
This is not meant to be used normally, but more as a way to recover from
489
filesystem corruption, etc. This rebuilds the working inventory back to a
490
'known good' state. Any new modifications (adding a file, renaming, etc)
491
will be lost, though modified files will still be detected as such.
493
Most users will want something more like "bzr revert" or "bzr update"
494
unless the state file has become corrupted.
496
By default this attempts to recover the current state by looking at the
497
headers of the state file. If the state file is too corrupted to even do
498
that, you can supply --revision to force the state of the tree.
501
takes_options = ['revision', 'directory',
503
help='Reset the tree even if it doesn\'t appear to be'
508
def run(self, revision=None, directory='.', force=False):
509
tree, _ = WorkingTree.open_containing(directory)
510
self.add_cleanup(tree.lock_tree_write().unlock)
514
except errors.BzrError:
515
pass # There seems to be a real error here, so we'll reset
518
raise errors.BzrCommandError(
519
'The tree does not appear to be corrupt. You probably'
520
' want "bzr revert" instead. Use "--force" if you are'
521
' sure you want to reset the working tree.')
525
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
527
tree.reset_state(revision_ids)
528
except errors.BzrError, e:
529
if revision_ids is None:
530
extra = (', the header appears corrupt, try passing -r -1'
531
' to set the state to the last commit')
534
raise errors.BzrCommandError('failed to reset the tree state'
538
514
class cmd_revno(Command):
539
515
__doc__ = """Show current revision number.
775
759
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
777
761
revision = _get_one_revision('inventory', revision)
778
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
779
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)
780
765
if revision is not None:
781
766
tree = revision.as_tree(work_tree.branch)
783
768
extra_trees = [work_tree]
784
self.add_cleanup(tree.lock_read().unlock)
770
self.add_cleanup(tree.unlock)
847
833
if len(names_list) < 2:
848
834
raise errors.BzrCommandError("missing file argument")
849
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
850
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)
851
838
self._run(tree, names_list, rel_names, after)
853
840
def run_auto(self, names_list, after, dry_run):
858
845
raise errors.BzrCommandError('--after cannot be specified with'
860
work_tree, file_list = WorkingTree.open_containing_paths(
861
names_list, default_directory='.')
862
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)
863
850
rename_map.RenameMap.guess_renames(work_tree, dry_run)
865
852
def _run(self, tree, names_list, rel_names, after):
973
960
takes_options = ['remember', 'overwrite', 'revision',
974
961
custom_help('verbose',
975
962
help='Show logs of pulled revisions.'),
976
custom_help('directory',
977
964
help='Branch to pull into, '
978
'rather than the one containing the working directory.'),
965
'rather than the one containing the working directory.',
980
970
help="Perform a local pull in a bound "
981
971
"branch. Local pulls are not applied to "
982
972
"the master branch."
985
help="Show base revision text in conflicts.")
987
975
takes_args = ['location?']
988
976
encoding_type = 'replace'
990
978
def run(self, location=None, remember=False, overwrite=False,
991
979
revision=None, verbose=False,
992
directory=None, local=False,
980
directory=None, local=False):
994
981
# FIXME: too much stuff is in the command class
995
982
revision_id = None
1000
987
tree_to = WorkingTree.open_containing(directory)[0]
1001
988
branch_to = tree_to.branch
1002
self.add_cleanup(tree_to.lock_write().unlock)
990
self.add_cleanup(tree_to.unlock)
1003
991
except errors.NoWorkingTree:
1005
993
branch_to = Branch.open_containing(directory)[0]
1006
self.add_cleanup(branch_to.lock_write().unlock)
1008
if tree_to is None and show_base:
1009
raise errors.BzrCommandError("Need working tree for --show-base.")
994
branch_to.lock_write()
995
self.add_cleanup(branch_to.unlock)
1011
997
if local and not branch_to.get_bound_location():
1012
998
raise errors.LocalRequiresBoundBranch()
1106
1088
Option('create-prefix',
1107
1089
help='Create the path leading up to the branch '
1108
1090
'if it does not already exist.'),
1109
custom_help('directory',
1110
1092
help='Branch to push from, '
1111
'rather than the one containing the working directory.'),
1093
'rather than the one containing the working directory.',
1112
1097
Option('use-existing-dir',
1113
1098
help='By default push will fail if the target'
1114
1099
' directory exists, but does not already'
1135
1117
def run(self, location=None, remember=False, overwrite=False,
1136
1118
create_prefix=False, verbose=False, revision=None,
1137
1119
use_existing_dir=False, directory=None, stacked_on=None,
1138
stacked=False, strict=None, no_tree=False):
1120
stacked=False, strict=None):
1139
1121
from bzrlib.push import _show_push_branch
1141
1123
if directory is None:
1187
1169
_show_push_branch(br_from, revision_id, location, self.outf,
1188
1170
verbose=verbose, overwrite=overwrite, remember=remember,
1189
1171
stacked_on=stacked_on, create_prefix=create_prefix,
1190
use_existing_dir=use_existing_dir, no_tree=no_tree)
1172
use_existing_dir=use_existing_dir)
1193
1175
class cmd_branch(Command):
1207
1189
_see_also = ['checkout']
1208
1190
takes_args = ['from_location', 'to_location?']
1209
takes_options = ['revision',
1210
Option('hardlink', help='Hard-link working tree files where possible.'),
1211
Option('files-from', type=str,
1212
help="Get file contents from this tree."),
1191
takes_options = ['revision', Option('hardlink',
1192
help='Hard-link working tree files where possible.'),
1213
1193
Option('no-tree',
1214
1194
help="Create a branch without a working-tree."),
1215
1195
Option('switch',
1234
1214
def run(self, from_location, to_location=None, revision=None,
1235
1215
hardlink=False, stacked=False, standalone=False, no_tree=False,
1236
use_existing_dir=False, switch=False, bind=False,
1216
use_existing_dir=False, switch=False, bind=False):
1238
1217
from bzrlib import switch as _mod_switch
1239
1218
from bzrlib.tag import _merge_tags_if_possible
1240
1219
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1242
if not (hardlink or files_from):
1243
# accelerator_tree is usually slower because you have to read N
1244
# files (no readahead, lots of seeks, etc), but allow the user to
1245
# explicitly request it
1246
accelerator_tree = None
1247
if files_from is not None and files_from != from_location:
1248
accelerator_tree = WorkingTree.open(files_from)
1249
1221
revision = _get_one_revision('branch', revision)
1250
self.add_cleanup(br_from.lock_read().unlock)
1223
self.add_cleanup(br_from.unlock)
1251
1224
if revision is not None:
1252
1225
revision_id = revision.as_revision_id(br_from)
1358
1331
to_location = branch_location
1359
1332
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1360
1333
branch_location)
1361
if not (hardlink or files_from):
1362
# accelerator_tree is usually slower because you have to read N
1363
# files (no readahead, lots of seeks, etc), but allow the user to
1364
# explicitly request it
1365
accelerator_tree = None
1366
1334
revision = _get_one_revision('checkout', revision)
1367
if files_from is not None and files_from != branch_location:
1335
if files_from is not None:
1368
1336
accelerator_tree = WorkingTree.open(files_from)
1369
1337
if revision is not None:
1370
1338
revision_id = revision.as_revision_id(source)
1426
1396
If you want to discard your local changes, you can just do a
1427
1397
'bzr revert' instead of 'bzr commit' after the update.
1429
If you want to restore a file that has been removed locally, use
1430
'bzr revert' instead of 'bzr update'.
1432
1399
If the tree's branch is bound to a master branch, it will also update
1433
1400
the branch from the master.
1436
1403
_see_also = ['pull', 'working-trees', 'status-flags']
1437
1404
takes_args = ['dir?']
1438
takes_options = ['revision',
1440
help="Show base revision text in conflicts."),
1405
takes_options = ['revision']
1442
1406
aliases = ['up']
1444
def run(self, dir='.', revision=None, show_base=None):
1408
def run(self, dir='.', revision=None):
1445
1409
if revision is not None and len(revision) != 1:
1446
1410
raise errors.BzrCommandError(
1447
1411
"bzr update --revision takes exactly one revision")
1556
1519
class cmd_remove(Command):
1557
1520
__doc__ = """Remove files or directories.
1559
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1560
delete them if they can easily be recovered using revert otherwise they
1561
will be backed up (adding an extention of the form .~#~). If no options or
1562
parameters are given Bazaar will scan for files that are being tracked by
1563
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.
1565
1527
takes_args = ['file*']
1566
1528
takes_options = ['verbose',
1568
1530
RegistryOption.from_kwargs('file-deletion-strategy',
1569
1531
'The file deletion mode to be used.',
1570
1532
title='Deletion Strategy', value_switches=True, enum_switch=False,
1571
safe='Backup changed files (default).',
1533
safe='Only delete files if they can be'
1534
' safely recovered (default).',
1572
1535
keep='Delete from bzr but leave the working copy.',
1573
no_backup='Don\'t backup changed files.',
1574
1536
force='Delete all the specified files, even if they can not be '
1575
'recovered and even if they are non-empty directories. '
1576
'(deprecated, use no-backup)')]
1537
'recovered and even if they are non-empty directories.')]
1577
1538
aliases = ['rm', 'del']
1578
1539
encoding_type = 'replace'
1580
1541
def run(self, file_list, verbose=False, new=False,
1581
1542
file_deletion_strategy='safe'):
1582
if file_deletion_strategy == 'force':
1583
note("(The --force option is deprecated, rather use --no-backup "
1585
file_deletion_strategy = 'no-backup'
1587
tree, file_list = WorkingTree.open_containing_paths(file_list)
1543
tree, file_list = tree_files(file_list)
1589
1545
if file_list is not None:
1590
1546
file_list = [f for f in file_list]
1592
self.add_cleanup(tree.lock_write().unlock)
1549
self.add_cleanup(tree.unlock)
1593
1550
# Heuristics should probably all move into tree.remove_smart or
1679
1636
_see_also = ['check']
1680
1637
takes_args = ['branch?']
1682
Option('canonicalize-chks',
1683
help='Make sure CHKs are in canonical form (repairs '
1688
def run(self, branch=".", canonicalize_chks=False):
1639
def run(self, branch="."):
1689
1640
from bzrlib.reconcile import reconcile
1690
1641
dir = bzrdir.BzrDir.open(branch)
1691
reconcile(dir, canonicalize_chks=canonicalize_chks)
1694
1645
class cmd_revision_history(Command):
1772
1723
Option('append-revisions-only',
1773
1724
help='Never change revnos or the existing log.'
1774
' Append revisions to it only.'),
1776
'Create a branch without a working tree.')
1725
' Append revisions to it only.')
1778
1727
def run(self, location=None, format=None, append_revisions_only=False,
1779
create_prefix=False, no_tree=False):
1728
create_prefix=False):
1780
1729
if format is None:
1781
1730
format = bzrdir.format_registry.make_bzrdir('default')
1782
1731
if location is None:
2059
1985
old_branch, new_branch,
2060
1986
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2061
1987
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2062
# GNU diff on Windows uses ANSI encoding for filenames
2063
path_encoding = osutils.get_diff_header_encoding()
2064
1988
return show_diff_trees(old_tree, new_tree, sys.stdout,
2065
1989
specific_files=specific_files,
2066
1990
external_diff_options=diff_options,
2067
1991
old_label=old_label, new_label=new_label,
2068
extra_trees=extra_trees,
2069
path_encoding=path_encoding,
1992
extra_trees=extra_trees, using=using,
2071
1993
format_cls=format)
2081
2003
# level of effort but possibly much less IO. (Or possibly not,
2082
2004
# if the directories are very large...)
2083
2005
_see_also = ['status', 'ls']
2084
takes_options = ['directory', 'show-ids']
2006
takes_options = ['show-ids']
2086
2008
@display_command
2087
def run(self, show_ids=False, directory=u'.'):
2088
tree = WorkingTree.open_containing(directory)[0]
2089
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)
2090
2013
old = tree.basis_tree()
2091
self.add_cleanup(old.lock_read().unlock)
2015
self.add_cleanup(old.unlock)
2092
2016
for path, ie in old.inventory.iter_entries():
2093
2017
if not tree.has_id(ie.file_id):
2094
2018
self.outf.write(path)
2106
2030
_see_also = ['status', 'ls']
2107
takes_options = ['directory', 'null']
2033
help='Write an ascii NUL (\\0) separator '
2034
'between files rather than a newline.')
2109
2037
@display_command
2110
def run(self, null=False, directory=u'.'):
2111
tree = WorkingTree.open_containing(directory)[0]
2112
self.add_cleanup(tree.lock_read().unlock)
2038
def run(self, null=False):
2039
tree = WorkingTree.open_containing(u'.')[0]
2113
2040
td = tree.changes_from(tree.basis_tree())
2115
2041
for path, id, kind, text_modified, meta_modified in td.modified:
2117
2043
self.outf.write(path + '\0')
2127
2053
_see_also = ['status', 'ls']
2128
takes_options = ['directory', 'null']
2056
help='Write an ascii NUL (\\0) separator '
2057
'between files rather than a newline.')
2130
2060
@display_command
2131
def run(self, null=False, directory=u'.'):
2132
wt = WorkingTree.open_containing(directory)[0]
2133
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)
2134
2065
basis = wt.basis_tree()
2135
self.add_cleanup(basis.lock_read().unlock)
2067
self.add_cleanup(basis.unlock)
2136
2068
basis_inv = basis.inventory
2137
2069
inv = wt.inventory
2138
2070
for file_id in inv:
2600
2528
help='Recurse into subdirectories.'),
2601
2529
Option('from-root',
2602
2530
help='Print paths relative to the root of the branch.'),
2603
Option('unknown', short_name='u',
2604
help='Print unknown files.'),
2531
Option('unknown', help='Print unknown files.'),
2605
2532
Option('versioned', help='Print versioned files.',
2606
2533
short_name='V'),
2607
Option('ignored', short_name='i',
2608
help='Print ignored files.'),
2609
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.'),
2610
2539
help='List entries of a particular kind: file, directory, symlink.',
2616
2543
@display_command
2617
2544
def run(self, revision=None, verbose=False,
2618
2545
recursive=False, from_root=False,
2619
2546
unknown=False, versioned=False, ignored=False,
2620
null=False, kind=None, show_ids=False, path=None, directory=None):
2547
null=False, kind=None, show_ids=False, path=None):
2622
2549
if kind and kind not in ('file', 'directory', 'symlink'):
2623
2550
raise errors.BzrCommandError('invalid kind specified')
2795
2713
_see_also = ['status', 'ignored', 'patterns']
2796
2714
takes_args = ['name_pattern*']
2797
takes_options = ['directory',
2798
2716
Option('default-rules',
2799
2717
help='Display the default ignore rules that bzr uses.')
2802
def run(self, name_pattern_list=None, default_rules=None,
2720
def run(self, name_pattern_list=None, default_rules=None):
2804
2721
from bzrlib import ignores
2805
2722
if default_rules is not None:
2806
2723
# dump the default rules and exit
2812
2729
"NAME_PATTERN or --default-rules.")
2813
2730
name_pattern_list = [globbing.normalize_pattern(p)
2814
2731
for p in name_pattern_list]
2816
for p in name_pattern_list:
2817
if not globbing.Globster.is_pattern_valid(p):
2818
bad_patterns += ('\n %s' % p)
2820
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2821
ui.ui_factory.show_error(msg)
2822
raise errors.InvalidPattern('')
2823
2732
for name_pattern in name_pattern_list:
2824
2733
if (name_pattern[0] == '/' or
2825
2734
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2826
2735
raise errors.BzrCommandError(
2827
2736
"NAME_PATTERN should not be an absolute path")
2828
tree, relpath = WorkingTree.open_containing(directory)
2737
tree, relpath = WorkingTree.open_containing(u'.')
2829
2738
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2830
2739
ignored = globbing.Globster(name_pattern_list)
2832
self.add_cleanup(tree.lock_read().unlock)
2833
2742
for entry in tree.list_files():
2835
2744
if id is not None:
2836
2745
filename = entry[0]
2837
2746
if ignored.match(filename):
2838
2747
matches.append(filename)
2839
2749
if len(matches) > 0:
2840
2750
self.outf.write("Warning: the following files are version controlled and"
2841
2751
" match your ignore pattern:\n%s"
2857
2767
encoding_type = 'replace'
2858
2768
_see_also = ['ignore', 'ls']
2859
takes_options = ['directory']
2861
2770
@display_command
2862
def run(self, directory=u'.'):
2863
tree = WorkingTree.open_containing(directory)[0]
2864
self.add_cleanup(tree.lock_read().unlock)
2772
tree = WorkingTree.open_containing(u'.')[0]
2774
self.add_cleanup(tree.unlock)
2865
2775
for path, file_class, kind, file_id, entry in tree.list_files():
2866
2776
if file_class != 'I':
2935
2844
'revision in which it was changed.'),
2937
2846
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2938
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2847
root=None, filters=False, per_file_timestamps=False):
2939
2848
from bzrlib.export import export
2941
2850
if branch_or_subdir is None:
2942
tree = WorkingTree.open_containing(directory)[0]
2851
tree = WorkingTree.open_containing(u'.')[0]
2943
2852
b = tree.branch
2976
2885
@display_command
2977
2886
def run(self, filename, revision=None, name_from_revision=False,
2978
filters=False, directory=None):
2979
2888
if revision is not None and len(revision) != 1:
2980
2889
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2981
2890
" one revision specifier")
2982
2891
tree, branch, relpath = \
2983
_open_directory_or_containing_tree_or_branch(filename, directory)
2984
self.add_cleanup(branch.lock_read().unlock)
2892
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2894
self.add_cleanup(branch.unlock)
2985
2895
return self._run(tree, branch, relpath, filename, revision,
2986
2896
name_from_revision, filters)
3389
3297
class cmd_upgrade(Command):
3390
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3392
When the default format has changed after a major new release of
3393
Bazaar, you may be informed during certain operations that you
3394
should upgrade. Upgrading to a newer format may improve performance
3395
or make new features available. It may however limit interoperability
3396
with older repositories or with older versions of Bazaar.
3398
If you wish to upgrade to a particular format rather than the
3399
current default, that can be specified using the --format option.
3400
As a consequence, you can use the upgrade command this way to
3401
"downgrade" to an earlier format, though some conversions are
3402
a one way process (e.g. changing from the 1.x default to the
3403
2.x default) so downgrading is not always possible.
3405
A backup.bzr.~#~ directory is created at the start of the conversion
3406
process (where # is a number). By default, this is left there on
3407
completion. If the conversion fails, delete the new .bzr directory
3408
and rename this one back in its place. Use the --clean option to ask
3409
for the backup.bzr directory to be removed on successful conversion.
3410
Alternatively, you can delete it by hand if everything looks good
3413
If the location given is a shared repository, dependent branches
3414
are also converted provided the repository converts successfully.
3415
If the conversion of a branch fails, remaining branches are still
3418
For more information on upgrades, see the Bazaar Upgrade Guide,
3419
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.
3422
_see_also = ['check', 'reconcile', 'formats']
3305
_see_also = ['check']
3423
3306
takes_args = ['url?']
3424
3307
takes_options = [
3425
RegistryOption('format',
3426
help='Upgrade to a specific format. See "bzr help'
3427
' formats" for details.',
3428
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3429
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3430
value_switches=True, title='Branch format'),
3432
help='Remove the backup.bzr directory if successful.'),
3434
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'),
3437
def run(self, url='.', format=None, clean=False, dry_run=False):
3316
def run(self, url='.', format=None):
3438
3317
from bzrlib.upgrade import upgrade
3439
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3441
if len(exceptions) == 1:
3442
# Compatibility with historical behavior
3318
upgrade(url, format)
3448
3321
class cmd_whoami(Command):
3468
3340
encoding_type = 'replace'
3470
3342
@display_command
3471
def run(self, email=False, branch=False, name=None, directory=None):
3343
def run(self, email=False, branch=False, name=None):
3472
3344
if name is None:
3473
if directory is None:
3474
# use branch if we're inside one; otherwise global config
3476
c = Branch.open_containing(u'.')[0].get_config()
3477
except errors.NotBranchError:
3478
c = _mod_config.GlobalConfig()
3480
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()
3482
3351
self.outf.write(c.user_email() + '\n')
3484
3353
self.outf.write(c.username() + '\n')
3488
raise errors.BzrCommandError("--email can only be used to display existing "
3491
3356
# display a warning if an email address isn't included in the given name.
3493
_mod_config.extract_email_address(name)
3358
config.extract_email_address(name)
3494
3359
except errors.NoEmailInUsername, e:
3495
3360
warning('"%s" does not seem to contain an email address. '
3496
3361
'This is allowed, but not recommended.', name)
3498
3363
# use global config unless --branch given
3500
if directory is None:
3501
c = Branch.open_containing(u'.')[0].get_config()
3503
c = Branch.open(directory).get_config()
3365
c = Branch.open_containing('.')[0].get_config()
3505
c = _mod_config.GlobalConfig()
3367
c = config.GlobalConfig()
3506
3368
c.set_user_option('email', name)
3575
3436
'bzr alias --remove expects an alias to remove.')
3576
3437
# If alias is not found, print something like:
3577
3438
# unalias: foo: not found
3578
c = _mod_config.GlobalConfig()
3439
c = config.GlobalConfig()
3579
3440
c.unset_alias(alias_name)
3581
3442
@display_command
3582
3443
def print_aliases(self):
3583
3444
"""Print out the defined aliases in a similar format to bash."""
3584
aliases = _mod_config.GlobalConfig().get_aliases()
3445
aliases = config.GlobalConfig().get_aliases()
3585
3446
for key, value in sorted(aliases.iteritems()):
3586
3447
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3679
3537
'throughout the test suite.',
3680
3538
type=get_transport_type),
3681
3539
Option('benchmark',
3682
help='Run the benchmarks rather than selftests.',
3540
help='Run the benchmarks rather than selftests.'),
3684
3541
Option('lsprof-timed',
3685
3542
help='Generate lsprof output for benchmarked'
3686
3543
' sections of code.'),
3687
3544
Option('lsprof-tests',
3688
3545
help='Generate lsprof output for each test.'),
3546
Option('cache-dir', type=str,
3547
help='Cache intermediate benchmark output in this '
3689
3549
Option('first',
3690
3550
help='Run all tests, but run specified tests first.',
3691
3551
short_name='f',
3726
3586
def run(self, testspecs_list=None, verbose=False, one=False,
3727
3587
transport=None, benchmark=None,
3588
lsprof_timed=None, cache_dir=None,
3729
3589
first=False, list_only=False,
3730
3590
randomize=None, exclude=None, strict=False,
3731
3591
load_list=None, debugflag=None, starting_with=None, subunit=False,
3732
3592
parallel=None, lsprof_tests=False):
3733
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)
3735
3602
if testspecs_list is not None:
3736
3603
pattern = '|'.join(testspecs_list)
3745
3612
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3746
3613
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3747
3614
# stdout, which would corrupt the subunit stream.
3748
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3749
# following code can be deleted when it's sufficiently deployed
3750
# -- vila/mgz 20100514
3751
if (sys.platform == "win32"
3752
and getattr(sys.stdout, 'fileno', None) is not None):
3615
if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3754
3617
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3756
3619
self.additional_selftest_args.setdefault(
3757
3620
'suite_decorators', []).append(parallel)
3759
raise errors.BzrCommandError(
3760
"--benchmark is no longer supported from bzr 2.2; "
3761
"use bzr-usertest instead")
3762
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
3763
3631
selftest_kwargs = {"verbose": verbose,
3764
3632
"pattern": pattern,
3765
3633
"stop_on_failure": one,
3847
3711
with bzr send. If neither is specified, the default is the upstream branch
3848
3712
or the branch most recently merged using --remember.
3850
When merging from a branch, by default bzr will try to merge in all new
3851
work from the other branch, automatically determining an appropriate base
3852
revision. If this fails, you may need to give an explicit base.
3854
To pick a different ending revision, pass "--revision OTHER". bzr will
3855
try to merge in all new work up to and including revision OTHER.
3857
If you specify two values, "--revision BASE..OTHER", only revisions BASE
3858
through OTHER, excluding BASE but including OTHER, will be merged. If this
3859
causes some revisions to be skipped, i.e. if the destination branch does
3860
not already contain revision BASE, such a merge is commonly referred to as
3863
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.
3865
3725
Merge will do its best to combine the changes in two branches, but there
3866
3726
are some kinds of problems only a human can fix. When it encounters those,
3933
3793
' completely merged into the source, pull from the'
3934
3794
' source rather than merging. When this happens,'
3935
3795
' you do not need to commit the result.'),
3936
custom_help('directory',
3937
3797
help='Branch to merge into, '
3938
'rather than the one containing the working directory.'),
3798
'rather than the one containing the working directory.',
3939
3802
Option('preview', help='Instead of merging, show a diff of the'
3941
3804
Option('interactive', help='Select changes interactively.',
4041
3905
def _do_preview(self, merger):
4042
3906
from bzrlib.diff import show_diff_trees
4043
3907
result_tree = self._get_preview(merger)
4044
path_encoding = osutils.get_diff_header_encoding()
4045
3908
show_diff_trees(merger.this_tree, result_tree, self.outf,
4046
old_label='', new_label='',
4047
path_encoding=path_encoding)
3909
old_label='', new_label='')
4049
3911
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4050
3912
merger.change_reporter = change_reporter
4130
3992
if ((remember or tree.branch.get_submit_branch() is None) and
4131
3993
user_location is not None):
4132
3994
tree.branch.set_submit_branch(other_branch.base)
4133
# Merge tags (but don't set them in the master branch yet, the user
4134
# might revert this merge). Commit will propagate them.
4135
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
3995
_merge_tags_if_possible(other_branch, tree.branch)
4136
3996
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4137
3997
other_revision_id, base_revision_id, other_branch, base_branch)
4138
3998
if other_path != '':
4306
4167
last committed revision is used.
4308
4169
To remove only some changes, without reverting to a prior version, use
4309
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4310
will remove the changes introduced by the second last commit (-2), without
4311
affecting the changes introduced by the last commit (-1). To remove
4312
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.
4314
4174
By default, any files that have been manually changed will be backed up
4315
4175
first. (Files changed only by merge are not backed up.) Backup files have
4480
4340
theirs_only=False,
4481
4341
log_format=None, long=False, short=False, line=False,
4482
4342
show_ids=False, verbose=False, this=False, other=False,
4483
include_merges=False, revision=None, my_revision=None,
4343
include_merges=False, revision=None, my_revision=None):
4485
4344
from bzrlib.missing import find_unmerged, iter_log_revisions
4486
4345
def message(s):
4487
4346
if not is_quiet():
4645
4507
@display_command
4646
4508
def run(self, verbose=False):
4647
from bzrlib import plugin
4648
self.outf.writelines(
4649
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")
4652
4531
class cmd_testament(Command):
4698
4578
Option('long', help='Show commit date in annotations.'),
4703
4582
encoding_type = 'exact'
4705
4584
@display_command
4706
4585
def run(self, filename, all=False, long=False, revision=None,
4707
show_ids=False, directory=None):
4708
4587
from bzrlib.annotate import annotate_file, annotate_file_tree
4709
4588
wt, branch, relpath = \
4710
_open_directory_or_containing_tree_or_branch(filename, directory)
4589
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4711
4590
if wt is not None:
4712
self.add_cleanup(wt.lock_read().unlock)
4592
self.add_cleanup(wt.unlock)
4714
self.add_cleanup(branch.lock_read().unlock)
4595
self.add_cleanup(branch.unlock)
4715
4596
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4716
self.add_cleanup(tree.lock_read().unlock)
4598
self.add_cleanup(tree.unlock)
4717
4599
if wt is not None:
4718
4600
file_id = wt.path2id(relpath)
4738
4620
hidden = True # is this right ?
4739
4621
takes_args = ['revision_id*']
4740
takes_options = ['directory', 'revision']
4622
takes_options = ['revision']
4742
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4624
def run(self, revision_id_list=None, revision=None):
4743
4625
if revision_id_list is not None and revision is not None:
4744
4626
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4745
4627
if revision_id_list is None and revision is None:
4746
4628
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4747
b = WorkingTree.open_containing(directory)[0].branch
4748
self.add_cleanup(b.lock_write().unlock)
4629
b = WorkingTree.open_containing(u'.')[0].branch
4631
self.add_cleanup(b.unlock)
4749
4632
return self._run(b, revision_id_list, revision)
4751
4634
def _run(self, b, revision_id_list, revision):
4811
4694
_see_also = ['checkouts', 'unbind']
4812
4695
takes_args = ['location?']
4813
takes_options = ['directory']
4815
def run(self, location=None, directory=u'.'):
4816
b, relpath = Branch.open_containing(directory)
4698
def run(self, location=None):
4699
b, relpath = Branch.open_containing(u'.')
4817
4700
if location is None:
4819
4702
location = b.get_old_bound_location()
4901
4784
b = control.open_branch()
4903
4786
if tree is not None:
4904
self.add_cleanup(tree.lock_write().unlock)
4788
self.add_cleanup(tree.unlock)
4906
self.add_cleanup(b.lock_write().unlock)
4791
self.add_cleanup(b.unlock)
4907
4792
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4909
4794
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4980
4859
bzr break-lock bzr+ssh://example.com/bzr/foo
4981
bzr break-lock --conf ~/.bazaar
4984
4861
takes_args = ['location?']
4987
help='LOCATION is the directory where the config lock is.'),
4989
help='Do not ask for confirmation before breaking the lock.'),
4992
def run(self, location=None, config=False, force=False):
4863
def run(self, location=None, show=False):
4993
4864
if location is None:
4994
4865
location = u'.'
4996
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
4998
{'bzrlib.lockdir.break': True})
5000
conf = _mod_config.LockableConfig(file_name=location)
5003
control, relpath = bzrdir.BzrDir.open_containing(location)
5005
control.break_lock()
5006
except NotImplementedError:
4866
control, relpath = bzrdir.BzrDir.open_containing(location)
4868
control.break_lock()
4869
except NotImplementedError:
5010
4873
class cmd_wait_until_signalled(Command):
5074
4938
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5075
4939
protocol=None):
5076
from bzrlib import transport
4940
from bzrlib.transport import get_transport, transport_server_registry
5077
4941
if directory is None:
5078
4942
directory = os.getcwd()
5079
4943
if protocol is None:
5080
protocol = transport.transport_server_registry.get()
4944
protocol = transport_server_registry.get()
5081
4945
host, port = self.get_host_and_port(port)
5082
4946
url = urlutils.local_path_to_url(directory)
5083
4947
if not allow_writes:
5084
4948
url = 'readonly+' + url
5085
t = transport.get_transport(url)
5086
protocol(t, host, port, inet)
4949
transport = get_transport(url)
4950
protocol(transport, host, port, inet)
5089
4953
class cmd_join(Command):
5201
5064
encoding_type = 'exact'
5203
5066
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5204
sign=False, revision=None, mail_to=None, message=None,
5067
sign=False, revision=None, mail_to=None, message=None):
5206
5068
from bzrlib.revision import ensure_null, NULL_REVISION
5207
5069
include_patch, include_bundle = {
5208
5070
'plain': (False, False),
5209
5071
'diff': (True, False),
5210
5072
'bundle': (True, True),
5212
branch = Branch.open(directory)
5074
branch = Branch.open('.')
5213
5075
stored_submit_branch = branch.get_submit_branch()
5214
5076
if submit_branch is None:
5215
5077
submit_branch = stored_submit_branch
5527
5393
_see_also = ['tag']
5528
5394
takes_options = [
5529
custom_help('directory',
5530
help='Branch whose tags should be displayed.'),
5531
RegistryOption('sort',
5396
help='Branch whose tags should be displayed.',
5400
RegistryOption.from_kwargs('sort',
5532
5401
'Sort tags by different criteria.', title='Sorting',
5533
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5402
alpha='Sort tags lexicographically (default).',
5403
time='Sort tags chronologically.',
5539
5409
@display_command
5540
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5541
from bzrlib.tag import tag_sort_methods
5542
5416
branch, relpath = Branch.open_containing(directory)
5544
5418
tags = branch.tags.get_tag_dict().items()
5548
self.add_cleanup(branch.lock_read().unlock)
5423
self.add_cleanup(branch.unlock)
5550
5425
graph = branch.repository.get_graph()
5551
5426
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5553
5428
# only show revisions between revid1 and revid2 (inclusive)
5554
5429
tags = [(tag, revid) for tag, revid in tags if
5555
5430
graph.is_between(revid, revid1, revid2)]
5557
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]])
5559
5444
if not show_ids:
5560
5445
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5561
5446
for index, (tag, revid) in enumerate(tags):
5700
5584
def run(self, to_location=None, force=False, create_branch=False,
5701
revision=None, directory=u'.'):
5702
5586
from bzrlib import switch
5703
tree_location = directory
5704
5588
revision = _get_one_revision('switch', revision)
5705
5589
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5706
5590
if to_location is None:
5707
5591
if revision is None:
5708
5592
raise errors.BzrCommandError('You must supply either a'
5709
5593
' revision or a location')
5710
to_location = tree_location
5712
5596
branch = control_dir.open_branch()
5713
5597
had_explicit_nick = branch.get_config().has_explicit_nickname()
5985
5868
You can put multiple items on the shelf, and by default, 'unshelve' will
5986
5869
restore the most recently shelved changes.
5988
For complicated changes, it is possible to edit the changes in a separate
5989
editor program to decide what the file remaining in the working copy
5990
should look like. To do this, add the configuration option
5992
change_editor = PROGRAM @new_path @old_path
5994
where @new_path is replaced with the path of the new version of the
5995
file and @old_path is replaced with the path of the old version of
5996
the file. The PROGRAM should save the new file with the desired
5997
contents of the file in the working tree.
6001
5872
takes_args = ['file*']
6003
5874
takes_options = [
6006
5876
Option('all', help='Shelve all changes.'),
6013
5883
Option('destroy',
6014
5884
help='Destroy removed changes instead of shelving them.'),
6016
_see_also = ['unshelve', 'configuration']
5886
_see_also = ['unshelve']
6018
5888
def run(self, revision=None, all=False, file_list=None, message=None,
6019
writer=None, list=False, destroy=False, directory=None):
5889
writer=None, list=False, destroy=False):
6021
return self.run_for_list(directory=directory)
5891
return self.run_for_list()
6022
5892
from bzrlib.shelf_ui import Shelver
6023
5893
if writer is None:
6024
5894
writer = bzrlib.option.diff_writer_registry.get()
6026
5896
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6027
file_list, message, destroy=destroy, directory=directory)
5897
file_list, message, destroy=destroy)
6099
5967
To check what clean-tree will do, use --dry-run.
6101
takes_options = ['directory',
6102
Option('ignored', help='Delete all ignored files.'),
5969
takes_options = [Option('ignored', help='Delete all ignored files.'),
6103
5970
Option('detritus', help='Delete conflict files, merge'
6104
5971
' backups, and failed selftest dirs.'),
6105
5972
Option('unknown',
6108
5975
' deleting them.'),
6109
5976
Option('force', help='Do not prompt before deleting.')]
6110
5977
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6111
force=False, directory=u'.'):
6112
5979
from bzrlib.clean_tree import clean_tree
6113
5980
if not (unknown or ignored or detritus):
6117
clean_tree(directory, unknown=unknown, ignored=ignored,
6118
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)
6121
5988
class cmd_reference(Command):
6170
6037
# be only called once.
6171
6038
for (name, aliases, module_name) in [
6172
6039
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6173
('cmd_config', [], 'bzrlib.config'),
6174
6040
('cmd_dpush', [], 'bzrlib.foreign'),
6175
6041
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6176
6042
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6177
6043
('cmd_conflicts', [], 'bzrlib.conflicts'),
6178
6044
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6179
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6181
6046
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
