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)
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 glog 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')
2811
2609
After adding, editing or deleting that file either indirectly by
2812
2610
using this command or directly by using an editor, be sure to commit
2815
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2816
the global ignore file can be found in the application data directory as
2817
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2818
Global ignores are not touched by this command. The global ignore file
2819
can be edited directly using an editor.
2821
Patterns prefixed with '!' are exceptions to ignore patterns and take
2822
precedence over regular ignores. Such exceptions are used to specify
2823
files that should be versioned which would otherwise be ignored.
2825
Patterns prefixed with '!!' act as regular ignore patterns, but have
2826
precedence over the '!' exception patterns.
2830
* Ignore patterns containing shell wildcards must be quoted from
2833
* Ignore patterns starting with "#" act as comments in the ignore file.
2834
To ignore patterns that begin with that character, use the "RE:" prefix.
2613
Note: ignore patterns containing shell wildcards must be quoted from
2837
2617
Ignore the top level Makefile::
2839
2619
bzr ignore ./Makefile
2841
Ignore .class files in all directories...::
2621
Ignore class files in all directories::
2843
2623
bzr ignore "*.class"
2845
...but do not ignore "special.class"::
2847
bzr ignore "!special.class"
2849
Ignore files whose name begins with the "#" character::
2853
2625
Ignore .o files under the lib directory::
2855
2627
bzr ignore "lib/**/*.o"
2861
2633
Ignore everything but the "debian" toplevel directory::
2863
2635
bzr ignore "RE:(?!debian/).*"
2865
Ignore everything except the "local" toplevel directory,
2866
but always ignore autosave files ending in ~, even under local/::
2869
bzr ignore "!./local"
2873
2638
_see_also = ['status', 'ignored', 'patterns']
2874
2639
takes_args = ['name_pattern*']
2875
takes_options = ['directory',
2876
Option('default-rules',
2877
help='Display the default ignore rules that bzr uses.')
2641
Option('old-default-rules',
2642
help='Write out the ignore rules bzr < 0.9 always used.')
2880
def run(self, name_pattern_list=None, default_rules=None,
2645
def run(self, name_pattern_list=None, old_default_rules=None):
2882
2646
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)
2647
if old_default_rules is not None:
2648
# dump the rules and exit
2649
for pattern in ignores.OLD_DEFAULTS:
2888
2652
if not name_pattern_list:
2889
2653
raise errors.BzrCommandError("ignore requires at least one "
2890
"NAME_PATTERN or --default-rules.")
2654
"NAME_PATTERN or --old-default-rules")
2891
2655
name_pattern_list = [globbing.normalize_pattern(p)
2892
2656
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
2657
for name_pattern in name_pattern_list:
2902
2658
if (name_pattern[0] == '/' or
2903
2659
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2904
2660
raise errors.BzrCommandError(
2905
2661
"NAME_PATTERN should not be an absolute path")
2906
tree, relpath = WorkingTree.open_containing(directory)
2662
tree, relpath = WorkingTree.open_containing(u'.')
2907
2663
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2908
2664
ignored = globbing.Globster(name_pattern_list)
2910
self.add_cleanup(tree.lock_read().unlock)
2911
2667
for entry in tree.list_files():
2913
2669
if id is not None:
2914
2670
filename = entry[0]
2915
2671
if ignored.match(filename):
2916
matches.append(filename)
2672
matches.append(filename.encode('utf-8'))
2917
2674
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),))
2675
print "Warning: the following files are version controlled and" \
2676
" match your ignore pattern:\n%s" \
2677
"\nThese files will continue to be version controlled" \
2678
" unless you 'bzr remove' them." % ("\n".join(matches),)
2924
2681
class cmd_ignored(Command):
2925
__doc__ = """List ignored files and the patterns that matched them.
2682
"""List ignored files and the patterns that matched them.
2927
2684
List all the ignored files and the ignore pattern that caused the file to
2951
2708
class cmd_lookup_revision(Command):
2952
__doc__ = """Lookup the revision-id from a revision-number
2709
"""Lookup the revision-id from a revision-number
2955
2712
bzr lookup-revision 33
2958
2715
takes_args = ['revno']
2959
takes_options = ['directory']
2961
2717
@display_command
2962
def run(self, revno, directory=u'.'):
2718
def run(self, revno):
2964
2720
revno = int(revno)
2965
2721
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)
2722
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2724
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2972
2727
class cmd_export(Command):
2973
__doc__ = """Export current or past revision to a destination directory or archive.
2728
"""Export current or past revision to a destination directory or archive.
2975
2730
If no revision is specified this exports the last committed revision.
3011
2765
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
2767
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3017
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2768
root=None, filters=False):
3018
2769
from bzrlib.export import export
3020
2771
if branch_or_subdir is None:
3021
tree = WorkingTree.open_containing(directory)[0]
2772
tree = WorkingTree.open_containing(u'.')[0]
3022
2773
b = tree.branch
3028
2779
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)
2781
export(rev_tree, dest, format, root, subdir, filtered=filters)
3032
2782
except errors.NoSuchExportFormat, e:
3033
2783
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
3036
2786
class cmd_cat(Command):
3037
__doc__ = """Write the contents of a file as of a given revision to standard output.
2787
"""Write the contents of a file as of a given revision to standard output.
3039
2789
If no revision is nominated, the last revision is used.
3055
2805
@display_command
3056
2806
def run(self, filename, revision=None, name_from_revision=False,
3057
filters=False, directory=None):
3058
2808
if revision is not None and len(revision) != 1:
3059
2809
raise errors.BzrCommandError("bzr cat --revision takes exactly"
3060
2810
" one revision specifier")
3061
2811
tree, branch, relpath = \
3062
_open_directory_or_containing_tree_or_branch(filename, directory)
3063
self.add_cleanup(branch.lock_read().unlock)
2812
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2814
self.add_cleanup(branch.unlock)
3064
2815
return self._run(tree, branch, relpath, filename, revision,
3065
2816
name_from_revision, filters)
3084
2832
"%r is not present in revision %s" % (
3085
2833
filename, rev_tree.get_revision_id()))
3087
actual_file_id = old_file_id
2835
content = rev_tree.get_file_text(old_file_id)
3089
2837
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
2839
if cur_file_id is not None:
2840
# Then try with the actual file id
2842
content = rev_tree.get_file_text(cur_file_id)
2844
except errors.NoSuchId:
2845
# The actual file id didn't exist at that time
2847
if not found and old_file_id is not None:
2848
# Finally try with the old file id
2849
content = rev_tree.get_file_text(old_file_id)
2852
# Can't be found anywhere
3095
2853
raise errors.BzrCommandError(
3096
2854
"%r is not present in revision %s" % (
3097
2855
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)
2857
from bzrlib.filters import (
2858
ContentFilterContext,
2859
filtered_output_bytes,
2861
filters = rev_tree._content_filter_stack(relpath)
2862
chunks = content.splitlines(True)
2863
content = filtered_output_bytes(chunks, filters,
2864
ContentFilterContext(relpath, rev_tree))
2866
self.outf.writelines(content)
3104
content = rev_tree.get_file_text(actual_file_id)
3106
self.outf.write(content)
2869
self.outf.write(content)
3109
2872
class cmd_local_time_offset(Command):
3110
__doc__ = """Show the offset in seconds from GMT to local time."""
2873
"""Show the offset in seconds from GMT to local time."""
3112
2875
@display_command
3114
self.outf.write("%s\n" % osutils.local_time_offset())
2877
print osutils.local_time_offset()
3118
2881
class cmd_commit(Command):
3119
__doc__ = """Commit changes into a new revision.
2882
"""Commit changes into a new revision.
3121
2884
An explanatory message needs to be given for each commit. This is
3122
2885
often done by using the --message option (getting the message from the
3170
2933
to trigger updates to external systems like bug trackers. The --fixes
3171
2934
option can be used to record the association between a revision and
3172
2935
one or more bugs. See ``bzr help bugs`` for details.
2937
A selective commit may fail in some cases where the committed
2938
tree would be invalid. Consider::
2943
bzr commit foo -m "committing foo"
2944
bzr mv foo/bar foo/baz
2947
bzr commit foo/bar -m "committing bar but not baz"
2949
In the example above, the last commit will fail by design. This gives
2950
the user the opportunity to decide whether they want to commit the
2951
rename at the same time, separately first, or not at all. (As a general
2952
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2954
# TODO: Run hooks on tree to-be-committed, and after commit.
2956
# TODO: Strict commit that fails if there are deleted files.
2957
# (what does "deleted files" mean ??)
2959
# TODO: Give better message for -s, --summary, used by tla people
2961
# XXX: verbose currently does nothing
3175
2963
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3176
2964
takes_args = ['selected*']
3258
3040
raise errors.BzrCommandError(
3259
3041
"Could not parse --commit-time: " + str(e))
3043
# TODO: Need a blackbox test for invoking the external editor; may be
3044
# slightly problematic to run this cross-platform.
3046
# TODO: do more checks that the commit will succeed before
3047
# spending the user's valuable time typing a commit message.
3261
3049
properties = {}
3263
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3051
tree, selected_list = tree_files(selected_list)
3264
3052
if selected_list == ['']:
3265
3053
# workaround - commit of root of tree should be exactly the same
3266
3054
# as just default commit in that tree, and succeed even though
3291
3079
'(use --file "%(f)s" to take commit message from that file)'
3292
3080
% { 'f': message })
3293
3081
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
3083
def get_message(commit_obj):
3302
3084
"""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,
3085
my_message = message
3086
if my_message is not None and '\r' in my_message:
3087
my_message = my_message.replace('\r\n', '\n')
3088
my_message = my_message.replace('\r', '\n')
3089
if my_message is None and not file:
3090
t = make_commit_message_template_encoded(tree,
3315
3091
selected_list, diff=show_diff,
3316
3092
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)
3093
start_message = generate_commit_message_template(commit_obj)
3094
my_message = edit_commit_message_encoded(t,
3095
start_message=start_message)
3327
3096
if my_message is None:
3328
3097
raise errors.BzrCommandError("please specify a commit"
3329
3098
" message with either --message or --file")
3099
elif my_message and file:
3100
raise errors.BzrCommandError(
3101
"please specify either --message or --file")
3103
my_message = codecs.open(file, 'rt',
3104
osutils.get_user_encoding()).read()
3330
3105
if my_message == "":
3331
3106
raise errors.BzrCommandError("empty commit message specified")
3332
3107
return my_message
3342
3117
reporter=None, verbose=verbose, revprops=properties,
3343
3118
authors=author, timestamp=commit_stamp,
3344
3119
timezone=offset,
3345
exclude=tree.safe_relpath_files(exclude),
3120
exclude=safe_relpath_files(tree, exclude))
3347
3121
except PointlessCommit:
3122
# FIXME: This should really happen before the file is read in;
3123
# perhaps prepare the commit; get the message; then actually commit
3348
3124
raise errors.BzrCommandError("No changes to commit."
3349
" Please 'bzr add' the files you want to commit, or use"
3350
" --unchanged to force an empty commit.")
3125
" Use --unchanged to commit anyhow.")
3351
3126
except ConflictsInTree:
3352
3127
raise errors.BzrCommandError('Conflicts detected in working '
3353
3128
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3356
3131
raise errors.BzrCommandError("Commit refused because there are"
3357
3132
" unknown files in the working tree.")
3358
3133
except errors.BoundBranchOutOfDate, e:
3359
e.extra_help = ("\n"
3360
'To commit to master branch, run update and then commit.\n'
3361
'You can also pass --local to commit to continue working '
3134
raise errors.BzrCommandError(str(e) + "\n"
3135
'To commit to master branch, run update and then commit.\n'
3136
'You can also pass --local to commit to continue working '
3366
3140
class cmd_check(Command):
3367
__doc__ = """Validate working tree structure, branch consistency and repository history.
3141
"""Validate working tree structure, branch consistency and repository history.
3369
3143
This command checks various invariants about branch and repository storage
3370
3144
to detect data corruption or bzr bugs.
3436
3210
class cmd_upgrade(Command):
3437
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3439
When the default format has changed after a major new release of
3440
Bazaar, you may be informed during certain operations that you
3441
should upgrade. Upgrading to a newer format may improve performance
3442
or make new features available. It may however limit interoperability
3443
with older repositories or with older versions of Bazaar.
3445
If you wish to upgrade to a particular format rather than the
3446
current default, that can be specified using the --format option.
3447
As a consequence, you can use the upgrade command this way to
3448
"downgrade" to an earlier format, though some conversions are
3449
a one way process (e.g. changing from the 1.x default to the
3450
2.x default) so downgrading is not always possible.
3452
A backup.bzr.~#~ directory is created at the start of the conversion
3453
process (where # is a number). By default, this is left there on
3454
completion. If the conversion fails, delete the new .bzr directory
3455
and rename this one back in its place. Use the --clean option to ask
3456
for the backup.bzr directory to be removed on successful conversion.
3457
Alternatively, you can delete it by hand if everything looks good
3460
If the location given is a shared repository, dependent branches
3461
are also converted provided the repository converts successfully.
3462
If the conversion of a branch fails, remaining branches are still
3465
For more information on upgrades, see the Bazaar Upgrade Guide,
3466
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3211
"""Upgrade branch storage to current format.
3213
The check command or bzr developers may sometimes advise you to run
3214
this command. When the default format has changed you may also be warned
3215
during other operations to upgrade.
3469
_see_also = ['check', 'reconcile', 'formats']
3218
_see_also = ['check']
3470
3219
takes_args = ['url?']
3471
3220
takes_options = [
3472
RegistryOption('format',
3473
help='Upgrade to a specific format. See "bzr help'
3474
' formats" for details.',
3475
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3476
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3477
value_switches=True, title='Branch format'),
3479
help='Remove the backup.bzr directory if successful.'),
3481
help="Show what would be done, but don't actually do anything."),
3221
RegistryOption('format',
3222
help='Upgrade to a specific format. See "bzr help'
3223
' formats" for details.',
3224
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3225
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3226
value_switches=True, title='Branch format'),
3484
def run(self, url='.', format=None, clean=False, dry_run=False):
3229
def run(self, url='.', format=None):
3485
3230
from bzrlib.upgrade import upgrade
3486
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3488
if len(exceptions) == 1:
3489
# Compatibility with historical behavior
3231
upgrade(url, format)
3495
3234
class cmd_whoami(Command):
3496
__doc__ = """Show or set bzr user id.
3235
"""Show or set bzr user id.
3499
3238
Show the email of the current user::
3515
3253
encoding_type = 'replace'
3517
3255
@display_command
3518
def run(self, email=False, branch=False, name=None, directory=None):
3256
def run(self, email=False, branch=False, name=None):
3519
3257
if name is None:
3520
if directory is None:
3521
# use branch if we're inside one; otherwise global config
3523
c = Branch.open_containing(u'.')[0].get_config()
3524
except errors.NotBranchError:
3525
c = _mod_config.GlobalConfig()
3527
c = Branch.open(directory).get_config()
3258
# use branch if we're inside one; otherwise global config
3260
c = Branch.open_containing('.')[0].get_config()
3261
except errors.NotBranchError:
3262
c = config.GlobalConfig()
3529
3264
self.outf.write(c.user_email() + '\n')
3531
3266
self.outf.write(c.username() + '\n')
3535
raise errors.BzrCommandError("--email can only be used to display existing "
3538
3269
# display a warning if an email address isn't included in the given name.
3540
_mod_config.extract_email_address(name)
3271
config.extract_email_address(name)
3541
3272
except errors.NoEmailInUsername, e:
3542
3273
warning('"%s" does not seem to contain an email address. '
3543
3274
'This is allowed, but not recommended.', name)
3545
3276
# use global config unless --branch given
3547
if directory is None:
3548
c = Branch.open_containing(u'.')[0].get_config()
3550
c = Branch.open(directory).get_config()
3278
c = Branch.open_containing('.')[0].get_config()
3552
c = _mod_config.GlobalConfig()
3280
c = config.GlobalConfig()
3553
3281
c.set_user_option('email', name)
3556
3284
class cmd_nick(Command):
3557
__doc__ = """Print or set the branch nickname.
3285
"""Print or set the branch nickname.
3559
3287
If unset, the tree root directory name is used as the nickname.
3560
3288
To print the current nickname, execute with no argument.
3622
3349
'bzr alias --remove expects an alias to remove.')
3623
3350
# If alias is not found, print something like:
3624
3351
# unalias: foo: not found
3625
c = _mod_config.GlobalConfig()
3352
c = config.GlobalConfig()
3626
3353
c.unset_alias(alias_name)
3628
3355
@display_command
3629
3356
def print_aliases(self):
3630
3357
"""Print out the defined aliases in a similar format to bash."""
3631
aliases = _mod_config.GlobalConfig().get_aliases()
3358
aliases = config.GlobalConfig().get_aliases()
3632
3359
for key, value in sorted(aliases.iteritems()):
3633
3360
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3645
3372
def set_alias(self, alias_name, alias_command):
3646
3373
"""Save the alias in the global config."""
3647
c = _mod_config.GlobalConfig()
3374
c = config.GlobalConfig()
3648
3375
c.set_alias(alias_name, alias_command)
3651
3378
class cmd_selftest(Command):
3652
__doc__ = """Run internal test suite.
3379
"""Run internal test suite.
3654
3381
If arguments are given, they are regular expressions that say which tests
3655
3382
should run. Tests matching any expression are run, and other tests are
3702
3426
def get_transport_type(typestring):
3703
3427
"""Parse and return a transport specifier."""
3704
3428
if typestring == "sftp":
3705
from bzrlib.tests import stub_sftp
3706
return stub_sftp.SFTPAbsoluteServer
3707
elif typestring == "memory":
3708
from bzrlib.tests import test_server
3709
return memory.MemoryServer
3710
elif typestring == "fakenfs":
3711
from bzrlib.tests import test_server
3712
return test_server.FakeNFSServer
3429
from bzrlib.transport.sftp import SFTPAbsoluteServer
3430
return SFTPAbsoluteServer
3431
if typestring == "memory":
3432
from bzrlib.transport.memory import MemoryServer
3434
if typestring == "fakenfs":
3435
from bzrlib.transport.fakenfs import FakeNFSServer
3436
return FakeNFSServer
3713
3437
msg = "No known transport type %s. Supported types are: sftp\n" %\
3715
3439
raise errors.BzrCommandError(msg)
3726
3450
'throughout the test suite.',
3727
3451
type=get_transport_type),
3728
3452
Option('benchmark',
3729
help='Run the benchmarks rather than selftests.',
3453
help='Run the benchmarks rather than selftests.'),
3731
3454
Option('lsprof-timed',
3732
3455
help='Generate lsprof output for benchmarked'
3733
3456
' sections of code.'),
3734
3457
Option('lsprof-tests',
3735
3458
help='Generate lsprof output for each test.'),
3459
Option('cache-dir', type=str,
3460
help='Cache intermediate benchmark output in this '
3736
3462
Option('first',
3737
3463
help='Run all tests, but run specified tests first.',
3738
3464
short_name='f',
3747
3473
Option('randomize', type=str, argname="SEED",
3748
3474
help='Randomize the order of tests using the given'
3749
3475
' seed or "now" for the current time.'),
3750
ListOption('exclude', type=str, argname="PATTERN",
3752
help='Exclude tests that match this regular'
3476
Option('exclude', type=str, argname="PATTERN",
3478
help='Exclude tests that match this regular'
3754
3480
Option('subunit',
3755
3481
help='Output test progress via subunit.'),
3756
3482
Option('strict', help='Fail on missing dependencies or '
3773
3499
def run(self, testspecs_list=None, verbose=False, one=False,
3774
3500
transport=None, benchmark=None,
3501
lsprof_timed=None, cache_dir=None,
3776
3502
first=False, list_only=False,
3777
3503
randomize=None, exclude=None, strict=False,
3778
3504
load_list=None, debugflag=None, starting_with=None, subunit=False,
3779
3505
parallel=None, lsprof_tests=False):
3780
from bzrlib import tests
3506
from bzrlib.tests import selftest
3507
import bzrlib.benchmarks as benchmarks
3508
from bzrlib.benchmarks import tree_creator
3510
# Make deprecation warnings visible, unless -Werror is set
3511
symbol_versioning.activate_deprecation_warnings(override=False)
3513
if cache_dir is not None:
3514
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3782
3515
if testspecs_list is not None:
3783
3516
pattern = '|'.join(testspecs_list)
3790
3523
raise errors.BzrCommandError("subunit not available. subunit "
3791
3524
"needs to be installed to use --subunit.")
3792
3525
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3793
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3794
# stdout, which would corrupt the subunit stream.
3795
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3796
# following code can be deleted when it's sufficiently deployed
3797
# -- vila/mgz 20100514
3798
if (sys.platform == "win32"
3799
and getattr(sys.stdout, 'fileno', None) is not None):
3801
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3803
3527
self.additional_selftest_args.setdefault(
3804
3528
'suite_decorators', []).append(parallel)
3806
raise errors.BzrCommandError(
3807
"--benchmark is no longer supported from bzr 2.2; "
3808
"use bzr-usertest instead")
3809
test_suite_factory = None
3811
exclude_pattern = None
3530
test_suite_factory = benchmarks.test_suite
3531
# Unless user explicitly asks for quiet, be verbose in benchmarks
3532
verbose = not is_quiet()
3533
# TODO: should possibly lock the history file...
3534
benchfile = open(".perf_history", "at", buffering=1)
3535
self.add_cleanup(benchfile.close)
3813
exclude_pattern = '(' + '|'.join(exclude) + ')'
3537
test_suite_factory = None
3814
3539
selftest_kwargs = {"verbose": verbose,
3815
3540
"pattern": pattern,
3816
3541
"stop_on_failure": one,
3818
3543
"test_suite_factory": test_suite_factory,
3819
3544
"lsprof_timed": lsprof_timed,
3820
3545
"lsprof_tests": lsprof_tests,
3546
"bench_history": benchfile,
3821
3547
"matching_tests_first": first,
3822
3548
"list_only": list_only,
3823
3549
"random_seed": randomize,
3824
"exclude_pattern": exclude_pattern,
3550
"exclude_pattern": exclude,
3825
3551
"strict": strict,
3826
3552
"load_list": load_list,
3827
3553
"debug_flags": debugflag,
3828
3554
"starting_with": starting_with
3830
3556
selftest_kwargs.update(self.additional_selftest_args)
3832
# Make deprecation warnings visible, unless -Werror is set
3833
cleanup = symbol_versioning.activate_deprecation_warnings(
3836
result = tests.selftest(**selftest_kwargs)
3557
result = selftest(**selftest_kwargs)
3839
3558
return int(not result)
3842
3561
class cmd_version(Command):
3843
__doc__ = """Show version of bzr."""
3562
"""Show version of bzr."""
3845
3564
encoding_type = 'replace'
3846
3565
takes_options = [
3880
3599
branch1 = Branch.open_containing(branch)[0]
3881
3600
branch2 = Branch.open_containing(other)[0]
3882
self.add_cleanup(branch1.lock_read().unlock)
3883
self.add_cleanup(branch2.lock_read().unlock)
3602
self.add_cleanup(branch1.unlock)
3604
self.add_cleanup(branch2.unlock)
3884
3605
last1 = ensure_null(branch1.last_revision())
3885
3606
last2 = ensure_null(branch2.last_revision())
3887
3608
graph = branch1.repository.get_graph(branch2.repository)
3888
3609
base_rev_id = graph.find_unique_lca(last1, last2)
3890
self.outf.write('merge base is revision %s\n' % base_rev_id)
3611
print 'merge base is revision %s' % base_rev_id
3893
3614
class cmd_merge(Command):
3894
__doc__ = """Perform a three-way merge.
3615
"""Perform a three-way merge.
3896
3617
The source of the merge can be specified either in the form of a branch,
3897
3618
or in the form of a path to a file containing a merge directive generated
3898
3619
with bzr send. If neither is specified, the default is the upstream branch
3899
or the branch most recently merged using --remember. The source of the
3900
merge may also be specified in the form of a path to a file in another
3901
branch: in this case, only the modifications to that file are merged into
3902
the current working tree.
3904
When merging from a branch, by default bzr will try to merge in all new
3905
work from the other branch, automatically determining an appropriate base
3906
revision. If this fails, you may need to give an explicit base.
3908
To pick a different ending revision, pass "--revision OTHER". bzr will
3909
try to merge in all new work up to and including revision OTHER.
3911
If you specify two values, "--revision BASE..OTHER", only revisions BASE
3912
through OTHER, excluding BASE but including OTHER, will be merged. If this
3913
causes some revisions to be skipped, i.e. if the destination branch does
3914
not already contain revision BASE, such a merge is commonly referred to as
3915
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
3916
cherrypicks. The changes look like a normal commit, and the history of the
3917
changes from the other branch is not stored in the commit.
3919
Revision numbers are always relative to the source branch.
3620
or the branch most recently merged using --remember.
3622
When merging a branch, by default the tip will be merged. To pick a different
3623
revision, pass --revision. If you specify two values, the first will be used as
3624
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3625
available revisions, like this is commonly referred to as "cherrypicking".
3627
Revision numbers are always relative to the branch being merged.
3629
By default, bzr will try to merge in all new work from the other
3630
branch, automatically determining an appropriate base. If this
3631
fails, you may need to give an explicit base.
3921
3633
Merge will do its best to combine the changes in two branches, but there
3922
3634
are some kinds of problems only a human can fix. When it encounters those,
3926
3638
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3928
If there is no default branch set, the first merge will set it (use
3929
--no-remember to avoid settting it). After that, you can omit the branch
3930
to use the default. To change the default, use --remember. The value will
3931
only be saved if the remote location can be accessed.
3640
If there is no default branch set, the first merge will set it. After
3641
that, you can omit the branch to use the default. To change the
3642
default, use --remember. The value will only be saved if the remote
3643
location can be accessed.
3933
3645
The results of the merge are placed into the destination working
3934
3646
directory, where they can be reviewed (with bzr diff), tested, and then
3935
3647
committed to record the result of the merge.
3937
3649
merge refuses to run if there are any uncommitted changes, unless
3938
--force is given. If --force is given, then the changes from the source
3939
will be merged with the current working tree, including any uncommitted
3940
changes in the tree. The --force option can also be used to create a
3941
merge revision which has more than two parents.
3943
3652
If one would like to merge changes from the working tree of the other
3944
3653
branch without merging any committed revisions, the --uncommitted option
3991
3693
' completely merged into the source, pull from the'
3992
3694
' source rather than merging. When this happens,'
3993
3695
' you do not need to commit the result.'),
3994
custom_help('directory',
3995
3697
help='Branch to merge into, '
3996
'rather than the one containing the working directory.'),
3698
'rather than the one containing the working directory.',
3997
3702
Option('preview', help='Instead of merging, show a diff of the'
3999
3704
Option('interactive', help='Select changes interactively.',
4052
3754
raise errors.BzrCommandError(
4053
3755
'Cannot use -r with merge directives or bundles')
4054
3756
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4057
3759
if merger is None and uncommitted:
4058
3760
if revision is not None and len(revision) > 0:
4059
3761
raise errors.BzrCommandError('Cannot use --uncommitted and'
4060
3762
' --revision at the same time.')
4061
merger = self.get_merger_from_uncommitted(tree, location, None)
3763
merger = self.get_merger_from_uncommitted(tree, location, pb)
4062
3764
allow_pending = False
4064
3766
if merger is None:
4065
3767
merger, allow_pending = self._get_merger_from_branch(tree,
4066
location, revision, remember, possible_transports, None)
3768
location, revision, remember, possible_transports, pb)
4068
3770
merger.merge_type = merge_type
4069
3771
merger.reprocess = reprocess
4071
3773
self.sanity_check_merger(merger)
4072
3774
if (merger.base_rev_id == merger.other_rev_id and
4073
3775
merger.other_rev_id is not None):
4074
# check if location is a nonexistent file (and not a branch) to
4075
# disambiguate the 'Nothing to do'
4076
if merger.interesting_files:
4077
if not merger.other_tree.has_filename(
4078
merger.interesting_files[0]):
4079
note("merger: " + str(merger))
4080
raise errors.PathsDoNotExist([location])
4081
3776
note('Nothing to do.')
4083
if pull and not preview:
4084
3779
if merger.interesting_files is not None:
4085
3780
raise errors.BzrCommandError('Cannot pull individual files')
4086
3781
if (merger.base_rev_id == tree.last_revision()):
4110
3805
def _do_preview(self, merger):
4111
3806
from bzrlib.diff import show_diff_trees
4112
3807
result_tree = self._get_preview(merger)
4113
path_encoding = osutils.get_diff_header_encoding()
4114
3808
show_diff_trees(merger.this_tree, result_tree, self.outf,
4115
old_label='', new_label='',
4116
path_encoding=path_encoding)
3809
old_label='', new_label='')
4118
3811
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4119
3812
merger.change_reporter = change_reporter
4195
3888
if other_revision_id is None:
4196
3889
other_revision_id = _mod_revision.ensure_null(
4197
3890
other_branch.last_revision())
4198
# Remember where we merge from. We need to remember if:
4199
# - user specify a location (and we don't merge from the parent
4201
# - user ask to remember or there is no previous location set to merge
4202
# from and user didn't ask to *not* remember
4203
if (user_location is not None
4205
or (remember is None
4206
and tree.branch.get_submit_branch() is None)))):
3891
# Remember where we merge from
3892
if ((remember or tree.branch.get_submit_branch() is None) and
3893
user_location is not None):
4207
3894
tree.branch.set_submit_branch(other_branch.base)
4208
# Merge tags (but don't set them in the master branch yet, the user
4209
# might revert this merge). Commit will propagate them.
4210
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
3895
_merge_tags_if_possible(other_branch, tree.branch)
4211
3896
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4212
3897
other_revision_id, base_revision_id, other_branch, base_branch)
4213
3898
if other_path != '':
4312
3997
def run(self, file_list=None, merge_type=None, show_base=False,
4313
3998
reprocess=False):
4314
from bzrlib.conflicts import restore
4315
3999
if merge_type is None:
4316
4000
merge_type = _mod_merge.Merge3Merger
4317
tree, file_list = WorkingTree.open_containing_paths(file_list)
4318
self.add_cleanup(tree.lock_write().unlock)
4001
tree, file_list = tree_files(file_list)
4003
self.add_cleanup(tree.unlock)
4319
4004
parents = tree.get_parent_ids()
4320
4005
if len(parents) != 2:
4321
4006
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4357
4042
# list, we imply that the working tree text has seen and rejected
4358
4043
# all the changes from the other tree, when in fact those changes
4359
4044
# have not yet been seen.
4045
pb = ui.ui_factory.nested_progress_bar()
4360
4046
tree.set_parent_ids(parents[:1])
4362
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4048
merger = _mod_merge.Merger.from_revision_ids(pb,
4363
4050
merger.interesting_ids = interesting_ids
4364
4051
merger.merge_type = merge_type
4365
4052
merger.show_base = show_base
4376
4064
class cmd_revert(Command):
4377
__doc__ = """Revert files to a previous revision.
4065
"""Revert files to a previous revision.
4379
4067
Giving a list of files will revert only those files. Otherwise, all files
4380
4068
will be reverted. If the revision is not specified with '--revision', the
4381
4069
last committed revision is used.
4383
4071
To remove only some changes, without reverting to a prior version, use
4384
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4385
will remove the changes introduced by the second last commit (-2), without
4386
affecting the changes introduced by the last commit (-1). To remove
4387
certain changes on a hunk-by-hunk basis, see the shelve command.
4072
merge instead. For example, "merge . --revision -2..-3" will remove the
4073
changes introduced by -2, without affecting the changes introduced by -1.
4074
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4389
4076
By default, any files that have been manually changed will be backed up
4390
4077
first. (Files changed only by merge are not backed up.) Backup files have
4442
4130
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4443
4131
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4444
tree.revert(file_list, rev_tree, not no_backup, None,
4445
report_changes=True)
4132
pb = ui.ui_factory.nested_progress_bar()
4134
tree.revert(file_list, rev_tree, not no_backup, pb,
4135
report_changes=True)
4448
4140
class cmd_assert_fail(Command):
4449
__doc__ = """Test reporting of assertion failures"""
4141
"""Test reporting of assertion failures"""
4450
4142
# intended just for use in testing
4592
4280
remote_branch = Branch.open(other_branch)
4593
4281
if remote_branch.base == local_branch.base:
4594
4282
remote_branch = local_branch
4596
self.add_cleanup(remote_branch.lock_read().unlock)
4284
local_branch.lock_read()
4285
self.add_cleanup(local_branch.unlock)
4598
4286
local_revid_range = _revision_range_to_revid_range(
4599
4287
_get_revision_range(my_revision, local_branch,
4290
remote_branch.lock_read()
4291
self.add_cleanup(remote_branch.unlock)
4602
4292
remote_revid_range = _revision_range_to_revid_range(
4603
4293
_get_revision_range(revision,
4604
4294
remote_branch, self.name()))
4664
4355
class cmd_pack(Command):
4665
__doc__ = """Compress the data within a repository.
4667
This operation compresses the data within a bazaar repository. As
4668
bazaar supports automatic packing of repository, this operation is
4669
normally not required to be done manually.
4671
During the pack operation, bazaar takes a backup of existing repository
4672
data, i.e. pack files. This backup is eventually removed by bazaar
4673
automatically when it is safe to do so. To save disk space by removing
4674
the backed up pack files, the --clean-obsolete-packs option may be
4677
Warning: If you use --clean-obsolete-packs and your machine crashes
4678
during or immediately after repacking, you may be left with a state
4679
where the deletion has been written to disk but the new packs have not
4680
been. In this case the repository may be unusable.
4356
"""Compress the data within a repository."""
4683
4358
_see_also = ['repositories']
4684
4359
takes_args = ['branch_or_repo?']
4686
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4689
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4361
def run(self, branch_or_repo='.'):
4690
4362
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4692
4364
branch = dir.open_branch()
4693
4365
repository = branch.repository
4694
4366
except errors.NotBranchError:
4695
4367
repository = dir.open_repository()
4696
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4699
4371
class cmd_plugins(Command):
4700
__doc__ = """List the installed plugins.
4372
"""List the installed plugins.
4702
4374
This command displays the list of installed plugins including
4703
4375
version of plugin and a short description of each.
4710
4382
adding new commands, providing additional network transports and
4711
4383
customizing log output.
4713
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4714
for further information on plugins including where to find them and how to
4715
install them. Instructions are also provided there on how to write new
4716
plugins using the Python programming language.
4385
See the Bazaar web site, http://bazaar-vcs.org, for further
4386
information on plugins including where to find them and how to
4387
install them. Instructions are also provided there on how to
4388
write new plugins using the Python programming language.
4718
4390
takes_options = ['verbose']
4720
4392
@display_command
4721
4393
def run(self, verbose=False):
4722
from bzrlib import plugin
4723
# Don't give writelines a generator as some codecs don't like that
4724
self.outf.writelines(
4725
list(plugin.describe_plugins(show_paths=verbose)))
4394
import bzrlib.plugin
4395
from inspect import getdoc
4397
for name, plugin in bzrlib.plugin.plugins().items():
4398
version = plugin.__version__
4399
if version == 'unknown':
4401
name_ver = '%s %s' % (name, version)
4402
d = getdoc(plugin.module)
4404
doc = d.split('\n')[0]
4406
doc = '(no description)'
4407
result.append((name_ver, doc, plugin.path()))
4408
for name_ver, doc, path in sorted(result):
4728
4416
class cmd_testament(Command):
4729
__doc__ = """Show testament (signing-form) of a revision."""
4417
"""Show testament (signing-form) of a revision."""
4730
4418
takes_options = [
4732
4420
Option('long', help='Produce long-format testament.'),
4774
4463
Option('long', help='Show commit date in annotations.'),
4779
4467
encoding_type = 'exact'
4781
4469
@display_command
4782
4470
def run(self, filename, all=False, long=False, revision=None,
4783
show_ids=False, directory=None):
4784
from bzrlib.annotate import (
4472
from bzrlib.annotate import annotate_file, annotate_file_tree
4787
4473
wt, branch, relpath = \
4788
_open_directory_or_containing_tree_or_branch(filename, directory)
4474
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4789
4475
if wt is not None:
4790
self.add_cleanup(wt.lock_read().unlock)
4477
self.add_cleanup(wt.unlock)
4792
self.add_cleanup(branch.lock_read().unlock)
4480
self.add_cleanup(branch.unlock)
4793
4481
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4794
self.add_cleanup(tree.lock_read().unlock)
4795
if wt is not None and revision is None:
4483
self.add_cleanup(tree.unlock)
4796
4485
file_id = wt.path2id(relpath)
4798
4487
file_id = tree.path2id(relpath)
4799
4488
if file_id is None:
4800
4489
raise errors.NotVersionedError(filename)
4490
file_version = tree.inventory[file_id].revision
4801
4491
if wt is not None and revision is None:
4802
4492
# If there is a tree and we're not annotating historical
4803
4493
# versions, annotate the working tree's content.
4804
4494
annotate_file_tree(wt, file_id, self.outf, long, all,
4805
4495
show_ids=show_ids)
4807
annotate_file_tree(tree, file_id, self.outf, long, all,
4808
show_ids=show_ids, branch=branch)
4497
annotate_file(branch, file_version, file_id, long, all, self.outf,
4811
4501
class cmd_re_sign(Command):
4812
__doc__ = """Create a digital signature for an existing revision."""
4502
"""Create a digital signature for an existing revision."""
4813
4503
# TODO be able to replace existing ones.
4815
4505
hidden = True # is this right ?
4816
4506
takes_args = ['revision_id*']
4817
takes_options = ['directory', 'revision']
4507
takes_options = ['revision']
4819
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4509
def run(self, revision_id_list=None, revision=None):
4820
4510
if revision_id_list is not None and revision is not None:
4821
4511
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4822
4512
if revision_id_list is None and revision is None:
4823
4513
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4824
b = WorkingTree.open_containing(directory)[0].branch
4825
self.add_cleanup(b.lock_write().unlock)
4514
b = WorkingTree.open_containing(u'.')[0].branch
4516
self.add_cleanup(b.unlock)
4826
4517
return self._run(b, revision_id_list, revision)
4828
4519
def _run(self, b, revision_id_list, revision):
4924
4611
_see_also = ['checkouts', 'bind']
4925
4612
takes_args = []
4926
takes_options = ['directory']
4928
def run(self, directory=u'.'):
4929
b, relpath = Branch.open_containing(directory)
4616
b, relpath = Branch.open_containing(u'.')
4930
4617
if not b.unbind():
4931
4618
raise errors.BzrCommandError('Local branch is not bound')
4934
4621
class cmd_uncommit(Command):
4935
__doc__ = """Remove the last committed revision.
4622
"""Remove the last committed revision.
4937
4624
--verbose will print out what is being removed.
4938
4625
--dry-run will go through all the motions, but not actually
4978
4665
b = control.open_branch()
4980
4667
if tree is not None:
4981
self.add_cleanup(tree.lock_write().unlock)
4669
self.add_cleanup(tree.unlock)
4983
self.add_cleanup(b.lock_write().unlock)
4672
self.add_cleanup(b.unlock)
4984
4673
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4986
4675
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
5019
4708
end_revision=last_revno)
5022
self.outf.write('Dry-run, pretending to remove'
5023
' the above revisions.\n')
4711
print 'Dry-run, pretending to remove the above revisions.'
4713
val = raw_input('Press <enter> to continue')
5025
self.outf.write('The above revision(s) will be removed.\n')
5028
if not ui.ui_factory.confirm_action(
5029
u'Uncommit these revisions',
5030
'bzrlib.builtins.uncommit',
5032
self.outf.write('Canceled\n')
4715
print 'The above revision(s) will be removed.'
4717
val = raw_input('Are you sure [y/N]? ')
4718
if val.lower() not in ('y', 'yes'):
5035
4722
mutter('Uncommitting from {%s} to {%s}',
5036
4723
last_rev_id, rev_id)
5037
4724
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5038
4725
revno=revno, local=local)
5039
self.outf.write('You can restore the old tip by running:\n'
5040
' bzr pull . -r revid:%s\n' % last_rev_id)
4726
note('You can restore the old tip by running:\n'
4727
' bzr pull . -r revid:%s', last_rev_id)
5043
4730
class cmd_break_lock(Command):
5044
__doc__ = """Break a dead lock.
5046
This command breaks a lock on a repository, branch, working directory or
4731
"""Break a dead lock on a repository, branch or working directory.
5049
4733
CAUTION: Locks should only be broken when you are sure that the process
5050
4734
holding the lock has been stopped.
5057
4741
bzr break-lock bzr+ssh://example.com/bzr/foo
5058
bzr break-lock --conf ~/.bazaar
5061
4743
takes_args = ['location?']
5064
help='LOCATION is the directory where the config lock is.'),
5066
help='Do not ask for confirmation before breaking the lock.'),
5069
def run(self, location=None, config=False, force=False):
4745
def run(self, location=None, show=False):
5070
4746
if location is None:
5071
4747
location = u'.'
5073
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5075
{'bzrlib.lockdir.break': True})
5077
conf = _mod_config.LockableConfig(file_name=location)
5080
control, relpath = bzrdir.BzrDir.open_containing(location)
5082
control.break_lock()
5083
except NotImplementedError:
4748
control, relpath = bzrdir.BzrDir.open_containing(location)
4750
control.break_lock()
4751
except NotImplementedError:
5087
4755
class cmd_wait_until_signalled(Command):
5088
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4756
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5090
4758
This just prints a line to signal when it is ready, then blocks on stdin.
5151
4820
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5152
4821
protocol=None):
5153
from bzrlib import transport
4822
from bzrlib.transport import get_transport, transport_server_registry
5154
4823
if directory is None:
5155
4824
directory = os.getcwd()
5156
4825
if protocol is None:
5157
protocol = transport.transport_server_registry.get()
4826
protocol = transport_server_registry.get()
5158
4827
host, port = self.get_host_and_port(port)
5159
4828
url = urlutils.local_path_to_url(directory)
5160
4829
if not allow_writes:
5161
4830
url = 'readonly+' + url
5162
t = transport.get_transport(url)
5163
protocol(t, host, port, inet)
4831
transport = get_transport(url)
4832
protocol(transport, host, port, inet)
5166
4835
class cmd_join(Command):
5167
__doc__ = """Combine a tree into its containing tree.
4836
"""Combine a tree into its containing tree.
5169
4838
This command requires the target tree to be in a rich-root format.
5278
4946
encoding_type = 'exact'
5280
4948
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5281
sign=False, revision=None, mail_to=None, message=None,
4949
sign=False, revision=None, mail_to=None, message=None):
5283
4950
from bzrlib.revision import ensure_null, NULL_REVISION
5284
4951
include_patch, include_bundle = {
5285
4952
'plain': (False, False),
5286
4953
'diff': (True, False),
5287
4954
'bundle': (True, True),
5289
branch = Branch.open(directory)
4956
branch = Branch.open('.')
5290
4957
stored_submit_branch = branch.get_submit_branch()
5291
4958
if submit_branch is None:
5292
4959
submit_branch = stored_submit_branch
5368
5035
source branch defaults to that containing the working directory, but can
5369
5036
be changed using --from.
5371
Both the submit branch and the public branch follow the usual behavior with
5372
respect to --remember: If there is no default location set, the first send
5373
will set it (use --no-remember to avoid settting it). After that, you can
5374
omit the location to use the default. To change the default, use
5375
--remember. The value will only be saved if the location can be accessed.
5377
5038
In order to calculate those changes, bzr must analyse the submit branch.
5378
5039
Therefore it is most efficient for the submit branch to be a local mirror.
5379
5040
If a public location is known for the submit_branch, that location is used
5548
5209
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5549
5210
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5551
If no tag name is specified it will be determined through the
5552
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5553
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5557
5213
_see_also = ['commit', 'tags']
5558
takes_args = ['tag_name?']
5214
takes_args = ['tag_name']
5559
5215
takes_options = [
5560
5216
Option('delete',
5561
5217
help='Delete this tag rather than placing it.',
5563
custom_help('directory',
5564
help='Branch in which to place the tag.'),
5220
help='Branch in which to place the tag.',
5565
5224
Option('force',
5566
5225
help='Replace existing tags.',
5571
def run(self, tag_name=None,
5230
def run(self, tag_name,
5577
5236
branch, relpath = Branch.open_containing(directory)
5578
self.add_cleanup(branch.lock_write().unlock)
5238
self.add_cleanup(branch.unlock)
5580
if tag_name is None:
5581
raise errors.BzrCommandError("No tag specified to delete.")
5582
5240
branch.tags.delete_tag(tag_name)
5583
note('Deleted tag %s.' % tag_name)
5241
self.outf.write('Deleted tag %s.\n' % tag_name)
5586
5244
if len(revision) != 1:
5590
5248
revision_id = revision[0].as_revision_id(branch)
5592
5250
revision_id = branch.last_revision()
5593
if tag_name is None:
5594
tag_name = branch.automatic_tag_name(revision_id)
5595
if tag_name is None:
5596
raise errors.BzrCommandError(
5597
"Please specify a tag name.")
5598
5251
if (not force) and branch.tags.has_tag(tag_name):
5599
5252
raise errors.TagAlreadyExists(tag_name)
5600
5253
branch.tags.set_tag(tag_name, revision_id)
5601
note('Created tag %s.' % tag_name)
5254
self.outf.write('Created tag %s.\n' % tag_name)
5604
5257
class cmd_tags(Command):
5605
__doc__ = """List tags.
5607
5260
This command shows a table of tag names and the revisions they reference.
5610
5263
_see_also = ['tag']
5611
5264
takes_options = [
5612
custom_help('directory',
5613
help='Branch whose tags should be displayed.'),
5614
RegistryOption('sort',
5266
help='Branch whose tags should be displayed.',
5270
RegistryOption.from_kwargs('sort',
5615
5271
'Sort tags by different criteria.', title='Sorting',
5616
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5272
alpha='Sort tags lexicographically (default).',
5273
time='Sort tags chronologically.',
5622
5279
@display_command
5623
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5624
from bzrlib.tag import tag_sort_methods
5625
5286
branch, relpath = Branch.open_containing(directory)
5627
5288
tags = branch.tags.get_tag_dict().items()
5631
self.add_cleanup(branch.lock_read().unlock)
5293
self.add_cleanup(branch.unlock)
5633
5295
graph = branch.repository.get_graph()
5634
5296
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5636
5298
# only show revisions between revid1 and revid2 (inclusive)
5637
5299
tags = [(tag, revid) for tag, revid in tags if
5638
5300
graph.is_between(revid, revid1, revid2)]
5640
sort = tag_sort_methods.get()
5303
elif sort == 'time':
5305
for tag, revid in tags:
5307
revobj = branch.repository.get_revision(revid)
5308
except errors.NoSuchRevision:
5309
timestamp = sys.maxint # place them at the end
5311
timestamp = revobj.timestamp
5312
timestamps[revid] = timestamp
5313
tags.sort(key=lambda x: timestamps[x[1]])
5642
5314
if not show_ids:
5643
5315
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5644
5316
for index, (tag, revid) in enumerate(tags):
5783
5454
def run(self, to_location=None, force=False, create_branch=False,
5784
revision=None, directory=u'.'):
5785
5456
from bzrlib import switch
5786
tree_location = directory
5787
5458
revision = _get_one_revision('switch', revision)
5788
5459
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5789
5460
if to_location is None:
5790
5461
if revision is None:
5791
5462
raise errors.BzrCommandError('You must supply either a'
5792
5463
' revision or a location')
5793
to_location = tree_location
5795
5466
branch = control_dir.open_branch()
5796
5467
had_explicit_nick = branch.get_config().has_explicit_nickname()
6019
5689
self.outf.write(" <no hooks installed>\n")
6022
class cmd_remove_branch(Command):
6023
__doc__ = """Remove a branch.
6025
This will remove the branch from the specified location but
6026
will keep any working tree or repository in place.
6030
Remove the branch at repo/trunk::
6032
bzr remove-branch repo/trunk
6036
takes_args = ["location?"]
6038
aliases = ["rmbranch"]
6040
def run(self, location=None):
6041
if location is None:
6043
branch = Branch.open_containing(location)[0]
6044
branch.bzrdir.destroy_branch()
6047
5692
class cmd_shelve(Command):
6048
__doc__ = """Temporarily set aside some changes from the current tree.
5693
"""Temporarily set aside some changes from the current tree.
6050
5695
Shelve allows you to temporarily put changes you've made "on the shelf",
6051
5696
ie. out of the way, until a later time when you can bring them back from
6068
5713
You can put multiple items on the shelf, and by default, 'unshelve' will
6069
5714
restore the most recently shelved changes.
6071
For complicated changes, it is possible to edit the changes in a separate
6072
editor program to decide what the file remaining in the working copy
6073
should look like. To do this, add the configuration option
6075
change_editor = PROGRAM @new_path @old_path
6077
where @new_path is replaced with the path of the new version of the
6078
file and @old_path is replaced with the path of the old version of
6079
the file. The PROGRAM should save the new file with the desired
6080
contents of the file in the working tree.
6084
5717
takes_args = ['file*']
6086
5719
takes_options = [
6089
5721
Option('all', help='Shelve all changes.'),
6096
5728
Option('destroy',
6097
5729
help='Destroy removed changes instead of shelving them.'),
6099
_see_also = ['unshelve', 'configuration']
5731
_see_also = ['unshelve']
6101
5733
def run(self, revision=None, all=False, file_list=None, message=None,
6102
writer=None, list=False, destroy=False, directory=None):
5734
writer=None, list=False, destroy=False):
6104
return self.run_for_list(directory=directory)
5736
return self.run_for_list()
6105
5737
from bzrlib.shelf_ui import Shelver
6106
5738
if writer is None:
6107
5739
writer = bzrlib.option.diff_writer_registry.get()
6109
5741
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6110
file_list, message, destroy=destroy, directory=directory)
5742
file_list, message, destroy=destroy)
6182
5812
To check what clean-tree will do, use --dry-run.
6184
takes_options = ['directory',
6185
Option('ignored', help='Delete all ignored files.'),
6186
Option('detritus', help='Delete conflict files, merge and revert'
5814
takes_options = [Option('ignored', help='Delete all ignored files.'),
5815
Option('detritus', help='Delete conflict files, merge'
6187
5816
' backups, and failed selftest dirs.'),
6188
5817
Option('unknown',
6189
5818
help='Delete files unknown to bzr (default).'),
6191
5820
' deleting them.'),
6192
5821
Option('force', help='Do not prompt before deleting.')]
6193
5822
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6194
force=False, directory=u'.'):
6195
5824
from bzrlib.clean_tree import clean_tree
6196
5825
if not (unknown or ignored or detritus):
6200
clean_tree(directory, unknown=unknown, ignored=ignored,
6201
detritus=detritus, dry_run=dry_run, no_prompt=force)
5829
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5830
dry_run=dry_run, no_prompt=force)
6204
5833
class cmd_reference(Command):
6205
__doc__ = """list, view and set branch locations for nested trees.
5834
"""list, view and set branch locations for nested trees.
6207
5836
If no arguments are provided, lists the branch locations for nested trees.
6208
5837
If one argument is provided, display the branch location for that tree.
6248
5877
self.outf.write('%s %s\n' % (path, location))
6251
class cmd_export_pot(Command):
6252
__doc__ = """Export command helps and error messages in po format."""
6257
from bzrlib.export_pot import export_pot
6258
export_pot(self.outf)
6261
def _register_lazy_builtins():
6262
# register lazy builtins from other modules; called at startup and should
6263
# be only called once.
6264
for (name, aliases, module_name) in [
6265
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6266
('cmd_config', [], 'bzrlib.config'),
6267
('cmd_dpush', [], 'bzrlib.foreign'),
6268
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6269
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6270
('cmd_conflicts', [], 'bzrlib.conflicts'),
6271
('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6272
('cmd_verify_signatures', [],
6273
'bzrlib.commit_signature_commands'),
6274
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6276
builtin_command_registry.register_lazy(name, aliases, module_name)
5880
# these get imported and then picked up by the scan for cmd_*
5881
# TODO: Some more consistent way to split command definitions across files;
5882
# we do need to load at least some information about them to know of
5883
# aliases. ideally we would avoid loading the implementation until the
5884
# details were needed.
5885
from bzrlib.cmd_version_info import cmd_version_info
5886
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5887
from bzrlib.bundle.commands import (
5890
from bzrlib.foreign import cmd_dpush
5891
from bzrlib.sign_my_commits import cmd_sign_my_commits
5892
from bzrlib.weave_commands import cmd_versionedfile_list, \
5893
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
