239
239
# opens the branch?)
241
241
class cmd_status(Command):
242
__doc__ = """Display status summary.
242
"""Display status summary.
244
244
This reports on versioned and unknown files, reporting them
245
245
grouped by state. Possible states are:
334
334
class cmd_cat_revision(Command):
335
__doc__ = """Write out metadata for a revision.
335
"""Write out metadata for a revision.
337
337
The revision to print can either be specified by a specific
338
338
revision identifier, or you can use --revision.
392
392
class cmd_dump_btree(Command):
393
__doc__ = """Dump the contents of a btree index file to stdout.
393
"""Dump the contents of a btree index file to stdout.
395
395
PATH is a btree index file, it can be any URL. This includes things like
396
396
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
473
473
class cmd_remove_tree(Command):
474
__doc__ = """Remove the working tree from a given branch/checkout.
474
"""Remove the working tree from a given branch/checkout.
476
476
Since a lightweight checkout is little more than a working tree
477
477
this will refuse to run against one.
504
504
if (working.has_changes()):
505
505
raise errors.UncommittedChanges(working)
507
if working.user_url != working.branch.user_url:
507
working_path = working.bzrdir.root_transport.base
508
branch_path = working.branch.bzrdir.root_transport.base
509
if working_path != branch_path:
508
510
raise errors.BzrCommandError("You cannot remove the working tree"
509
511
" from a lightweight checkout")
550
552
class cmd_revision_info(Command):
551
__doc__ = """Show revision number and revision id for a given revision identifier.
553
"""Show revision number and revision id for a given revision identifier.
554
556
takes_args = ['revision_info*']
612
614
class cmd_add(Command):
613
__doc__ = """Add specified files or directories.
615
"""Add specified files or directories.
615
617
In non-recursive mode, all the named items are added, regardless
616
618
of whether they were previously ignored. A warning is given if
735
737
class cmd_inventory(Command):
736
__doc__ = """Show inventory of the current working copy or a revision.
738
"""Show inventory of the current working copy or a revision.
738
740
It is possible to limit the output to a particular entry
739
741
type using the --kind option. For example: --kind file.
933
935
class cmd_pull(Command):
934
__doc__ = """Turn this branch into a mirror of another branch.
936
"""Turn this branch into a mirror of another branch.
936
938
By default, this command only works on branches that have not diverged.
937
939
Branches are considered diverged if the destination branch's most recent
1060
1062
class cmd_push(Command):
1061
__doc__ = """Update a mirror of this branch.
1063
"""Update a mirror of this branch.
1063
1065
The target branch will not have its working tree populated because this
1064
1066
is both expensive, and is not supported on remote file systems.
1133
1135
revision_id = None
1134
1136
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.')
1137
tree.warn_if_changed_or_out_of_date(
1138
strict, 'push_strict', 'Use --no-strict to force the push.')
1139
1139
# Get the stacked_on branch, if any
1140
1140
if stacked_on is not None:
1141
1141
stacked_on = urlutils.normalize_url(stacked_on)
1175
1175
class cmd_branch(Command):
1176
__doc__ = """Create a new branch that is a copy of an existing branch.
1176
"""Create a new branch that is a copy of an existing branch.
1178
1178
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1179
1179
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1288
1288
class cmd_checkout(Command):
1289
__doc__ = """Create a new checkout of an existing branch.
1289
"""Create a new checkout of an existing branch.
1291
1291
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1292
1292
the branch found in '.'. This is useful if you have removed the working tree
1389
1389
class cmd_update(Command):
1390
__doc__ = """Update a tree to have the latest code committed to its branch.
1390
"""Update a tree to have the latest code committed to its branch.
1392
1392
This will perform a merge into the working tree, and may generate
1393
1393
conflicts. If you have any local changes, you will still
1475
1475
class cmd_info(Command):
1476
__doc__ = """Show information about a working tree, branch or repository.
1476
"""Show information about a working tree, branch or repository.
1478
1478
This command will show all known locations and formats associated to the
1479
1479
tree, branch or repository.
1519
1519
class cmd_remove(Command):
1520
__doc__ = """Remove files or directories.
1520
"""Remove files or directories.
1522
1522
This makes bzr stop tracking changes to the specified files. bzr will delete
1523
1523
them if they can easily be recovered using revert. If no options or
1573
1573
class cmd_file_id(Command):
1574
__doc__ = """Print file_id of a particular file or directory.
1574
"""Print file_id of a particular file or directory.
1576
1576
The file_id is assigned when the file is first added and remains the
1577
1577
same through all revisions where the file exists, even when it is
1595
1595
class cmd_file_path(Command):
1596
__doc__ = """Print path of file_ids to a file or directory.
1596
"""Print path of file_ids to a file or directory.
1598
1598
This prints one line for each directory down to the target,
1599
1599
starting at the branch root.
1617
1617
class cmd_reconcile(Command):
1618
__doc__ = """Reconcile bzr metadata in a branch.
1618
"""Reconcile bzr metadata in a branch.
1620
1620
This can correct data mismatches that may have been caused by
1621
1621
previous ghost operations or bzr upgrades. You should only
1661
1661
class cmd_ancestry(Command):
1662
__doc__ = """List all revisions merged into this branch."""
1662
"""List all revisions merged into this branch."""
1664
1664
_see_also = ['log', 'revision-history']
1665
1665
takes_args = ['location?']
1795
1795
class cmd_init_repository(Command):
1796
__doc__ = """Create a shared repository for branches to share storage space.
1796
"""Create a shared repository for branches to share storage space.
1798
1798
New branches created under the repository directory will store their
1799
1799
revisions in the repository, not in the branch directory. For branches
1855
1855
class cmd_diff(Command):
1856
__doc__ = """Show differences in the working tree, between revisions or branches.
1856
"""Show differences in the working tree, between revisions or branches.
1858
1858
If no arguments are given, all changes for the current tree are listed.
1859
1859
If files are given, only the changes in those files are listed.
1996
1996
class cmd_deleted(Command):
1997
__doc__ = """List files deleted in the working tree.
1997
"""List files deleted in the working tree.
1999
1999
# TODO: Show files deleted since a previous revision, or
2000
2000
# between two revisions.
2114
2114
class cmd_log(Command):
2115
__doc__ = """Show historical log for a branch or subset of a branch.
2115
"""Show historical log for a branch or subset of a branch.
2117
2117
log is bzr's default tool for exploring the history of a branch.
2118
2118
The branch to use is taken from the first parameter. If no parameters
2299
2299
help='Show changes made in each revision as a patch.'),
2300
2300
Option('include-merges',
2301
2301
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
2303
encoding_type = 'replace'
2320
2316
show_diff=False,
2321
include_merges=False,
2322
exclude_common_ancestry=False,
2317
include_merges=False):
2324
2318
from bzrlib.log import (
2326
2320
make_log_request_dict,
2327
2321
_get_info_for_log_files,
2329
2323
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
2324
if include_merges:
2335
2325
if levels is None:
2429
2419
direction=direction, specific_fileids=file_ids,
2430
2420
start_revision=rev1, end_revision=rev2, limit=limit,
2431
2421
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,
2422
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2435
2423
Logger(b, rqst).show(lf)
2497
2485
class cmd_touching_revisions(Command):
2498
__doc__ = """Return revision-ids which affected a particular file.
2486
"""Return revision-ids which affected a particular file.
2500
2488
A more user-friendly interface is "bzr log FILE".
2661
2649
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
2652
Patterns prefixed with '!' are exceptions to ignore patterns and take
2671
2653
precedence over regular ignores. Such exceptions are used to specify
2672
2654
files that should be versioned which would otherwise be ignored.
2713
2695
_see_also = ['status', 'ignored', 'patterns']
2714
2696
takes_args = ['name_pattern*']
2715
2697
takes_options = [
2716
Option('default-rules',
2717
help='Display the default ignore rules that bzr uses.')
2698
Option('old-default-rules',
2699
help='Write out the ignore rules bzr < 0.9 always used.')
2720
def run(self, name_pattern_list=None, default_rules=None):
2702
def run(self, name_pattern_list=None, old_default_rules=None):
2721
2703
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:
2704
if old_default_rules is not None:
2705
# dump the rules and exit
2706
for pattern in ignores.OLD_DEFAULTS:
2725
2707
self.outf.write("%s\n" % pattern)
2727
2709
if not name_pattern_list:
2728
2710
raise errors.BzrCommandError("ignore requires at least one "
2729
"NAME_PATTERN or --default-rules.")
2711
"NAME_PATTERN or --old-default-rules")
2730
2712
name_pattern_list = [globbing.normalize_pattern(p)
2731
2713
for p in name_pattern_list]
2732
2714
for name_pattern in name_pattern_list:
2756
2738
class cmd_ignored(Command):
2757
__doc__ = """List ignored files and the patterns that matched them.
2739
"""List ignored files and the patterns that matched them.
2759
2741
List all the ignored files and the ignore pattern that caused the file to
2803
2785
class cmd_export(Command):
2804
__doc__ = """Export current or past revision to a destination directory or archive.
2786
"""Export current or past revision to a destination directory or archive.
2806
2788
If no revision is specified this exports the last committed revision.
2961
2943
class cmd_commit(Command):
2962
__doc__ = """Commit changes into a new revision.
2944
"""Commit changes into a new revision.
2964
2946
An explanatory message needs to be given for each commit. This is
2965
2947
often done by using the --message option (getting the message from the
3073
3055
"the master branch until a normal commit "
3074
3056
"is performed."
3076
Option('show-diff', short_name='p',
3077
3059
help='When no message is supplied, show the diff along'
3078
3060
' with the status summary in the message editor.'),
3227
3209
class cmd_check(Command):
3228
__doc__ = """Validate working tree structure, branch consistency and repository history.
3210
"""Validate working tree structure, branch consistency and repository history.
3230
3212
This command checks various invariants about branch and repository storage
3231
3213
to detect data corruption or bzr bugs.
3297
3279
class cmd_upgrade(Command):
3298
__doc__ = """Upgrade branch storage to current format.
3280
"""Upgrade branch storage to current format.
3300
3282
The check command or bzr developers may sometimes advise you to run
3301
3283
this command. When the default format has changed you may also be warned
3371
3353
class cmd_nick(Command):
3372
__doc__ = """Print or set the branch nickname.
3354
"""Print or set the branch nickname.
3374
3356
If unset, the tree root directory name is used as the nickname.
3375
3357
To print the current nickname, execute with no argument.
3465
3447
class cmd_selftest(Command):
3466
__doc__ = """Run internal test suite.
3448
"""Run internal test suite.
3468
3450
If arguments are given, they are regular expressions that say which tests
3469
3451
should run. Tests matching any expression are run, and other tests are
3610
3592
raise errors.BzrCommandError("subunit not available. subunit "
3611
3593
"needs to be installed to use --subunit.")
3612
3594
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
3596
self.additional_selftest_args.setdefault(
3620
3597
'suite_decorators', []).append(parallel)
3680
3657
class cmd_find_merge_base(Command):
3681
__doc__ = """Find and print a base revision for merging two branches."""
3658
"""Find and print a base revision for merging two branches."""
3682
3659
# TODO: Options to specify revisions on either side, as if
3683
3660
# merging only part of the history.
3684
3661
takes_args = ['branch', 'other']
3706
3683
class cmd_merge(Command):
3707
__doc__ = """Perform a three-way merge.
3684
"""Perform a three-way merge.
3709
3686
The source of the merge can be specified either in the form of a branch,
3710
3687
or in the form of a path to a file containing a merge directive generated
4067
4044
class cmd_remerge(Command):
4068
__doc__ = """Redo a merge.
4070
4047
Use this if you want to try a different merge technique while resolving
4071
4048
conflicts. Some merge techniques are better than others, and remerge
4162
4139
class cmd_revert(Command):
4163
__doc__ = """Revert files to a previous revision.
4140
"""Revert files to a previous revision.
4165
4142
Giving a list of files will revert only those files. Otherwise, all files
4166
4143
will be reverted. If the revision is not specified with '--revision', the
4217
4194
def run(self, revision=None, no_backup=False, file_list=None,
4218
4195
forget_merges=None):
4219
4196
tree, file_list = tree_files(file_list)
4220
tree.lock_tree_write()
4221
4198
self.add_cleanup(tree.unlock)
4222
4199
if forget_merges:
4223
4200
tree.set_parent_ids(tree.get_parent_ids()[:1])
4263
4240
class cmd_shell_complete(Command):
4264
__doc__ = """Show appropriate completions for context.
4241
"""Show appropriate completions for context.
4266
4243
For a list of all available commands, say 'bzr shell-complete'.
4451
4428
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.
4429
"""Compress the data within a repository."""
4470
4431
_see_also = ['repositories']
4471
4432
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):
4434
def run(self, branch_or_repo='.'):
4477
4435
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4479
4437
branch = dir.open_branch()
4480
4438
repository = branch.repository
4481
4439
except errors.NotBranchError:
4482
4440
repository = dir.open_repository()
4483
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4486
4444
class cmd_plugins(Command):
4487
__doc__ = """List the installed plugins.
4445
"""List the installed plugins.
4489
4447
This command displays the list of installed plugins including
4490
4448
version of plugin and a short description of each.
4531
4489
class cmd_testament(Command):
4532
__doc__ = """Show testament (signing-form) of a revision."""
4490
"""Show testament (signing-form) of a revision."""
4533
4491
takes_options = [
4535
4493
Option('long', help='Produce long-format testament.'),
4563
4521
class cmd_annotate(Command):
4564
__doc__ = """Show the origin of each line in a file.
4522
"""Show the origin of each line in a file.
4566
4524
This prints out the given file with an annotation on the left side
4567
4525
indicating which revision, author and date introduced the change.
4616
4574
class cmd_re_sign(Command):
4617
__doc__ = """Create a digital signature for an existing revision."""
4575
"""Create a digital signature for an existing revision."""
4618
4576
# TODO be able to replace existing ones.
4620
4578
hidden = True # is this right ?
4682
4640
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.
4641
"""Convert the current branch into a checkout of the supplied branch.
4686
4643
Once converted into a checkout, commits must succeed on the master branch
4687
4644
before they will be applied to the local branch.
4723
4680
class cmd_unbind(Command):
4724
__doc__ = """Convert the current checkout into a regular branch.
4681
"""Convert the current checkout into a regular branch.
4726
4683
After unbinding, the local branch is considered independent and subsequent
4727
4684
commits will be local only.
4740
4697
class cmd_uncommit(Command):
4741
__doc__ = """Remove the last committed revision.
4698
"""Remove the last committed revision.
4743
4700
--verbose will print out what is being removed.
4744
4701
--dry-run will go through all the motions, but not actually
4848
4805
class cmd_break_lock(Command):
4849
__doc__ = """Break a dead lock on a repository, branch or working directory.
4806
"""Break a dead lock on a repository, branch or working directory.
4851
4808
CAUTION: Locks should only be broken when you are sure that the process
4852
4809
holding the lock has been stopped.
4873
4830
class cmd_wait_until_signalled(Command):
4874
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4831
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4876
4833
This just prints a line to signal when it is ready, then blocks on stdin.
4999
4956
class cmd_split(Command):
5000
__doc__ = """Split a subdirectory of a tree into a separate tree.
4957
"""Split a subdirectory of a tree into a separate tree.
5002
4959
This command will produce a target tree in a format that supports
5003
4960
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5025
4982
class cmd_merge_directive(Command):
5026
__doc__ = """Generate a merge directive for auto-merge tools.
4983
"""Generate a merge directive for auto-merge tools.
5028
4985
A directive requests a merge to be performed, and also provides all the
5029
4986
information necessary to do so. This means it must either include a
5241
5198
class cmd_bundle_revisions(cmd_send):
5242
__doc__ = """Create a merge-directive for submitting changes.
5199
"""Create a merge-directive for submitting changes.
5244
5201
A merge directive provides many things needed for requesting merges:
5314
5271
class cmd_tag(Command):
5315
__doc__ = """Create, remove or modify a tag naming a revision.
5272
"""Create, remove or modify a tag naming a revision.
5317
5274
Tags give human-meaningful names to revisions. Commands that take a -r
5318
5275
(--revision) option can be given -rtag:X, where X is any previously
5552
5509
class cmd_switch(Command):
5553
__doc__ = """Set the branch of a checkout and update.
5510
"""Set the branch of a checkout and update.
5555
5512
For lightweight checkouts, this changes the branch being referenced.
5556
5513
For heavyweight checkouts, this checks that there are no local commits
5648
5605
class cmd_view(Command):
5649
__doc__ = """Manage filtered views.
5606
"""Manage filtered views.
5651
5608
Views provide a mask over the tree so that users can focus on
5652
5609
a subset of a tree when doing their work. After creating a view,
5847
5804
class cmd_shelve(Command):
5848
__doc__ = """Temporarily set aside some changes from the current tree.
5805
"""Temporarily set aside some changes from the current tree.
5850
5807
Shelve allows you to temporarily put changes you've made "on the shelf",
5851
5808
ie. out of the way, until a later time when you can bring them back from
5922
5879
class cmd_unshelve(Command):
5923
__doc__ = """Restore shelved changes.
5880
"""Restore shelved changes.
5925
5882
By default, the most recently shelved changes are restored. However if you
5926
5883
specify a shelf by id those changes will be restored instead. This works
5954
5911
class cmd_clean_tree(Command):
5955
__doc__ = """Remove unwanted files from working tree.
5912
"""Remove unwanted files from working tree.
5957
5914
By default, only unknown files, not ignored files, are deleted. Versioned
5958
5915
files are never deleted.
5988
5945
class cmd_reference(Command):
5989
__doc__ = """list, view and set branch locations for nested trees.
5946
"""list, view and set branch locations for nested trees.
5991
5948
If no arguments are provided, lists the branch locations for nested trees.
5992
5949
If one argument is provided, display the branch location for that tree.