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
331
b = WorkingTree.open_containing(directory)[0].branch
365
333
revisions = b.repository.revisions
366
334
if revisions is None:
759
721
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
761
723
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)
724
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
725
self.add_cleanup(work_tree.lock_read().unlock)
765
726
if revision is not None:
766
727
tree = revision.as_tree(work_tree.branch)
768
729
extra_trees = [work_tree]
770
self.add_cleanup(tree.unlock)
730
self.add_cleanup(tree.lock_read().unlock)
833
793
if len(names_list) < 2:
834
794
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)
795
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
796
self.add_cleanup(tree.lock_tree_write().unlock)
838
797
self._run(tree, names_list, rel_names, after)
840
799
def run_auto(self, names_list, after, dry_run):
845
804
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)
806
work_tree, file_list = WorkingTree.open_containing_paths(
807
names_list, default_directory='.')
808
self.add_cleanup(work_tree.lock_tree_write().unlock)
850
809
rename_map.RenameMap.guess_renames(work_tree, dry_run)
852
811
def _run(self, tree, names_list, rel_names, after):
960
919
takes_options = ['remember', 'overwrite', 'revision',
961
920
custom_help('verbose',
962
921
help='Show logs of pulled revisions.'),
922
custom_help('directory',
964
923
help='Branch to pull into, '
965
'rather than the one containing the working directory.',
924
'rather than the one containing the working directory.'),
970
926
help="Perform a local pull in a bound "
971
927
"branch. Local pulls are not applied to "
972
928
"the master branch."
931
help="Show base revision text in conflicts.")
975
933
takes_args = ['location?']
976
934
encoding_type = 'replace'
978
936
def run(self, location=None, remember=False, overwrite=False,
979
937
revision=None, verbose=False,
980
directory=None, local=False):
938
directory=None, local=False,
981
940
# FIXME: too much stuff is in the command class
982
941
revision_id = None
987
946
tree_to = WorkingTree.open_containing(directory)[0]
988
947
branch_to = tree_to.branch
990
self.add_cleanup(tree_to.unlock)
948
self.add_cleanup(tree_to.lock_write().unlock)
991
949
except errors.NoWorkingTree:
993
951
branch_to = Branch.open_containing(directory)[0]
994
branch_to.lock_write()
995
self.add_cleanup(branch_to.unlock)
952
self.add_cleanup(branch_to.lock_write().unlock)
954
if tree_to is None and show_base:
955
raise errors.BzrCommandError("Need working tree for --show-base.")
997
957
if local and not branch_to.get_bound_location():
998
958
raise errors.LocalRequiresBoundBranch()
1088
1048
Option('create-prefix',
1089
1049
help='Create the path leading up to the branch '
1090
1050
'if it does not already exist.'),
1051
custom_help('directory',
1092
1052
help='Branch to push from, '
1093
'rather than the one containing the working directory.',
1053
'rather than the one containing the working directory.'),
1097
1054
Option('use-existing-dir',
1098
1055
help='By default push will fail if the target'
1099
1056
' directory exists, but does not already'
1117
1077
def run(self, location=None, remember=False, overwrite=False,
1118
1078
create_prefix=False, verbose=False, revision=None,
1119
1079
use_existing_dir=False, directory=None, stacked_on=None,
1120
stacked=False, strict=None):
1080
stacked=False, strict=None, no_tree=False):
1121
1081
from bzrlib.push import _show_push_branch
1123
1083
if directory is None:
1169
1129
_show_push_branch(br_from, revision_id, location, self.outf,
1170
1130
verbose=verbose, overwrite=overwrite, remember=remember,
1171
1131
stacked_on=stacked_on, create_prefix=create_prefix,
1172
use_existing_dir=use_existing_dir)
1132
use_existing_dir=use_existing_dir, no_tree=no_tree)
1175
1135
class cmd_branch(Command):
1189
1149
_see_also = ['checkout']
1190
1150
takes_args = ['from_location', 'to_location?']
1191
takes_options = ['revision', Option('hardlink',
1192
help='Hard-link working tree files where possible.'),
1151
takes_options = ['revision',
1152
Option('hardlink', help='Hard-link working tree files where possible.'),
1153
Option('files-from', type=str,
1154
help="Get file contents from this tree."),
1193
1155
Option('no-tree',
1194
1156
help="Create a branch without a working-tree."),
1195
1157
Option('switch',
1214
1176
def run(self, from_location, to_location=None, revision=None,
1215
1177
hardlink=False, stacked=False, standalone=False, no_tree=False,
1216
use_existing_dir=False, switch=False, bind=False):
1178
use_existing_dir=False, switch=False, bind=False,
1217
1180
from bzrlib import switch as _mod_switch
1218
1181
from bzrlib.tag import _merge_tags_if_possible
1219
1182
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1184
if not (hardlink or files_from):
1185
# accelerator_tree is usually slower because you have to read N
1186
# files (no readahead, lots of seeks, etc), but allow the user to
1187
# explicitly request it
1188
accelerator_tree = None
1189
if files_from is not None and files_from != from_location:
1190
accelerator_tree = WorkingTree.open(files_from)
1221
1191
revision = _get_one_revision('branch', revision)
1223
self.add_cleanup(br_from.unlock)
1192
self.add_cleanup(br_from.lock_read().unlock)
1224
1193
if revision is not None:
1225
1194
revision_id = revision.as_revision_id(br_from)
1331
1300
to_location = branch_location
1332
1301
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1333
1302
branch_location)
1303
if not (hardlink or files_from):
1304
# accelerator_tree is usually slower because you have to read N
1305
# files (no readahead, lots of seeks, etc), but allow the user to
1306
# explicitly request it
1307
accelerator_tree = None
1334
1308
revision = _get_one_revision('checkout', revision)
1335
if files_from is not None:
1309
if files_from is not None and files_from != branch_location:
1336
1310
accelerator_tree = WorkingTree.open(files_from)
1337
1311
if revision is not None:
1338
1312
revision_id = revision.as_revision_id(source)
1396
1368
If you want to discard your local changes, you can just do a
1397
1369
'bzr revert' instead of 'bzr commit' after the update.
1371
If you want to restore a file that has been removed locally, use
1372
'bzr revert' instead of 'bzr update'.
1399
1374
If the tree's branch is bound to a master branch, it will also update
1400
1375
the branch from the master.
1403
1378
_see_also = ['pull', 'working-trees', 'status-flags']
1404
1379
takes_args = ['dir?']
1405
takes_options = ['revision']
1380
takes_options = ['revision',
1382
help="Show base revision text in conflicts."),
1406
1384
aliases = ['up']
1408
def run(self, dir='.', revision=None):
1386
def run(self, dir='.', revision=None, show_base=None):
1409
1387
if revision is not None and len(revision) != 1:
1410
1388
raise errors.BzrCommandError(
1411
1389
"bzr update --revision takes exactly one revision")
1519
1498
class cmd_remove(Command):
1520
1499
__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.
1501
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1502
delete them if they can easily be recovered using revert otherwise they
1503
will be backed up (adding an extention of the form .~#~). If no options or
1504
parameters are given Bazaar will scan for files that are being tracked by
1505
Bazaar but missing in your tree and stop tracking them for you.
1527
1507
takes_args = ['file*']
1528
1508
takes_options = ['verbose',
1530
1510
RegistryOption.from_kwargs('file-deletion-strategy',
1531
1511
'The file deletion mode to be used.',
1532
1512
title='Deletion Strategy', value_switches=True, enum_switch=False,
1533
safe='Only delete files if they can be'
1534
' safely recovered (default).',
1513
safe='Backup changed files (default).',
1535
1514
keep='Delete from bzr but leave the working copy.',
1515
no_backup='Don\'t backup changed files.',
1536
1516
force='Delete all the specified files, even if they can not be '
1537
'recovered and even if they are non-empty directories.')]
1517
'recovered and even if they are non-empty directories. '
1518
'(deprecated, use no-backup)')]
1538
1519
aliases = ['rm', 'del']
1539
1520
encoding_type = 'replace'
1541
1522
def run(self, file_list, verbose=False, new=False,
1542
1523
file_deletion_strategy='safe'):
1543
tree, file_list = tree_files(file_list)
1524
if file_deletion_strategy == 'force':
1525
note("(The --force option is deprecated, rather use --no-backup "
1527
file_deletion_strategy = 'no-backup'
1529
tree, file_list = WorkingTree.open_containing_paths(file_list)
1545
1531
if file_list is not None:
1546
1532
file_list = [f for f in file_list]
1549
self.add_cleanup(tree.unlock)
1534
self.add_cleanup(tree.lock_write().unlock)
1550
1535
# Heuristics should probably all move into tree.remove_smart or
1636
1621
_see_also = ['check']
1637
1622
takes_args = ['branch?']
1624
Option('canonicalize-chks',
1625
help='Make sure CHKs are in canonical form (repairs '
1639
def run(self, branch="."):
1630
def run(self, branch=".", canonicalize_chks=False):
1640
1631
from bzrlib.reconcile import reconcile
1641
1632
dir = bzrdir.BzrDir.open(branch)
1633
reconcile(dir, canonicalize_chks=canonicalize_chks)
1645
1636
class cmd_revision_history(Command):
1723
1714
Option('append-revisions-only',
1724
1715
help='Never change revnos or the existing log.'
1725
' Append revisions to it only.')
1716
' Append revisions to it only.'),
1718
'Create a branch without a working tree.')
1727
1720
def run(self, location=None, format=None, append_revisions_only=False,
1728
create_prefix=False):
1721
create_prefix=False, no_tree=False):
1729
1722
if format is None:
1730
1723
format = bzrdir.format_registry.make_bzrdir('default')
1731
1724
if location is None:
1985
2000
old_branch, new_branch,
1986
2001
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
2002
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2003
# GNU diff on Windows uses ANSI encoding for filenames
2004
path_encoding = osutils.get_diff_header_encoding()
1988
2005
return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
2006
specific_files=specific_files,
1990
2007
external_diff_options=diff_options,
1991
2008
old_label=old_label, new_label=new_label,
1992
extra_trees=extra_trees, using=using,
2009
extra_trees=extra_trees,
2010
path_encoding=path_encoding,
1993
2012
format_cls=format)
2003
2022
# level of effort but possibly much less IO. (Or possibly not,
2004
2023
# if the directories are very large...)
2005
2024
_see_also = ['status', 'ls']
2006
takes_options = ['show-ids']
2025
takes_options = ['directory', 'show-ids']
2008
2027
@display_command
2009
def run(self, show_ids=False):
2010
tree = WorkingTree.open_containing(u'.')[0]
2012
self.add_cleanup(tree.unlock)
2028
def run(self, show_ids=False, directory=u'.'):
2029
tree = WorkingTree.open_containing(directory)[0]
2030
self.add_cleanup(tree.lock_read().unlock)
2013
2031
old = tree.basis_tree()
2015
self.add_cleanup(old.unlock)
2032
self.add_cleanup(old.lock_read().unlock)
2016
2033
for path, ie in old.inventory.iter_entries():
2017
2034
if not tree.has_id(ie.file_id):
2018
2035
self.outf.write(path)
2030
2047
_see_also = ['status', 'ls']
2033
help='Write an ascii NUL (\\0) separator '
2034
'between files rather than a newline.')
2048
takes_options = ['directory', 'null']
2037
2050
@display_command
2038
def run(self, null=False):
2039
tree = WorkingTree.open_containing(u'.')[0]
2051
def run(self, null=False, directory=u'.'):
2052
tree = WorkingTree.open_containing(directory)[0]
2053
self.add_cleanup(tree.lock_read().unlock)
2040
2054
td = tree.changes_from(tree.basis_tree())
2041
2056
for path, id, kind, text_modified, meta_modified in td.modified:
2043
2058
self.outf.write(path + '\0')
2053
2068
_see_also = ['status', 'ls']
2056
help='Write an ascii NUL (\\0) separator '
2057
'between files rather than a newline.')
2069
takes_options = ['directory', 'null']
2060
2071
@display_command
2061
def run(self, null=False):
2062
wt = WorkingTree.open_containing(u'.')[0]
2064
self.add_cleanup(wt.unlock)
2072
def run(self, null=False, directory=u'.'):
2073
wt = WorkingTree.open_containing(directory)[0]
2074
self.add_cleanup(wt.lock_read().unlock)
2065
2075
basis = wt.basis_tree()
2067
self.add_cleanup(basis.unlock)
2076
self.add_cleanup(basis.lock_read().unlock)
2068
2077
basis_inv = basis.inventory
2069
2078
inv = wt.inventory
2070
2079
for file_id in inv:
2528
2541
help='Recurse into subdirectories.'),
2529
2542
Option('from-root',
2530
2543
help='Print paths relative to the root of the branch.'),
2531
Option('unknown', help='Print unknown files.'),
2544
Option('unknown', short_name='u',
2545
help='Print unknown files.'),
2532
2546
Option('versioned', help='Print versioned files.',
2533
2547
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.'),
2548
Option('ignored', short_name='i',
2549
help='Print ignored files.'),
2550
Option('kind', short_name='k',
2539
2551
help='List entries of a particular kind: file, directory, symlink.',
2543
2557
@display_command
2544
2558
def run(self, revision=None, verbose=False,
2545
2559
recursive=False, from_root=False,
2546
2560
unknown=False, versioned=False, ignored=False,
2547
null=False, kind=None, show_ids=False, path=None):
2561
null=False, kind=None, show_ids=False, path=None, directory=None):
2549
2563
if kind and kind not in ('file', 'directory', 'symlink'):
2550
2564
raise errors.BzrCommandError('invalid kind specified')
2713
2736
_see_also = ['status', 'ignored', 'patterns']
2714
2737
takes_args = ['name_pattern*']
2738
takes_options = ['directory',
2716
2739
Option('default-rules',
2717
2740
help='Display the default ignore rules that bzr uses.')
2720
def run(self, name_pattern_list=None, default_rules=None):
2743
def run(self, name_pattern_list=None, default_rules=None,
2721
2745
from bzrlib import ignores
2722
2746
if default_rules is not None:
2723
2747
# dump the default rules and exit
2729
2753
"NAME_PATTERN or --default-rules.")
2730
2754
name_pattern_list = [globbing.normalize_pattern(p)
2731
2755
for p in name_pattern_list]
2757
for p in name_pattern_list:
2758
if not globbing.Globster.is_pattern_valid(p):
2759
bad_patterns += ('\n %s' % p)
2761
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2762
ui.ui_factory.show_error(msg)
2763
raise errors.InvalidPattern('')
2732
2764
for name_pattern in name_pattern_list:
2733
2765
if (name_pattern[0] == '/' or
2734
2766
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2735
2767
raise errors.BzrCommandError(
2736
2768
"NAME_PATTERN should not be an absolute path")
2737
tree, relpath = WorkingTree.open_containing(u'.')
2769
tree, relpath = WorkingTree.open_containing(directory)
2738
2770
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2739
2771
ignored = globbing.Globster(name_pattern_list)
2773
self.add_cleanup(tree.lock_read().unlock)
2742
2774
for entry in tree.list_files():
2744
2776
if id is not None:
2745
2777
filename = entry[0]
2746
2778
if ignored.match(filename):
2747
2779
matches.append(filename)
2749
2780
if len(matches) > 0:
2750
2781
self.outf.write("Warning: the following files are version controlled and"
2751
2782
" match your ignore pattern:\n%s"
2767
2798
encoding_type = 'replace'
2768
2799
_see_also = ['ignore', 'ls']
2800
takes_options = ['directory']
2770
2802
@display_command
2772
tree = WorkingTree.open_containing(u'.')[0]
2774
self.add_cleanup(tree.unlock)
2803
def run(self, directory=u'.'):
2804
tree = WorkingTree.open_containing(directory)[0]
2805
self.add_cleanup(tree.lock_read().unlock)
2775
2806
for path, file_class, kind, file_id, entry in tree.list_files():
2776
2807
if file_class != 'I':
2844
2876
'revision in which it was changed.'),
2846
2878
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
root=None, filters=False, per_file_timestamps=False):
2879
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2848
2880
from bzrlib.export import export
2850
2882
if branch_or_subdir is None:
2851
tree = WorkingTree.open_containing(u'.')[0]
2883
tree = WorkingTree.open_containing(directory)[0]
2852
2884
b = tree.branch
2885
2917
@display_command
2886
2918
def run(self, filename, revision=None, name_from_revision=False,
2919
filters=False, directory=None):
2888
2920
if revision is not None and len(revision) != 1:
2889
2921
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2890
2922
" one revision specifier")
2891
2923
tree, branch, relpath = \
2892
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2894
self.add_cleanup(branch.unlock)
2924
_open_directory_or_containing_tree_or_branch(filename, directory)
2925
self.add_cleanup(branch.lock_read().unlock)
2895
2926
return self._run(tree, branch, relpath, filename, revision,
2896
2927
name_from_revision, filters)
3297
3330
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.
3331
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3333
When the default format has changed after a major new release of
3334
Bazaar, you may be informed during certain operations that you
3335
should upgrade. Upgrading to a newer format may improve performance
3336
or make new features available. It may however limit interoperability
3337
with older repositories or with older versions of Bazaar.
3339
If you wish to upgrade to a particular format rather than the
3340
current default, that can be specified using the --format option.
3341
As a consequence, you can use the upgrade command this way to
3342
"downgrade" to an earlier format, though some conversions are
3343
a one way process (e.g. changing from the 1.x default to the
3344
2.x default) so downgrading is not always possible.
3346
A backup.bzr.~#~ directory is created at the start of the conversion
3347
process (where # is a number). By default, this is left there on
3348
completion. If the conversion fails, delete the new .bzr directory
3349
and rename this one back in its place. Use the --clean option to ask
3350
for the backup.bzr directory to be removed on successful conversion.
3351
Alternatively, you can delete it by hand if everything looks good
3354
If the location given is a shared repository, dependent branches
3355
are also converted provided the repository converts successfully.
3356
If the conversion of a branch fails, remaining branches are still
3359
For more information on upgrades, see the Bazaar Upgrade Guide,
3360
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3305
_see_also = ['check']
3363
_see_also = ['check', 'reconcile', 'formats']
3306
3364
takes_args = ['url?']
3307
3365
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'),
3366
RegistryOption('format',
3367
help='Upgrade to a specific format. See "bzr help'
3368
' formats" for details.',
3369
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3370
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3371
value_switches=True, title='Branch format'),
3373
help='Remove the backup.bzr directory if successful.'),
3375
help="Show what would be done, but don't actually do anything."),
3316
def run(self, url='.', format=None):
3378
def run(self, url='.', format=None, clean=False, dry_run=False):
3317
3379
from bzrlib.upgrade import upgrade
3318
upgrade(url, format)
3380
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3382
if len(exceptions) == 1:
3383
# Compatibility with historical behavior
3321
3389
class cmd_whoami(Command):
3340
3409
encoding_type = 'replace'
3342
3411
@display_command
3343
def run(self, email=False, branch=False, name=None):
3412
def run(self, email=False, branch=False, name=None, directory=None):
3344
3413
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()
3414
if directory is None:
3415
# use branch if we're inside one; otherwise global config
3417
c = Branch.open_containing(u'.')[0].get_config()
3418
except errors.NotBranchError:
3419
c = _mod_config.GlobalConfig()
3421
c = Branch.open(directory).get_config()
3351
3423
self.outf.write(c.user_email() + '\n')
3356
3428
# display a warning if an email address isn't included in the given name.
3358
config.extract_email_address(name)
3430
_mod_config.extract_email_address(name)
3359
3431
except errors.NoEmailInUsername, e:
3360
3432
warning('"%s" does not seem to contain an email address. '
3361
3433
'This is allowed, but not recommended.', name)
3363
3435
# use global config unless --branch given
3365
c = Branch.open_containing('.')[0].get_config()
3437
if directory is None:
3438
c = Branch.open_containing(u'.')[0].get_config()
3440
c = Branch.open(directory).get_config()
3367
c = config.GlobalConfig()
3442
c = _mod_config.GlobalConfig()
3368
3443
c.set_user_option('email', name)
3436
3512
'bzr alias --remove expects an alias to remove.')
3437
3513
# If alias is not found, print something like:
3438
3514
# unalias: foo: not found
3439
c = config.GlobalConfig()
3515
c = _mod_config.GlobalConfig()
3440
3516
c.unset_alias(alias_name)
3442
3518
@display_command
3443
3519
def print_aliases(self):
3444
3520
"""Print out the defined aliases in a similar format to bash."""
3445
aliases = config.GlobalConfig().get_aliases()
3521
aliases = _mod_config.GlobalConfig().get_aliases()
3446
3522
for key, value in sorted(aliases.iteritems()):
3447
3523
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3537
3616
'throughout the test suite.',
3538
3617
type=get_transport_type),
3539
3618
Option('benchmark',
3540
help='Run the benchmarks rather than selftests.'),
3619
help='Run the benchmarks rather than selftests.',
3541
3621
Option('lsprof-timed',
3542
3622
help='Generate lsprof output for benchmarked'
3543
3623
' sections of code.'),
3544
3624
Option('lsprof-tests',
3545
3625
help='Generate lsprof output for each test.'),
3546
Option('cache-dir', type=str,
3547
help='Cache intermediate benchmark output in this '
3549
3626
Option('first',
3550
3627
help='Run all tests, but run specified tests first.',
3551
3628
short_name='f',
3586
3663
def run(self, testspecs_list=None, verbose=False, one=False,
3587
3664
transport=None, benchmark=None,
3588
lsprof_timed=None, cache_dir=None,
3589
3666
first=False, list_only=False,
3590
3667
randomize=None, exclude=None, strict=False,
3591
3668
load_list=None, debugflag=None, starting_with=None, subunit=False,
3592
3669
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)
3670
from bzrlib import tests
3602
3672
if testspecs_list is not None:
3603
3673
pattern = '|'.join(testspecs_list)
3612
3682
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3613
3683
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3614
3684
# stdout, which would corrupt the subunit stream.
3615
if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3685
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3686
# following code can be deleted when it's sufficiently deployed
3687
# -- vila/mgz 20100514
3688
if (sys.platform == "win32"
3689
and getattr(sys.stdout, 'fileno', None) is not None):
3617
3691
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3619
3693
self.additional_selftest_args.setdefault(
3620
3694
'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
3696
raise errors.BzrCommandError(
3697
"--benchmark is no longer supported from bzr 2.2; "
3698
"use bzr-usertest instead")
3699
test_suite_factory = None
3631
3700
selftest_kwargs = {"verbose": verbose,
3632
3701
"pattern": pattern,
3633
3702
"stop_on_failure": one,
3711
3784
with bzr send. If neither is specified, the default is the upstream branch
3712
3785
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.
3787
When merging from a branch, by default bzr will try to merge in all new
3788
work from the other branch, automatically determining an appropriate base
3789
revision. If this fails, you may need to give an explicit base.
3791
To pick a different ending revision, pass "--revision OTHER". bzr will
3792
try to merge in all new work up to and including revision OTHER.
3794
If you specify two values, "--revision BASE..OTHER", only revisions BASE
3795
through OTHER, excluding BASE but including OTHER, will be merged. If this
3796
causes some revisions to be skipped, i.e. if the destination branch does
3797
not already contain revision BASE, such a merge is commonly referred to as
3800
Revision numbers are always relative to the source branch.
3725
3802
Merge will do its best to combine the changes in two branches, but there
3726
3803
are some kinds of problems only a human can fix. When it encounters those,
3793
3870
' completely merged into the source, pull from the'
3794
3871
' source rather than merging. When this happens,'
3795
3872
' you do not need to commit the result.'),
3873
custom_help('directory',
3797
3874
help='Branch to merge into, '
3798
'rather than the one containing the working directory.',
3875
'rather than the one containing the working directory.'),
3802
3876
Option('preview', help='Instead of merging, show a diff of the'
3804
3878
Option('interactive', help='Select changes interactively.',
3905
3978
def _do_preview(self, merger):
3906
3979
from bzrlib.diff import show_diff_trees
3907
3980
result_tree = self._get_preview(merger)
3981
path_encoding = osutils.get_diff_header_encoding()
3908
3982
show_diff_trees(merger.this_tree, result_tree, self.outf,
3909
old_label='', new_label='')
3983
old_label='', new_label='',
3984
path_encoding=path_encoding)
3911
3986
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3912
3987
merger.change_reporter = change_reporter
3992
4067
if ((remember or tree.branch.get_submit_branch() is None) and
3993
4068
user_location is not None):
3994
4069
tree.branch.set_submit_branch(other_branch.base)
3995
_merge_tags_if_possible(other_branch, tree.branch)
4070
# Merge tags (but don't set them in the master branch yet, the user
4071
# might revert this merge). Commit will propagate them.
4072
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
3996
4073
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3997
4074
other_revision_id, base_revision_id, other_branch, base_branch)
3998
4075
if other_path != '':
4167
4243
last committed revision is used.
4169
4245
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.
4246
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4247
will remove the changes introduced by the second last commit (-2), without
4248
affecting the changes introduced by the last commit (-1). To remove
4249
certain changes on a hunk-by-hunk basis, see the shelve command.
4174
4251
By default, any files that have been manually changed will be backed up
4175
4252
first. (Files changed only by merge are not backed up.) Backup files have
4340
4417
theirs_only=False,
4341
4418
log_format=None, long=False, short=False, line=False,
4342
4419
show_ids=False, verbose=False, this=False, other=False,
4343
include_merges=False, revision=None, my_revision=None):
4420
include_merges=False, revision=None, my_revision=None,
4344
4422
from bzrlib.missing import find_unmerged, iter_log_revisions
4345
4423
def message(s):
4346
4424
if not is_quiet():
4507
4582
@display_command
4508
4583
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")
4584
from bzrlib import plugin
4585
self.outf.writelines(
4586
plugin.describe_plugins(show_paths=verbose))
4531
4589
class cmd_testament(Command):
4578
4635
Option('long', help='Show commit date in annotations.'),
4582
4640
encoding_type = 'exact'
4584
4642
@display_command
4585
4643
def run(self, filename, all=False, long=False, revision=None,
4644
show_ids=False, directory=None):
4587
4645
from bzrlib.annotate import annotate_file, annotate_file_tree
4588
4646
wt, branch, relpath = \
4589
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4647
_open_directory_or_containing_tree_or_branch(filename, directory)
4590
4648
if wt is not None:
4592
self.add_cleanup(wt.unlock)
4649
self.add_cleanup(wt.lock_read().unlock)
4595
self.add_cleanup(branch.unlock)
4651
self.add_cleanup(branch.lock_read().unlock)
4596
4652
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4598
self.add_cleanup(tree.unlock)
4653
self.add_cleanup(tree.lock_read().unlock)
4599
4654
if wt is not None:
4600
4655
file_id = wt.path2id(relpath)
4620
4675
hidden = True # is this right ?
4621
4676
takes_args = ['revision_id*']
4622
takes_options = ['revision']
4677
takes_options = ['directory', 'revision']
4624
def run(self, revision_id_list=None, revision=None):
4679
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4625
4680
if revision_id_list is not None and revision is not None:
4626
4681
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4627
4682
if revision_id_list is None and revision is None:
4628
4683
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)
4684
b = WorkingTree.open_containing(directory)[0].branch
4685
self.add_cleanup(b.lock_write().unlock)
4632
4686
return self._run(b, revision_id_list, revision)
4634
4688
def _run(self, b, revision_id_list, revision):
4694
4748
_see_also = ['checkouts', 'unbind']
4695
4749
takes_args = ['location?']
4750
takes_options = ['directory']
4698
def run(self, location=None):
4699
b, relpath = Branch.open_containing(u'.')
4752
def run(self, location=None, directory=u'.'):
4753
b, relpath = Branch.open_containing(directory)
4700
4754
if location is None:
4702
4756
location = b.get_old_bound_location()
4784
4838
b = control.open_branch()
4786
4840
if tree is not None:
4788
self.add_cleanup(tree.unlock)
4841
self.add_cleanup(tree.lock_write().unlock)
4791
self.add_cleanup(b.unlock)
4843
self.add_cleanup(b.lock_write().unlock)
4792
4844
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4794
4846
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4859
4917
bzr break-lock bzr+ssh://example.com/bzr/foo
4918
bzr break-lock --conf ~/.bazaar
4861
4921
takes_args = ['location?']
4924
help='LOCATION is the directory where the config lock is.'),
4926
help='Do not ask for confirmation before breaking the lock.'),
4863
def run(self, location=None, show=False):
4929
def run(self, location=None, config=False, force=False):
4864
4930
if location is None:
4865
4931
location = u'.'
4866
control, relpath = bzrdir.BzrDir.open_containing(location)
4868
control.break_lock()
4869
except NotImplementedError:
4933
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
4935
{'bzrlib.lockdir.break': True})
4937
conf = _mod_config.LockableConfig(file_name=location)
4940
control, relpath = bzrdir.BzrDir.open_containing(location)
4942
control.break_lock()
4943
except NotImplementedError:
4873
4947
class cmd_wait_until_signalled(Command):
4938
5011
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4939
5012
protocol=None):
4940
from bzrlib.transport import get_transport, transport_server_registry
5013
from bzrlib import transport
4941
5014
if directory is None:
4942
5015
directory = os.getcwd()
4943
5016
if protocol is None:
4944
protocol = transport_server_registry.get()
5017
protocol = transport.transport_server_registry.get()
4945
5018
host, port = self.get_host_and_port(port)
4946
5019
url = urlutils.local_path_to_url(directory)
4947
5020
if not allow_writes:
4948
5021
url = 'readonly+' + url
4949
transport = get_transport(url)
4950
protocol(transport, host, port, inet)
5022
t = transport.get_transport(url)
5023
protocol(t, host, port, inet)
4953
5026
class cmd_join(Command):
5064
5138
encoding_type = 'exact'
5066
5140
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5067
sign=False, revision=None, mail_to=None, message=None):
5141
sign=False, revision=None, mail_to=None, message=None,
5068
5143
from bzrlib.revision import ensure_null, NULL_REVISION
5069
5144
include_patch, include_bundle = {
5070
5145
'plain': (False, False),
5071
5146
'diff': (True, False),
5072
5147
'bundle': (True, True),
5074
branch = Branch.open('.')
5149
branch = Branch.open(directory)
5075
5150
stored_submit_branch = branch.get_submit_branch()
5076
5151
if submit_branch is None:
5077
5152
submit_branch = stored_submit_branch
5393
5464
_see_also = ['tag']
5394
5465
takes_options = [
5396
help='Branch whose tags should be displayed.',
5400
RegistryOption.from_kwargs('sort',
5466
custom_help('directory',
5467
help='Branch whose tags should be displayed.'),
5468
RegistryOption('sort',
5401
5469
'Sort tags by different criteria.', title='Sorting',
5402
alpha='Sort tags lexicographically (default).',
5403
time='Sort tags chronologically.',
5470
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5409
5476
@display_command
5477
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5478
from bzrlib.tag import tag_sort_methods
5416
5479
branch, relpath = Branch.open_containing(directory)
5418
5481
tags = branch.tags.get_tag_dict().items()
5423
self.add_cleanup(branch.unlock)
5485
self.add_cleanup(branch.lock_read().unlock)
5425
5487
graph = branch.repository.get_graph()
5426
5488
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5428
5490
# only show revisions between revid1 and revid2 (inclusive)
5429
5491
tags = [(tag, revid) for tag, revid in tags if
5430
5492
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]])
5494
sort = tag_sort_methods.get()
5444
5496
if not show_ids:
5445
5497
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5446
5498
for index, (tag, revid) in enumerate(tags):
5584
5637
def run(self, to_location=None, force=False, create_branch=False,
5638
revision=None, directory=u'.'):
5586
5639
from bzrlib import switch
5640
tree_location = directory
5588
5641
revision = _get_one_revision('switch', revision)
5589
5642
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5590
5643
if to_location is None:
5591
5644
if revision is None:
5592
5645
raise errors.BzrCommandError('You must supply either a'
5593
5646
' revision or a location')
5647
to_location = tree_location
5596
5649
branch = control_dir.open_branch()
5597
5650
had_explicit_nick = branch.get_config().has_explicit_nickname()
5868
5922
You can put multiple items on the shelf, and by default, 'unshelve' will
5869
5923
restore the most recently shelved changes.
5925
For complicated changes, it is possible to edit the changes in a separate
5926
editor program to decide what the file remaining in the working copy
5927
should look like. To do this, add the configuration option
5929
change_editor = PROGRAM @new_path @old_path
5931
where @new_path is replaced with the path of the new version of the
5932
file and @old_path is replaced with the path of the old version of
5933
the file. The PROGRAM should save the new file with the desired
5934
contents of the file in the working tree.
5872
5938
takes_args = ['file*']
5874
5940
takes_options = [
5876
5943
Option('all', help='Shelve all changes.'),
5883
5950
Option('destroy',
5884
5951
help='Destroy removed changes instead of shelving them.'),
5886
_see_also = ['unshelve']
5953
_see_also = ['unshelve', 'configuration']
5888
5955
def run(self, revision=None, all=False, file_list=None, message=None,
5889
writer=None, list=False, destroy=False):
5956
writer=None, list=False, destroy=False, directory=None):
5891
return self.run_for_list()
5958
return self.run_for_list(directory=directory)
5892
5959
from bzrlib.shelf_ui import Shelver
5893
5960
if writer is None:
5894
5961
writer = bzrlib.option.diff_writer_registry.get()
5896
5963
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5897
file_list, message, destroy=destroy)
5964
file_list, message, destroy=destroy, directory=directory)
5967
6036
To check what clean-tree will do, use --dry-run.
5969
takes_options = [Option('ignored', help='Delete all ignored files.'),
6038
takes_options = ['directory',
6039
Option('ignored', help='Delete all ignored files.'),
5970
6040
Option('detritus', help='Delete conflict files, merge'
5971
6041
' backups, and failed selftest dirs.'),
5972
6042
Option('unknown',
5975
6045
' deleting them.'),
5976
6046
Option('force', help='Do not prompt before deleting.')]
5977
6047
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6048
force=False, directory=u'.'):
5979
6049
from bzrlib.clean_tree import clean_tree
5980
6050
if not (unknown or ignored or detritus):
5984
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5985
dry_run=dry_run, no_prompt=force)
6054
clean_tree(directory, unknown=unknown, ignored=ignored,
6055
detritus=detritus, dry_run=dry_run, no_prompt=force)
5988
6058
class cmd_reference(Command):
6037
6107
# be only called once.
6038
6108
for (name, aliases, module_name) in [
6039
6109
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6110
('cmd_config', [], 'bzrlib.config'),
6040
6111
('cmd_dpush', [], 'bzrlib.foreign'),
6041
6112
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6042
6113
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6043
6114
('cmd_conflicts', [], 'bzrlib.conflicts'),
6044
6115
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6116
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6046
6118
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
