55
55
from bzrlib.branch import Branch
56
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.transport import memory
58
57
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
58
from bzrlib.smtp_connection import SMTPConnection
60
59
from bzrlib.workingtree import WorkingTree
63
from bzrlib.commands import (
65
builtin_command_registry,
62
from bzrlib.commands import Command, display_command
68
63
from bzrlib.option import (
334
329
class cmd_cat_revision(Command):
335
__doc__ = """Write out metadata for a revision.
330
"""Write out metadata for a revision.
337
332
The revision to print can either be specified by a specific
338
333
revision identifier, or you can use --revision.
344
339
# cat-revision is more for frontends so should be exact
345
340
encoding = 'strict'
347
def print_revision(self, revisions, revid):
348
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
349
record = stream.next()
350
if record.storage_kind == 'absent':
351
raise errors.NoSuchRevision(revisions, revid)
352
revtext = record.get_bytes_as('fulltext')
353
self.outf.write(revtext.decode('utf-8'))
356
343
def run(self, revision_id=None, revision=None):
357
344
if revision_id is not None and revision is not None:
362
349
' --revision or a revision_id')
363
350
b = WorkingTree.open_containing(u'.')[0].branch
365
revisions = b.repository.revisions
366
if revisions is None:
367
raise errors.BzrCommandError('Repository %r does not support '
368
'access to raw revision texts')
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
b.repository.lock_read()
372
# TODO: jam 20060112 should cat-revision always output utf-8?
373
if revision_id is not None:
374
revision_id = osutils.safe_revision_id(revision_id, warn=False)
376
self.print_revision(revisions, revision_id)
377
except errors.NoSuchRevision:
378
msg = "The repository %s contains no revision %s." % (
379
b.repository.base, revision_id)
380
raise errors.BzrCommandError(msg)
381
elif revision is not None:
384
raise errors.BzrCommandError(
385
'You cannot specify a NULL revision.')
386
rev_id = rev.as_revision_id(b)
387
self.print_revision(revisions, rev_id)
389
b.repository.unlock()
392
370
class cmd_dump_btree(Command):
393
__doc__ = """Dump the contents of a btree index file to stdout.
371
"""Dump the contents of a btree index file to stdout.
395
373
PATH is a btree index file, it can be any URL. This includes things like
396
374
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
460
438
for node in bt.iter_all_entries():
461
439
# Node is made up of:
462
440
# (index, key, value, [references])
466
refs_as_tuples = None
468
refs_as_tuples = static_tuple.as_tuples(refs)
441
refs_as_tuples = static_tuple.as_tuples(node[3])
469
442
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
470
443
self.outf.write('%s\n' % (as_tuple,))
473
446
class cmd_remove_tree(Command):
474
__doc__ = """Remove the working tree from a given branch/checkout.
447
"""Remove the working tree from a given branch/checkout.
476
449
Since a lightweight checkout is little more than a working tree
477
450
this will refuse to run against one.
479
452
To re-create the working tree, use "bzr checkout".
481
454
_see_also = ['checkout', 'working-trees']
482
takes_args = ['location*']
455
takes_args = ['location?']
483
456
takes_options = [
485
458
help='Remove the working tree even if it has '
486
459
'uncommitted changes.'),
489
def run(self, location_list, force=False):
490
if not location_list:
493
for location in location_list:
494
d = bzrdir.BzrDir.open(location)
497
working = d.open_workingtree()
498
except errors.NoWorkingTree:
499
raise errors.BzrCommandError("No working tree to remove")
500
except errors.NotLocalUrl:
501
raise errors.BzrCommandError("You cannot remove the working tree"
504
if (working.has_changes()):
505
raise errors.UncommittedChanges(working)
507
if working.user_url != working.branch.user_url:
508
raise errors.BzrCommandError("You cannot remove the working tree"
509
" from a lightweight checkout")
511
d.destroy_workingtree()
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"
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()
514
485
class cmd_revno(Command):
515
__doc__ = """Show current revision number.
486
"""Show current revision number.
517
488
This is equal to the number of revisions on this branch.
707
678
def run(self, dir_list):
708
679
for d in dir_list:
709
681
wt, dd = WorkingTree.open_containing(d)
710
base = os.path.dirname(dd)
711
id = wt.path2id(base)
715
self.outf.write('added %s\n' % d)
717
raise errors.NotVersionedError(path=base)
683
self.outf.write('added %s\n' % d)
720
686
class cmd_relpath(Command):
721
__doc__ = """Show path of a file relative to root"""
687
"""Show path of a file relative to root"""
723
689
takes_args = ['filename']
987
953
tree_to = WorkingTree.open_containing(directory)[0]
988
954
branch_to = tree_to.branch
990
self.add_cleanup(tree_to.unlock)
991
955
except errors.NoWorkingTree:
993
957
branch_to = Branch.open_containing(directory)[0]
994
branch_to.lock_write()
995
self.add_cleanup(branch_to.unlock)
997
959
if local and not branch_to.get_bound_location():
998
960
raise errors.LocalRequiresBoundBranch()
1030
992
branch_from = Branch.open(location,
1031
993
possible_transports=possible_transports)
995
if branch_to.get_parent() is None or remember:
996
branch_to.set_parent(branch_from.base)
998
if branch_from is not branch_to:
1032
999
branch_from.lock_read()
1033
1000
self.add_cleanup(branch_from.unlock)
1035
if branch_to.get_parent() is None or remember:
1036
branch_to.set_parent(branch_from.base)
1038
1001
if revision is not None:
1039
1002
revision_id = revision.as_revision_id(branch_from)
1004
branch_to.lock_write()
1005
self.add_cleanup(branch_to.unlock)
1041
1006
if tree_to is not None:
1042
1007
view_info = _get_view_info_for_change_reporter(tree_to)
1043
1008
change_reporter = delta._ChangeReporter(
1125
1090
# Get the source branch
1126
1091
(tree, br_from,
1127
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
1128
1096
# Get the tip's revision_id
1129
1097
revision = _get_one_revision('push', revision)
1130
1098
if revision is not None:
1131
1099
revision_id = revision.in_history(br_from).rev_id
1133
1101
revision_id = None
1134
if tree is not None and revision_id is None:
1135
tree.check_changed_or_out_of_date(
1136
strict, 'push_strict',
1137
more_error='Use --no-strict to force the push.',
1138
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.')
1139
1113
# Get the stacked_on branch, if any
1140
1114
if stacked_on is not None:
1141
1115
stacked_on = urlutils.normalize_url(stacked_on)
1175
1149
class cmd_branch(Command):
1176
__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.
1178
1152
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1179
1153
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1288
1262
class cmd_checkout(Command):
1289
__doc__ = """Create a new checkout of an existing branch.
1263
"""Create a new checkout of an existing branch.
1291
1265
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1292
1266
the branch found in '.'. This is useful if you have removed the working tree
1389
1363
class cmd_update(Command):
1390
__doc__ = """Update a tree to have the latest code committed to its branch.
1364
"""Update a tree to have the latest code committed to its branch.
1392
1366
This will perform a merge into the working tree, and may generate
1393
1367
conflicts. If you have any local changes, you will still
1422
1396
branch_location = tree.branch.base
1423
1397
self.add_cleanup(tree.unlock)
1424
1398
# get rid of the final '/' and be ready for display
1425
branch_location = urlutils.unescape_for_display(
1426
branch_location.rstrip('/'),
1399
branch_location = urlutils.unescape_for_display(branch_location[:-1],
1428
1401
existing_pending_merges = tree.get_parent_ids()[1:]
1429
1402
if master is None:
1439
1412
revision_id = branch.last_revision()
1440
1413
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1441
revno = branch.revision_id_to_dotted_revno(revision_id)
1442
note("Tree is up to date at revision %s of branch %s" %
1443
('.'.join(map(str, revno)), branch_location))
1414
revno = branch.revision_id_to_revno(revision_id)
1415
note("Tree is up to date at revision %d of branch %s" %
1416
(revno, branch_location))
1445
1418
view_info = _get_view_info_for_change_reporter(tree)
1446
1419
change_reporter = delta._ChangeReporter(
1458
1431
"bzr update --revision only works"
1459
1432
" for a revision in the branch history"
1460
1433
% (e.revision))
1461
revno = tree.branch.revision_id_to_dotted_revno(
1434
revno = tree.branch.revision_id_to_revno(
1462
1435
_mod_revision.ensure_null(tree.last_revision()))
1463
note('Updated to revision %s of branch %s' %
1464
('.'.join(map(str, revno)), branch_location))
1465
parent_ids = tree.get_parent_ids()
1466
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:
1467
1439
note('Your local commits will now show as pending merges with '
1468
1440
"'bzr status', and can be committed with 'bzr commit'.")
1469
1441
if conflicts != 0:
1475
1447
class cmd_info(Command):
1476
__doc__ = """Show information about a working tree, branch or repository.
1448
"""Show information about a working tree, branch or repository.
1478
1450
This command will show all known locations and formats associated to the
1479
1451
tree, branch or repository.
1573
1545
class cmd_file_id(Command):
1574
__doc__ = """Print file_id of a particular file or directory.
1546
"""Print file_id of a particular file or directory.
1576
1548
The file_id is assigned when the file is first added and remains the
1577
1549
same through all revisions where the file exists, even when it is
1595
1567
class cmd_file_path(Command):
1596
__doc__ = """Print path of file_ids to a file or directory.
1568
"""Print path of file_ids to a file or directory.
1598
1570
This prints one line for each directory down to the target,
1599
1571
starting at the branch root.
1661
1633
class cmd_ancestry(Command):
1662
__doc__ = """List all revisions merged into this branch."""
1634
"""List all revisions merged into this branch."""
1664
1636
_see_also = ['log', 'revision-history']
1665
1637
takes_args = ['location?']
1795
1767
class cmd_init_repository(Command):
1796
__doc__ = """Create a shared repository for branches to share storage space.
1768
"""Create a shared repository for branches to share storage space.
1798
1770
New branches created under the repository directory will store their
1799
1771
revisions in the repository, not in the branch directory. For branches
1855
1827
class cmd_diff(Command):
1856
__doc__ = """Show differences in the working tree, between revisions or branches.
1828
"""Show differences in the working tree, between revisions or branches.
1858
1830
If no arguments are given, all changes for the current tree are listed.
1859
1831
If files are given, only the changes in those files are listed.
1945
1917
help='Use this command to compare files.',
1948
RegistryOption('format',
1949
help='Diff format to use.',
1950
lazy_registry=('bzrlib.diff', 'format_registry'),
1951
value_switches=False, title='Diff format'),
1953
1921
aliases = ['di', 'dif']
1954
1922
encoding_type = 'exact'
1956
1924
@display_command
1957
1925
def run(self, revision=None, file_list=None, diff_options=None,
1958
prefix=None, old=None, new=None, using=None, format=None):
1959
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
1962
1929
if (prefix is None) or (prefix == '0'):
1963
1930
# diff -p0 format
1977
1944
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1978
1945
' one or two revision specifiers')
1980
if using is not None and format is not None:
1981
raise errors.BzrCommandError('--using and --format are mutually '
1984
1947
(old_tree, new_tree,
1985
1948
old_branch, new_branch,
1986
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
file_list, revision, old, new, self.add_cleanup, apply_view=True)
1949
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1950
file_list, revision, old, new, apply_view=True)
1988
1951
return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
1952
specific_files=specific_files,
1990
1953
external_diff_options=diff_options,
1991
1954
old_label=old_label, new_label=new_label,
1992
extra_trees=extra_trees, using=using,
1955
extra_trees=extra_trees, using=using)
1996
1958
class cmd_deleted(Command):
1997
__doc__ = """List files deleted in the working tree.
1959
"""List files deleted in the working tree.
1999
1961
# TODO: Show files deleted since a previous revision, or
2000
1962
# between two revisions.
2229
2191
:Tips & tricks:
2231
2193
GUI tools and IDEs are often better at exploring history than command
2232
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2233
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2234
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2235
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2194
line tools. You may prefer qlog or viz from the QBzr and Bzr-Gtk packages
2195
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2196
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2198
Web interfaces are often better at exploring history than command line
2199
tools, particularly for branches on servers. You may prefer Loggerhead
2200
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2237
2202
You may find it useful to add the aliases below to ``bazaar.conf``::
2299
2264
help='Show changes made in each revision as a patch.'),
2300
2265
Option('include-merges',
2301
2266
help='Show merged revisions like --levels 0 does.'),
2302
Option('exclude-common-ancestry',
2303
help='Display only the revisions that are not part'
2304
' of both ancestries (require -rX..Y)'
2307
2268
encoding_type = 'replace'
2320
2281
show_diff=False,
2321
include_merges=False,
2322
exclude_common_ancestry=False,
2282
include_merges=False):
2324
2283
from bzrlib.log import (
2326
2285
make_log_request_dict,
2327
2286
_get_info_for_log_files,
2329
2288
direction = (forward and 'forward') or 'reverse'
2330
if (exclude_common_ancestry
2331
and (revision is None or len(revision) != 2)):
2332
raise errors.BzrCommandError(
2333
'--exclude-common-ancestry requires -r with two revisions')
2334
2289
if include_merges:
2335
2290
if levels is None:
2429
2384
direction=direction, specific_fileids=file_ids,
2430
2385
start_revision=rev1, end_revision=rev2, limit=limit,
2431
2386
message_search=message, delta_type=delta_type,
2432
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2433
exclude_common_ancestry=exclude_common_ancestry,
2387
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2435
2388
Logger(b, rqst).show(lf)
2456
2409
raise errors.BzrCommandError(
2457
2410
"bzr %s doesn't accept two revisions in different"
2458
2411
" branches." % command_name)
2459
if start_spec.spec is None:
2460
# Avoid loading all the history.
2461
rev1 = RevisionInfo(branch, None, None)
2463
rev1 = start_spec.in_history(branch)
2412
rev1 = start_spec.in_history(branch)
2464
2413
# Avoid loading all of history when we know a missing
2465
2414
# end of range means the last revision ...
2466
2415
if end_spec.spec is None:
2661
2610
using this command or directly by using an editor, be sure to commit
2664
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2665
the global ignore file can be found in the application data directory as
2666
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2667
Global ignores are not touched by this command. The global ignore file
2668
can be edited directly using an editor.
2670
2613
Patterns prefixed with '!' are exceptions to ignore patterns and take
2671
2614
precedence over regular ignores. Such exceptions are used to specify
2672
2615
files that should be versioned which would otherwise be ignored.
2713
2656
_see_also = ['status', 'ignored', 'patterns']
2714
2657
takes_args = ['name_pattern*']
2715
2658
takes_options = [
2716
Option('default-rules',
2717
help='Display the default ignore rules that bzr uses.')
2659
Option('old-default-rules',
2660
help='Write out the ignore rules bzr < 0.9 always used.')
2720
def run(self, name_pattern_list=None, default_rules=None):
2663
def run(self, name_pattern_list=None, old_default_rules=None):
2721
2664
from bzrlib import ignores
2722
if default_rules is not None:
2723
# dump the default rules and exit
2724
for pattern in ignores.USER_DEFAULTS:
2725
self.outf.write("%s\n" % pattern)
2665
if old_default_rules is not None:
2666
# dump the rules and exit
2667
for pattern in ignores.OLD_DEFAULTS:
2727
2670
if not name_pattern_list:
2728
2671
raise errors.BzrCommandError("ignore requires at least one "
2729
"NAME_PATTERN or --default-rules.")
2672
"NAME_PATTERN or --old-default-rules")
2730
2673
name_pattern_list = [globbing.normalize_pattern(p)
2731
2674
for p in name_pattern_list]
2732
2675
for name_pattern in name_pattern_list:
2744
2687
if id is not None:
2745
2688
filename = entry[0]
2746
2689
if ignored.match(filename):
2747
matches.append(filename)
2690
matches.append(filename.encode('utf-8'))
2749
2692
if len(matches) > 0:
2750
self.outf.write("Warning: the following files are version controlled and"
2751
" match your ignore pattern:\n%s"
2752
"\nThese files will continue to be version controlled"
2753
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2693
print "Warning: the following files are version controlled and" \
2694
" match your ignore pattern:\n%s" \
2695
"\nThese files will continue to be version controlled" \
2696
" unless you 'bzr remove' them." % ("\n".join(matches),)
2756
2699
class cmd_ignored(Command):
2757
__doc__ = """List ignored files and the patterns that matched them.
2700
"""List ignored files and the patterns that matched them.
2759
2702
List all the ignored files and the ignore pattern that caused the file to
2795
2738
revno = int(revno)
2796
2739
except ValueError:
2797
raise errors.BzrCommandError("not a valid revision-number: %r"
2799
revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2800
self.outf.write("%s\n" % revid)
2740
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2742
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2803
2745
class cmd_export(Command):
2804
__doc__ = """Export current or past revision to a destination directory or archive.
2746
"""Export current or past revision to a destination directory or archive.
2806
2748
If no revision is specified this exports the last committed revision.
2841
2783
help="Name of the root directory inside the exported file."),
2842
Option('per-file-timestamps',
2843
help='Set modification time of files to that of the last '
2844
'revision in which it was changed.'),
2846
2785
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
root=None, filters=False, per_file_timestamps=False):
2786
root=None, filters=False):
2848
2787
from bzrlib.export import export
2850
2789
if branch_or_subdir is None:
2858
2797
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2860
export(rev_tree, dest, format, root, subdir, filtered=filters,
2861
per_file_timestamps=per_file_timestamps)
2799
export(rev_tree, dest, format, root, subdir, filtered=filters)
2862
2800
except errors.NoSuchExportFormat, e:
2863
2801
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2866
2804
class cmd_cat(Command):
2867
__doc__ = """Write the contents of a file as of a given revision to standard output.
2805
"""Write the contents of a file as of a given revision to standard output.
2869
2807
If no revision is nominated, the last revision is used.
2952
2890
class cmd_local_time_offset(Command):
2953
__doc__ = """Show the offset in seconds from GMT to local time."""
2891
"""Show the offset in seconds from GMT to local time."""
2955
2893
@display_command
2957
self.outf.write("%s\n" % osutils.local_time_offset())
2895
print osutils.local_time_offset()
2961
2899
class cmd_commit(Command):
2962
__doc__ = """Commit changes into a new revision.
2900
"""Commit changes into a new revision.
2964
2902
An explanatory message needs to be given for each commit. This is
2965
2903
often done by using the --message option (getting the message from the
3073
3011
"the master branch until a normal commit "
3074
3012
"is performed."
3076
Option('show-diff', short_name='p',
3077
3015
help='When no message is supplied, show the diff along'
3078
3016
' with the status summary in the message editor.'),
3159
3097
'(use --file "%(f)s" to take commit message from that file)'
3160
3098
% { 'f': message })
3161
3099
ui.ui_factory.show_warning(warning_msg)
3163
message = message.replace('\r\n', '\n')
3164
message = message.replace('\r', '\n')
3166
raise errors.BzrCommandError(
3167
"please specify either --message or --file")
3169
3101
def get_message(commit_obj):
3170
3102
"""Callback to get commit message"""
3172
my_message = codecs.open(
3173
file, 'rt', osutils.get_user_encoding()).read()
3174
elif message is not None:
3175
my_message = message
3177
# No message supplied: make one up.
3178
# text is the status of the tree
3179
text = make_commit_message_template_encoded(tree,
3103
my_message = message
3104
if my_message is not None and '\r' in my_message:
3105
my_message = my_message.replace('\r\n', '\n')
3106
my_message = my_message.replace('\r', '\n')
3107
if my_message is None and not file:
3108
t = make_commit_message_template_encoded(tree,
3180
3109
selected_list, diff=show_diff,
3181
3110
output_encoding=osutils.get_user_encoding())
3182
# start_message is the template generated from hooks
3183
# XXX: Warning - looks like hooks return unicode,
3184
# make_commit_message_template_encoded returns user encoding.
3185
# We probably want to be using edit_commit_message instead to
3187
3111
start_message = generate_commit_message_template(commit_obj)
3188
my_message = edit_commit_message_encoded(text,
3112
my_message = edit_commit_message_encoded(t,
3189
3113
start_message=start_message)
3190
3114
if my_message is None:
3191
3115
raise errors.BzrCommandError("please specify a commit"
3192
3116
" message with either --message or --file")
3117
elif my_message and file:
3118
raise errors.BzrCommandError(
3119
"please specify either --message or --file")
3121
my_message = codecs.open(file, 'rt',
3122
osutils.get_user_encoding()).read()
3193
3123
if my_message == "":
3194
3124
raise errors.BzrCommandError("empty commit message specified")
3195
3125
return my_message
3207
3137
timezone=offset,
3208
3138
exclude=safe_relpath_files(tree, exclude))
3209
3139
except PointlessCommit:
3140
# FIXME: This should really happen before the file is read in;
3141
# perhaps prepare the commit; get the message; then actually commit
3210
3142
raise errors.BzrCommandError("No changes to commit."
3211
3143
" Use --unchanged to commit anyhow.")
3212
3144
except ConflictsInTree:
3217
3149
raise errors.BzrCommandError("Commit refused because there are"
3218
3150
" unknown files in the working tree.")
3219
3151
except errors.BoundBranchOutOfDate, e:
3220
e.extra_help = ("\n"
3221
'To commit to master branch, run update and then commit.\n'
3222
'You can also pass --local to commit to continue working '
3152
raise errors.BzrCommandError(str(e) + "\n"
3153
'To commit to master branch, run update and then commit.\n'
3154
'You can also pass --local to commit to continue working '
3227
3158
class cmd_check(Command):
3228
__doc__ = """Validate working tree structure, branch consistency and repository history.
3159
"""Validate working tree structure, branch consistency and repository history.
3230
3161
This command checks various invariants about branch and repository storage
3231
3162
to detect data corruption or bzr bugs.
3390
3321
@display_command
3391
3322
def printme(self, branch):
3392
self.outf.write('%s\n' % branch.nick)
3395
3326
class cmd_alias(Command):
3396
__doc__ = """Set/unset and display aliases.
3327
"""Set/unset and display aliases.
3399
3330
Show the current aliases::
3465
3396
class cmd_selftest(Command):
3466
__doc__ = """Run internal test suite.
3397
"""Run internal test suite.
3468
3399
If arguments are given, they are regular expressions that say which tests
3469
3400
should run. Tests matching any expression are run, and other tests are
3513
3444
def get_transport_type(typestring):
3514
3445
"""Parse and return a transport specifier."""
3515
3446
if typestring == "sftp":
3516
from bzrlib.tests import stub_sftp
3517
return stub_sftp.SFTPAbsoluteServer
3447
from bzrlib.transport.sftp import SFTPAbsoluteServer
3448
return SFTPAbsoluteServer
3518
3449
if typestring == "memory":
3519
from bzrlib.tests import test_server
3520
return memory.MemoryServer
3450
from bzrlib.transport.memory import MemoryServer
3521
3452
if typestring == "fakenfs":
3522
from bzrlib.tests import test_server
3523
return test_server.FakeNFSServer
3453
from bzrlib.transport.fakenfs import FakeNFSServer
3454
return FakeNFSServer
3524
3455
msg = "No known transport type %s. Supported types are: sftp\n" %\
3526
3457
raise errors.BzrCommandError(msg)
3610
3541
raise errors.BzrCommandError("subunit not available. subunit "
3611
3542
"needs to be installed to use --subunit.")
3612
3543
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3613
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3614
# stdout, which would corrupt the subunit stream.
3615
if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3617
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3619
3545
self.additional_selftest_args.setdefault(
3620
3546
'suite_decorators', []).append(parallel)
3670
3596
class cmd_rocks(Command):
3671
__doc__ = """Statement of optimism."""
3597
"""Statement of optimism."""
3675
3601
@display_command
3677
self.outf.write("It sure does!\n")
3603
print "It sure does!"
3680
3606
class cmd_find_merge_base(Command):
3681
__doc__ = """Find and print a base revision for merging two branches."""
3607
"""Find and print a base revision for merging two branches."""
3682
3608
# TODO: Options to specify revisions on either side, as if
3683
3609
# merging only part of the history.
3684
3610
takes_args = ['branch', 'other']
3700
3626
graph = branch1.repository.get_graph(branch2.repository)
3701
3627
base_rev_id = graph.find_unique_lca(last1, last2)
3703
self.outf.write('merge base is revision %s\n' % base_rev_id)
3629
print 'merge base is revision %s' % base_rev_id
3706
3632
class cmd_merge(Command):
3707
__doc__ = """Perform a three-way merge.
3633
"""Perform a three-way merge.
3709
3635
The source of the merge can be specified either in the form of a branch,
3710
3636
or in the form of a path to a file containing a merge directive generated
3854
3780
raise errors.BzrCommandError(
3855
3781
'Cannot use -r with merge directives or bundles')
3856
3782
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3859
3785
if merger is None and uncommitted:
3860
3786
if revision is not None and len(revision) > 0:
3861
3787
raise errors.BzrCommandError('Cannot use --uncommitted and'
3862
3788
' --revision at the same time.')
3863
merger = self.get_merger_from_uncommitted(tree, location, None)
3789
merger = self.get_merger_from_uncommitted(tree, location, pb)
3864
3790
allow_pending = False
3866
3792
if merger is None:
3867
3793
merger, allow_pending = self._get_merger_from_branch(tree,
3868
location, revision, remember, possible_transports, None)
3794
location, revision, remember, possible_transports, pb)
3870
3796
merger.merge_type = merge_type
3871
3797
merger.reprocess = reprocess
4097
4023
def run(self, file_list=None, merge_type=None, show_base=False,
4098
4024
reprocess=False):
4099
from bzrlib.conflicts import restore
4100
4025
if merge_type is None:
4101
4026
merge_type = _mod_merge.Merge3Merger
4102
4027
tree, file_list = tree_files(file_list)
4143
4068
# list, we imply that the working tree text has seen and rejected
4144
4069
# all the changes from the other tree, when in fact those changes
4145
4070
# have not yet been seen.
4071
pb = ui.ui_factory.nested_progress_bar()
4146
4072
tree.set_parent_ids(parents[:1])
4148
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4074
merger = _mod_merge.Merger.from_revision_ids(pb,
4149
4076
merger.interesting_ids = interesting_ids
4150
4077
merger.merge_type = merge_type
4151
4078
merger.show_base = show_base
4162
4090
class cmd_revert(Command):
4163
__doc__ = """Revert files to a previous revision.
4091
"""Revert files to a previous revision.
4165
4093
Giving a list of files will revert only those files. Otherwise, all files
4166
4094
will be reverted. If the revision is not specified with '--revision', the
4217
4145
def run(self, revision=None, no_backup=False, file_list=None,
4218
4146
forget_merges=None):
4219
4147
tree, file_list = tree_files(file_list)
4220
tree.lock_tree_write()
4221
4149
self.add_cleanup(tree.unlock)
4222
4150
if forget_merges:
4223
4151
tree.set_parent_ids(tree.get_parent_ids()[:1])
4228
4156
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4229
4157
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4230
tree.revert(file_list, rev_tree, not no_backup, None,
4231
report_changes=True)
4158
pb = ui.ui_factory.nested_progress_bar()
4160
tree.revert(file_list, rev_tree, not no_backup, pb,
4161
report_changes=True)
4234
4166
class cmd_assert_fail(Command):
4235
__doc__ = """Test reporting of assertion failures"""
4167
"""Test reporting of assertion failures"""
4236
4168
# intended just for use in testing
4377
4306
remote_branch = Branch.open(other_branch)
4378
4307
if remote_branch.base == local_branch.base:
4379
4308
remote_branch = local_branch
4381
remote_branch.lock_read()
4382
self.add_cleanup(remote_branch.unlock)
4310
local_branch.lock_read()
4311
self.add_cleanup(local_branch.unlock)
4384
4312
local_revid_range = _revision_range_to_revid_range(
4385
4313
_get_revision_range(my_revision, local_branch,
4316
remote_branch.lock_read()
4317
self.add_cleanup(remote_branch.unlock)
4388
4318
remote_revid_range = _revision_range_to_revid_range(
4389
4319
_get_revision_range(revision,
4390
4320
remote_branch, self.name()))
4451
4381
class cmd_pack(Command):
4452
__doc__ = """Compress the data within a repository.
4454
This operation compresses the data within a bazaar repository. As
4455
bazaar supports automatic packing of repository, this operation is
4456
normally not required to be done manually.
4458
During the pack operation, bazaar takes a backup of existing repository
4459
data, i.e. pack files. This backup is eventually removed by bazaar
4460
automatically when it is safe to do so. To save disk space by removing
4461
the backed up pack files, the --clean-obsolete-packs option may be
4464
Warning: If you use --clean-obsolete-packs and your machine crashes
4465
during or immediately after repacking, you may be left with a state
4466
where the deletion has been written to disk but the new packs have not
4467
been. In this case the repository may be unusable.
4382
"""Compress the data within a repository."""
4470
4384
_see_also = ['repositories']
4471
4385
takes_args = ['branch_or_repo?']
4473
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4476
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4387
def run(self, branch_or_repo='.'):
4477
4388
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4479
4390
branch = dir.open_branch()
4480
4391
repository = branch.repository
4481
4392
except errors.NotBranchError:
4482
4393
repository = dir.open_repository()
4483
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4486
4397
class cmd_plugins(Command):
4487
__doc__ = """List the installed plugins.
4398
"""List the installed plugins.
4489
4400
This command displays the list of installed plugins including
4490
4401
version of plugin and a short description of each.
4497
4408
adding new commands, providing additional network transports and
4498
4409
customizing log output.
4500
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4501
for further information on plugins including where to find them and how to
4502
install them. Instructions are also provided there on how to write new
4503
plugins using the Python programming language.
4411
See the Bazaar web site, http://bazaar-vcs.org, for further
4412
information on plugins including where to find them and how to
4413
install them. Instructions are also provided there on how to
4414
write new plugins using the Python programming language.
4505
4416
takes_options = ['verbose']
4521
4432
doc = '(no description)'
4522
4433
result.append((name_ver, doc, plugin.path()))
4523
4434
for name_ver, doc, path in sorted(result):
4524
self.outf.write("%s\n" % name_ver)
4525
self.outf.write(" %s\n" % doc)
4527
self.outf.write(" %s\n" % path)
4528
self.outf.write("\n")
4531
4442
class cmd_testament(Command):
4532
__doc__ = """Show testament (signing-form) of a revision."""
4443
"""Show testament (signing-form) of a revision."""
4533
4444
takes_options = [
4535
4446
Option('long', help='Produce long-format testament.'),
4563
4474
class cmd_annotate(Command):
4564
__doc__ = """Show the origin of each line in a file.
4475
"""Show the origin of each line in a file.
4566
4477
This prints out the given file with an annotation on the left side
4567
4478
indicating which revision, author and date introduced the change.
4682
4593
class cmd_bind(Command):
4683
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4684
If no branch is supplied, rebind to the last bound location.
4594
"""Convert the current branch into a checkout of the supplied branch.
4686
4596
Once converted into a checkout, commits must succeed on the master branch
4687
4597
before they will be applied to the local branch.
4705
4615
'This format does not remember old locations.')
4707
4617
if location is None:
4708
if b.get_bound_location() is not None:
4709
raise errors.BzrCommandError('Branch is already bound')
4711
raise errors.BzrCommandError('No location supplied '
4712
'and no previous location known')
4618
raise errors.BzrCommandError('No location supplied and no '
4619
'previous location known')
4713
4620
b_other = Branch.open(location)
4715
4622
b.bind(b_other)
4723
4630
class cmd_unbind(Command):
4724
__doc__ = """Convert the current checkout into a regular branch.
4631
"""Convert the current checkout into a regular branch.
4726
4633
After unbinding, the local branch is considered independent and subsequent
4727
4634
commits will be local only.
4740
4647
class cmd_uncommit(Command):
4741
__doc__ = """Remove the last committed revision.
4648
"""Remove the last committed revision.
4743
4650
--verbose will print out what is being removed.
4744
4651
--dry-run will go through all the motions, but not actually
4827
4734
end_revision=last_revno)
4830
self.outf.write('Dry-run, pretending to remove'
4831
' the above revisions.\n')
4737
print 'Dry-run, pretending to remove the above revisions.'
4739
val = raw_input('Press <enter> to continue')
4833
self.outf.write('The above revision(s) will be removed.\n')
4836
if not ui.ui_factory.get_boolean('Are you sure'):
4837
self.outf.write('Canceled')
4741
print 'The above revision(s) will be removed.'
4743
val = raw_input('Are you sure [y/N]? ')
4744
if val.lower() not in ('y', 'yes'):
4840
4748
mutter('Uncommitting from {%s} to {%s}',
4841
4749
last_rev_id, rev_id)
4842
4750
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4843
4751
revno=revno, local=local)
4844
self.outf.write('You can restore the old tip by running:\n'
4845
' bzr pull . -r revid:%s\n' % last_rev_id)
4752
note('You can restore the old tip by running:\n'
4753
' bzr pull . -r revid:%s', last_rev_id)
4848
4756
class cmd_break_lock(Command):
4849
__doc__ = """Break a dead lock on a repository, branch or working directory.
4757
"""Break a dead lock on a repository, branch or working directory.
4851
4759
CAUTION: Locks should only be broken when you are sure that the process
4852
4760
holding the lock has been stopped.
4999
4907
class cmd_split(Command):
5000
__doc__ = """Split a subdirectory of a tree into a separate tree.
4908
"""Split a subdirectory of a tree into a separate tree.
5002
4910
This command will produce a target tree in a format that supports
5003
4911
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5025
4933
class cmd_merge_directive(Command):
5026
__doc__ = """Generate a merge directive for auto-merge tools.
4934
"""Generate a merge directive for auto-merge tools.
5028
4936
A directive requests a merge to be performed, and also provides all the
5029
4937
information necessary to do so. This means it must either include a
5314
5222
class cmd_tag(Command):
5315
__doc__ = """Create, remove or modify a tag naming a revision.
5223
"""Create, remove or modify a tag naming a revision.
5317
5225
Tags give human-meaningful names to revisions. Commands that take a -r
5318
5226
(--revision) option can be given -rtag:X, where X is any previously
5327
5235
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5328
5236
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5330
If no tag name is specified it will be determined through the
5331
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5332
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5336
5239
_see_also = ['commit', 'tags']
5337
takes_args = ['tag_name?']
5240
takes_args = ['tag_name']
5338
5241
takes_options = [
5339
5242
Option('delete',
5340
5243
help='Delete this tag rather than placing it.',
5373
5274
revision_id = revision[0].as_revision_id(branch)
5375
5276
revision_id = branch.last_revision()
5376
if tag_name is None:
5377
tag_name = branch.automatic_tag_name(revision_id)
5378
if tag_name is None:
5379
raise errors.BzrCommandError(
5380
"Please specify a tag name.")
5381
5277
if (not force) and branch.tags.has_tag(tag_name):
5382
5278
raise errors.TagAlreadyExists(tag_name)
5383
5279
branch.tags.set_tag(tag_name, revision_id)
5552
5448
class cmd_switch(Command):
5553
__doc__ = """Set the branch of a checkout and update.
5449
"""Set the branch of a checkout and update.
5555
5451
For lightweight checkouts, this changes the branch being referenced.
5556
5452
For heavyweight checkouts, this checks that there are no local commits
5819
5715
self.outf.write(" <no hooks installed>\n")
5822
class cmd_remove_branch(Command):
5823
__doc__ = """Remove a branch.
5825
This will remove the branch from the specified location but
5826
will keep any working tree or repository in place.
5830
Remove the branch at repo/trunk::
5832
bzr remove-branch repo/trunk
5836
takes_args = ["location?"]
5838
aliases = ["rmbranch"]
5840
def run(self, location=None):
5841
if location is None:
5843
branch = Branch.open_containing(location)[0]
5844
branch.bzrdir.destroy_branch()
5847
5718
class cmd_shelve(Command):
5848
__doc__ = """Temporarily set aside some changes from the current tree.
5719
"""Temporarily set aside some changes from the current tree.
5850
5721
Shelve allows you to temporarily put changes you've made "on the shelf",
5851
5722
ie. out of the way, until a later time when you can bring them back from
5922
5793
class cmd_unshelve(Command):
5923
__doc__ = """Restore shelved changes.
5794
"""Restore shelved changes.
5925
5796
By default, the most recently shelved changes are restored. However if you
5926
5797
specify a shelf by id those changes will be restored instead. This works
5954
5825
class cmd_clean_tree(Command):
5955
__doc__ = """Remove unwanted files from working tree.
5826
"""Remove unwanted files from working tree.
5957
5828
By default, only unknown files, not ignored files, are deleted. Versioned
5958
5829
files are never deleted.
5988
5859
class cmd_reference(Command):
5989
__doc__ = """list, view and set branch locations for nested trees.
5860
"""list, view and set branch locations for nested trees.
5991
5862
If no arguments are provided, lists the branch locations for nested trees.
5992
5863
If one argument is provided, display the branch location for that tree.
6032
5903
self.outf.write('%s %s\n' % (path, location))
6035
def _register_lazy_builtins():
6036
# register lazy builtins from other modules; called at startup and should
6037
# be only called once.
6038
for (name, aliases, module_name) in [
6039
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6040
('cmd_dpush', [], 'bzrlib.foreign'),
6041
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6042
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6043
('cmd_conflicts', [], 'bzrlib.conflicts'),
6044
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6046
builtin_command_registry.register_lazy(name, aliases, module_name)
5906
# these get imported and then picked up by the scan for cmd_*
5907
# TODO: Some more consistent way to split command definitions across files;
5908
# we do need to load at least some information about them to know of
5909
# aliases. ideally we would avoid loading the implementation until the
5910
# details were needed.
5911
from bzrlib.cmd_version_info import cmd_version_info
5912
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5913
from bzrlib.bundle.commands import (
5916
from bzrlib.foreign import cmd_dpush
5917
from bzrlib.sign_my_commits import cmd_sign_my_commits
5918
from bzrlib.weave_commands import cmd_versionedfile_list, \
5919
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
