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:
759
722
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
761
724
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)
725
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
726
self.add_cleanup(work_tree.lock_read().unlock)
765
727
if revision is not None:
766
728
tree = revision.as_tree(work_tree.branch)
768
730
extra_trees = [work_tree]
770
self.add_cleanup(tree.unlock)
731
self.add_cleanup(tree.lock_read().unlock)
833
794
if len(names_list) < 2:
834
795
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)
796
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
797
self.add_cleanup(tree.lock_tree_write().unlock)
838
798
self._run(tree, names_list, rel_names, after)
840
800
def run_auto(self, names_list, after, dry_run):
845
805
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)
807
work_tree, file_list = WorkingTree.open_containing_paths(
808
names_list, default_directory='.')
809
self.add_cleanup(work_tree.lock_tree_write().unlock)
850
810
rename_map.RenameMap.guess_renames(work_tree, dry_run)
852
812
def _run(self, tree, names_list, rel_names, after):
960
920
takes_options = ['remember', 'overwrite', 'revision',
961
921
custom_help('verbose',
962
922
help='Show logs of pulled revisions.'),
923
custom_help('directory',
964
924
help='Branch to pull into, '
965
'rather than the one containing the working directory.',
925
'rather than the one containing the working directory.'),
970
927
help="Perform a local pull in a bound "
971
928
"branch. Local pulls are not applied to "
972
929
"the master branch."
932
help="Show base revision text in conflicts.")
975
934
takes_args = ['location?']
976
935
encoding_type = 'replace'
978
937
def run(self, location=None, remember=False, overwrite=False,
979
938
revision=None, verbose=False,
980
directory=None, local=False):
939
directory=None, local=False,
981
941
# FIXME: too much stuff is in the command class
982
942
revision_id = None
987
947
tree_to = WorkingTree.open_containing(directory)[0]
988
948
branch_to = tree_to.branch
990
self.add_cleanup(tree_to.unlock)
949
self.add_cleanup(tree_to.lock_write().unlock)
991
950
except errors.NoWorkingTree:
993
952
branch_to = Branch.open_containing(directory)[0]
994
branch_to.lock_write()
995
self.add_cleanup(branch_to.unlock)
953
self.add_cleanup(branch_to.lock_write().unlock)
955
if tree_to is None and show_base:
956
raise errors.BzrCommandError("Need working tree for --show-base.")
997
958
if local and not branch_to.get_bound_location():
998
959
raise errors.LocalRequiresBoundBranch()
1088
1053
Option('create-prefix',
1089
1054
help='Create the path leading up to the branch '
1090
1055
'if it does not already exist.'),
1056
custom_help('directory',
1092
1057
help='Branch to push from, '
1093
'rather than the one containing the working directory.',
1058
'rather than the one containing the working directory.'),
1097
1059
Option('use-existing-dir',
1098
1060
help='By default push will fail if the target'
1099
1061
' directory exists, but does not already'
1117
1082
def run(self, location=None, remember=False, overwrite=False,
1118
1083
create_prefix=False, verbose=False, revision=None,
1119
1084
use_existing_dir=False, directory=None, stacked_on=None,
1120
stacked=False, strict=None):
1085
stacked=False, strict=None, no_tree=False):
1121
1086
from bzrlib.push import _show_push_branch
1123
1088
if directory is None:
1169
1134
_show_push_branch(br_from, revision_id, location, self.outf,
1170
1135
verbose=verbose, overwrite=overwrite, remember=remember,
1171
1136
stacked_on=stacked_on, create_prefix=create_prefix,
1172
use_existing_dir=use_existing_dir)
1137
use_existing_dir=use_existing_dir, no_tree=no_tree)
1175
1140
class cmd_branch(Command):
1189
1154
_see_also = ['checkout']
1190
1155
takes_args = ['from_location', 'to_location?']
1191
takes_options = ['revision', Option('hardlink',
1192
help='Hard-link working tree files where possible.'),
1156
takes_options = ['revision',
1157
Option('hardlink', help='Hard-link working tree files where possible.'),
1158
Option('files-from', type=str,
1159
help="Get file contents from this tree."),
1193
1160
Option('no-tree',
1194
1161
help="Create a branch without a working-tree."),
1195
1162
Option('switch',
1214
1181
def run(self, from_location, to_location=None, revision=None,
1215
1182
hardlink=False, stacked=False, standalone=False, no_tree=False,
1216
use_existing_dir=False, switch=False, bind=False):
1183
use_existing_dir=False, switch=False, bind=False,
1217
1185
from bzrlib import switch as _mod_switch
1218
1186
from bzrlib.tag import _merge_tags_if_possible
1219
1187
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1189
if not (hardlink or files_from):
1190
# accelerator_tree is usually slower because you have to read N
1191
# files (no readahead, lots of seeks, etc), but allow the user to
1192
# explicitly request it
1193
accelerator_tree = None
1194
if files_from is not None and files_from != from_location:
1195
accelerator_tree = WorkingTree.open(files_from)
1221
1196
revision = _get_one_revision('branch', revision)
1223
self.add_cleanup(br_from.unlock)
1197
self.add_cleanup(br_from.lock_read().unlock)
1224
1198
if revision is not None:
1225
1199
revision_id = revision.as_revision_id(br_from)
1331
1305
to_location = branch_location
1332
1306
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1333
1307
branch_location)
1308
if not (hardlink or files_from):
1309
# accelerator_tree is usually slower because you have to read N
1310
# files (no readahead, lots of seeks, etc), but allow the user to
1311
# explicitly request it
1312
accelerator_tree = None
1334
1313
revision = _get_one_revision('checkout', revision)
1335
if files_from is not None:
1314
if files_from is not None and files_from != branch_location:
1336
1315
accelerator_tree = WorkingTree.open(files_from)
1337
1316
if revision is not None:
1338
1317
revision_id = revision.as_revision_id(source)
1396
1373
If you want to discard your local changes, you can just do a
1397
1374
'bzr revert' instead of 'bzr commit' after the update.
1376
If you want to restore a file that has been removed locally, use
1377
'bzr revert' instead of 'bzr update'.
1399
1379
If the tree's branch is bound to a master branch, it will also update
1400
1380
the branch from the master.
1403
1383
_see_also = ['pull', 'working-trees', 'status-flags']
1404
1384
takes_args = ['dir?']
1405
takes_options = ['revision']
1385
takes_options = ['revision',
1387
help="Show base revision text in conflicts."),
1406
1389
aliases = ['up']
1408
def run(self, dir='.', revision=None):
1391
def run(self, dir='.', revision=None, show_base=None):
1409
1392
if revision is not None and len(revision) != 1:
1410
1393
raise errors.BzrCommandError(
1411
1394
"bzr update --revision takes exactly one revision")
1519
1503
class cmd_remove(Command):
1520
1504
__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.
1506
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1507
delete them if they can easily be recovered using revert otherwise they
1508
will be backed up (adding an extention of the form .~#~). If no options or
1509
parameters are given Bazaar will scan for files that are being tracked by
1510
Bazaar but missing in your tree and stop tracking them for you.
1527
1512
takes_args = ['file*']
1528
1513
takes_options = ['verbose',
1530
1515
RegistryOption.from_kwargs('file-deletion-strategy',
1531
1516
'The file deletion mode to be used.',
1532
1517
title='Deletion Strategy', value_switches=True, enum_switch=False,
1533
safe='Only delete files if they can be'
1534
' safely recovered (default).',
1518
safe='Backup changed files (default).',
1535
1519
keep='Delete from bzr but leave the working copy.',
1520
no_backup='Don\'t backup changed files.',
1536
1521
force='Delete all the specified files, even if they can not be '
1537
'recovered and even if they are non-empty directories.')]
1522
'recovered and even if they are non-empty directories. '
1523
'(deprecated, use no-backup)')]
1538
1524
aliases = ['rm', 'del']
1539
1525
encoding_type = 'replace'
1541
1527
def run(self, file_list, verbose=False, new=False,
1542
1528
file_deletion_strategy='safe'):
1543
tree, file_list = tree_files(file_list)
1529
if file_deletion_strategy == 'force':
1530
note("(The --force option is deprecated, rather use --no-backup "
1532
file_deletion_strategy = 'no-backup'
1534
tree, file_list = WorkingTree.open_containing_paths(file_list)
1545
1536
if file_list is not None:
1546
1537
file_list = [f for f in file_list]
1549
self.add_cleanup(tree.unlock)
1539
self.add_cleanup(tree.lock_write().unlock)
1550
1540
# Heuristics should probably all move into tree.remove_smart or
1636
1626
_see_also = ['check']
1637
1627
takes_args = ['branch?']
1629
Option('canonicalize-chks',
1630
help='Make sure CHKs are in canonical form (repairs '
1639
def run(self, branch="."):
1635
def run(self, branch=".", canonicalize_chks=False):
1640
1636
from bzrlib.reconcile import reconcile
1641
1637
dir = bzrdir.BzrDir.open(branch)
1638
reconcile(dir, canonicalize_chks=canonicalize_chks)
1645
1641
class cmd_revision_history(Command):
1723
1719
Option('append-revisions-only',
1724
1720
help='Never change revnos or the existing log.'
1725
' Append revisions to it only.')
1721
' Append revisions to it only.'),
1723
'Create a branch without a working tree.')
1727
1725
def run(self, location=None, format=None, append_revisions_only=False,
1728
create_prefix=False):
1726
create_prefix=False, no_tree=False):
1729
1727
if format is None:
1730
1728
format = bzrdir.format_registry.make_bzrdir('default')
1731
1729
if location is None:
1985
2006
old_branch, new_branch,
1986
2007
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
2008
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2009
# GNU diff on Windows uses ANSI encoding for filenames
2010
path_encoding = osutils.get_diff_header_encoding()
1988
2011
return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
2012
specific_files=specific_files,
1990
2013
external_diff_options=diff_options,
1991
2014
old_label=old_label, new_label=new_label,
1992
extra_trees=extra_trees, using=using,
2015
extra_trees=extra_trees,
2016
path_encoding=path_encoding,
1993
2018
format_cls=format)
2003
2028
# level of effort but possibly much less IO. (Or possibly not,
2004
2029
# if the directories are very large...)
2005
2030
_see_also = ['status', 'ls']
2006
takes_options = ['show-ids']
2031
takes_options = ['directory', 'show-ids']
2008
2033
@display_command
2009
def run(self, show_ids=False):
2010
tree = WorkingTree.open_containing(u'.')[0]
2012
self.add_cleanup(tree.unlock)
2034
def run(self, show_ids=False, directory=u'.'):
2035
tree = WorkingTree.open_containing(directory)[0]
2036
self.add_cleanup(tree.lock_read().unlock)
2013
2037
old = tree.basis_tree()
2015
self.add_cleanup(old.unlock)
2038
self.add_cleanup(old.lock_read().unlock)
2016
2039
for path, ie in old.inventory.iter_entries():
2017
2040
if not tree.has_id(ie.file_id):
2018
2041
self.outf.write(path)
2030
2053
_see_also = ['status', 'ls']
2033
help='Write an ascii NUL (\\0) separator '
2034
'between files rather than a newline.')
2054
takes_options = ['directory', 'null']
2037
2056
@display_command
2038
def run(self, null=False):
2039
tree = WorkingTree.open_containing(u'.')[0]
2057
def run(self, null=False, directory=u'.'):
2058
tree = WorkingTree.open_containing(directory)[0]
2059
self.add_cleanup(tree.lock_read().unlock)
2040
2060
td = tree.changes_from(tree.basis_tree())
2041
2062
for path, id, kind, text_modified, meta_modified in td.modified:
2043
2064
self.outf.write(path + '\0')
2053
2074
_see_also = ['status', 'ls']
2056
help='Write an ascii NUL (\\0) separator '
2057
'between files rather than a newline.')
2075
takes_options = ['directory', 'null']
2060
2077
@display_command
2061
def run(self, null=False):
2062
wt = WorkingTree.open_containing(u'.')[0]
2064
self.add_cleanup(wt.unlock)
2078
def run(self, null=False, directory=u'.'):
2079
wt = WorkingTree.open_containing(directory)[0]
2080
self.add_cleanup(wt.lock_read().unlock)
2065
2081
basis = wt.basis_tree()
2067
self.add_cleanup(basis.unlock)
2082
self.add_cleanup(basis.lock_read().unlock)
2068
2083
basis_inv = basis.inventory
2069
2084
inv = wt.inventory
2070
2085
for file_id in inv:
2528
2547
help='Recurse into subdirectories.'),
2529
2548
Option('from-root',
2530
2549
help='Print paths relative to the root of the branch.'),
2531
Option('unknown', help='Print unknown files.'),
2550
Option('unknown', short_name='u',
2551
help='Print unknown files.'),
2532
2552
Option('versioned', help='Print versioned files.',
2533
2553
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.'),
2554
Option('ignored', short_name='i',
2555
help='Print ignored files.'),
2556
Option('kind', short_name='k',
2539
2557
help='List entries of a particular kind: file, directory, symlink.',
2543
2563
@display_command
2544
2564
def run(self, revision=None, verbose=False,
2545
2565
recursive=False, from_root=False,
2546
2566
unknown=False, versioned=False, ignored=False,
2547
null=False, kind=None, show_ids=False, path=None):
2567
null=False, kind=None, show_ids=False, path=None, directory=None):
2549
2569
if kind and kind not in ('file', 'directory', 'symlink'):
2550
2570
raise errors.BzrCommandError('invalid kind specified')
2713
2742
_see_also = ['status', 'ignored', 'patterns']
2714
2743
takes_args = ['name_pattern*']
2744
takes_options = ['directory',
2716
2745
Option('default-rules',
2717
2746
help='Display the default ignore rules that bzr uses.')
2720
def run(self, name_pattern_list=None, default_rules=None):
2749
def run(self, name_pattern_list=None, default_rules=None,
2721
2751
from bzrlib import ignores
2722
2752
if default_rules is not None:
2723
2753
# dump the default rules and exit
2729
2759
"NAME_PATTERN or --default-rules.")
2730
2760
name_pattern_list = [globbing.normalize_pattern(p)
2731
2761
for p in name_pattern_list]
2763
for p in name_pattern_list:
2764
if not globbing.Globster.is_pattern_valid(p):
2765
bad_patterns += ('\n %s' % p)
2767
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2768
ui.ui_factory.show_error(msg)
2769
raise errors.InvalidPattern('')
2732
2770
for name_pattern in name_pattern_list:
2733
2771
if (name_pattern[0] == '/' or
2734
2772
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2735
2773
raise errors.BzrCommandError(
2736
2774
"NAME_PATTERN should not be an absolute path")
2737
tree, relpath = WorkingTree.open_containing(u'.')
2775
tree, relpath = WorkingTree.open_containing(directory)
2738
2776
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2739
2777
ignored = globbing.Globster(name_pattern_list)
2779
self.add_cleanup(tree.lock_read().unlock)
2742
2780
for entry in tree.list_files():
2744
2782
if id is not None:
2745
2783
filename = entry[0]
2746
2784
if ignored.match(filename):
2747
2785
matches.append(filename)
2749
2786
if len(matches) > 0:
2750
2787
self.outf.write("Warning: the following files are version controlled and"
2751
2788
" match your ignore pattern:\n%s"
2767
2804
encoding_type = 'replace'
2768
2805
_see_also = ['ignore', 'ls']
2806
takes_options = ['directory']
2770
2808
@display_command
2772
tree = WorkingTree.open_containing(u'.')[0]
2774
self.add_cleanup(tree.unlock)
2809
def run(self, directory=u'.'):
2810
tree = WorkingTree.open_containing(directory)[0]
2811
self.add_cleanup(tree.lock_read().unlock)
2775
2812
for path, file_class, kind, file_id, entry in tree.list_files():
2776
2813
if file_class != 'I':
2844
2882
'revision in which it was changed.'),
2846
2884
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
root=None, filters=False, per_file_timestamps=False):
2885
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2848
2886
from bzrlib.export import export
2850
2888
if branch_or_subdir is None:
2851
tree = WorkingTree.open_containing(u'.')[0]
2889
tree = WorkingTree.open_containing(directory)[0]
2852
2890
b = tree.branch
2885
2923
@display_command
2886
2924
def run(self, filename, revision=None, name_from_revision=False,
2925
filters=False, directory=None):
2888
2926
if revision is not None and len(revision) != 1:
2889
2927
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2890
2928
" one revision specifier")
2891
2929
tree, branch, relpath = \
2892
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2894
self.add_cleanup(branch.unlock)
2930
_open_directory_or_containing_tree_or_branch(filename, directory)
2931
self.add_cleanup(branch.lock_read().unlock)
2895
2932
return self._run(tree, branch, relpath, filename, revision,
2896
2933
name_from_revision, filters)
3297
3336
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.
3337
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3339
When the default format has changed after a major new release of
3340
Bazaar, you may be informed during certain operations that you
3341
should upgrade. Upgrading to a newer format may improve performance
3342
or make new features available. It may however limit interoperability
3343
with older repositories or with older versions of Bazaar.
3345
If you wish to upgrade to a particular format rather than the
3346
current default, that can be specified using the --format option.
3347
As a consequence, you can use the upgrade command this way to
3348
"downgrade" to an earlier format, though some conversions are
3349
a one way process (e.g. changing from the 1.x default to the
3350
2.x default) so downgrading is not always possible.
3352
A backup.bzr.~#~ directory is created at the start of the conversion
3353
process (where # is a number). By default, this is left there on
3354
completion. If the conversion fails, delete the new .bzr directory
3355
and rename this one back in its place. Use the --clean option to ask
3356
for the backup.bzr directory to be removed on successful conversion.
3357
Alternatively, you can delete it by hand if everything looks good
3360
If the location given is a shared repository, dependent branches
3361
are also converted provided the repository converts successfully.
3362
If the conversion of a branch fails, remaining branches are still
3365
For more information on upgrades, see the Bazaar Upgrade Guide,
3366
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3305
_see_also = ['check']
3369
_see_also = ['check', 'reconcile', 'formats']
3306
3370
takes_args = ['url?']
3307
3371
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'),
3372
RegistryOption('format',
3373
help='Upgrade to a specific format. See "bzr help'
3374
' formats" for details.',
3375
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3376
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3377
value_switches=True, title='Branch format'),
3379
help='Remove the backup.bzr directory if successful.'),
3381
help="Show what would be done, but don't actually do anything."),
3316
def run(self, url='.', format=None):
3384
def run(self, url='.', format=None, clean=False, dry_run=False):
3317
3385
from bzrlib.upgrade import upgrade
3318
upgrade(url, format)
3386
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3388
if len(exceptions) == 1:
3389
# Compatibility with historical behavior
3321
3395
class cmd_whoami(Command):
3340
3415
encoding_type = 'replace'
3342
3417
@display_command
3343
def run(self, email=False, branch=False, name=None):
3418
def run(self, email=False, branch=False, name=None, directory=None):
3344
3419
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()
3420
if directory is None:
3421
# use branch if we're inside one; otherwise global config
3423
c = Branch.open_containing(u'.')[0].get_config()
3424
except errors.NotBranchError:
3425
c = _mod_config.GlobalConfig()
3427
c = Branch.open(directory).get_config()
3351
3429
self.outf.write(c.user_email() + '\n')
3353
3431
self.outf.write(c.username() + '\n')
3435
raise errors.BzrCommandError("--email can only be used to display existing "
3356
3438
# display a warning if an email address isn't included in the given name.
3358
config.extract_email_address(name)
3440
_mod_config.extract_email_address(name)
3359
3441
except errors.NoEmailInUsername, e:
3360
3442
warning('"%s" does not seem to contain an email address. '
3361
3443
'This is allowed, but not recommended.', name)
3363
3445
# use global config unless --branch given
3365
c = Branch.open_containing('.')[0].get_config()
3447
if directory is None:
3448
c = Branch.open_containing(u'.')[0].get_config()
3450
c = Branch.open(directory).get_config()
3367
c = config.GlobalConfig()
3452
c = _mod_config.GlobalConfig()
3368
3453
c.set_user_option('email', name)
3436
3522
'bzr alias --remove expects an alias to remove.')
3437
3523
# If alias is not found, print something like:
3438
3524
# unalias: foo: not found
3439
c = config.GlobalConfig()
3525
c = _mod_config.GlobalConfig()
3440
3526
c.unset_alias(alias_name)
3442
3528
@display_command
3443
3529
def print_aliases(self):
3444
3530
"""Print out the defined aliases in a similar format to bash."""
3445
aliases = config.GlobalConfig().get_aliases()
3531
aliases = _mod_config.GlobalConfig().get_aliases()
3446
3532
for key, value in sorted(aliases.iteritems()):
3447
3533
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3537
3626
'throughout the test suite.',
3538
3627
type=get_transport_type),
3539
3628
Option('benchmark',
3540
help='Run the benchmarks rather than selftests.'),
3629
help='Run the benchmarks rather than selftests.',
3541
3631
Option('lsprof-timed',
3542
3632
help='Generate lsprof output for benchmarked'
3543
3633
' sections of code.'),
3544
3634
Option('lsprof-tests',
3545
3635
help='Generate lsprof output for each test.'),
3546
Option('cache-dir', type=str,
3547
help='Cache intermediate benchmark output in this '
3549
3636
Option('first',
3550
3637
help='Run all tests, but run specified tests first.',
3551
3638
short_name='f',
3586
3673
def run(self, testspecs_list=None, verbose=False, one=False,
3587
3674
transport=None, benchmark=None,
3588
lsprof_timed=None, cache_dir=None,
3589
3676
first=False, list_only=False,
3590
3677
randomize=None, exclude=None, strict=False,
3591
3678
load_list=None, debugflag=None, starting_with=None, subunit=False,
3592
3679
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)
3680
from bzrlib import tests
3602
3682
if testspecs_list is not None:
3603
3683
pattern = '|'.join(testspecs_list)
3612
3692
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3613
3693
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3614
3694
# stdout, which would corrupt the subunit stream.
3615
if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3695
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3696
# following code can be deleted when it's sufficiently deployed
3697
# -- vila/mgz 20100514
3698
if (sys.platform == "win32"
3699
and getattr(sys.stdout, 'fileno', None) is not None):
3617
3701
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3619
3703
self.additional_selftest_args.setdefault(
3620
3704
'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
3706
raise errors.BzrCommandError(
3707
"--benchmark is no longer supported from bzr 2.2; "
3708
"use bzr-usertest instead")
3709
test_suite_factory = None
3631
3710
selftest_kwargs = {"verbose": verbose,
3632
3711
"pattern": pattern,
3633
3712
"stop_on_failure": one,
3711
3794
with bzr send. If neither is specified, the default is the upstream branch
3712
3795
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.
3797
When merging from a branch, by default bzr will try to merge in all new
3798
work from the other branch, automatically determining an appropriate base
3799
revision. If this fails, you may need to give an explicit base.
3801
To pick a different ending revision, pass "--revision OTHER". bzr will
3802
try to merge in all new work up to and including revision OTHER.
3804
If you specify two values, "--revision BASE..OTHER", only revisions BASE
3805
through OTHER, excluding BASE but including OTHER, will be merged. If this
3806
causes some revisions to be skipped, i.e. if the destination branch does
3807
not already contain revision BASE, such a merge is commonly referred to as
3810
Revision numbers are always relative to the source branch.
3725
3812
Merge will do its best to combine the changes in two branches, but there
3726
3813
are some kinds of problems only a human can fix. When it encounters those,
3793
3880
' completely merged into the source, pull from the'
3794
3881
' source rather than merging. When this happens,'
3795
3882
' you do not need to commit the result.'),
3883
custom_help('directory',
3797
3884
help='Branch to merge into, '
3798
'rather than the one containing the working directory.',
3885
'rather than the one containing the working directory.'),
3802
3886
Option('preview', help='Instead of merging, show a diff of the'
3804
3888
Option('interactive', help='Select changes interactively.',
3905
3988
def _do_preview(self, merger):
3906
3989
from bzrlib.diff import show_diff_trees
3907
3990
result_tree = self._get_preview(merger)
3991
path_encoding = osutils.get_diff_header_encoding()
3908
3992
show_diff_trees(merger.this_tree, result_tree, self.outf,
3909
old_label='', new_label='')
3993
old_label='', new_label='',
3994
path_encoding=path_encoding)
3911
3996
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3912
3997
merger.change_reporter = change_reporter
3992
4077
if ((remember or tree.branch.get_submit_branch() is None) and
3993
4078
user_location is not None):
3994
4079
tree.branch.set_submit_branch(other_branch.base)
3995
_merge_tags_if_possible(other_branch, tree.branch)
4080
# Merge tags (but don't set them in the master branch yet, the user
4081
# might revert this merge). Commit will propagate them.
4082
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
3996
4083
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3997
4084
other_revision_id, base_revision_id, other_branch, base_branch)
3998
4085
if other_path != '':
4167
4253
last committed revision is used.
4169
4255
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.
4256
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4257
will remove the changes introduced by the second last commit (-2), without
4258
affecting the changes introduced by the last commit (-1). To remove
4259
certain changes on a hunk-by-hunk basis, see the shelve command.
4174
4261
By default, any files that have been manually changed will be backed up
4175
4262
first. (Files changed only by merge are not backed up.) Backup files have
4340
4427
theirs_only=False,
4341
4428
log_format=None, long=False, short=False, line=False,
4342
4429
show_ids=False, verbose=False, this=False, other=False,
4343
include_merges=False, revision=None, my_revision=None):
4430
include_merges=False, revision=None, my_revision=None,
4344
4432
from bzrlib.missing import find_unmerged, iter_log_revisions
4345
4433
def message(s):
4346
4434
if not is_quiet():
4507
4592
@display_command
4508
4593
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")
4594
from bzrlib import plugin
4595
self.outf.writelines(
4596
plugin.describe_plugins(show_paths=verbose))
4531
4599
class cmd_testament(Command):
4578
4645
Option('long', help='Show commit date in annotations.'),
4582
4650
encoding_type = 'exact'
4584
4652
@display_command
4585
4653
def run(self, filename, all=False, long=False, revision=None,
4654
show_ids=False, directory=None):
4587
4655
from bzrlib.annotate import annotate_file, annotate_file_tree
4588
4656
wt, branch, relpath = \
4589
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4657
_open_directory_or_containing_tree_or_branch(filename, directory)
4590
4658
if wt is not None:
4592
self.add_cleanup(wt.unlock)
4659
self.add_cleanup(wt.lock_read().unlock)
4595
self.add_cleanup(branch.unlock)
4661
self.add_cleanup(branch.lock_read().unlock)
4596
4662
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4598
self.add_cleanup(tree.unlock)
4663
self.add_cleanup(tree.lock_read().unlock)
4599
4664
if wt is not None:
4600
4665
file_id = wt.path2id(relpath)
4620
4685
hidden = True # is this right ?
4621
4686
takes_args = ['revision_id*']
4622
takes_options = ['revision']
4687
takes_options = ['directory', 'revision']
4624
def run(self, revision_id_list=None, revision=None):
4689
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4625
4690
if revision_id_list is not None and revision is not None:
4626
4691
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4627
4692
if revision_id_list is None and revision is None:
4628
4693
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)
4694
b = WorkingTree.open_containing(directory)[0].branch
4695
self.add_cleanup(b.lock_write().unlock)
4632
4696
return self._run(b, revision_id_list, revision)
4634
4698
def _run(self, b, revision_id_list, revision):
4694
4758
_see_also = ['checkouts', 'unbind']
4695
4759
takes_args = ['location?']
4760
takes_options = ['directory']
4698
def run(self, location=None):
4699
b, relpath = Branch.open_containing(u'.')
4762
def run(self, location=None, directory=u'.'):
4763
b, relpath = Branch.open_containing(directory)
4700
4764
if location is None:
4702
4766
location = b.get_old_bound_location()
4784
4848
b = control.open_branch()
4786
4850
if tree is not None:
4788
self.add_cleanup(tree.unlock)
4851
self.add_cleanup(tree.lock_write().unlock)
4791
self.add_cleanup(b.unlock)
4853
self.add_cleanup(b.lock_write().unlock)
4792
4854
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4794
4856
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4859
4927
bzr break-lock bzr+ssh://example.com/bzr/foo
4928
bzr break-lock --conf ~/.bazaar
4861
4931
takes_args = ['location?']
4934
help='LOCATION is the directory where the config lock is.'),
4936
help='Do not ask for confirmation before breaking the lock.'),
4863
def run(self, location=None, show=False):
4939
def run(self, location=None, config=False, force=False):
4864
4940
if location is None:
4865
4941
location = u'.'
4866
control, relpath = bzrdir.BzrDir.open_containing(location)
4868
control.break_lock()
4869
except NotImplementedError:
4943
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
4945
{'bzrlib.lockdir.break': True})
4947
conf = _mod_config.LockableConfig(file_name=location)
4950
control, relpath = bzrdir.BzrDir.open_containing(location)
4952
control.break_lock()
4953
except NotImplementedError:
4873
4957
class cmd_wait_until_signalled(Command):
4938
5021
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4939
5022
protocol=None):
4940
from bzrlib.transport import get_transport, transport_server_registry
5023
from bzrlib import transport
4941
5024
if directory is None:
4942
5025
directory = os.getcwd()
4943
5026
if protocol is None:
4944
protocol = transport_server_registry.get()
5027
protocol = transport.transport_server_registry.get()
4945
5028
host, port = self.get_host_and_port(port)
4946
5029
url = urlutils.local_path_to_url(directory)
4947
5030
if not allow_writes:
4948
5031
url = 'readonly+' + url
4949
transport = get_transport(url)
4950
protocol(transport, host, port, inet)
5032
t = transport.get_transport(url)
5033
protocol(t, host, port, inet)
4953
5036
class cmd_join(Command):
5064
5148
encoding_type = 'exact'
5066
5150
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5067
sign=False, revision=None, mail_to=None, message=None):
5151
sign=False, revision=None, mail_to=None, message=None,
5068
5153
from bzrlib.revision import ensure_null, NULL_REVISION
5069
5154
include_patch, include_bundle = {
5070
5155
'plain': (False, False),
5071
5156
'diff': (True, False),
5072
5157
'bundle': (True, True),
5074
branch = Branch.open('.')
5159
branch = Branch.open(directory)
5075
5160
stored_submit_branch = branch.get_submit_branch()
5076
5161
if submit_branch is None:
5077
5162
submit_branch = stored_submit_branch
5393
5474
_see_also = ['tag']
5394
5475
takes_options = [
5396
help='Branch whose tags should be displayed.',
5400
RegistryOption.from_kwargs('sort',
5476
custom_help('directory',
5477
help='Branch whose tags should be displayed.'),
5478
RegistryOption('sort',
5401
5479
'Sort tags by different criteria.', title='Sorting',
5402
alpha='Sort tags lexicographically (default).',
5403
time='Sort tags chronologically.',
5480
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5409
5486
@display_command
5487
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5488
from bzrlib.tag import tag_sort_methods
5416
5489
branch, relpath = Branch.open_containing(directory)
5418
5491
tags = branch.tags.get_tag_dict().items()
5423
self.add_cleanup(branch.unlock)
5495
self.add_cleanup(branch.lock_read().unlock)
5425
5497
graph = branch.repository.get_graph()
5426
5498
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5428
5500
# only show revisions between revid1 and revid2 (inclusive)
5429
5501
tags = [(tag, revid) for tag, revid in tags if
5430
5502
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]])
5504
sort = tag_sort_methods.get()
5444
5506
if not show_ids:
5445
5507
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5446
5508
for index, (tag, revid) in enumerate(tags):
5584
5647
def run(self, to_location=None, force=False, create_branch=False,
5648
revision=None, directory=u'.'):
5586
5649
from bzrlib import switch
5650
tree_location = directory
5588
5651
revision = _get_one_revision('switch', revision)
5589
5652
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5590
5653
if to_location is None:
5591
5654
if revision is None:
5592
5655
raise errors.BzrCommandError('You must supply either a'
5593
5656
' revision or a location')
5657
to_location = tree_location
5596
5659
branch = control_dir.open_branch()
5597
5660
had_explicit_nick = branch.get_config().has_explicit_nickname()
5868
5932
You can put multiple items on the shelf, and by default, 'unshelve' will
5869
5933
restore the most recently shelved changes.
5935
For complicated changes, it is possible to edit the changes in a separate
5936
editor program to decide what the file remaining in the working copy
5937
should look like. To do this, add the configuration option
5939
change_editor = PROGRAM @new_path @old_path
5941
where @new_path is replaced with the path of the new version of the
5942
file and @old_path is replaced with the path of the old version of
5943
the file. The PROGRAM should save the new file with the desired
5944
contents of the file in the working tree.
5872
5948
takes_args = ['file*']
5874
5950
takes_options = [
5876
5953
Option('all', help='Shelve all changes.'),
5883
5960
Option('destroy',
5884
5961
help='Destroy removed changes instead of shelving them.'),
5886
_see_also = ['unshelve']
5963
_see_also = ['unshelve', 'configuration']
5888
5965
def run(self, revision=None, all=False, file_list=None, message=None,
5889
writer=None, list=False, destroy=False):
5966
writer=None, list=False, destroy=False, directory=None):
5891
return self.run_for_list()
5968
return self.run_for_list(directory=directory)
5892
5969
from bzrlib.shelf_ui import Shelver
5893
5970
if writer is None:
5894
5971
writer = bzrlib.option.diff_writer_registry.get()
5896
5973
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5897
file_list, message, destroy=destroy)
5974
file_list, message, destroy=destroy, directory=directory)
5967
6046
To check what clean-tree will do, use --dry-run.
5969
takes_options = [Option('ignored', help='Delete all ignored files.'),
6048
takes_options = ['directory',
6049
Option('ignored', help='Delete all ignored files.'),
5970
6050
Option('detritus', help='Delete conflict files, merge'
5971
6051
' backups, and failed selftest dirs.'),
5972
6052
Option('unknown',
5975
6055
' deleting them.'),
5976
6056
Option('force', help='Do not prompt before deleting.')]
5977
6057
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6058
force=False, directory=u'.'):
5979
6059
from bzrlib.clean_tree import clean_tree
5980
6060
if not (unknown or ignored or detritus):
5984
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5985
dry_run=dry_run, no_prompt=force)
6064
clean_tree(directory, unknown=unknown, ignored=ignored,
6065
detritus=detritus, dry_run=dry_run, no_prompt=force)
5988
6068
class cmd_reference(Command):
6037
6117
# be only called once.
6038
6118
for (name, aliases, module_name) in [
6039
6119
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6120
('cmd_config', [], 'bzrlib.config'),
6040
6121
('cmd_dpush', [], 'bzrlib.foreign'),
6041
6122
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6042
6123
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6043
6124
('cmd_conflicts', [], 'bzrlib.conflicts'),
6044
6125
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6126
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6046
6128
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
