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
482
d.destroy_workingtree()
485
class cmd_reset_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']
504
def run(self, revision=None):
514
508
class cmd_revno(Command):
515
509
__doc__ = """Show current revision number.
759
745
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
761
747
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)
748
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
749
self.add_cleanup(work_tree.lock_read().unlock)
765
750
if revision is not None:
766
751
tree = revision.as_tree(work_tree.branch)
768
753
extra_trees = [work_tree]
770
self.add_cleanup(tree.unlock)
754
self.add_cleanup(tree.lock_read().unlock)
833
817
if len(names_list) < 2:
834
818
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)
819
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
820
self.add_cleanup(tree.lock_tree_write().unlock)
838
821
self._run(tree, names_list, rel_names, after)
840
823
def run_auto(self, names_list, after, dry_run):
845
828
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)
830
work_tree, file_list = WorkingTree.open_containing_paths(
831
names_list, default_directory='.')
832
self.add_cleanup(work_tree.lock_tree_write().unlock)
850
833
rename_map.RenameMap.guess_renames(work_tree, dry_run)
852
835
def _run(self, tree, names_list, rel_names, after):
960
943
takes_options = ['remember', 'overwrite', 'revision',
961
944
custom_help('verbose',
962
945
help='Show logs of pulled revisions.'),
946
custom_help('directory',
964
947
help='Branch to pull into, '
965
'rather than the one containing the working directory.',
948
'rather than the one containing the working directory.'),
970
950
help="Perform a local pull in a bound "
971
951
"branch. Local pulls are not applied to "
972
952
"the master branch."
955
help="Show base revision text in conflicts.")
975
957
takes_args = ['location?']
976
958
encoding_type = 'replace'
978
960
def run(self, location=None, remember=False, overwrite=False,
979
961
revision=None, verbose=False,
980
directory=None, local=False):
962
directory=None, local=False,
981
964
# FIXME: too much stuff is in the command class
982
965
revision_id = None
987
970
tree_to = WorkingTree.open_containing(directory)[0]
988
971
branch_to = tree_to.branch
990
self.add_cleanup(tree_to.unlock)
972
self.add_cleanup(tree_to.lock_write().unlock)
991
973
except errors.NoWorkingTree:
993
975
branch_to = Branch.open_containing(directory)[0]
994
branch_to.lock_write()
995
self.add_cleanup(branch_to.unlock)
976
self.add_cleanup(branch_to.lock_write().unlock)
978
if tree_to is None and show_base:
979
raise errors.BzrCommandError("Need working tree for --show-base.")
997
981
if local and not branch_to.get_bound_location():
998
982
raise errors.LocalRequiresBoundBranch()
1088
1076
Option('create-prefix',
1089
1077
help='Create the path leading up to the branch '
1090
1078
'if it does not already exist.'),
1079
custom_help('directory',
1092
1080
help='Branch to push from, '
1093
'rather than the one containing the working directory.',
1081
'rather than the one containing the working directory.'),
1097
1082
Option('use-existing-dir',
1098
1083
help='By default push will fail if the target'
1099
1084
' directory exists, but does not already'
1117
1105
def run(self, location=None, remember=False, overwrite=False,
1118
1106
create_prefix=False, verbose=False, revision=None,
1119
1107
use_existing_dir=False, directory=None, stacked_on=None,
1120
stacked=False, strict=None):
1108
stacked=False, strict=None, no_tree=False):
1121
1109
from bzrlib.push import _show_push_branch
1123
1111
if directory is None:
1169
1157
_show_push_branch(br_from, revision_id, location, self.outf,
1170
1158
verbose=verbose, overwrite=overwrite, remember=remember,
1171
1159
stacked_on=stacked_on, create_prefix=create_prefix,
1172
use_existing_dir=use_existing_dir)
1160
use_existing_dir=use_existing_dir, no_tree=no_tree)
1175
1163
class cmd_branch(Command):
1189
1177
_see_also = ['checkout']
1190
1178
takes_args = ['from_location', 'to_location?']
1191
takes_options = ['revision', Option('hardlink',
1192
help='Hard-link working tree files where possible.'),
1179
takes_options = ['revision',
1180
Option('hardlink', help='Hard-link working tree files where possible.'),
1181
Option('files-from', type=str,
1182
help="Get file contents from this tree."),
1193
1183
Option('no-tree',
1194
1184
help="Create a branch without a working-tree."),
1195
1185
Option('switch',
1214
1204
def run(self, from_location, to_location=None, revision=None,
1215
1205
hardlink=False, stacked=False, standalone=False, no_tree=False,
1216
use_existing_dir=False, switch=False, bind=False):
1206
use_existing_dir=False, switch=False, bind=False,
1217
1208
from bzrlib import switch as _mod_switch
1218
1209
from bzrlib.tag import _merge_tags_if_possible
1219
1210
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1212
if not (hardlink or files_from):
1213
# accelerator_tree is usually slower because you have to read N
1214
# files (no readahead, lots of seeks, etc), but allow the user to
1215
# explicitly request it
1216
accelerator_tree = None
1217
if files_from is not None and files_from != from_location:
1218
accelerator_tree = WorkingTree.open(files_from)
1221
1219
revision = _get_one_revision('branch', revision)
1223
self.add_cleanup(br_from.unlock)
1220
self.add_cleanup(br_from.lock_read().unlock)
1224
1221
if revision is not None:
1225
1222
revision_id = revision.as_revision_id(br_from)
1331
1328
to_location = branch_location
1332
1329
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1333
1330
branch_location)
1331
if not (hardlink or files_from):
1332
# accelerator_tree is usually slower because you have to read N
1333
# files (no readahead, lots of seeks, etc), but allow the user to
1334
# explicitly request it
1335
accelerator_tree = None
1334
1336
revision = _get_one_revision('checkout', revision)
1335
if files_from is not None:
1337
if files_from is not None and files_from != branch_location:
1336
1338
accelerator_tree = WorkingTree.open(files_from)
1337
1339
if revision is not None:
1338
1340
revision_id = revision.as_revision_id(source)
1396
1396
If you want to discard your local changes, you can just do a
1397
1397
'bzr revert' instead of 'bzr commit' after the update.
1399
If you want to restore a file that has been removed locally, use
1400
'bzr revert' instead of 'bzr update'.
1399
1402
If the tree's branch is bound to a master branch, it will also update
1400
1403
the branch from the master.
1403
1406
_see_also = ['pull', 'working-trees', 'status-flags']
1404
1407
takes_args = ['dir?']
1405
takes_options = ['revision']
1408
takes_options = ['revision',
1410
help="Show base revision text in conflicts."),
1406
1412
aliases = ['up']
1408
def run(self, dir='.', revision=None):
1414
def run(self, dir='.', revision=None, show_base=None):
1409
1415
if revision is not None and len(revision) != 1:
1410
1416
raise errors.BzrCommandError(
1411
1417
"bzr update --revision takes exactly one revision")
1519
1526
class cmd_remove(Command):
1520
1527
__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.
1529
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1530
delete them if they can easily be recovered using revert otherwise they
1531
will be backed up (adding an extention of the form .~#~). If no options or
1532
parameters are given Bazaar will scan for files that are being tracked by
1533
Bazaar but missing in your tree and stop tracking them for you.
1527
1535
takes_args = ['file*']
1528
1536
takes_options = ['verbose',
1530
1538
RegistryOption.from_kwargs('file-deletion-strategy',
1531
1539
'The file deletion mode to be used.',
1532
1540
title='Deletion Strategy', value_switches=True, enum_switch=False,
1533
safe='Only delete files if they can be'
1534
' safely recovered (default).',
1541
safe='Backup changed files (default).',
1535
1542
keep='Delete from bzr but leave the working copy.',
1543
no_backup='Don\'t backup changed files.',
1536
1544
force='Delete all the specified files, even if they can not be '
1537
'recovered and even if they are non-empty directories.')]
1545
'recovered and even if they are non-empty directories. '
1546
'(deprecated, use no-backup)')]
1538
1547
aliases = ['rm', 'del']
1539
1548
encoding_type = 'replace'
1541
1550
def run(self, file_list, verbose=False, new=False,
1542
1551
file_deletion_strategy='safe'):
1543
tree, file_list = tree_files(file_list)
1552
if file_deletion_strategy == 'force':
1553
note("(The --force option is deprecated, rather use --no-backup "
1555
file_deletion_strategy = 'no-backup'
1557
tree, file_list = WorkingTree.open_containing_paths(file_list)
1545
1559
if file_list is not None:
1546
1560
file_list = [f for f in file_list]
1549
self.add_cleanup(tree.unlock)
1562
self.add_cleanup(tree.lock_write().unlock)
1550
1563
# Heuristics should probably all move into tree.remove_smart or
1636
1649
_see_also = ['check']
1637
1650
takes_args = ['branch?']
1652
Option('canonicalize-chks',
1653
help='Make sure CHKs are in canonical form (repairs '
1639
def run(self, branch="."):
1658
def run(self, branch=".", canonicalize_chks=False):
1640
1659
from bzrlib.reconcile import reconcile
1641
1660
dir = bzrdir.BzrDir.open(branch)
1661
reconcile(dir, canonicalize_chks=canonicalize_chks)
1645
1664
class cmd_revision_history(Command):
1723
1742
Option('append-revisions-only',
1724
1743
help='Never change revnos or the existing log.'
1725
' Append revisions to it only.')
1744
' Append revisions to it only.'),
1746
'Create a branch without a working tree.')
1727
1748
def run(self, location=None, format=None, append_revisions_only=False,
1728
create_prefix=False):
1749
create_prefix=False, no_tree=False):
1729
1750
if format is None:
1730
1751
format = bzrdir.format_registry.make_bzrdir('default')
1731
1752
if location is None:
1985
2029
old_branch, new_branch,
1986
2030
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
2031
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2032
# GNU diff on Windows uses ANSI encoding for filenames
2033
path_encoding = osutils.get_diff_header_encoding()
1988
2034
return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
2035
specific_files=specific_files,
1990
2036
external_diff_options=diff_options,
1991
2037
old_label=old_label, new_label=new_label,
1992
extra_trees=extra_trees, using=using,
2038
extra_trees=extra_trees,
2039
path_encoding=path_encoding,
1993
2041
format_cls=format)
2003
2051
# level of effort but possibly much less IO. (Or possibly not,
2004
2052
# if the directories are very large...)
2005
2053
_see_also = ['status', 'ls']
2006
takes_options = ['show-ids']
2054
takes_options = ['directory', 'show-ids']
2008
2056
@display_command
2009
def run(self, show_ids=False):
2010
tree = WorkingTree.open_containing(u'.')[0]
2012
self.add_cleanup(tree.unlock)
2057
def run(self, show_ids=False, directory=u'.'):
2058
tree = WorkingTree.open_containing(directory)[0]
2059
self.add_cleanup(tree.lock_read().unlock)
2013
2060
old = tree.basis_tree()
2015
self.add_cleanup(old.unlock)
2061
self.add_cleanup(old.lock_read().unlock)
2016
2062
for path, ie in old.inventory.iter_entries():
2017
2063
if not tree.has_id(ie.file_id):
2018
2064
self.outf.write(path)
2030
2076
_see_also = ['status', 'ls']
2033
help='Write an ascii NUL (\\0) separator '
2034
'between files rather than a newline.')
2077
takes_options = ['directory', 'null']
2037
2079
@display_command
2038
def run(self, null=False):
2039
tree = WorkingTree.open_containing(u'.')[0]
2080
def run(self, null=False, directory=u'.'):
2081
tree = WorkingTree.open_containing(directory)[0]
2082
self.add_cleanup(tree.lock_read().unlock)
2040
2083
td = tree.changes_from(tree.basis_tree())
2041
2085
for path, id, kind, text_modified, meta_modified in td.modified:
2043
2087
self.outf.write(path + '\0')
2053
2097
_see_also = ['status', 'ls']
2056
help='Write an ascii NUL (\\0) separator '
2057
'between files rather than a newline.')
2098
takes_options = ['directory', 'null']
2060
2100
@display_command
2061
def run(self, null=False):
2062
wt = WorkingTree.open_containing(u'.')[0]
2064
self.add_cleanup(wt.unlock)
2101
def run(self, null=False, directory=u'.'):
2102
wt = WorkingTree.open_containing(directory)[0]
2103
self.add_cleanup(wt.lock_read().unlock)
2065
2104
basis = wt.basis_tree()
2067
self.add_cleanup(basis.unlock)
2105
self.add_cleanup(basis.lock_read().unlock)
2068
2106
basis_inv = basis.inventory
2069
2107
inv = wt.inventory
2070
2108
for file_id in inv:
2528
2570
help='Recurse into subdirectories.'),
2529
2571
Option('from-root',
2530
2572
help='Print paths relative to the root of the branch.'),
2531
Option('unknown', help='Print unknown files.'),
2573
Option('unknown', short_name='u',
2574
help='Print unknown files.'),
2532
2575
Option('versioned', help='Print versioned files.',
2533
2576
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.'),
2577
Option('ignored', short_name='i',
2578
help='Print ignored files.'),
2579
Option('kind', short_name='k',
2539
2580
help='List entries of a particular kind: file, directory, symlink.',
2543
2586
@display_command
2544
2587
def run(self, revision=None, verbose=False,
2545
2588
recursive=False, from_root=False,
2546
2589
unknown=False, versioned=False, ignored=False,
2547
null=False, kind=None, show_ids=False, path=None):
2590
null=False, kind=None, show_ids=False, path=None, directory=None):
2549
2592
if kind and kind not in ('file', 'directory', 'symlink'):
2550
2593
raise errors.BzrCommandError('invalid kind specified')
2713
2765
_see_also = ['status', 'ignored', 'patterns']
2714
2766
takes_args = ['name_pattern*']
2767
takes_options = ['directory',
2716
2768
Option('default-rules',
2717
2769
help='Display the default ignore rules that bzr uses.')
2720
def run(self, name_pattern_list=None, default_rules=None):
2772
def run(self, name_pattern_list=None, default_rules=None,
2721
2774
from bzrlib import ignores
2722
2775
if default_rules is not None:
2723
2776
# dump the default rules and exit
2729
2782
"NAME_PATTERN or --default-rules.")
2730
2783
name_pattern_list = [globbing.normalize_pattern(p)
2731
2784
for p in name_pattern_list]
2786
for p in name_pattern_list:
2787
if not globbing.Globster.is_pattern_valid(p):
2788
bad_patterns += ('\n %s' % p)
2790
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2791
ui.ui_factory.show_error(msg)
2792
raise errors.InvalidPattern('')
2732
2793
for name_pattern in name_pattern_list:
2733
2794
if (name_pattern[0] == '/' or
2734
2795
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2735
2796
raise errors.BzrCommandError(
2736
2797
"NAME_PATTERN should not be an absolute path")
2737
tree, relpath = WorkingTree.open_containing(u'.')
2798
tree, relpath = WorkingTree.open_containing(directory)
2738
2799
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2739
2800
ignored = globbing.Globster(name_pattern_list)
2802
self.add_cleanup(tree.lock_read().unlock)
2742
2803
for entry in tree.list_files():
2744
2805
if id is not None:
2745
2806
filename = entry[0]
2746
2807
if ignored.match(filename):
2747
2808
matches.append(filename)
2749
2809
if len(matches) > 0:
2750
2810
self.outf.write("Warning: the following files are version controlled and"
2751
2811
" match your ignore pattern:\n%s"
2767
2827
encoding_type = 'replace'
2768
2828
_see_also = ['ignore', 'ls']
2829
takes_options = ['directory']
2770
2831
@display_command
2772
tree = WorkingTree.open_containing(u'.')[0]
2774
self.add_cleanup(tree.unlock)
2832
def run(self, directory=u'.'):
2833
tree = WorkingTree.open_containing(directory)[0]
2834
self.add_cleanup(tree.lock_read().unlock)
2775
2835
for path, file_class, kind, file_id, entry in tree.list_files():
2776
2836
if file_class != 'I':
2844
2905
'revision in which it was changed.'),
2846
2907
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
root=None, filters=False, per_file_timestamps=False):
2908
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2848
2909
from bzrlib.export import export
2850
2911
if branch_or_subdir is None:
2851
tree = WorkingTree.open_containing(u'.')[0]
2912
tree = WorkingTree.open_containing(directory)[0]
2852
2913
b = tree.branch
2885
2946
@display_command
2886
2947
def run(self, filename, revision=None, name_from_revision=False,
2948
filters=False, directory=None):
2888
2949
if revision is not None and len(revision) != 1:
2889
2950
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2890
2951
" one revision specifier")
2891
2952
tree, branch, relpath = \
2892
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2894
self.add_cleanup(branch.unlock)
2953
_open_directory_or_containing_tree_or_branch(filename, directory)
2954
self.add_cleanup(branch.lock_read().unlock)
2895
2955
return self._run(tree, branch, relpath, filename, revision,
2896
2956
name_from_revision, filters)
3297
3359
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.
3360
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3362
When the default format has changed after a major new release of
3363
Bazaar, you may be informed during certain operations that you
3364
should upgrade. Upgrading to a newer format may improve performance
3365
or make new features available. It may however limit interoperability
3366
with older repositories or with older versions of Bazaar.
3368
If you wish to upgrade to a particular format rather than the
3369
current default, that can be specified using the --format option.
3370
As a consequence, you can use the upgrade command this way to
3371
"downgrade" to an earlier format, though some conversions are
3372
a one way process (e.g. changing from the 1.x default to the
3373
2.x default) so downgrading is not always possible.
3375
A backup.bzr.~#~ directory is created at the start of the conversion
3376
process (where # is a number). By default, this is left there on
3377
completion. If the conversion fails, delete the new .bzr directory
3378
and rename this one back in its place. Use the --clean option to ask
3379
for the backup.bzr directory to be removed on successful conversion.
3380
Alternatively, you can delete it by hand if everything looks good
3383
If the location given is a shared repository, dependent branches
3384
are also converted provided the repository converts successfully.
3385
If the conversion of a branch fails, remaining branches are still
3388
For more information on upgrades, see the Bazaar Upgrade Guide,
3389
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3305
_see_also = ['check']
3392
_see_also = ['check', 'reconcile', 'formats']
3306
3393
takes_args = ['url?']
3307
3394
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'),
3395
RegistryOption('format',
3396
help='Upgrade to a specific format. See "bzr help'
3397
' formats" for details.',
3398
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3399
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3400
value_switches=True, title='Branch format'),
3402
help='Remove the backup.bzr directory if successful.'),
3404
help="Show what would be done, but don't actually do anything."),
3316
def run(self, url='.', format=None):
3407
def run(self, url='.', format=None, clean=False, dry_run=False):
3317
3408
from bzrlib.upgrade import upgrade
3318
upgrade(url, format)
3409
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3411
if len(exceptions) == 1:
3412
# Compatibility with historical behavior
3321
3418
class cmd_whoami(Command):
3340
3438
encoding_type = 'replace'
3342
3440
@display_command
3343
def run(self, email=False, branch=False, name=None):
3441
def run(self, email=False, branch=False, name=None, directory=None):
3344
3442
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()
3443
if directory is None:
3444
# use branch if we're inside one; otherwise global config
3446
c = Branch.open_containing(u'.')[0].get_config()
3447
except errors.NotBranchError:
3448
c = _mod_config.GlobalConfig()
3450
c = Branch.open(directory).get_config()
3351
3452
self.outf.write(c.user_email() + '\n')
3353
3454
self.outf.write(c.username() + '\n')
3458
raise errors.BzrCommandError("--email can only be used to display existing "
3356
3461
# display a warning if an email address isn't included in the given name.
3358
config.extract_email_address(name)
3463
_mod_config.extract_email_address(name)
3359
3464
except errors.NoEmailInUsername, e:
3360
3465
warning('"%s" does not seem to contain an email address. '
3361
3466
'This is allowed, but not recommended.', name)
3363
3468
# use global config unless --branch given
3365
c = Branch.open_containing('.')[0].get_config()
3470
if directory is None:
3471
c = Branch.open_containing(u'.')[0].get_config()
3473
c = Branch.open(directory).get_config()
3367
c = config.GlobalConfig()
3475
c = _mod_config.GlobalConfig()
3368
3476
c.set_user_option('email', name)
3436
3545
'bzr alias --remove expects an alias to remove.')
3437
3546
# If alias is not found, print something like:
3438
3547
# unalias: foo: not found
3439
c = config.GlobalConfig()
3548
c = _mod_config.GlobalConfig()
3440
3549
c.unset_alias(alias_name)
3442
3551
@display_command
3443
3552
def print_aliases(self):
3444
3553
"""Print out the defined aliases in a similar format to bash."""
3445
aliases = config.GlobalConfig().get_aliases()
3554
aliases = _mod_config.GlobalConfig().get_aliases()
3446
3555
for key, value in sorted(aliases.iteritems()):
3447
3556
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3537
3649
'throughout the test suite.',
3538
3650
type=get_transport_type),
3539
3651
Option('benchmark',
3540
help='Run the benchmarks rather than selftests.'),
3652
help='Run the benchmarks rather than selftests.',
3541
3654
Option('lsprof-timed',
3542
3655
help='Generate lsprof output for benchmarked'
3543
3656
' sections of code.'),
3544
3657
Option('lsprof-tests',
3545
3658
help='Generate lsprof output for each test.'),
3546
Option('cache-dir', type=str,
3547
help='Cache intermediate benchmark output in this '
3549
3659
Option('first',
3550
3660
help='Run all tests, but run specified tests first.',
3551
3661
short_name='f',
3586
3696
def run(self, testspecs_list=None, verbose=False, one=False,
3587
3697
transport=None, benchmark=None,
3588
lsprof_timed=None, cache_dir=None,
3589
3699
first=False, list_only=False,
3590
3700
randomize=None, exclude=None, strict=False,
3591
3701
load_list=None, debugflag=None, starting_with=None, subunit=False,
3592
3702
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)
3703
from bzrlib import tests
3602
3705
if testspecs_list is not None:
3603
3706
pattern = '|'.join(testspecs_list)
3612
3715
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3613
3716
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3614
3717
# stdout, which would corrupt the subunit stream.
3615
if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3718
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3719
# following code can be deleted when it's sufficiently deployed
3720
# -- vila/mgz 20100514
3721
if (sys.platform == "win32"
3722
and getattr(sys.stdout, 'fileno', None) is not None):
3617
3724
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3619
3726
self.additional_selftest_args.setdefault(
3620
3727
'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
3729
raise errors.BzrCommandError(
3730
"--benchmark is no longer supported from bzr 2.2; "
3731
"use bzr-usertest instead")
3732
test_suite_factory = None
3631
3733
selftest_kwargs = {"verbose": verbose,
3632
3734
"pattern": pattern,
3633
3735
"stop_on_failure": one,
3711
3817
with bzr send. If neither is specified, the default is the upstream branch
3712
3818
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.
3820
When merging from a branch, by default bzr will try to merge in all new
3821
work from the other branch, automatically determining an appropriate base
3822
revision. If this fails, you may need to give an explicit base.
3824
To pick a different ending revision, pass "--revision OTHER". bzr will
3825
try to merge in all new work up to and including revision OTHER.
3827
If you specify two values, "--revision BASE..OTHER", only revisions BASE
3828
through OTHER, excluding BASE but including OTHER, will be merged. If this
3829
causes some revisions to be skipped, i.e. if the destination branch does
3830
not already contain revision BASE, such a merge is commonly referred to as
3833
Revision numbers are always relative to the source branch.
3725
3835
Merge will do its best to combine the changes in two branches, but there
3726
3836
are some kinds of problems only a human can fix. When it encounters those,
3793
3903
' completely merged into the source, pull from the'
3794
3904
' source rather than merging. When this happens,'
3795
3905
' you do not need to commit the result.'),
3906
custom_help('directory',
3797
3907
help='Branch to merge into, '
3798
'rather than the one containing the working directory.',
3908
'rather than the one containing the working directory.'),
3802
3909
Option('preview', help='Instead of merging, show a diff of the'
3804
3911
Option('interactive', help='Select changes interactively.',
3905
4011
def _do_preview(self, merger):
3906
4012
from bzrlib.diff import show_diff_trees
3907
4013
result_tree = self._get_preview(merger)
4014
path_encoding = osutils.get_diff_header_encoding()
3908
4015
show_diff_trees(merger.this_tree, result_tree, self.outf,
3909
old_label='', new_label='')
4016
old_label='', new_label='',
4017
path_encoding=path_encoding)
3911
4019
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3912
4020
merger.change_reporter = change_reporter
3992
4100
if ((remember or tree.branch.get_submit_branch() is None) and
3993
4101
user_location is not None):
3994
4102
tree.branch.set_submit_branch(other_branch.base)
3995
_merge_tags_if_possible(other_branch, tree.branch)
4103
# Merge tags (but don't set them in the master branch yet, the user
4104
# might revert this merge). Commit will propagate them.
4105
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
3996
4106
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3997
4107
other_revision_id, base_revision_id, other_branch, base_branch)
3998
4108
if other_path != '':
4167
4276
last committed revision is used.
4169
4278
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.
4279
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4280
will remove the changes introduced by the second last commit (-2), without
4281
affecting the changes introduced by the last commit (-1). To remove
4282
certain changes on a hunk-by-hunk basis, see the shelve command.
4174
4284
By default, any files that have been manually changed will be backed up
4175
4285
first. (Files changed only by merge are not backed up.) Backup files have
4340
4450
theirs_only=False,
4341
4451
log_format=None, long=False, short=False, line=False,
4342
4452
show_ids=False, verbose=False, this=False, other=False,
4343
include_merges=False, revision=None, my_revision=None):
4453
include_merges=False, revision=None, my_revision=None,
4344
4455
from bzrlib.missing import find_unmerged, iter_log_revisions
4345
4456
def message(s):
4346
4457
if not is_quiet():
4507
4615
@display_command
4508
4616
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")
4617
from bzrlib import plugin
4618
self.outf.writelines(
4619
plugin.describe_plugins(show_paths=verbose))
4531
4622
class cmd_testament(Command):
4578
4668
Option('long', help='Show commit date in annotations.'),
4582
4673
encoding_type = 'exact'
4584
4675
@display_command
4585
4676
def run(self, filename, all=False, long=False, revision=None,
4677
show_ids=False, directory=None):
4587
4678
from bzrlib.annotate import annotate_file, annotate_file_tree
4588
4679
wt, branch, relpath = \
4589
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4680
_open_directory_or_containing_tree_or_branch(filename, directory)
4590
4681
if wt is not None:
4592
self.add_cleanup(wt.unlock)
4682
self.add_cleanup(wt.lock_read().unlock)
4595
self.add_cleanup(branch.unlock)
4684
self.add_cleanup(branch.lock_read().unlock)
4596
4685
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4598
self.add_cleanup(tree.unlock)
4686
self.add_cleanup(tree.lock_read().unlock)
4599
4687
if wt is not None:
4600
4688
file_id = wt.path2id(relpath)
4620
4708
hidden = True # is this right ?
4621
4709
takes_args = ['revision_id*']
4622
takes_options = ['revision']
4710
takes_options = ['directory', 'revision']
4624
def run(self, revision_id_list=None, revision=None):
4712
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4625
4713
if revision_id_list is not None and revision is not None:
4626
4714
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4627
4715
if revision_id_list is None and revision is None:
4628
4716
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)
4717
b = WorkingTree.open_containing(directory)[0].branch
4718
self.add_cleanup(b.lock_write().unlock)
4632
4719
return self._run(b, revision_id_list, revision)
4634
4721
def _run(self, b, revision_id_list, revision):
4694
4781
_see_also = ['checkouts', 'unbind']
4695
4782
takes_args = ['location?']
4783
takes_options = ['directory']
4698
def run(self, location=None):
4699
b, relpath = Branch.open_containing(u'.')
4785
def run(self, location=None, directory=u'.'):
4786
b, relpath = Branch.open_containing(directory)
4700
4787
if location is None:
4702
4789
location = b.get_old_bound_location()
4784
4871
b = control.open_branch()
4786
4873
if tree is not None:
4788
self.add_cleanup(tree.unlock)
4874
self.add_cleanup(tree.lock_write().unlock)
4791
self.add_cleanup(b.unlock)
4876
self.add_cleanup(b.lock_write().unlock)
4792
4877
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4794
4879
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4859
4950
bzr break-lock bzr+ssh://example.com/bzr/foo
4951
bzr break-lock --conf ~/.bazaar
4861
4954
takes_args = ['location?']
4957
help='LOCATION is the directory where the config lock is.'),
4959
help='Do not ask for confirmation before breaking the lock.'),
4863
def run(self, location=None, show=False):
4962
def run(self, location=None, config=False, force=False):
4864
4963
if location is None:
4865
4964
location = u'.'
4866
control, relpath = bzrdir.BzrDir.open_containing(location)
4868
control.break_lock()
4869
except NotImplementedError:
4966
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
4968
{'bzrlib.lockdir.break': True})
4970
conf = _mod_config.LockableConfig(file_name=location)
4973
control, relpath = bzrdir.BzrDir.open_containing(location)
4975
control.break_lock()
4976
except NotImplementedError:
4873
4980
class cmd_wait_until_signalled(Command):
4938
5044
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4939
5045
protocol=None):
4940
from bzrlib.transport import get_transport, transport_server_registry
5046
from bzrlib import transport
4941
5047
if directory is None:
4942
5048
directory = os.getcwd()
4943
5049
if protocol is None:
4944
protocol = transport_server_registry.get()
5050
protocol = transport.transport_server_registry.get()
4945
5051
host, port = self.get_host_and_port(port)
4946
5052
url = urlutils.local_path_to_url(directory)
4947
5053
if not allow_writes:
4948
5054
url = 'readonly+' + url
4949
transport = get_transport(url)
4950
protocol(transport, host, port, inet)
5055
t = transport.get_transport(url)
5056
protocol(t, host, port, inet)
4953
5059
class cmd_join(Command):
5064
5171
encoding_type = 'exact'
5066
5173
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5067
sign=False, revision=None, mail_to=None, message=None):
5174
sign=False, revision=None, mail_to=None, message=None,
5068
5176
from bzrlib.revision import ensure_null, NULL_REVISION
5069
5177
include_patch, include_bundle = {
5070
5178
'plain': (False, False),
5071
5179
'diff': (True, False),
5072
5180
'bundle': (True, True),
5074
branch = Branch.open('.')
5182
branch = Branch.open(directory)
5075
5183
stored_submit_branch = branch.get_submit_branch()
5076
5184
if submit_branch is None:
5077
5185
submit_branch = stored_submit_branch
5393
5497
_see_also = ['tag']
5394
5498
takes_options = [
5396
help='Branch whose tags should be displayed.',
5400
RegistryOption.from_kwargs('sort',
5499
custom_help('directory',
5500
help='Branch whose tags should be displayed.'),
5501
RegistryOption('sort',
5401
5502
'Sort tags by different criteria.', title='Sorting',
5402
alpha='Sort tags lexicographically (default).',
5403
time='Sort tags chronologically.',
5503
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5409
5509
@display_command
5510
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5511
from bzrlib.tag import tag_sort_methods
5416
5512
branch, relpath = Branch.open_containing(directory)
5418
5514
tags = branch.tags.get_tag_dict().items()
5423
self.add_cleanup(branch.unlock)
5518
self.add_cleanup(branch.lock_read().unlock)
5425
5520
graph = branch.repository.get_graph()
5426
5521
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5428
5523
# only show revisions between revid1 and revid2 (inclusive)
5429
5524
tags = [(tag, revid) for tag, revid in tags if
5430
5525
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]])
5527
sort = tag_sort_methods.get()
5444
5529
if not show_ids:
5445
5530
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5446
5531
for index, (tag, revid) in enumerate(tags):
5584
5670
def run(self, to_location=None, force=False, create_branch=False,
5671
revision=None, directory=u'.'):
5586
5672
from bzrlib import switch
5673
tree_location = directory
5588
5674
revision = _get_one_revision('switch', revision)
5589
5675
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5590
5676
if to_location is None:
5591
5677
if revision is None:
5592
5678
raise errors.BzrCommandError('You must supply either a'
5593
5679
' revision or a location')
5680
to_location = tree_location
5596
5682
branch = control_dir.open_branch()
5597
5683
had_explicit_nick = branch.get_config().has_explicit_nickname()
5868
5955
You can put multiple items on the shelf, and by default, 'unshelve' will
5869
5956
restore the most recently shelved changes.
5958
For complicated changes, it is possible to edit the changes in a separate
5959
editor program to decide what the file remaining in the working copy
5960
should look like. To do this, add the configuration option
5962
change_editor = PROGRAM @new_path @old_path
5964
where @new_path is replaced with the path of the new version of the
5965
file and @old_path is replaced with the path of the old version of
5966
the file. The PROGRAM should save the new file with the desired
5967
contents of the file in the working tree.
5872
5971
takes_args = ['file*']
5874
5973
takes_options = [
5876
5976
Option('all', help='Shelve all changes.'),
5883
5983
Option('destroy',
5884
5984
help='Destroy removed changes instead of shelving them.'),
5886
_see_also = ['unshelve']
5986
_see_also = ['unshelve', 'configuration']
5888
5988
def run(self, revision=None, all=False, file_list=None, message=None,
5889
writer=None, list=False, destroy=False):
5989
writer=None, list=False, destroy=False, directory=None):
5891
return self.run_for_list()
5991
return self.run_for_list(directory=directory)
5892
5992
from bzrlib.shelf_ui import Shelver
5893
5993
if writer is None:
5894
5994
writer = bzrlib.option.diff_writer_registry.get()
5896
5996
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5897
file_list, message, destroy=destroy)
5997
file_list, message, destroy=destroy, directory=directory)
5967
6069
To check what clean-tree will do, use --dry-run.
5969
takes_options = [Option('ignored', help='Delete all ignored files.'),
6071
takes_options = ['directory',
6072
Option('ignored', help='Delete all ignored files.'),
5970
6073
Option('detritus', help='Delete conflict files, merge'
5971
6074
' backups, and failed selftest dirs.'),
5972
6075
Option('unknown',
5975
6078
' deleting them.'),
5976
6079
Option('force', help='Do not prompt before deleting.')]
5977
6080
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6081
force=False, directory=u'.'):
5979
6082
from bzrlib.clean_tree import clean_tree
5980
6083
if not (unknown or ignored or detritus):
5984
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5985
dry_run=dry_run, no_prompt=force)
6087
clean_tree(directory, unknown=unknown, ignored=ignored,
6088
detritus=detritus, dry_run=dry_run, no_prompt=force)
5988
6091
class cmd_reference(Command):
6037
6140
# be only called once.
6038
6141
for (name, aliases, module_name) in [
6039
6142
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6143
('cmd_config', [], 'bzrlib.config'),
6040
6144
('cmd_dpush', [], 'bzrlib.foreign'),
6041
6145
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6042
6146
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6043
6147
('cmd_conflicts', [], 'bzrlib.conflicts'),
6044
6148
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6149
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6046
6151
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
