1
# Copyright (C) 2004, 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
43
revision as _mod_revision,
50
from bzrlib.branch import Branch
51
from bzrlib.conflicts import ConflictList
52
from bzrlib.revisionspec import RevisionSpec
53
from bzrlib.smtp_connection import SMTPConnection
54
from bzrlib.workingtree import WorkingTree
57
from bzrlib.commands import Command, display_command
58
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
59
from bzrlib.trace import mutter, note, warning, is_quiet
62
def tree_files(file_list, default_branch=u'.'):
64
return internal_tree_files(file_list, default_branch)
65
except errors.FileInWrongBranch, e:
66
raise errors.BzrCommandError("%s is not in the same branch as %s" %
67
(e.path, file_list[0]))
70
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
75
rev_tree = tree.basis_tree()
77
rev_tree = branch.basis_tree()
79
if len(revisions) != 1:
80
raise errors.BzrCommandError(
81
'bzr %s --revision takes exactly one revision identifier' % (
83
rev_tree = revisions[0].as_tree(branch)
87
# XXX: Bad function name; should possibly also be a class method of
88
# WorkingTree rather than a function.
89
def internal_tree_files(file_list, default_branch=u'.'):
90
"""Convert command-line paths to a WorkingTree and relative paths.
92
This is typically used for command-line processors that take one or
93
more filenames, and infer the workingtree that contains them.
95
The filenames given are not required to exist.
97
:param file_list: Filenames to convert.
99
:param default_branch: Fallback tree path to use if file_list is empty or
102
:return: workingtree, [relative_paths]
104
if file_list is None or len(file_list) == 0:
105
return WorkingTree.open_containing(default_branch)[0], file_list
106
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
107
return tree, safe_relpath_files(tree, file_list)
110
def safe_relpath_files(tree, file_list):
111
"""Convert file_list into a list of relpaths in tree.
113
:param tree: A tree to operate on.
114
:param file_list: A list of user provided paths or None.
115
:return: A list of relative paths.
116
:raises errors.PathNotChild: When a provided path is in a different tree
119
if file_list is None:
122
for filename in file_list:
124
new_list.append(tree.relpath(osutils.dereference_path(filename)))
125
except errors.PathNotChild:
126
raise errors.FileInWrongBranch(tree.branch, filename)
130
# TODO: Make sure no commands unconditionally use the working directory as a
131
# branch. If a filename argument is used, the first of them should be used to
132
# specify the branch. (Perhaps this can be factored out into some kind of
133
# Argument class, representing a file in a branch, where the first occurrence
136
class cmd_status(Command):
137
"""Display status summary.
139
This reports on versioned and unknown files, reporting them
140
grouped by state. Possible states are:
143
Versioned in the working copy but not in the previous revision.
146
Versioned in the previous revision but removed or deleted
150
Path of this file changed from the previous revision;
151
the text may also have changed. This includes files whose
152
parent directory was renamed.
155
Text has changed since the previous revision.
158
File kind has been changed (e.g. from file to directory).
161
Not versioned and not matching an ignore pattern.
163
To see ignored files use 'bzr ignored'. For details on the
164
changes to file texts, use 'bzr diff'.
166
Note that --short or -S gives status flags for each item, similar
167
to Subversion's status command. To get output similar to svn -q,
170
If no arguments are specified, the status of the entire working
171
directory is shown. Otherwise, only the status of the specified
172
files or directories is reported. If a directory is given, status
173
is reported for everything inside that directory.
175
If a revision argument is given, the status is calculated against
176
that revision, or between two revisions if two are provided.
179
# TODO: --no-recurse, --recurse options
181
takes_args = ['file*']
182
takes_options = ['show-ids', 'revision', 'change',
183
Option('short', help='Use short status indicators.',
185
Option('versioned', help='Only show versioned files.',
187
Option('no-pending', help='Don\'t show pending merges.',
190
aliases = ['st', 'stat']
192
encoding_type = 'replace'
193
_see_also = ['diff', 'revert', 'status-flags']
196
def run(self, show_ids=False, file_list=None, revision=None, short=False,
197
versioned=False, no_pending=False):
198
from bzrlib.status import show_tree_status
200
if revision and len(revision) > 2:
201
raise errors.BzrCommandError('bzr status --revision takes exactly'
202
' one or two revision specifiers')
204
tree, relfile_list = tree_files(file_list)
205
# Avoid asking for specific files when that is not needed.
206
if relfile_list == ['']:
208
# Don't disable pending merges for full trees other than '.'.
209
if file_list == ['.']:
211
# A specific path within a tree was given.
212
elif relfile_list is not None:
214
show_tree_status(tree, show_ids=show_ids,
215
specific_files=relfile_list, revision=revision,
216
to_file=self.outf, short=short, versioned=versioned,
217
show_pending=(not no_pending))
220
class cmd_cat_revision(Command):
221
"""Write out metadata for a revision.
223
The revision to print can either be specified by a specific
224
revision identifier, or you can use --revision.
228
takes_args = ['revision_id?']
229
takes_options = ['revision']
230
# cat-revision is more for frontends so should be exact
234
def run(self, revision_id=None, revision=None):
235
if revision_id is not None and revision is not None:
236
raise errors.BzrCommandError('You can only supply one of'
237
' revision_id or --revision')
238
if revision_id is None and revision is None:
239
raise errors.BzrCommandError('You must supply either'
240
' --revision or a revision_id')
241
b = WorkingTree.open_containing(u'.')[0].branch
243
# TODO: jam 20060112 should cat-revision always output utf-8?
244
if revision_id is not None:
245
revision_id = osutils.safe_revision_id(revision_id, warn=False)
247
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
248
except errors.NoSuchRevision:
249
msg = "The repository %s contains no revision %s." % (b.repository.base,
251
raise errors.BzrCommandError(msg)
252
elif revision is not None:
255
raise errors.BzrCommandError('You cannot specify a NULL'
257
rev_id = rev.as_revision_id(b)
258
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
261
class cmd_dump_btree(Command):
262
"""Dump the contents of a btree index file to stdout.
264
PATH is a btree index file, it can be any URL. This includes things like
265
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
267
By default, the tuples stored in the index file will be displayed. With
268
--raw, we will uncompress the pages, but otherwise display the raw bytes
272
# TODO: Do we want to dump the internal nodes as well?
273
# TODO: It would be nice to be able to dump the un-parsed information,
274
# rather than only going through iter_all_entries. However, this is
275
# good enough for a start
277
encoding_type = 'exact'
278
takes_args = ['path']
279
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
280
' rather than the parsed tuples.'),
283
def run(self, path, raw=False):
284
dirname, basename = osutils.split(path)
285
t = transport.get_transport(dirname)
287
self._dump_raw_bytes(t, basename)
289
self._dump_entries(t, basename)
291
def _get_index_and_bytes(self, trans, basename):
292
"""Create a BTreeGraphIndex and raw bytes."""
293
bt = btree_index.BTreeGraphIndex(trans, basename, None)
294
bytes = trans.get_bytes(basename)
295
bt._file = cStringIO.StringIO(bytes)
296
bt._size = len(bytes)
299
def _dump_raw_bytes(self, trans, basename):
302
# We need to parse at least the root node.
303
# This is because the first page of every row starts with an
304
# uncompressed header.
305
bt, bytes = self._get_index_and_bytes(trans, basename)
306
for page_idx, page_start in enumerate(xrange(0, len(bytes),
307
btree_index._PAGE_SIZE)):
308
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
309
page_bytes = bytes[page_start:page_end]
311
self.outf.write('Root node:\n')
312
header_end, data = bt._parse_header_from_bytes(page_bytes)
313
self.outf.write(page_bytes[:header_end])
315
self.outf.write('\nPage %d\n' % (page_idx,))
316
decomp_bytes = zlib.decompress(page_bytes)
317
self.outf.write(decomp_bytes)
318
self.outf.write('\n')
320
def _dump_entries(self, trans, basename):
322
st = trans.stat(basename)
323
except errors.TransportNotPossible:
324
# We can't stat, so we'll fake it because we have to do the 'get()'
326
bt, _ = self._get_index_and_bytes(trans, basename)
328
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
329
for node in bt.iter_all_entries():
330
# Node is made up of:
331
# (index, key, value, [references])
332
self.outf.write('%s\n' % (node[1:],))
335
class cmd_remove_tree(Command):
336
"""Remove the working tree from a given branch/checkout.
338
Since a lightweight checkout is little more than a working tree
339
this will refuse to run against one.
341
To re-create the working tree, use "bzr checkout".
343
_see_also = ['checkout', 'working-trees']
344
takes_args = ['location?']
347
help='Remove the working tree even if it has '
348
'uncommitted changes.'),
351
def run(self, location='.', force=False):
352
d = bzrdir.BzrDir.open(location)
355
working = d.open_workingtree()
356
except errors.NoWorkingTree:
357
raise errors.BzrCommandError("No working tree to remove")
358
except errors.NotLocalUrl:
359
raise errors.BzrCommandError("You cannot remove the working tree of a "
362
changes = working.changes_from(working.basis_tree())
363
if changes.has_changed():
364
raise errors.UncommittedChanges(working)
366
working_path = working.bzrdir.root_transport.base
367
branch_path = working.branch.bzrdir.root_transport.base
368
if working_path != branch_path:
369
raise errors.BzrCommandError("You cannot remove the working tree from "
370
"a lightweight checkout")
372
d.destroy_workingtree()
375
class cmd_revno(Command):
376
"""Show current revision number.
378
This is equal to the number of revisions on this branch.
382
takes_args = ['location?']
385
def run(self, location=u'.'):
386
self.outf.write(str(Branch.open_containing(location)[0].revno()))
387
self.outf.write('\n')
390
class cmd_revision_info(Command):
391
"""Show revision number and revision id for a given revision identifier.
394
takes_args = ['revision_info*']
395
takes_options = ['revision']
398
def run(self, revision=None, revision_info_list=[]):
401
if revision is not None:
402
revs.extend(revision)
403
if revision_info_list is not None:
404
for rev in revision_info_list:
405
revs.append(RevisionSpec.from_string(rev))
407
b = Branch.open_containing(u'.')[0]
410
revs.append(RevisionSpec.from_string('-1'))
413
revision_id = rev.as_revision_id(b)
415
revno = '%4d' % (b.revision_id_to_revno(revision_id))
416
except errors.NoSuchRevision:
417
dotted_map = b.get_revision_id_to_revno_map()
418
revno = '.'.join(str(i) for i in dotted_map[revision_id])
419
print '%s %s' % (revno, revision_id)
422
class cmd_add(Command):
423
"""Add specified files or directories.
425
In non-recursive mode, all the named items are added, regardless
426
of whether they were previously ignored. A warning is given if
427
any of the named files are already versioned.
429
In recursive mode (the default), files are treated the same way
430
but the behaviour for directories is different. Directories that
431
are already versioned do not give a warning. All directories,
432
whether already versioned or not, are searched for files or
433
subdirectories that are neither versioned or ignored, and these
434
are added. This search proceeds recursively into versioned
435
directories. If no names are given '.' is assumed.
437
Therefore simply saying 'bzr add' will version all files that
438
are currently unknown.
440
Adding a file whose parent directory is not versioned will
441
implicitly add the parent, and so on up to the root. This means
442
you should never need to explicitly add a directory, they'll just
443
get added when you add a file in the directory.
445
--dry-run will show which files would be added, but not actually
448
--file-ids-from will try to use the file ids from the supplied path.
449
It looks up ids trying to find a matching parent directory with the
450
same filename, and then by pure path. This option is rarely needed
451
but can be useful when adding the same logical file into two
452
branches that will be merged later (without showing the two different
453
adds as a conflict). It is also useful when merging another project
454
into a subdirectory of this one.
456
takes_args = ['file*']
459
help="Don't recursively add the contents of directories."),
461
help="Show what would be done, but don't actually do anything."),
463
Option('file-ids-from',
465
help='Lookup file ids from this tree.'),
467
encoding_type = 'replace'
468
_see_also = ['remove']
470
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
475
if file_ids_from is not None:
477
base_tree, base_path = WorkingTree.open_containing(
479
except errors.NoWorkingTree:
480
base_branch, base_path = Branch.open_containing(
482
base_tree = base_branch.basis_tree()
484
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
485
to_file=self.outf, should_print=(not is_quiet()))
487
action = bzrlib.add.AddAction(to_file=self.outf,
488
should_print=(not is_quiet()))
491
base_tree.lock_read()
493
file_list = self._maybe_expand_globs(file_list)
495
tree = WorkingTree.open_containing(file_list[0])[0]
497
tree = WorkingTree.open_containing(u'.')[0]
498
added, ignored = tree.smart_add(file_list, not
499
no_recurse, action=action, save=not dry_run)
501
if base_tree is not None:
505
for glob in sorted(ignored.keys()):
506
for path in ignored[glob]:
507
self.outf.write("ignored %s matching \"%s\"\n"
511
for glob, paths in ignored.items():
512
match_len += len(paths)
513
self.outf.write("ignored %d file(s).\n" % match_len)
514
self.outf.write("If you wish to add some of these files,"
515
" please add them by name.\n")
518
class cmd_mkdir(Command):
519
"""Create a new versioned directory.
521
This is equivalent to creating the directory and then adding it.
524
takes_args = ['dir+']
525
encoding_type = 'replace'
527
def run(self, dir_list):
530
wt, dd = WorkingTree.open_containing(d)
532
self.outf.write('added %s\n' % d)
535
class cmd_relpath(Command):
536
"""Show path of a file relative to root"""
538
takes_args = ['filename']
542
def run(self, filename):
543
# TODO: jam 20050106 Can relpath return a munged path if
544
# sys.stdout encoding cannot represent it?
545
tree, relpath = WorkingTree.open_containing(filename)
546
self.outf.write(relpath)
547
self.outf.write('\n')
550
class cmd_inventory(Command):
551
"""Show inventory of the current working copy or a revision.
553
It is possible to limit the output to a particular entry
554
type using the --kind option. For example: --kind file.
556
It is also possible to restrict the list of files to a specific
557
set. For example: bzr inventory --show-ids this/file
566
help='List entries of a particular kind: file, directory, symlink.',
569
takes_args = ['file*']
572
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
573
if kind and kind not in ['file', 'directory', 'symlink']:
574
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
576
work_tree, file_list = tree_files(file_list)
577
work_tree.lock_read()
579
if revision is not None:
580
if len(revision) > 1:
581
raise errors.BzrCommandError(
582
'bzr inventory --revision takes exactly one revision'
584
tree = revision[0].as_tree(work_tree.branch)
586
extra_trees = [work_tree]
592
if file_list is not None:
593
file_ids = tree.paths2ids(file_list, trees=extra_trees,
594
require_versioned=True)
595
# find_ids_across_trees may include some paths that don't
597
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
598
for file_id in file_ids if file_id in tree)
600
entries = tree.inventory.entries()
603
if tree is not work_tree:
606
for path, entry in entries:
607
if kind and kind != entry.kind:
610
self.outf.write('%-50s %s\n' % (path, entry.file_id))
612
self.outf.write(path)
613
self.outf.write('\n')
616
class cmd_mv(Command):
617
"""Move or rename a file.
620
bzr mv OLDNAME NEWNAME
622
bzr mv SOURCE... DESTINATION
624
If the last argument is a versioned directory, all the other names
625
are moved into it. Otherwise, there must be exactly two arguments
626
and the file is changed to a new name.
628
If OLDNAME does not exist on the filesystem but is versioned and
629
NEWNAME does exist on the filesystem but is not versioned, mv
630
assumes that the file has been manually moved and only updates
631
its internal inventory to reflect that change.
632
The same is valid when moving many SOURCE files to a DESTINATION.
634
Files cannot be moved between branches.
637
takes_args = ['names*']
638
takes_options = [Option("after", help="Move only the bzr identifier"
639
" of the file, because the file has already been moved."),
641
aliases = ['move', 'rename']
642
encoding_type = 'replace'
644
def run(self, names_list, after=False):
645
if names_list is None:
648
if len(names_list) < 2:
649
raise errors.BzrCommandError("missing file argument")
650
tree, rel_names = tree_files(names_list)
653
self._run(tree, names_list, rel_names, after)
657
def _run(self, tree, names_list, rel_names, after):
658
into_existing = osutils.isdir(names_list[-1])
659
if into_existing and len(names_list) == 2:
661
# a. case-insensitive filesystem and change case of dir
662
# b. move directory after the fact (if the source used to be
663
# a directory, but now doesn't exist in the working tree
664
# and the target is an existing directory, just rename it)
665
if (not tree.case_sensitive
666
and rel_names[0].lower() == rel_names[1].lower()):
667
into_existing = False
670
from_id = tree.path2id(rel_names[0])
671
if (not osutils.lexists(names_list[0]) and
672
from_id and inv.get_file_kind(from_id) == "directory"):
673
into_existing = False
676
# move into existing directory
677
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
678
self.outf.write("%s => %s\n" % pair)
680
if len(names_list) != 2:
681
raise errors.BzrCommandError('to mv multiple files the'
682
' destination must be a versioned'
684
tree.rename_one(rel_names[0], rel_names[1], after=after)
685
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
688
class cmd_pull(Command):
689
"""Turn this branch into a mirror of another branch.
691
This command only works on branches that have not diverged. Branches are
692
considered diverged if the destination branch's most recent commit is one
693
that has not been merged (directly or indirectly) into the parent.
695
If branches have diverged, you can use 'bzr merge' to integrate the changes
696
from one into the other. Once one branch has merged, the other should
697
be able to pull it again.
699
If you want to forget your local changes and just update your branch to
700
match the remote one, use pull --overwrite.
702
If there is no default location set, the first pull will set it. After
703
that, you can omit the location to use the default. To change the
704
default, use --remember. The value will only be saved if the remote
705
location can be accessed.
707
Note: The location can be specified either in the form of a branch,
708
or in the form of a path to a file containing a merge directive generated
712
_see_also = ['push', 'update', 'status-flags']
713
takes_options = ['remember', 'overwrite', 'revision',
714
custom_help('verbose',
715
help='Show logs of pulled revisions.'),
717
help='Branch to pull into, '
718
'rather than the one containing the working directory.',
723
takes_args = ['location?']
724
encoding_type = 'replace'
726
def run(self, location=None, remember=False, overwrite=False,
727
revision=None, verbose=False,
729
# FIXME: too much stuff is in the command class
732
if directory is None:
735
tree_to = WorkingTree.open_containing(directory)[0]
736
branch_to = tree_to.branch
737
except errors.NoWorkingTree:
739
branch_to = Branch.open_containing(directory)[0]
741
possible_transports = []
742
if location is not None:
744
mergeable = bundle.read_mergeable_from_url(location,
745
possible_transports=possible_transports)
746
except errors.NotABundle:
749
stored_loc = branch_to.get_parent()
751
if stored_loc is None:
752
raise errors.BzrCommandError("No pull location known or"
755
display_url = urlutils.unescape_for_display(stored_loc,
758
self.outf.write("Using saved parent location: %s\n" % display_url)
759
location = stored_loc
761
if mergeable is not None:
762
if revision is not None:
763
raise errors.BzrCommandError(
764
'Cannot use -r with merge directives or bundles')
765
mergeable.install_revisions(branch_to.repository)
766
base_revision_id, revision_id, verified = \
767
mergeable.get_merge_request(branch_to.repository)
768
branch_from = branch_to
770
branch_from = Branch.open(location,
771
possible_transports=possible_transports)
773
if branch_to.get_parent() is None or remember:
774
branch_to.set_parent(branch_from.base)
776
if revision is not None:
777
if len(revision) == 1:
778
revision_id = revision[0].as_revision_id(branch_from)
780
raise errors.BzrCommandError(
781
'bzr pull --revision takes one value.')
783
branch_to.lock_write()
785
if tree_to is not None:
786
change_reporter = delta._ChangeReporter(
787
unversioned_filter=tree_to.is_ignored)
788
result = tree_to.pull(branch_from, overwrite, revision_id,
790
possible_transports=possible_transports)
792
result = branch_to.pull(branch_from, overwrite, revision_id)
794
result.report(self.outf)
795
if verbose and result.old_revid != result.new_revid:
797
branch_to.repository.iter_reverse_revision_history(
800
new_rh = branch_to.revision_history()
801
log.show_changed_revisions(branch_to, old_rh, new_rh,
807
class cmd_push(Command):
808
"""Update a mirror of this branch.
810
The target branch will not have its working tree populated because this
811
is both expensive, and is not supported on remote file systems.
813
Some smart servers or protocols *may* put the working tree in place in
816
This command only works on branches that have not diverged. Branches are
817
considered diverged if the destination branch's most recent commit is one
818
that has not been merged (directly or indirectly) by the source branch.
820
If branches have diverged, you can use 'bzr push --overwrite' to replace
821
the other branch completely, discarding its unmerged changes.
823
If you want to ensure you have the different changes in the other branch,
824
do a merge (see bzr help merge) from the other branch, and commit that.
825
After that you will be able to do a push without '--overwrite'.
827
If there is no default push location set, the first push will set it.
828
After that, you can omit the location to use the default. To change the
829
default, use --remember. The value will only be saved if the remote
830
location can be accessed.
833
_see_also = ['pull', 'update', 'working-trees']
834
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
835
Option('create-prefix',
836
help='Create the path leading up to the branch '
837
'if it does not already exist.'),
839
help='Branch to push from, '
840
'rather than the one containing the working directory.',
844
Option('use-existing-dir',
845
help='By default push will fail if the target'
846
' directory exists, but does not already'
847
' have a control directory. This flag will'
848
' allow push to proceed.'),
850
help='Create a stacked branch that references the public location '
851
'of the parent branch.'),
853
help='Create a stacked branch that refers to another branch '
854
'for the commit history. Only the work not present in the '
855
'referenced branch is included in the branch created.',
858
takes_args = ['location?']
859
encoding_type = 'replace'
861
def run(self, location=None, remember=False, overwrite=False,
862
create_prefix=False, verbose=False, revision=None,
863
use_existing_dir=False, directory=None, stacked_on=None,
865
from bzrlib.push import _show_push_branch
867
# Get the source branch and revision_id
868
if directory is None:
870
br_from = Branch.open_containing(directory)[0]
871
if revision is not None:
872
if len(revision) == 1:
873
revision_id = revision[0].in_history(br_from).rev_id
875
raise errors.BzrCommandError(
876
'bzr push --revision takes one value.')
878
revision_id = br_from.last_revision()
880
# Get the stacked_on branch, if any
881
if stacked_on is not None:
882
stacked_on = urlutils.normalize_url(stacked_on)
884
parent_url = br_from.get_parent()
886
parent = Branch.open(parent_url)
887
stacked_on = parent.get_public_branch()
889
# I considered excluding non-http url's here, thus forcing
890
# 'public' branches only, but that only works for some
891
# users, so it's best to just depend on the user spotting an
892
# error by the feedback given to them. RBC 20080227.
893
stacked_on = parent_url
895
raise errors.BzrCommandError(
896
"Could not determine branch to refer to.")
898
# Get the destination location
900
stored_loc = br_from.get_push_location()
901
if stored_loc is None:
902
raise errors.BzrCommandError(
903
"No push location known or specified.")
905
display_url = urlutils.unescape_for_display(stored_loc,
907
self.outf.write("Using saved push location: %s\n" % display_url)
908
location = stored_loc
910
_show_push_branch(br_from, revision_id, location, self.outf,
911
verbose=verbose, overwrite=overwrite, remember=remember,
912
stacked_on=stacked_on, create_prefix=create_prefix,
913
use_existing_dir=use_existing_dir)
916
class cmd_branch(Command):
917
"""Create a new copy of a branch.
919
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
920
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
921
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
922
is derived from the FROM_LOCATION by stripping a leading scheme or drive
923
identifier, if any. For example, "branch lp:foo-bar" will attempt to
926
To retrieve the branch as of a particular revision, supply the --revision
927
parameter, as in "branch foo/bar -r 5".
930
_see_also = ['checkout']
931
takes_args = ['from_location', 'to_location?']
932
takes_options = ['revision', Option('hardlink',
933
help='Hard-link working tree files where possible.'),
935
help='Create a stacked branch referring to the source branch. '
936
'The new branch will depend on the availability of the source '
937
'branch for all operations.'),
939
help='Do not use a shared repository, even if available.'),
941
aliases = ['get', 'clone']
943
def run(self, from_location, to_location=None, revision=None,
944
hardlink=False, stacked=False, standalone=False):
945
from bzrlib.tag import _merge_tags_if_possible
948
elif len(revision) > 1:
949
raise errors.BzrCommandError(
950
'bzr branch --revision takes exactly 1 revision value')
952
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
956
if len(revision) == 1 and revision[0] is not None:
957
revision_id = revision[0].as_revision_id(br_from)
959
# FIXME - wt.last_revision, fallback to branch, fall back to
960
# None or perhaps NULL_REVISION to mean copy nothing
962
revision_id = br_from.last_revision()
963
if to_location is None:
964
to_location = urlutils.derive_to_location(from_location)
965
to_transport = transport.get_transport(to_location)
967
to_transport.mkdir('.')
968
except errors.FileExists:
969
raise errors.BzrCommandError('Target directory "%s" already'
970
' exists.' % to_location)
971
except errors.NoSuchFile:
972
raise errors.BzrCommandError('Parent of "%s" does not exist.'
975
# preserve whatever source format we have.
976
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
977
possible_transports=[to_transport],
978
accelerator_tree=accelerator_tree,
979
hardlink=hardlink, stacked=stacked,
980
force_new_repo=standalone)
981
branch = dir.open_branch()
982
except errors.NoSuchRevision:
983
to_transport.delete_tree('.')
984
msg = "The branch %s has no revision %s." % (from_location,
986
raise errors.BzrCommandError(msg)
987
_merge_tags_if_possible(br_from, branch)
988
# If the source branch is stacked, the new branch may
989
# be stacked whether we asked for that explicitly or not.
990
# We therefore need a try/except here and not just 'if stacked:'
992
note('Created new stacked branch referring to %s.' %
993
branch.get_stacked_on_url())
994
except (errors.NotStacked, errors.UnstackableBranchFormat,
995
errors.UnstackableRepositoryFormat), e:
996
note('Branched %d revision(s).' % branch.revno())
1001
class cmd_checkout(Command):
1002
"""Create a new checkout of an existing branch.
1004
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1005
the branch found in '.'. This is useful if you have removed the working tree
1006
or if it was never created - i.e. if you pushed the branch to its current
1007
location using SFTP.
1009
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1010
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1011
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1012
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1013
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1016
To retrieve the branch as of a particular revision, supply the --revision
1017
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1018
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1022
_see_also = ['checkouts', 'branch']
1023
takes_args = ['branch_location?', 'to_location?']
1024
takes_options = ['revision',
1025
Option('lightweight',
1026
help="Perform a lightweight checkout. Lightweight "
1027
"checkouts depend on access to the branch for "
1028
"every operation. Normal checkouts can perform "
1029
"common operations like diff and status without "
1030
"such access, and also support local commits."
1032
Option('files-from', type=str,
1033
help="Get file contents from this tree."),
1035
help='Hard-link working tree files where possible.'
1040
def run(self, branch_location=None, to_location=None, revision=None,
1041
lightweight=False, files_from=None, hardlink=False):
1042
if revision is None:
1044
elif len(revision) > 1:
1045
raise errors.BzrCommandError(
1046
'bzr checkout --revision takes exactly 1 revision value')
1047
if branch_location is None:
1048
branch_location = osutils.getcwd()
1049
to_location = branch_location
1050
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1052
if files_from is not None:
1053
accelerator_tree = WorkingTree.open(files_from)
1054
if len(revision) == 1 and revision[0] is not None:
1055
revision_id = revision[0].as_revision_id(source)
1058
if to_location is None:
1059
to_location = urlutils.derive_to_location(branch_location)
1060
# if the source and to_location are the same,
1061
# and there is no working tree,
1062
# then reconstitute a branch
1063
if (osutils.abspath(to_location) ==
1064
osutils.abspath(branch_location)):
1066
source.bzrdir.open_workingtree()
1067
except errors.NoWorkingTree:
1068
source.bzrdir.create_workingtree(revision_id)
1070
source.create_checkout(to_location, revision_id, lightweight,
1071
accelerator_tree, hardlink)
1074
class cmd_renames(Command):
1075
"""Show list of renamed files.
1077
# TODO: Option to show renames between two historical versions.
1079
# TODO: Only show renames under dir, rather than in the whole branch.
1080
_see_also = ['status']
1081
takes_args = ['dir?']
1084
def run(self, dir=u'.'):
1085
tree = WorkingTree.open_containing(dir)[0]
1088
new_inv = tree.inventory
1089
old_tree = tree.basis_tree()
1090
old_tree.lock_read()
1092
old_inv = old_tree.inventory
1093
renames = list(_mod_tree.find_renames(old_inv, new_inv))
1095
for old_name, new_name in renames:
1096
self.outf.write("%s => %s\n" % (old_name, new_name))
1103
class cmd_update(Command):
1104
"""Update a tree to have the latest code committed to its branch.
1106
This will perform a merge into the working tree, and may generate
1107
conflicts. If you have any local changes, you will still
1108
need to commit them after the update for the update to be complete.
1110
If you want to discard your local changes, you can just do a
1111
'bzr revert' instead of 'bzr commit' after the update.
1114
_see_also = ['pull', 'working-trees', 'status-flags']
1115
takes_args = ['dir?']
1118
def run(self, dir='.'):
1119
tree = WorkingTree.open_containing(dir)[0]
1120
possible_transports = []
1121
master = tree.branch.get_master_branch(
1122
possible_transports=possible_transports)
1123
if master is not None:
1126
tree.lock_tree_write()
1128
existing_pending_merges = tree.get_parent_ids()[1:]
1129
last_rev = _mod_revision.ensure_null(tree.last_revision())
1130
if last_rev == _mod_revision.ensure_null(
1131
tree.branch.last_revision()):
1132
# may be up to date, check master too.
1133
if master is None or last_rev == _mod_revision.ensure_null(
1134
master.last_revision()):
1135
revno = tree.branch.revision_id_to_revno(last_rev)
1136
note("Tree is up to date at revision %d." % (revno,))
1138
conflicts = tree.update(
1139
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1140
possible_transports=possible_transports)
1141
revno = tree.branch.revision_id_to_revno(
1142
_mod_revision.ensure_null(tree.last_revision()))
1143
note('Updated to revision %d.' % (revno,))
1144
if tree.get_parent_ids()[1:] != existing_pending_merges:
1145
note('Your local commits will now show as pending merges with '
1146
"'bzr status', and can be committed with 'bzr commit'.")
1155
class cmd_info(Command):
1156
"""Show information about a working tree, branch or repository.
1158
This command will show all known locations and formats associated to the
1159
tree, branch or repository. Statistical information is included with
1162
Branches and working trees will also report any missing revisions.
1164
_see_also = ['revno', 'working-trees', 'repositories']
1165
takes_args = ['location?']
1166
takes_options = ['verbose']
1167
encoding_type = 'replace'
1170
def run(self, location=None, verbose=False):
1175
from bzrlib.info import show_bzrdir_info
1176
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1177
verbose=noise_level, outfile=self.outf)
1180
class cmd_remove(Command):
1181
"""Remove files or directories.
1183
This makes bzr stop tracking changes to the specified files. bzr will delete
1184
them if they can easily be recovered using revert. If no options or
1185
parameters are given bzr will scan for files that are being tracked by bzr
1186
but missing in your tree and stop tracking them for you.
1188
takes_args = ['file*']
1189
takes_options = ['verbose',
1190
Option('new', help='Only remove files that have never been committed.'),
1191
RegistryOption.from_kwargs('file-deletion-strategy',
1192
'The file deletion mode to be used.',
1193
title='Deletion Strategy', value_switches=True, enum_switch=False,
1194
safe='Only delete files if they can be'
1195
' safely recovered (default).',
1196
keep="Don't delete any files.",
1197
force='Delete all the specified files, even if they can not be '
1198
'recovered and even if they are non-empty directories.')]
1199
aliases = ['rm', 'del']
1200
encoding_type = 'replace'
1202
def run(self, file_list, verbose=False, new=False,
1203
file_deletion_strategy='safe'):
1204
tree, file_list = tree_files(file_list)
1206
if file_list is not None:
1207
file_list = [f for f in file_list]
1211
# Heuristics should probably all move into tree.remove_smart or
1214
added = tree.changes_from(tree.basis_tree(),
1215
specific_files=file_list).added
1216
file_list = sorted([f[0] for f in added], reverse=True)
1217
if len(file_list) == 0:
1218
raise errors.BzrCommandError('No matching files.')
1219
elif file_list is None:
1220
# missing files show up in iter_changes(basis) as
1221
# versioned-with-no-kind.
1223
for change in tree.iter_changes(tree.basis_tree()):
1224
# Find paths in the working tree that have no kind:
1225
if change[1][1] is not None and change[6][1] is None:
1226
missing.append(change[1][1])
1227
file_list = sorted(missing, reverse=True)
1228
file_deletion_strategy = 'keep'
1229
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1230
keep_files=file_deletion_strategy=='keep',
1231
force=file_deletion_strategy=='force')
1236
class cmd_file_id(Command):
1237
"""Print file_id of a particular file or directory.
1239
The file_id is assigned when the file is first added and remains the
1240
same through all revisions where the file exists, even when it is
1245
_see_also = ['inventory', 'ls']
1246
takes_args = ['filename']
1249
def run(self, filename):
1250
tree, relpath = WorkingTree.open_containing(filename)
1251
i = tree.path2id(relpath)
1253
raise errors.NotVersionedError(filename)
1255
self.outf.write(i + '\n')
1258
class cmd_file_path(Command):
1259
"""Print path of file_ids to a file or directory.
1261
This prints one line for each directory down to the target,
1262
starting at the branch root.
1266
takes_args = ['filename']
1269
def run(self, filename):
1270
tree, relpath = WorkingTree.open_containing(filename)
1271
fid = tree.path2id(relpath)
1273
raise errors.NotVersionedError(filename)
1274
segments = osutils.splitpath(relpath)
1275
for pos in range(1, len(segments) + 1):
1276
path = osutils.joinpath(segments[:pos])
1277
self.outf.write("%s\n" % tree.path2id(path))
1280
class cmd_reconcile(Command):
1281
"""Reconcile bzr metadata in a branch.
1283
This can correct data mismatches that may have been caused by
1284
previous ghost operations or bzr upgrades. You should only
1285
need to run this command if 'bzr check' or a bzr developer
1286
advises you to run it.
1288
If a second branch is provided, cross-branch reconciliation is
1289
also attempted, which will check that data like the tree root
1290
id which was not present in very early bzr versions is represented
1291
correctly in both branches.
1293
At the same time it is run it may recompress data resulting in
1294
a potential saving in disk space or performance gain.
1296
The branch *MUST* be on a listable system such as local disk or sftp.
1299
_see_also = ['check']
1300
takes_args = ['branch?']
1302
def run(self, branch="."):
1303
from bzrlib.reconcile import reconcile
1304
dir = bzrdir.BzrDir.open(branch)
1308
class cmd_revision_history(Command):
1309
"""Display the list of revision ids on a branch."""
1312
takes_args = ['location?']
1317
def run(self, location="."):
1318
branch = Branch.open_containing(location)[0]
1319
for revid in branch.revision_history():
1320
self.outf.write(revid)
1321
self.outf.write('\n')
1324
class cmd_ancestry(Command):
1325
"""List all revisions merged into this branch."""
1327
_see_also = ['log', 'revision-history']
1328
takes_args = ['location?']
1333
def run(self, location="."):
1335
wt = WorkingTree.open_containing(location)[0]
1336
except errors.NoWorkingTree:
1337
b = Branch.open(location)
1338
last_revision = b.last_revision()
1341
last_revision = wt.last_revision()
1343
revision_ids = b.repository.get_ancestry(last_revision)
1345
for revision_id in revision_ids:
1346
self.outf.write(revision_id + '\n')
1349
class cmd_init(Command):
1350
"""Make a directory into a versioned branch.
1352
Use this to create an empty branch, or before importing an
1355
If there is a repository in a parent directory of the location, then
1356
the history of the branch will be stored in the repository. Otherwise
1357
init creates a standalone branch which carries its own history
1358
in the .bzr directory.
1360
If there is already a branch at the location but it has no working tree,
1361
the tree can be populated with 'bzr checkout'.
1363
Recipe for importing a tree of files::
1369
bzr commit -m "imported project"
1372
_see_also = ['init-repository', 'branch', 'checkout']
1373
takes_args = ['location?']
1375
Option('create-prefix',
1376
help='Create the path leading up to the branch '
1377
'if it does not already exist.'),
1378
RegistryOption('format',
1379
help='Specify a format for this branch. '
1380
'See "help formats".',
1381
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1382
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1383
value_switches=True,
1384
title="Branch Format",
1386
Option('append-revisions-only',
1387
help='Never change revnos or the existing log.'
1388
' Append revisions to it only.')
1390
def run(self, location=None, format=None, append_revisions_only=False,
1391
create_prefix=False):
1393
format = bzrdir.format_registry.make_bzrdir('default')
1394
if location is None:
1397
to_transport = transport.get_transport(location)
1399
# The path has to exist to initialize a
1400
# branch inside of it.
1401
# Just using os.mkdir, since I don't
1402
# believe that we want to create a bunch of
1403
# locations if the user supplies an extended path
1405
to_transport.ensure_base()
1406
except errors.NoSuchFile:
1407
if not create_prefix:
1408
raise errors.BzrCommandError("Parent directory of %s"
1410
"\nYou may supply --create-prefix to create all"
1411
" leading parent directories."
1413
_create_prefix(to_transport)
1416
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1417
except errors.NotBranchError:
1418
# really a NotBzrDir error...
1419
create_branch = bzrdir.BzrDir.create_branch_convenience
1420
branch = create_branch(to_transport.base, format=format,
1421
possible_transports=[to_transport])
1422
a_bzrdir = branch.bzrdir
1424
from bzrlib.transport.local import LocalTransport
1425
if a_bzrdir.has_branch():
1426
if (isinstance(to_transport, LocalTransport)
1427
and not a_bzrdir.has_workingtree()):
1428
raise errors.BranchExistsWithoutWorkingTree(location)
1429
raise errors.AlreadyBranchError(location)
1430
branch = a_bzrdir.create_branch()
1431
a_bzrdir.create_workingtree()
1432
if append_revisions_only:
1434
branch.set_append_revisions_only(True)
1435
except errors.UpgradeRequired:
1436
raise errors.BzrCommandError('This branch format cannot be set'
1437
' to append-revisions-only. Try --experimental-branch6')
1439
from bzrlib.info import show_bzrdir_info
1440
show_bzrdir_info(a_bzrdir, verbose=0, outfile=self.outf)
1443
class cmd_init_repository(Command):
1444
"""Create a shared repository to hold branches.
1446
New branches created under the repository directory will store their
1447
revisions in the repository, not in the branch directory.
1449
If the --no-trees option is used then the branches in the repository
1450
will not have working trees by default.
1453
Create a shared repositories holding just branches::
1455
bzr init-repo --no-trees repo
1458
Make a lightweight checkout elsewhere::
1460
bzr checkout --lightweight repo/trunk trunk-checkout
1465
_see_also = ['init', 'branch', 'checkout', 'repositories']
1466
takes_args = ["location"]
1467
takes_options = [RegistryOption('format',
1468
help='Specify a format for this repository. See'
1469
' "bzr help formats" for details.',
1470
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1471
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1472
value_switches=True, title='Repository format'),
1474
help='Branches in the repository will default to'
1475
' not having a working tree.'),
1477
aliases = ["init-repo"]
1479
def run(self, location, format=None, no_trees=False):
1481
format = bzrdir.format_registry.make_bzrdir('default')
1483
if location is None:
1486
to_transport = transport.get_transport(location)
1487
to_transport.ensure_base()
1489
newdir = format.initialize_on_transport(to_transport)
1490
repo = newdir.create_repository(shared=True)
1491
repo.set_make_working_trees(not no_trees)
1493
from bzrlib.info import show_bzrdir_info
1494
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1497
class cmd_diff(Command):
1498
"""Show differences in the working tree, between revisions or branches.
1500
If no arguments are given, all changes for the current tree are listed.
1501
If files are given, only the changes in those files are listed.
1502
Remote and multiple branches can be compared by using the --old and
1503
--new options. If not provided, the default for both is derived from
1504
the first argument, if any, or the current tree if no arguments are
1507
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1508
produces patches suitable for "patch -p1".
1512
2 - unrepresentable changes
1517
Shows the difference in the working tree versus the last commit::
1521
Difference between the working tree and revision 1::
1525
Difference between revision 2 and revision 1::
1529
Difference between revision 2 and revision 1 for branch xxx::
1533
Show just the differences for file NEWS::
1537
Show the differences in working tree xxx for file NEWS::
1541
Show the differences from branch xxx to this working tree:
1545
Show the differences between two branches for file NEWS::
1547
bzr diff --old xxx --new yyy NEWS
1549
Same as 'bzr diff' but prefix paths with old/ and new/::
1551
bzr diff --prefix old/:new/
1553
_see_also = ['status']
1554
takes_args = ['file*']
1556
Option('diff-options', type=str,
1557
help='Pass these options to the external diff program.'),
1558
Option('prefix', type=str,
1560
help='Set prefixes added to old and new filenames, as '
1561
'two values separated by a colon. (eg "old/:new/").'),
1563
help='Branch/tree to compare from.',
1567
help='Branch/tree to compare to.',
1573
help='Use this command to compare files.',
1577
aliases = ['di', 'dif']
1578
encoding_type = 'exact'
1581
def run(self, revision=None, file_list=None, diff_options=None,
1582
prefix=None, old=None, new=None, using=None):
1583
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1585
if (prefix is None) or (prefix == '0'):
1593
old_label, new_label = prefix.split(":")
1595
raise errors.BzrCommandError(
1596
'--prefix expects two values separated by a colon'
1597
' (eg "old/:new/")')
1599
if revision and len(revision) > 2:
1600
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1601
' one or two revision specifiers')
1603
old_tree, new_tree, specific_files, extra_trees = \
1604
_get_trees_to_diff(file_list, revision, old, new)
1605
return show_diff_trees(old_tree, new_tree, sys.stdout,
1606
specific_files=specific_files,
1607
external_diff_options=diff_options,
1608
old_label=old_label, new_label=new_label,
1609
extra_trees=extra_trees, using=using)
1612
class cmd_deleted(Command):
1613
"""List files deleted in the working tree.
1615
# TODO: Show files deleted since a previous revision, or
1616
# between two revisions.
1617
# TODO: Much more efficient way to do this: read in new
1618
# directories with readdir, rather than stating each one. Same
1619
# level of effort but possibly much less IO. (Or possibly not,
1620
# if the directories are very large...)
1621
_see_also = ['status', 'ls']
1622
takes_options = ['show-ids']
1625
def run(self, show_ids=False):
1626
tree = WorkingTree.open_containing(u'.')[0]
1629
old = tree.basis_tree()
1632
for path, ie in old.inventory.iter_entries():
1633
if not tree.has_id(ie.file_id):
1634
self.outf.write(path)
1636
self.outf.write(' ')
1637
self.outf.write(ie.file_id)
1638
self.outf.write('\n')
1645
class cmd_modified(Command):
1646
"""List files modified in working tree.
1650
_see_also = ['status', 'ls']
1653
help='Write an ascii NUL (\\0) separator '
1654
'between files rather than a newline.')
1658
def run(self, null=False):
1659
tree = WorkingTree.open_containing(u'.')[0]
1660
td = tree.changes_from(tree.basis_tree())
1661
for path, id, kind, text_modified, meta_modified in td.modified:
1663
self.outf.write(path + '\0')
1665
self.outf.write(osutils.quotefn(path) + '\n')
1668
class cmd_added(Command):
1669
"""List files added in working tree.
1673
_see_also = ['status', 'ls']
1676
help='Write an ascii NUL (\\0) separator '
1677
'between files rather than a newline.')
1681
def run(self, null=False):
1682
wt = WorkingTree.open_containing(u'.')[0]
1685
basis = wt.basis_tree()
1688
basis_inv = basis.inventory
1691
if file_id in basis_inv:
1693
if inv.is_root(file_id) and len(basis_inv) == 0:
1695
path = inv.id2path(file_id)
1696
if not os.access(osutils.abspath(path), os.F_OK):
1699
self.outf.write(path + '\0')
1701
self.outf.write(osutils.quotefn(path) + '\n')
1708
class cmd_root(Command):
1709
"""Show the tree root directory.
1711
The root is the nearest enclosing directory with a .bzr control
1714
takes_args = ['filename?']
1716
def run(self, filename=None):
1717
"""Print the branch root."""
1718
tree = WorkingTree.open_containing(filename)[0]
1719
self.outf.write(tree.basedir + '\n')
1722
def _parse_limit(limitstring):
1724
return int(limitstring)
1726
msg = "The limit argument must be an integer."
1727
raise errors.BzrCommandError(msg)
1730
class cmd_log(Command):
1731
"""Show log of a branch, file, or directory.
1733
By default show the log of the branch containing the working directory.
1735
To request a range of logs, you can use the command -r begin..end
1736
-r revision requests a specific revision, -r ..end or -r begin.. are
1740
Log the current branch::
1748
Log the last 10 revisions of a branch::
1750
bzr log -r -10.. http://server/branch
1753
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1755
takes_args = ['location?']
1758
help='Show from oldest to newest.'),
1760
custom_help('verbose',
1761
help='Show files changed in each revision.'),
1765
type=bzrlib.option._parse_revision_str,
1767
help='Show just the specified revision.'
1768
' See also "help revisionspec".'),
1772
help='Show revisions whose message matches this '
1773
'regular expression.',
1777
help='Limit the output to the first N revisions.',
1781
encoding_type = 'replace'
1784
def run(self, location=None, timezone='original',
1793
from bzrlib.log import show_log
1794
direction = (forward and 'forward') or 'reverse'
1796
if change is not None:
1798
raise errors.RangeInChangeOption()
1799
if revision is not None:
1800
raise errors.BzrCommandError(
1801
'--revision and --change are mutually exclusive')
1808
# find the file id to log:
1810
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1814
tree = b.basis_tree()
1815
file_id = tree.path2id(fp)
1817
raise errors.BzrCommandError(
1818
"Path does not have any revision history: %s" %
1822
# FIXME ? log the current subdir only RBC 20060203
1823
if revision is not None \
1824
and len(revision) > 0 and revision[0].get_branch():
1825
location = revision[0].get_branch()
1828
dir, relpath = bzrdir.BzrDir.open_containing(location)
1829
b = dir.open_branch()
1833
if revision is None:
1836
elif len(revision) == 1:
1837
rev1 = rev2 = revision[0].in_history(b)
1838
elif len(revision) == 2:
1839
if revision[1].get_branch() != revision[0].get_branch():
1840
# b is taken from revision[0].get_branch(), and
1841
# show_log will use its revision_history. Having
1842
# different branches will lead to weird behaviors.
1843
raise errors.BzrCommandError(
1844
"Log doesn't accept two revisions in different"
1846
rev1 = revision[0].in_history(b)
1847
rev2 = revision[1].in_history(b)
1849
raise errors.BzrCommandError(
1850
'bzr log --revision takes one or two values.')
1852
if log_format is None:
1853
log_format = log.log_formatter_registry.get_default(b)
1855
lf = log_format(show_ids=show_ids, to_file=self.outf,
1856
show_timezone=timezone)
1862
direction=direction,
1863
start_revision=rev1,
1871
def get_log_format(long=False, short=False, line=False, default='long'):
1872
log_format = default
1876
log_format = 'short'
1882
class cmd_touching_revisions(Command):
1883
"""Return revision-ids which affected a particular file.
1885
A more user-friendly interface is "bzr log FILE".
1889
takes_args = ["filename"]
1892
def run(self, filename):
1893
tree, relpath = WorkingTree.open_containing(filename)
1895
file_id = tree.path2id(relpath)
1896
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1897
self.outf.write("%6d %s\n" % (revno, what))
1900
class cmd_ls(Command):
1901
"""List files in a tree.
1904
_see_also = ['status', 'cat']
1905
takes_args = ['path?']
1906
# TODO: Take a revision or remote path and list that tree instead.
1910
Option('non-recursive',
1911
help='Don\'t recurse into subdirectories.'),
1913
help='Print paths relative to the root of the branch.'),
1914
Option('unknown', help='Print unknown files.'),
1915
Option('versioned', help='Print versioned files.',
1917
Option('ignored', help='Print ignored files.'),
1919
help='Write an ascii NUL (\\0) separator '
1920
'between files rather than a newline.'),
1922
help='List entries of a particular kind: file, directory, symlink.',
1927
def run(self, revision=None, verbose=False,
1928
non_recursive=False, from_root=False,
1929
unknown=False, versioned=False, ignored=False,
1930
null=False, kind=None, show_ids=False, path=None):
1932
if kind and kind not in ('file', 'directory', 'symlink'):
1933
raise errors.BzrCommandError('invalid kind specified')
1935
if verbose and null:
1936
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1937
all = not (unknown or versioned or ignored)
1939
selection = {'I':ignored, '?':unknown, 'V':versioned}
1946
raise errors.BzrCommandError('cannot specify both --from-root'
1950
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1956
if revision is not None or tree is None:
1957
tree = _get_one_revision_tree('ls', revision, branch=branch)
1961
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1962
if fp.startswith(relpath):
1963
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1964
if non_recursive and '/' in fp:
1966
if not all and not selection[fc]:
1968
if kind is not None and fkind != kind:
1971
kindch = entry.kind_character()
1972
outstring = '%-8s %s%s' % (fc, fp, kindch)
1973
if show_ids and fid is not None:
1974
outstring = "%-50s %s" % (outstring, fid)
1975
self.outf.write(outstring + '\n')
1977
self.outf.write(fp + '\0')
1980
self.outf.write(fid)
1981
self.outf.write('\0')
1989
self.outf.write('%-50s %s\n' % (fp, my_id))
1991
self.outf.write(fp + '\n')
1996
class cmd_unknowns(Command):
1997
"""List unknown files.
2005
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2006
self.outf.write(osutils.quotefn(f) + '\n')
2009
class cmd_ignore(Command):
2010
"""Ignore specified files or patterns.
2012
See ``bzr help patterns`` for details on the syntax of patterns.
2014
To remove patterns from the ignore list, edit the .bzrignore file.
2015
After adding, editing or deleting that file either indirectly by
2016
using this command or directly by using an editor, be sure to commit
2019
Note: ignore patterns containing shell wildcards must be quoted from
2023
Ignore the top level Makefile::
2025
bzr ignore ./Makefile
2027
Ignore class files in all directories::
2029
bzr ignore "*.class"
2031
Ignore .o files under the lib directory::
2033
bzr ignore "lib/**/*.o"
2035
Ignore .o files under the lib directory::
2037
bzr ignore "RE:lib/.*\.o"
2039
Ignore everything but the "debian" toplevel directory::
2041
bzr ignore "RE:(?!debian/).*"
2044
_see_also = ['status', 'ignored', 'patterns']
2045
takes_args = ['name_pattern*']
2047
Option('old-default-rules',
2048
help='Write out the ignore rules bzr < 0.9 always used.')
2051
def run(self, name_pattern_list=None, old_default_rules=None):
2052
from bzrlib import ignores
2053
if old_default_rules is not None:
2054
# dump the rules and exit
2055
for pattern in ignores.OLD_DEFAULTS:
2058
if not name_pattern_list:
2059
raise errors.BzrCommandError("ignore requires at least one "
2060
"NAME_PATTERN or --old-default-rules")
2061
name_pattern_list = [globbing.normalize_pattern(p)
2062
for p in name_pattern_list]
2063
for name_pattern in name_pattern_list:
2064
if (name_pattern[0] == '/' or
2065
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2066
raise errors.BzrCommandError(
2067
"NAME_PATTERN should not be an absolute path")
2068
tree, relpath = WorkingTree.open_containing(u'.')
2069
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2070
ignored = globbing.Globster(name_pattern_list)
2073
for entry in tree.list_files():
2077
if ignored.match(filename):
2078
matches.append(filename.encode('utf-8'))
2080
if len(matches) > 0:
2081
print "Warning: the following files are version controlled and" \
2082
" match your ignore pattern:\n%s" % ("\n".join(matches),)
2085
class cmd_ignored(Command):
2086
"""List ignored files and the patterns that matched them.
2088
List all the ignored files and the ignore pattern that caused the file to
2091
Alternatively, to list just the files::
2096
encoding_type = 'replace'
2097
_see_also = ['ignore', 'ls']
2101
tree = WorkingTree.open_containing(u'.')[0]
2104
for path, file_class, kind, file_id, entry in tree.list_files():
2105
if file_class != 'I':
2107
## XXX: Slightly inefficient since this was already calculated
2108
pat = tree.is_ignored(path)
2109
self.outf.write('%-50s %s\n' % (path, pat))
2114
class cmd_lookup_revision(Command):
2115
"""Lookup the revision-id from a revision-number
2118
bzr lookup-revision 33
2121
takes_args = ['revno']
2124
def run(self, revno):
2128
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2130
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2133
class cmd_export(Command):
2134
"""Export current or past revision to a destination directory or archive.
2136
If no revision is specified this exports the last committed revision.
2138
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2139
given, try to find the format with the extension. If no extension
2140
is found exports to a directory (equivalent to --format=dir).
2142
If root is supplied, it will be used as the root directory inside
2143
container formats (tar, zip, etc). If it is not supplied it will default
2144
to the exported filename. The root option has no effect for 'dir' format.
2146
If branch is omitted then the branch containing the current working
2147
directory will be used.
2149
Note: Export of tree with non-ASCII filenames to zip is not supported.
2151
================= =========================
2152
Supported formats Autodetected by extension
2153
================= =========================
2156
tbz2 .tar.bz2, .tbz2
2159
================= =========================
2161
takes_args = ['dest', 'branch_or_subdir?']
2164
help="Type of file to export to.",
2169
help="Name of the root directory inside the exported file."),
2171
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2173
from bzrlib.export import export
2175
if branch_or_subdir is None:
2176
tree = WorkingTree.open_containing(u'.')[0]
2180
b, subdir = Branch.open_containing(branch_or_subdir)
2183
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2185
export(rev_tree, dest, format, root, subdir)
2186
except errors.NoSuchExportFormat, e:
2187
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2190
class cmd_cat(Command):
2191
"""Write the contents of a file as of a given revision to standard output.
2193
If no revision is nominated, the last revision is used.
2195
Note: Take care to redirect standard output when using this command on a
2201
Option('name-from-revision', help='The path name in the old tree.'),
2204
takes_args = ['filename']
2205
encoding_type = 'exact'
2208
def run(self, filename, revision=None, name_from_revision=False):
2209
if revision is not None and len(revision) != 1:
2210
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2211
" one revision specifier")
2212
tree, branch, relpath = \
2213
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2216
return self._run(tree, branch, relpath, filename, revision,
2221
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2223
tree = b.basis_tree()
2224
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2226
cur_file_id = tree.path2id(relpath)
2227
old_file_id = rev_tree.path2id(relpath)
2229
if name_from_revision:
2230
if old_file_id is None:
2231
raise errors.BzrCommandError(
2232
"%r is not present in revision %s" % (
2233
filename, rev_tree.get_revision_id()))
2235
content = rev_tree.get_file_text(old_file_id)
2236
elif cur_file_id is not None:
2237
content = rev_tree.get_file_text(cur_file_id)
2238
elif old_file_id is not None:
2239
content = rev_tree.get_file_text(old_file_id)
2241
raise errors.BzrCommandError(
2242
"%r is not present in revision %s" % (
2243
filename, rev_tree.get_revision_id()))
2244
self.outf.write(content)
2247
class cmd_local_time_offset(Command):
2248
"""Show the offset in seconds from GMT to local time."""
2252
print osutils.local_time_offset()
2256
class cmd_commit(Command):
2257
"""Commit changes into a new revision.
2259
If no arguments are given, the entire tree is committed.
2261
If selected files are specified, only changes to those files are
2262
committed. If a directory is specified then the directory and everything
2263
within it is committed.
2265
When excludes are given, they take precedence over selected files.
2266
For example, too commit only changes within foo, but not changes within
2269
bzr commit foo -x foo/bar
2271
If author of the change is not the same person as the committer, you can
2272
specify the author's name using the --author option. The name should be
2273
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2275
A selected-file commit may fail in some cases where the committed
2276
tree would be invalid. Consider::
2281
bzr commit foo -m "committing foo"
2282
bzr mv foo/bar foo/baz
2285
bzr commit foo/bar -m "committing bar but not baz"
2287
In the example above, the last commit will fail by design. This gives
2288
the user the opportunity to decide whether they want to commit the
2289
rename at the same time, separately first, or not at all. (As a general
2290
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2292
Note: A selected-file commit after a merge is not yet supported.
2294
# TODO: Run hooks on tree to-be-committed, and after commit.
2296
# TODO: Strict commit that fails if there are deleted files.
2297
# (what does "deleted files" mean ??)
2299
# TODO: Give better message for -s, --summary, used by tla people
2301
# XXX: verbose currently does nothing
2303
_see_also = ['bugs', 'uncommit']
2304
takes_args = ['selected*']
2306
ListOption('exclude', type=str, short_name='x',
2307
help="Do not consider changes made to a given path."),
2308
Option('message', type=unicode,
2310
help="Description of the new revision."),
2313
help='Commit even if nothing has changed.'),
2314
Option('file', type=str,
2317
help='Take commit message from this file.'),
2319
help="Refuse to commit if there are unknown "
2320
"files in the working tree."),
2321
ListOption('fixes', type=str,
2322
help="Mark a bug as being fixed by this revision."),
2323
Option('author', type=unicode,
2324
help="Set the author's name, if it's different "
2325
"from the committer."),
2327
help="Perform a local commit in a bound "
2328
"branch. Local commits are not pushed to "
2329
"the master branch until a normal commit "
2333
help='When no message is supplied, show the diff along'
2334
' with the status summary in the message editor.'),
2336
aliases = ['ci', 'checkin']
2338
def _get_bug_fix_properties(self, fixes, branch):
2340
# Configure the properties for bug fixing attributes.
2341
for fixed_bug in fixes:
2342
tokens = fixed_bug.split(':')
2343
if len(tokens) != 2:
2344
raise errors.BzrCommandError(
2345
"Invalid bug %s. Must be in the form of 'tag:id'. "
2346
"Commit refused." % fixed_bug)
2347
tag, bug_id = tokens
2349
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2350
except errors.UnknownBugTrackerAbbreviation:
2351
raise errors.BzrCommandError(
2352
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2353
except errors.MalformedBugIdentifier:
2354
raise errors.BzrCommandError(
2355
"Invalid bug identifier for %s. Commit refused."
2357
properties.append('%s fixed' % bug_url)
2358
return '\n'.join(properties)
2360
def run(self, message=None, file=None, verbose=False, selected_list=None,
2361
unchanged=False, strict=False, local=False, fixes=None,
2362
author=None, show_diff=False, exclude=None):
2363
from bzrlib.errors import (
2368
from bzrlib.msgeditor import (
2369
edit_commit_message_encoded,
2370
make_commit_message_template_encoded
2373
# TODO: Need a blackbox test for invoking the external editor; may be
2374
# slightly problematic to run this cross-platform.
2376
# TODO: do more checks that the commit will succeed before
2377
# spending the user's valuable time typing a commit message.
2381
tree, selected_list = tree_files(selected_list)
2382
if selected_list == ['']:
2383
# workaround - commit of root of tree should be exactly the same
2384
# as just default commit in that tree, and succeed even though
2385
# selected-file merge commit is not done yet
2390
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2392
properties['bugs'] = bug_property
2394
if local and not tree.branch.get_bound_location():
2395
raise errors.LocalRequiresBoundBranch()
2397
def get_message(commit_obj):
2398
"""Callback to get commit message"""
2399
my_message = message
2400
if my_message is None and not file:
2401
t = make_commit_message_template_encoded(tree,
2402
selected_list, diff=show_diff,
2403
output_encoding=osutils.get_user_encoding())
2404
my_message = edit_commit_message_encoded(t)
2405
if my_message is None:
2406
raise errors.BzrCommandError("please specify a commit"
2407
" message with either --message or --file")
2408
elif my_message and file:
2409
raise errors.BzrCommandError(
2410
"please specify either --message or --file")
2412
my_message = codecs.open(file, 'rt',
2413
osutils.get_user_encoding()).read()
2414
if my_message == "":
2415
raise errors.BzrCommandError("empty commit message specified")
2419
tree.commit(message_callback=get_message,
2420
specific_files=selected_list,
2421
allow_pointless=unchanged, strict=strict, local=local,
2422
reporter=None, verbose=verbose, revprops=properties,
2424
exclude=safe_relpath_files(tree, exclude))
2425
except PointlessCommit:
2426
# FIXME: This should really happen before the file is read in;
2427
# perhaps prepare the commit; get the message; then actually commit
2428
raise errors.BzrCommandError("no changes to commit."
2429
" use --unchanged to commit anyhow")
2430
except ConflictsInTree:
2431
raise errors.BzrCommandError('Conflicts detected in working '
2432
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2434
except StrictCommitFailed:
2435
raise errors.BzrCommandError("Commit refused because there are"
2436
" unknown files in the working tree.")
2437
except errors.BoundBranchOutOfDate, e:
2438
raise errors.BzrCommandError(str(e) + "\n"
2439
'To commit to master branch, run update and then commit.\n'
2440
'You can also pass --local to commit to continue working '
2444
class cmd_check(Command):
2445
"""Validate working tree structure, branch consistency and repository history.
2447
This command checks various invariants about branch and repository storage
2448
to detect data corruption or bzr bugs.
2450
The working tree and branch checks will only give output if a problem is
2451
detected. The output fields of the repository check are:
2453
revisions: This is just the number of revisions checked. It doesn't
2455
versionedfiles: This is just the number of versionedfiles checked. It
2456
doesn't indicate a problem.
2457
unreferenced ancestors: Texts that are ancestors of other texts, but
2458
are not properly referenced by the revision ancestry. This is a
2459
subtle problem that Bazaar can work around.
2460
unique file texts: This is the total number of unique file contents
2461
seen in the checked revisions. It does not indicate a problem.
2462
repeated file texts: This is the total number of repeated texts seen
2463
in the checked revisions. Texts can be repeated when their file
2464
entries are modified, but the file contents are not. It does not
2467
If no restrictions are specified, all Bazaar data that is found at the given
2468
location will be checked.
2472
Check the tree and branch at 'foo'::
2474
bzr check --tree --branch foo
2476
Check only the repository at 'bar'::
2478
bzr check --repo bar
2480
Check everything at 'baz'::
2485
_see_also = ['reconcile']
2486
takes_args = ['path?']
2487
takes_options = ['verbose',
2488
Option('branch', help="Check the branch related to the"
2489
" current directory."),
2490
Option('repo', help="Check the repository related to the"
2491
" current directory."),
2492
Option('tree', help="Check the working tree related to"
2493
" the current directory.")]
2495
def run(self, path=None, verbose=False, branch=False, repo=False,
2497
from bzrlib.check import check_dwim
2500
if not branch and not repo and not tree:
2501
branch = repo = tree = True
2502
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2505
class cmd_upgrade(Command):
2506
"""Upgrade branch storage to current format.
2508
The check command or bzr developers may sometimes advise you to run
2509
this command. When the default format has changed you may also be warned
2510
during other operations to upgrade.
2513
_see_also = ['check']
2514
takes_args = ['url?']
2516
RegistryOption('format',
2517
help='Upgrade to a specific format. See "bzr help'
2518
' formats" for details.',
2519
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
2520
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
2521
value_switches=True, title='Branch format'),
2524
def run(self, url='.', format=None):
2525
from bzrlib.upgrade import upgrade
2527
format = bzrdir.format_registry.make_bzrdir('default')
2528
upgrade(url, format)
2531
class cmd_whoami(Command):
2532
"""Show or set bzr user id.
2535
Show the email of the current user::
2539
Set the current user::
2541
bzr whoami "Frank Chu <fchu@example.com>"
2543
takes_options = [ Option('email',
2544
help='Display email address only.'),
2546
help='Set identity for the current branch instead of '
2549
takes_args = ['name?']
2550
encoding_type = 'replace'
2553
def run(self, email=False, branch=False, name=None):
2555
# use branch if we're inside one; otherwise global config
2557
c = Branch.open_containing('.')[0].get_config()
2558
except errors.NotBranchError:
2559
c = config.GlobalConfig()
2561
self.outf.write(c.user_email() + '\n')
2563
self.outf.write(c.username() + '\n')
2566
# display a warning if an email address isn't included in the given name.
2568
config.extract_email_address(name)
2569
except errors.NoEmailInUsername, e:
2570
warning('"%s" does not seem to contain an email address. '
2571
'This is allowed, but not recommended.', name)
2573
# use global config unless --branch given
2575
c = Branch.open_containing('.')[0].get_config()
2577
c = config.GlobalConfig()
2578
c.set_user_option('email', name)
2581
class cmd_nick(Command):
2582
"""Print or set the branch nickname.
2584
If unset, the tree root directory name is used as the nickname
2585
To print the current nickname, execute with no argument.
2588
_see_also = ['info']
2589
takes_args = ['nickname?']
2590
def run(self, nickname=None):
2591
branch = Branch.open_containing(u'.')[0]
2592
if nickname is None:
2593
self.printme(branch)
2595
branch.nick = nickname
2598
def printme(self, branch):
2602
class cmd_alias(Command):
2603
"""Set/unset and display aliases.
2606
Show the current aliases::
2610
Show the alias specified for 'll'::
2614
Set an alias for 'll'::
2616
bzr alias ll="log --line -r-10..-1"
2618
To remove an alias for 'll'::
2620
bzr alias --remove ll
2623
takes_args = ['name?']
2625
Option('remove', help='Remove the alias.'),
2628
def run(self, name=None, remove=False):
2630
self.remove_alias(name)
2632
self.print_aliases()
2634
equal_pos = name.find('=')
2636
self.print_alias(name)
2638
self.set_alias(name[:equal_pos], name[equal_pos+1:])
2640
def remove_alias(self, alias_name):
2641
if alias_name is None:
2642
raise errors.BzrCommandError(
2643
'bzr alias --remove expects an alias to remove.')
2644
# If alias is not found, print something like:
2645
# unalias: foo: not found
2646
c = config.GlobalConfig()
2647
c.unset_alias(alias_name)
2650
def print_aliases(self):
2651
"""Print out the defined aliases in a similar format to bash."""
2652
aliases = config.GlobalConfig().get_aliases()
2653
for key, value in sorted(aliases.iteritems()):
2654
self.outf.write('bzr alias %s="%s"\n' % (key, value))
2657
def print_alias(self, alias_name):
2658
from bzrlib.commands import get_alias
2659
alias = get_alias(alias_name)
2661
self.outf.write("bzr alias: %s: not found\n" % alias_name)
2664
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
2666
def set_alias(self, alias_name, alias_command):
2667
"""Save the alias in the global config."""
2668
c = config.GlobalConfig()
2669
c.set_alias(alias_name, alias_command)
2672
class cmd_selftest(Command):
2673
"""Run internal test suite.
2675
If arguments are given, they are regular expressions that say which tests
2676
should run. Tests matching any expression are run, and other tests are
2679
Alternatively if --first is given, matching tests are run first and then
2680
all other tests are run. This is useful if you have been working in a
2681
particular area, but want to make sure nothing else was broken.
2683
If --exclude is given, tests that match that regular expression are
2684
excluded, regardless of whether they match --first or not.
2686
To help catch accidential dependencies between tests, the --randomize
2687
option is useful. In most cases, the argument used is the word 'now'.
2688
Note that the seed used for the random number generator is displayed
2689
when this option is used. The seed can be explicitly passed as the
2690
argument to this option if required. This enables reproduction of the
2691
actual ordering used if and when an order sensitive problem is encountered.
2693
If --list-only is given, the tests that would be run are listed. This is
2694
useful when combined with --first, --exclude and/or --randomize to
2695
understand their impact. The test harness reports "Listed nn tests in ..."
2696
instead of "Ran nn tests in ..." when list mode is enabled.
2698
If the global option '--no-plugins' is given, plugins are not loaded
2699
before running the selftests. This has two effects: features provided or
2700
modified by plugins will not be tested, and tests provided by plugins will
2703
Tests that need working space on disk use a common temporary directory,
2704
typically inside $TMPDIR or /tmp.
2707
Run only tests relating to 'ignore'::
2711
Disable plugins and list tests as they're run::
2713
bzr --no-plugins selftest -v
2715
# NB: this is used from the class without creating an instance, which is
2716
# why it does not have a self parameter.
2717
def get_transport_type(typestring):
2718
"""Parse and return a transport specifier."""
2719
if typestring == "sftp":
2720
from bzrlib.transport.sftp import SFTPAbsoluteServer
2721
return SFTPAbsoluteServer
2722
if typestring == "memory":
2723
from bzrlib.transport.memory import MemoryServer
2725
if typestring == "fakenfs":
2726
from bzrlib.transport.fakenfs import FakeNFSServer
2727
return FakeNFSServer
2728
msg = "No known transport type %s. Supported types are: sftp\n" %\
2730
raise errors.BzrCommandError(msg)
2733
takes_args = ['testspecs*']
2734
takes_options = ['verbose',
2736
help='Stop when one test fails.',
2740
help='Use a different transport by default '
2741
'throughout the test suite.',
2742
type=get_transport_type),
2744
help='Run the benchmarks rather than selftests.'),
2745
Option('lsprof-timed',
2746
help='Generate lsprof output for benchmarked'
2747
' sections of code.'),
2748
Option('cache-dir', type=str,
2749
help='Cache intermediate benchmark output in this '
2752
help='Run all tests, but run specified tests first.',
2756
help='List the tests instead of running them.'),
2757
Option('randomize', type=str, argname="SEED",
2758
help='Randomize the order of tests using the given'
2759
' seed or "now" for the current time.'),
2760
Option('exclude', type=str, argname="PATTERN",
2762
help='Exclude tests that match this regular'
2764
Option('strict', help='Fail on missing dependencies or '
2766
Option('load-list', type=str, argname='TESTLISTFILE',
2767
help='Load a test id list from a text file.'),
2768
ListOption('debugflag', type=str, short_name='E',
2769
help='Turn on a selftest debug flag.'),
2770
ListOption('starting-with', type=str, argname='TESTID',
2771
param_name='starting_with', short_name='s',
2773
'Load only the tests starting with TESTID.'),
2775
encoding_type = 'replace'
2777
def run(self, testspecs_list=None, verbose=False, one=False,
2778
transport=None, benchmark=None,
2779
lsprof_timed=None, cache_dir=None,
2780
first=False, list_only=False,
2781
randomize=None, exclude=None, strict=False,
2782
load_list=None, debugflag=None, starting_with=None):
2783
from bzrlib.tests import selftest
2784
import bzrlib.benchmarks as benchmarks
2785
from bzrlib.benchmarks import tree_creator
2787
# Make deprecation warnings visible, unless -Werror is set
2788
symbol_versioning.activate_deprecation_warnings(override=False)
2790
if cache_dir is not None:
2791
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2793
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2794
print ' %s (%s python%s)' % (
2796
bzrlib.version_string,
2797
bzrlib._format_version_tuple(sys.version_info),
2800
if testspecs_list is not None:
2801
pattern = '|'.join(testspecs_list)
2805
test_suite_factory = benchmarks.test_suite
2806
# Unless user explicitly asks for quiet, be verbose in benchmarks
2807
verbose = not is_quiet()
2808
# TODO: should possibly lock the history file...
2809
benchfile = open(".perf_history", "at", buffering=1)
2811
test_suite_factory = None
2814
result = selftest(verbose=verbose,
2816
stop_on_failure=one,
2817
transport=transport,
2818
test_suite_factory=test_suite_factory,
2819
lsprof_timed=lsprof_timed,
2820
bench_history=benchfile,
2821
matching_tests_first=first,
2822
list_only=list_only,
2823
random_seed=randomize,
2824
exclude_pattern=exclude,
2826
load_list=load_list,
2827
debug_flags=debugflag,
2828
starting_with=starting_with,
2831
if benchfile is not None:
2834
note('tests passed')
2836
note('tests failed')
2837
return int(not result)
2840
class cmd_version(Command):
2841
"""Show version of bzr."""
2843
encoding_type = 'replace'
2845
Option("short", help="Print just the version number."),
2849
def run(self, short=False):
2850
from bzrlib.version import show_version
2852
self.outf.write(bzrlib.version_string + '\n')
2854
show_version(to_file=self.outf)
2857
class cmd_rocks(Command):
2858
"""Statement of optimism."""
2864
print "It sure does!"
2867
class cmd_find_merge_base(Command):
2868
"""Find and print a base revision for merging two branches."""
2869
# TODO: Options to specify revisions on either side, as if
2870
# merging only part of the history.
2871
takes_args = ['branch', 'other']
2875
def run(self, branch, other):
2876
from bzrlib.revision import ensure_null
2878
branch1 = Branch.open_containing(branch)[0]
2879
branch2 = Branch.open_containing(other)[0]
2884
last1 = ensure_null(branch1.last_revision())
2885
last2 = ensure_null(branch2.last_revision())
2887
graph = branch1.repository.get_graph(branch2.repository)
2888
base_rev_id = graph.find_unique_lca(last1, last2)
2890
print 'merge base is revision %s' % base_rev_id
2897
class cmd_merge(Command):
2898
"""Perform a three-way merge.
2900
The source of the merge can be specified either in the form of a branch,
2901
or in the form of a path to a file containing a merge directive generated
2902
with bzr send. If neither is specified, the default is the upstream branch
2903
or the branch most recently merged using --remember.
2905
When merging a branch, by default the tip will be merged. To pick a different
2906
revision, pass --revision. If you specify two values, the first will be used as
2907
BASE and the second one as OTHER. Merging individual revisions, or a subset of
2908
available revisions, like this is commonly referred to as "cherrypicking".
2910
Revision numbers are always relative to the branch being merged.
2912
By default, bzr will try to merge in all new work from the other
2913
branch, automatically determining an appropriate base. If this
2914
fails, you may need to give an explicit base.
2916
Merge will do its best to combine the changes in two branches, but there
2917
are some kinds of problems only a human can fix. When it encounters those,
2918
it will mark a conflict. A conflict means that you need to fix something,
2919
before you should commit.
2921
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2923
If there is no default branch set, the first merge will set it. After
2924
that, you can omit the branch to use the default. To change the
2925
default, use --remember. The value will only be saved if the remote
2926
location can be accessed.
2928
The results of the merge are placed into the destination working
2929
directory, where they can be reviewed (with bzr diff), tested, and then
2930
committed to record the result of the merge.
2932
merge refuses to run if there are any uncommitted changes, unless
2936
To merge the latest revision from bzr.dev::
2938
bzr merge ../bzr.dev
2940
To merge changes up to and including revision 82 from bzr.dev::
2942
bzr merge -r 82 ../bzr.dev
2944
To merge the changes introduced by 82, without previous changes::
2946
bzr merge -r 81..82 ../bzr.dev
2948
To apply a merge directive contained in in /tmp/merge:
2950
bzr merge /tmp/merge
2953
encoding_type = 'exact'
2954
_see_also = ['update', 'remerge', 'status-flags']
2955
takes_args = ['location?']
2960
help='Merge even if the destination tree has uncommitted changes.'),
2964
Option('show-base', help="Show base revision text in "
2966
Option('uncommitted', help='Apply uncommitted changes'
2967
' from a working copy, instead of branch changes.'),
2968
Option('pull', help='If the destination is already'
2969
' completely merged into the source, pull from the'
2970
' source rather than merging. When this happens,'
2971
' you do not need to commit the result.'),
2973
help='Branch to merge into, '
2974
'rather than the one containing the working directory.',
2978
Option('preview', help='Instead of merging, show a diff of the merge.')
2981
def run(self, location=None, revision=None, force=False,
2982
merge_type=None, show_base=False, reprocess=None, remember=False,
2983
uncommitted=False, pull=False,
2987
if merge_type is None:
2988
merge_type = _mod_merge.Merge3Merger
2990
if directory is None: directory = u'.'
2991
possible_transports = []
2993
allow_pending = True
2994
verified = 'inapplicable'
2995
tree = WorkingTree.open_containing(directory)[0]
2996
change_reporter = delta._ChangeReporter(
2997
unversioned_filter=tree.is_ignored)
3000
pb = ui.ui_factory.nested_progress_bar()
3001
cleanups.append(pb.finished)
3003
cleanups.append(tree.unlock)
3004
if location is not None:
3006
mergeable = bundle.read_mergeable_from_url(location,
3007
possible_transports=possible_transports)
3008
except errors.NotABundle:
3012
raise errors.BzrCommandError('Cannot use --uncommitted'
3013
' with bundles or merge directives.')
3015
if revision is not None:
3016
raise errors.BzrCommandError(
3017
'Cannot use -r with merge directives or bundles')
3018
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3021
if merger is None and uncommitted:
3022
if revision is not None and len(revision) > 0:
3023
raise errors.BzrCommandError('Cannot use --uncommitted and'
3024
' --revision at the same time.')
3025
location = self._select_branch_location(tree, location)[0]
3026
other_tree, other_path = WorkingTree.open_containing(location)
3027
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
3029
allow_pending = False
3030
if other_path != '':
3031
merger.interesting_files = [other_path]
3034
merger, allow_pending = self._get_merger_from_branch(tree,
3035
location, revision, remember, possible_transports, pb)
3037
merger.merge_type = merge_type
3038
merger.reprocess = reprocess
3039
merger.show_base = show_base
3040
self.sanity_check_merger(merger)
3041
if (merger.base_rev_id == merger.other_rev_id and
3042
merger.other_rev_id is not None):
3043
note('Nothing to do.')
3046
if merger.interesting_files is not None:
3047
raise errors.BzrCommandError('Cannot pull individual files')
3048
if (merger.base_rev_id == tree.last_revision()):
3049
result = tree.pull(merger.other_branch, False,
3050
merger.other_rev_id)
3051
result.report(self.outf)
3053
merger.check_basis(not force)
3055
return self._do_preview(merger)
3057
return self._do_merge(merger, change_reporter, allow_pending,
3060
for cleanup in reversed(cleanups):
3063
def _do_preview(self, merger):
3064
from bzrlib.diff import show_diff_trees
3065
tree_merger = merger.make_merger()
3066
tt = tree_merger.make_preview_transform()
3068
result_tree = tt.get_preview_tree()
3069
show_diff_trees(merger.this_tree, result_tree, self.outf,
3070
old_label='', new_label='')
3074
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3075
merger.change_reporter = change_reporter
3076
conflict_count = merger.do_merge()
3078
merger.set_pending()
3079
if verified == 'failed':
3080
warning('Preview patch does not match changes')
3081
if conflict_count != 0:
3086
def sanity_check_merger(self, merger):
3087
if (merger.show_base and
3088
not merger.merge_type is _mod_merge.Merge3Merger):
3089
raise errors.BzrCommandError("Show-base is not supported for this"
3090
" merge type. %s" % merger.merge_type)
3091
if merger.reprocess is None:
3092
if merger.show_base:
3093
merger.reprocess = False
3095
# Use reprocess if the merger supports it
3096
merger.reprocess = merger.merge_type.supports_reprocess
3097
if merger.reprocess and not merger.merge_type.supports_reprocess:
3098
raise errors.BzrCommandError("Conflict reduction is not supported"
3099
" for merge type %s." %
3101
if merger.reprocess and merger.show_base:
3102
raise errors.BzrCommandError("Cannot do conflict reduction and"
3105
def _get_merger_from_branch(self, tree, location, revision, remember,
3106
possible_transports, pb):
3107
"""Produce a merger from a location, assuming it refers to a branch."""
3108
from bzrlib.tag import _merge_tags_if_possible
3109
# find the branch locations
3110
other_loc, user_location = self._select_branch_location(tree, location,
3112
if revision is not None and len(revision) == 2:
3113
base_loc, _unused = self._select_branch_location(tree,
3114
location, revision, 0)
3116
base_loc = other_loc
3118
other_branch, other_path = Branch.open_containing(other_loc,
3119
possible_transports)
3120
if base_loc == other_loc:
3121
base_branch = other_branch
3123
base_branch, base_path = Branch.open_containing(base_loc,
3124
possible_transports)
3125
# Find the revision ids
3126
if revision is None or len(revision) < 1 or revision[-1] is None:
3127
other_revision_id = _mod_revision.ensure_null(
3128
other_branch.last_revision())
3130
other_revision_id = revision[-1].as_revision_id(other_branch)
3131
if (revision is not None and len(revision) == 2
3132
and revision[0] is not None):
3133
base_revision_id = revision[0].as_revision_id(base_branch)
3135
base_revision_id = None
3136
# Remember where we merge from
3137
if ((remember or tree.branch.get_submit_branch() is None) and
3138
user_location is not None):
3139
tree.branch.set_submit_branch(other_branch.base)
3140
_merge_tags_if_possible(other_branch, tree.branch)
3141
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3142
other_revision_id, base_revision_id, other_branch, base_branch)
3143
if other_path != '':
3144
allow_pending = False
3145
merger.interesting_files = [other_path]
3147
allow_pending = True
3148
return merger, allow_pending
3150
def _select_branch_location(self, tree, user_location, revision=None,
3152
"""Select a branch location, according to possible inputs.
3154
If provided, branches from ``revision`` are preferred. (Both
3155
``revision`` and ``index`` must be supplied.)
3157
Otherwise, the ``location`` parameter is used. If it is None, then the
3158
``submit`` or ``parent`` location is used, and a note is printed.
3160
:param tree: The working tree to select a branch for merging into
3161
:param location: The location entered by the user
3162
:param revision: The revision parameter to the command
3163
:param index: The index to use for the revision parameter. Negative
3164
indices are permitted.
3165
:return: (selected_location, user_location). The default location
3166
will be the user-entered location.
3168
if (revision is not None and index is not None
3169
and revision[index] is not None):
3170
branch = revision[index].get_branch()
3171
if branch is not None:
3172
return branch, branch
3173
if user_location is None:
3174
location = self._get_remembered(tree, 'Merging from')
3176
location = user_location
3177
return location, user_location
3179
def _get_remembered(self, tree, verb_string):
3180
"""Use tree.branch's parent if none was supplied.
3182
Report if the remembered location was used.
3184
stored_location = tree.branch.get_submit_branch()
3185
stored_location_type = "submit"
3186
if stored_location is None:
3187
stored_location = tree.branch.get_parent()
3188
stored_location_type = "parent"
3189
mutter("%s", stored_location)
3190
if stored_location is None:
3191
raise errors.BzrCommandError("No location specified or remembered")
3192
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3193
note(u"%s remembered %s location %s", verb_string,
3194
stored_location_type, display_url)
3195
return stored_location
3198
class cmd_remerge(Command):
3201
Use this if you want to try a different merge technique while resolving
3202
conflicts. Some merge techniques are better than others, and remerge
3203
lets you try different ones on different files.
3205
The options for remerge have the same meaning and defaults as the ones for
3206
merge. The difference is that remerge can (only) be run when there is a
3207
pending merge, and it lets you specify particular files.
3210
Re-do the merge of all conflicted files, and show the base text in
3211
conflict regions, in addition to the usual THIS and OTHER texts::
3213
bzr remerge --show-base
3215
Re-do the merge of "foobar", using the weave merge algorithm, with
3216
additional processing to reduce the size of conflict regions::
3218
bzr remerge --merge-type weave --reprocess foobar
3220
takes_args = ['file*']
3225
help="Show base revision text in conflicts."),
3228
def run(self, file_list=None, merge_type=None, show_base=False,
3230
if merge_type is None:
3231
merge_type = _mod_merge.Merge3Merger
3232
tree, file_list = tree_files(file_list)
3235
parents = tree.get_parent_ids()
3236
if len(parents) != 2:
3237
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3238
" merges. Not cherrypicking or"
3240
repository = tree.branch.repository
3241
interesting_ids = None
3243
conflicts = tree.conflicts()
3244
if file_list is not None:
3245
interesting_ids = set()
3246
for filename in file_list:
3247
file_id = tree.path2id(filename)
3249
raise errors.NotVersionedError(filename)
3250
interesting_ids.add(file_id)
3251
if tree.kind(file_id) != "directory":
3254
for name, ie in tree.inventory.iter_entries(file_id):
3255
interesting_ids.add(ie.file_id)
3256
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3258
# Remerge only supports resolving contents conflicts
3259
allowed_conflicts = ('text conflict', 'contents conflict')
3260
restore_files = [c.path for c in conflicts
3261
if c.typestring in allowed_conflicts]
3262
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3263
tree.set_conflicts(ConflictList(new_conflicts))
3264
if file_list is not None:
3265
restore_files = file_list
3266
for filename in restore_files:
3268
restore(tree.abspath(filename))
3269
except errors.NotConflicted:
3271
# Disable pending merges, because the file texts we are remerging
3272
# have not had those merges performed. If we use the wrong parents
3273
# list, we imply that the working tree text has seen and rejected
3274
# all the changes from the other tree, when in fact those changes
3275
# have not yet been seen.
3276
pb = ui.ui_factory.nested_progress_bar()
3277
tree.set_parent_ids(parents[:1])
3279
merger = _mod_merge.Merger.from_revision_ids(pb,
3281
merger.interesting_ids = interesting_ids
3282
merger.merge_type = merge_type
3283
merger.show_base = show_base
3284
merger.reprocess = reprocess
3285
conflicts = merger.do_merge()
3287
tree.set_parent_ids(parents)
3297
class cmd_revert(Command):
3298
"""Revert files to a previous revision.
3300
Giving a list of files will revert only those files. Otherwise, all files
3301
will be reverted. If the revision is not specified with '--revision', the
3302
last committed revision is used.
3304
To remove only some changes, without reverting to a prior version, use
3305
merge instead. For example, "merge . --revision -2..-3" will remove the
3306
changes introduced by -2, without affecting the changes introduced by -1.
3307
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3309
By default, any files that have been manually changed will be backed up
3310
first. (Files changed only by merge are not backed up.) Backup files have
3311
'.~#~' appended to their name, where # is a number.
3313
When you provide files, you can use their current pathname or the pathname
3314
from the target revision. So you can use revert to "undelete" a file by
3315
name. If you name a directory, all the contents of that directory will be
3318
Any files that have been newly added since that revision will be deleted,
3319
with a backup kept if appropriate. Directories containing unknown files
3320
will not be deleted.
3322
The working tree contains a list of pending merged revisions, which will
3323
be included as parents in the next commit. Normally, revert clears that
3324
list as well as reverting the files. If any files are specified, revert
3325
leaves the pending merge list alone and reverts only the files. Use "bzr
3326
revert ." in the tree root to revert all files but keep the merge record,
3327
and "bzr revert --forget-merges" to clear the pending merge list without
3328
reverting any files.
3331
_see_also = ['cat', 'export']
3334
Option('no-backup', "Do not save backups of reverted files."),
3335
Option('forget-merges',
3336
'Remove pending merge marker, without changing any files.'),
3338
takes_args = ['file*']
3340
def run(self, revision=None, no_backup=False, file_list=None,
3341
forget_merges=None):
3342
tree, file_list = tree_files(file_list)
3346
tree.set_parent_ids(tree.get_parent_ids()[:1])
3348
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3353
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3354
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3355
pb = ui.ui_factory.nested_progress_bar()
3357
tree.revert(file_list, rev_tree, not no_backup, pb,
3358
report_changes=True)
3363
class cmd_assert_fail(Command):
3364
"""Test reporting of assertion failures"""
3365
# intended just for use in testing
3370
raise AssertionError("always fails")
3373
class cmd_help(Command):
3374
"""Show help on a command or other topic.
3377
_see_also = ['topics']
3379
Option('long', 'Show help on all commands.'),
3381
takes_args = ['topic?']
3382
aliases = ['?', '--help', '-?', '-h']
3385
def run(self, topic=None, long=False):
3387
if topic is None and long:
3389
bzrlib.help.help(topic)
3392
class cmd_shell_complete(Command):
3393
"""Show appropriate completions for context.
3395
For a list of all available commands, say 'bzr shell-complete'.
3397
takes_args = ['context?']
3402
def run(self, context=None):
3403
import shellcomplete
3404
shellcomplete.shellcomplete(context)
3407
class cmd_missing(Command):
3408
"""Show unmerged/unpulled revisions between two branches.
3410
OTHER_BRANCH may be local or remote.
3413
_see_also = ['merge', 'pull']
3414
takes_args = ['other_branch?']
3416
Option('reverse', 'Reverse the order of revisions.'),
3418
'Display changes in the local branch only.'),
3419
Option('this' , 'Same as --mine-only.'),
3420
Option('theirs-only',
3421
'Display changes in the remote branch only.'),
3422
Option('other', 'Same as --theirs-only.'),
3426
Option('include-merges', 'Show merged revisions.'),
3428
encoding_type = 'replace'
3431
def run(self, other_branch=None, reverse=False, mine_only=False,
3433
log_format=None, long=False, short=False, line=False,
3434
show_ids=False, verbose=False, this=False, other=False,
3435
include_merges=False):
3436
from bzrlib.missing import find_unmerged, iter_log_revisions
3442
# TODO: We should probably check that we don't have mine-only and
3443
# theirs-only set, but it gets complicated because we also have
3444
# this and other which could be used.
3451
local_branch = Branch.open_containing(u".")[0]
3452
parent = local_branch.get_parent()
3453
if other_branch is None:
3454
other_branch = parent
3455
if other_branch is None:
3456
raise errors.BzrCommandError("No peer location known"
3458
display_url = urlutils.unescape_for_display(parent,
3460
self.outf.write("Using saved parent location: "
3461
+ display_url + "\n")
3463
remote_branch = Branch.open(other_branch)
3464
if remote_branch.base == local_branch.base:
3465
remote_branch = local_branch
3466
local_branch.lock_read()
3468
remote_branch.lock_read()
3470
local_extra, remote_extra = find_unmerged(
3471
local_branch, remote_branch, restrict,
3472
backward=not reverse,
3473
include_merges=include_merges)
3475
if log_format is None:
3476
registry = log.log_formatter_registry
3477
log_format = registry.get_default(local_branch)
3478
lf = log_format(to_file=self.outf,
3480
show_timezone='original')
3483
if local_extra and not theirs_only:
3484
self.outf.write("You have %d extra revision(s):\n" %
3486
for revision in iter_log_revisions(local_extra,
3487
local_branch.repository,
3489
lf.log_revision(revision)
3490
printed_local = True
3493
printed_local = False
3495
if remote_extra and not mine_only:
3496
if printed_local is True:
3497
self.outf.write("\n\n\n")
3498
self.outf.write("You are missing %d revision(s):\n" %
3500
for revision in iter_log_revisions(remote_extra,
3501
remote_branch.repository,
3503
lf.log_revision(revision)
3506
if mine_only and not local_extra:
3507
# We checked local, and found nothing extra
3508
self.outf.write('This branch is up to date.\n')
3509
elif theirs_only and not remote_extra:
3510
# We checked remote, and found nothing extra
3511
self.outf.write('Other branch is up to date.\n')
3512
elif not (mine_only or theirs_only or local_extra or
3514
# We checked both branches, and neither one had extra
3516
self.outf.write("Branches are up to date.\n")
3518
remote_branch.unlock()
3520
local_branch.unlock()
3521
if not status_code and parent is None and other_branch is not None:
3522
local_branch.lock_write()
3524
# handle race conditions - a parent might be set while we run.
3525
if local_branch.get_parent() is None:
3526
local_branch.set_parent(remote_branch.base)
3528
local_branch.unlock()
3532
class cmd_pack(Command):
3533
"""Compress the data within a repository."""
3535
_see_also = ['repositories']
3536
takes_args = ['branch_or_repo?']
3538
def run(self, branch_or_repo='.'):
3539
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3541
branch = dir.open_branch()
3542
repository = branch.repository
3543
except errors.NotBranchError:
3544
repository = dir.open_repository()
3548
class cmd_plugins(Command):
3549
"""List the installed plugins.
3551
This command displays the list of installed plugins including
3552
version of plugin and a short description of each.
3554
--verbose shows the path where each plugin is located.
3556
A plugin is an external component for Bazaar that extends the
3557
revision control system, by adding or replacing code in Bazaar.
3558
Plugins can do a variety of things, including overriding commands,
3559
adding new commands, providing additional network transports and
3560
customizing log output.
3562
See the Bazaar web site, http://bazaar-vcs.org, for further
3563
information on plugins including where to find them and how to
3564
install them. Instructions are also provided there on how to
3565
write new plugins using the Python programming language.
3567
takes_options = ['verbose']
3570
def run(self, verbose=False):
3571
import bzrlib.plugin
3572
from inspect import getdoc
3574
for name, plugin in bzrlib.plugin.plugins().items():
3575
version = plugin.__version__
3576
if version == 'unknown':
3578
name_ver = '%s %s' % (name, version)
3579
d = getdoc(plugin.module)
3581
doc = d.split('\n')[0]
3583
doc = '(no description)'
3584
result.append((name_ver, doc, plugin.path()))
3585
for name_ver, doc, path in sorted(result):
3593
class cmd_testament(Command):
3594
"""Show testament (signing-form) of a revision."""
3597
Option('long', help='Produce long-format testament.'),
3599
help='Produce a strict-format testament.')]
3600
takes_args = ['branch?']
3602
def run(self, branch=u'.', revision=None, long=False, strict=False):
3603
from bzrlib.testament import Testament, StrictTestament
3605
testament_class = StrictTestament
3607
testament_class = Testament
3609
b = Branch.open_containing(branch)[0]
3611
b = Branch.open(branch)
3614
if revision is None:
3615
rev_id = b.last_revision()
3617
rev_id = revision[0].as_revision_id(b)
3618
t = testament_class.from_revision(b.repository, rev_id)
3620
sys.stdout.writelines(t.as_text_lines())
3622
sys.stdout.write(t.as_short_text())
3627
class cmd_annotate(Command):
3628
"""Show the origin of each line in a file.
3630
This prints out the given file with an annotation on the left side
3631
indicating which revision, author and date introduced the change.
3633
If the origin is the same for a run of consecutive lines, it is
3634
shown only at the top, unless the --all option is given.
3636
# TODO: annotate directories; showing when each file was last changed
3637
# TODO: if the working copy is modified, show annotations on that
3638
# with new uncommitted lines marked
3639
aliases = ['ann', 'blame', 'praise']
3640
takes_args = ['filename']
3641
takes_options = [Option('all', help='Show annotations on all lines.'),
3642
Option('long', help='Show commit date in annotations.'),
3646
encoding_type = 'exact'
3649
def run(self, filename, all=False, long=False, revision=None,
3651
from bzrlib.annotate import annotate_file, annotate_file_tree
3652
wt, branch, relpath = \
3653
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3659
tree = _get_one_revision_tree('annotate', revision, branch=branch)
3661
file_id = wt.path2id(relpath)
3663
file_id = tree.path2id(relpath)
3665
raise errors.NotVersionedError(filename)
3666
file_version = tree.inventory[file_id].revision
3667
if wt is not None and revision is None:
3668
# If there is a tree and we're not annotating historical
3669
# versions, annotate the working tree's content.
3670
annotate_file_tree(wt, file_id, self.outf, long, all,
3673
annotate_file(branch, file_version, file_id, long, all, self.outf,
3682
class cmd_re_sign(Command):
3683
"""Create a digital signature for an existing revision."""
3684
# TODO be able to replace existing ones.
3686
hidden = True # is this right ?
3687
takes_args = ['revision_id*']
3688
takes_options = ['revision']
3690
def run(self, revision_id_list=None, revision=None):
3691
if revision_id_list is not None and revision is not None:
3692
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3693
if revision_id_list is None and revision is None:
3694
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3695
b = WorkingTree.open_containing(u'.')[0].branch
3698
return self._run(b, revision_id_list, revision)
3702
def _run(self, b, revision_id_list, revision):
3703
import bzrlib.gpg as gpg
3704
gpg_strategy = gpg.GPGStrategy(b.get_config())
3705
if revision_id_list is not None:
3706
b.repository.start_write_group()
3708
for revision_id in revision_id_list:
3709
b.repository.sign_revision(revision_id, gpg_strategy)
3711
b.repository.abort_write_group()
3714
b.repository.commit_write_group()
3715
elif revision is not None:
3716
if len(revision) == 1:
3717
revno, rev_id = revision[0].in_history(b)
3718
b.repository.start_write_group()
3720
b.repository.sign_revision(rev_id, gpg_strategy)
3722
b.repository.abort_write_group()
3725
b.repository.commit_write_group()
3726
elif len(revision) == 2:
3727
# are they both on rh- if so we can walk between them
3728
# might be nice to have a range helper for arbitrary
3729
# revision paths. hmm.
3730
from_revno, from_revid = revision[0].in_history(b)
3731
to_revno, to_revid = revision[1].in_history(b)
3732
if to_revid is None:
3733
to_revno = b.revno()
3734
if from_revno is None or to_revno is None:
3735
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3736
b.repository.start_write_group()
3738
for revno in range(from_revno, to_revno + 1):
3739
b.repository.sign_revision(b.get_rev_id(revno),
3742
b.repository.abort_write_group()
3745
b.repository.commit_write_group()
3747
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3750
class cmd_bind(Command):
3751
"""Convert the current branch into a checkout of the supplied branch.
3753
Once converted into a checkout, commits must succeed on the master branch
3754
before they will be applied to the local branch.
3757
_see_also = ['checkouts', 'unbind']
3758
takes_args = ['location?']
3761
def run(self, location=None):
3762
b, relpath = Branch.open_containing(u'.')
3763
if location is None:
3765
location = b.get_old_bound_location()
3766
except errors.UpgradeRequired:
3767
raise errors.BzrCommandError('No location supplied. '
3768
'This format does not remember old locations.')
3770
if location is None:
3771
raise errors.BzrCommandError('No location supplied and no '
3772
'previous location known')
3773
b_other = Branch.open(location)
3776
except errors.DivergedBranches:
3777
raise errors.BzrCommandError('These branches have diverged.'
3778
' Try merging, and then bind again.')
3781
class cmd_unbind(Command):
3782
"""Convert the current checkout into a regular branch.
3784
After unbinding, the local branch is considered independent and subsequent
3785
commits will be local only.
3788
_see_also = ['checkouts', 'bind']
3793
b, relpath = Branch.open_containing(u'.')
3795
raise errors.BzrCommandError('Local branch is not bound')
3798
class cmd_uncommit(Command):
3799
"""Remove the last committed revision.
3801
--verbose will print out what is being removed.
3802
--dry-run will go through all the motions, but not actually
3805
If --revision is specified, uncommit revisions to leave the branch at the
3806
specified revision. For example, "bzr uncommit -r 15" will leave the
3807
branch at revision 15.
3809
Uncommit leaves the working tree ready for a new commit. The only change
3810
it may make is to restore any pending merges that were present before
3814
# TODO: jam 20060108 Add an option to allow uncommit to remove
3815
# unreferenced information in 'branch-as-repository' branches.
3816
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3817
# information in shared branches as well.
3818
_see_also = ['commit']
3819
takes_options = ['verbose', 'revision',
3820
Option('dry-run', help='Don\'t actually make changes.'),
3821
Option('force', help='Say yes to all questions.'),
3823
help="Only remove the commits from the local branch"
3824
" when in a checkout."
3827
takes_args = ['location?']
3829
encoding_type = 'replace'
3831
def run(self, location=None,
3832
dry_run=False, verbose=False,
3833
revision=None, force=False, local=False):
3834
if location is None:
3836
control, relpath = bzrdir.BzrDir.open_containing(location)
3838
tree = control.open_workingtree()
3840
except (errors.NoWorkingTree, errors.NotLocalUrl):
3842
b = control.open_branch()
3844
if tree is not None:
3849
return self._run(b, tree, dry_run, verbose, revision, force,
3852
if tree is not None:
3857
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3858
from bzrlib.log import log_formatter, show_log
3859
from bzrlib.uncommit import uncommit
3861
last_revno, last_rev_id = b.last_revision_info()
3864
if revision is None:
3866
rev_id = last_rev_id
3868
# 'bzr uncommit -r 10' actually means uncommit
3869
# so that the final tree is at revno 10.
3870
# but bzrlib.uncommit.uncommit() actually uncommits
3871
# the revisions that are supplied.
3872
# So we need to offset it by one
3873
revno = revision[0].in_history(b).revno + 1
3874
if revno <= last_revno:
3875
rev_id = b.get_rev_id(revno)
3877
if rev_id is None or _mod_revision.is_null(rev_id):
3878
self.outf.write('No revisions to uncommit.\n')
3881
lf = log_formatter('short',
3883
show_timezone='original')
3888
direction='forward',
3889
start_revision=revno,
3890
end_revision=last_revno)
3893
print 'Dry-run, pretending to remove the above revisions.'
3895
val = raw_input('Press <enter> to continue')
3897
print 'The above revision(s) will be removed.'
3899
val = raw_input('Are you sure [y/N]? ')
3900
if val.lower() not in ('y', 'yes'):
3904
mutter('Uncommitting from {%s} to {%s}',
3905
last_rev_id, rev_id)
3906
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3907
revno=revno, local=local)
3908
note('You can restore the old tip by running:\n'
3909
' bzr pull . -r revid:%s', last_rev_id)
3912
class cmd_break_lock(Command):
3913
"""Break a dead lock on a repository, branch or working directory.
3915
CAUTION: Locks should only be broken when you are sure that the process
3916
holding the lock has been stopped.
3918
You can get information on what locks are open via the 'bzr info' command.
3923
takes_args = ['location?']
3925
def run(self, location=None, show=False):
3926
if location is None:
3928
control, relpath = bzrdir.BzrDir.open_containing(location)
3930
control.break_lock()
3931
except NotImplementedError:
3935
class cmd_wait_until_signalled(Command):
3936
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3938
This just prints a line to signal when it is ready, then blocks on stdin.
3944
sys.stdout.write("running\n")
3946
sys.stdin.readline()
3949
class cmd_serve(Command):
3950
"""Run the bzr server."""
3952
aliases = ['server']
3956
help='Serve on stdin/out for use from inetd or sshd.'),
3958
help='Listen for connections on nominated port of the form '
3959
'[hostname:]portnumber. Passing 0 as the port number will '
3960
'result in a dynamically allocated port. The default port is '
3964
help='Serve contents of this directory.',
3966
Option('allow-writes',
3967
help='By default the server is a readonly server. Supplying '
3968
'--allow-writes enables write access to the contents of '
3969
'the served directory and below.'
3973
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3974
from bzrlib import lockdir
3975
from bzrlib.smart import medium, server
3976
from bzrlib.transport import get_transport
3977
from bzrlib.transport.chroot import ChrootServer
3978
if directory is None:
3979
directory = os.getcwd()
3980
url = urlutils.local_path_to_url(directory)
3981
if not allow_writes:
3982
url = 'readonly+' + url
3983
chroot_server = ChrootServer(get_transport(url))
3984
chroot_server.setUp()
3985
t = get_transport(chroot_server.get_url())
3987
smart_server = medium.SmartServerPipeStreamMedium(
3988
sys.stdin, sys.stdout, t)
3990
host = medium.BZR_DEFAULT_INTERFACE
3992
port = medium.BZR_DEFAULT_PORT
3995
host, port = port.split(':')
3997
smart_server = server.SmartTCPServer(t, host=host, port=port)
3998
print 'listening on port: ', smart_server.port
4000
# for the duration of this server, no UI output is permitted.
4001
# note that this may cause problems with blackbox tests. This should
4002
# be changed with care though, as we dont want to use bandwidth sending
4003
# progress over stderr to smart server clients!
4004
old_factory = ui.ui_factory
4005
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
4007
ui.ui_factory = ui.SilentUIFactory()
4008
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
4009
smart_server.serve()
4011
ui.ui_factory = old_factory
4012
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
4015
class cmd_join(Command):
4016
"""Combine a subtree into its containing tree.
4018
This command is for experimental use only. It requires the target tree
4019
to be in dirstate-with-subtree format, which cannot be converted into
4022
The TREE argument should be an independent tree, inside another tree, but
4023
not part of it. (Such trees can be produced by "bzr split", but also by
4024
running "bzr branch" with the target inside a tree.)
4026
The result is a combined tree, with the subtree no longer an independant
4027
part. This is marked as a merge of the subtree into the containing tree,
4028
and all history is preserved.
4030
If --reference is specified, the subtree retains its independence. It can
4031
be branched by itself, and can be part of multiple projects at the same
4032
time. But operations performed in the containing tree, such as commit
4033
and merge, will recurse into the subtree.
4036
_see_also = ['split']
4037
takes_args = ['tree']
4039
Option('reference', help='Join by reference.'),
4043
def run(self, tree, reference=False):
4044
sub_tree = WorkingTree.open(tree)
4045
parent_dir = osutils.dirname(sub_tree.basedir)
4046
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4047
repo = containing_tree.branch.repository
4048
if not repo.supports_rich_root():
4049
raise errors.BzrCommandError(
4050
"Can't join trees because %s doesn't support rich root data.\n"
4051
"You can use bzr upgrade on the repository."
4055
containing_tree.add_reference(sub_tree)
4056
except errors.BadReferenceTarget, e:
4057
# XXX: Would be better to just raise a nicely printable
4058
# exception from the real origin. Also below. mbp 20070306
4059
raise errors.BzrCommandError("Cannot join %s. %s" %
4063
containing_tree.subsume(sub_tree)
4064
except errors.BadSubsumeSource, e:
4065
raise errors.BzrCommandError("Cannot join %s. %s" %
4069
class cmd_split(Command):
4070
"""Split a subdirectory of a tree into a separate tree.
4072
This command will produce a target tree in a format that supports
4073
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4074
converted into earlier formats like 'dirstate-tags'.
4076
The TREE argument should be a subdirectory of a working tree. That
4077
subdirectory will be converted into an independent tree, with its own
4078
branch. Commits in the top-level tree will not apply to the new subtree.
4081
# join is not un-hidden yet
4082
#_see_also = ['join']
4083
takes_args = ['tree']
4085
def run(self, tree):
4086
containing_tree, subdir = WorkingTree.open_containing(tree)
4087
sub_id = containing_tree.path2id(subdir)
4089
raise errors.NotVersionedError(subdir)
4091
containing_tree.extract(sub_id)
4092
except errors.RootNotRich:
4093
raise errors.UpgradeRequired(containing_tree.branch.base)
4096
class cmd_merge_directive(Command):
4097
"""Generate a merge directive for auto-merge tools.
4099
A directive requests a merge to be performed, and also provides all the
4100
information necessary to do so. This means it must either include a
4101
revision bundle, or the location of a branch containing the desired
4104
A submit branch (the location to merge into) must be supplied the first
4105
time the command is issued. After it has been supplied once, it will
4106
be remembered as the default.
4108
A public branch is optional if a revision bundle is supplied, but required
4109
if --diff or --plain is specified. It will be remembered as the default
4110
after the first use.
4113
takes_args = ['submit_branch?', 'public_branch?']
4117
_see_also = ['send']
4120
RegistryOption.from_kwargs('patch-type',
4121
'The type of patch to include in the directive.',
4123
value_switches=True,
4125
bundle='Bazaar revision bundle (default).',
4126
diff='Normal unified diff.',
4127
plain='No patch, just directive.'),
4128
Option('sign', help='GPG-sign the directive.'), 'revision',
4129
Option('mail-to', type=str,
4130
help='Instead of printing the directive, email to this address.'),
4131
Option('message', type=str, short_name='m',
4132
help='Message to use when committing this merge.')
4135
encoding_type = 'exact'
4137
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4138
sign=False, revision=None, mail_to=None, message=None):
4139
from bzrlib.revision import ensure_null, NULL_REVISION
4140
include_patch, include_bundle = {
4141
'plain': (False, False),
4142
'diff': (True, False),
4143
'bundle': (True, True),
4145
branch = Branch.open('.')
4146
stored_submit_branch = branch.get_submit_branch()
4147
if submit_branch is None:
4148
submit_branch = stored_submit_branch
4150
if stored_submit_branch is None:
4151
branch.set_submit_branch(submit_branch)
4152
if submit_branch is None:
4153
submit_branch = branch.get_parent()
4154
if submit_branch is None:
4155
raise errors.BzrCommandError('No submit branch specified or known')
4157
stored_public_branch = branch.get_public_branch()
4158
if public_branch is None:
4159
public_branch = stored_public_branch
4160
elif stored_public_branch is None:
4161
branch.set_public_branch(public_branch)
4162
if not include_bundle and public_branch is None:
4163
raise errors.BzrCommandError('No public branch specified or'
4165
base_revision_id = None
4166
if revision is not None:
4167
if len(revision) > 2:
4168
raise errors.BzrCommandError('bzr merge-directive takes '
4169
'at most two one revision identifiers')
4170
revision_id = revision[-1].as_revision_id(branch)
4171
if len(revision) == 2:
4172
base_revision_id = revision[0].as_revision_id(branch)
4174
revision_id = branch.last_revision()
4175
revision_id = ensure_null(revision_id)
4176
if revision_id == NULL_REVISION:
4177
raise errors.BzrCommandError('No revisions to bundle.')
4178
directive = merge_directive.MergeDirective2.from_objects(
4179
branch.repository, revision_id, time.time(),
4180
osutils.local_time_offset(), submit_branch,
4181
public_branch=public_branch, include_patch=include_patch,
4182
include_bundle=include_bundle, message=message,
4183
base_revision_id=base_revision_id)
4186
self.outf.write(directive.to_signed(branch))
4188
self.outf.writelines(directive.to_lines())
4190
message = directive.to_email(mail_to, branch, sign)
4191
s = SMTPConnection(branch.get_config())
4192
s.send_email(message)
4195
class cmd_send(Command):
4196
"""Mail or create a merge-directive for submiting changes.
4198
A merge directive provides many things needed for requesting merges:
4200
* A machine-readable description of the merge to perform
4202
* An optional patch that is a preview of the changes requested
4204
* An optional bundle of revision data, so that the changes can be applied
4205
directly from the merge directive, without retrieving data from a
4208
If --no-bundle is specified, then public_branch is needed (and must be
4209
up-to-date), so that the receiver can perform the merge using the
4210
public_branch. The public_branch is always included if known, so that
4211
people can check it later.
4213
The submit branch defaults to the parent, but can be overridden. Both
4214
submit branch and public branch will be remembered if supplied.
4216
If a public_branch is known for the submit_branch, that public submit
4217
branch is used in the merge instructions. This means that a local mirror
4218
can be used as your actual submit branch, once you have set public_branch
4221
Mail is sent using your preferred mail program. This should be transparent
4222
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4223
If the preferred client can't be found (or used), your editor will be used.
4225
To use a specific mail program, set the mail_client configuration option.
4226
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4227
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4228
generic options are "default", "editor", "emacsclient", "mapi", and
4229
"xdg-email". Plugins may also add supported clients.
4231
If mail is being sent, a to address is required. This can be supplied
4232
either on the commandline, by setting the submit_to configuration
4233
option in the branch itself or the child_submit_to configuration option
4234
in the submit branch.
4236
Two formats are currently supported: "4" uses revision bundle format 4 and
4237
merge directive format 2. It is significantly faster and smaller than
4238
older formats. It is compatible with Bazaar 0.19 and later. It is the
4239
default. "0.9" uses revision bundle format 0.9 and merge directive
4240
format 1. It is compatible with Bazaar 0.12 - 0.18.
4242
Merge directives are applied using the merge command or the pull command.
4245
encoding_type = 'exact'
4247
_see_also = ['merge', 'pull']
4249
takes_args = ['submit_branch?', 'public_branch?']
4253
help='Do not include a bundle in the merge directive.'),
4254
Option('no-patch', help='Do not include a preview patch in the merge'
4257
help='Remember submit and public branch.'),
4259
help='Branch to generate the submission from, '
4260
'rather than the one containing the working directory.',
4263
Option('output', short_name='o',
4264
help='Write merge directive to this file; '
4265
'use - for stdout.',
4267
Option('mail-to', help='Mail the request to this address.',
4271
RegistryOption.from_kwargs('format',
4272
'Use the specified output format.',
4273
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4274
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4277
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4278
no_patch=False, revision=None, remember=False, output=None,
4279
format='4', mail_to=None, message=None, **kwargs):
4280
return self._run(submit_branch, revision, public_branch, remember,
4281
format, no_bundle, no_patch, output,
4282
kwargs.get('from', '.'), mail_to, message)
4284
def _run(self, submit_branch, revision, public_branch, remember, format,
4285
no_bundle, no_patch, output, from_, mail_to, message):
4286
from bzrlib.revision import NULL_REVISION
4287
branch = Branch.open_containing(from_)[0]
4289
outfile = cStringIO.StringIO()
4293
outfile = open(output, 'wb')
4294
# we may need to write data into branch's repository to calculate
4299
config = branch.get_config()
4301
mail_to = config.get_user_option('submit_to')
4302
mail_client = config.get_mail_client()
4303
if remember and submit_branch is None:
4304
raise errors.BzrCommandError(
4305
'--remember requires a branch to be specified.')
4306
stored_submit_branch = branch.get_submit_branch()
4307
remembered_submit_branch = None
4308
if submit_branch is None:
4309
submit_branch = stored_submit_branch
4310
remembered_submit_branch = "submit"
4312
if stored_submit_branch is None or remember:
4313
branch.set_submit_branch(submit_branch)
4314
if submit_branch is None:
4315
submit_branch = branch.get_parent()
4316
remembered_submit_branch = "parent"
4317
if submit_branch is None:
4318
raise errors.BzrCommandError('No submit branch known or'
4320
if remembered_submit_branch is not None:
4321
note('Using saved %s location "%s" to determine what '
4322
'changes to submit.', remembered_submit_branch,
4326
submit_config = Branch.open(submit_branch).get_config()
4327
mail_to = submit_config.get_user_option("child_submit_to")
4329
stored_public_branch = branch.get_public_branch()
4330
if public_branch is None:
4331
public_branch = stored_public_branch
4332
elif stored_public_branch is None or remember:
4333
branch.set_public_branch(public_branch)
4334
if no_bundle and public_branch is None:
4335
raise errors.BzrCommandError('No public branch specified or'
4337
base_revision_id = None
4339
if revision is not None:
4340
if len(revision) > 2:
4341
raise errors.BzrCommandError('bzr send takes '
4342
'at most two one revision identifiers')
4343
revision_id = revision[-1].as_revision_id(branch)
4344
if len(revision) == 2:
4345
base_revision_id = revision[0].as_revision_id(branch)
4346
if revision_id is None:
4347
revision_id = branch.last_revision()
4348
if revision_id == NULL_REVISION:
4349
raise errors.BzrCommandError('No revisions to submit.')
4351
directive = merge_directive.MergeDirective2.from_objects(
4352
branch.repository, revision_id, time.time(),
4353
osutils.local_time_offset(), submit_branch,
4354
public_branch=public_branch, include_patch=not no_patch,
4355
include_bundle=not no_bundle, message=message,
4356
base_revision_id=base_revision_id)
4357
elif format == '0.9':
4360
patch_type = 'bundle'
4362
raise errors.BzrCommandError('Format 0.9 does not'
4363
' permit bundle with no patch')
4369
directive = merge_directive.MergeDirective.from_objects(
4370
branch.repository, revision_id, time.time(),
4371
osutils.local_time_offset(), submit_branch,
4372
public_branch=public_branch, patch_type=patch_type,
4375
outfile.writelines(directive.to_lines())
4377
subject = '[MERGE] '
4378
if message is not None:
4381
revision = branch.repository.get_revision(revision_id)
4382
subject += revision.get_summary()
4383
basename = directive.get_disk_name(branch)
4384
mail_client.compose_merge_request(mail_to, subject,
4385
outfile.getvalue(), basename)
4392
class cmd_bundle_revisions(cmd_send):
4394
"""Create a merge-directive for submiting changes.
4396
A merge directive provides many things needed for requesting merges:
4398
* A machine-readable description of the merge to perform
4400
* An optional patch that is a preview of the changes requested
4402
* An optional bundle of revision data, so that the changes can be applied
4403
directly from the merge directive, without retrieving data from a
4406
If --no-bundle is specified, then public_branch is needed (and must be
4407
up-to-date), so that the receiver can perform the merge using the
4408
public_branch. The public_branch is always included if known, so that
4409
people can check it later.
4411
The submit branch defaults to the parent, but can be overridden. Both
4412
submit branch and public branch will be remembered if supplied.
4414
If a public_branch is known for the submit_branch, that public submit
4415
branch is used in the merge instructions. This means that a local mirror
4416
can be used as your actual submit branch, once you have set public_branch
4419
Two formats are currently supported: "4" uses revision bundle format 4 and
4420
merge directive format 2. It is significantly faster and smaller than
4421
older formats. It is compatible with Bazaar 0.19 and later. It is the
4422
default. "0.9" uses revision bundle format 0.9 and merge directive
4423
format 1. It is compatible with Bazaar 0.12 - 0.18.
4428
help='Do not include a bundle in the merge directive.'),
4429
Option('no-patch', help='Do not include a preview patch in the merge'
4432
help='Remember submit and public branch.'),
4434
help='Branch to generate the submission from, '
4435
'rather than the one containing the working directory.',
4438
Option('output', short_name='o', help='Write directive to this file.',
4441
RegistryOption.from_kwargs('format',
4442
'Use the specified output format.',
4443
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4444
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4446
aliases = ['bundle']
4448
_see_also = ['send', 'merge']
4452
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4453
no_patch=False, revision=None, remember=False, output=None,
4454
format='4', **kwargs):
4457
return self._run(submit_branch, revision, public_branch, remember,
4458
format, no_bundle, no_patch, output,
4459
kwargs.get('from', '.'), None, None)
4462
class cmd_tag(Command):
4463
"""Create, remove or modify a tag naming a revision.
4465
Tags give human-meaningful names to revisions. Commands that take a -r
4466
(--revision) option can be given -rtag:X, where X is any previously
4469
Tags are stored in the branch. Tags are copied from one branch to another
4470
along when you branch, push, pull or merge.
4472
It is an error to give a tag name that already exists unless you pass
4473
--force, in which case the tag is moved to point to the new revision.
4475
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4476
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4479
_see_also = ['commit', 'tags']
4480
takes_args = ['tag_name']
4483
help='Delete this tag rather than placing it.',
4486
help='Branch in which to place the tag.',
4491
help='Replace existing tags.',
4496
def run(self, tag_name,
4502
branch, relpath = Branch.open_containing(directory)
4506
branch.tags.delete_tag(tag_name)
4507
self.outf.write('Deleted tag %s.\n' % tag_name)
4510
if len(revision) != 1:
4511
raise errors.BzrCommandError(
4512
"Tags can only be placed on a single revision, "
4514
revision_id = revision[0].as_revision_id(branch)
4516
revision_id = branch.last_revision()
4517
if (not force) and branch.tags.has_tag(tag_name):
4518
raise errors.TagAlreadyExists(tag_name)
4519
branch.tags.set_tag(tag_name, revision_id)
4520
self.outf.write('Created tag %s.\n' % tag_name)
4525
class cmd_tags(Command):
4528
This command shows a table of tag names and the revisions they reference.
4534
help='Branch whose tags should be displayed.',
4538
RegistryOption.from_kwargs('sort',
4539
'Sort tags by different criteria.', title='Sorting',
4540
alpha='Sort tags lexicographically (default).',
4541
time='Sort tags chronologically.',
4552
branch, relpath = Branch.open_containing(directory)
4553
tags = branch.tags.get_tag_dict().items()
4558
elif sort == 'time':
4560
for tag, revid in tags:
4562
revobj = branch.repository.get_revision(revid)
4563
except errors.NoSuchRevision:
4564
timestamp = sys.maxint # place them at the end
4566
timestamp = revobj.timestamp
4567
timestamps[revid] = timestamp
4568
tags.sort(key=lambda x: timestamps[x[1]])
4570
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4571
revno_map = branch.get_revision_id_to_revno_map()
4572
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4573
for tag, revid in tags ]
4574
for tag, revspec in tags:
4575
self.outf.write('%-20s %s\n' % (tag, revspec))
4578
class cmd_reconfigure(Command):
4579
"""Reconfigure the type of a bzr directory.
4581
A target configuration must be specified.
4583
For checkouts, the bind-to location will be auto-detected if not specified.
4584
The order of preference is
4585
1. For a lightweight checkout, the current bound location.
4586
2. For branches that used to be checkouts, the previously-bound location.
4587
3. The push location.
4588
4. The parent location.
4589
If none of these is available, --bind-to must be specified.
4592
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
4593
takes_args = ['location?']
4594
takes_options = [RegistryOption.from_kwargs('target_type',
4595
title='Target type',
4596
help='The type to reconfigure the directory to.',
4597
value_switches=True, enum_switch=False,
4598
branch='Reconfigure to be an unbound branch '
4599
'with no working tree.',
4600
tree='Reconfigure to be an unbound branch '
4601
'with a working tree.',
4602
checkout='Reconfigure to be a bound branch '
4603
'with a working tree.',
4604
lightweight_checkout='Reconfigure to be a lightweight'
4605
' checkout (with no local history).',
4606
standalone='Reconfigure to be a standalone branch '
4607
'(i.e. stop using shared repository).',
4608
use_shared='Reconfigure to use a shared repository.'),
4609
Option('bind-to', help='Branch to bind checkout to.',
4612
help='Perform reconfiguration even if local changes'
4616
def run(self, location=None, target_type=None, bind_to=None, force=False):
4617
directory = bzrdir.BzrDir.open(location)
4618
if target_type is None:
4619
raise errors.BzrCommandError('No target configuration specified')
4620
elif target_type == 'branch':
4621
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4622
elif target_type == 'tree':
4623
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4624
elif target_type == 'checkout':
4625
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4627
elif target_type == 'lightweight-checkout':
4628
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4630
elif target_type == 'use-shared':
4631
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4632
elif target_type == 'standalone':
4633
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
4634
reconfiguration.apply(force)
4637
class cmd_switch(Command):
4638
"""Set the branch of a checkout and update.
4640
For lightweight checkouts, this changes the branch being referenced.
4641
For heavyweight checkouts, this checks that there are no local commits
4642
versus the current bound branch, then it makes the local branch a mirror
4643
of the new location and binds to it.
4645
In both cases, the working tree is updated and uncommitted changes
4646
are merged. The user can commit or revert these as they desire.
4648
Pending merges need to be committed or reverted before using switch.
4650
The path to the branch to switch to can be specified relative to the parent
4651
directory of the current branch. For example, if you are currently in a
4652
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4656
takes_args = ['to_location']
4657
takes_options = [Option('force',
4658
help='Switch even if local commits will be lost.')
4661
def run(self, to_location, force=False):
4662
from bzrlib import switch
4664
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4666
to_branch = Branch.open(to_location)
4667
except errors.NotBranchError:
4668
this_branch = control_dir.open_branch()
4669
# This may be a heavy checkout, where we want the master branch
4670
this_url = this_branch.get_bound_location()
4671
# If not, use a local sibling
4672
if this_url is None:
4673
this_url = this_branch.base
4674
to_branch = Branch.open(
4675
urlutils.join(this_url, '..', to_location))
4676
switch.switch(control_dir, to_branch, force)
4677
note('Switched to branch: %s',
4678
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4681
class cmd_hooks(Command):
4682
"""Show a branch's currently registered hooks.
4686
takes_args = ['path?']
4688
def run(self, path=None):
4691
branch_hooks = Branch.open(path).hooks
4692
for hook_type in branch_hooks:
4693
hooks = branch_hooks[hook_type]
4694
self.outf.write("%s:\n" % (hook_type,))
4697
self.outf.write(" %s\n" %
4698
(branch_hooks.get_hook_name(hook),))
4700
self.outf.write(" <no hooks installed>\n")
4703
def _create_prefix(cur_transport):
4704
needed = [cur_transport]
4705
# Recurse upwards until we can create a directory successfully
4707
new_transport = cur_transport.clone('..')
4708
if new_transport.base == cur_transport.base:
4709
raise errors.BzrCommandError(
4710
"Failed to create path prefix for %s."
4711
% cur_transport.base)
4713
new_transport.mkdir('.')
4714
except errors.NoSuchFile:
4715
needed.append(new_transport)
4716
cur_transport = new_transport
4719
# Now we only need to create child directories
4721
cur_transport = needed.pop()
4722
cur_transport.ensure_base()
4725
# these get imported and then picked up by the scan for cmd_*
4726
# TODO: Some more consistent way to split command definitions across files;
4727
# we do need to load at least some information about them to know of
4728
# aliases. ideally we would avoid loading the implementation until the
4729
# details were needed.
4730
from bzrlib.cmd_version_info import cmd_version_info
4731
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4732
from bzrlib.bundle.commands import (
4735
from bzrlib.sign_my_commits import cmd_sign_my_commits
4736
from bzrlib.weave_commands import cmd_versionedfile_list, \
4737
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
