45
46
revision as _mod_revision,
54
55
from bzrlib.branch import Branch
55
56
from bzrlib.conflicts import ConflictList
56
from bzrlib.transport import memory
57
57
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
58
58
from bzrlib.smtp_connection import SMTPConnection
59
59
from bzrlib.workingtree import WorkingTree
62
from bzrlib.commands import (
64
builtin_command_registry,
62
from bzrlib.commands import Command, display_command
67
63
from bzrlib.option import (
72
68
_parse_revision_str,
74
70
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
80
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
81
73
def tree_files(file_list, default_branch=u'.', canonicalize=True,
83
return internal_tree_files(file_list, default_branch, canonicalize,
76
return internal_tree_files(file_list, default_branch, canonicalize,
78
except errors.FileInWrongBranch, e:
79
raise errors.BzrCommandError("%s is not in the same branch as %s" %
80
(e.path, file_list[0]))
87
83
def tree_files_for_add(file_list):
174
167
:return: workingtree, [relative_paths]
176
return WorkingTree.open_containing_paths(
177
file_list, default_directory='.',
169
if file_list is None or len(file_list) == 0:
170
tree = WorkingTree.open_containing(default_branch)[0]
171
if tree.supports_views() and apply_view:
172
view_files = tree.views.lookup_view()
174
file_list = view_files
175
view_str = views.view_display_str(view_files)
176
note("Ignoring files outside view. View is %s" % view_str)
177
return tree, file_list
178
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
179
return tree, safe_relpath_files(tree, file_list, canonicalize,
180
apply_view=apply_view)
183
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
184
"""Convert file_list into a list of relpaths in tree.
186
:param tree: A tree to operate on.
187
:param file_list: A list of user provided paths or None.
188
:param apply_view: if True and a view is set, apply it or check that
189
specified files are within it
190
:return: A list of relative paths.
191
:raises errors.PathNotChild: When a provided path is in a different tree
194
if file_list is None:
196
if tree.supports_views() and apply_view:
197
view_files = tree.views.lookup_view()
201
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
202
# doesn't - fix that up here before we enter the loop.
204
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
207
for filename in file_list:
209
relpath = fixer(osutils.dereference_path(filename))
210
if view_files and not osutils.is_inside_any(view_files, relpath):
211
raise errors.FileOutsideView(filename, view_files)
212
new_list.append(relpath)
213
except errors.PathNotChild:
214
raise errors.FileInWrongBranch(tree.branch, filename)
182
218
def _get_view_info_for_change_reporter(tree):
233
261
Not versioned and not matching an ignore pattern.
235
Additionally for directories, symlinks and files with a changed
236
executable bit, Bazaar indicates their type using a trailing
237
character: '/', '@' or '*' respectively. These decorations can be
238
disabled using the '--no-classify' option.
263
Additionally for directories, symlinks and files with an executable
264
bit, Bazaar indicates their type using a trailing character: '/', '@'
240
267
To see ignored files use 'bzr ignored'. For details on the
241
268
changes to file texts, use 'bzr diff'.
254
281
To skip the display of pending merge information altogether, use
255
282
the no-pending option or specify a file/directory.
257
To compare the working directory to a specific revision, pass a
258
single revision to the revision argument.
260
To see which files have changed in a specific revision, or between
261
two revisions, pass a revision range to the revision argument.
262
This will produce the same results as calling 'bzr diff --summarize'.
284
If a revision argument is given, the status is calculated against
285
that revision, or between two revisions if two are provided.
265
288
# TODO: --no-recurse, --recurse options
285
305
def run(self, show_ids=False, file_list=None, revision=None, short=False,
286
versioned=False, no_pending=False, verbose=False,
306
versioned=False, no_pending=False, verbose=False):
288
307
from bzrlib.status import show_tree_status
290
309
if revision and len(revision) > 2:
291
310
raise errors.BzrCommandError('bzr status --revision takes exactly'
292
311
' one or two revision specifiers')
294
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
313
tree, relfile_list = tree_files(file_list)
295
314
# Avoid asking for specific files when that is not needed.
296
315
if relfile_list == ['']:
297
316
relfile_list = None
304
323
show_tree_status(tree, show_ids=show_ids,
305
324
specific_files=relfile_list, revision=revision,
306
325
to_file=self.outf, short=short, versioned=versioned,
307
show_pending=(not no_pending), verbose=verbose,
308
classify=not no_classify)
326
show_pending=(not no_pending), verbose=verbose)
311
329
class cmd_cat_revision(Command):
312
__doc__ = """Write out metadata for a revision.
330
"""Write out metadata for a revision.
314
332
The revision to print can either be specified by a specific
315
333
revision identifier, or you can use --revision.
319
337
takes_args = ['revision_id?']
320
takes_options = ['directory', 'revision']
338
takes_options = ['revision']
321
339
# cat-revision is more for frontends so should be exact
322
340
encoding = 'strict'
324
def print_revision(self, revisions, revid):
325
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
326
record = stream.next()
327
if record.storage_kind == 'absent':
328
raise errors.NoSuchRevision(revisions, revid)
329
revtext = record.get_bytes_as('fulltext')
330
self.outf.write(revtext.decode('utf-8'))
333
def run(self, revision_id=None, revision=None, directory=u'.'):
343
def run(self, revision_id=None, revision=None):
334
344
if revision_id is not None and revision is not None:
335
345
raise errors.BzrCommandError('You can only supply one of'
336
346
' revision_id or --revision')
337
347
if revision_id is None and revision is None:
338
348
raise errors.BzrCommandError('You must supply either'
339
349
' --revision or a revision_id')
341
b = bzrdir.BzrDir.open_containing_tree_or_branch(directory)[1]
343
revisions = b.repository.revisions
344
if revisions is None:
345
raise errors.BzrCommandError('Repository %r does not support '
346
'access to raw revision texts')
348
b.repository.lock_read()
350
# TODO: jam 20060112 should cat-revision always output utf-8?
351
if revision_id is not None:
352
revision_id = osutils.safe_revision_id(revision_id, warn=False)
354
self.print_revision(revisions, revision_id)
355
except errors.NoSuchRevision:
356
msg = "The repository %s contains no revision %s." % (
357
b.repository.base, revision_id)
358
raise errors.BzrCommandError(msg)
359
elif revision is not None:
362
raise errors.BzrCommandError(
363
'You cannot specify a NULL revision.')
364
rev_id = rev.as_revision_id(b)
365
self.print_revision(revisions, rev_id)
367
b.repository.unlock()
350
b = WorkingTree.open_containing(u'.')[0].branch
352
# TODO: jam 20060112 should cat-revision always output utf-8?
353
if revision_id is not None:
354
revision_id = osutils.safe_revision_id(revision_id, warn=False)
356
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
357
except errors.NoSuchRevision:
358
msg = "The repository %s contains no revision %s." % (b.repository.base,
360
raise errors.BzrCommandError(msg)
361
elif revision is not None:
364
raise errors.BzrCommandError('You cannot specify a NULL'
366
rev_id = rev.as_revision_id(b)
367
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
370
370
class cmd_dump_btree(Command):
371
__doc__ = """Dump the contents of a btree index file to stdout.
371
"""Dump the contents of a btree index file to stdout.
373
373
PATH is a btree index file, it can be any URL. This includes things like
374
374
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
441
438
for node in bt.iter_all_entries():
442
439
# Node is made up of:
443
440
# (index, key, value, [references])
447
refs_as_tuples = None
449
refs_as_tuples = static_tuple.as_tuples(refs)
441
refs_as_tuples = static_tuple.as_tuples(node[3])
450
442
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
451
443
self.outf.write('%s\n' % (as_tuple,))
454
446
class cmd_remove_tree(Command):
455
__doc__ = """Remove the working tree from a given branch/checkout.
447
"""Remove the working tree from a given branch/checkout.
457
449
Since a lightweight checkout is little more than a working tree
458
450
this will refuse to run against one.
460
452
To re-create the working tree, use "bzr checkout".
462
454
_see_also = ['checkout', 'working-trees']
463
takes_args = ['location*']
455
takes_args = ['location?']
464
456
takes_options = [
466
458
help='Remove the working tree even if it has '
467
'uncommitted or shelved changes.'),
459
'uncommitted changes.'),
470
def run(self, location_list, force=False):
471
if not location_list:
474
for location in location_list:
475
d = bzrdir.BzrDir.open(location)
478
working = d.open_workingtree()
479
except errors.NoWorkingTree:
480
raise errors.BzrCommandError("No working tree to remove")
481
except errors.NotLocalUrl:
482
raise errors.BzrCommandError("You cannot remove the working tree"
485
if (working.has_changes()):
486
raise errors.UncommittedChanges(working)
487
if working.get_shelf_manager().last_shelf() is not None:
488
raise errors.ShelvedChanges(working)
490
if working.user_url != working.branch.user_url:
491
raise errors.BzrCommandError("You cannot remove the working tree"
492
" from a lightweight checkout")
494
d.destroy_workingtree()
497
class cmd_repair_workingtree(Command):
498
__doc__ = """Reset the working tree state file.
500
This is not meant to be used normally, but more as a way to recover from
501
filesystem corruption, etc. This rebuilds the working inventory back to a
502
'known good' state. Any new modifications (adding a file, renaming, etc)
503
will be lost, though modified files will still be detected as such.
505
Most users will want something more like "bzr revert" or "bzr update"
506
unless the state file has become corrupted.
508
By default this attempts to recover the current state by looking at the
509
headers of the state file. If the state file is too corrupted to even do
510
that, you can supply --revision to force the state of the tree.
513
takes_options = ['revision', 'directory',
515
help='Reset the tree even if it doesn\'t appear to be'
520
def run(self, revision=None, directory='.', force=False):
521
tree, _ = WorkingTree.open_containing(directory)
522
self.add_cleanup(tree.lock_tree_write().unlock)
462
def run(self, location='.', force=False):
463
d = bzrdir.BzrDir.open(location)
466
working = d.open_workingtree()
467
except errors.NoWorkingTree:
468
raise errors.BzrCommandError("No working tree to remove")
469
except errors.NotLocalUrl:
470
raise errors.BzrCommandError("You cannot remove the working tree"
526
except errors.BzrError:
527
pass # There seems to be a real error here, so we'll reset
530
raise errors.BzrCommandError(
531
'The tree does not appear to be corrupt. You probably'
532
' want "bzr revert" instead. Use "--force" if you are'
533
' sure you want to reset the working tree.')
537
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
539
tree.reset_state(revision_ids)
540
except errors.BzrError, e:
541
if revision_ids is None:
542
extra = (', the header appears corrupt, try passing -r -1'
543
' to set the state to the last commit')
546
raise errors.BzrCommandError('failed to reset the tree state'
473
if (working.has_changes()):
474
raise errors.UncommittedChanges(working)
476
working_path = working.bzrdir.root_transport.base
477
branch_path = working.branch.bzrdir.root_transport.base
478
if working_path != branch_path:
479
raise errors.BzrCommandError("You cannot remove the working tree"
480
" from a lightweight checkout")
482
d.destroy_workingtree()
550
485
class cmd_revno(Command):
551
__doc__ = """Show current revision number.
486
"""Show current revision number.
553
488
This is equal to the number of revisions on this branch.
575
511
revno = ".".join(str(n) for n in revno_t)
577
513
b = Branch.open_containing(location)[0]
578
self.add_cleanup(b.lock_read().unlock)
515
self.add_cleanup(b.unlock)
579
516
revno = b.revno()
580
517
self.cleanup_now()
581
518
self.outf.write(str(revno) + '\n')
584
521
class cmd_revision_info(Command):
585
__doc__ = """Show revision number and revision id for a given revision identifier.
522
"""Show revision number and revision id for a given revision identifier.
588
525
takes_args = ['revision_info*']
589
526
takes_options = [
591
custom_help('directory',
592
529
help='Branch to examine, '
593
'rather than the one containing the working directory.'),
530
'rather than the one containing the working directory.',
594
534
Option('tree', help='Show revno of working tree'),
871
811
raise errors.BzrCommandError('--after cannot be specified with'
873
work_tree, file_list = WorkingTree.open_containing_paths(
874
names_list, default_directory='.')
875
self.add_cleanup(work_tree.lock_tree_write().unlock)
813
work_tree, file_list = tree_files(names_list, default_branch='.')
814
work_tree.lock_tree_write()
815
self.add_cleanup(work_tree.unlock)
876
816
rename_map.RenameMap.guess_renames(work_tree, dry_run)
878
818
def _run(self, tree, names_list, rel_names, after):
972
912
match the remote one, use pull --overwrite. This will work even if the two
973
913
branches have diverged.
975
If there is no default location set, the first pull will set it (use
976
--no-remember to avoid settting it). After that, you can omit the
977
location to use the default. To change the default, use --remember. The
978
value will only be saved if the remote location can be accessed.
915
If there is no default location set, the first pull will set it. After
916
that, you can omit the location to use the default. To change the
917
default, use --remember. The value will only be saved if the remote
918
location can be accessed.
980
920
Note: The location can be specified either in the form of a branch,
981
921
or in the form of a path to a file containing a merge directive generated
986
926
takes_options = ['remember', 'overwrite', 'revision',
987
927
custom_help('verbose',
988
928
help='Show logs of pulled revisions.'),
989
custom_help('directory',
990
930
help='Branch to pull into, '
991
'rather than the one containing the working directory.'),
931
'rather than the one containing the working directory.',
993
936
help="Perform a local pull in a bound "
994
937
"branch. Local pulls are not applied to "
995
938
"the master branch."
998
help="Show base revision text in conflicts.")
1000
941
takes_args = ['location?']
1001
942
encoding_type = 'replace'
1003
def run(self, location=None, remember=None, overwrite=False,
944
def run(self, location=None, remember=False, overwrite=False,
1004
945
revision=None, verbose=False,
1005
directory=None, local=False,
946
directory=None, local=False):
1007
947
# FIXME: too much stuff is in the command class
1008
948
revision_id = None
1009
949
mergeable = None
1057
992
branch_from = Branch.open(location,
1058
993
possible_transports=possible_transports)
1059
self.add_cleanup(branch_from.lock_read().unlock)
1060
# Remembers if asked explicitly or no previous location is set
1062
or (remember is None and branch_to.get_parent() is None)):
995
if branch_to.get_parent() is None or remember:
1063
996
branch_to.set_parent(branch_from.base)
998
if branch_from is not branch_to:
999
branch_from.lock_read()
1000
self.add_cleanup(branch_from.unlock)
1065
1001
if revision is not None:
1066
1002
revision_id = revision.as_revision_id(branch_from)
1004
branch_to.lock_write()
1005
self.add_cleanup(branch_to.unlock)
1068
1006
if tree_to is not None:
1069
1007
view_info = _get_view_info_for_change_reporter(tree_to)
1070
1008
change_reporter = delta._ChangeReporter(
1109
1042
do a merge (see bzr help merge) from the other branch, and commit that.
1110
1043
After that you will be able to do a push without '--overwrite'.
1112
If there is no default push location set, the first push will set it (use
1113
--no-remember to avoid settting it). After that, you can omit the
1114
location to use the default. To change the default, use --remember. The
1115
value will only be saved if the remote location can be accessed.
1045
If there is no default push location set, the first push will set it.
1046
After that, you can omit the location to use the default. To change the
1047
default, use --remember. The value will only be saved if the remote
1048
location can be accessed.
1118
1051
_see_also = ['pull', 'update', 'working-trees']
1139
1075
Option('strict',
1140
1076
help='Refuse to push if there are uncommitted changes in'
1141
1077
' the working tree, --no-strict disables the check.'),
1143
help="Don't populate the working tree, even for protocols"
1144
" that support it."),
1146
1079
takes_args = ['location?']
1147
1080
encoding_type = 'replace'
1149
def run(self, location=None, remember=None, overwrite=False,
1082
def run(self, location=None, remember=False, overwrite=False,
1150
1083
create_prefix=False, verbose=False, revision=None,
1151
1084
use_existing_dir=False, directory=None, stacked_on=None,
1152
stacked=False, strict=None, no_tree=False):
1085
stacked=False, strict=None):
1153
1086
from bzrlib.push import _show_push_branch
1155
1088
if directory is None:
1157
1090
# Get the source branch
1158
1091
(tree, br_from,
1159
1092
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1094
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1095
if strict is None: strict = True # default value
1160
1096
# Get the tip's revision_id
1161
1097
revision = _get_one_revision('push', revision)
1162
1098
if revision is not None:
1163
1099
revision_id = revision.in_history(br_from).rev_id
1165
1101
revision_id = None
1166
if tree is not None and revision_id is None:
1167
tree.check_changed_or_out_of_date(
1168
strict, 'push_strict',
1169
more_error='Use --no-strict to force the push.',
1170
more_warning='Uncommitted changes will not be pushed.')
1102
if strict and tree is not None and revision_id is None:
1103
if (tree.has_changes()):
1104
raise errors.UncommittedChanges(
1105
tree, more='Use --no-strict to force the push.')
1106
if tree.last_revision() != tree.branch.last_revision():
1107
# The tree has lost sync with its branch, there is little
1108
# chance that the user is aware of it but he can still force
1109
# the push with --no-strict
1110
raise errors.OutOfDateTree(
1111
tree, more='Use --no-strict to force the push.')
1171
1113
# Get the stacked_on branch, if any
1172
1114
if stacked_on is not None:
1173
1115
stacked_on = urlutils.normalize_url(stacked_on)
1196
1138
display_url = urlutils.unescape_for_display(stored_loc,
1197
1139
self.outf.encoding)
1198
note("Using saved push location: %s" % display_url)
1140
self.outf.write("Using saved push location: %s\n" % display_url)
1199
1141
location = stored_loc
1201
1143
_show_push_branch(br_from, revision_id, location, self.outf,
1202
1144
verbose=verbose, overwrite=overwrite, remember=remember,
1203
1145
stacked_on=stacked_on, create_prefix=create_prefix,
1204
use_existing_dir=use_existing_dir, no_tree=no_tree)
1146
use_existing_dir=use_existing_dir)
1207
1149
class cmd_branch(Command):
1208
__doc__ = """Create a new branch that is a copy of an existing branch.
1150
"""Create a new branch that is a copy of an existing branch.
1210
1152
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1211
1153
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1217
1159
To retrieve the branch as of a particular revision, supply the --revision
1218
1160
parameter, as in "branch foo/bar -r 5".
1220
The synonyms 'clone' and 'get' for this command are deprecated.
1223
1163
_see_also = ['checkout']
1224
1164
takes_args = ['from_location', 'to_location?']
1225
takes_options = ['revision',
1226
Option('hardlink', help='Hard-link working tree files where possible.'),
1227
Option('files-from', type=str,
1228
help="Get file contents from this tree."),
1165
takes_options = ['revision', Option('hardlink',
1166
help='Hard-link working tree files where possible.'),
1229
1167
Option('no-tree',
1230
1168
help="Create a branch without a working-tree."),
1231
1169
Option('switch',
1250
1188
def run(self, from_location, to_location=None, revision=None,
1251
1189
hardlink=False, stacked=False, standalone=False, no_tree=False,
1252
use_existing_dir=False, switch=False, bind=False,
1190
use_existing_dir=False, switch=False, bind=False):
1254
1191
from bzrlib import switch as _mod_switch
1255
1192
from bzrlib.tag import _merge_tags_if_possible
1256
if self.invoked_as in ['get', 'clone']:
1257
ui.ui_factory.show_user_warning(
1258
'deprecated_command',
1259
deprecated_name=self.invoked_as,
1260
recommended_name='branch',
1261
deprecated_in_version='2.4')
1262
1193
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1264
if not (hardlink or files_from):
1265
# accelerator_tree is usually slower because you have to read N
1266
# files (no readahead, lots of seeks, etc), but allow the user to
1267
# explicitly request it
1268
accelerator_tree = None
1269
if files_from is not None and files_from != from_location:
1270
accelerator_tree = WorkingTree.open(files_from)
1271
1195
revision = _get_one_revision('branch', revision)
1272
self.add_cleanup(br_from.lock_read().unlock)
1197
self.add_cleanup(br_from.unlock)
1273
1198
if revision is not None:
1274
1199
revision_id = revision.as_revision_id(br_from)
1380
1305
to_location = branch_location
1381
1306
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1382
1307
branch_location)
1383
if not (hardlink or files_from):
1384
# accelerator_tree is usually slower because you have to read N
1385
# files (no readahead, lots of seeks, etc), but allow the user to
1386
# explicitly request it
1387
accelerator_tree = None
1388
1308
revision = _get_one_revision('checkout', revision)
1389
if files_from is not None and files_from != branch_location:
1309
if files_from is not None:
1390
1310
accelerator_tree = WorkingTree.open(files_from)
1391
1311
if revision is not None:
1392
1312
revision_id = revision.as_revision_id(source)
1448
1370
If you want to discard your local changes, you can just do a
1449
1371
'bzr revert' instead of 'bzr commit' after the update.
1451
If you want to restore a file that has been removed locally, use
1452
'bzr revert' instead of 'bzr update'.
1454
1373
If the tree's branch is bound to a master branch, it will also update
1455
1374
the branch from the master.
1458
1377
_see_also = ['pull', 'working-trees', 'status-flags']
1459
1378
takes_args = ['dir?']
1460
takes_options = ['revision',
1462
help="Show base revision text in conflicts."),
1379
takes_options = ['revision']
1464
1380
aliases = ['up']
1466
def run(self, dir='.', revision=None, show_base=None):
1382
def run(self, dir='.', revision=None):
1467
1383
if revision is not None and len(revision) != 1:
1468
1384
raise errors.BzrCommandError(
1469
1385
"bzr update --revision takes exactly one revision")
1509
1424
change_reporter,
1510
1425
possible_transports=possible_transports,
1511
1426
revision=revision_id,
1513
show_base=show_base)
1514
1428
except errors.NoSuchRevision, e:
1515
1429
raise errors.BzrCommandError(
1516
1430
"branch has no revision %s\n"
1517
1431
"bzr update --revision only works"
1518
1432
" for a revision in the branch history"
1519
1433
% (e.revision))
1520
revno = tree.branch.revision_id_to_dotted_revno(
1434
revno = tree.branch.revision_id_to_revno(
1521
1435
_mod_revision.ensure_null(tree.last_revision()))
1522
note('Updated to revision %s of branch %s' %
1523
('.'.join(map(str, revno)), branch_location))
1524
parent_ids = tree.get_parent_ids()
1525
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1436
note('Updated to revision %d of branch %s' %
1437
(revno, branch_location))
1438
if tree.get_parent_ids()[1:] != existing_pending_merges:
1526
1439
note('Your local commits will now show as pending merges with '
1527
1440
"'bzr status', and can be committed with 'bzr commit'.")
1528
1441
if conflicts != 0:
1578
1491
class cmd_remove(Command):
1579
__doc__ = """Remove files or directories.
1492
"""Remove files or directories.
1581
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1582
delete them if they can easily be recovered using revert otherwise they
1583
will be backed up (adding an extention of the form .~#~). If no options or
1584
parameters are given Bazaar will scan for files that are being tracked by
1585
Bazaar but missing in your tree and stop tracking them for you.
1494
This makes bzr stop tracking changes to the specified files. bzr will delete
1495
them if they can easily be recovered using revert. If no options or
1496
parameters are given bzr will scan for files that are being tracked by bzr
1497
but missing in your tree and stop tracking them for you.
1587
1499
takes_args = ['file*']
1588
1500
takes_options = ['verbose',
1590
1502
RegistryOption.from_kwargs('file-deletion-strategy',
1591
1503
'The file deletion mode to be used.',
1592
1504
title='Deletion Strategy', value_switches=True, enum_switch=False,
1593
safe='Backup changed files (default).',
1505
safe='Only delete files if they can be'
1506
' safely recovered (default).',
1594
1507
keep='Delete from bzr but leave the working copy.',
1595
no_backup='Don\'t backup changed files.',
1596
1508
force='Delete all the specified files, even if they can not be '
1597
'recovered and even if they are non-empty directories. '
1598
'(deprecated, use no-backup)')]
1509
'recovered and even if they are non-empty directories.')]
1599
1510
aliases = ['rm', 'del']
1600
1511
encoding_type = 'replace'
1602
1513
def run(self, file_list, verbose=False, new=False,
1603
1514
file_deletion_strategy='safe'):
1604
if file_deletion_strategy == 'force':
1605
note("(The --force option is deprecated, rather use --no-backup "
1607
file_deletion_strategy = 'no-backup'
1609
tree, file_list = WorkingTree.open_containing_paths(file_list)
1515
tree, file_list = tree_files(file_list)
1611
1517
if file_list is not None:
1612
1518
file_list = [f for f in file_list]
1614
self.add_cleanup(tree.lock_write().unlock)
1521
self.add_cleanup(tree.unlock)
1615
1522
# Heuristics should probably all move into tree.remove_smart or
1632
1539
file_deletion_strategy = 'keep'
1633
1540
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1634
1541
keep_files=file_deletion_strategy=='keep',
1635
force=(file_deletion_strategy=='no-backup'))
1542
force=file_deletion_strategy=='force')
1638
1545
class cmd_file_id(Command):
1639
__doc__ = """Print file_id of a particular file or directory.
1546
"""Print file_id of a particular file or directory.
1641
1548
The file_id is assigned when the file is first added and remains the
1642
1549
same through all revisions where the file exists, even when it is
1701
1608
_see_also = ['check']
1702
1609
takes_args = ['branch?']
1704
Option('canonicalize-chks',
1705
help='Make sure CHKs are in canonical form (repairs '
1710
def run(self, branch=".", canonicalize_chks=False):
1611
def run(self, branch="."):
1711
1612
from bzrlib.reconcile import reconcile
1712
1613
dir = bzrdir.BzrDir.open(branch)
1713
reconcile(dir, canonicalize_chks=canonicalize_chks)
1716
1617
class cmd_revision_history(Command):
1717
__doc__ = """Display the list of revision ids on a branch."""
1618
"""Display the list of revision ids on a branch."""
1719
1620
_see_also = ['log']
1720
1621
takes_args = ['location?']
1749
1650
last_revision = wt.last_revision()
1751
self.add_cleanup(b.repository.lock_read().unlock)
1752
graph = b.repository.get_graph()
1753
revisions = [revid for revid, parents in
1754
graph.iter_ancestry([last_revision])]
1755
for revision_id in reversed(revisions):
1756
if _mod_revision.is_null(revision_id):
1652
revision_ids = b.repository.get_ancestry(last_revision)
1654
for revision_id in revision_ids:
1758
1655
self.outf.write(revision_id + '\n')
1761
1658
class cmd_init(Command):
1762
__doc__ = """Make a directory into a versioned branch.
1659
"""Make a directory into a versioned branch.
1764
1661
Use this to create an empty branch, or before importing an
1765
1662
existing project.
2044
1917
help='Use this command to compare files.',
2047
RegistryOption('format',
2049
help='Diff format to use.',
2050
lazy_registry=('bzrlib.diff', 'format_registry'),
2051
title='Diff format'),
2053
1921
aliases = ['di', 'dif']
2054
1922
encoding_type = 'exact'
2056
1924
@display_command
2057
1925
def run(self, revision=None, file_list=None, diff_options=None,
2058
prefix=None, old=None, new=None, using=None, format=None):
2059
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1926
prefix=None, old=None, new=None, using=None):
1927
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
2062
1929
if (prefix is None) or (prefix == '0'):
2063
1930
# diff -p0 format
2077
1944
raise errors.BzrCommandError('bzr diff --revision takes exactly'
2078
1945
' one or two revision specifiers')
2080
if using is not None and format is not None:
2081
raise errors.BzrCommandError('--using and --format are mutually '
2084
1947
(old_tree, new_tree,
2085
1948
old_branch, new_branch,
2086
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2087
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2088
# GNU diff on Windows uses ANSI encoding for filenames
2089
path_encoding = osutils.get_diff_header_encoding()
1949
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1950
file_list, revision, old, new, apply_view=True)
2090
1951
return show_diff_trees(old_tree, new_tree, sys.stdout,
2091
1952
specific_files=specific_files,
2092
1953
external_diff_options=diff_options,
2093
1954
old_label=old_label, new_label=new_label,
2094
extra_trees=extra_trees,
2095
path_encoding=path_encoding,
1955
extra_trees=extra_trees, using=using)
2100
1958
class cmd_deleted(Command):
2101
__doc__ = """List files deleted in the working tree.
1959
"""List files deleted in the working tree.
2103
1961
# TODO: Show files deleted since a previous revision, or
2104
1962
# between two revisions.
2107
1965
# level of effort but possibly much less IO. (Or possibly not,
2108
1966
# if the directories are very large...)
2109
1967
_see_also = ['status', 'ls']
2110
takes_options = ['directory', 'show-ids']
1968
takes_options = ['show-ids']
2112
1970
@display_command
2113
def run(self, show_ids=False, directory=u'.'):
2114
tree = WorkingTree.open_containing(directory)[0]
2115
self.add_cleanup(tree.lock_read().unlock)
1971
def run(self, show_ids=False):
1972
tree = WorkingTree.open_containing(u'.')[0]
1974
self.add_cleanup(tree.unlock)
2116
1975
old = tree.basis_tree()
2117
self.add_cleanup(old.lock_read().unlock)
1977
self.add_cleanup(old.unlock)
2118
1978
for path, ie in old.inventory.iter_entries():
2119
1979
if not tree.has_id(ie.file_id):
2120
1980
self.outf.write(path)
2127
1987
class cmd_modified(Command):
2128
__doc__ = """List files modified in working tree.
1988
"""List files modified in working tree.
2132
1992
_see_also = ['status', 'ls']
2133
takes_options = ['directory', 'null']
1995
help='Write an ascii NUL (\\0) separator '
1996
'between files rather than a newline.')
2135
1999
@display_command
2136
def run(self, null=False, directory=u'.'):
2137
tree = WorkingTree.open_containing(directory)[0]
2138
self.add_cleanup(tree.lock_read().unlock)
2000
def run(self, null=False):
2001
tree = WorkingTree.open_containing(u'.')[0]
2139
2002
td = tree.changes_from(tree.basis_tree())
2141
2003
for path, id, kind, text_modified, meta_modified in td.modified:
2143
2005
self.outf.write(path + '\0')
2148
2010
class cmd_added(Command):
2149
__doc__ = """List files added in working tree.
2011
"""List files added in working tree.
2153
2015
_see_also = ['status', 'ls']
2154
takes_options = ['directory', 'null']
2018
help='Write an ascii NUL (\\0) separator '
2019
'between files rather than a newline.')
2156
2022
@display_command
2157
def run(self, null=False, directory=u'.'):
2158
wt = WorkingTree.open_containing(directory)[0]
2159
self.add_cleanup(wt.lock_read().unlock)
2023
def run(self, null=False):
2024
wt = WorkingTree.open_containing(u'.')[0]
2026
self.add_cleanup(wt.unlock)
2160
2027
basis = wt.basis_tree()
2161
self.add_cleanup(basis.lock_read().unlock)
2029
self.add_cleanup(basis.unlock)
2162
2030
basis_inv = basis.inventory
2163
2031
inv = wt.inventory
2164
2032
for file_id in inv:
2165
if basis_inv.has_id(file_id):
2033
if file_id in basis_inv:
2167
2035
if inv.is_root(file_id) and len(basis_inv) == 0:
2169
2037
path = inv.id2path(file_id)
2170
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2038
if not os.access(osutils.abspath(path), os.F_OK):
2173
2041
self.outf.write(path + '\0')
2318
2186
:Other filtering:
2320
The --match option can be used for finding revisions that match a
2321
regular expression in a commit message, committer, author or bug.
2322
Specifying the option several times will match any of the supplied
2323
expressions. --match-author, --match-bugs, --match-committer and
2324
--match-message can be used to only match a specific field.
2188
The --message option can be used for finding revisions that match a
2189
regular expression in a commit message.
2326
2191
:Tips & tricks:
2328
2193
GUI tools and IDEs are often better at exploring history than command
2329
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2330
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2331
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2332
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2194
line tools. You may prefer qlog or viz from the QBzr and Bzr-Gtk packages
2195
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2196
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2198
Web interfaces are often better at exploring history than command line
2199
tools, particularly for branches on servers. You may prefer Loggerhead
2200
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2334
2202
You may find it useful to add the aliases below to ``bazaar.conf``::
2401
2264
help='Show changes made in each revision as a patch.'),
2402
2265
Option('include-merges',
2403
2266
help='Show merged revisions like --levels 0 does.'),
2404
Option('exclude-common-ancestry',
2405
help='Display only the revisions that are not part'
2406
' of both ancestries (require -rX..Y)'
2408
Option('signatures',
2409
help='Show digital signature validity'),
2412
help='Show revisions whose properties match this '
2415
ListOption('match-message',
2416
help='Show revisions whose message matches this '
2419
ListOption('match-committer',
2420
help='Show revisions whose committer matches this '
2423
ListOption('match-author',
2424
help='Show revisions whose authors match this '
2427
ListOption('match-bugs',
2428
help='Show revisions whose bugs match this '
2432
2268
encoding_type = 'replace'
2678
2477
help='Recurse into subdirectories.'),
2679
2478
Option('from-root',
2680
2479
help='Print paths relative to the root of the branch.'),
2681
Option('unknown', short_name='u',
2682
help='Print unknown files.'),
2480
Option('unknown', help='Print unknown files.'),
2683
2481
Option('versioned', help='Print versioned files.',
2684
2482
short_name='V'),
2685
Option('ignored', short_name='i',
2686
help='Print ignored files.'),
2687
Option('kind', short_name='k',
2483
Option('ignored', help='Print ignored files.'),
2485
help='Write an ascii NUL (\\0) separator '
2486
'between files rather than a newline.'),
2688
2488
help='List entries of a particular kind: file, directory, symlink.',
2694
2492
@display_command
2695
2493
def run(self, revision=None, verbose=False,
2696
2494
recursive=False, from_root=False,
2697
2495
unknown=False, versioned=False, ignored=False,
2698
null=False, kind=None, show_ids=False, path=None, directory=None):
2496
null=False, kind=None, show_ids=False, path=None):
2700
2498
if kind and kind not in ('file', 'directory', 'symlink'):
2701
2499
raise errors.BzrCommandError('invalid kind specified')
2873
2656
_see_also = ['status', 'ignored', 'patterns']
2874
2657
takes_args = ['name_pattern*']
2875
takes_options = ['directory',
2876
Option('default-rules',
2877
help='Display the default ignore rules that bzr uses.')
2659
Option('old-default-rules',
2660
help='Write out the ignore rules bzr < 0.9 always used.')
2880
def run(self, name_pattern_list=None, default_rules=None,
2663
def run(self, name_pattern_list=None, old_default_rules=None):
2882
2664
from bzrlib import ignores
2883
if default_rules is not None:
2884
# dump the default rules and exit
2885
for pattern in ignores.USER_DEFAULTS:
2886
self.outf.write("%s\n" % pattern)
2665
if old_default_rules is not None:
2666
# dump the rules and exit
2667
for pattern in ignores.OLD_DEFAULTS:
2888
2670
if not name_pattern_list:
2889
2671
raise errors.BzrCommandError("ignore requires at least one "
2890
"NAME_PATTERN or --default-rules.")
2672
"NAME_PATTERN or --old-default-rules")
2891
2673
name_pattern_list = [globbing.normalize_pattern(p)
2892
2674
for p in name_pattern_list]
2894
for p in name_pattern_list:
2895
if not globbing.Globster.is_pattern_valid(p):
2896
bad_patterns += ('\n %s' % p)
2898
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2899
ui.ui_factory.show_error(msg)
2900
raise errors.InvalidPattern('')
2901
2675
for name_pattern in name_pattern_list:
2902
2676
if (name_pattern[0] == '/' or
2903
2677
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2904
2678
raise errors.BzrCommandError(
2905
2679
"NAME_PATTERN should not be an absolute path")
2906
tree, relpath = WorkingTree.open_containing(directory)
2680
tree, relpath = WorkingTree.open_containing(u'.')
2907
2681
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2908
2682
ignored = globbing.Globster(name_pattern_list)
2910
self.add_cleanup(tree.lock_read().unlock)
2911
2685
for entry in tree.list_files():
2913
2687
if id is not None:
2914
2688
filename = entry[0]
2915
2689
if ignored.match(filename):
2916
matches.append(filename)
2690
matches.append(filename.encode('utf-8'))
2917
2692
if len(matches) > 0:
2918
self.outf.write("Warning: the following files are version controlled and"
2919
" match your ignore pattern:\n%s"
2920
"\nThese files will continue to be version controlled"
2921
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2693
print "Warning: the following files are version controlled and" \
2694
" match your ignore pattern:\n%s" \
2695
"\nThese files will continue to be version controlled" \
2696
" unless you 'bzr remove' them." % ("\n".join(matches),)
2924
2699
class cmd_ignored(Command):
2925
__doc__ = """List ignored files and the patterns that matched them.
2700
"""List ignored files and the patterns that matched them.
2927
2702
List all the ignored files and the ignore pattern that caused the file to
2951
2726
class cmd_lookup_revision(Command):
2952
__doc__ = """Lookup the revision-id from a revision-number
2727
"""Lookup the revision-id from a revision-number
2955
2730
bzr lookup-revision 33
2958
2733
takes_args = ['revno']
2959
takes_options = ['directory']
2961
2735
@display_command
2962
def run(self, revno, directory=u'.'):
2736
def run(self, revno):
2964
2738
revno = int(revno)
2965
2739
except ValueError:
2966
raise errors.BzrCommandError("not a valid revision-number: %r"
2968
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2969
self.outf.write("%s\n" % revid)
2740
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2742
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2972
2745
class cmd_export(Command):
2973
__doc__ = """Export current or past revision to a destination directory or archive.
2746
"""Export current or past revision to a destination directory or archive.
2975
2748
If no revision is specified this exports the last committed revision.
3011
2783
help="Name of the root directory inside the exported file."),
3012
Option('per-file-timestamps',
3013
help='Set modification time of files to that of the last '
3014
'revision in which it was changed.'),
3016
2785
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3017
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2786
root=None, filters=False):
3018
2787
from bzrlib.export import export
3020
2789
if branch_or_subdir is None:
3021
tree = WorkingTree.open_containing(directory)[0]
2790
tree = WorkingTree.open_containing(u'.')[0]
3022
2791
b = tree.branch
3028
2797
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3030
export(rev_tree, dest, format, root, subdir, filtered=filters,
3031
per_file_timestamps=per_file_timestamps)
2799
export(rev_tree, dest, format, root, subdir, filtered=filters)
3032
2800
except errors.NoSuchExportFormat, e:
3033
2801
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
3036
2804
class cmd_cat(Command):
3037
__doc__ = """Write the contents of a file as of a given revision to standard output.
2805
"""Write the contents of a file as of a given revision to standard output.
3039
2807
If no revision is nominated, the last revision is used.
3055
2823
@display_command
3056
2824
def run(self, filename, revision=None, name_from_revision=False,
3057
filters=False, directory=None):
3058
2826
if revision is not None and len(revision) != 1:
3059
2827
raise errors.BzrCommandError("bzr cat --revision takes exactly"
3060
2828
" one revision specifier")
3061
2829
tree, branch, relpath = \
3062
_open_directory_or_containing_tree_or_branch(filename, directory)
3063
self.add_cleanup(branch.lock_read().unlock)
2830
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2832
self.add_cleanup(branch.unlock)
3064
2833
return self._run(tree, branch, relpath, filename, revision,
3065
2834
name_from_revision, filters)
3084
2850
"%r is not present in revision %s" % (
3085
2851
filename, rev_tree.get_revision_id()))
3087
actual_file_id = old_file_id
2853
content = rev_tree.get_file_text(old_file_id)
3089
2855
cur_file_id = tree.path2id(relpath)
3090
if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3091
actual_file_id = cur_file_id
3092
elif old_file_id is not None:
3093
actual_file_id = old_file_id
2857
if cur_file_id is not None:
2858
# Then try with the actual file id
2860
content = rev_tree.get_file_text(cur_file_id)
2862
except errors.NoSuchId:
2863
# The actual file id didn't exist at that time
2865
if not found and old_file_id is not None:
2866
# Finally try with the old file id
2867
content = rev_tree.get_file_text(old_file_id)
2870
# Can't be found anywhere
3095
2871
raise errors.BzrCommandError(
3096
2872
"%r is not present in revision %s" % (
3097
2873
filename, rev_tree.get_revision_id()))
3099
from bzrlib.filter_tree import ContentFilterTree
3100
filter_tree = ContentFilterTree(rev_tree,
3101
rev_tree._content_filter_stack)
3102
content = filter_tree.get_file_text(actual_file_id)
2875
from bzrlib.filters import (
2876
ContentFilterContext,
2877
filtered_output_bytes,
2879
filters = rev_tree._content_filter_stack(relpath)
2880
chunks = content.splitlines(True)
2881
content = filtered_output_bytes(chunks, filters,
2882
ContentFilterContext(relpath, rev_tree))
2884
self.outf.writelines(content)
3104
content = rev_tree.get_file_text(actual_file_id)
3106
self.outf.write(content)
2887
self.outf.write(content)
3109
2890
class cmd_local_time_offset(Command):
3110
__doc__ = """Show the offset in seconds from GMT to local time."""
2891
"""Show the offset in seconds from GMT to local time."""
3112
2893
@display_command
3114
self.outf.write("%s\n" % osutils.local_time_offset())
2895
print osutils.local_time_offset()
3118
2899
class cmd_commit(Command):
3119
__doc__ = """Commit changes into a new revision.
2900
"""Commit changes into a new revision.
3121
2902
An explanatory message needs to be given for each commit. This is
3122
2903
often done by using the --message option (getting the message from the
3170
2951
to trigger updates to external systems like bug trackers. The --fixes
3171
2952
option can be used to record the association between a revision and
3172
2953
one or more bugs. See ``bzr help bugs`` for details.
2955
A selective commit may fail in some cases where the committed
2956
tree would be invalid. Consider::
2961
bzr commit foo -m "committing foo"
2962
bzr mv foo/bar foo/baz
2965
bzr commit foo/bar -m "committing bar but not baz"
2967
In the example above, the last commit will fail by design. This gives
2968
the user the opportunity to decide whether they want to commit the
2969
rename at the same time, separately first, or not at all. (As a general
2970
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2972
# TODO: Run hooks on tree to-be-committed, and after commit.
2974
# TODO: Strict commit that fails if there are deleted files.
2975
# (what does "deleted files" mean ??)
2977
# TODO: Give better message for -s, --summary, used by tla people
2979
# XXX: verbose currently does nothing
3175
2981
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3176
2982
takes_args = ['selected*']
3258
3058
raise errors.BzrCommandError(
3259
3059
"Could not parse --commit-time: " + str(e))
3061
# TODO: Need a blackbox test for invoking the external editor; may be
3062
# slightly problematic to run this cross-platform.
3064
# TODO: do more checks that the commit will succeed before
3065
# spending the user's valuable time typing a commit message.
3261
3067
properties = {}
3263
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3069
tree, selected_list = tree_files(selected_list)
3264
3070
if selected_list == ['']:
3265
3071
# workaround - commit of root of tree should be exactly the same
3266
3072
# as just default commit in that tree, and succeed even though
3291
3097
'(use --file "%(f)s" to take commit message from that file)'
3292
3098
% { 'f': message })
3293
3099
ui.ui_factory.show_warning(warning_msg)
3295
message = message.replace('\r\n', '\n')
3296
message = message.replace('\r', '\n')
3298
raise errors.BzrCommandError(
3299
"please specify either --message or --file")
3301
3101
def get_message(commit_obj):
3302
3102
"""Callback to get commit message"""
3306
my_message = f.read().decode(osutils.get_user_encoding())
3309
elif message is not None:
3310
my_message = message
3312
# No message supplied: make one up.
3313
# text is the status of the tree
3314
text = make_commit_message_template_encoded(tree,
3103
my_message = message
3104
if my_message is not None and '\r' in my_message:
3105
my_message = my_message.replace('\r\n', '\n')
3106
my_message = my_message.replace('\r', '\n')
3107
if my_message is None and not file:
3108
t = make_commit_message_template_encoded(tree,
3315
3109
selected_list, diff=show_diff,
3316
3110
output_encoding=osutils.get_user_encoding())
3317
# start_message is the template generated from hooks
3318
# XXX: Warning - looks like hooks return unicode,
3319
# make_commit_message_template_encoded returns user encoding.
3320
# We probably want to be using edit_commit_message instead to
3322
my_message = set_commit_message(commit_obj)
3323
if my_message is None:
3324
start_message = generate_commit_message_template(commit_obj)
3325
my_message = edit_commit_message_encoded(text,
3326
start_message=start_message)
3111
start_message = generate_commit_message_template(commit_obj)
3112
my_message = edit_commit_message_encoded(t,
3113
start_message=start_message)
3327
3114
if my_message is None:
3328
3115
raise errors.BzrCommandError("please specify a commit"
3329
3116
" message with either --message or --file")
3117
elif my_message and file:
3118
raise errors.BzrCommandError(
3119
"please specify either --message or --file")
3121
my_message = codecs.open(file, 'rt',
3122
osutils.get_user_encoding()).read()
3330
3123
if my_message == "":
3331
raise errors.BzrCommandError("Empty commit message specified."
3332
" Please specify a commit message with either"
3333
" --message or --file or leave a blank message"
3334
" with --message \"\".")
3124
raise errors.BzrCommandError("empty commit message specified")
3335
3125
return my_message
3337
3127
# The API permits a commit with a filter of [] to mean 'select nothing'
3345
3135
reporter=None, verbose=verbose, revprops=properties,
3346
3136
authors=author, timestamp=commit_stamp,
3347
3137
timezone=offset,
3348
exclude=tree.safe_relpath_files(exclude),
3138
exclude=safe_relpath_files(tree, exclude))
3350
3139
except PointlessCommit:
3140
# FIXME: This should really happen before the file is read in;
3141
# perhaps prepare the commit; get the message; then actually commit
3351
3142
raise errors.BzrCommandError("No changes to commit."
3352
" Please 'bzr add' the files you want to commit, or use"
3353
" --unchanged to force an empty commit.")
3143
" Use --unchanged to commit anyhow.")
3354
3144
except ConflictsInTree:
3355
3145
raise errors.BzrCommandError('Conflicts detected in working '
3356
3146
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3359
3149
raise errors.BzrCommandError("Commit refused because there are"
3360
3150
" unknown files in the working tree.")
3361
3151
except errors.BoundBranchOutOfDate, e:
3362
e.extra_help = ("\n"
3363
'To commit to master branch, run update and then commit.\n'
3364
'You can also pass --local to commit to continue working '
3152
raise errors.BzrCommandError(str(e) + "\n"
3153
'To commit to master branch, run update and then commit.\n'
3154
'You can also pass --local to commit to continue working '
3369
3158
class cmd_check(Command):
3370
__doc__ = """Validate working tree structure, branch consistency and repository history.
3159
"""Validate working tree structure, branch consistency and repository history.
3372
3161
This command checks various invariants about branch and repository storage
3373
3162
to detect data corruption or bzr bugs.
3439
3228
class cmd_upgrade(Command):
3440
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3442
When the default format has changed after a major new release of
3443
Bazaar, you may be informed during certain operations that you
3444
should upgrade. Upgrading to a newer format may improve performance
3445
or make new features available. It may however limit interoperability
3446
with older repositories or with older versions of Bazaar.
3448
If you wish to upgrade to a particular format rather than the
3449
current default, that can be specified using the --format option.
3450
As a consequence, you can use the upgrade command this way to
3451
"downgrade" to an earlier format, though some conversions are
3452
a one way process (e.g. changing from the 1.x default to the
3453
2.x default) so downgrading is not always possible.
3455
A backup.bzr.~#~ directory is created at the start of the conversion
3456
process (where # is a number). By default, this is left there on
3457
completion. If the conversion fails, delete the new .bzr directory
3458
and rename this one back in its place. Use the --clean option to ask
3459
for the backup.bzr directory to be removed on successful conversion.
3460
Alternatively, you can delete it by hand if everything looks good
3463
If the location given is a shared repository, dependent branches
3464
are also converted provided the repository converts successfully.
3465
If the conversion of a branch fails, remaining branches are still
3468
For more information on upgrades, see the Bazaar Upgrade Guide,
3469
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3229
"""Upgrade branch storage to current format.
3231
The check command or bzr developers may sometimes advise you to run
3232
this command. When the default format has changed you may also be warned
3233
during other operations to upgrade.
3472
_see_also = ['check', 'reconcile', 'formats']
3236
_see_also = ['check']
3473
3237
takes_args = ['url?']
3474
3238
takes_options = [
3475
RegistryOption('format',
3476
help='Upgrade to a specific format. See "bzr help'
3477
' formats" for details.',
3478
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3479
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3480
value_switches=True, title='Branch format'),
3482
help='Remove the backup.bzr directory if successful.'),
3484
help="Show what would be done, but don't actually do anything."),
3239
RegistryOption('format',
3240
help='Upgrade to a specific format. See "bzr help'
3241
' formats" for details.',
3242
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3243
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3244
value_switches=True, title='Branch format'),
3487
def run(self, url='.', format=None, clean=False, dry_run=False):
3247
def run(self, url='.', format=None):
3488
3248
from bzrlib.upgrade import upgrade
3489
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3491
if len(exceptions) == 1:
3492
# Compatibility with historical behavior
3249
upgrade(url, format)
3498
3252
class cmd_whoami(Command):
3499
__doc__ = """Show or set bzr user id.
3253
"""Show or set bzr user id.
3502
3256
Show the email of the current user::
3518
3271
encoding_type = 'replace'
3520
3273
@display_command
3521
def run(self, email=False, branch=False, name=None, directory=None):
3274
def run(self, email=False, branch=False, name=None):
3522
3275
if name is None:
3523
if directory is None:
3524
# use branch if we're inside one; otherwise global config
3526
c = Branch.open_containing(u'.')[0].get_config()
3527
except errors.NotBranchError:
3528
c = _mod_config.GlobalConfig()
3530
c = Branch.open(directory).get_config()
3276
# use branch if we're inside one; otherwise global config
3278
c = Branch.open_containing('.')[0].get_config()
3279
except errors.NotBranchError:
3280
c = config.GlobalConfig()
3532
3282
self.outf.write(c.user_email() + '\n')
3534
3284
self.outf.write(c.username() + '\n')
3538
raise errors.BzrCommandError("--email can only be used to display existing "
3541
3287
# display a warning if an email address isn't included in the given name.
3543
_mod_config.extract_email_address(name)
3289
config.extract_email_address(name)
3544
3290
except errors.NoEmailInUsername, e:
3545
3291
warning('"%s" does not seem to contain an email address. '
3546
3292
'This is allowed, but not recommended.', name)
3548
3294
# use global config unless --branch given
3550
if directory is None:
3551
c = Branch.open_containing(u'.')[0].get_config()
3553
c = Branch.open(directory).get_config()
3296
c = Branch.open_containing('.')[0].get_config()
3555
c = _mod_config.GlobalConfig()
3298
c = config.GlobalConfig()
3556
3299
c.set_user_option('email', name)
3559
3302
class cmd_nick(Command):
3560
__doc__ = """Print or set the branch nickname.
3303
"""Print or set the branch nickname.
3562
3305
If unset, the tree root directory name is used as the nickname.
3563
3306
To print the current nickname, execute with no argument.
3625
3367
'bzr alias --remove expects an alias to remove.')
3626
3368
# If alias is not found, print something like:
3627
3369
# unalias: foo: not found
3628
c = _mod_config.GlobalConfig()
3370
c = config.GlobalConfig()
3629
3371
c.unset_alias(alias_name)
3631
3373
@display_command
3632
3374
def print_aliases(self):
3633
3375
"""Print out the defined aliases in a similar format to bash."""
3634
aliases = _mod_config.GlobalConfig().get_aliases()
3376
aliases = config.GlobalConfig().get_aliases()
3635
3377
for key, value in sorted(aliases.iteritems()):
3636
3378
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3648
3390
def set_alias(self, alias_name, alias_command):
3649
3391
"""Save the alias in the global config."""
3650
c = _mod_config.GlobalConfig()
3392
c = config.GlobalConfig()
3651
3393
c.set_alias(alias_name, alias_command)
3654
3396
class cmd_selftest(Command):
3655
__doc__ = """Run internal test suite.
3397
"""Run internal test suite.
3657
3399
If arguments are given, they are regular expressions that say which tests
3658
3400
should run. Tests matching any expression are run, and other tests are
3705
3444
def get_transport_type(typestring):
3706
3445
"""Parse and return a transport specifier."""
3707
3446
if typestring == "sftp":
3708
from bzrlib.tests import stub_sftp
3709
return stub_sftp.SFTPAbsoluteServer
3710
elif typestring == "memory":
3711
from bzrlib.tests import test_server
3712
return memory.MemoryServer
3713
elif typestring == "fakenfs":
3714
from bzrlib.tests import test_server
3715
return test_server.FakeNFSServer
3447
from bzrlib.transport.sftp import SFTPAbsoluteServer
3448
return SFTPAbsoluteServer
3449
if typestring == "memory":
3450
from bzrlib.transport.memory import MemoryServer
3452
if typestring == "fakenfs":
3453
from bzrlib.transport.fakenfs import FakeNFSServer
3454
return FakeNFSServer
3716
3455
msg = "No known transport type %s. Supported types are: sftp\n" %\
3718
3457
raise errors.BzrCommandError(msg)
3729
3468
'throughout the test suite.',
3730
3469
type=get_transport_type),
3731
3470
Option('benchmark',
3732
help='Run the benchmarks rather than selftests.',
3471
help='Run the benchmarks rather than selftests.'),
3734
3472
Option('lsprof-timed',
3735
3473
help='Generate lsprof output for benchmarked'
3736
3474
' sections of code.'),
3737
3475
Option('lsprof-tests',
3738
3476
help='Generate lsprof output for each test.'),
3477
Option('cache-dir', type=str,
3478
help='Cache intermediate benchmark output in this '
3739
3480
Option('first',
3740
3481
help='Run all tests, but run specified tests first.',
3741
3482
short_name='f',
3750
3491
Option('randomize', type=str, argname="SEED",
3751
3492
help='Randomize the order of tests using the given'
3752
3493
' seed or "now" for the current time.'),
3753
ListOption('exclude', type=str, argname="PATTERN",
3755
help='Exclude tests that match this regular'
3494
Option('exclude', type=str, argname="PATTERN",
3496
help='Exclude tests that match this regular'
3757
3498
Option('subunit',
3758
3499
help='Output test progress via subunit.'),
3759
3500
Option('strict', help='Fail on missing dependencies or '
3776
3517
def run(self, testspecs_list=None, verbose=False, one=False,
3777
3518
transport=None, benchmark=None,
3519
lsprof_timed=None, cache_dir=None,
3779
3520
first=False, list_only=False,
3780
3521
randomize=None, exclude=None, strict=False,
3781
3522
load_list=None, debugflag=None, starting_with=None, subunit=False,
3782
3523
parallel=None, lsprof_tests=False):
3783
from bzrlib import tests
3524
from bzrlib.tests import selftest
3525
import bzrlib.benchmarks as benchmarks
3526
from bzrlib.benchmarks import tree_creator
3528
# Make deprecation warnings visible, unless -Werror is set
3529
symbol_versioning.activate_deprecation_warnings(override=False)
3531
if cache_dir is not None:
3532
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3785
3533
if testspecs_list is not None:
3786
3534
pattern = '|'.join(testspecs_list)
3793
3541
raise errors.BzrCommandError("subunit not available. subunit "
3794
3542
"needs to be installed to use --subunit.")
3795
3543
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3796
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3797
# stdout, which would corrupt the subunit stream.
3798
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3799
# following code can be deleted when it's sufficiently deployed
3800
# -- vila/mgz 20100514
3801
if (sys.platform == "win32"
3802
and getattr(sys.stdout, 'fileno', None) is not None):
3804
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3806
3545
self.additional_selftest_args.setdefault(
3807
3546
'suite_decorators', []).append(parallel)
3809
raise errors.BzrCommandError(
3810
"--benchmark is no longer supported from bzr 2.2; "
3811
"use bzr-usertest instead")
3812
test_suite_factory = None
3814
exclude_pattern = None
3548
test_suite_factory = benchmarks.test_suite
3549
# Unless user explicitly asks for quiet, be verbose in benchmarks
3550
verbose = not is_quiet()
3551
# TODO: should possibly lock the history file...
3552
benchfile = open(".perf_history", "at", buffering=1)
3553
self.add_cleanup(benchfile.close)
3816
exclude_pattern = '(' + '|'.join(exclude) + ')'
3555
test_suite_factory = None
3817
3557
selftest_kwargs = {"verbose": verbose,
3818
3558
"pattern": pattern,
3819
3559
"stop_on_failure": one,
3821
3561
"test_suite_factory": test_suite_factory,
3822
3562
"lsprof_timed": lsprof_timed,
3823
3563
"lsprof_tests": lsprof_tests,
3564
"bench_history": benchfile,
3824
3565
"matching_tests_first": first,
3825
3566
"list_only": list_only,
3826
3567
"random_seed": randomize,
3827
"exclude_pattern": exclude_pattern,
3568
"exclude_pattern": exclude,
3828
3569
"strict": strict,
3829
3570
"load_list": load_list,
3830
3571
"debug_flags": debugflag,
3831
3572
"starting_with": starting_with
3833
3574
selftest_kwargs.update(self.additional_selftest_args)
3835
# Make deprecation warnings visible, unless -Werror is set
3836
cleanup = symbol_versioning.activate_deprecation_warnings(
3839
result = tests.selftest(**selftest_kwargs)
3575
result = selftest(**selftest_kwargs)
3842
3576
return int(not result)
3845
3579
class cmd_version(Command):
3846
__doc__ = """Show version of bzr."""
3580
"""Show version of bzr."""
3848
3582
encoding_type = 'replace'
3849
3583
takes_options = [
3883
3617
branch1 = Branch.open_containing(branch)[0]
3884
3618
branch2 = Branch.open_containing(other)[0]
3885
self.add_cleanup(branch1.lock_read().unlock)
3886
self.add_cleanup(branch2.lock_read().unlock)
3620
self.add_cleanup(branch1.unlock)
3622
self.add_cleanup(branch2.unlock)
3887
3623
last1 = ensure_null(branch1.last_revision())
3888
3624
last2 = ensure_null(branch2.last_revision())
3890
3626
graph = branch1.repository.get_graph(branch2.repository)
3891
3627
base_rev_id = graph.find_unique_lca(last1, last2)
3893
self.outf.write('merge base is revision %s\n' % base_rev_id)
3629
print 'merge base is revision %s' % base_rev_id
3896
3632
class cmd_merge(Command):
3897
__doc__ = """Perform a three-way merge.
3633
"""Perform a three-way merge.
3899
3635
The source of the merge can be specified either in the form of a branch,
3900
3636
or in the form of a path to a file containing a merge directive generated
3901
3637
with bzr send. If neither is specified, the default is the upstream branch
3902
or the branch most recently merged using --remember. The source of the
3903
merge may also be specified in the form of a path to a file in another
3904
branch: in this case, only the modifications to that file are merged into
3905
the current working tree.
3907
When merging from a branch, by default bzr will try to merge in all new
3908
work from the other branch, automatically determining an appropriate base
3909
revision. If this fails, you may need to give an explicit base.
3911
To pick a different ending revision, pass "--revision OTHER". bzr will
3912
try to merge in all new work up to and including revision OTHER.
3914
If you specify two values, "--revision BASE..OTHER", only revisions BASE
3915
through OTHER, excluding BASE but including OTHER, will be merged. If this
3916
causes some revisions to be skipped, i.e. if the destination branch does
3917
not already contain revision BASE, such a merge is commonly referred to as
3918
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
3919
cherrypicks. The changes look like a normal commit, and the history of the
3920
changes from the other branch is not stored in the commit.
3922
Revision numbers are always relative to the source branch.
3638
or the branch most recently merged using --remember.
3640
When merging a branch, by default the tip will be merged. To pick a different
3641
revision, pass --revision. If you specify two values, the first will be used as
3642
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3643
available revisions, like this is commonly referred to as "cherrypicking".
3645
Revision numbers are always relative to the branch being merged.
3647
By default, bzr will try to merge in all new work from the other
3648
branch, automatically determining an appropriate base. If this
3649
fails, you may need to give an explicit base.
3924
3651
Merge will do its best to combine the changes in two branches, but there
3925
3652
are some kinds of problems only a human can fix. When it encounters those,
3929
3656
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3931
If there is no default branch set, the first merge will set it (use
3932
--no-remember to avoid settting it). After that, you can omit the branch
3933
to use the default. To change the default, use --remember. The value will
3934
only be saved if the remote location can be accessed.
3658
If there is no default branch set, the first merge will set it. After
3659
that, you can omit the branch to use the default. To change the
3660
default, use --remember. The value will only be saved if the remote
3661
location can be accessed.
3936
3663
The results of the merge are placed into the destination working
3937
3664
directory, where they can be reviewed (with bzr diff), tested, and then
3938
3665
committed to record the result of the merge.
3940
3667
merge refuses to run if there are any uncommitted changes, unless
3941
--force is given. If --force is given, then the changes from the source
3942
will be merged with the current working tree, including any uncommitted
3943
changes in the tree. The --force option can also be used to create a
3668
--force is given. The --force option can also be used to create a
3944
3669
merge revision which has more than two parents.
3946
3671
If one would like to merge changes from the working tree of the other
3994
3719
' completely merged into the source, pull from the'
3995
3720
' source rather than merging. When this happens,'
3996
3721
' you do not need to commit the result.'),
3997
custom_help('directory',
3998
3723
help='Branch to merge into, '
3999
'rather than the one containing the working directory.'),
3724
'rather than the one containing the working directory.',
4000
3728
Option('preview', help='Instead of merging, show a diff of the'
4002
3730
Option('interactive', help='Select changes interactively.',
4055
3780
raise errors.BzrCommandError(
4056
3781
'Cannot use -r with merge directives or bundles')
4057
3782
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4060
3785
if merger is None and uncommitted:
4061
3786
if revision is not None and len(revision) > 0:
4062
3787
raise errors.BzrCommandError('Cannot use --uncommitted and'
4063
3788
' --revision at the same time.')
4064
merger = self.get_merger_from_uncommitted(tree, location, None)
3789
merger = self.get_merger_from_uncommitted(tree, location, pb)
4065
3790
allow_pending = False
4067
3792
if merger is None:
4068
3793
merger, allow_pending = self._get_merger_from_branch(tree,
4069
location, revision, remember, possible_transports, None)
3794
location, revision, remember, possible_transports, pb)
4071
3796
merger.merge_type = merge_type
4072
3797
merger.reprocess = reprocess
4074
3799
self.sanity_check_merger(merger)
4075
3800
if (merger.base_rev_id == merger.other_rev_id and
4076
3801
merger.other_rev_id is not None):
4077
# check if location is a nonexistent file (and not a branch) to
4078
# disambiguate the 'Nothing to do'
4079
if merger.interesting_files:
4080
if not merger.other_tree.has_filename(
4081
merger.interesting_files[0]):
4082
note("merger: " + str(merger))
4083
raise errors.PathsDoNotExist([location])
4084
3802
note('Nothing to do.')
4086
if pull and not preview:
4087
3805
if merger.interesting_files is not None:
4088
3806
raise errors.BzrCommandError('Cannot pull individual files')
4089
3807
if (merger.base_rev_id == tree.last_revision()):
4113
3831
def _do_preview(self, merger):
4114
3832
from bzrlib.diff import show_diff_trees
4115
3833
result_tree = self._get_preview(merger)
4116
path_encoding = osutils.get_diff_header_encoding()
4117
3834
show_diff_trees(merger.this_tree, result_tree, self.outf,
4118
old_label='', new_label='',
4119
path_encoding=path_encoding)
3835
old_label='', new_label='')
4121
3837
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4122
3838
merger.change_reporter = change_reporter
4198
3914
if other_revision_id is None:
4199
3915
other_revision_id = _mod_revision.ensure_null(
4200
3916
other_branch.last_revision())
4201
# Remember where we merge from. We need to remember if:
4202
# - user specify a location (and we don't merge from the parent
4204
# - user ask to remember or there is no previous location set to merge
4205
# from and user didn't ask to *not* remember
4206
if (user_location is not None
4208
or (remember is None
4209
and tree.branch.get_submit_branch() is None)))):
3917
# Remember where we merge from
3918
if ((remember or tree.branch.get_submit_branch() is None) and
3919
user_location is not None):
4210
3920
tree.branch.set_submit_branch(other_branch.base)
4211
# Merge tags (but don't set them in the master branch yet, the user
4212
# might revert this merge). Commit will propagate them.
4213
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
3921
_merge_tags_if_possible(other_branch, tree.branch)
4214
3922
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4215
3923
other_revision_id, base_revision_id, other_branch, base_branch)
4216
3924
if other_path != '':
4315
4023
def run(self, file_list=None, merge_type=None, show_base=False,
4316
4024
reprocess=False):
4317
from bzrlib.conflicts import restore
4318
4025
if merge_type is None:
4319
4026
merge_type = _mod_merge.Merge3Merger
4320
tree, file_list = WorkingTree.open_containing_paths(file_list)
4321
self.add_cleanup(tree.lock_write().unlock)
4027
tree, file_list = tree_files(file_list)
4029
self.add_cleanup(tree.unlock)
4322
4030
parents = tree.get_parent_ids()
4323
4031
if len(parents) != 2:
4324
4032
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4360
4068
# list, we imply that the working tree text has seen and rejected
4361
4069
# all the changes from the other tree, when in fact those changes
4362
4070
# have not yet been seen.
4071
pb = ui.ui_factory.nested_progress_bar()
4363
4072
tree.set_parent_ids(parents[:1])
4365
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4074
merger = _mod_merge.Merger.from_revision_ids(pb,
4366
4076
merger.interesting_ids = interesting_ids
4367
4077
merger.merge_type = merge_type
4368
4078
merger.show_base = show_base
4379
4090
class cmd_revert(Command):
4380
__doc__ = """Revert files to a previous revision.
4091
"""Revert files to a previous revision.
4382
4093
Giving a list of files will revert only those files. Otherwise, all files
4383
4094
will be reverted. If the revision is not specified with '--revision', the
4384
4095
last committed revision is used.
4386
4097
To remove only some changes, without reverting to a prior version, use
4387
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4388
will remove the changes introduced by the second last commit (-2), without
4389
affecting the changes introduced by the last commit (-1). To remove
4390
certain changes on a hunk-by-hunk basis, see the shelve command.
4098
merge instead. For example, "merge . --revision -2..-3" will remove the
4099
changes introduced by -2, without affecting the changes introduced by -1.
4100
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4392
4102
By default, any files that have been manually changed will be backed up
4393
4103
first. (Files changed only by merge are not backed up.) Backup files have
4445
4156
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4446
4157
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4447
tree.revert(file_list, rev_tree, not no_backup, None,
4448
report_changes=True)
4158
pb = ui.ui_factory.nested_progress_bar()
4160
tree.revert(file_list, rev_tree, not no_backup, pb,
4161
report_changes=True)
4451
4166
class cmd_assert_fail(Command):
4452
__doc__ = """Test reporting of assertion failures"""
4167
"""Test reporting of assertion failures"""
4453
4168
# intended just for use in testing
4595
4306
remote_branch = Branch.open(other_branch)
4596
4307
if remote_branch.base == local_branch.base:
4597
4308
remote_branch = local_branch
4599
self.add_cleanup(remote_branch.lock_read().unlock)
4310
local_branch.lock_read()
4311
self.add_cleanup(local_branch.unlock)
4601
4312
local_revid_range = _revision_range_to_revid_range(
4602
4313
_get_revision_range(my_revision, local_branch,
4316
remote_branch.lock_read()
4317
self.add_cleanup(remote_branch.unlock)
4605
4318
remote_revid_range = _revision_range_to_revid_range(
4606
4319
_get_revision_range(revision,
4607
4320
remote_branch, self.name()))
4667
4381
class cmd_pack(Command):
4668
__doc__ = """Compress the data within a repository.
4670
This operation compresses the data within a bazaar repository. As
4671
bazaar supports automatic packing of repository, this operation is
4672
normally not required to be done manually.
4674
During the pack operation, bazaar takes a backup of existing repository
4675
data, i.e. pack files. This backup is eventually removed by bazaar
4676
automatically when it is safe to do so. To save disk space by removing
4677
the backed up pack files, the --clean-obsolete-packs option may be
4680
Warning: If you use --clean-obsolete-packs and your machine crashes
4681
during or immediately after repacking, you may be left with a state
4682
where the deletion has been written to disk but the new packs have not
4683
been. In this case the repository may be unusable.
4382
"""Compress the data within a repository."""
4686
4384
_see_also = ['repositories']
4687
4385
takes_args = ['branch_or_repo?']
4689
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4692
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4387
def run(self, branch_or_repo='.'):
4693
4388
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4695
4390
branch = dir.open_branch()
4696
4391
repository = branch.repository
4697
4392
except errors.NotBranchError:
4698
4393
repository = dir.open_repository()
4699
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4702
4397
class cmd_plugins(Command):
4703
__doc__ = """List the installed plugins.
4398
"""List the installed plugins.
4705
4400
This command displays the list of installed plugins including
4706
4401
version of plugin and a short description of each.
4713
4408
adding new commands, providing additional network transports and
4714
4409
customizing log output.
4716
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4717
for further information on plugins including where to find them and how to
4718
install them. Instructions are also provided there on how to write new
4719
plugins using the Python programming language.
4411
See the Bazaar web site, http://bazaar-vcs.org, for further
4412
information on plugins including where to find them and how to
4413
install them. Instructions are also provided there on how to
4414
write new plugins using the Python programming language.
4721
4416
takes_options = ['verbose']
4723
4418
@display_command
4724
4419
def run(self, verbose=False):
4725
from bzrlib import plugin
4726
# Don't give writelines a generator as some codecs don't like that
4727
self.outf.writelines(
4728
list(plugin.describe_plugins(show_paths=verbose)))
4420
import bzrlib.plugin
4421
from inspect import getdoc
4423
for name, plugin in bzrlib.plugin.plugins().items():
4424
version = plugin.__version__
4425
if version == 'unknown':
4427
name_ver = '%s %s' % (name, version)
4428
d = getdoc(plugin.module)
4430
doc = d.split('\n')[0]
4432
doc = '(no description)'
4433
result.append((name_ver, doc, plugin.path()))
4434
for name_ver, doc, path in sorted(result):
4731
4442
class cmd_testament(Command):
4732
__doc__ = """Show testament (signing-form) of a revision."""
4443
"""Show testament (signing-form) of a revision."""
4733
4444
takes_options = [
4735
4446
Option('long', help='Produce long-format testament.'),
4777
4489
Option('long', help='Show commit date in annotations.'),
4782
4493
encoding_type = 'exact'
4784
4495
@display_command
4785
4496
def run(self, filename, all=False, long=False, revision=None,
4786
show_ids=False, directory=None):
4787
from bzrlib.annotate import (
4498
from bzrlib.annotate import annotate_file, annotate_file_tree
4790
4499
wt, branch, relpath = \
4791
_open_directory_or_containing_tree_or_branch(filename, directory)
4500
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4792
4501
if wt is not None:
4793
self.add_cleanup(wt.lock_read().unlock)
4503
self.add_cleanup(wt.unlock)
4795
self.add_cleanup(branch.lock_read().unlock)
4506
self.add_cleanup(branch.unlock)
4796
4507
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4797
self.add_cleanup(tree.lock_read().unlock)
4798
if wt is not None and revision is None:
4509
self.add_cleanup(tree.unlock)
4799
4511
file_id = wt.path2id(relpath)
4801
4513
file_id = tree.path2id(relpath)
4802
4514
if file_id is None:
4803
4515
raise errors.NotVersionedError(filename)
4516
file_version = tree.inventory[file_id].revision
4804
4517
if wt is not None and revision is None:
4805
4518
# If there is a tree and we're not annotating historical
4806
4519
# versions, annotate the working tree's content.
4807
4520
annotate_file_tree(wt, file_id, self.outf, long, all,
4808
4521
show_ids=show_ids)
4810
annotate_file_tree(tree, file_id, self.outf, long, all,
4811
show_ids=show_ids, branch=branch)
4523
annotate_file(branch, file_version, file_id, long, all, self.outf,
4814
4527
class cmd_re_sign(Command):
4815
__doc__ = """Create a digital signature for an existing revision."""
4528
"""Create a digital signature for an existing revision."""
4816
4529
# TODO be able to replace existing ones.
4818
4531
hidden = True # is this right ?
4819
4532
takes_args = ['revision_id*']
4820
takes_options = ['directory', 'revision']
4533
takes_options = ['revision']
4822
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4535
def run(self, revision_id_list=None, revision=None):
4823
4536
if revision_id_list is not None and revision is not None:
4824
4537
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4825
4538
if revision_id_list is None and revision is None:
4826
4539
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4827
b = WorkingTree.open_containing(directory)[0].branch
4828
self.add_cleanup(b.lock_write().unlock)
4540
b = WorkingTree.open_containing(u'.')[0].branch
4542
self.add_cleanup(b.unlock)
4829
4543
return self._run(b, revision_id_list, revision)
4831
4545
def _run(self, b, revision_id_list, revision):
4927
4637
_see_also = ['checkouts', 'bind']
4928
4638
takes_args = []
4929
takes_options = ['directory']
4931
def run(self, directory=u'.'):
4932
b, relpath = Branch.open_containing(directory)
4642
b, relpath = Branch.open_containing(u'.')
4933
4643
if not b.unbind():
4934
4644
raise errors.BzrCommandError('Local branch is not bound')
4937
4647
class cmd_uncommit(Command):
4938
__doc__ = """Remove the last committed revision.
4648
"""Remove the last committed revision.
4940
4650
--verbose will print out what is being removed.
4941
4651
--dry-run will go through all the motions, but not actually
4981
4691
b = control.open_branch()
4983
4693
if tree is not None:
4984
self.add_cleanup(tree.lock_write().unlock)
4695
self.add_cleanup(tree.unlock)
4986
self.add_cleanup(b.lock_write().unlock)
4698
self.add_cleanup(b.unlock)
4987
4699
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4989
4701
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
5022
4734
end_revision=last_revno)
5025
self.outf.write('Dry-run, pretending to remove'
5026
' the above revisions.\n')
4737
print 'Dry-run, pretending to remove the above revisions.'
4739
val = raw_input('Press <enter> to continue')
5028
self.outf.write('The above revision(s) will be removed.\n')
5031
if not ui.ui_factory.confirm_action(
5032
u'Uncommit these revisions',
5033
'bzrlib.builtins.uncommit',
5035
self.outf.write('Canceled\n')
4741
print 'The above revision(s) will be removed.'
4743
val = raw_input('Are you sure [y/N]? ')
4744
if val.lower() not in ('y', 'yes'):
5038
4748
mutter('Uncommitting from {%s} to {%s}',
5039
4749
last_rev_id, rev_id)
5040
4750
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5041
4751
revno=revno, local=local)
5042
self.outf.write('You can restore the old tip by running:\n'
5043
' bzr pull . -r revid:%s\n' % last_rev_id)
4752
note('You can restore the old tip by running:\n'
4753
' bzr pull . -r revid:%s', last_rev_id)
5046
4756
class cmd_break_lock(Command):
5047
__doc__ = """Break a dead lock.
5049
This command breaks a lock on a repository, branch, working directory or
4757
"""Break a dead lock on a repository, branch or working directory.
5052
4759
CAUTION: Locks should only be broken when you are sure that the process
5053
4760
holding the lock has been stopped.
5060
4767
bzr break-lock bzr+ssh://example.com/bzr/foo
5061
bzr break-lock --conf ~/.bazaar
5064
4769
takes_args = ['location?']
5067
help='LOCATION is the directory where the config lock is.'),
5069
help='Do not ask for confirmation before breaking the lock.'),
5072
def run(self, location=None, config=False, force=False):
4771
def run(self, location=None, show=False):
5073
4772
if location is None:
5074
4773
location = u'.'
5076
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5078
{'bzrlib.lockdir.break': True})
5080
conf = _mod_config.LockableConfig(file_name=location)
5083
control, relpath = bzrdir.BzrDir.open_containing(location)
5085
control.break_lock()
5086
except NotImplementedError:
4774
control, relpath = bzrdir.BzrDir.open_containing(location)
4776
control.break_lock()
4777
except NotImplementedError:
5090
4781
class cmd_wait_until_signalled(Command):
5091
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4782
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5093
4784
This just prints a line to signal when it is ready, then blocks on stdin.
5154
4846
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5155
4847
protocol=None):
5156
from bzrlib import transport
4848
from bzrlib.transport import get_transport, transport_server_registry
5157
4849
if directory is None:
5158
4850
directory = os.getcwd()
5159
4851
if protocol is None:
5160
protocol = transport.transport_server_registry.get()
4852
protocol = transport_server_registry.get()
5161
4853
host, port = self.get_host_and_port(port)
5162
4854
url = urlutils.local_path_to_url(directory)
5163
4855
if not allow_writes:
5164
4856
url = 'readonly+' + url
5165
t = transport.get_transport(url)
5166
protocol(t, host, port, inet)
4857
transport = get_transport(url)
4858
protocol(transport, host, port, inet)
5169
4861
class cmd_join(Command):
5170
__doc__ = """Combine a tree into its containing tree.
4862
"""Combine a tree into its containing tree.
5172
4864
This command requires the target tree to be in a rich-root format.
5281
4972
encoding_type = 'exact'
5283
4974
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5284
sign=False, revision=None, mail_to=None, message=None,
4975
sign=False, revision=None, mail_to=None, message=None):
5286
4976
from bzrlib.revision import ensure_null, NULL_REVISION
5287
4977
include_patch, include_bundle = {
5288
4978
'plain': (False, False),
5289
4979
'diff': (True, False),
5290
4980
'bundle': (True, True),
5292
branch = Branch.open(directory)
4982
branch = Branch.open('.')
5293
4983
stored_submit_branch = branch.get_submit_branch()
5294
4984
if submit_branch is None:
5295
4985
submit_branch = stored_submit_branch
5371
5061
source branch defaults to that containing the working directory, but can
5372
5062
be changed using --from.
5374
Both the submit branch and the public branch follow the usual behavior with
5375
respect to --remember: If there is no default location set, the first send
5376
will set it (use --no-remember to avoid settting it). After that, you can
5377
omit the location to use the default. To change the default, use
5378
--remember. The value will only be saved if the location can be accessed.
5380
5064
In order to calculate those changes, bzr must analyse the submit branch.
5381
5065
Therefore it is most efficient for the submit branch to be a local mirror.
5382
5066
If a public location is known for the submit_branch, that location is used
5551
5235
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5552
5236
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5554
If no tag name is specified it will be determined through the
5555
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5556
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5560
5239
_see_also = ['commit', 'tags']
5561
takes_args = ['tag_name?']
5240
takes_args = ['tag_name']
5562
5241
takes_options = [
5563
5242
Option('delete',
5564
5243
help='Delete this tag rather than placing it.',
5566
custom_help('directory',
5567
help='Branch in which to place the tag.'),
5246
help='Branch in which to place the tag.',
5568
5250
Option('force',
5569
5251
help='Replace existing tags.',
5574
def run(self, tag_name=None,
5256
def run(self, tag_name,
5580
5262
branch, relpath = Branch.open_containing(directory)
5581
self.add_cleanup(branch.lock_write().unlock)
5264
self.add_cleanup(branch.unlock)
5583
if tag_name is None:
5584
raise errors.BzrCommandError("No tag specified to delete.")
5585
5266
branch.tags.delete_tag(tag_name)
5586
note('Deleted tag %s.' % tag_name)
5267
self.outf.write('Deleted tag %s.\n' % tag_name)
5589
5270
if len(revision) != 1:
5593
5274
revision_id = revision[0].as_revision_id(branch)
5595
5276
revision_id = branch.last_revision()
5596
if tag_name is None:
5597
tag_name = branch.automatic_tag_name(revision_id)
5598
if tag_name is None:
5599
raise errors.BzrCommandError(
5600
"Please specify a tag name.")
5601
5277
if (not force) and branch.tags.has_tag(tag_name):
5602
5278
raise errors.TagAlreadyExists(tag_name)
5603
5279
branch.tags.set_tag(tag_name, revision_id)
5604
note('Created tag %s.' % tag_name)
5280
self.outf.write('Created tag %s.\n' % tag_name)
5607
5283
class cmd_tags(Command):
5608
__doc__ = """List tags.
5610
5286
This command shows a table of tag names and the revisions they reference.
5613
5289
_see_also = ['tag']
5614
5290
takes_options = [
5615
custom_help('directory',
5616
help='Branch whose tags should be displayed.'),
5617
RegistryOption('sort',
5292
help='Branch whose tags should be displayed.',
5296
RegistryOption.from_kwargs('sort',
5618
5297
'Sort tags by different criteria.', title='Sorting',
5619
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5298
alpha='Sort tags lexicographically (default).',
5299
time='Sort tags chronologically.',
5625
5305
@display_command
5626
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5627
from bzrlib.tag import tag_sort_methods
5628
5312
branch, relpath = Branch.open_containing(directory)
5630
5314
tags = branch.tags.get_tag_dict().items()
5634
self.add_cleanup(branch.lock_read().unlock)
5319
self.add_cleanup(branch.unlock)
5636
5321
graph = branch.repository.get_graph()
5637
5322
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5639
5324
# only show revisions between revid1 and revid2 (inclusive)
5640
5325
tags = [(tag, revid) for tag, revid in tags if
5641
5326
graph.is_between(revid, revid1, revid2)]
5643
sort = tag_sort_methods.get()
5329
elif sort == 'time':
5331
for tag, revid in tags:
5333
revobj = branch.repository.get_revision(revid)
5334
except errors.NoSuchRevision:
5335
timestamp = sys.maxint # place them at the end
5337
timestamp = revobj.timestamp
5338
timestamps[revid] = timestamp
5339
tags.sort(key=lambda x: timestamps[x[1]])
5645
5340
if not show_ids:
5646
5341
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5647
5342
for index, (tag, revid) in enumerate(tags):
5786
5480
def run(self, to_location=None, force=False, create_branch=False,
5787
revision=None, directory=u'.'):
5788
5482
from bzrlib import switch
5789
tree_location = directory
5790
5484
revision = _get_one_revision('switch', revision)
5791
5485
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5792
5486
if to_location is None:
5793
5487
if revision is None:
5794
5488
raise errors.BzrCommandError('You must supply either a'
5795
5489
' revision or a location')
5796
to_location = tree_location
5798
5492
branch = control_dir.open_branch()
5799
5493
had_explicit_nick = branch.get_config().has_explicit_nickname()
6022
5715
self.outf.write(" <no hooks installed>\n")
6025
class cmd_remove_branch(Command):
6026
__doc__ = """Remove a branch.
6028
This will remove the branch from the specified location but
6029
will keep any working tree or repository in place.
6033
Remove the branch at repo/trunk::
6035
bzr remove-branch repo/trunk
6039
takes_args = ["location?"]
6041
aliases = ["rmbranch"]
6043
def run(self, location=None):
6044
if location is None:
6046
branch = Branch.open_containing(location)[0]
6047
branch.bzrdir.destroy_branch()
6050
5718
class cmd_shelve(Command):
6051
__doc__ = """Temporarily set aside some changes from the current tree.
5719
"""Temporarily set aside some changes from the current tree.
6053
5721
Shelve allows you to temporarily put changes you've made "on the shelf",
6054
5722
ie. out of the way, until a later time when you can bring them back from
6071
5739
You can put multiple items on the shelf, and by default, 'unshelve' will
6072
5740
restore the most recently shelved changes.
6074
For complicated changes, it is possible to edit the changes in a separate
6075
editor program to decide what the file remaining in the working copy
6076
should look like. To do this, add the configuration option
6078
change_editor = PROGRAM @new_path @old_path
6080
where @new_path is replaced with the path of the new version of the
6081
file and @old_path is replaced with the path of the old version of
6082
the file. The PROGRAM should save the new file with the desired
6083
contents of the file in the working tree.
6087
5743
takes_args = ['file*']
6089
5745
takes_options = [
6092
5747
Option('all', help='Shelve all changes.'),
6099
5754
Option('destroy',
6100
5755
help='Destroy removed changes instead of shelving them.'),
6102
_see_also = ['unshelve', 'configuration']
5757
_see_also = ['unshelve']
6104
5759
def run(self, revision=None, all=False, file_list=None, message=None,
6105
writer=None, list=False, destroy=False, directory=None):
5760
writer=None, list=False, destroy=False):
6107
return self.run_for_list(directory=directory)
5762
return self.run_for_list()
6108
5763
from bzrlib.shelf_ui import Shelver
6109
5764
if writer is None:
6110
5765
writer = bzrlib.option.diff_writer_registry.get()
6112
5767
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6113
file_list, message, destroy=destroy, directory=directory)
5768
file_list, message, destroy=destroy)
6185
5838
To check what clean-tree will do, use --dry-run.
6187
takes_options = ['directory',
6188
Option('ignored', help='Delete all ignored files.'),
6189
Option('detritus', help='Delete conflict files, merge and revert'
5840
takes_options = [Option('ignored', help='Delete all ignored files.'),
5841
Option('detritus', help='Delete conflict files, merge'
6190
5842
' backups, and failed selftest dirs.'),
6191
5843
Option('unknown',
6192
5844
help='Delete files unknown to bzr (default).'),
6194
5846
' deleting them.'),
6195
5847
Option('force', help='Do not prompt before deleting.')]
6196
5848
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6197
force=False, directory=u'.'):
6198
5850
from bzrlib.clean_tree import clean_tree
6199
5851
if not (unknown or ignored or detritus):
6203
clean_tree(directory, unknown=unknown, ignored=ignored,
6204
detritus=detritus, dry_run=dry_run, no_prompt=force)
5855
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5856
dry_run=dry_run, no_prompt=force)
6207
5859
class cmd_reference(Command):
6208
__doc__ = """list, view and set branch locations for nested trees.
5860
"""list, view and set branch locations for nested trees.
6210
5862
If no arguments are provided, lists the branch locations for nested trees.
6211
5863
If one argument is provided, display the branch location for that tree.
6251
5903
self.outf.write('%s %s\n' % (path, location))
6254
class cmd_export_pot(Command):
6255
__doc__ = """Export command helps and error messages in po format."""
6260
from bzrlib.export_pot import export_pot
6261
export_pot(self.outf)
6264
def _register_lazy_builtins():
6265
# register lazy builtins from other modules; called at startup and should
6266
# be only called once.
6267
for (name, aliases, module_name) in [
6268
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6269
('cmd_config', [], 'bzrlib.config'),
6270
('cmd_dpush', [], 'bzrlib.foreign'),
6271
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6272
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6273
('cmd_conflicts', [], 'bzrlib.conflicts'),
6274
('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6275
('cmd_verify_signatures', [],
6276
'bzrlib.commit_signature_commands'),
6277
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6279
builtin_command_registry.register_lazy(name, aliases, module_name)
5906
# these get imported and then picked up by the scan for cmd_*
5907
# TODO: Some more consistent way to split command definitions across files;
5908
# we do need to load at least some information about them to know of
5909
# aliases. ideally we would avoid loading the implementation until the
5910
# details were needed.
5911
from bzrlib.cmd_version_info import cmd_version_info
5912
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5913
from bzrlib.bundle.commands import (
5916
from bzrlib.foreign import cmd_dpush
5917
from bzrlib.sign_my_commits import cmd_sign_my_commits
5918
from bzrlib.weave_commands import cmd_versionedfile_list, \
5919
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
