250
250
To skip the display of pending merge information altogether, use
251
251
the no-pending option or specify a file/directory.
253
To compare the working directory to a specific revision, pass a
254
single revision to the revision argument.
256
To see which files have changed in a specific revision, or between
257
two revisions, pass a revision range to the revision argument.
258
This will produce the same results as calling 'bzr diff --summarize'.
253
If a revision argument is given, the status is calculated against
254
that revision, or between two revisions if two are provided.
261
257
# TODO: --no-recurse, --recurse options
485
477
d.destroy_workingtree()
488
class cmd_repair_workingtree(Command):
489
__doc__ = """Reset the working tree state file.
491
This is not meant to be used normally, but more as a way to recover from
492
filesystem corruption, etc. This rebuilds the working inventory back to a
493
'known good' state. Any new modifications (adding a file, renaming, etc)
494
will be lost, though modified files will still be detected as such.
496
Most users will want something more like "bzr revert" or "bzr update"
497
unless the state file has become corrupted.
499
By default this attempts to recover the current state by looking at the
500
headers of the state file. If the state file is too corrupted to even do
501
that, you can supply --revision to force the state of the tree.
504
takes_options = ['revision', 'directory',
506
help='Reset the tree even if it doesn\'t appear to be'
511
def run(self, revision=None, directory='.', force=False):
512
tree, _ = WorkingTree.open_containing(directory)
513
self.add_cleanup(tree.lock_tree_write().unlock)
517
except errors.BzrError:
518
pass # There seems to be a real error here, so we'll reset
521
raise errors.BzrCommandError(
522
'The tree does not appear to be corrupt. You probably'
523
' want "bzr revert" instead. Use "--force" if you are'
524
' sure you want to reset the working tree.')
528
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
530
tree.reset_state(revision_ids)
531
except errors.BzrError, e:
532
if revision_ids is None:
533
extra = (', the header appears corrupt, try passing -r -1'
534
' to set the state to the last commit')
537
raise errors.BzrCommandError('failed to reset the tree state'
541
480
class cmd_revno(Command):
542
481
__doc__ = """Show current revision number.
984
923
"branch. Local pulls are not applied to "
985
924
"the master branch."
988
help="Show base revision text in conflicts.")
990
927
takes_args = ['location?']
991
928
encoding_type = 'replace'
993
930
def run(self, location=None, remember=False, overwrite=False,
994
931
revision=None, verbose=False,
995
directory=None, local=False,
932
directory=None, local=False):
997
933
# FIXME: too much stuff is in the command class
998
934
revision_id = None
1138
1063
def run(self, location=None, remember=False, overwrite=False,
1139
1064
create_prefix=False, verbose=False, revision=None,
1140
1065
use_existing_dir=False, directory=None, stacked_on=None,
1141
stacked=False, strict=None, no_tree=False):
1066
stacked=False, strict=None):
1142
1067
from bzrlib.push import _show_push_branch
1144
1069
if directory is None:
1190
1115
_show_push_branch(br_from, revision_id, location, self.outf,
1191
1116
verbose=verbose, overwrite=overwrite, remember=remember,
1192
1117
stacked_on=stacked_on, create_prefix=create_prefix,
1193
use_existing_dir=use_existing_dir, no_tree=no_tree)
1118
use_existing_dir=use_existing_dir)
1196
1121
class cmd_branch(Command):
1242
1165
files_from=None):
1243
1166
from bzrlib import switch as _mod_switch
1244
1167
from bzrlib.tag import _merge_tags_if_possible
1245
if self.invoked_as in ['get', 'clone']:
1246
ui.ui_factory.show_user_warning(
1247
'deprecated_command',
1248
deprecated_name=self.invoked_as,
1249
recommended_name='branch',
1250
deprecated_in_version='2.4')
1251
1168
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1253
1170
if not (hardlink or files_from):
1437
1354
If you want to discard your local changes, you can just do a
1438
1355
'bzr revert' instead of 'bzr commit' after the update.
1440
If you want to restore a file that has been removed locally, use
1441
'bzr revert' instead of 'bzr update'.
1443
1357
If the tree's branch is bound to a master branch, it will also update
1444
1358
the branch from the master.
1447
1361
_see_also = ['pull', 'working-trees', 'status-flags']
1448
1362
takes_args = ['dir?']
1449
takes_options = ['revision',
1451
help="Show base revision text in conflicts."),
1363
takes_options = ['revision']
1453
1364
aliases = ['up']
1455
def run(self, dir='.', revision=None, show_base=None):
1366
def run(self, dir='.', revision=None):
1456
1367
if revision is not None and len(revision) != 1:
1457
1368
raise errors.BzrCommandError(
1458
1369
"bzr update --revision takes exactly one revision")
1581
1491
title='Deletion Strategy', value_switches=True, enum_switch=False,
1582
1492
safe='Backup changed files (default).',
1583
1493
keep='Delete from bzr but leave the working copy.',
1584
no_backup='Don\'t backup changed files.',
1585
1494
force='Delete all the specified files, even if they can not be '
1586
'recovered and even if they are non-empty directories. '
1587
'(deprecated, use no-backup)')]
1495
'recovered and even if they are non-empty directories.')]
1588
1496
aliases = ['rm', 'del']
1589
1497
encoding_type = 'replace'
1591
1499
def run(self, file_list, verbose=False, new=False,
1592
1500
file_deletion_strategy='safe'):
1593
if file_deletion_strategy == 'force':
1594
note("(The --force option is deprecated, rather use --no-backup "
1596
file_deletion_strategy = 'no-backup'
1598
1501
tree, file_list = WorkingTree.open_containing_paths(file_list)
1600
1503
if file_list is not None:
1783
1686
Option('append-revisions-only',
1784
1687
help='Never change revnos or the existing log.'
1785
' Append revisions to it only.'),
1787
'Create a branch without a working tree.')
1688
' Append revisions to it only.')
1789
1690
def run(self, location=None, format=None, append_revisions_only=False,
1790
create_prefix=False, no_tree=False):
1691
create_prefix=False):
1791
1692
if format is None:
1792
1693
format = bzrdir.format_registry.make_bzrdir('default')
1793
1694
if location is None:
3114
2984
to trigger updates to external systems like bug trackers. The --fixes
3115
2985
option can be used to record the association between a revision and
3116
2986
one or more bugs. See ``bzr help bugs`` for details.
2988
A selective commit may fail in some cases where the committed
2989
tree would be invalid. Consider::
2994
bzr commit foo -m "committing foo"
2995
bzr mv foo/bar foo/baz
2998
bzr commit foo/bar -m "committing bar but not baz"
3000
In the example above, the last commit will fail by design. This gives
3001
the user the opportunity to decide whether they want to commit the
3002
rename at the same time, separately first, or not at all. (As a general
3003
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3005
# TODO: Run hooks on tree to-be-committed, and after commit.
3007
# TODO: Strict commit that fails if there are deleted files.
3008
# (what does "deleted files" mean ??)
3010
# TODO: Give better message for -s, --summary, used by tla people
3012
# XXX: verbose currently does nothing
3119
3014
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3120
3015
takes_args = ['selected*']
3181
3072
def run(self, message=None, file=None, verbose=False, selected_list=None,
3182
3073
unchanged=False, strict=False, local=False, fixes=None,
3183
author=None, show_diff=False, exclude=None, commit_time=None,
3074
author=None, show_diff=False, exclude=None, commit_time=None):
3185
3075
from bzrlib.errors import (
3186
3076
PointlessCommit,
3187
3077
ConflictsInTree,
3283
3179
reporter=None, verbose=verbose, revprops=properties,
3284
3180
authors=author, timestamp=commit_stamp,
3285
3181
timezone=offset,
3286
exclude=tree.safe_relpath_files(exclude),
3182
exclude=tree.safe_relpath_files(exclude))
3288
3183
except PointlessCommit:
3289
3184
raise errors.BzrCommandError("No changes to commit."
3290
" Please 'bzr add' the files you want to commit, or use"
3291
" --unchanged to force an empty commit.")
3185
" Use --unchanged to commit anyhow.")
3292
3186
except ConflictsInTree:
3293
3187
raise errors.BzrCommandError('Conflicts detected in working '
3294
3188
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3377
3271
class cmd_upgrade(Command):
3378
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3380
When the default format has changed after a major new release of
3381
Bazaar, you may be informed during certain operations that you
3382
should upgrade. Upgrading to a newer format may improve performance
3383
or make new features available. It may however limit interoperability
3384
with older repositories or with older versions of Bazaar.
3386
If you wish to upgrade to a particular format rather than the
3387
current default, that can be specified using the --format option.
3388
As a consequence, you can use the upgrade command this way to
3389
"downgrade" to an earlier format, though some conversions are
3390
a one way process (e.g. changing from the 1.x default to the
3391
2.x default) so downgrading is not always possible.
3393
A backup.bzr.~#~ directory is created at the start of the conversion
3394
process (where # is a number). By default, this is left there on
3395
completion. If the conversion fails, delete the new .bzr directory
3396
and rename this one back in its place. Use the --clean option to ask
3397
for the backup.bzr directory to be removed on successful conversion.
3398
Alternatively, you can delete it by hand if everything looks good
3401
If the location given is a shared repository, dependent branches
3402
are also converted provided the repository converts successfully.
3403
If the conversion of a branch fails, remaining branches are still
3406
For more information on upgrades, see the Bazaar Upgrade Guide,
3407
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3272
__doc__ = """Upgrade branch storage to current format.
3274
The check command or bzr developers may sometimes advise you to run
3275
this command. When the default format has changed you may also be warned
3276
during other operations to upgrade.
3410
_see_also = ['check', 'reconcile', 'formats']
3279
_see_also = ['check']
3411
3280
takes_args = ['url?']
3412
3281
takes_options = [
3413
RegistryOption('format',
3414
help='Upgrade to a specific format. See "bzr help'
3415
' formats" for details.',
3416
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3417
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3418
value_switches=True, title='Branch format'),
3420
help='Remove the backup.bzr directory if successful.'),
3422
help="Show what would be done, but don't actually do anything."),
3282
RegistryOption('format',
3283
help='Upgrade to a specific format. See "bzr help'
3284
' formats" for details.',
3285
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3286
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3287
value_switches=True, title='Branch format'),
3425
def run(self, url='.', format=None, clean=False, dry_run=False):
3290
def run(self, url='.', format=None):
3426
3291
from bzrlib.upgrade import upgrade
3427
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3429
if len(exceptions) == 1:
3430
# Compatibility with historical behavior
3292
upgrade(url, format)
3436
3295
class cmd_whoami(Command):
3835
3690
with bzr send. If neither is specified, the default is the upstream branch
3836
3691
or the branch most recently merged using --remember.
3838
When merging from a branch, by default bzr will try to merge in all new
3839
work from the other branch, automatically determining an appropriate base
3840
revision. If this fails, you may need to give an explicit base.
3842
To pick a different ending revision, pass "--revision OTHER". bzr will
3843
try to merge in all new work up to and including revision OTHER.
3845
If you specify two values, "--revision BASE..OTHER", only revisions BASE
3846
through OTHER, excluding BASE but including OTHER, will be merged. If this
3847
causes some revisions to be skipped, i.e. if the destination branch does
3848
not already contain revision BASE, such a merge is commonly referred to as
3851
Revision numbers are always relative to the source branch.
3693
When merging a branch, by default the tip will be merged. To pick a different
3694
revision, pass --revision. If you specify two values, the first will be used as
3695
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3696
available revisions, like this is commonly referred to as "cherrypicking".
3698
Revision numbers are always relative to the branch being merged.
3700
By default, bzr will try to merge in all new work from the other
3701
branch, automatically determining an appropriate base. If this
3702
fails, you may need to give an explicit base.
3853
3704
Merge will do its best to combine the changes in two branches, but there
3854
3705
are some kinds of problems only a human can fix. When it encounters those,
4118
3969
if ((remember or tree.branch.get_submit_branch() is None) and
4119
3970
user_location is not None):
4120
3971
tree.branch.set_submit_branch(other_branch.base)
4121
# Merge tags (but don't set them in the master branch yet, the user
4122
# might revert this merge). Commit will propagate them.
4123
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
3972
_merge_tags_if_possible(other_branch, tree.branch)
4124
3973
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4125
3974
other_revision_id, base_revision_id, other_branch, base_branch)
4126
3975
if other_path != '':
4294
4143
last committed revision is used.
4296
4145
To remove only some changes, without reverting to a prior version, use
4297
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4298
will remove the changes introduced by the second last commit (-2), without
4299
affecting the changes introduced by the last commit (-1). To remove
4300
certain changes on a hunk-by-hunk basis, see the shelve command.
4146
merge instead. For example, "merge . --revision -2..-3" will remove the
4147
changes introduced by -2, without affecting the changes introduced by -1.
4148
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4302
4150
By default, any files that have been manually changed will be backed up
4303
4151
first. (Files changed only by merge are not backed up.) Backup files have
4633
4481
@display_command
4634
4482
def run(self, verbose=False):
4635
from bzrlib import plugin
4636
self.outf.writelines(
4637
plugin.describe_plugins(show_paths=verbose))
4483
import bzrlib.plugin
4484
from inspect import getdoc
4486
for name, plugin in bzrlib.plugin.plugins().items():
4487
version = plugin.__version__
4488
if version == 'unknown':
4490
name_ver = '%s %s' % (name, version)
4491
d = getdoc(plugin.module)
4493
doc = d.split('\n')[0]
4495
doc = '(no description)'
4496
result.append((name_ver, doc, plugin.path()))
4497
for name_ver, doc, path in sorted(result):
4498
self.outf.write("%s\n" % name_ver)
4499
self.outf.write(" %s\n" % doc)
4501
self.outf.write(" %s\n" % path)
4502
self.outf.write("\n")
4640
4505
class cmd_testament(Command):
4704
4567
self.add_cleanup(branch.lock_read().unlock)
4705
4568
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4706
4569
self.add_cleanup(tree.lock_read().unlock)
4707
if wt is not None and revision is None:
4708
4571
file_id = wt.path2id(relpath)
4710
4573
file_id = tree.path2id(relpath)
4711
4574
if file_id is None:
4712
4575
raise errors.NotVersionedError(filename)
4576
file_version = tree.inventory[file_id].revision
4713
4577
if wt is not None and revision is None:
4714
4578
# If there is a tree and we're not annotating historical
4715
4579
# versions, annotate the working tree's content.
4716
4580
annotate_file_tree(wt, file_id, self.outf, long, all,
4717
4581
show_ids=show_ids)
4719
annotate_file_tree(tree, file_id, self.outf, long, all,
4720
show_ids=show_ids, branch=branch)
4583
annotate_file(branch, file_version, file_id, long, all, self.outf,
4723
4587
class cmd_re_sign(Command):
4974
4838
takes_options = [
4975
4839
Option('config',
4976
4840
help='LOCATION is the directory where the config lock is.'),
4978
help='Do not ask for confirmation before breaking the lock.'),
4981
def run(self, location=None, config=False, force=False):
4843
def run(self, location=None, config=False):
4982
4844
if location is None:
4983
4845
location = u'.'
4985
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
4987
{'bzrlib.lockdir.break': True})
4989
4847
conf = _mod_config.LockableConfig(file_name=location)
4990
4848
conf.break_lock()
5517
5375
takes_options = [
5518
5376
custom_help('directory',
5519
5377
help='Branch whose tags should be displayed.'),
5520
RegistryOption('sort',
5378
RegistryOption.from_kwargs('sort',
5521
5379
'Sort tags by different criteria.', title='Sorting',
5522
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5380
alpha='Sort tags lexicographically (default).',
5381
time='Sort tags chronologically.',
5528
5387
@display_command
5529
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5530
from bzrlib.tag import tag_sort_methods
5531
5394
branch, relpath = Branch.open_containing(directory)
5533
5396
tags = branch.tags.get_tag_dict().items()
5542
5405
# only show revisions between revid1 and revid2 (inclusive)
5543
5406
tags = [(tag, revid) for tag, revid in tags if
5544
5407
graph.is_between(revid, revid1, revid2)]
5546
sort = tag_sort_methods.get()
5410
elif sort == 'time':
5412
for tag, revid in tags:
5414
revobj = branch.repository.get_revision(revid)
5415
except errors.NoSuchRevision:
5416
timestamp = sys.maxint # place them at the end
5418
timestamp = revobj.timestamp
5419
timestamps[revid] = timestamp
5420
tags.sort(key=lambda x: timestamps[x[1]])
5548
5421
if not show_ids:
5549
5422
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5550
5423
for index, (tag, revid) in enumerate(tags):
5974
5847
You can put multiple items on the shelf, and by default, 'unshelve' will
5975
5848
restore the most recently shelved changes.
5977
For complicated changes, it is possible to edit the changes in a separate
5978
editor program to decide what the file remaining in the working copy
5979
should look like. To do this, add the configuration option
5981
change_editor = PROGRAM @new_path @old_path
5983
where @new_path is replaced with the path of the new version of the
5984
file and @old_path is replaced with the path of the old version of
5985
the file. The PROGRAM should save the new file with the desired
5986
contents of the file in the working tree.
5990
5851
takes_args = ['file*']
6002
5863
Option('destroy',
6003
5864
help='Destroy removed changes instead of shelving them.'),
6005
_see_also = ['unshelve', 'configuration']
5866
_see_also = ['unshelve']
6007
5868
def run(self, revision=None, all=False, file_list=None, message=None,
6008
writer=None, list=False, destroy=False, directory=None):
5869
writer=None, list=False, destroy=False, directory=u'.'):
6010
return self.run_for_list(directory=directory)
5871
return self.run_for_list()
6011
5872
from bzrlib.shelf_ui import Shelver
6012
5873
if writer is None:
6013
5874
writer = bzrlib.option.diff_writer_registry.get()
6090
5949
takes_options = ['directory',
6091
5950
Option('ignored', help='Delete all ignored files.'),
6092
Option('detritus', help='Delete conflict files, merge and revert'
5951
Option('detritus', help='Delete conflict files, merge'
6093
5952
' backups, and failed selftest dirs.'),
6094
5953
Option('unknown',
6095
5954
help='Delete files unknown to bzr (default).'),
6154
6013
self.outf.write('%s %s\n' % (path, location))
6157
class cmd_export_pot(Command):
6158
__doc__ = """Export command helps and error messages in po format."""
6163
from bzrlib.export_pot import export_pot
6164
export_pot(self.outf)
6167
6016
def _register_lazy_builtins():
6168
6017
# register lazy builtins from other modules; called at startup and should
6169
6018
# be only called once.
6170
6019
for (name, aliases, module_name) in [
6171
6020
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6172
('cmd_config', [], 'bzrlib.config'),
6173
6021
('cmd_dpush', [], 'bzrlib.foreign'),
6174
6022
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6175
6023
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6176
6024
('cmd_conflicts', [], 'bzrlib.conflicts'),
6177
6025
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6178
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6180
6027
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
