1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 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(), """
44
revision as _mod_revision,
52
from bzrlib.branch import Branch
53
from bzrlib.conflicts import ConflictList
54
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
55
from bzrlib.smtp_connection import SMTPConnection
56
from bzrlib.workingtree import WorkingTree
59
from bzrlib.commands import Command, display_command
60
from bzrlib.option import (
67
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
70
def tree_files(file_list, default_branch=u'.', canonicalize=True,
73
return internal_tree_files(file_list, default_branch, canonicalize,
75
except errors.FileInWrongBranch, e:
76
raise errors.BzrCommandError("%s is not in the same branch as %s" %
77
(e.path, file_list[0]))
80
def tree_files_for_add(file_list):
81
"""Add handles files a bit differently so it a custom implementation."""
83
tree = WorkingTree.open_containing(file_list[0])[0]
84
if tree.supports_views():
85
view_files = tree.views.lookup_view()
86
for filename in file_list:
87
if not osutils.is_inside_any(view_files, filename):
88
raise errors.FileOutsideView(filename, view_files)
90
tree = WorkingTree.open_containing(u'.')[0]
91
if tree.supports_views():
92
view_files = tree.views.lookup_view()
94
file_list = view_files
95
view_str = views.view_display_str(view_files)
96
note("ignoring files outside view: %s" % view_str)
97
return tree, file_list
100
def _get_one_revision(command_name, revisions):
101
if revisions is None:
103
if len(revisions) != 1:
104
raise errors.BzrCommandError(
105
'bzr %s --revision takes exactly one revision identifier' % (
110
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
113
if revisions is None:
115
rev_tree = tree.basis_tree()
117
rev_tree = branch.basis_tree()
119
revision = _get_one_revision(command_name, revisions)
120
rev_tree = revision.as_tree(branch)
124
# XXX: Bad function name; should possibly also be a class method of
125
# WorkingTree rather than a function.
126
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
128
"""Convert command-line paths to a WorkingTree and relative paths.
130
This is typically used for command-line processors that take one or
131
more filenames, and infer the workingtree that contains them.
133
The filenames given are not required to exist.
135
:param file_list: Filenames to convert.
137
:param default_branch: Fallback tree path to use if file_list is empty or
140
:param apply_view: if True and a view is set, apply it or check that
141
specified files are within it
143
:return: workingtree, [relative_paths]
145
if file_list is None or len(file_list) == 0:
146
tree = WorkingTree.open_containing(default_branch)[0]
147
if tree.supports_views() and apply_view:
148
view_files = tree.views.lookup_view()
150
file_list = view_files
151
view_str = views.view_display_str(view_files)
152
note("ignoring files outside view: %s" % view_str)
153
return tree, file_list
154
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
155
return tree, safe_relpath_files(tree, file_list, canonicalize,
156
apply_view=apply_view)
159
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
160
"""Convert file_list into a list of relpaths in tree.
162
:param tree: A tree to operate on.
163
:param file_list: A list of user provided paths or None.
164
:param apply_view: if True and a view is set, apply it or check that
165
specified files are within it
166
:return: A list of relative paths.
167
:raises errors.PathNotChild: When a provided path is in a different tree
170
if file_list is None:
172
if tree.supports_views() and apply_view:
173
view_files = tree.views.lookup_view()
177
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
178
# doesn't - fix that up here before we enter the loop.
180
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
183
for filename in file_list:
185
relpath = fixer(osutils.dereference_path(filename))
186
if view_files and not osutils.is_inside_any(view_files, relpath):
187
raise errors.FileOutsideView(filename, view_files)
188
new_list.append(relpath)
189
except errors.PathNotChild:
190
raise errors.FileInWrongBranch(tree.branch, filename)
194
def _get_view_info_for_change_reporter(tree):
195
"""Get the view information from a tree for change reporting."""
198
current_view = tree.views.get_view_info()[0]
199
if current_view is not None:
200
view_info = (current_view, tree.views.lookup_view())
201
except errors.ViewsNotSupported:
206
# TODO: Make sure no commands unconditionally use the working directory as a
207
# branch. If a filename argument is used, the first of them should be used to
208
# specify the branch. (Perhaps this can be factored out into some kind of
209
# Argument class, representing a file in a branch, where the first occurrence
212
class cmd_status(Command):
213
"""Display status summary.
215
This reports on versioned and unknown files, reporting them
216
grouped by state. Possible states are:
219
Versioned in the working copy but not in the previous revision.
222
Versioned in the previous revision but removed or deleted
226
Path of this file changed from the previous revision;
227
the text may also have changed. This includes files whose
228
parent directory was renamed.
231
Text has changed since the previous revision.
234
File kind has been changed (e.g. from file to directory).
237
Not versioned and not matching an ignore pattern.
239
To see ignored files use 'bzr ignored'. For details on the
240
changes to file texts, use 'bzr diff'.
242
Note that --short or -S gives status flags for each item, similar
243
to Subversion's status command. To get output similar to svn -q,
246
If no arguments are specified, the status of the entire working
247
directory is shown. Otherwise, only the status of the specified
248
files or directories is reported. If a directory is given, status
249
is reported for everything inside that directory.
251
Before merges are committed, the pending merge tip revisions are
252
shown. To see all pending merge revisions, use the -v option.
253
To skip the display of pending merge information altogether, use
254
the no-pending option or specify a file/directory.
256
If a revision argument is given, the status is calculated against
257
that revision, or between two revisions if two are provided.
260
# TODO: --no-recurse, --recurse options
262
takes_args = ['file*']
263
takes_options = ['show-ids', 'revision', 'change', 'verbose',
264
Option('short', help='Use short status indicators.',
266
Option('versioned', help='Only show versioned files.',
268
Option('no-pending', help='Don\'t show pending merges.',
271
aliases = ['st', 'stat']
273
encoding_type = 'replace'
274
_see_also = ['diff', 'revert', 'status-flags']
277
def run(self, show_ids=False, file_list=None, revision=None, short=False,
278
versioned=False, no_pending=False, verbose=False):
279
from bzrlib.status import show_tree_status
281
if revision and len(revision) > 2:
282
raise errors.BzrCommandError('bzr status --revision takes exactly'
283
' one or two revision specifiers')
285
tree, relfile_list = tree_files(file_list)
286
# Avoid asking for specific files when that is not needed.
287
if relfile_list == ['']:
289
# Don't disable pending merges for full trees other than '.'.
290
if file_list == ['.']:
292
# A specific path within a tree was given.
293
elif relfile_list is not None:
295
show_tree_status(tree, show_ids=show_ids,
296
specific_files=relfile_list, revision=revision,
297
to_file=self.outf, short=short, versioned=versioned,
298
show_pending=(not no_pending), verbose=verbose)
301
class cmd_cat_revision(Command):
302
"""Write out metadata for a revision.
304
The revision to print can either be specified by a specific
305
revision identifier, or you can use --revision.
309
takes_args = ['revision_id?']
310
takes_options = ['revision']
311
# cat-revision is more for frontends so should be exact
315
def run(self, revision_id=None, revision=None):
316
if revision_id is not None and revision is not None:
317
raise errors.BzrCommandError('You can only supply one of'
318
' revision_id or --revision')
319
if revision_id is None and revision is None:
320
raise errors.BzrCommandError('You must supply either'
321
' --revision or a revision_id')
322
b = WorkingTree.open_containing(u'.')[0].branch
324
# TODO: jam 20060112 should cat-revision always output utf-8?
325
if revision_id is not None:
326
revision_id = osutils.safe_revision_id(revision_id, warn=False)
328
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
329
except errors.NoSuchRevision:
330
msg = "The repository %s contains no revision %s." % (b.repository.base,
332
raise errors.BzrCommandError(msg)
333
elif revision is not None:
336
raise errors.BzrCommandError('You cannot specify a NULL'
338
rev_id = rev.as_revision_id(b)
339
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
342
class cmd_dump_btree(Command):
343
"""Dump the contents of a btree index file to stdout.
345
PATH is a btree index file, it can be any URL. This includes things like
346
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
348
By default, the tuples stored in the index file will be displayed. With
349
--raw, we will uncompress the pages, but otherwise display the raw bytes
353
# TODO: Do we want to dump the internal nodes as well?
354
# TODO: It would be nice to be able to dump the un-parsed information,
355
# rather than only going through iter_all_entries. However, this is
356
# good enough for a start
358
encoding_type = 'exact'
359
takes_args = ['path']
360
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
361
' rather than the parsed tuples.'),
364
def run(self, path, raw=False):
365
dirname, basename = osutils.split(path)
366
t = transport.get_transport(dirname)
368
self._dump_raw_bytes(t, basename)
370
self._dump_entries(t, basename)
372
def _get_index_and_bytes(self, trans, basename):
373
"""Create a BTreeGraphIndex and raw bytes."""
374
bt = btree_index.BTreeGraphIndex(trans, basename, None)
375
bytes = trans.get_bytes(basename)
376
bt._file = cStringIO.StringIO(bytes)
377
bt._size = len(bytes)
380
def _dump_raw_bytes(self, trans, basename):
383
# We need to parse at least the root node.
384
# This is because the first page of every row starts with an
385
# uncompressed header.
386
bt, bytes = self._get_index_and_bytes(trans, basename)
387
for page_idx, page_start in enumerate(xrange(0, len(bytes),
388
btree_index._PAGE_SIZE)):
389
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
390
page_bytes = bytes[page_start:page_end]
392
self.outf.write('Root node:\n')
393
header_end, data = bt._parse_header_from_bytes(page_bytes)
394
self.outf.write(page_bytes[:header_end])
396
self.outf.write('\nPage %d\n' % (page_idx,))
397
decomp_bytes = zlib.decompress(page_bytes)
398
self.outf.write(decomp_bytes)
399
self.outf.write('\n')
401
def _dump_entries(self, trans, basename):
403
st = trans.stat(basename)
404
except errors.TransportNotPossible:
405
# We can't stat, so we'll fake it because we have to do the 'get()'
407
bt, _ = self._get_index_and_bytes(trans, basename)
409
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
410
for node in bt.iter_all_entries():
411
# Node is made up of:
412
# (index, key, value, [references])
413
self.outf.write('%s\n' % (node[1:],))
416
class cmd_remove_tree(Command):
417
"""Remove the working tree from a given branch/checkout.
419
Since a lightweight checkout is little more than a working tree
420
this will refuse to run against one.
422
To re-create the working tree, use "bzr checkout".
424
_see_also = ['checkout', 'working-trees']
425
takes_args = ['location?']
428
help='Remove the working tree even if it has '
429
'uncommitted changes.'),
432
def run(self, location='.', force=False):
433
d = bzrdir.BzrDir.open(location)
436
working = d.open_workingtree()
437
except errors.NoWorkingTree:
438
raise errors.BzrCommandError("No working tree to remove")
439
except errors.NotLocalUrl:
440
raise errors.BzrCommandError("You cannot remove the working tree of a "
443
changes = working.changes_from(working.basis_tree())
444
if changes.has_changed():
445
raise errors.UncommittedChanges(working)
447
working_path = working.bzrdir.root_transport.base
448
branch_path = working.branch.bzrdir.root_transport.base
449
if working_path != branch_path:
450
raise errors.BzrCommandError("You cannot remove the working tree from "
451
"a lightweight checkout")
453
d.destroy_workingtree()
456
class cmd_revno(Command):
457
"""Show current revision number.
459
This is equal to the number of revisions on this branch.
463
takes_args = ['location?']
466
def run(self, location=u'.'):
467
self.outf.write(str(Branch.open_containing(location)[0].revno()))
468
self.outf.write('\n')
471
class cmd_revision_info(Command):
472
"""Show revision number and revision id for a given revision identifier.
475
takes_args = ['revision_info*']
479
help='Branch to examine, '
480
'rather than the one containing the working directory.',
487
def run(self, revision=None, directory=u'.', revision_info_list=[]):
490
if revision is not None:
491
revs.extend(revision)
492
if revision_info_list is not None:
493
for rev in revision_info_list:
494
revs.append(RevisionSpec.from_string(rev))
496
b = Branch.open_containing(directory)[0]
499
revs.append(RevisionSpec.from_string('-1'))
502
revision_id = rev.as_revision_id(b)
504
revno = '%4d' % (b.revision_id_to_revno(revision_id))
505
except errors.NoSuchRevision:
506
dotted_map = b.get_revision_id_to_revno_map()
507
revno = '.'.join(str(i) for i in dotted_map[revision_id])
508
print '%s %s' % (revno, revision_id)
511
class cmd_add(Command):
512
"""Add specified files or directories.
514
In non-recursive mode, all the named items are added, regardless
515
of whether they were previously ignored. A warning is given if
516
any of the named files are already versioned.
518
In recursive mode (the default), files are treated the same way
519
but the behaviour for directories is different. Directories that
520
are already versioned do not give a warning. All directories,
521
whether already versioned or not, are searched for files or
522
subdirectories that are neither versioned or ignored, and these
523
are added. This search proceeds recursively into versioned
524
directories. If no names are given '.' is assumed.
526
Therefore simply saying 'bzr add' will version all files that
527
are currently unknown.
529
Adding a file whose parent directory is not versioned will
530
implicitly add the parent, and so on up to the root. This means
531
you should never need to explicitly add a directory, they'll just
532
get added when you add a file in the directory.
534
--dry-run will show which files would be added, but not actually
537
--file-ids-from will try to use the file ids from the supplied path.
538
It looks up ids trying to find a matching parent directory with the
539
same filename, and then by pure path. This option is rarely needed
540
but can be useful when adding the same logical file into two
541
branches that will be merged later (without showing the two different
542
adds as a conflict). It is also useful when merging another project
543
into a subdirectory of this one.
545
takes_args = ['file*']
548
help="Don't recursively add the contents of directories."),
550
help="Show what would be done, but don't actually do anything."),
552
Option('file-ids-from',
554
help='Lookup file ids from this tree.'),
556
encoding_type = 'replace'
557
_see_also = ['remove']
559
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
564
if file_ids_from is not None:
566
base_tree, base_path = WorkingTree.open_containing(
568
except errors.NoWorkingTree:
569
base_branch, base_path = Branch.open_containing(
571
base_tree = base_branch.basis_tree()
573
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
574
to_file=self.outf, should_print=(not is_quiet()))
576
action = bzrlib.add.AddAction(to_file=self.outf,
577
should_print=(not is_quiet()))
580
base_tree.lock_read()
582
file_list = self._maybe_expand_globs(file_list)
583
tree, file_list = tree_files_for_add(file_list)
584
added, ignored = tree.smart_add(file_list, not
585
no_recurse, action=action, save=not dry_run)
587
if base_tree is not None:
591
for glob in sorted(ignored.keys()):
592
for path in ignored[glob]:
593
self.outf.write("ignored %s matching \"%s\"\n"
597
for glob, paths in ignored.items():
598
match_len += len(paths)
599
self.outf.write("ignored %d file(s).\n" % match_len)
600
self.outf.write("If you wish to add some of these files,"
601
" please add them by name.\n")
604
class cmd_mkdir(Command):
605
"""Create a new versioned directory.
607
This is equivalent to creating the directory and then adding it.
610
takes_args = ['dir+']
611
encoding_type = 'replace'
613
def run(self, dir_list):
616
wt, dd = WorkingTree.open_containing(d)
618
self.outf.write('added %s\n' % d)
621
class cmd_relpath(Command):
622
"""Show path of a file relative to root"""
624
takes_args = ['filename']
628
def run(self, filename):
629
# TODO: jam 20050106 Can relpath return a munged path if
630
# sys.stdout encoding cannot represent it?
631
tree, relpath = WorkingTree.open_containing(filename)
632
self.outf.write(relpath)
633
self.outf.write('\n')
636
class cmd_inventory(Command):
637
"""Show inventory of the current working copy or a revision.
639
It is possible to limit the output to a particular entry
640
type using the --kind option. For example: --kind file.
642
It is also possible to restrict the list of files to a specific
643
set. For example: bzr inventory --show-ids this/file
652
help='List entries of a particular kind: file, directory, symlink.',
655
takes_args = ['file*']
658
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
659
if kind and kind not in ['file', 'directory', 'symlink']:
660
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
662
revision = _get_one_revision('inventory', revision)
663
work_tree, file_list = tree_files(file_list)
664
work_tree.lock_read()
666
if revision is not None:
667
tree = revision.as_tree(work_tree.branch)
669
extra_trees = [work_tree]
675
if file_list is not None:
676
file_ids = tree.paths2ids(file_list, trees=extra_trees,
677
require_versioned=True)
678
# find_ids_across_trees may include some paths that don't
680
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
681
for file_id in file_ids if file_id in tree)
683
entries = tree.inventory.entries()
686
if tree is not work_tree:
689
for path, entry in entries:
690
if kind and kind != entry.kind:
693
self.outf.write('%-50s %s\n' % (path, entry.file_id))
695
self.outf.write(path)
696
self.outf.write('\n')
699
class cmd_mv(Command):
700
"""Move or rename a file.
703
bzr mv OLDNAME NEWNAME
705
bzr mv SOURCE... DESTINATION
707
If the last argument is a versioned directory, all the other names
708
are moved into it. Otherwise, there must be exactly two arguments
709
and the file is changed to a new name.
711
If OLDNAME does not exist on the filesystem but is versioned and
712
NEWNAME does exist on the filesystem but is not versioned, mv
713
assumes that the file has been manually moved and only updates
714
its internal inventory to reflect that change.
715
The same is valid when moving many SOURCE files to a DESTINATION.
717
Files cannot be moved between branches.
720
takes_args = ['names*']
721
takes_options = [Option("after", help="Move only the bzr identifier"
722
" of the file, because the file has already been moved."),
724
aliases = ['move', 'rename']
725
encoding_type = 'replace'
727
def run(self, names_list, after=False):
728
if names_list is None:
731
if len(names_list) < 2:
732
raise errors.BzrCommandError("missing file argument")
733
tree, rel_names = tree_files(names_list, canonicalize=False)
736
self._run(tree, names_list, rel_names, after)
740
def _run(self, tree, names_list, rel_names, after):
741
into_existing = osutils.isdir(names_list[-1])
742
if into_existing and len(names_list) == 2:
744
# a. case-insensitive filesystem and change case of dir
745
# b. move directory after the fact (if the source used to be
746
# a directory, but now doesn't exist in the working tree
747
# and the target is an existing directory, just rename it)
748
if (not tree.case_sensitive
749
and rel_names[0].lower() == rel_names[1].lower()):
750
into_existing = False
753
# 'fix' the case of a potential 'from'
754
from_id = tree.path2id(
755
tree.get_canonical_inventory_path(rel_names[0]))
756
if (not osutils.lexists(names_list[0]) and
757
from_id and inv.get_file_kind(from_id) == "directory"):
758
into_existing = False
761
# move into existing directory
762
# All entries reference existing inventory items, so fix them up
763
# for cicp file-systems.
764
rel_names = tree.get_canonical_inventory_paths(rel_names)
765
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
766
self.outf.write("%s => %s\n" % pair)
768
if len(names_list) != 2:
769
raise errors.BzrCommandError('to mv multiple files the'
770
' destination must be a versioned'
773
# for cicp file-systems: the src references an existing inventory
775
src = tree.get_canonical_inventory_path(rel_names[0])
776
# Find the canonical version of the destination: In all cases, the
777
# parent of the target must be in the inventory, so we fetch the
778
# canonical version from there (we do not always *use* the
779
# canonicalized tail portion - we may be attempting to rename the
781
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
782
dest_parent = osutils.dirname(canon_dest)
783
spec_tail = osutils.basename(rel_names[1])
784
# For a CICP file-system, we need to avoid creating 2 inventory
785
# entries that differ only by case. So regardless of the case
786
# we *want* to use (ie, specified by the user or the file-system),
787
# we must always choose to use the case of any existing inventory
788
# items. The only exception to this is when we are attempting a
789
# case-only rename (ie, canonical versions of src and dest are
791
dest_id = tree.path2id(canon_dest)
792
if dest_id is None or tree.path2id(src) == dest_id:
793
# No existing item we care about, so work out what case we
794
# are actually going to use.
796
# If 'after' is specified, the tail must refer to a file on disk.
798
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
800
# pathjoin with an empty tail adds a slash, which breaks
802
dest_parent_fq = tree.basedir
804
dest_tail = osutils.canonical_relpath(
806
osutils.pathjoin(dest_parent_fq, spec_tail))
808
# not 'after', so case as specified is used
809
dest_tail = spec_tail
811
# Use the existing item so 'mv' fails with AlreadyVersioned.
812
dest_tail = os.path.basename(canon_dest)
813
dest = osutils.pathjoin(dest_parent, dest_tail)
814
mutter("attempting to move %s => %s", src, dest)
815
tree.rename_one(src, dest, after=after)
816
self.outf.write("%s => %s\n" % (src, dest))
819
class cmd_pull(Command):
820
"""Turn this branch into a mirror of another branch.
822
This command only works on branches that have not diverged. Branches are
823
considered diverged if the destination branch's most recent commit is one
824
that has not been merged (directly or indirectly) into the parent.
826
If branches have diverged, you can use 'bzr merge' to integrate the changes
827
from one into the other. Once one branch has merged, the other should
828
be able to pull it again.
830
If you want to forget your local changes and just update your branch to
831
match the remote one, use pull --overwrite.
833
If there is no default location set, the first pull will set it. After
834
that, you can omit the location to use the default. To change the
835
default, use --remember. The value will only be saved if the remote
836
location can be accessed.
838
Note: The location can be specified either in the form of a branch,
839
or in the form of a path to a file containing a merge directive generated
843
_see_also = ['push', 'update', 'status-flags', 'send']
844
takes_options = ['remember', 'overwrite', 'revision',
845
custom_help('verbose',
846
help='Show logs of pulled revisions.'),
848
help='Branch to pull into, '
849
'rather than the one containing the working directory.',
854
takes_args = ['location?']
855
encoding_type = 'replace'
857
def run(self, location=None, remember=False, overwrite=False,
858
revision=None, verbose=False,
860
# FIXME: too much stuff is in the command class
863
if directory is None:
866
tree_to = WorkingTree.open_containing(directory)[0]
867
branch_to = tree_to.branch
868
except errors.NoWorkingTree:
870
branch_to = Branch.open_containing(directory)[0]
872
possible_transports = []
873
if location is not None:
875
mergeable = bundle.read_mergeable_from_url(location,
876
possible_transports=possible_transports)
877
except errors.NotABundle:
880
stored_loc = branch_to.get_parent()
882
if stored_loc is None:
883
raise errors.BzrCommandError("No pull location known or"
886
display_url = urlutils.unescape_for_display(stored_loc,
889
self.outf.write("Using saved parent location: %s\n" % display_url)
890
location = stored_loc
892
revision = _get_one_revision('pull', revision)
893
if mergeable is not None:
894
if revision is not None:
895
raise errors.BzrCommandError(
896
'Cannot use -r with merge directives or bundles')
897
mergeable.install_revisions(branch_to.repository)
898
base_revision_id, revision_id, verified = \
899
mergeable.get_merge_request(branch_to.repository)
900
branch_from = branch_to
902
branch_from = Branch.open(location,
903
possible_transports=possible_transports)
905
if branch_to.get_parent() is None or remember:
906
branch_to.set_parent(branch_from.base)
908
if revision is not None:
909
revision_id = revision.as_revision_id(branch_from)
911
branch_to.lock_write()
913
if tree_to is not None:
914
view_info = _get_view_info_for_change_reporter(tree_to)
915
change_reporter = delta._ChangeReporter(
916
unversioned_filter=tree_to.is_ignored, view_info=view_info)
917
result = tree_to.pull(branch_from, overwrite, revision_id,
919
possible_transports=possible_transports)
921
result = branch_to.pull(branch_from, overwrite, revision_id)
923
result.report(self.outf)
924
if verbose and result.old_revid != result.new_revid:
925
log.show_branch_change(branch_to, self.outf, result.old_revno,
931
class cmd_push(Command):
932
"""Update a mirror of this branch.
934
The target branch will not have its working tree populated because this
935
is both expensive, and is not supported on remote file systems.
937
Some smart servers or protocols *may* put the working tree in place in
940
This command only works on branches that have not diverged. Branches are
941
considered diverged if the destination branch's most recent commit is one
942
that has not been merged (directly or indirectly) by the source branch.
944
If branches have diverged, you can use 'bzr push --overwrite' to replace
945
the other branch completely, discarding its unmerged changes.
947
If you want to ensure you have the different changes in the other branch,
948
do a merge (see bzr help merge) from the other branch, and commit that.
949
After that you will be able to do a push without '--overwrite'.
951
If there is no default push location set, the first push will set it.
952
After that, you can omit the location to use the default. To change the
953
default, use --remember. The value will only be saved if the remote
954
location can be accessed.
957
_see_also = ['pull', 'update', 'working-trees']
958
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
959
Option('create-prefix',
960
help='Create the path leading up to the branch '
961
'if it does not already exist.'),
963
help='Branch to push from, '
964
'rather than the one containing the working directory.',
968
Option('use-existing-dir',
969
help='By default push will fail if the target'
970
' directory exists, but does not already'
971
' have a control directory. This flag will'
972
' allow push to proceed.'),
974
help='Create a stacked branch that references the public location '
975
'of the parent branch.'),
977
help='Create a stacked branch that refers to another branch '
978
'for the commit history. Only the work not present in the '
979
'referenced branch is included in the branch created.',
982
takes_args = ['location?']
983
encoding_type = 'replace'
985
def run(self, location=None, remember=False, overwrite=False,
986
create_prefix=False, verbose=False, revision=None,
987
use_existing_dir=False, directory=None, stacked_on=None,
989
from bzrlib.push import _show_push_branch
991
# Get the source branch and revision_id
992
if directory is None:
994
br_from = Branch.open_containing(directory)[0]
995
revision = _get_one_revision('push', revision)
996
if revision is not None:
997
revision_id = revision.in_history(br_from).rev_id
999
revision_id = br_from.last_revision()
1001
# Get the stacked_on branch, if any
1002
if stacked_on is not None:
1003
stacked_on = urlutils.normalize_url(stacked_on)
1005
parent_url = br_from.get_parent()
1007
parent = Branch.open(parent_url)
1008
stacked_on = parent.get_public_branch()
1010
# I considered excluding non-http url's here, thus forcing
1011
# 'public' branches only, but that only works for some
1012
# users, so it's best to just depend on the user spotting an
1013
# error by the feedback given to them. RBC 20080227.
1014
stacked_on = parent_url
1016
raise errors.BzrCommandError(
1017
"Could not determine branch to refer to.")
1019
# Get the destination location
1020
if location is None:
1021
stored_loc = br_from.get_push_location()
1022
if stored_loc is None:
1023
raise errors.BzrCommandError(
1024
"No push location known or specified.")
1026
display_url = urlutils.unescape_for_display(stored_loc,
1028
self.outf.write("Using saved push location: %s\n" % display_url)
1029
location = stored_loc
1031
_show_push_branch(br_from, revision_id, location, self.outf,
1032
verbose=verbose, overwrite=overwrite, remember=remember,
1033
stacked_on=stacked_on, create_prefix=create_prefix,
1034
use_existing_dir=use_existing_dir)
1037
class cmd_branch(Command):
1038
"""Create a new copy of a branch.
1040
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1041
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1042
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1043
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1044
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1047
To retrieve the branch as of a particular revision, supply the --revision
1048
parameter, as in "branch foo/bar -r 5".
1051
_see_also = ['checkout']
1052
takes_args = ['from_location', 'to_location?']
1053
takes_options = ['revision', Option('hardlink',
1054
help='Hard-link working tree files where possible.'),
1056
help="Create a branch without a working-tree."),
1058
help='Create a stacked branch referring to the source branch. '
1059
'The new branch will depend on the availability of the source '
1060
'branch for all operations.'),
1061
Option('standalone',
1062
help='Do not use a shared repository, even if available.'),
1064
aliases = ['get', 'clone']
1066
def run(self, from_location, to_location=None, revision=None,
1067
hardlink=False, stacked=False, standalone=False, no_tree=False):
1068
from bzrlib.tag import _merge_tags_if_possible
1070
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1072
revision = _get_one_revision('branch', revision)
1075
if revision is not None:
1076
revision_id = revision.as_revision_id(br_from)
1078
# FIXME - wt.last_revision, fallback to branch, fall back to
1079
# None or perhaps NULL_REVISION to mean copy nothing
1081
revision_id = br_from.last_revision()
1082
if to_location is None:
1083
to_location = urlutils.derive_to_location(from_location)
1084
to_transport = transport.get_transport(to_location)
1086
to_transport.mkdir('.')
1087
except errors.FileExists:
1088
raise errors.BzrCommandError('Target directory "%s" already'
1089
' exists.' % to_location)
1090
except errors.NoSuchFile:
1091
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1094
# preserve whatever source format we have.
1095
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1096
possible_transports=[to_transport],
1097
accelerator_tree=accelerator_tree,
1098
hardlink=hardlink, stacked=stacked,
1099
force_new_repo=standalone,
1100
create_tree_if_local=not no_tree,
1101
source_branch=br_from)
1102
branch = dir.open_branch()
1103
except errors.NoSuchRevision:
1104
to_transport.delete_tree('.')
1105
msg = "The branch %s has no revision %s." % (from_location,
1107
raise errors.BzrCommandError(msg)
1108
_merge_tags_if_possible(br_from, branch)
1109
# If the source branch is stacked, the new branch may
1110
# be stacked whether we asked for that explicitly or not.
1111
# We therefore need a try/except here and not just 'if stacked:'
1113
note('Created new stacked branch referring to %s.' %
1114
branch.get_stacked_on_url())
1115
except (errors.NotStacked, errors.UnstackableBranchFormat,
1116
errors.UnstackableRepositoryFormat), e:
1117
note('Branched %d revision(s).' % branch.revno())
1122
class cmd_checkout(Command):
1123
"""Create a new checkout of an existing branch.
1125
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1126
the branch found in '.'. This is useful if you have removed the working tree
1127
or if it was never created - i.e. if you pushed the branch to its current
1128
location using SFTP.
1130
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1131
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1132
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1133
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1134
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1137
To retrieve the branch as of a particular revision, supply the --revision
1138
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1139
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1143
_see_also = ['checkouts', 'branch']
1144
takes_args = ['branch_location?', 'to_location?']
1145
takes_options = ['revision',
1146
Option('lightweight',
1147
help="Perform a lightweight checkout. Lightweight "
1148
"checkouts depend on access to the branch for "
1149
"every operation. Normal checkouts can perform "
1150
"common operations like diff and status without "
1151
"such access, and also support local commits."
1153
Option('files-from', type=str,
1154
help="Get file contents from this tree."),
1156
help='Hard-link working tree files where possible.'
1161
def run(self, branch_location=None, to_location=None, revision=None,
1162
lightweight=False, files_from=None, hardlink=False):
1163
if branch_location is None:
1164
branch_location = osutils.getcwd()
1165
to_location = branch_location
1166
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1168
revision = _get_one_revision('checkout', revision)
1169
if files_from is not None:
1170
accelerator_tree = WorkingTree.open(files_from)
1171
if revision is not None:
1172
revision_id = revision.as_revision_id(source)
1175
if to_location is None:
1176
to_location = urlutils.derive_to_location(branch_location)
1177
# if the source and to_location are the same,
1178
# and there is no working tree,
1179
# then reconstitute a branch
1180
if (osutils.abspath(to_location) ==
1181
osutils.abspath(branch_location)):
1183
source.bzrdir.open_workingtree()
1184
except errors.NoWorkingTree:
1185
source.bzrdir.create_workingtree(revision_id)
1187
source.create_checkout(to_location, revision_id, lightweight,
1188
accelerator_tree, hardlink)
1191
class cmd_renames(Command):
1192
"""Show list of renamed files.
1194
# TODO: Option to show renames between two historical versions.
1196
# TODO: Only show renames under dir, rather than in the whole branch.
1197
_see_also = ['status']
1198
takes_args = ['dir?']
1201
def run(self, dir=u'.'):
1202
tree = WorkingTree.open_containing(dir)[0]
1205
new_inv = tree.inventory
1206
old_tree = tree.basis_tree()
1207
old_tree.lock_read()
1209
old_inv = old_tree.inventory
1211
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1212
for f, paths, c, v, p, n, k, e in iterator:
1213
if paths[0] == paths[1]:
1217
renames.append(paths)
1219
for old_name, new_name in renames:
1220
self.outf.write("%s => %s\n" % (old_name, new_name))
1227
class cmd_update(Command):
1228
"""Update a tree to have the latest code committed to its branch.
1230
This will perform a merge into the working tree, and may generate
1231
conflicts. If you have any local changes, you will still
1232
need to commit them after the update for the update to be complete.
1234
If you want to discard your local changes, you can just do a
1235
'bzr revert' instead of 'bzr commit' after the update.
1238
_see_also = ['pull', 'working-trees', 'status-flags']
1239
takes_args = ['dir?']
1242
def run(self, dir='.'):
1243
tree = WorkingTree.open_containing(dir)[0]
1244
possible_transports = []
1245
master = tree.branch.get_master_branch(
1246
possible_transports=possible_transports)
1247
if master is not None:
1250
tree.lock_tree_write()
1252
existing_pending_merges = tree.get_parent_ids()[1:]
1253
last_rev = _mod_revision.ensure_null(tree.last_revision())
1254
if last_rev == _mod_revision.ensure_null(
1255
tree.branch.last_revision()):
1256
# may be up to date, check master too.
1257
if master is None or last_rev == _mod_revision.ensure_null(
1258
master.last_revision()):
1259
revno = tree.branch.revision_id_to_revno(last_rev)
1260
note("Tree is up to date at revision %d." % (revno,))
1262
view_info = _get_view_info_for_change_reporter(tree)
1263
conflicts = tree.update(
1264
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1265
view_info=view_info), possible_transports=possible_transports)
1266
revno = tree.branch.revision_id_to_revno(
1267
_mod_revision.ensure_null(tree.last_revision()))
1268
note('Updated to revision %d.' % (revno,))
1269
if tree.get_parent_ids()[1:] != existing_pending_merges:
1270
note('Your local commits will now show as pending merges with '
1271
"'bzr status', and can be committed with 'bzr commit'.")
1280
class cmd_info(Command):
1281
"""Show information about a working tree, branch or repository.
1283
This command will show all known locations and formats associated to the
1284
tree, branch or repository.
1286
In verbose mode, statistical information is included with each report.
1287
To see extended statistic information, use a verbosity level of 2 or
1288
higher by specifying the verbose option multiple times, e.g. -vv.
1290
Branches and working trees will also report any missing revisions.
1294
Display information on the format and related locations:
1298
Display the above together with extended format information and
1299
basic statistics (like the number of files in the working tree and
1300
number of revisions in the branch and repository):
1304
Display the above together with number of committers to the branch:
1308
_see_also = ['revno', 'working-trees', 'repositories']
1309
takes_args = ['location?']
1310
takes_options = ['verbose']
1311
encoding_type = 'replace'
1314
def run(self, location=None, verbose=False):
1316
noise_level = get_verbosity_level()
1319
from bzrlib.info import show_bzrdir_info
1320
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1321
verbose=noise_level, outfile=self.outf)
1324
class cmd_remove(Command):
1325
"""Remove files or directories.
1327
This makes bzr stop tracking changes to the specified files. bzr will delete
1328
them if they can easily be recovered using revert. If no options or
1329
parameters are given bzr will scan for files that are being tracked by bzr
1330
but missing in your tree and stop tracking them for you.
1332
takes_args = ['file*']
1333
takes_options = ['verbose',
1334
Option('new', help='Only remove files that have never been committed.'),
1335
RegistryOption.from_kwargs('file-deletion-strategy',
1336
'The file deletion mode to be used.',
1337
title='Deletion Strategy', value_switches=True, enum_switch=False,
1338
safe='Only delete files if they can be'
1339
' safely recovered (default).',
1340
keep="Don't delete any files.",
1341
force='Delete all the specified files, even if they can not be '
1342
'recovered and even if they are non-empty directories.')]
1343
aliases = ['rm', 'del']
1344
encoding_type = 'replace'
1346
def run(self, file_list, verbose=False, new=False,
1347
file_deletion_strategy='safe'):
1348
tree, file_list = tree_files(file_list)
1350
if file_list is not None:
1351
file_list = [f for f in file_list]
1355
# Heuristics should probably all move into tree.remove_smart or
1358
added = tree.changes_from(tree.basis_tree(),
1359
specific_files=file_list).added
1360
file_list = sorted([f[0] for f in added], reverse=True)
1361
if len(file_list) == 0:
1362
raise errors.BzrCommandError('No matching files.')
1363
elif file_list is None:
1364
# missing files show up in iter_changes(basis) as
1365
# versioned-with-no-kind.
1367
for change in tree.iter_changes(tree.basis_tree()):
1368
# Find paths in the working tree that have no kind:
1369
if change[1][1] is not None and change[6][1] is None:
1370
missing.append(change[1][1])
1371
file_list = sorted(missing, reverse=True)
1372
file_deletion_strategy = 'keep'
1373
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1374
keep_files=file_deletion_strategy=='keep',
1375
force=file_deletion_strategy=='force')
1380
class cmd_file_id(Command):
1381
"""Print file_id of a particular file or directory.
1383
The file_id is assigned when the file is first added and remains the
1384
same through all revisions where the file exists, even when it is
1389
_see_also = ['inventory', 'ls']
1390
takes_args = ['filename']
1393
def run(self, filename):
1394
tree, relpath = WorkingTree.open_containing(filename)
1395
i = tree.path2id(relpath)
1397
raise errors.NotVersionedError(filename)
1399
self.outf.write(i + '\n')
1402
class cmd_file_path(Command):
1403
"""Print path of file_ids to a file or directory.
1405
This prints one line for each directory down to the target,
1406
starting at the branch root.
1410
takes_args = ['filename']
1413
def run(self, filename):
1414
tree, relpath = WorkingTree.open_containing(filename)
1415
fid = tree.path2id(relpath)
1417
raise errors.NotVersionedError(filename)
1418
segments = osutils.splitpath(relpath)
1419
for pos in range(1, len(segments) + 1):
1420
path = osutils.joinpath(segments[:pos])
1421
self.outf.write("%s\n" % tree.path2id(path))
1424
class cmd_reconcile(Command):
1425
"""Reconcile bzr metadata in a branch.
1427
This can correct data mismatches that may have been caused by
1428
previous ghost operations or bzr upgrades. You should only
1429
need to run this command if 'bzr check' or a bzr developer
1430
advises you to run it.
1432
If a second branch is provided, cross-branch reconciliation is
1433
also attempted, which will check that data like the tree root
1434
id which was not present in very early bzr versions is represented
1435
correctly in both branches.
1437
At the same time it is run it may recompress data resulting in
1438
a potential saving in disk space or performance gain.
1440
The branch *MUST* be on a listable system such as local disk or sftp.
1443
_see_also = ['check']
1444
takes_args = ['branch?']
1446
def run(self, branch="."):
1447
from bzrlib.reconcile import reconcile
1448
dir = bzrdir.BzrDir.open(branch)
1452
class cmd_revision_history(Command):
1453
"""Display the list of revision ids on a branch."""
1456
takes_args = ['location?']
1461
def run(self, location="."):
1462
branch = Branch.open_containing(location)[0]
1463
for revid in branch.revision_history():
1464
self.outf.write(revid)
1465
self.outf.write('\n')
1468
class cmd_ancestry(Command):
1469
"""List all revisions merged into this branch."""
1471
_see_also = ['log', 'revision-history']
1472
takes_args = ['location?']
1477
def run(self, location="."):
1479
wt = WorkingTree.open_containing(location)[0]
1480
except errors.NoWorkingTree:
1481
b = Branch.open(location)
1482
last_revision = b.last_revision()
1485
last_revision = wt.last_revision()
1487
revision_ids = b.repository.get_ancestry(last_revision)
1489
for revision_id in revision_ids:
1490
self.outf.write(revision_id + '\n')
1493
class cmd_init(Command):
1494
"""Make a directory into a versioned branch.
1496
Use this to create an empty branch, or before importing an
1499
If there is a repository in a parent directory of the location, then
1500
the history of the branch will be stored in the repository. Otherwise
1501
init creates a standalone branch which carries its own history
1502
in the .bzr directory.
1504
If there is already a branch at the location but it has no working tree,
1505
the tree can be populated with 'bzr checkout'.
1507
Recipe for importing a tree of files::
1513
bzr commit -m "imported project"
1516
_see_also = ['init-repository', 'branch', 'checkout']
1517
takes_args = ['location?']
1519
Option('create-prefix',
1520
help='Create the path leading up to the branch '
1521
'if it does not already exist.'),
1522
RegistryOption('format',
1523
help='Specify a format for this branch. '
1524
'See "help formats".',
1525
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1526
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1527
value_switches=True,
1528
title="Branch Format",
1530
Option('append-revisions-only',
1531
help='Never change revnos or the existing log.'
1532
' Append revisions to it only.')
1534
def run(self, location=None, format=None, append_revisions_only=False,
1535
create_prefix=False):
1537
format = bzrdir.format_registry.make_bzrdir('default')
1538
if location is None:
1541
to_transport = transport.get_transport(location)
1543
# The path has to exist to initialize a
1544
# branch inside of it.
1545
# Just using os.mkdir, since I don't
1546
# believe that we want to create a bunch of
1547
# locations if the user supplies an extended path
1549
to_transport.ensure_base()
1550
except errors.NoSuchFile:
1551
if not create_prefix:
1552
raise errors.BzrCommandError("Parent directory of %s"
1554
"\nYou may supply --create-prefix to create all"
1555
" leading parent directories."
1557
_create_prefix(to_transport)
1560
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1561
except errors.NotBranchError:
1562
# really a NotBzrDir error...
1563
create_branch = bzrdir.BzrDir.create_branch_convenience
1564
branch = create_branch(to_transport.base, format=format,
1565
possible_transports=[to_transport])
1566
a_bzrdir = branch.bzrdir
1568
from bzrlib.transport.local import LocalTransport
1569
if a_bzrdir.has_branch():
1570
if (isinstance(to_transport, LocalTransport)
1571
and not a_bzrdir.has_workingtree()):
1572
raise errors.BranchExistsWithoutWorkingTree(location)
1573
raise errors.AlreadyBranchError(location)
1574
branch = a_bzrdir.create_branch()
1575
a_bzrdir.create_workingtree()
1576
if append_revisions_only:
1578
branch.set_append_revisions_only(True)
1579
except errors.UpgradeRequired:
1580
raise errors.BzrCommandError('This branch format cannot be set'
1581
' to append-revisions-only. Try --experimental-branch6')
1583
from bzrlib.info import describe_layout, describe_format
1585
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1586
except (errors.NoWorkingTree, errors.NotLocalUrl):
1588
repository = branch.repository
1589
layout = describe_layout(repository, branch, tree).lower()
1590
format = describe_format(a_bzrdir, repository, branch, tree)
1591
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1592
if repository.is_shared():
1593
#XXX: maybe this can be refactored into transport.path_or_url()
1594
url = repository.bzrdir.root_transport.external_url()
1596
url = urlutils.local_path_from_url(url)
1597
except errors.InvalidURL:
1599
self.outf.write("Using shared repository: %s\n" % url)
1602
class cmd_init_repository(Command):
1603
"""Create a shared repository to hold branches.
1605
New branches created under the repository directory will store their
1606
revisions in the repository, not in the branch directory.
1608
If the --no-trees option is used then the branches in the repository
1609
will not have working trees by default.
1612
Create a shared repositories holding just branches::
1614
bzr init-repo --no-trees repo
1617
Make a lightweight checkout elsewhere::
1619
bzr checkout --lightweight repo/trunk trunk-checkout
1624
_see_also = ['init', 'branch', 'checkout', 'repositories']
1625
takes_args = ["location"]
1626
takes_options = [RegistryOption('format',
1627
help='Specify a format for this repository. See'
1628
' "bzr help formats" for details.',
1629
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1630
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1631
value_switches=True, title='Repository format'),
1633
help='Branches in the repository will default to'
1634
' not having a working tree.'),
1636
aliases = ["init-repo"]
1638
def run(self, location, format=None, no_trees=False):
1640
format = bzrdir.format_registry.make_bzrdir('default')
1642
if location is None:
1645
to_transport = transport.get_transport(location)
1646
to_transport.ensure_base()
1648
newdir = format.initialize_on_transport(to_transport)
1649
repo = newdir.create_repository(shared=True)
1650
repo.set_make_working_trees(not no_trees)
1652
from bzrlib.info import show_bzrdir_info
1653
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1656
class cmd_diff(Command):
1657
"""Show differences in the working tree, between revisions or branches.
1659
If no arguments are given, all changes for the current tree are listed.
1660
If files are given, only the changes in those files are listed.
1661
Remote and multiple branches can be compared by using the --old and
1662
--new options. If not provided, the default for both is derived from
1663
the first argument, if any, or the current tree if no arguments are
1666
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1667
produces patches suitable for "patch -p1".
1671
2 - unrepresentable changes
1676
Shows the difference in the working tree versus the last commit::
1680
Difference between the working tree and revision 1::
1684
Difference between revision 2 and revision 1::
1688
Difference between revision 2 and revision 1 for branch xxx::
1692
Show just the differences for file NEWS::
1696
Show the differences in working tree xxx for file NEWS::
1700
Show the differences from branch xxx to this working tree:
1704
Show the differences between two branches for file NEWS::
1706
bzr diff --old xxx --new yyy NEWS
1708
Same as 'bzr diff' but prefix paths with old/ and new/::
1710
bzr diff --prefix old/:new/
1712
_see_also = ['status']
1713
takes_args = ['file*']
1715
Option('diff-options', type=str,
1716
help='Pass these options to the external diff program.'),
1717
Option('prefix', type=str,
1719
help='Set prefixes added to old and new filenames, as '
1720
'two values separated by a colon. (eg "old/:new/").'),
1722
help='Branch/tree to compare from.',
1726
help='Branch/tree to compare to.',
1732
help='Use this command to compare files.',
1736
aliases = ['di', 'dif']
1737
encoding_type = 'exact'
1740
def run(self, revision=None, file_list=None, diff_options=None,
1741
prefix=None, old=None, new=None, using=None):
1742
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1744
if (prefix is None) or (prefix == '0'):
1752
old_label, new_label = prefix.split(":")
1754
raise errors.BzrCommandError(
1755
'--prefix expects two values separated by a colon'
1756
' (eg "old/:new/")')
1758
if revision and len(revision) > 2:
1759
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1760
' one or two revision specifiers')
1762
old_tree, new_tree, specific_files, extra_trees = \
1763
_get_trees_to_diff(file_list, revision, old, new,
1765
return show_diff_trees(old_tree, new_tree, sys.stdout,
1766
specific_files=specific_files,
1767
external_diff_options=diff_options,
1768
old_label=old_label, new_label=new_label,
1769
extra_trees=extra_trees, using=using)
1772
class cmd_deleted(Command):
1773
"""List files deleted in the working tree.
1775
# TODO: Show files deleted since a previous revision, or
1776
# between two revisions.
1777
# TODO: Much more efficient way to do this: read in new
1778
# directories with readdir, rather than stating each one. Same
1779
# level of effort but possibly much less IO. (Or possibly not,
1780
# if the directories are very large...)
1781
_see_also = ['status', 'ls']
1782
takes_options = ['show-ids']
1785
def run(self, show_ids=False):
1786
tree = WorkingTree.open_containing(u'.')[0]
1789
old = tree.basis_tree()
1792
for path, ie in old.inventory.iter_entries():
1793
if not tree.has_id(ie.file_id):
1794
self.outf.write(path)
1796
self.outf.write(' ')
1797
self.outf.write(ie.file_id)
1798
self.outf.write('\n')
1805
class cmd_modified(Command):
1806
"""List files modified in working tree.
1810
_see_also = ['status', 'ls']
1813
help='Write an ascii NUL (\\0) separator '
1814
'between files rather than a newline.')
1818
def run(self, null=False):
1819
tree = WorkingTree.open_containing(u'.')[0]
1820
td = tree.changes_from(tree.basis_tree())
1821
for path, id, kind, text_modified, meta_modified in td.modified:
1823
self.outf.write(path + '\0')
1825
self.outf.write(osutils.quotefn(path) + '\n')
1828
class cmd_added(Command):
1829
"""List files added in working tree.
1833
_see_also = ['status', 'ls']
1836
help='Write an ascii NUL (\\0) separator '
1837
'between files rather than a newline.')
1841
def run(self, null=False):
1842
wt = WorkingTree.open_containing(u'.')[0]
1845
basis = wt.basis_tree()
1848
basis_inv = basis.inventory
1851
if file_id in basis_inv:
1853
if inv.is_root(file_id) and len(basis_inv) == 0:
1855
path = inv.id2path(file_id)
1856
if not os.access(osutils.abspath(path), os.F_OK):
1859
self.outf.write(path + '\0')
1861
self.outf.write(osutils.quotefn(path) + '\n')
1868
class cmd_root(Command):
1869
"""Show the tree root directory.
1871
The root is the nearest enclosing directory with a .bzr control
1874
takes_args = ['filename?']
1876
def run(self, filename=None):
1877
"""Print the branch root."""
1878
tree = WorkingTree.open_containing(filename)[0]
1879
self.outf.write(tree.basedir + '\n')
1882
def _parse_limit(limitstring):
1884
return int(limitstring)
1886
msg = "The limit argument must be an integer."
1887
raise errors.BzrCommandError(msg)
1890
def _parse_levels(s):
1894
msg = "The levels argument must be an integer."
1895
raise errors.BzrCommandError(msg)
1898
class cmd_log(Command):
1899
"""Show historical log for a branch or subset of a branch.
1901
log is bzr's default tool for exploring the history of a branch.
1902
The branch to use is taken from the first parameter. If no parameters
1903
are given, the branch containing the working directory is logged.
1904
Here are some simple examples::
1906
bzr log log the current branch
1907
bzr log foo.py log a file in its branch
1908
bzr log http://server/branch log a branch on a server
1910
The filtering, ordering and information shown for each revision can
1911
be controlled as explained below. By default, all revisions are
1912
shown sorted (topologically) so that newer revisions appear before
1913
older ones and descendants always appear before ancestors. If displayed,
1914
merged revisions are shown indented under the revision in which they
1919
The log format controls how information about each revision is
1920
displayed. The standard log formats are called ``long``, ``short``
1921
and ``line``. The default is long. See ``bzr help log-formats``
1922
for more details on log formats.
1924
The following options can be used to control what information is
1927
-l N display a maximum of N revisions
1928
-n N display N levels of revisions (0 for all, 1 for collapsed)
1929
-v display a status summary (delta) for each revision
1930
-p display a diff (patch) for each revision
1931
--show-ids display revision-ids (and file-ids), not just revnos
1933
Note that the default number of levels to display is a function of the
1934
log format. If the -n option is not used, ``short`` and ``line`` show
1935
just the top level (mainline) while ``long`` shows all levels of merged
1938
Status summaries are shown using status flags like A, M, etc. To see
1939
the changes explained using words like ``added`` and ``modified``
1940
instead, use the -vv option.
1944
To display revisions from oldest to newest, use the --forward option.
1945
In most cases, using this option will have little impact on the total
1946
time taken to produce a log, though --forward does not incrementally
1947
display revisions like --reverse does when it can.
1949
:Revision filtering:
1951
The -r option can be used to specify what revision or range of revisions
1952
to filter against. The various forms are shown below::
1954
-rX display revision X
1955
-rX.. display revision X and later
1956
-r..Y display up to and including revision Y
1957
-rX..Y display from X to Y inclusive
1959
See ``bzr help revisionspec`` for details on how to specify X and Y.
1960
Some common examples are given below::
1962
-r-1 show just the tip
1963
-r-10.. show the last 10 mainline revisions
1964
-rsubmit:.. show what's new on this branch
1965
-rancestor:path.. show changes since the common ancestor of this
1966
branch and the one at location path
1967
-rdate:yesterday.. show changes since yesterday
1969
When logging a range of revisions using -rX..Y, log starts at
1970
revision Y and searches back in history through the primary
1971
("left-hand") parents until it finds X. When logging just the
1972
top level (using -n1), an error is reported if X is not found
1973
along the way. If multi-level logging is used (-n0), X may be
1974
a nested merge revision and the log will be truncated accordingly.
1978
If a parameter is given and it's not a branch, the log will be filtered
1979
to show only those revisions that changed the nominated file or
1982
Filenames are interpreted within their historical context. To log a
1983
deleted file, specify a revision range so that the file existed at
1984
the end or start of the range.
1986
Historical context is also important when interpreting pathnames of
1987
renamed files/directories. Consider the following example:
1989
* revision 1: add tutorial.txt
1990
* revision 2: modify tutorial.txt
1991
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
1995
* ``bzr log guide.txt`` will log the file added in revision 1
1997
* ``bzr log tutorial.txt`` will log the new file added in revision 3
1999
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2000
the original file in revision 2.
2002
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2003
was no file called guide.txt in revision 2.
2005
Renames are always followed by log. By design, there is no need to
2006
explicitly ask for this (and no way to stop logging a file back
2007
until it was last renamed).
2009
Note: If the path is a directory, only revisions that directly changed
2010
that directory object are currently shown. This is considered a bug.
2011
(Support for filtering against multiple files and for files within a
2012
directory is under development.)
2016
The --message option can be used for finding revisions that match a
2017
regular expression in a commit message.
2021
GUI tools and IDEs are often better at exploring history than command
2022
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2023
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2024
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2026
Web interfaces are often better at exploring history than command line
2027
tools, particularly for branches on servers. You may prefer Loggerhead
2028
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2030
You may find it useful to add the aliases below to ``bazaar.conf``::
2034
top = log -r-10.. --short --forward
2035
show = log -v -p -n1 --long
2037
``bzr tip`` will then show the latest revision while ``bzr top``
2038
will show the last 10 mainline revisions. To see the details of a
2039
particular revision X, ``bzr show -rX``.
2041
As many GUI tools and Web interfaces do, you may prefer viewing
2042
history collapsed initially. If you are interested in looking deeper
2043
into a particular merge X, use ``bzr log -n0 -rX``. If you like
2044
working this way, you may wish to either:
2046
* change your default log format to short (or line)
2047
* add this alias: log = log -n1
2049
``bzr log -v`` on a branch with lots of history is currently
2050
very slow. A fix for this issue is currently under development.
2051
With or without that fix, it is recommended that a revision range
2052
be given when using the -v option.
2054
bzr has a generic full-text matching plugin, bzr-search, that can be
2055
used to find revisions matching user names, commit messages, etc.
2056
Among other features, this plugin can find all revisions containing
2057
a list of words but not others.
2059
When exploring non-mainline history on large projects with deep
2060
history, the performance of log can be greatly improved by installing
2061
the revnocache plugin. This plugin buffers historical information
2062
trading disk space for faster speed.
2064
takes_args = ['location?']
2065
_see_also = ['log-formats', 'revisionspec']
2068
help='Show from oldest to newest.'),
2070
custom_help('verbose',
2071
help='Show files changed in each revision.'),
2075
type=bzrlib.option._parse_revision_str,
2077
help='Show just the specified revision.'
2078
' See also "help revisionspec".'),
2082
help='Number of levels to display - 0 for all, 1 for flat.',
2084
type=_parse_levels),
2087
help='Show revisions whose message matches this '
2088
'regular expression.',
2092
help='Limit the output to the first N revisions.',
2097
help='Show changes made in each revision as a patch.'),
2099
encoding_type = 'replace'
2102
def run(self, location=None, timezone='original',
2113
from bzrlib.log import show_log, _get_fileid_to_log
2114
direction = (forward and 'forward') or 'reverse'
2116
if change is not None:
2118
raise errors.RangeInChangeOption()
2119
if revision is not None:
2120
raise errors.BzrCommandError(
2121
'--revision and --change are mutually exclusive')
2128
# find the file id to log:
2130
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
2133
file_id = _get_fileid_to_log(revision, tree, b, fp)
2135
raise errors.BzrCommandError(
2136
"Path unknown at end or start of revision range: %s" %
2140
# FIXME ? log the current subdir only RBC 20060203
2141
if revision is not None \
2142
and len(revision) > 0 and revision[0].get_branch():
2143
location = revision[0].get_branch()
2146
dir, relpath = bzrdir.BzrDir.open_containing(location)
2147
b = dir.open_branch()
2151
rev1, rev2 = _get_revision_range(revision, b, self.name())
2152
if log_format is None:
2153
log_format = log.log_formatter_registry.get_default(b)
2155
lf = log_format(show_ids=show_ids, to_file=self.outf,
2156
show_timezone=timezone,
2157
delta_format=get_verbosity_level(),
2164
direction=direction,
2165
start_revision=rev1,
2169
show_diff=show_diff)
2174
def _get_revision_range(revisionspec_list, branch, command_name):
2175
"""Take the input of a revision option and turn it into a revision range.
2177
It returns RevisionInfo objects which can be used to obtain the rev_id's
2178
of the desired revisons. It does some user input validations.
2180
if revisionspec_list is None:
2183
elif len(revisionspec_list) == 1:
2184
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2185
elif len(revisionspec_list) == 2:
2186
start_spec = revisionspec_list[0]
2187
end_spec = revisionspec_list[1]
2188
if end_spec.get_branch() != start_spec.get_branch():
2189
# b is taken from revision[0].get_branch(), and
2190
# show_log will use its revision_history. Having
2191
# different branches will lead to weird behaviors.
2192
raise errors.BzrCommandError(
2193
"bzr %s doesn't accept two revisions in different"
2194
" branches." % command_name)
2195
rev1 = start_spec.in_history(branch)
2196
# Avoid loading all of history when we know a missing
2197
# end of range means the last revision ...
2198
if end_spec.spec is None:
2199
last_revno, last_revision_id = branch.last_revision_info()
2200
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2202
rev2 = end_spec.in_history(branch)
2204
raise errors.BzrCommandError(
2205
'bzr %s --revision takes one or two values.' % command_name)
2209
def _revision_range_to_revid_range(revision_range):
2212
if revision_range[0] is not None:
2213
rev_id1 = revision_range[0].rev_id
2214
if revision_range[1] is not None:
2215
rev_id2 = revision_range[1].rev_id
2216
return rev_id1, rev_id2
2218
def get_log_format(long=False, short=False, line=False, default='long'):
2219
log_format = default
2223
log_format = 'short'
2229
class cmd_touching_revisions(Command):
2230
"""Return revision-ids which affected a particular file.
2232
A more user-friendly interface is "bzr log FILE".
2236
takes_args = ["filename"]
2239
def run(self, filename):
2240
tree, relpath = WorkingTree.open_containing(filename)
2242
file_id = tree.path2id(relpath)
2243
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2244
self.outf.write("%6d %s\n" % (revno, what))
2247
class cmd_ls(Command):
2248
"""List files in a tree.
2251
_see_also = ['status', 'cat']
2252
takes_args = ['path?']
2253
# TODO: Take a revision or remote path and list that tree instead.
2257
Option('non-recursive',
2258
help='Don\'t recurse into subdirectories.'),
2260
help='Print paths relative to the root of the branch.'),
2261
Option('unknown', help='Print unknown files.'),
2262
Option('versioned', help='Print versioned files.',
2264
Option('ignored', help='Print ignored files.'),
2266
help='Write an ascii NUL (\\0) separator '
2267
'between files rather than a newline.'),
2269
help='List entries of a particular kind: file, directory, symlink.',
2274
def run(self, revision=None, verbose=False,
2275
non_recursive=False, from_root=False,
2276
unknown=False, versioned=False, ignored=False,
2277
null=False, kind=None, show_ids=False, path=None):
2279
if kind and kind not in ('file', 'directory', 'symlink'):
2280
raise errors.BzrCommandError('invalid kind specified')
2282
if verbose and null:
2283
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2284
all = not (unknown or versioned or ignored)
2286
selection = {'I':ignored, '?':unknown, 'V':versioned}
2293
raise errors.BzrCommandError('cannot specify both --from-root'
2297
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2303
if revision is not None or tree is None:
2304
tree = _get_one_revision_tree('ls', revision, branch=branch)
2307
if isinstance(tree, WorkingTree) and tree.supports_views():
2308
view_files = tree.views.lookup_view()
2311
view_str = views.view_display_str(view_files)
2312
note("ignoring files outside view: %s" % view_str)
2316
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
2317
if fp.startswith(relpath):
2318
fp = osutils.pathjoin(prefix, fp[len(relpath):])
2319
if non_recursive and '/' in fp:
2321
if not all and not selection[fc]:
2323
if kind is not None and fkind != kind:
2327
views.check_path_in_view(tree, fp)
2328
except errors.FileOutsideView:
2330
kindch = entry.kind_character()
2331
outstring = fp + kindch
2333
outstring = '%-8s %s' % (fc, outstring)
2334
if show_ids and fid is not None:
2335
outstring = "%-50s %s" % (outstring, fid)
2336
self.outf.write(outstring + '\n')
2338
self.outf.write(fp + '\0')
2341
self.outf.write(fid)
2342
self.outf.write('\0')
2350
self.outf.write('%-50s %s\n' % (outstring, my_id))
2352
self.outf.write(outstring + '\n')
2357
class cmd_unknowns(Command):
2358
"""List unknown files.
2366
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2367
self.outf.write(osutils.quotefn(f) + '\n')
2370
class cmd_ignore(Command):
2371
"""Ignore specified files or patterns.
2373
See ``bzr help patterns`` for details on the syntax of patterns.
2375
To remove patterns from the ignore list, edit the .bzrignore file.
2376
After adding, editing or deleting that file either indirectly by
2377
using this command or directly by using an editor, be sure to commit
2380
Note: ignore patterns containing shell wildcards must be quoted from
2384
Ignore the top level Makefile::
2386
bzr ignore ./Makefile
2388
Ignore class files in all directories::
2390
bzr ignore "*.class"
2392
Ignore .o files under the lib directory::
2394
bzr ignore "lib/**/*.o"
2396
Ignore .o files under the lib directory::
2398
bzr ignore "RE:lib/.*\.o"
2400
Ignore everything but the "debian" toplevel directory::
2402
bzr ignore "RE:(?!debian/).*"
2405
_see_also = ['status', 'ignored', 'patterns']
2406
takes_args = ['name_pattern*']
2408
Option('old-default-rules',
2409
help='Write out the ignore rules bzr < 0.9 always used.')
2412
def run(self, name_pattern_list=None, old_default_rules=None):
2413
from bzrlib import ignores
2414
if old_default_rules is not None:
2415
# dump the rules and exit
2416
for pattern in ignores.OLD_DEFAULTS:
2419
if not name_pattern_list:
2420
raise errors.BzrCommandError("ignore requires at least one "
2421
"NAME_PATTERN or --old-default-rules")
2422
name_pattern_list = [globbing.normalize_pattern(p)
2423
for p in name_pattern_list]
2424
for name_pattern in name_pattern_list:
2425
if (name_pattern[0] == '/' or
2426
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2427
raise errors.BzrCommandError(
2428
"NAME_PATTERN should not be an absolute path")
2429
tree, relpath = WorkingTree.open_containing(u'.')
2430
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2431
ignored = globbing.Globster(name_pattern_list)
2434
for entry in tree.list_files():
2438
if ignored.match(filename):
2439
matches.append(filename.encode('utf-8'))
2441
if len(matches) > 0:
2442
print "Warning: the following files are version controlled and" \
2443
" match your ignore pattern:\n%s" \
2444
"\nThese files will continue to be version controlled" \
2445
" unless you 'bzr remove' them." % ("\n".join(matches),)
2448
class cmd_ignored(Command):
2449
"""List ignored files and the patterns that matched them.
2451
List all the ignored files and the ignore pattern that caused the file to
2454
Alternatively, to list just the files::
2459
encoding_type = 'replace'
2460
_see_also = ['ignore', 'ls']
2464
tree = WorkingTree.open_containing(u'.')[0]
2467
for path, file_class, kind, file_id, entry in tree.list_files():
2468
if file_class != 'I':
2470
## XXX: Slightly inefficient since this was already calculated
2471
pat = tree.is_ignored(path)
2472
self.outf.write('%-50s %s\n' % (path, pat))
2477
class cmd_lookup_revision(Command):
2478
"""Lookup the revision-id from a revision-number
2481
bzr lookup-revision 33
2484
takes_args = ['revno']
2487
def run(self, revno):
2491
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2493
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2496
class cmd_export(Command):
2497
"""Export current or past revision to a destination directory or archive.
2499
If no revision is specified this exports the last committed revision.
2501
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2502
given, try to find the format with the extension. If no extension
2503
is found exports to a directory (equivalent to --format=dir).
2505
If root is supplied, it will be used as the root directory inside
2506
container formats (tar, zip, etc). If it is not supplied it will default
2507
to the exported filename. The root option has no effect for 'dir' format.
2509
If branch is omitted then the branch containing the current working
2510
directory will be used.
2512
Note: Export of tree with non-ASCII filenames to zip is not supported.
2514
================= =========================
2515
Supported formats Autodetected by extension
2516
================= =========================
2519
tbz2 .tar.bz2, .tbz2
2522
================= =========================
2524
takes_args = ['dest', 'branch_or_subdir?']
2527
help="Type of file to export to.",
2530
Option('filters', help='Apply content filters to export the '
2531
'convenient form.'),
2534
help="Name of the root directory inside the exported file."),
2536
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2537
root=None, filters=False):
2538
from bzrlib.export import export
2540
if branch_or_subdir is None:
2541
tree = WorkingTree.open_containing(u'.')[0]
2545
b, subdir = Branch.open_containing(branch_or_subdir)
2548
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2550
export(rev_tree, dest, format, root, subdir, filtered=filters)
2551
except errors.NoSuchExportFormat, e:
2552
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2555
class cmd_cat(Command):
2556
"""Write the contents of a file as of a given revision to standard output.
2558
If no revision is nominated, the last revision is used.
2560
Note: Take care to redirect standard output when using this command on a
2566
Option('name-from-revision', help='The path name in the old tree.'),
2567
Option('filters', help='Apply content filters to display the '
2568
'convenience form.'),
2571
takes_args = ['filename']
2572
encoding_type = 'exact'
2575
def run(self, filename, revision=None, name_from_revision=False,
2577
if revision is not None and len(revision) != 1:
2578
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2579
" one revision specifier")
2580
tree, branch, relpath = \
2581
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2584
return self._run(tree, branch, relpath, filename, revision,
2585
name_from_revision, filters)
2589
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2592
tree = b.basis_tree()
2593
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2595
old_file_id = rev_tree.path2id(relpath)
2597
if name_from_revision:
2598
# Try in revision if requested
2599
if old_file_id is None:
2600
raise errors.BzrCommandError(
2601
"%r is not present in revision %s" % (
2602
filename, rev_tree.get_revision_id()))
2604
content = rev_tree.get_file_text(old_file_id)
2606
cur_file_id = tree.path2id(relpath)
2608
if cur_file_id is not None:
2609
# Then try with the actual file id
2611
content = rev_tree.get_file_text(cur_file_id)
2613
except errors.NoSuchId:
2614
# The actual file id didn't exist at that time
2616
if not found and old_file_id is not None:
2617
# Finally try with the old file id
2618
content = rev_tree.get_file_text(old_file_id)
2621
# Can't be found anywhere
2622
raise errors.BzrCommandError(
2623
"%r is not present in revision %s" % (
2624
filename, rev_tree.get_revision_id()))
2626
from bzrlib.filters import (
2627
ContentFilterContext,
2628
filtered_output_bytes,
2630
filters = rev_tree._content_filter_stack(relpath)
2631
chunks = content.splitlines(True)
2632
content = filtered_output_bytes(chunks, filters,
2633
ContentFilterContext(relpath, rev_tree))
2634
self.outf.writelines(content)
2636
self.outf.write(content)
2639
class cmd_local_time_offset(Command):
2640
"""Show the offset in seconds from GMT to local time."""
2644
print osutils.local_time_offset()
2648
class cmd_commit(Command):
2649
"""Commit changes into a new revision.
2651
If no arguments are given, the entire tree is committed.
2653
If selected files are specified, only changes to those files are
2654
committed. If a directory is specified then the directory and everything
2655
within it is committed.
2657
When excludes are given, they take precedence over selected files.
2658
For example, too commit only changes within foo, but not changes within
2661
bzr commit foo -x foo/bar
2663
If author of the change is not the same person as the committer, you can
2664
specify the author's name using the --author option. The name should be
2665
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2666
If there is more than one author of the change you can specify the option
2667
multiple times, once for each author.
2669
A selected-file commit may fail in some cases where the committed
2670
tree would be invalid. Consider::
2675
bzr commit foo -m "committing foo"
2676
bzr mv foo/bar foo/baz
2679
bzr commit foo/bar -m "committing bar but not baz"
2681
In the example above, the last commit will fail by design. This gives
2682
the user the opportunity to decide whether they want to commit the
2683
rename at the same time, separately first, or not at all. (As a general
2684
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2686
Note: A selected-file commit after a merge is not yet supported.
2688
# TODO: Run hooks on tree to-be-committed, and after commit.
2690
# TODO: Strict commit that fails if there are deleted files.
2691
# (what does "deleted files" mean ??)
2693
# TODO: Give better message for -s, --summary, used by tla people
2695
# XXX: verbose currently does nothing
2697
_see_also = ['bugs', 'uncommit']
2698
takes_args = ['selected*']
2700
ListOption('exclude', type=str, short_name='x',
2701
help="Do not consider changes made to a given path."),
2702
Option('message', type=unicode,
2704
help="Description of the new revision."),
2707
help='Commit even if nothing has changed.'),
2708
Option('file', type=str,
2711
help='Take commit message from this file.'),
2713
help="Refuse to commit if there are unknown "
2714
"files in the working tree."),
2715
ListOption('fixes', type=str,
2716
help="Mark a bug as being fixed by this revision "
2717
"(see \"bzr help bugs\")."),
2718
ListOption('author', type=unicode,
2719
help="Set the author's name, if it's different "
2720
"from the committer."),
2722
help="Perform a local commit in a bound "
2723
"branch. Local commits are not pushed to "
2724
"the master branch until a normal commit "
2728
help='When no message is supplied, show the diff along'
2729
' with the status summary in the message editor.'),
2731
aliases = ['ci', 'checkin']
2733
def _iter_bug_fix_urls(self, fixes, branch):
2734
# Configure the properties for bug fixing attributes.
2735
for fixed_bug in fixes:
2736
tokens = fixed_bug.split(':')
2737
if len(tokens) != 2:
2738
raise errors.BzrCommandError(
2739
"Invalid bug %s. Must be in the form of 'tracker:id'. "
2740
"See \"bzr help bugs\" for more information on this "
2741
"feature.\nCommit refused." % fixed_bug)
2742
tag, bug_id = tokens
2744
yield bugtracker.get_bug_url(tag, branch, bug_id)
2745
except errors.UnknownBugTrackerAbbreviation:
2746
raise errors.BzrCommandError(
2747
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2748
except errors.MalformedBugIdentifier, e:
2749
raise errors.BzrCommandError(
2750
"%s\nCommit refused." % (str(e),))
2752
def run(self, message=None, file=None, verbose=False, selected_list=None,
2753
unchanged=False, strict=False, local=False, fixes=None,
2754
author=None, show_diff=False, exclude=None):
2755
from bzrlib.errors import (
2760
from bzrlib.msgeditor import (
2761
edit_commit_message_encoded,
2762
generate_commit_message_template,
2763
make_commit_message_template_encoded
2766
# TODO: Need a blackbox test for invoking the external editor; may be
2767
# slightly problematic to run this cross-platform.
2769
# TODO: do more checks that the commit will succeed before
2770
# spending the user's valuable time typing a commit message.
2774
tree, selected_list = tree_files(selected_list)
2775
if selected_list == ['']:
2776
# workaround - commit of root of tree should be exactly the same
2777
# as just default commit in that tree, and succeed even though
2778
# selected-file merge commit is not done yet
2783
bug_property = bugtracker.encode_fixes_bug_urls(
2784
self._iter_bug_fix_urls(fixes, tree.branch))
2786
properties['bugs'] = bug_property
2788
if local and not tree.branch.get_bound_location():
2789
raise errors.LocalRequiresBoundBranch()
2791
def get_message(commit_obj):
2792
"""Callback to get commit message"""
2793
my_message = message
2794
if my_message is None and not file:
2795
t = make_commit_message_template_encoded(tree,
2796
selected_list, diff=show_diff,
2797
output_encoding=osutils.get_user_encoding())
2798
start_message = generate_commit_message_template(commit_obj)
2799
my_message = edit_commit_message_encoded(t,
2800
start_message=start_message)
2801
if my_message is None:
2802
raise errors.BzrCommandError("please specify a commit"
2803
" message with either --message or --file")
2804
elif my_message and file:
2805
raise errors.BzrCommandError(
2806
"please specify either --message or --file")
2808
my_message = codecs.open(file, 'rt',
2809
osutils.get_user_encoding()).read()
2810
if my_message == "":
2811
raise errors.BzrCommandError("empty commit message specified")
2815
tree.commit(message_callback=get_message,
2816
specific_files=selected_list,
2817
allow_pointless=unchanged, strict=strict, local=local,
2818
reporter=None, verbose=verbose, revprops=properties,
2820
exclude=safe_relpath_files(tree, exclude))
2821
except PointlessCommit:
2822
# FIXME: This should really happen before the file is read in;
2823
# perhaps prepare the commit; get the message; then actually commit
2824
raise errors.BzrCommandError("no changes to commit."
2825
" use --unchanged to commit anyhow")
2826
except ConflictsInTree:
2827
raise errors.BzrCommandError('Conflicts detected in working '
2828
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2830
except StrictCommitFailed:
2831
raise errors.BzrCommandError("Commit refused because there are"
2832
" unknown files in the working tree.")
2833
except errors.BoundBranchOutOfDate, e:
2834
raise errors.BzrCommandError(str(e) + "\n"
2835
'To commit to master branch, run update and then commit.\n'
2836
'You can also pass --local to commit to continue working '
2840
class cmd_check(Command):
2841
"""Validate working tree structure, branch consistency and repository history.
2843
This command checks various invariants about branch and repository storage
2844
to detect data corruption or bzr bugs.
2846
The working tree and branch checks will only give output if a problem is
2847
detected. The output fields of the repository check are:
2849
revisions: This is just the number of revisions checked. It doesn't
2851
versionedfiles: This is just the number of versionedfiles checked. It
2852
doesn't indicate a problem.
2853
unreferenced ancestors: Texts that are ancestors of other texts, but
2854
are not properly referenced by the revision ancestry. This is a
2855
subtle problem that Bazaar can work around.
2856
unique file texts: This is the total number of unique file contents
2857
seen in the checked revisions. It does not indicate a problem.
2858
repeated file texts: This is the total number of repeated texts seen
2859
in the checked revisions. Texts can be repeated when their file
2860
entries are modified, but the file contents are not. It does not
2863
If no restrictions are specified, all Bazaar data that is found at the given
2864
location will be checked.
2868
Check the tree and branch at 'foo'::
2870
bzr check --tree --branch foo
2872
Check only the repository at 'bar'::
2874
bzr check --repo bar
2876
Check everything at 'baz'::
2881
_see_also = ['reconcile']
2882
takes_args = ['path?']
2883
takes_options = ['verbose',
2884
Option('branch', help="Check the branch related to the"
2885
" current directory."),
2886
Option('repo', help="Check the repository related to the"
2887
" current directory."),
2888
Option('tree', help="Check the working tree related to"
2889
" the current directory.")]
2891
def run(self, path=None, verbose=False, branch=False, repo=False,
2893
from bzrlib.check import check_dwim
2896
if not branch and not repo and not tree:
2897
branch = repo = tree = True
2898
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2901
class cmd_upgrade(Command):
2902
"""Upgrade branch storage to current format.
2904
The check command or bzr developers may sometimes advise you to run
2905
this command. When the default format has changed you may also be warned
2906
during other operations to upgrade.
2909
_see_also = ['check']
2910
takes_args = ['url?']
2912
RegistryOption('format',
2913
help='Upgrade to a specific format. See "bzr help'
2914
' formats" for details.',
2915
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
2916
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
2917
value_switches=True, title='Branch format'),
2920
def run(self, url='.', format=None):
2921
from bzrlib.upgrade import upgrade
2923
format = bzrdir.format_registry.make_bzrdir('default')
2924
upgrade(url, format)
2927
class cmd_whoami(Command):
2928
"""Show or set bzr user id.
2931
Show the email of the current user::
2935
Set the current user::
2937
bzr whoami "Frank Chu <fchu@example.com>"
2939
takes_options = [ Option('email',
2940
help='Display email address only.'),
2942
help='Set identity for the current branch instead of '
2945
takes_args = ['name?']
2946
encoding_type = 'replace'
2949
def run(self, email=False, branch=False, name=None):
2951
# use branch if we're inside one; otherwise global config
2953
c = Branch.open_containing('.')[0].get_config()
2954
except errors.NotBranchError:
2955
c = config.GlobalConfig()
2957
self.outf.write(c.user_email() + '\n')
2959
self.outf.write(c.username() + '\n')
2962
# display a warning if an email address isn't included in the given name.
2964
config.extract_email_address(name)
2965
except errors.NoEmailInUsername, e:
2966
warning('"%s" does not seem to contain an email address. '
2967
'This is allowed, but not recommended.', name)
2969
# use global config unless --branch given
2971
c = Branch.open_containing('.')[0].get_config()
2973
c = config.GlobalConfig()
2974
c.set_user_option('email', name)
2977
class cmd_nick(Command):
2978
"""Print or set the branch nickname.
2980
If unset, the tree root directory name is used as the nickname.
2981
To print the current nickname, execute with no argument.
2983
Bound branches use the nickname of its master branch unless it is set
2987
_see_also = ['info']
2988
takes_args = ['nickname?']
2989
def run(self, nickname=None):
2990
branch = Branch.open_containing(u'.')[0]
2991
if nickname is None:
2992
self.printme(branch)
2994
branch.nick = nickname
2997
def printme(self, branch):
3001
class cmd_alias(Command):
3002
"""Set/unset and display aliases.
3005
Show the current aliases::
3009
Show the alias specified for 'll'::
3013
Set an alias for 'll'::
3015
bzr alias ll="log --line -r-10..-1"
3017
To remove an alias for 'll'::
3019
bzr alias --remove ll
3022
takes_args = ['name?']
3024
Option('remove', help='Remove the alias.'),
3027
def run(self, name=None, remove=False):
3029
self.remove_alias(name)
3031
self.print_aliases()
3033
equal_pos = name.find('=')
3035
self.print_alias(name)
3037
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3039
def remove_alias(self, alias_name):
3040
if alias_name is None:
3041
raise errors.BzrCommandError(
3042
'bzr alias --remove expects an alias to remove.')
3043
# If alias is not found, print something like:
3044
# unalias: foo: not found
3045
c = config.GlobalConfig()
3046
c.unset_alias(alias_name)
3049
def print_aliases(self):
3050
"""Print out the defined aliases in a similar format to bash."""
3051
aliases = config.GlobalConfig().get_aliases()
3052
for key, value in sorted(aliases.iteritems()):
3053
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3056
def print_alias(self, alias_name):
3057
from bzrlib.commands import get_alias
3058
alias = get_alias(alias_name)
3060
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3063
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3065
def set_alias(self, alias_name, alias_command):
3066
"""Save the alias in the global config."""
3067
c = config.GlobalConfig()
3068
c.set_alias(alias_name, alias_command)
3071
class cmd_selftest(Command):
3072
"""Run internal test suite.
3074
If arguments are given, they are regular expressions that say which tests
3075
should run. Tests matching any expression are run, and other tests are
3078
Alternatively if --first is given, matching tests are run first and then
3079
all other tests are run. This is useful if you have been working in a
3080
particular area, but want to make sure nothing else was broken.
3082
If --exclude is given, tests that match that regular expression are
3083
excluded, regardless of whether they match --first or not.
3085
To help catch accidential dependencies between tests, the --randomize
3086
option is useful. In most cases, the argument used is the word 'now'.
3087
Note that the seed used for the random number generator is displayed
3088
when this option is used. The seed can be explicitly passed as the
3089
argument to this option if required. This enables reproduction of the
3090
actual ordering used if and when an order sensitive problem is encountered.
3092
If --list-only is given, the tests that would be run are listed. This is
3093
useful when combined with --first, --exclude and/or --randomize to
3094
understand their impact. The test harness reports "Listed nn tests in ..."
3095
instead of "Ran nn tests in ..." when list mode is enabled.
3097
If the global option '--no-plugins' is given, plugins are not loaded
3098
before running the selftests. This has two effects: features provided or
3099
modified by plugins will not be tested, and tests provided by plugins will
3102
Tests that need working space on disk use a common temporary directory,
3103
typically inside $TMPDIR or /tmp.
3106
Run only tests relating to 'ignore'::
3110
Disable plugins and list tests as they're run::
3112
bzr --no-plugins selftest -v
3114
# NB: this is used from the class without creating an instance, which is
3115
# why it does not have a self parameter.
3116
def get_transport_type(typestring):
3117
"""Parse and return a transport specifier."""
3118
if typestring == "sftp":
3119
from bzrlib.transport.sftp import SFTPAbsoluteServer
3120
return SFTPAbsoluteServer
3121
if typestring == "memory":
3122
from bzrlib.transport.memory import MemoryServer
3124
if typestring == "fakenfs":
3125
from bzrlib.transport.fakenfs import FakeNFSServer
3126
return FakeNFSServer
3127
msg = "No known transport type %s. Supported types are: sftp\n" %\
3129
raise errors.BzrCommandError(msg)
3132
takes_args = ['testspecs*']
3133
takes_options = ['verbose',
3135
help='Stop when one test fails.',
3139
help='Use a different transport by default '
3140
'throughout the test suite.',
3141
type=get_transport_type),
3143
help='Run the benchmarks rather than selftests.'),
3144
Option('lsprof-timed',
3145
help='Generate lsprof output for benchmarked'
3146
' sections of code.'),
3147
Option('cache-dir', type=str,
3148
help='Cache intermediate benchmark output in this '
3151
help='Run all tests, but run specified tests first.',
3155
help='List the tests instead of running them.'),
3156
Option('randomize', type=str, argname="SEED",
3157
help='Randomize the order of tests using the given'
3158
' seed or "now" for the current time.'),
3159
Option('exclude', type=str, argname="PATTERN",
3161
help='Exclude tests that match this regular'
3163
Option('strict', help='Fail on missing dependencies or '
3165
Option('load-list', type=str, argname='TESTLISTFILE',
3166
help='Load a test id list from a text file.'),
3167
ListOption('debugflag', type=str, short_name='E',
3168
help='Turn on a selftest debug flag.'),
3169
ListOption('starting-with', type=str, argname='TESTID',
3170
param_name='starting_with', short_name='s',
3172
'Load only the tests starting with TESTID.'),
3174
encoding_type = 'replace'
3177
Command.__init__(self)
3178
self.additional_selftest_args = {}
3180
def run(self, testspecs_list=None, verbose=False, one=False,
3181
transport=None, benchmark=None,
3182
lsprof_timed=None, cache_dir=None,
3183
first=False, list_only=False,
3184
randomize=None, exclude=None, strict=False,
3185
load_list=None, debugflag=None, starting_with=None):
3186
from bzrlib.tests import selftest
3187
import bzrlib.benchmarks as benchmarks
3188
from bzrlib.benchmarks import tree_creator
3190
# Make deprecation warnings visible, unless -Werror is set
3191
symbol_versioning.activate_deprecation_warnings(override=False)
3193
if cache_dir is not None:
3194
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3196
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
3197
print ' %s (%s python%s)' % (
3199
bzrlib.version_string,
3200
bzrlib._format_version_tuple(sys.version_info),
3203
if testspecs_list is not None:
3204
pattern = '|'.join(testspecs_list)
3208
test_suite_factory = benchmarks.test_suite
3209
# Unless user explicitly asks for quiet, be verbose in benchmarks
3210
verbose = not is_quiet()
3211
# TODO: should possibly lock the history file...
3212
benchfile = open(".perf_history", "at", buffering=1)
3214
test_suite_factory = None
3217
selftest_kwargs = {"verbose": verbose,
3219
"stop_on_failure": one,
3220
"transport": transport,
3221
"test_suite_factory": test_suite_factory,
3222
"lsprof_timed": lsprof_timed,
3223
"bench_history": benchfile,
3224
"matching_tests_first": first,
3225
"list_only": list_only,
3226
"random_seed": randomize,
3227
"exclude_pattern": exclude,
3229
"load_list": load_list,
3230
"debug_flags": debugflag,
3231
"starting_with": starting_with
3233
selftest_kwargs.update(self.additional_selftest_args)
3234
result = selftest(**selftest_kwargs)
3236
if benchfile is not None:
3239
note('tests passed')
3241
note('tests failed')
3242
return int(not result)
3245
class cmd_version(Command):
3246
"""Show version of bzr."""
3248
encoding_type = 'replace'
3250
Option("short", help="Print just the version number."),
3254
def run(self, short=False):
3255
from bzrlib.version import show_version
3257
self.outf.write(bzrlib.version_string + '\n')
3259
show_version(to_file=self.outf)
3262
class cmd_rocks(Command):
3263
"""Statement of optimism."""
3269
print "It sure does!"
3272
class cmd_find_merge_base(Command):
3273
"""Find and print a base revision for merging two branches."""
3274
# TODO: Options to specify revisions on either side, as if
3275
# merging only part of the history.
3276
takes_args = ['branch', 'other']
3280
def run(self, branch, other):
3281
from bzrlib.revision import ensure_null
3283
branch1 = Branch.open_containing(branch)[0]
3284
branch2 = Branch.open_containing(other)[0]
3289
last1 = ensure_null(branch1.last_revision())
3290
last2 = ensure_null(branch2.last_revision())
3292
graph = branch1.repository.get_graph(branch2.repository)
3293
base_rev_id = graph.find_unique_lca(last1, last2)
3295
print 'merge base is revision %s' % base_rev_id
3302
class cmd_merge(Command):
3303
"""Perform a three-way merge.
3305
The source of the merge can be specified either in the form of a branch,
3306
or in the form of a path to a file containing a merge directive generated
3307
with bzr send. If neither is specified, the default is the upstream branch
3308
or the branch most recently merged using --remember.
3310
When merging a branch, by default the tip will be merged. To pick a different
3311
revision, pass --revision. If you specify two values, the first will be used as
3312
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3313
available revisions, like this is commonly referred to as "cherrypicking".
3315
Revision numbers are always relative to the branch being merged.
3317
By default, bzr will try to merge in all new work from the other
3318
branch, automatically determining an appropriate base. If this
3319
fails, you may need to give an explicit base.
3321
Merge will do its best to combine the changes in two branches, but there
3322
are some kinds of problems only a human can fix. When it encounters those,
3323
it will mark a conflict. A conflict means that you need to fix something,
3324
before you should commit.
3326
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3328
If there is no default branch set, the first merge will set it. After
3329
that, you can omit the branch to use the default. To change the
3330
default, use --remember. The value will only be saved if the remote
3331
location can be accessed.
3333
The results of the merge are placed into the destination working
3334
directory, where they can be reviewed (with bzr diff), tested, and then
3335
committed to record the result of the merge.
3337
merge refuses to run if there are any uncommitted changes, unless
3341
To merge the latest revision from bzr.dev::
3343
bzr merge ../bzr.dev
3345
To merge changes up to and including revision 82 from bzr.dev::
3347
bzr merge -r 82 ../bzr.dev
3349
To merge the changes introduced by 82, without previous changes::
3351
bzr merge -r 81..82 ../bzr.dev
3353
To apply a merge directive contained in in /tmp/merge:
3355
bzr merge /tmp/merge
3358
encoding_type = 'exact'
3359
_see_also = ['update', 'remerge', 'status-flags', 'send']
3360
takes_args = ['location?']
3365
help='Merge even if the destination tree has uncommitted changes.'),
3369
Option('show-base', help="Show base revision text in "
3371
Option('uncommitted', help='Apply uncommitted changes'
3372
' from a working copy, instead of branch changes.'),
3373
Option('pull', help='If the destination is already'
3374
' completely merged into the source, pull from the'
3375
' source rather than merging. When this happens,'
3376
' you do not need to commit the result.'),
3378
help='Branch to merge into, '
3379
'rather than the one containing the working directory.',
3383
Option('preview', help='Instead of merging, show a diff of the merge.')
3386
def run(self, location=None, revision=None, force=False,
3387
merge_type=None, show_base=False, reprocess=None, remember=False,
3388
uncommitted=False, pull=False,
3392
if merge_type is None:
3393
merge_type = _mod_merge.Merge3Merger
3395
if directory is None: directory = u'.'
3396
possible_transports = []
3398
allow_pending = True
3399
verified = 'inapplicable'
3400
tree = WorkingTree.open_containing(directory)[0]
3402
# die as quickly as possible if there are uncommitted changes
3404
basis_tree = tree.revision_tree(tree.last_revision())
3405
except errors.NoSuchRevision:
3406
basis_tree = tree.basis_tree()
3408
changes = tree.changes_from(basis_tree)
3409
if changes.has_changed():
3410
raise errors.UncommittedChanges(tree)
3412
view_info = _get_view_info_for_change_reporter(tree)
3413
change_reporter = delta._ChangeReporter(
3414
unversioned_filter=tree.is_ignored, view_info=view_info)
3417
pb = ui.ui_factory.nested_progress_bar()
3418
cleanups.append(pb.finished)
3420
cleanups.append(tree.unlock)
3421
if location is not None:
3423
mergeable = bundle.read_mergeable_from_url(location,
3424
possible_transports=possible_transports)
3425
except errors.NotABundle:
3429
raise errors.BzrCommandError('Cannot use --uncommitted'
3430
' with bundles or merge directives.')
3432
if revision is not None:
3433
raise errors.BzrCommandError(
3434
'Cannot use -r with merge directives or bundles')
3435
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3438
if merger is None and uncommitted:
3439
if revision is not None and len(revision) > 0:
3440
raise errors.BzrCommandError('Cannot use --uncommitted and'
3441
' --revision at the same time.')
3442
location = self._select_branch_location(tree, location)[0]
3443
other_tree, other_path = WorkingTree.open_containing(location)
3444
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
3446
allow_pending = False
3447
if other_path != '':
3448
merger.interesting_files = [other_path]
3451
merger, allow_pending = self._get_merger_from_branch(tree,
3452
location, revision, remember, possible_transports, pb)
3454
merger.merge_type = merge_type
3455
merger.reprocess = reprocess
3456
merger.show_base = show_base
3457
self.sanity_check_merger(merger)
3458
if (merger.base_rev_id == merger.other_rev_id and
3459
merger.other_rev_id is not None):
3460
note('Nothing to do.')
3463
if merger.interesting_files is not None:
3464
raise errors.BzrCommandError('Cannot pull individual files')
3465
if (merger.base_rev_id == tree.last_revision()):
3466
result = tree.pull(merger.other_branch, False,
3467
merger.other_rev_id)
3468
result.report(self.outf)
3470
merger.check_basis(False)
3472
return self._do_preview(merger)
3474
return self._do_merge(merger, change_reporter, allow_pending,
3477
for cleanup in reversed(cleanups):
3480
def _do_preview(self, merger):
3481
from bzrlib.diff import show_diff_trees
3482
tree_merger = merger.make_merger()
3483
tt = tree_merger.make_preview_transform()
3485
result_tree = tt.get_preview_tree()
3486
show_diff_trees(merger.this_tree, result_tree, self.outf,
3487
old_label='', new_label='')
3491
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3492
merger.change_reporter = change_reporter
3493
conflict_count = merger.do_merge()
3495
merger.set_pending()
3496
if verified == 'failed':
3497
warning('Preview patch does not match changes')
3498
if conflict_count != 0:
3503
def sanity_check_merger(self, merger):
3504
if (merger.show_base and
3505
not merger.merge_type is _mod_merge.Merge3Merger):
3506
raise errors.BzrCommandError("Show-base is not supported for this"
3507
" merge type. %s" % merger.merge_type)
3508
if merger.reprocess is None:
3509
if merger.show_base:
3510
merger.reprocess = False
3512
# Use reprocess if the merger supports it
3513
merger.reprocess = merger.merge_type.supports_reprocess
3514
if merger.reprocess and not merger.merge_type.supports_reprocess:
3515
raise errors.BzrCommandError("Conflict reduction is not supported"
3516
" for merge type %s." %
3518
if merger.reprocess and merger.show_base:
3519
raise errors.BzrCommandError("Cannot do conflict reduction and"
3522
def _get_merger_from_branch(self, tree, location, revision, remember,
3523
possible_transports, pb):
3524
"""Produce a merger from a location, assuming it refers to a branch."""
3525
from bzrlib.tag import _merge_tags_if_possible
3526
# find the branch locations
3527
other_loc, user_location = self._select_branch_location(tree, location,
3529
if revision is not None and len(revision) == 2:
3530
base_loc, _unused = self._select_branch_location(tree,
3531
location, revision, 0)
3533
base_loc = other_loc
3535
other_branch, other_path = Branch.open_containing(other_loc,
3536
possible_transports)
3537
if base_loc == other_loc:
3538
base_branch = other_branch
3540
base_branch, base_path = Branch.open_containing(base_loc,
3541
possible_transports)
3542
# Find the revision ids
3543
if revision is None or len(revision) < 1 or revision[-1] is None:
3544
other_revision_id = _mod_revision.ensure_null(
3545
other_branch.last_revision())
3547
other_revision_id = revision[-1].as_revision_id(other_branch)
3548
if (revision is not None and len(revision) == 2
3549
and revision[0] is not None):
3550
base_revision_id = revision[0].as_revision_id(base_branch)
3552
base_revision_id = None
3553
# Remember where we merge from
3554
if ((remember or tree.branch.get_submit_branch() is None) and
3555
user_location is not None):
3556
tree.branch.set_submit_branch(other_branch.base)
3557
_merge_tags_if_possible(other_branch, tree.branch)
3558
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3559
other_revision_id, base_revision_id, other_branch, base_branch)
3560
if other_path != '':
3561
allow_pending = False
3562
merger.interesting_files = [other_path]
3564
allow_pending = True
3565
return merger, allow_pending
3567
def _select_branch_location(self, tree, user_location, revision=None,
3569
"""Select a branch location, according to possible inputs.
3571
If provided, branches from ``revision`` are preferred. (Both
3572
``revision`` and ``index`` must be supplied.)
3574
Otherwise, the ``location`` parameter is used. If it is None, then the
3575
``submit`` or ``parent`` location is used, and a note is printed.
3577
:param tree: The working tree to select a branch for merging into
3578
:param location: The location entered by the user
3579
:param revision: The revision parameter to the command
3580
:param index: The index to use for the revision parameter. Negative
3581
indices are permitted.
3582
:return: (selected_location, user_location). The default location
3583
will be the user-entered location.
3585
if (revision is not None and index is not None
3586
and revision[index] is not None):
3587
branch = revision[index].get_branch()
3588
if branch is not None:
3589
return branch, branch
3590
if user_location is None:
3591
location = self._get_remembered(tree, 'Merging from')
3593
location = user_location
3594
return location, user_location
3596
def _get_remembered(self, tree, verb_string):
3597
"""Use tree.branch's parent if none was supplied.
3599
Report if the remembered location was used.
3601
stored_location = tree.branch.get_submit_branch()
3602
stored_location_type = "submit"
3603
if stored_location is None:
3604
stored_location = tree.branch.get_parent()
3605
stored_location_type = "parent"
3606
mutter("%s", stored_location)
3607
if stored_location is None:
3608
raise errors.BzrCommandError("No location specified or remembered")
3609
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3610
note(u"%s remembered %s location %s", verb_string,
3611
stored_location_type, display_url)
3612
return stored_location
3615
class cmd_remerge(Command):
3618
Use this if you want to try a different merge technique while resolving
3619
conflicts. Some merge techniques are better than others, and remerge
3620
lets you try different ones on different files.
3622
The options for remerge have the same meaning and defaults as the ones for
3623
merge. The difference is that remerge can (only) be run when there is a
3624
pending merge, and it lets you specify particular files.
3627
Re-do the merge of all conflicted files, and show the base text in
3628
conflict regions, in addition to the usual THIS and OTHER texts::
3630
bzr remerge --show-base
3632
Re-do the merge of "foobar", using the weave merge algorithm, with
3633
additional processing to reduce the size of conflict regions::
3635
bzr remerge --merge-type weave --reprocess foobar
3637
takes_args = ['file*']
3642
help="Show base revision text in conflicts."),
3645
def run(self, file_list=None, merge_type=None, show_base=False,
3647
if merge_type is None:
3648
merge_type = _mod_merge.Merge3Merger
3649
tree, file_list = tree_files(file_list)
3652
parents = tree.get_parent_ids()
3653
if len(parents) != 2:
3654
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3655
" merges. Not cherrypicking or"
3657
repository = tree.branch.repository
3658
interesting_ids = None
3660
conflicts = tree.conflicts()
3661
if file_list is not None:
3662
interesting_ids = set()
3663
for filename in file_list:
3664
file_id = tree.path2id(filename)
3666
raise errors.NotVersionedError(filename)
3667
interesting_ids.add(file_id)
3668
if tree.kind(file_id) != "directory":
3671
for name, ie in tree.inventory.iter_entries(file_id):
3672
interesting_ids.add(ie.file_id)
3673
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3675
# Remerge only supports resolving contents conflicts
3676
allowed_conflicts = ('text conflict', 'contents conflict')
3677
restore_files = [c.path for c in conflicts
3678
if c.typestring in allowed_conflicts]
3679
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3680
tree.set_conflicts(ConflictList(new_conflicts))
3681
if file_list is not None:
3682
restore_files = file_list
3683
for filename in restore_files:
3685
restore(tree.abspath(filename))
3686
except errors.NotConflicted:
3688
# Disable pending merges, because the file texts we are remerging
3689
# have not had those merges performed. If we use the wrong parents
3690
# list, we imply that the working tree text has seen and rejected
3691
# all the changes from the other tree, when in fact those changes
3692
# have not yet been seen.
3693
pb = ui.ui_factory.nested_progress_bar()
3694
tree.set_parent_ids(parents[:1])
3696
merger = _mod_merge.Merger.from_revision_ids(pb,
3698
merger.interesting_ids = interesting_ids
3699
merger.merge_type = merge_type
3700
merger.show_base = show_base
3701
merger.reprocess = reprocess
3702
conflicts = merger.do_merge()
3704
tree.set_parent_ids(parents)
3714
class cmd_revert(Command):
3715
"""Revert files to a previous revision.
3717
Giving a list of files will revert only those files. Otherwise, all files
3718
will be reverted. If the revision is not specified with '--revision', the
3719
last committed revision is used.
3721
To remove only some changes, without reverting to a prior version, use
3722
merge instead. For example, "merge . --revision -2..-3" will remove the
3723
changes introduced by -2, without affecting the changes introduced by -1.
3724
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3726
By default, any files that have been manually changed will be backed up
3727
first. (Files changed only by merge are not backed up.) Backup files have
3728
'.~#~' appended to their name, where # is a number.
3730
When you provide files, you can use their current pathname or the pathname
3731
from the target revision. So you can use revert to "undelete" a file by
3732
name. If you name a directory, all the contents of that directory will be
3735
Any files that have been newly added since that revision will be deleted,
3736
with a backup kept if appropriate. Directories containing unknown files
3737
will not be deleted.
3739
The working tree contains a list of pending merged revisions, which will
3740
be included as parents in the next commit. Normally, revert clears that
3741
list as well as reverting the files. If any files are specified, revert
3742
leaves the pending merge list alone and reverts only the files. Use "bzr
3743
revert ." in the tree root to revert all files but keep the merge record,
3744
and "bzr revert --forget-merges" to clear the pending merge list without
3745
reverting any files.
3748
_see_also = ['cat', 'export']
3751
Option('no-backup', "Do not save backups of reverted files."),
3752
Option('forget-merges',
3753
'Remove pending merge marker, without changing any files.'),
3755
takes_args = ['file*']
3757
def run(self, revision=None, no_backup=False, file_list=None,
3758
forget_merges=None):
3759
tree, file_list = tree_files(file_list)
3763
tree.set_parent_ids(tree.get_parent_ids()[:1])
3765
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3770
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3771
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3772
pb = ui.ui_factory.nested_progress_bar()
3774
tree.revert(file_list, rev_tree, not no_backup, pb,
3775
report_changes=True)
3780
class cmd_assert_fail(Command):
3781
"""Test reporting of assertion failures"""
3782
# intended just for use in testing
3787
raise AssertionError("always fails")
3790
class cmd_help(Command):
3791
"""Show help on a command or other topic.
3794
_see_also = ['topics']
3796
Option('long', 'Show help on all commands.'),
3798
takes_args = ['topic?']
3799
aliases = ['?', '--help', '-?', '-h']
3802
def run(self, topic=None, long=False):
3804
if topic is None and long:
3806
bzrlib.help.help(topic)
3809
class cmd_shell_complete(Command):
3810
"""Show appropriate completions for context.
3812
For a list of all available commands, say 'bzr shell-complete'.
3814
takes_args = ['context?']
3819
def run(self, context=None):
3820
import shellcomplete
3821
shellcomplete.shellcomplete(context)
3824
class cmd_missing(Command):
3825
"""Show unmerged/unpulled revisions between two branches.
3827
OTHER_BRANCH may be local or remote.
3829
To filter on a range of revisions, you can use the command -r begin..end
3830
-r revision requests a specific revision, -r ..end or -r begin.. are
3835
Determine the missing revisions between this and the branch at the
3836
remembered pull location::
3840
Determine the missing revisions between this and another branch::
3842
bzr missing http://server/branch
3844
Determine the missing revisions up to a specific revision on the other
3847
bzr missing -r ..-10
3849
Determine the missing revisions up to a specific revision on this
3852
bzr missing --my-revision ..-10
3855
_see_also = ['merge', 'pull']
3856
takes_args = ['other_branch?']
3858
Option('reverse', 'Reverse the order of revisions.'),
3860
'Display changes in the local branch only.'),
3861
Option('this' , 'Same as --mine-only.'),
3862
Option('theirs-only',
3863
'Display changes in the remote branch only.'),
3864
Option('other', 'Same as --theirs-only.'),
3868
custom_help('revision',
3869
help='Filter on other branch revisions (inclusive). '
3870
'See "help revisionspec" for details.'),
3871
Option('my-revision',
3872
type=_parse_revision_str,
3873
help='Filter on local branch revisions (inclusive). '
3874
'See "help revisionspec" for details.'),
3875
Option('include-merges', 'Show merged revisions.'),
3877
encoding_type = 'replace'
3880
def run(self, other_branch=None, reverse=False, mine_only=False,
3882
log_format=None, long=False, short=False, line=False,
3883
show_ids=False, verbose=False, this=False, other=False,
3884
include_merges=False, revision=None, my_revision=None):
3885
from bzrlib.missing import find_unmerged, iter_log_revisions
3894
# TODO: We should probably check that we don't have mine-only and
3895
# theirs-only set, but it gets complicated because we also have
3896
# this and other which could be used.
3903
local_branch = Branch.open_containing(u".")[0]
3904
parent = local_branch.get_parent()
3905
if other_branch is None:
3906
other_branch = parent
3907
if other_branch is None:
3908
raise errors.BzrCommandError("No peer location known"
3910
display_url = urlutils.unescape_for_display(parent,
3912
message("Using saved parent location: "
3913
+ display_url + "\n")
3915
remote_branch = Branch.open(other_branch)
3916
if remote_branch.base == local_branch.base:
3917
remote_branch = local_branch
3919
local_revid_range = _revision_range_to_revid_range(
3920
_get_revision_range(my_revision, local_branch,
3923
remote_revid_range = _revision_range_to_revid_range(
3924
_get_revision_range(revision,
3925
remote_branch, self.name()))
3927
local_branch.lock_read()
3929
remote_branch.lock_read()
3931
local_extra, remote_extra = find_unmerged(
3932
local_branch, remote_branch, restrict,
3933
backward=not reverse,
3934
include_merges=include_merges,
3935
local_revid_range=local_revid_range,
3936
remote_revid_range=remote_revid_range)
3938
if log_format is None:
3939
registry = log.log_formatter_registry
3940
log_format = registry.get_default(local_branch)
3941
lf = log_format(to_file=self.outf,
3943
show_timezone='original')
3946
if local_extra and not theirs_only:
3947
message("You have %d extra revision(s):\n" %
3949
for revision in iter_log_revisions(local_extra,
3950
local_branch.repository,
3952
lf.log_revision(revision)
3953
printed_local = True
3956
printed_local = False
3958
if remote_extra and not mine_only:
3959
if printed_local is True:
3961
message("You are missing %d revision(s):\n" %
3963
for revision in iter_log_revisions(remote_extra,
3964
remote_branch.repository,
3966
lf.log_revision(revision)
3969
if mine_only and not local_extra:
3970
# We checked local, and found nothing extra
3971
message('This branch is up to date.\n')
3972
elif theirs_only and not remote_extra:
3973
# We checked remote, and found nothing extra
3974
message('Other branch is up to date.\n')
3975
elif not (mine_only or theirs_only or local_extra or
3977
# We checked both branches, and neither one had extra
3979
message("Branches are up to date.\n")
3981
remote_branch.unlock()
3983
local_branch.unlock()
3984
if not status_code and parent is None and other_branch is not None:
3985
local_branch.lock_write()
3987
# handle race conditions - a parent might be set while we run.
3988
if local_branch.get_parent() is None:
3989
local_branch.set_parent(remote_branch.base)
3991
local_branch.unlock()
3995
class cmd_pack(Command):
3996
"""Compress the data within a repository."""
3998
_see_also = ['repositories']
3999
takes_args = ['branch_or_repo?']
4001
def run(self, branch_or_repo='.'):
4002
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4004
branch = dir.open_branch()
4005
repository = branch.repository
4006
except errors.NotBranchError:
4007
repository = dir.open_repository()
4011
class cmd_plugins(Command):
4012
"""List the installed plugins.
4014
This command displays the list of installed plugins including
4015
version of plugin and a short description of each.
4017
--verbose shows the path where each plugin is located.
4019
A plugin is an external component for Bazaar that extends the
4020
revision control system, by adding or replacing code in Bazaar.
4021
Plugins can do a variety of things, including overriding commands,
4022
adding new commands, providing additional network transports and
4023
customizing log output.
4025
See the Bazaar web site, http://bazaar-vcs.org, for further
4026
information on plugins including where to find them and how to
4027
install them. Instructions are also provided there on how to
4028
write new plugins using the Python programming language.
4030
takes_options = ['verbose']
4033
def run(self, verbose=False):
4034
import bzrlib.plugin
4035
from inspect import getdoc
4037
for name, plugin in bzrlib.plugin.plugins().items():
4038
version = plugin.__version__
4039
if version == 'unknown':
4041
name_ver = '%s %s' % (name, version)
4042
d = getdoc(plugin.module)
4044
doc = d.split('\n')[0]
4046
doc = '(no description)'
4047
result.append((name_ver, doc, plugin.path()))
4048
for name_ver, doc, path in sorted(result):
4056
class cmd_testament(Command):
4057
"""Show testament (signing-form) of a revision."""
4060
Option('long', help='Produce long-format testament.'),
4062
help='Produce a strict-format testament.')]
4063
takes_args = ['branch?']
4065
def run(self, branch=u'.', revision=None, long=False, strict=False):
4066
from bzrlib.testament import Testament, StrictTestament
4068
testament_class = StrictTestament
4070
testament_class = Testament
4072
b = Branch.open_containing(branch)[0]
4074
b = Branch.open(branch)
4077
if revision is None:
4078
rev_id = b.last_revision()
4080
rev_id = revision[0].as_revision_id(b)
4081
t = testament_class.from_revision(b.repository, rev_id)
4083
sys.stdout.writelines(t.as_text_lines())
4085
sys.stdout.write(t.as_short_text())
4090
class cmd_annotate(Command):
4091
"""Show the origin of each line in a file.
4093
This prints out the given file with an annotation on the left side
4094
indicating which revision, author and date introduced the change.
4096
If the origin is the same for a run of consecutive lines, it is
4097
shown only at the top, unless the --all option is given.
4099
# TODO: annotate directories; showing when each file was last changed
4100
# TODO: if the working copy is modified, show annotations on that
4101
# with new uncommitted lines marked
4102
aliases = ['ann', 'blame', 'praise']
4103
takes_args = ['filename']
4104
takes_options = [Option('all', help='Show annotations on all lines.'),
4105
Option('long', help='Show commit date in annotations.'),
4109
encoding_type = 'exact'
4112
def run(self, filename, all=False, long=False, revision=None,
4114
from bzrlib.annotate import annotate_file, annotate_file_tree
4115
wt, branch, relpath = \
4116
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4122
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4124
file_id = wt.path2id(relpath)
4126
file_id = tree.path2id(relpath)
4128
raise errors.NotVersionedError(filename)
4129
file_version = tree.inventory[file_id].revision
4130
if wt is not None and revision is None:
4131
# If there is a tree and we're not annotating historical
4132
# versions, annotate the working tree's content.
4133
annotate_file_tree(wt, file_id, self.outf, long, all,
4136
annotate_file(branch, file_version, file_id, long, all, self.outf,
4145
class cmd_re_sign(Command):
4146
"""Create a digital signature for an existing revision."""
4147
# TODO be able to replace existing ones.
4149
hidden = True # is this right ?
4150
takes_args = ['revision_id*']
4151
takes_options = ['revision']
4153
def run(self, revision_id_list=None, revision=None):
4154
if revision_id_list is not None and revision is not None:
4155
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4156
if revision_id_list is None and revision is None:
4157
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4158
b = WorkingTree.open_containing(u'.')[0].branch
4161
return self._run(b, revision_id_list, revision)
4165
def _run(self, b, revision_id_list, revision):
4166
import bzrlib.gpg as gpg
4167
gpg_strategy = gpg.GPGStrategy(b.get_config())
4168
if revision_id_list is not None:
4169
b.repository.start_write_group()
4171
for revision_id in revision_id_list:
4172
b.repository.sign_revision(revision_id, gpg_strategy)
4174
b.repository.abort_write_group()
4177
b.repository.commit_write_group()
4178
elif revision is not None:
4179
if len(revision) == 1:
4180
revno, rev_id = revision[0].in_history(b)
4181
b.repository.start_write_group()
4183
b.repository.sign_revision(rev_id, gpg_strategy)
4185
b.repository.abort_write_group()
4188
b.repository.commit_write_group()
4189
elif len(revision) == 2:
4190
# are they both on rh- if so we can walk between them
4191
# might be nice to have a range helper for arbitrary
4192
# revision paths. hmm.
4193
from_revno, from_revid = revision[0].in_history(b)
4194
to_revno, to_revid = revision[1].in_history(b)
4195
if to_revid is None:
4196
to_revno = b.revno()
4197
if from_revno is None or to_revno is None:
4198
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4199
b.repository.start_write_group()
4201
for revno in range(from_revno, to_revno + 1):
4202
b.repository.sign_revision(b.get_rev_id(revno),
4205
b.repository.abort_write_group()
4208
b.repository.commit_write_group()
4210
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4213
class cmd_bind(Command):
4214
"""Convert the current branch into a checkout of the supplied branch.
4216
Once converted into a checkout, commits must succeed on the master branch
4217
before they will be applied to the local branch.
4219
Bound branches use the nickname of its master branch unless it is set
4220
locally, in which case binding will update the the local nickname to be
4224
_see_also = ['checkouts', 'unbind']
4225
takes_args = ['location?']
4228
def run(self, location=None):
4229
b, relpath = Branch.open_containing(u'.')
4230
if location is None:
4232
location = b.get_old_bound_location()
4233
except errors.UpgradeRequired:
4234
raise errors.BzrCommandError('No location supplied. '
4235
'This format does not remember old locations.')
4237
if location is None:
4238
raise errors.BzrCommandError('No location supplied and no '
4239
'previous location known')
4240
b_other = Branch.open(location)
4243
except errors.DivergedBranches:
4244
raise errors.BzrCommandError('These branches have diverged.'
4245
' Try merging, and then bind again.')
4246
if b.get_config().has_explicit_nickname():
4247
b.nick = b_other.nick
4250
class cmd_unbind(Command):
4251
"""Convert the current checkout into a regular branch.
4253
After unbinding, the local branch is considered independent and subsequent
4254
commits will be local only.
4257
_see_also = ['checkouts', 'bind']
4262
b, relpath = Branch.open_containing(u'.')
4264
raise errors.BzrCommandError('Local branch is not bound')
4267
class cmd_uncommit(Command):
4268
"""Remove the last committed revision.
4270
--verbose will print out what is being removed.
4271
--dry-run will go through all the motions, but not actually
4274
If --revision is specified, uncommit revisions to leave the branch at the
4275
specified revision. For example, "bzr uncommit -r 15" will leave the
4276
branch at revision 15.
4278
Uncommit leaves the working tree ready for a new commit. The only change
4279
it may make is to restore any pending merges that were present before
4283
# TODO: jam 20060108 Add an option to allow uncommit to remove
4284
# unreferenced information in 'branch-as-repository' branches.
4285
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4286
# information in shared branches as well.
4287
_see_also = ['commit']
4288
takes_options = ['verbose', 'revision',
4289
Option('dry-run', help='Don\'t actually make changes.'),
4290
Option('force', help='Say yes to all questions.'),
4292
help="Only remove the commits from the local branch"
4293
" when in a checkout."
4296
takes_args = ['location?']
4298
encoding_type = 'replace'
4300
def run(self, location=None,
4301
dry_run=False, verbose=False,
4302
revision=None, force=False, local=False):
4303
if location is None:
4305
control, relpath = bzrdir.BzrDir.open_containing(location)
4307
tree = control.open_workingtree()
4309
except (errors.NoWorkingTree, errors.NotLocalUrl):
4311
b = control.open_branch()
4313
if tree is not None:
4318
return self._run(b, tree, dry_run, verbose, revision, force,
4321
if tree is not None:
4326
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4327
from bzrlib.log import log_formatter, show_log
4328
from bzrlib.uncommit import uncommit
4330
last_revno, last_rev_id = b.last_revision_info()
4333
if revision is None:
4335
rev_id = last_rev_id
4337
# 'bzr uncommit -r 10' actually means uncommit
4338
# so that the final tree is at revno 10.
4339
# but bzrlib.uncommit.uncommit() actually uncommits
4340
# the revisions that are supplied.
4341
# So we need to offset it by one
4342
revno = revision[0].in_history(b).revno + 1
4343
if revno <= last_revno:
4344
rev_id = b.get_rev_id(revno)
4346
if rev_id is None or _mod_revision.is_null(rev_id):
4347
self.outf.write('No revisions to uncommit.\n')
4350
lf = log_formatter('short',
4352
show_timezone='original')
4357
direction='forward',
4358
start_revision=revno,
4359
end_revision=last_revno)
4362
print 'Dry-run, pretending to remove the above revisions.'
4364
val = raw_input('Press <enter> to continue')
4366
print 'The above revision(s) will be removed.'
4368
val = raw_input('Are you sure [y/N]? ')
4369
if val.lower() not in ('y', 'yes'):
4373
mutter('Uncommitting from {%s} to {%s}',
4374
last_rev_id, rev_id)
4375
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4376
revno=revno, local=local)
4377
note('You can restore the old tip by running:\n'
4378
' bzr pull . -r revid:%s', last_rev_id)
4381
class cmd_break_lock(Command):
4382
"""Break a dead lock on a repository, branch or working directory.
4384
CAUTION: Locks should only be broken when you are sure that the process
4385
holding the lock has been stopped.
4387
You can get information on what locks are open via the 'bzr info' command.
4392
takes_args = ['location?']
4394
def run(self, location=None, show=False):
4395
if location is None:
4397
control, relpath = bzrdir.BzrDir.open_containing(location)
4399
control.break_lock()
4400
except NotImplementedError:
4404
class cmd_wait_until_signalled(Command):
4405
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4407
This just prints a line to signal when it is ready, then blocks on stdin.
4413
sys.stdout.write("running\n")
4415
sys.stdin.readline()
4418
class cmd_serve(Command):
4419
"""Run the bzr server."""
4421
aliases = ['server']
4425
help='Serve on stdin/out for use from inetd or sshd.'),
4427
help='Listen for connections on nominated port of the form '
4428
'[hostname:]portnumber. Passing 0 as the port number will '
4429
'result in a dynamically allocated port. The default port is '
4433
help='Serve contents of this directory.',
4435
Option('allow-writes',
4436
help='By default the server is a readonly server. Supplying '
4437
'--allow-writes enables write access to the contents of '
4438
'the served directory and below.'
4442
def run_smart_server(self, smart_server):
4443
"""Run 'smart_server' forever, with no UI output at all."""
4444
# For the duration of this server, no UI output is permitted. note
4445
# that this may cause problems with blackbox tests. This should be
4446
# changed with care though, as we dont want to use bandwidth sending
4447
# progress over stderr to smart server clients!
4448
from bzrlib import lockdir
4449
old_factory = ui.ui_factory
4450
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
4452
ui.ui_factory = ui.SilentUIFactory()
4453
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
4454
smart_server.serve()
4456
ui.ui_factory = old_factory
4457
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
4459
def get_host_and_port(self, port):
4460
"""Return the host and port to run the smart server on.
4462
If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
4463
and port (`medium.BZR_DEFAULT_PORT`) will be used.
4465
If 'port' has a colon in it, the string before the colon will be
4466
interpreted as the host.
4468
:param port: A string of the port to run the server on.
4469
:return: A tuple of (host, port), where 'host' is a host name or IP,
4470
and port is an integer TCP/IP port.
4472
from bzrlib.smart import medium
4473
host = medium.BZR_DEFAULT_INTERFACE
4475
port = medium.BZR_DEFAULT_PORT
4478
host, port = port.split(':')
4482
def get_smart_server(self, transport, inet, port):
4483
"""Construct a smart server.
4485
:param transport: The base transport from which branches will be
4487
:param inet: If True, serve over stdin and stdout. Used for running
4489
:param port: The port to listen on. By default, it's `
4490
medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
4492
:return: A smart server.
4494
from bzrlib.smart import medium, server
4496
smart_server = medium.SmartServerPipeStreamMedium(
4497
sys.stdin, sys.stdout, transport)
4499
host, port = self.get_host_and_port(port)
4500
smart_server = server.SmartTCPServer(
4501
transport, host=host, port=port)
4502
note('listening on port: %s' % smart_server.port)
4505
def run(self, port=None, inet=False, directory=None, allow_writes=False):
4506
from bzrlib.transport import get_transport
4507
from bzrlib.transport.chroot import ChrootServer
4508
if directory is None:
4509
directory = os.getcwd()
4510
url = urlutils.local_path_to_url(directory)
4511
if not allow_writes:
4512
url = 'readonly+' + url
4513
chroot_server = ChrootServer(get_transport(url))
4514
chroot_server.setUp()
4515
t = get_transport(chroot_server.get_url())
4516
smart_server = self.get_smart_server(t, inet, port)
4517
self.run_smart_server(smart_server)
4520
class cmd_join(Command):
4521
"""Combine a subtree into its containing tree.
4523
This command is for experimental use only. It requires the target tree
4524
to be in dirstate-with-subtree format, which cannot be converted into
4527
The TREE argument should be an independent tree, inside another tree, but
4528
not part of it. (Such trees can be produced by "bzr split", but also by
4529
running "bzr branch" with the target inside a tree.)
4531
The result is a combined tree, with the subtree no longer an independant
4532
part. This is marked as a merge of the subtree into the containing tree,
4533
and all history is preserved.
4535
If --reference is specified, the subtree retains its independence. It can
4536
be branched by itself, and can be part of multiple projects at the same
4537
time. But operations performed in the containing tree, such as commit
4538
and merge, will recurse into the subtree.
4541
_see_also = ['split']
4542
takes_args = ['tree']
4544
Option('reference', help='Join by reference.'),
4548
def run(self, tree, reference=False):
4549
sub_tree = WorkingTree.open(tree)
4550
parent_dir = osutils.dirname(sub_tree.basedir)
4551
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4552
repo = containing_tree.branch.repository
4553
if not repo.supports_rich_root():
4554
raise errors.BzrCommandError(
4555
"Can't join trees because %s doesn't support rich root data.\n"
4556
"You can use bzr upgrade on the repository."
4560
containing_tree.add_reference(sub_tree)
4561
except errors.BadReferenceTarget, e:
4562
# XXX: Would be better to just raise a nicely printable
4563
# exception from the real origin. Also below. mbp 20070306
4564
raise errors.BzrCommandError("Cannot join %s. %s" %
4568
containing_tree.subsume(sub_tree)
4569
except errors.BadSubsumeSource, e:
4570
raise errors.BzrCommandError("Cannot join %s. %s" %
4574
class cmd_split(Command):
4575
"""Split a subdirectory of a tree into a separate tree.
4577
This command will produce a target tree in a format that supports
4578
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4579
converted into earlier formats like 'dirstate-tags'.
4581
The TREE argument should be a subdirectory of a working tree. That
4582
subdirectory will be converted into an independent tree, with its own
4583
branch. Commits in the top-level tree will not apply to the new subtree.
4586
# join is not un-hidden yet
4587
#_see_also = ['join']
4588
takes_args = ['tree']
4590
def run(self, tree):
4591
containing_tree, subdir = WorkingTree.open_containing(tree)
4592
sub_id = containing_tree.path2id(subdir)
4594
raise errors.NotVersionedError(subdir)
4596
containing_tree.extract(sub_id)
4597
except errors.RootNotRich:
4598
raise errors.UpgradeRequired(containing_tree.branch.base)
4601
class cmd_merge_directive(Command):
4602
"""Generate a merge directive for auto-merge tools.
4604
A directive requests a merge to be performed, and also provides all the
4605
information necessary to do so. This means it must either include a
4606
revision bundle, or the location of a branch containing the desired
4609
A submit branch (the location to merge into) must be supplied the first
4610
time the command is issued. After it has been supplied once, it will
4611
be remembered as the default.
4613
A public branch is optional if a revision bundle is supplied, but required
4614
if --diff or --plain is specified. It will be remembered as the default
4615
after the first use.
4618
takes_args = ['submit_branch?', 'public_branch?']
4622
_see_also = ['send']
4625
RegistryOption.from_kwargs('patch-type',
4626
'The type of patch to include in the directive.',
4628
value_switches=True,
4630
bundle='Bazaar revision bundle (default).',
4631
diff='Normal unified diff.',
4632
plain='No patch, just directive.'),
4633
Option('sign', help='GPG-sign the directive.'), 'revision',
4634
Option('mail-to', type=str,
4635
help='Instead of printing the directive, email to this address.'),
4636
Option('message', type=str, short_name='m',
4637
help='Message to use when committing this merge.')
4640
encoding_type = 'exact'
4642
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4643
sign=False, revision=None, mail_to=None, message=None):
4644
from bzrlib.revision import ensure_null, NULL_REVISION
4645
include_patch, include_bundle = {
4646
'plain': (False, False),
4647
'diff': (True, False),
4648
'bundle': (True, True),
4650
branch = Branch.open('.')
4651
stored_submit_branch = branch.get_submit_branch()
4652
if submit_branch is None:
4653
submit_branch = stored_submit_branch
4655
if stored_submit_branch is None:
4656
branch.set_submit_branch(submit_branch)
4657
if submit_branch is None:
4658
submit_branch = branch.get_parent()
4659
if submit_branch is None:
4660
raise errors.BzrCommandError('No submit branch specified or known')
4662
stored_public_branch = branch.get_public_branch()
4663
if public_branch is None:
4664
public_branch = stored_public_branch
4665
elif stored_public_branch is None:
4666
branch.set_public_branch(public_branch)
4667
if not include_bundle and public_branch is None:
4668
raise errors.BzrCommandError('No public branch specified or'
4670
base_revision_id = None
4671
if revision is not None:
4672
if len(revision) > 2:
4673
raise errors.BzrCommandError('bzr merge-directive takes '
4674
'at most two one revision identifiers')
4675
revision_id = revision[-1].as_revision_id(branch)
4676
if len(revision) == 2:
4677
base_revision_id = revision[0].as_revision_id(branch)
4679
revision_id = branch.last_revision()
4680
revision_id = ensure_null(revision_id)
4681
if revision_id == NULL_REVISION:
4682
raise errors.BzrCommandError('No revisions to bundle.')
4683
directive = merge_directive.MergeDirective2.from_objects(
4684
branch.repository, revision_id, time.time(),
4685
osutils.local_time_offset(), submit_branch,
4686
public_branch=public_branch, include_patch=include_patch,
4687
include_bundle=include_bundle, message=message,
4688
base_revision_id=base_revision_id)
4691
self.outf.write(directive.to_signed(branch))
4693
self.outf.writelines(directive.to_lines())
4695
message = directive.to_email(mail_to, branch, sign)
4696
s = SMTPConnection(branch.get_config())
4697
s.send_email(message)
4700
class cmd_send(Command):
4701
"""Mail or create a merge-directive for submitting changes.
4703
A merge directive provides many things needed for requesting merges:
4705
* A machine-readable description of the merge to perform
4707
* An optional patch that is a preview of the changes requested
4709
* An optional bundle of revision data, so that the changes can be applied
4710
directly from the merge directive, without retrieving data from a
4713
If --no-bundle is specified, then public_branch is needed (and must be
4714
up-to-date), so that the receiver can perform the merge using the
4715
public_branch. The public_branch is always included if known, so that
4716
people can check it later.
4718
The submit branch defaults to the parent, but can be overridden. Both
4719
submit branch and public branch will be remembered if supplied.
4721
If a public_branch is known for the submit_branch, that public submit
4722
branch is used in the merge instructions. This means that a local mirror
4723
can be used as your actual submit branch, once you have set public_branch
4726
Mail is sent using your preferred mail program. This should be transparent
4727
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4728
If the preferred client can't be found (or used), your editor will be used.
4730
To use a specific mail program, set the mail_client configuration option.
4731
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4732
specific clients are "claws", "evolution", "kmail", "mutt", and
4733
"thunderbird"; generic options are "default", "editor", "emacsclient",
4734
"mapi", and "xdg-email". Plugins may also add supported clients.
4736
If mail is being sent, a to address is required. This can be supplied
4737
either on the commandline, by setting the submit_to configuration
4738
option in the branch itself or the child_submit_to configuration option
4739
in the submit branch.
4741
Two formats are currently supported: "4" uses revision bundle format 4 and
4742
merge directive format 2. It is significantly faster and smaller than
4743
older formats. It is compatible with Bazaar 0.19 and later. It is the
4744
default. "0.9" uses revision bundle format 0.9 and merge directive
4745
format 1. It is compatible with Bazaar 0.12 - 0.18.
4747
The merge directives created by bzr send may be applied using bzr merge or
4748
bzr pull by specifying a file containing a merge directive as the location.
4751
encoding_type = 'exact'
4753
_see_also = ['merge', 'pull']
4755
takes_args = ['submit_branch?', 'public_branch?']
4759
help='Do not include a bundle in the merge directive.'),
4760
Option('no-patch', help='Do not include a preview patch in the merge'
4763
help='Remember submit and public branch.'),
4765
help='Branch to generate the submission from, '
4766
'rather than the one containing the working directory.',
4769
Option('output', short_name='o',
4770
help='Write merge directive to this file; '
4771
'use - for stdout.',
4773
Option('mail-to', help='Mail the request to this address.',
4777
Option('body', help='Body for the email.', type=unicode),
4778
RegistryOption.from_kwargs('format',
4779
'Use the specified output format.',
4780
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4781
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4784
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4785
no_patch=False, revision=None, remember=False, output=None,
4786
format='4', mail_to=None, message=None, body=None, **kwargs):
4787
return self._run(submit_branch, revision, public_branch, remember,
4788
format, no_bundle, no_patch, output,
4789
kwargs.get('from', '.'), mail_to, message, body)
4791
def _run(self, submit_branch, revision, public_branch, remember, format,
4792
no_bundle, no_patch, output, from_, mail_to, message, body):
4793
from bzrlib.revision import NULL_REVISION
4794
branch = Branch.open_containing(from_)[0]
4796
outfile = cStringIO.StringIO()
4800
outfile = open(output, 'wb')
4801
# we may need to write data into branch's repository to calculate
4806
config = branch.get_config()
4808
mail_to = config.get_user_option('submit_to')
4809
mail_client = config.get_mail_client()
4810
if (not getattr(mail_client, 'supports_body', False)
4811
and body is not None):
4812
raise errors.BzrCommandError(
4813
'Mail client "%s" does not support specifying body' %
4814
mail_client.__class__.__name__)
4815
if remember and submit_branch is None:
4816
raise errors.BzrCommandError(
4817
'--remember requires a branch to be specified.')
4818
stored_submit_branch = branch.get_submit_branch()
4819
remembered_submit_branch = None
4820
if submit_branch is None:
4821
submit_branch = stored_submit_branch
4822
remembered_submit_branch = "submit"
4824
if stored_submit_branch is None or remember:
4825
branch.set_submit_branch(submit_branch)
4826
if submit_branch is None:
4827
submit_branch = branch.get_parent()
4828
remembered_submit_branch = "parent"
4829
if submit_branch is None:
4830
raise errors.BzrCommandError('No submit branch known or'
4832
if remembered_submit_branch is not None:
4833
note('Using saved %s location "%s" to determine what '
4834
'changes to submit.', remembered_submit_branch,
4838
submit_config = Branch.open(submit_branch).get_config()
4839
mail_to = submit_config.get_user_option("child_submit_to")
4841
stored_public_branch = branch.get_public_branch()
4842
if public_branch is None:
4843
public_branch = stored_public_branch
4844
elif stored_public_branch is None or remember:
4845
branch.set_public_branch(public_branch)
4846
if no_bundle and public_branch is None:
4847
raise errors.BzrCommandError('No public branch specified or'
4849
base_revision_id = None
4851
if revision is not None:
4852
if len(revision) > 2:
4853
raise errors.BzrCommandError('bzr send takes '
4854
'at most two one revision identifiers')
4855
revision_id = revision[-1].as_revision_id(branch)
4856
if len(revision) == 2:
4857
base_revision_id = revision[0].as_revision_id(branch)
4858
if revision_id is None:
4859
revision_id = branch.last_revision()
4860
if revision_id == NULL_REVISION:
4861
raise errors.BzrCommandError('No revisions to submit.')
4863
directive = merge_directive.MergeDirective2.from_objects(
4864
branch.repository, revision_id, time.time(),
4865
osutils.local_time_offset(), submit_branch,
4866
public_branch=public_branch, include_patch=not no_patch,
4867
include_bundle=not no_bundle, message=message,
4868
base_revision_id=base_revision_id)
4869
elif format == '0.9':
4872
patch_type = 'bundle'
4874
raise errors.BzrCommandError('Format 0.9 does not'
4875
' permit bundle with no patch')
4881
directive = merge_directive.MergeDirective.from_objects(
4882
branch.repository, revision_id, time.time(),
4883
osutils.local_time_offset(), submit_branch,
4884
public_branch=public_branch, patch_type=patch_type,
4887
outfile.writelines(directive.to_lines())
4889
subject = '[MERGE] '
4890
if message is not None:
4893
revision = branch.repository.get_revision(revision_id)
4894
subject += revision.get_summary()
4895
basename = directive.get_disk_name(branch)
4896
mail_client.compose_merge_request(mail_to, subject,
4905
class cmd_bundle_revisions(cmd_send):
4907
"""Create a merge-directive for submitting changes.
4909
A merge directive provides many things needed for requesting merges:
4911
* A machine-readable description of the merge to perform
4913
* An optional patch that is a preview of the changes requested
4915
* An optional bundle of revision data, so that the changes can be applied
4916
directly from the merge directive, without retrieving data from a
4919
If --no-bundle is specified, then public_branch is needed (and must be
4920
up-to-date), so that the receiver can perform the merge using the
4921
public_branch. The public_branch is always included if known, so that
4922
people can check it later.
4924
The submit branch defaults to the parent, but can be overridden. Both
4925
submit branch and public branch will be remembered if supplied.
4927
If a public_branch is known for the submit_branch, that public submit
4928
branch is used in the merge instructions. This means that a local mirror
4929
can be used as your actual submit branch, once you have set public_branch
4932
Two formats are currently supported: "4" uses revision bundle format 4 and
4933
merge directive format 2. It is significantly faster and smaller than
4934
older formats. It is compatible with Bazaar 0.19 and later. It is the
4935
default. "0.9" uses revision bundle format 0.9 and merge directive
4936
format 1. It is compatible with Bazaar 0.12 - 0.18.
4941
help='Do not include a bundle in the merge directive.'),
4942
Option('no-patch', help='Do not include a preview patch in the merge'
4945
help='Remember submit and public branch.'),
4947
help='Branch to generate the submission from, '
4948
'rather than the one containing the working directory.',
4951
Option('output', short_name='o', help='Write directive to this file.',
4954
RegistryOption.from_kwargs('format',
4955
'Use the specified output format.',
4956
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4957
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4959
aliases = ['bundle']
4961
_see_also = ['send', 'merge']
4965
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4966
no_patch=False, revision=None, remember=False, output=None,
4967
format='4', **kwargs):
4970
return self._run(submit_branch, revision, public_branch, remember,
4971
format, no_bundle, no_patch, output,
4972
kwargs.get('from', '.'), None, None, None)
4975
class cmd_tag(Command):
4976
"""Create, remove or modify a tag naming a revision.
4978
Tags give human-meaningful names to revisions. Commands that take a -r
4979
(--revision) option can be given -rtag:X, where X is any previously
4982
Tags are stored in the branch. Tags are copied from one branch to another
4983
along when you branch, push, pull or merge.
4985
It is an error to give a tag name that already exists unless you pass
4986
--force, in which case the tag is moved to point to the new revision.
4988
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4989
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4992
_see_also = ['commit', 'tags']
4993
takes_args = ['tag_name']
4996
help='Delete this tag rather than placing it.',
4999
help='Branch in which to place the tag.',
5004
help='Replace existing tags.',
5009
def run(self, tag_name,
5015
branch, relpath = Branch.open_containing(directory)
5019
branch.tags.delete_tag(tag_name)
5020
self.outf.write('Deleted tag %s.\n' % tag_name)
5023
if len(revision) != 1:
5024
raise errors.BzrCommandError(
5025
"Tags can only be placed on a single revision, "
5027
revision_id = revision[0].as_revision_id(branch)
5029
revision_id = branch.last_revision()
5030
if (not force) and branch.tags.has_tag(tag_name):
5031
raise errors.TagAlreadyExists(tag_name)
5032
branch.tags.set_tag(tag_name, revision_id)
5033
self.outf.write('Created tag %s.\n' % tag_name)
5038
class cmd_tags(Command):
5041
This command shows a table of tag names and the revisions they reference.
5047
help='Branch whose tags should be displayed.',
5051
RegistryOption.from_kwargs('sort',
5052
'Sort tags by different criteria.', title='Sorting',
5053
alpha='Sort tags lexicographically (default).',
5054
time='Sort tags chronologically.',
5067
branch, relpath = Branch.open_containing(directory)
5069
tags = branch.tags.get_tag_dict().items()
5076
graph = branch.repository.get_graph()
5077
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5078
revid1, revid2 = rev1.rev_id, rev2.rev_id
5079
# only show revisions between revid1 and revid2 (inclusive)
5080
tags = [(tag, revid) for tag, revid in tags if
5081
graph.is_between(revid, revid1, revid2)]
5086
elif sort == 'time':
5088
for tag, revid in tags:
5090
revobj = branch.repository.get_revision(revid)
5091
except errors.NoSuchRevision:
5092
timestamp = sys.maxint # place them at the end
5094
timestamp = revobj.timestamp
5095
timestamps[revid] = timestamp
5096
tags.sort(key=lambda x: timestamps[x[1]])
5098
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5099
revno_map = branch.get_revision_id_to_revno_map()
5100
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
5101
for tag, revid in tags ]
5102
for tag, revspec in tags:
5103
self.outf.write('%-20s %s\n' % (tag, revspec))
5106
class cmd_reconfigure(Command):
5107
"""Reconfigure the type of a bzr directory.
5109
A target configuration must be specified.
5111
For checkouts, the bind-to location will be auto-detected if not specified.
5112
The order of preference is
5113
1. For a lightweight checkout, the current bound location.
5114
2. For branches that used to be checkouts, the previously-bound location.
5115
3. The push location.
5116
4. The parent location.
5117
If none of these is available, --bind-to must be specified.
5120
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5121
takes_args = ['location?']
5123
RegistryOption.from_kwargs(
5125
title='Target type',
5126
help='The type to reconfigure the directory to.',
5127
value_switches=True, enum_switch=False,
5128
branch='Reconfigure to be an unbound branch with no working tree.',
5129
tree='Reconfigure to be an unbound branch with a working tree.',
5130
checkout='Reconfigure to be a bound branch with a working tree.',
5131
lightweight_checkout='Reconfigure to be a lightweight'
5132
' checkout (with no local history).',
5133
standalone='Reconfigure to be a standalone branch '
5134
'(i.e. stop using shared repository).',
5135
use_shared='Reconfigure to use a shared repository.',
5136
with_trees='Reconfigure repository to create '
5137
'working trees on branches by default.',
5138
with_no_trees='Reconfigure repository to not create '
5139
'working trees on branches by default.'
5141
Option('bind-to', help='Branch to bind checkout to.', type=str),
5143
help='Perform reconfiguration even if local changes'
5147
def run(self, location=None, target_type=None, bind_to=None, force=False):
5148
directory = bzrdir.BzrDir.open(location)
5149
if target_type is None:
5150
raise errors.BzrCommandError('No target configuration specified')
5151
elif target_type == 'branch':
5152
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5153
elif target_type == 'tree':
5154
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5155
elif target_type == 'checkout':
5156
reconfiguration = reconfigure.Reconfigure.to_checkout(
5158
elif target_type == 'lightweight-checkout':
5159
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5161
elif target_type == 'use-shared':
5162
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5163
elif target_type == 'standalone':
5164
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5165
elif target_type == 'with-trees':
5166
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5168
elif target_type == 'with-no-trees':
5169
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5171
reconfiguration.apply(force)
5174
class cmd_switch(Command):
5175
"""Set the branch of a checkout and update.
5177
For lightweight checkouts, this changes the branch being referenced.
5178
For heavyweight checkouts, this checks that there are no local commits
5179
versus the current bound branch, then it makes the local branch a mirror
5180
of the new location and binds to it.
5182
In both cases, the working tree is updated and uncommitted changes
5183
are merged. The user can commit or revert these as they desire.
5185
Pending merges need to be committed or reverted before using switch.
5187
The path to the branch to switch to can be specified relative to the parent
5188
directory of the current branch. For example, if you are currently in a
5189
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5192
Bound branches use the nickname of its master branch unless it is set
5193
locally, in which case switching will update the the local nickname to be
5197
takes_args = ['to_location']
5198
takes_options = [Option('force',
5199
help='Switch even if local commits will be lost.')
5202
def run(self, to_location, force=False):
5203
from bzrlib import switch
5205
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5206
branch = control_dir.open_branch()
5208
to_branch = Branch.open(to_location)
5209
except errors.NotBranchError:
5210
this_branch = control_dir.open_branch()
5211
# This may be a heavy checkout, where we want the master branch
5212
this_url = this_branch.get_bound_location()
5213
# If not, use a local sibling
5214
if this_url is None:
5215
this_url = this_branch.base
5216
to_branch = Branch.open(
5217
urlutils.join(this_url, '..', to_location))
5218
switch.switch(control_dir, to_branch, force)
5219
if branch.get_config().has_explicit_nickname():
5220
branch = control_dir.open_branch() #get the new branch!
5221
branch.nick = to_branch.nick
5222
note('Switched to branch: %s',
5223
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5226
class cmd_view(Command):
5227
"""Manage filtered views.
5229
Views provide a mask over the tree so that users can focus on
5230
a subset of a tree when doing their work. After creating a view,
5231
commands that support a list of files - status, diff, commit, etc -
5232
effectively have that list of files implicitly given each time.
5233
An explicit list of files can still be given but those files
5234
must be within the current view.
5236
In most cases, a view has a short life-span: it is created to make
5237
a selected change and is deleted once that change is committed.
5238
At other times, you may wish to create one or more named views
5239
and switch between them.
5241
To disable the current view without deleting it, you can switch to
5242
the pseudo view called ``off``. This can be useful when you need
5243
to see the whole tree for an operation or two (e.g. merge) but
5244
want to switch back to your view after that.
5247
To define the current view::
5249
bzr view file1 dir1 ...
5251
To list the current view::
5255
To delete the current view::
5259
To disable the current view without deleting it::
5261
bzr view --switch off
5263
To define a named view and switch to it::
5265
bzr view --name view-name file1 dir1 ...
5267
To list a named view::
5269
bzr view --name view-name
5271
To delete a named view::
5273
bzr view --name view-name --delete
5275
To switch to a named view::
5277
bzr view --switch view-name
5279
To list all views defined::
5283
To delete all views::
5285
bzr view --delete --all
5289
takes_args = ['file*']
5292
help='Apply list or delete action to all views.',
5295
help='Delete the view.',
5298
help='Name of the view to define, list or delete.',
5302
help='Name of the view to switch to.',
5307
def run(self, file_list,
5313
tree, file_list = tree_files(file_list, apply_view=False)
5314
current_view, view_dict = tree.views.get_view_info()
5319
raise errors.BzrCommandError(
5320
"Both --delete and a file list specified")
5322
raise errors.BzrCommandError(
5323
"Both --delete and --switch specified")
5325
tree.views.set_view_info(None, {})
5326
self.outf.write("Deleted all views.\n")
5328
raise errors.BzrCommandError("No current view to delete")
5330
tree.views.delete_view(name)
5331
self.outf.write("Deleted '%s' view.\n" % name)
5334
raise errors.BzrCommandError(
5335
"Both --switch and a file list specified")
5337
raise errors.BzrCommandError(
5338
"Both --switch and --all specified")
5339
elif switch == 'off':
5340
if current_view is None:
5341
raise errors.BzrCommandError("No current view to disable")
5342
tree.views.set_view_info(None, view_dict)
5343
self.outf.write("Disabled '%s' view.\n" % (current_view))
5345
tree.views.set_view_info(switch, view_dict)
5346
view_str = views.view_display_str(tree.views.lookup_view())
5347
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5350
self.outf.write('Views defined:\n')
5351
for view in sorted(view_dict):
5352
if view == current_view:
5356
view_str = views.view_display_str(view_dict[view])
5357
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5359
self.outf.write('No views defined.\n')
5362
# No name given and no current view set
5365
raise errors.BzrCommandError(
5366
"Cannot change the 'off' pseudo view")
5367
tree.views.set_view(name, sorted(file_list))
5368
view_str = views.view_display_str(tree.views.lookup_view())
5369
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5373
# No name given and no current view set
5374
self.outf.write('No current view.\n')
5376
view_str = views.view_display_str(tree.views.lookup_view(name))
5377
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5380
class cmd_hooks(Command):
5386
for hook_key in sorted(hooks.known_hooks.keys()):
5387
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5388
self.outf.write("%s:\n" % type(some_hooks).__name__)
5389
for hook_name, hook_point in sorted(some_hooks.items()):
5390
self.outf.write(" %s:\n" % (hook_name,))
5391
found_hooks = list(hook_point)
5393
for hook in found_hooks:
5394
self.outf.write(" %s\n" %
5395
(some_hooks.get_hook_name(hook),))
5397
self.outf.write(" <no hooks installed>\n")
5400
class cmd_shelve(Command):
5401
"""Temporarily set aside some changes from the current tree.
5403
Shelve allows you to temporarily put changes you've made "on the shelf",
5404
ie. out of the way, until a later time when you can bring them back from
5405
the shelf with the 'unshelve' command. The changes are stored alongside
5406
your working tree, and so they aren't propagated along with your branch nor
5407
will they survive its deletion.
5409
If shelve --list is specified, previously-shelved changes are listed.
5411
Shelve is intended to help separate several sets of changes that have
5412
been inappropriately mingled. If you just want to get rid of all changes
5413
and you don't need to restore them later, use revert. If you want to
5414
shelve all text changes at once, use shelve --all.
5416
If filenames are specified, only the changes to those files will be
5417
shelved. Other files will be left untouched.
5419
If a revision is specified, changes since that revision will be shelved.
5421
You can put multiple items on the shelf, and by default, 'unshelve' will
5422
restore the most recently shelved changes.
5425
takes_args = ['file*']
5429
Option('all', help='Shelve all changes.'),
5431
RegistryOption('writer', 'Method to use for writing diffs.',
5432
bzrlib.option.diff_writer_registry,
5433
value_switches=True, enum_switch=False),
5435
Option('list', help='List shelved changes.'),
5437
help='Destroy removed changes instead of shelving them.'),
5439
_see_also = ['unshelve']
5441
def run(self, revision=None, all=False, file_list=None, message=None,
5442
writer=None, list=False, destroy=False):
5444
return self.run_for_list()
5445
from bzrlib.shelf_ui import Shelver
5447
writer = bzrlib.option.diff_writer_registry.get()
5449
Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5450
message, destroy=destroy).run()
5451
except errors.UserAbort:
5454
def run_for_list(self):
5455
tree = WorkingTree.open_containing('.')[0]
5458
manager = tree.get_shelf_manager()
5459
shelves = manager.active_shelves()
5460
if len(shelves) == 0:
5461
note('No shelved changes.')
5463
for shelf_id in reversed(shelves):
5464
message = manager.get_metadata(shelf_id).get('message')
5466
message = '<no message>'
5467
self.outf.write('%3d: %s\n' % (shelf_id, message))
5473
class cmd_unshelve(Command):
5474
"""Restore shelved changes.
5476
By default, the most recently shelved changes are restored. However if you
5477
specify a shelf by id those changes will be restored instead. This works
5478
best when the changes don't depend on each other.
5481
takes_args = ['shelf_id?']
5483
RegistryOption.from_kwargs(
5484
'action', help="The action to perform.",
5485
enum_switch=False, value_switches=True,
5486
apply="Apply changes and remove from the shelf.",
5487
dry_run="Show changes, but do not apply or remove them.",
5488
delete_only="Delete changes without applying them."
5491
_see_also = ['shelve']
5493
def run(self, shelf_id=None, action='apply'):
5494
from bzrlib.shelf_ui import Unshelver
5495
Unshelver.from_args(shelf_id, action).run()
5498
class cmd_clean_tree(Command):
5499
"""Remove unwanted files from working tree.
5501
By default, only unknown files, not ignored files, are deleted. Versioned
5502
files are never deleted.
5504
Another class is 'detritus', which includes files emitted by bzr during
5505
normal operations and selftests. (The value of these files decreases with
5508
If no options are specified, unknown files are deleted. Otherwise, option
5509
flags are respected, and may be combined.
5511
To check what clean-tree will do, use --dry-run.
5513
takes_options = [Option('ignored', help='Delete all ignored files.'),
5514
Option('detritus', help='Delete conflict files, merge'
5515
' backups, and failed selftest dirs.'),
5517
help='Delete files unknown to bzr (default).'),
5518
Option('dry-run', help='Show files to delete instead of'
5520
Option('force', help='Do not prompt before deleting.')]
5521
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5523
from bzrlib.clean_tree import clean_tree
5524
if not (unknown or ignored or detritus):
5528
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5529
dry_run=dry_run, no_prompt=force)
5532
def _create_prefix(cur_transport):
5533
needed = [cur_transport]
5534
# Recurse upwards until we can create a directory successfully
5536
new_transport = cur_transport.clone('..')
5537
if new_transport.base == cur_transport.base:
5538
raise errors.BzrCommandError(
5539
"Failed to create path prefix for %s."
5540
% cur_transport.base)
5542
new_transport.mkdir('.')
5543
except errors.NoSuchFile:
5544
needed.append(new_transport)
5545
cur_transport = new_transport
5548
# Now we only need to create child directories
5550
cur_transport = needed.pop()
5551
cur_transport.ensure_base()
5554
# these get imported and then picked up by the scan for cmd_*
5555
# TODO: Some more consistent way to split command definitions across files;
5556
# we do need to load at least some information about them to know of
5557
# aliases. ideally we would avoid loading the implementation until the
5558
# details were needed.
5559
from bzrlib.cmd_version_info import cmd_version_info
5560
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5561
from bzrlib.bundle.commands import (
5564
from bzrlib.sign_my_commits import cmd_sign_my_commits
5565
from bzrlib.weave_commands import cmd_versionedfile_list, \
5566
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
