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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
45
revision as _mod_revision,
53
from bzrlib.branch import Branch
54
from bzrlib.conflicts import ConflictList
55
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
56
from bzrlib.smtp_connection import SMTPConnection
57
from bzrlib.workingtree import WorkingTree
60
from bzrlib.commands import Command, display_command
61
from bzrlib.option import (
68
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
71
def tree_files(file_list, default_branch=u'.', canonicalize=True,
74
return internal_tree_files(file_list, default_branch, canonicalize,
76
except errors.FileInWrongBranch, e:
77
raise errors.BzrCommandError("%s is not in the same branch as %s" %
78
(e.path, file_list[0]))
81
def tree_files_for_add(file_list):
83
Return a tree and list of absolute paths from a file list.
85
Similar to tree_files, but add handles files a bit differently, so it a
86
custom implementation. In particular, MutableTreeTree.smart_add expects
87
absolute paths, which it immediately converts to relative paths.
89
# FIXME Would be nice to just return the relative paths like
90
# internal_tree_files does, but there are a large number of unit tests
91
# that assume the current interface to mutabletree.smart_add
93
tree, relpath = WorkingTree.open_containing(file_list[0])
94
if tree.supports_views():
95
view_files = tree.views.lookup_view()
97
for filename in file_list:
98
if not osutils.is_inside_any(view_files, filename):
99
raise errors.FileOutsideView(filename, view_files)
100
file_list = file_list[:]
101
file_list[0] = tree.abspath(relpath)
103
tree = WorkingTree.open_containing(u'.')[0]
104
if tree.supports_views():
105
view_files = tree.views.lookup_view()
107
file_list = view_files
108
view_str = views.view_display_str(view_files)
109
note("Ignoring files outside view. View is %s" % view_str)
110
return tree, file_list
113
def _get_one_revision(command_name, revisions):
114
if revisions is None:
116
if len(revisions) != 1:
117
raise errors.BzrCommandError(
118
'bzr %s --revision takes exactly one revision identifier' % (
123
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
126
if revisions is None:
128
rev_tree = tree.basis_tree()
130
rev_tree = branch.basis_tree()
132
revision = _get_one_revision(command_name, revisions)
133
rev_tree = revision.as_tree(branch)
137
# XXX: Bad function name; should possibly also be a class method of
138
# WorkingTree rather than a function.
139
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
141
"""Convert command-line paths to a WorkingTree and relative paths.
143
This is typically used for command-line processors that take one or
144
more filenames, and infer the workingtree that contains them.
146
The filenames given are not required to exist.
148
:param file_list: Filenames to convert.
150
:param default_branch: Fallback tree path to use if file_list is empty or
153
:param apply_view: if True and a view is set, apply it or check that
154
specified files are within it
156
:return: workingtree, [relative_paths]
158
if file_list is None or len(file_list) == 0:
159
tree = WorkingTree.open_containing(default_branch)[0]
160
if tree.supports_views() and apply_view:
161
view_files = tree.views.lookup_view()
163
file_list = view_files
164
view_str = views.view_display_str(view_files)
165
note("Ignoring files outside view. View is %s" % view_str)
166
return tree, file_list
167
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
168
return tree, safe_relpath_files(tree, file_list, canonicalize,
169
apply_view=apply_view)
172
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
173
"""Convert file_list into a list of relpaths in tree.
175
:param tree: A tree to operate on.
176
:param file_list: A list of user provided paths or None.
177
:param apply_view: if True and a view is set, apply it or check that
178
specified files are within it
179
:return: A list of relative paths.
180
:raises errors.PathNotChild: When a provided path is in a different tree
183
if file_list is None:
185
if tree.supports_views() and apply_view:
186
view_files = tree.views.lookup_view()
190
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
191
# doesn't - fix that up here before we enter the loop.
193
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
196
for filename in file_list:
198
relpath = fixer(osutils.dereference_path(filename))
199
if view_files and not osutils.is_inside_any(view_files, relpath):
200
raise errors.FileOutsideView(filename, view_files)
201
new_list.append(relpath)
202
except errors.PathNotChild:
203
raise errors.FileInWrongBranch(tree.branch, filename)
207
def _get_view_info_for_change_reporter(tree):
208
"""Get the view information from a tree for change reporting."""
211
current_view = tree.views.get_view_info()[0]
212
if current_view is not None:
213
view_info = (current_view, tree.views.lookup_view())
214
except errors.ViewsNotSupported:
219
# TODO: Make sure no commands unconditionally use the working directory as a
220
# branch. If a filename argument is used, the first of them should be used to
221
# specify the branch. (Perhaps this can be factored out into some kind of
222
# Argument class, representing a file in a branch, where the first occurrence
225
class cmd_status(Command):
226
"""Display status summary.
228
This reports on versioned and unknown files, reporting them
229
grouped by state. Possible states are:
232
Versioned in the working copy but not in the previous revision.
235
Versioned in the previous revision but removed or deleted
239
Path of this file changed from the previous revision;
240
the text may also have changed. This includes files whose
241
parent directory was renamed.
244
Text has changed since the previous revision.
247
File kind has been changed (e.g. from file to directory).
250
Not versioned and not matching an ignore pattern.
252
To see ignored files use 'bzr ignored'. For details on the
253
changes to file texts, use 'bzr diff'.
255
Note that --short or -S gives status flags for each item, similar
256
to Subversion's status command. To get output similar to svn -q,
259
If no arguments are specified, the status of the entire working
260
directory is shown. Otherwise, only the status of the specified
261
files or directories is reported. If a directory is given, status
262
is reported for everything inside that directory.
264
Before merges are committed, the pending merge tip revisions are
265
shown. To see all pending merge revisions, use the -v option.
266
To skip the display of pending merge information altogether, use
267
the no-pending option or specify a file/directory.
269
If a revision argument is given, the status is calculated against
270
that revision, or between two revisions if two are provided.
273
# TODO: --no-recurse, --recurse options
275
takes_args = ['file*']
276
takes_options = ['show-ids', 'revision', 'change', 'verbose',
277
Option('short', help='Use short status indicators.',
279
Option('versioned', help='Only show versioned files.',
281
Option('no-pending', help='Don\'t show pending merges.',
284
aliases = ['st', 'stat']
286
encoding_type = 'replace'
287
_see_also = ['diff', 'revert', 'status-flags']
290
def run(self, show_ids=False, file_list=None, revision=None, short=False,
291
versioned=False, no_pending=False, verbose=False):
292
from bzrlib.status import show_tree_status
294
if revision and len(revision) > 2:
295
raise errors.BzrCommandError('bzr status --revision takes exactly'
296
' one or two revision specifiers')
298
tree, relfile_list = tree_files(file_list)
299
# Avoid asking for specific files when that is not needed.
300
if relfile_list == ['']:
302
# Don't disable pending merges for full trees other than '.'.
303
if file_list == ['.']:
305
# A specific path within a tree was given.
306
elif relfile_list is not None:
308
show_tree_status(tree, show_ids=show_ids,
309
specific_files=relfile_list, revision=revision,
310
to_file=self.outf, short=short, versioned=versioned,
311
show_pending=(not no_pending), verbose=verbose)
314
class cmd_cat_revision(Command):
315
"""Write out metadata for a revision.
317
The revision to print can either be specified by a specific
318
revision identifier, or you can use --revision.
322
takes_args = ['revision_id?']
323
takes_options = ['revision']
324
# cat-revision is more for frontends so should be exact
328
def run(self, revision_id=None, revision=None):
329
if revision_id is not None and revision is not None:
330
raise errors.BzrCommandError('You can only supply one of'
331
' revision_id or --revision')
332
if revision_id is None and revision is None:
333
raise errors.BzrCommandError('You must supply either'
334
' --revision or a revision_id')
335
b = WorkingTree.open_containing(u'.')[0].branch
337
# TODO: jam 20060112 should cat-revision always output utf-8?
338
if revision_id is not None:
339
revision_id = osutils.safe_revision_id(revision_id, warn=False)
341
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
342
except errors.NoSuchRevision:
343
msg = "The repository %s contains no revision %s." % (b.repository.base,
345
raise errors.BzrCommandError(msg)
346
elif revision is not None:
349
raise errors.BzrCommandError('You cannot specify a NULL'
351
rev_id = rev.as_revision_id(b)
352
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
355
class cmd_dump_btree(Command):
356
"""Dump the contents of a btree index file to stdout.
358
PATH is a btree index file, it can be any URL. This includes things like
359
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
361
By default, the tuples stored in the index file will be displayed. With
362
--raw, we will uncompress the pages, but otherwise display the raw bytes
366
# TODO: Do we want to dump the internal nodes as well?
367
# TODO: It would be nice to be able to dump the un-parsed information,
368
# rather than only going through iter_all_entries. However, this is
369
# good enough for a start
371
encoding_type = 'exact'
372
takes_args = ['path']
373
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
374
' rather than the parsed tuples.'),
377
def run(self, path, raw=False):
378
dirname, basename = osutils.split(path)
379
t = transport.get_transport(dirname)
381
self._dump_raw_bytes(t, basename)
383
self._dump_entries(t, basename)
385
def _get_index_and_bytes(self, trans, basename):
386
"""Create a BTreeGraphIndex and raw bytes."""
387
bt = btree_index.BTreeGraphIndex(trans, basename, None)
388
bytes = trans.get_bytes(basename)
389
bt._file = cStringIO.StringIO(bytes)
390
bt._size = len(bytes)
393
def _dump_raw_bytes(self, trans, basename):
396
# We need to parse at least the root node.
397
# This is because the first page of every row starts with an
398
# uncompressed header.
399
bt, bytes = self._get_index_and_bytes(trans, basename)
400
for page_idx, page_start in enumerate(xrange(0, len(bytes),
401
btree_index._PAGE_SIZE)):
402
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
403
page_bytes = bytes[page_start:page_end]
405
self.outf.write('Root node:\n')
406
header_end, data = bt._parse_header_from_bytes(page_bytes)
407
self.outf.write(page_bytes[:header_end])
409
self.outf.write('\nPage %d\n' % (page_idx,))
410
decomp_bytes = zlib.decompress(page_bytes)
411
self.outf.write(decomp_bytes)
412
self.outf.write('\n')
414
def _dump_entries(self, trans, basename):
416
st = trans.stat(basename)
417
except errors.TransportNotPossible:
418
# We can't stat, so we'll fake it because we have to do the 'get()'
420
bt, _ = self._get_index_and_bytes(trans, basename)
422
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
423
for node in bt.iter_all_entries():
424
# Node is made up of:
425
# (index, key, value, [references])
426
self.outf.write('%s\n' % (node[1:],))
429
class cmd_remove_tree(Command):
430
"""Remove the working tree from a given branch/checkout.
432
Since a lightweight checkout is little more than a working tree
433
this will refuse to run against one.
435
To re-create the working tree, use "bzr checkout".
437
_see_also = ['checkout', 'working-trees']
438
takes_args = ['location?']
441
help='Remove the working tree even if it has '
442
'uncommitted changes.'),
445
def run(self, location='.', force=False):
446
d = bzrdir.BzrDir.open(location)
449
working = d.open_workingtree()
450
except errors.NoWorkingTree:
451
raise errors.BzrCommandError("No working tree to remove")
452
except errors.NotLocalUrl:
453
raise errors.BzrCommandError("You cannot remove the working tree of a "
456
changes = working.changes_from(working.basis_tree())
457
if changes.has_changed():
458
raise errors.UncommittedChanges(working)
460
working_path = working.bzrdir.root_transport.base
461
branch_path = working.branch.bzrdir.root_transport.base
462
if working_path != branch_path:
463
raise errors.BzrCommandError("You cannot remove the working tree from "
464
"a lightweight checkout")
466
d.destroy_workingtree()
469
class cmd_revno(Command):
470
"""Show current revision number.
472
This is equal to the number of revisions on this branch.
476
takes_args = ['location?']
479
def run(self, location=u'.'):
480
self.outf.write(str(Branch.open_containing(location)[0].revno()))
481
self.outf.write('\n')
484
class cmd_revision_info(Command):
485
"""Show revision number and revision id for a given revision identifier.
488
takes_args = ['revision_info*']
492
help='Branch to examine, '
493
'rather than the one containing the working directory.',
500
def run(self, revision=None, directory=u'.', revision_info_list=[]):
503
if revision is not None:
504
revs.extend(revision)
505
if revision_info_list is not None:
506
for rev in revision_info_list:
507
revs.append(RevisionSpec.from_string(rev))
509
b = Branch.open_containing(directory)[0]
512
revs.append(RevisionSpec.from_string('-1'))
515
revision_id = rev.as_revision_id(b)
517
revno = '%4d' % (b.revision_id_to_revno(revision_id))
518
except errors.NoSuchRevision:
519
dotted_map = b.get_revision_id_to_revno_map()
520
revno = '.'.join(str(i) for i in dotted_map[revision_id])
521
print '%s %s' % (revno, revision_id)
524
class cmd_add(Command):
525
"""Add specified files or directories.
527
In non-recursive mode, all the named items are added, regardless
528
of whether they were previously ignored. A warning is given if
529
any of the named files are already versioned.
531
In recursive mode (the default), files are treated the same way
532
but the behaviour for directories is different. Directories that
533
are already versioned do not give a warning. All directories,
534
whether already versioned or not, are searched for files or
535
subdirectories that are neither versioned or ignored, and these
536
are added. This search proceeds recursively into versioned
537
directories. If no names are given '.' is assumed.
539
Therefore simply saying 'bzr add' will version all files that
540
are currently unknown.
542
Adding a file whose parent directory is not versioned will
543
implicitly add the parent, and so on up to the root. This means
544
you should never need to explicitly add a directory, they'll just
545
get added when you add a file in the directory.
547
--dry-run will show which files would be added, but not actually
550
--file-ids-from will try to use the file ids from the supplied path.
551
It looks up ids trying to find a matching parent directory with the
552
same filename, and then by pure path. This option is rarely needed
553
but can be useful when adding the same logical file into two
554
branches that will be merged later (without showing the two different
555
adds as a conflict). It is also useful when merging another project
556
into a subdirectory of this one.
558
takes_args = ['file*']
561
help="Don't recursively add the contents of directories."),
563
help="Show what would be done, but don't actually do anything."),
565
Option('file-ids-from',
567
help='Lookup file ids from this tree.'),
569
encoding_type = 'replace'
570
_see_also = ['remove']
572
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
577
if file_ids_from is not None:
579
base_tree, base_path = WorkingTree.open_containing(
581
except errors.NoWorkingTree:
582
base_branch, base_path = Branch.open_containing(
584
base_tree = base_branch.basis_tree()
586
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
587
to_file=self.outf, should_print=(not is_quiet()))
589
action = bzrlib.add.AddAction(to_file=self.outf,
590
should_print=(not is_quiet()))
593
base_tree.lock_read()
595
file_list = self._maybe_expand_globs(file_list)
596
tree, file_list = tree_files_for_add(file_list)
597
added, ignored = tree.smart_add(file_list, not
598
no_recurse, action=action, save=not dry_run)
600
if base_tree is not None:
604
for glob in sorted(ignored.keys()):
605
for path in ignored[glob]:
606
self.outf.write("ignored %s matching \"%s\"\n"
610
for glob, paths in ignored.items():
611
match_len += len(paths)
612
self.outf.write("ignored %d file(s).\n" % match_len)
613
self.outf.write("If you wish to add ignored files, "
614
"please add them explicitly by name. "
615
"(\"bzr ignored\" gives a list)\n")
618
class cmd_mkdir(Command):
619
"""Create a new versioned directory.
621
This is equivalent to creating the directory and then adding it.
624
takes_args = ['dir+']
625
encoding_type = 'replace'
627
def run(self, dir_list):
630
wt, dd = WorkingTree.open_containing(d)
632
self.outf.write('added %s\n' % d)
635
class cmd_relpath(Command):
636
"""Show path of a file relative to root"""
638
takes_args = ['filename']
642
def run(self, filename):
643
# TODO: jam 20050106 Can relpath return a munged path if
644
# sys.stdout encoding cannot represent it?
645
tree, relpath = WorkingTree.open_containing(filename)
646
self.outf.write(relpath)
647
self.outf.write('\n')
650
class cmd_inventory(Command):
651
"""Show inventory of the current working copy or a revision.
653
It is possible to limit the output to a particular entry
654
type using the --kind option. For example: --kind file.
656
It is also possible to restrict the list of files to a specific
657
set. For example: bzr inventory --show-ids this/file
666
help='List entries of a particular kind: file, directory, symlink.',
669
takes_args = ['file*']
672
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
673
if kind and kind not in ['file', 'directory', 'symlink']:
674
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
676
revision = _get_one_revision('inventory', revision)
677
work_tree, file_list = tree_files(file_list)
678
work_tree.lock_read()
680
if revision is not None:
681
tree = revision.as_tree(work_tree.branch)
683
extra_trees = [work_tree]
689
if file_list is not None:
690
file_ids = tree.paths2ids(file_list, trees=extra_trees,
691
require_versioned=True)
692
# find_ids_across_trees may include some paths that don't
694
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
695
for file_id in file_ids if file_id in tree)
697
entries = tree.inventory.entries()
700
if tree is not work_tree:
703
for path, entry in entries:
704
if kind and kind != entry.kind:
707
self.outf.write('%-50s %s\n' % (path, entry.file_id))
709
self.outf.write(path)
710
self.outf.write('\n')
713
class cmd_mv(Command):
714
"""Move or rename a file.
717
bzr mv OLDNAME NEWNAME
719
bzr mv SOURCE... DESTINATION
721
If the last argument is a versioned directory, all the other names
722
are moved into it. Otherwise, there must be exactly two arguments
723
and the file is changed to a new name.
725
If OLDNAME does not exist on the filesystem but is versioned and
726
NEWNAME does exist on the filesystem but is not versioned, mv
727
assumes that the file has been manually moved and only updates
728
its internal inventory to reflect that change.
729
The same is valid when moving many SOURCE files to a DESTINATION.
731
Files cannot be moved between branches.
734
takes_args = ['names*']
735
takes_options = [Option("after", help="Move only the bzr identifier"
736
" of the file, because the file has already been moved."),
737
Option('auto', help='Automatically guess renames.'),
738
Option('dry-run', help='Avoid making changes when guessing renames.'),
740
aliases = ['move', 'rename']
741
encoding_type = 'replace'
743
def run(self, names_list, after=False, auto=False, dry_run=False):
745
return self.run_auto(names_list, after, dry_run)
747
raise errors.BzrCommandError('--dry-run requires --auto.')
748
if names_list is None:
750
if len(names_list) < 2:
751
raise errors.BzrCommandError("missing file argument")
752
tree, rel_names = tree_files(names_list, canonicalize=False)
755
self._run(tree, names_list, rel_names, after)
759
def run_auto(self, names_list, after, dry_run):
760
if names_list is not None and len(names_list) > 1:
761
raise errors.BzrCommandError('Only one path may be specified to'
764
raise errors.BzrCommandError('--after cannot be specified with'
766
work_tree, file_list = tree_files(names_list, default_branch='.')
767
work_tree.lock_write()
769
rename_map.RenameMap.guess_renames(work_tree, dry_run)
773
def _run(self, tree, names_list, rel_names, after):
774
into_existing = osutils.isdir(names_list[-1])
775
if into_existing and len(names_list) == 2:
777
# a. case-insensitive filesystem and change case of dir
778
# b. move directory after the fact (if the source used to be
779
# a directory, but now doesn't exist in the working tree
780
# and the target is an existing directory, just rename it)
781
if (not tree.case_sensitive
782
and rel_names[0].lower() == rel_names[1].lower()):
783
into_existing = False
786
# 'fix' the case of a potential 'from'
787
from_id = tree.path2id(
788
tree.get_canonical_inventory_path(rel_names[0]))
789
if (not osutils.lexists(names_list[0]) and
790
from_id and inv.get_file_kind(from_id) == "directory"):
791
into_existing = False
794
# move into existing directory
795
# All entries reference existing inventory items, so fix them up
796
# for cicp file-systems.
797
rel_names = tree.get_canonical_inventory_paths(rel_names)
798
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
799
self.outf.write("%s => %s\n" % pair)
801
if len(names_list) != 2:
802
raise errors.BzrCommandError('to mv multiple files the'
803
' destination must be a versioned'
806
# for cicp file-systems: the src references an existing inventory
808
src = tree.get_canonical_inventory_path(rel_names[0])
809
# Find the canonical version of the destination: In all cases, the
810
# parent of the target must be in the inventory, so we fetch the
811
# canonical version from there (we do not always *use* the
812
# canonicalized tail portion - we may be attempting to rename the
814
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
815
dest_parent = osutils.dirname(canon_dest)
816
spec_tail = osutils.basename(rel_names[1])
817
# For a CICP file-system, we need to avoid creating 2 inventory
818
# entries that differ only by case. So regardless of the case
819
# we *want* to use (ie, specified by the user or the file-system),
820
# we must always choose to use the case of any existing inventory
821
# items. The only exception to this is when we are attempting a
822
# case-only rename (ie, canonical versions of src and dest are
824
dest_id = tree.path2id(canon_dest)
825
if dest_id is None or tree.path2id(src) == dest_id:
826
# No existing item we care about, so work out what case we
827
# are actually going to use.
829
# If 'after' is specified, the tail must refer to a file on disk.
831
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
833
# pathjoin with an empty tail adds a slash, which breaks
835
dest_parent_fq = tree.basedir
837
dest_tail = osutils.canonical_relpath(
839
osutils.pathjoin(dest_parent_fq, spec_tail))
841
# not 'after', so case as specified is used
842
dest_tail = spec_tail
844
# Use the existing item so 'mv' fails with AlreadyVersioned.
845
dest_tail = os.path.basename(canon_dest)
846
dest = osutils.pathjoin(dest_parent, dest_tail)
847
mutter("attempting to move %s => %s", src, dest)
848
tree.rename_one(src, dest, after=after)
849
self.outf.write("%s => %s\n" % (src, dest))
852
class cmd_pull(Command):
853
"""Turn this branch into a mirror of another branch.
855
This command only works on branches that have not diverged. Branches are
856
considered diverged if the destination branch's most recent commit is one
857
that has not been merged (directly or indirectly) into the parent.
859
If branches have diverged, you can use 'bzr merge' to integrate the changes
860
from one into the other. Once one branch has merged, the other should
861
be able to pull it again.
863
If you want to forget your local changes and just update your branch to
864
match the remote one, use pull --overwrite.
866
If there is no default location set, the first pull will set it. After
867
that, you can omit the location to use the default. To change the
868
default, use --remember. The value will only be saved if the remote
869
location can be accessed.
871
Note: The location can be specified either in the form of a branch,
872
or in the form of a path to a file containing a merge directive generated
876
_see_also = ['push', 'update', 'status-flags', 'send']
877
takes_options = ['remember', 'overwrite', 'revision',
878
custom_help('verbose',
879
help='Show logs of pulled revisions.'),
881
help='Branch to pull into, '
882
'rather than the one containing the working directory.',
887
help="Perform a local pull in a bound "
888
"branch. Local pulls are not applied to "
892
takes_args = ['location?']
893
encoding_type = 'replace'
895
def run(self, location=None, remember=False, overwrite=False,
896
revision=None, verbose=False,
897
directory=None, local=False):
898
# FIXME: too much stuff is in the command class
901
if directory is None:
904
tree_to = WorkingTree.open_containing(directory)[0]
905
branch_to = tree_to.branch
906
except errors.NoWorkingTree:
908
branch_to = Branch.open_containing(directory)[0]
910
if local and not branch_to.get_bound_location():
911
raise errors.LocalRequiresBoundBranch()
913
possible_transports = []
914
if location is not None:
916
mergeable = bundle.read_mergeable_from_url(location,
917
possible_transports=possible_transports)
918
except errors.NotABundle:
921
stored_loc = branch_to.get_parent()
923
if stored_loc is None:
924
raise errors.BzrCommandError("No pull location known or"
927
display_url = urlutils.unescape_for_display(stored_loc,
930
self.outf.write("Using saved parent location: %s\n" % display_url)
931
location = stored_loc
933
revision = _get_one_revision('pull', revision)
934
if mergeable is not None:
935
if revision is not None:
936
raise errors.BzrCommandError(
937
'Cannot use -r with merge directives or bundles')
938
mergeable.install_revisions(branch_to.repository)
939
base_revision_id, revision_id, verified = \
940
mergeable.get_merge_request(branch_to.repository)
941
branch_from = branch_to
943
branch_from = Branch.open(location,
944
possible_transports=possible_transports)
946
if branch_to.get_parent() is None or remember:
947
branch_to.set_parent(branch_from.base)
949
if branch_from is not branch_to:
950
branch_from.lock_read()
952
if revision is not None:
953
revision_id = revision.as_revision_id(branch_from)
955
branch_to.lock_write()
957
if tree_to is not None:
958
view_info = _get_view_info_for_change_reporter(tree_to)
959
change_reporter = delta._ChangeReporter(
960
unversioned_filter=tree_to.is_ignored,
962
result = tree_to.pull(
963
branch_from, overwrite, revision_id, change_reporter,
964
possible_transports=possible_transports, local=local)
966
result = branch_to.pull(
967
branch_from, overwrite, revision_id, local=local)
969
result.report(self.outf)
970
if verbose and result.old_revid != result.new_revid:
971
log.show_branch_change(
972
branch_to, self.outf, result.old_revno,
977
if branch_from is not branch_to:
981
class cmd_push(Command):
982
"""Update a mirror of this branch.
984
The target branch will not have its working tree populated because this
985
is both expensive, and is not supported on remote file systems.
987
Some smart servers or protocols *may* put the working tree in place in
990
This command only works on branches that have not diverged. Branches are
991
considered diverged if the destination branch's most recent commit is one
992
that has not been merged (directly or indirectly) by the source branch.
994
If branches have diverged, you can use 'bzr push --overwrite' to replace
995
the other branch completely, discarding its unmerged changes.
997
If you want to ensure you have the different changes in the other branch,
998
do a merge (see bzr help merge) from the other branch, and commit that.
999
After that you will be able to do a push without '--overwrite'.
1001
If there is no default push location set, the first push will set it.
1002
After that, you can omit the location to use the default. To change the
1003
default, use --remember. The value will only be saved if the remote
1004
location can be accessed.
1007
_see_also = ['pull', 'update', 'working-trees']
1008
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1009
Option('create-prefix',
1010
help='Create the path leading up to the branch '
1011
'if it does not already exist.'),
1013
help='Branch to push from, '
1014
'rather than the one containing the working directory.',
1018
Option('use-existing-dir',
1019
help='By default push will fail if the target'
1020
' directory exists, but does not already'
1021
' have a control directory. This flag will'
1022
' allow push to proceed.'),
1024
help='Create a stacked branch that references the public location '
1025
'of the parent branch.'),
1026
Option('stacked-on',
1027
help='Create a stacked branch that refers to another branch '
1028
'for the commit history. Only the work not present in the '
1029
'referenced branch is included in the branch created.',
1032
help='Refuse to push if there are uncommitted changes in'
1033
' the working tree.'),
1035
takes_args = ['location?']
1036
encoding_type = 'replace'
1038
def run(self, location=None, remember=False, overwrite=False,
1039
create_prefix=False, verbose=False, revision=None,
1040
use_existing_dir=False, directory=None, stacked_on=None,
1041
stacked=False, strict=None):
1042
from bzrlib.push import _show_push_branch
1044
if directory is None:
1046
# Get the source branch
1047
tree, br_from = bzrdir.BzrDir.open_tree_or_branch(directory)
1049
strict = br_from.get_config().get_user_option('push_strict')
1050
if strict is not None:
1051
# FIXME: This should be better supported by config
1053
bools = dict(yes=True, no=False, on=True, off=False,
1054
true=True, false=False)
1056
strict = bools[strict.lower()]
1060
changes = tree.changes_from(tree.basis_tree())
1061
if changes.has_changed():
1062
raise errors.UncommittedChanges(tree)
1063
# Get the tip's revision_id
1064
revision = _get_one_revision('push', revision)
1065
if revision is not None:
1066
revision_id = revision.in_history(br_from).rev_id
1070
# Get the stacked_on branch, if any
1071
if stacked_on is not None:
1072
stacked_on = urlutils.normalize_url(stacked_on)
1074
parent_url = br_from.get_parent()
1076
parent = Branch.open(parent_url)
1077
stacked_on = parent.get_public_branch()
1079
# I considered excluding non-http url's here, thus forcing
1080
# 'public' branches only, but that only works for some
1081
# users, so it's best to just depend on the user spotting an
1082
# error by the feedback given to them. RBC 20080227.
1083
stacked_on = parent_url
1085
raise errors.BzrCommandError(
1086
"Could not determine branch to refer to.")
1088
# Get the destination location
1089
if location is None:
1090
stored_loc = br_from.get_push_location()
1091
if stored_loc is None:
1092
raise errors.BzrCommandError(
1093
"No push location known or specified.")
1095
display_url = urlutils.unescape_for_display(stored_loc,
1097
self.outf.write("Using saved push location: %s\n" % display_url)
1098
location = stored_loc
1100
_show_push_branch(br_from, revision_id, location, self.outf,
1101
verbose=verbose, overwrite=overwrite, remember=remember,
1102
stacked_on=stacked_on, create_prefix=create_prefix,
1103
use_existing_dir=use_existing_dir)
1106
class cmd_branch(Command):
1107
"""Create a new branch that is a copy of an existing branch.
1109
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1110
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1111
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1112
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1113
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1116
To retrieve the branch as of a particular revision, supply the --revision
1117
parameter, as in "branch foo/bar -r 5".
1120
_see_also = ['checkout']
1121
takes_args = ['from_location', 'to_location?']
1122
takes_options = ['revision', Option('hardlink',
1123
help='Hard-link working tree files where possible.'),
1125
help="Create a branch without a working-tree."),
1127
help='Create a stacked branch referring to the source branch. '
1128
'The new branch will depend on the availability of the source '
1129
'branch for all operations.'),
1130
Option('standalone',
1131
help='Do not use a shared repository, even if available.'),
1133
aliases = ['get', 'clone']
1135
def run(self, from_location, to_location=None, revision=None,
1136
hardlink=False, stacked=False, standalone=False, no_tree=False):
1137
from bzrlib.tag import _merge_tags_if_possible
1139
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1141
if (accelerator_tree is not None and
1142
accelerator_tree.supports_content_filtering()):
1143
accelerator_tree = None
1144
revision = _get_one_revision('branch', revision)
1147
if revision is not None:
1148
revision_id = revision.as_revision_id(br_from)
1150
# FIXME - wt.last_revision, fallback to branch, fall back to
1151
# None or perhaps NULL_REVISION to mean copy nothing
1153
revision_id = br_from.last_revision()
1154
if to_location is None:
1155
to_location = urlutils.derive_to_location(from_location)
1156
to_transport = transport.get_transport(to_location)
1158
to_transport.mkdir('.')
1159
except errors.FileExists:
1160
raise errors.BzrCommandError('Target directory "%s" already'
1161
' exists.' % to_location)
1162
except errors.NoSuchFile:
1163
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1166
# preserve whatever source format we have.
1167
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1168
possible_transports=[to_transport],
1169
accelerator_tree=accelerator_tree,
1170
hardlink=hardlink, stacked=stacked,
1171
force_new_repo=standalone,
1172
create_tree_if_local=not no_tree,
1173
source_branch=br_from)
1174
branch = dir.open_branch()
1175
except errors.NoSuchRevision:
1176
to_transport.delete_tree('.')
1177
msg = "The branch %s has no revision %s." % (from_location,
1179
raise errors.BzrCommandError(msg)
1180
_merge_tags_if_possible(br_from, branch)
1181
# If the source branch is stacked, the new branch may
1182
# be stacked whether we asked for that explicitly or not.
1183
# We therefore need a try/except here and not just 'if stacked:'
1185
note('Created new stacked branch referring to %s.' %
1186
branch.get_stacked_on_url())
1187
except (errors.NotStacked, errors.UnstackableBranchFormat,
1188
errors.UnstackableRepositoryFormat), e:
1189
note('Branched %d revision(s).' % branch.revno())
1194
class cmd_checkout(Command):
1195
"""Create a new checkout of an existing branch.
1197
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1198
the branch found in '.'. This is useful if you have removed the working tree
1199
or if it was never created - i.e. if you pushed the branch to its current
1200
location using SFTP.
1202
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1203
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1204
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1205
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1206
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1209
To retrieve the branch as of a particular revision, supply the --revision
1210
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1211
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1215
_see_also = ['checkouts', 'branch']
1216
takes_args = ['branch_location?', 'to_location?']
1217
takes_options = ['revision',
1218
Option('lightweight',
1219
help="Perform a lightweight checkout. Lightweight "
1220
"checkouts depend on access to the branch for "
1221
"every operation. Normal checkouts can perform "
1222
"common operations like diff and status without "
1223
"such access, and also support local commits."
1225
Option('files-from', type=str,
1226
help="Get file contents from this tree."),
1228
help='Hard-link working tree files where possible.'
1233
def run(self, branch_location=None, to_location=None, revision=None,
1234
lightweight=False, files_from=None, hardlink=False):
1235
if branch_location is None:
1236
branch_location = osutils.getcwd()
1237
to_location = branch_location
1238
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1240
revision = _get_one_revision('checkout', revision)
1241
if files_from is not None:
1242
accelerator_tree = WorkingTree.open(files_from)
1243
if revision is not None:
1244
revision_id = revision.as_revision_id(source)
1247
if to_location is None:
1248
to_location = urlutils.derive_to_location(branch_location)
1249
# if the source and to_location are the same,
1250
# and there is no working tree,
1251
# then reconstitute a branch
1252
if (osutils.abspath(to_location) ==
1253
osutils.abspath(branch_location)):
1255
source.bzrdir.open_workingtree()
1256
except errors.NoWorkingTree:
1257
source.bzrdir.create_workingtree(revision_id)
1259
source.create_checkout(to_location, revision_id, lightweight,
1260
accelerator_tree, hardlink)
1263
class cmd_renames(Command):
1264
"""Show list of renamed files.
1266
# TODO: Option to show renames between two historical versions.
1268
# TODO: Only show renames under dir, rather than in the whole branch.
1269
_see_also = ['status']
1270
takes_args = ['dir?']
1273
def run(self, dir=u'.'):
1274
tree = WorkingTree.open_containing(dir)[0]
1277
new_inv = tree.inventory
1278
old_tree = tree.basis_tree()
1279
old_tree.lock_read()
1281
old_inv = old_tree.inventory
1283
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1284
for f, paths, c, v, p, n, k, e in iterator:
1285
if paths[0] == paths[1]:
1289
renames.append(paths)
1291
for old_name, new_name in renames:
1292
self.outf.write("%s => %s\n" % (old_name, new_name))
1299
class cmd_update(Command):
1300
"""Update a tree to have the latest code committed to its branch.
1302
This will perform a merge into the working tree, and may generate
1303
conflicts. If you have any local changes, you will still
1304
need to commit them after the update for the update to be complete.
1306
If you want to discard your local changes, you can just do a
1307
'bzr revert' instead of 'bzr commit' after the update.
1310
_see_also = ['pull', 'working-trees', 'status-flags']
1311
takes_args = ['dir?']
1314
def run(self, dir='.'):
1315
tree = WorkingTree.open_containing(dir)[0]
1316
possible_transports = []
1317
master = tree.branch.get_master_branch(
1318
possible_transports=possible_transports)
1319
if master is not None:
1322
tree.lock_tree_write()
1324
existing_pending_merges = tree.get_parent_ids()[1:]
1325
last_rev = _mod_revision.ensure_null(tree.last_revision())
1326
if last_rev == _mod_revision.ensure_null(
1327
tree.branch.last_revision()):
1328
# may be up to date, check master too.
1329
if master is None or last_rev == _mod_revision.ensure_null(
1330
master.last_revision()):
1331
revno = tree.branch.revision_id_to_revno(last_rev)
1332
note("Tree is up to date at revision %d." % (revno,))
1334
view_info = _get_view_info_for_change_reporter(tree)
1335
conflicts = tree.update(
1336
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1337
view_info=view_info), possible_transports=possible_transports)
1338
revno = tree.branch.revision_id_to_revno(
1339
_mod_revision.ensure_null(tree.last_revision()))
1340
note('Updated to revision %d.' % (revno,))
1341
if tree.get_parent_ids()[1:] != existing_pending_merges:
1342
note('Your local commits will now show as pending merges with '
1343
"'bzr status', and can be committed with 'bzr commit'.")
1352
class cmd_info(Command):
1353
"""Show information about a working tree, branch or repository.
1355
This command will show all known locations and formats associated to the
1356
tree, branch or repository.
1358
In verbose mode, statistical information is included with each report.
1359
To see extended statistic information, use a verbosity level of 2 or
1360
higher by specifying the verbose option multiple times, e.g. -vv.
1362
Branches and working trees will also report any missing revisions.
1366
Display information on the format and related locations:
1370
Display the above together with extended format information and
1371
basic statistics (like the number of files in the working tree and
1372
number of revisions in the branch and repository):
1376
Display the above together with number of committers to the branch:
1380
_see_also = ['revno', 'working-trees', 'repositories']
1381
takes_args = ['location?']
1382
takes_options = ['verbose']
1383
encoding_type = 'replace'
1386
def run(self, location=None, verbose=False):
1388
noise_level = get_verbosity_level()
1391
from bzrlib.info import show_bzrdir_info
1392
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1393
verbose=noise_level, outfile=self.outf)
1396
class cmd_remove(Command):
1397
"""Remove files or directories.
1399
This makes bzr stop tracking changes to the specified files. bzr will delete
1400
them if they can easily be recovered using revert. If no options or
1401
parameters are given bzr will scan for files that are being tracked by bzr
1402
but missing in your tree and stop tracking them for you.
1404
takes_args = ['file*']
1405
takes_options = ['verbose',
1406
Option('new', help='Only remove files that have never been committed.'),
1407
RegistryOption.from_kwargs('file-deletion-strategy',
1408
'The file deletion mode to be used.',
1409
title='Deletion Strategy', value_switches=True, enum_switch=False,
1410
safe='Only delete files if they can be'
1411
' safely recovered (default).',
1412
keep="Don't delete any files.",
1413
force='Delete all the specified files, even if they can not be '
1414
'recovered and even if they are non-empty directories.')]
1415
aliases = ['rm', 'del']
1416
encoding_type = 'replace'
1418
def run(self, file_list, verbose=False, new=False,
1419
file_deletion_strategy='safe'):
1420
tree, file_list = tree_files(file_list)
1422
if file_list is not None:
1423
file_list = [f for f in file_list]
1427
# Heuristics should probably all move into tree.remove_smart or
1430
added = tree.changes_from(tree.basis_tree(),
1431
specific_files=file_list).added
1432
file_list = sorted([f[0] for f in added], reverse=True)
1433
if len(file_list) == 0:
1434
raise errors.BzrCommandError('No matching files.')
1435
elif file_list is None:
1436
# missing files show up in iter_changes(basis) as
1437
# versioned-with-no-kind.
1439
for change in tree.iter_changes(tree.basis_tree()):
1440
# Find paths in the working tree that have no kind:
1441
if change[1][1] is not None and change[6][1] is None:
1442
missing.append(change[1][1])
1443
file_list = sorted(missing, reverse=True)
1444
file_deletion_strategy = 'keep'
1445
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1446
keep_files=file_deletion_strategy=='keep',
1447
force=file_deletion_strategy=='force')
1452
class cmd_file_id(Command):
1453
"""Print file_id of a particular file or directory.
1455
The file_id is assigned when the file is first added and remains the
1456
same through all revisions where the file exists, even when it is
1461
_see_also = ['inventory', 'ls']
1462
takes_args = ['filename']
1465
def run(self, filename):
1466
tree, relpath = WorkingTree.open_containing(filename)
1467
i = tree.path2id(relpath)
1469
raise errors.NotVersionedError(filename)
1471
self.outf.write(i + '\n')
1474
class cmd_file_path(Command):
1475
"""Print path of file_ids to a file or directory.
1477
This prints one line for each directory down to the target,
1478
starting at the branch root.
1482
takes_args = ['filename']
1485
def run(self, filename):
1486
tree, relpath = WorkingTree.open_containing(filename)
1487
fid = tree.path2id(relpath)
1489
raise errors.NotVersionedError(filename)
1490
segments = osutils.splitpath(relpath)
1491
for pos in range(1, len(segments) + 1):
1492
path = osutils.joinpath(segments[:pos])
1493
self.outf.write("%s\n" % tree.path2id(path))
1496
class cmd_reconcile(Command):
1497
"""Reconcile bzr metadata in a branch.
1499
This can correct data mismatches that may have been caused by
1500
previous ghost operations or bzr upgrades. You should only
1501
need to run this command if 'bzr check' or a bzr developer
1502
advises you to run it.
1504
If a second branch is provided, cross-branch reconciliation is
1505
also attempted, which will check that data like the tree root
1506
id which was not present in very early bzr versions is represented
1507
correctly in both branches.
1509
At the same time it is run it may recompress data resulting in
1510
a potential saving in disk space or performance gain.
1512
The branch *MUST* be on a listable system such as local disk or sftp.
1515
_see_also = ['check']
1516
takes_args = ['branch?']
1518
def run(self, branch="."):
1519
from bzrlib.reconcile import reconcile
1520
dir = bzrdir.BzrDir.open(branch)
1524
class cmd_revision_history(Command):
1525
"""Display the list of revision ids on a branch."""
1528
takes_args = ['location?']
1533
def run(self, location="."):
1534
branch = Branch.open_containing(location)[0]
1535
for revid in branch.revision_history():
1536
self.outf.write(revid)
1537
self.outf.write('\n')
1540
class cmd_ancestry(Command):
1541
"""List all revisions merged into this branch."""
1543
_see_also = ['log', 'revision-history']
1544
takes_args = ['location?']
1549
def run(self, location="."):
1551
wt = WorkingTree.open_containing(location)[0]
1552
except errors.NoWorkingTree:
1553
b = Branch.open(location)
1554
last_revision = b.last_revision()
1557
last_revision = wt.last_revision()
1559
revision_ids = b.repository.get_ancestry(last_revision)
1561
for revision_id in revision_ids:
1562
self.outf.write(revision_id + '\n')
1565
class cmd_init(Command):
1566
"""Make a directory into a versioned branch.
1568
Use this to create an empty branch, or before importing an
1571
If there is a repository in a parent directory of the location, then
1572
the history of the branch will be stored in the repository. Otherwise
1573
init creates a standalone branch which carries its own history
1574
in the .bzr directory.
1576
If there is already a branch at the location but it has no working tree,
1577
the tree can be populated with 'bzr checkout'.
1579
Recipe for importing a tree of files::
1585
bzr commit -m "imported project"
1588
_see_also = ['init-repository', 'branch', 'checkout']
1589
takes_args = ['location?']
1591
Option('create-prefix',
1592
help='Create the path leading up to the branch '
1593
'if it does not already exist.'),
1594
RegistryOption('format',
1595
help='Specify a format for this branch. '
1596
'See "help formats".',
1597
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1598
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1599
value_switches=True,
1600
title="Branch Format",
1602
Option('append-revisions-only',
1603
help='Never change revnos or the existing log.'
1604
' Append revisions to it only.')
1606
def run(self, location=None, format=None, append_revisions_only=False,
1607
create_prefix=False):
1609
format = bzrdir.format_registry.make_bzrdir('default')
1610
if location is None:
1613
to_transport = transport.get_transport(location)
1615
# The path has to exist to initialize a
1616
# branch inside of it.
1617
# Just using os.mkdir, since I don't
1618
# believe that we want to create a bunch of
1619
# locations if the user supplies an extended path
1621
to_transport.ensure_base()
1622
except errors.NoSuchFile:
1623
if not create_prefix:
1624
raise errors.BzrCommandError("Parent directory of %s"
1626
"\nYou may supply --create-prefix to create all"
1627
" leading parent directories."
1629
to_transport.create_prefix()
1632
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1633
except errors.NotBranchError:
1634
# really a NotBzrDir error...
1635
create_branch = bzrdir.BzrDir.create_branch_convenience
1636
branch = create_branch(to_transport.base, format=format,
1637
possible_transports=[to_transport])
1638
a_bzrdir = branch.bzrdir
1640
from bzrlib.transport.local import LocalTransport
1641
if a_bzrdir.has_branch():
1642
if (isinstance(to_transport, LocalTransport)
1643
and not a_bzrdir.has_workingtree()):
1644
raise errors.BranchExistsWithoutWorkingTree(location)
1645
raise errors.AlreadyBranchError(location)
1646
branch = a_bzrdir.create_branch()
1647
a_bzrdir.create_workingtree()
1648
if append_revisions_only:
1650
branch.set_append_revisions_only(True)
1651
except errors.UpgradeRequired:
1652
raise errors.BzrCommandError('This branch format cannot be set'
1653
' to append-revisions-only. Try --default.')
1655
from bzrlib.info import describe_layout, describe_format
1657
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1658
except (errors.NoWorkingTree, errors.NotLocalUrl):
1660
repository = branch.repository
1661
layout = describe_layout(repository, branch, tree).lower()
1662
format = describe_format(a_bzrdir, repository, branch, tree)
1663
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1664
if repository.is_shared():
1665
#XXX: maybe this can be refactored into transport.path_or_url()
1666
url = repository.bzrdir.root_transport.external_url()
1668
url = urlutils.local_path_from_url(url)
1669
except errors.InvalidURL:
1671
self.outf.write("Using shared repository: %s\n" % url)
1674
class cmd_init_repository(Command):
1675
"""Create a shared repository to hold branches.
1677
New branches created under the repository directory will store their
1678
revisions in the repository, not in the branch directory.
1680
If the --no-trees option is used then the branches in the repository
1681
will not have working trees by default.
1684
Create a shared repositories holding just branches::
1686
bzr init-repo --no-trees repo
1689
Make a lightweight checkout elsewhere::
1691
bzr checkout --lightweight repo/trunk trunk-checkout
1696
_see_also = ['init', 'branch', 'checkout', 'repositories']
1697
takes_args = ["location"]
1698
takes_options = [RegistryOption('format',
1699
help='Specify a format for this repository. See'
1700
' "bzr help formats" for details.',
1701
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1702
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1703
value_switches=True, title='Repository format'),
1705
help='Branches in the repository will default to'
1706
' not having a working tree.'),
1708
aliases = ["init-repo"]
1710
def run(self, location, format=None, no_trees=False):
1712
format = bzrdir.format_registry.make_bzrdir('default')
1714
if location is None:
1717
to_transport = transport.get_transport(location)
1718
to_transport.ensure_base()
1720
newdir = format.initialize_on_transport(to_transport)
1721
repo = newdir.create_repository(shared=True)
1722
repo.set_make_working_trees(not no_trees)
1724
from bzrlib.info import show_bzrdir_info
1725
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1728
class cmd_diff(Command):
1729
"""Show differences in the working tree, between revisions or branches.
1731
If no arguments are given, all changes for the current tree are listed.
1732
If files are given, only the changes in those files are listed.
1733
Remote and multiple branches can be compared by using the --old and
1734
--new options. If not provided, the default for both is derived from
1735
the first argument, if any, or the current tree if no arguments are
1738
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1739
produces patches suitable for "patch -p1".
1743
2 - unrepresentable changes
1748
Shows the difference in the working tree versus the last commit::
1752
Difference between the working tree and revision 1::
1756
Difference between revision 2 and revision 1::
1760
Difference between revision 2 and revision 1 for branch xxx::
1764
Show just the differences for file NEWS::
1768
Show the differences in working tree xxx for file NEWS::
1772
Show the differences from branch xxx to this working tree:
1776
Show the differences between two branches for file NEWS::
1778
bzr diff --old xxx --new yyy NEWS
1780
Same as 'bzr diff' but prefix paths with old/ and new/::
1782
bzr diff --prefix old/:new/
1784
_see_also = ['status']
1785
takes_args = ['file*']
1787
Option('diff-options', type=str,
1788
help='Pass these options to the external diff program.'),
1789
Option('prefix', type=str,
1791
help='Set prefixes added to old and new filenames, as '
1792
'two values separated by a colon. (eg "old/:new/").'),
1794
help='Branch/tree to compare from.',
1798
help='Branch/tree to compare to.',
1804
help='Use this command to compare files.',
1808
aliases = ['di', 'dif']
1809
encoding_type = 'exact'
1812
def run(self, revision=None, file_list=None, diff_options=None,
1813
prefix=None, old=None, new=None, using=None):
1814
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1816
if (prefix is None) or (prefix == '0'):
1824
old_label, new_label = prefix.split(":")
1826
raise errors.BzrCommandError(
1827
'--prefix expects two values separated by a colon'
1828
' (eg "old/:new/")')
1830
if revision and len(revision) > 2:
1831
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1832
' one or two revision specifiers')
1834
old_tree, new_tree, specific_files, extra_trees = \
1835
_get_trees_to_diff(file_list, revision, old, new,
1837
return show_diff_trees(old_tree, new_tree, sys.stdout,
1838
specific_files=specific_files,
1839
external_diff_options=diff_options,
1840
old_label=old_label, new_label=new_label,
1841
extra_trees=extra_trees, using=using)
1844
class cmd_deleted(Command):
1845
"""List files deleted in the working tree.
1847
# TODO: Show files deleted since a previous revision, or
1848
# between two revisions.
1849
# TODO: Much more efficient way to do this: read in new
1850
# directories with readdir, rather than stating each one. Same
1851
# level of effort but possibly much less IO. (Or possibly not,
1852
# if the directories are very large...)
1853
_see_also = ['status', 'ls']
1854
takes_options = ['show-ids']
1857
def run(self, show_ids=False):
1858
tree = WorkingTree.open_containing(u'.')[0]
1861
old = tree.basis_tree()
1864
for path, ie in old.inventory.iter_entries():
1865
if not tree.has_id(ie.file_id):
1866
self.outf.write(path)
1868
self.outf.write(' ')
1869
self.outf.write(ie.file_id)
1870
self.outf.write('\n')
1877
class cmd_modified(Command):
1878
"""List files modified in working tree.
1882
_see_also = ['status', 'ls']
1885
help='Write an ascii NUL (\\0) separator '
1886
'between files rather than a newline.')
1890
def run(self, null=False):
1891
tree = WorkingTree.open_containing(u'.')[0]
1892
td = tree.changes_from(tree.basis_tree())
1893
for path, id, kind, text_modified, meta_modified in td.modified:
1895
self.outf.write(path + '\0')
1897
self.outf.write(osutils.quotefn(path) + '\n')
1900
class cmd_added(Command):
1901
"""List files added in working tree.
1905
_see_also = ['status', 'ls']
1908
help='Write an ascii NUL (\\0) separator '
1909
'between files rather than a newline.')
1913
def run(self, null=False):
1914
wt = WorkingTree.open_containing(u'.')[0]
1917
basis = wt.basis_tree()
1920
basis_inv = basis.inventory
1923
if file_id in basis_inv:
1925
if inv.is_root(file_id) and len(basis_inv) == 0:
1927
path = inv.id2path(file_id)
1928
if not os.access(osutils.abspath(path), os.F_OK):
1931
self.outf.write(path + '\0')
1933
self.outf.write(osutils.quotefn(path) + '\n')
1940
class cmd_root(Command):
1941
"""Show the tree root directory.
1943
The root is the nearest enclosing directory with a .bzr control
1946
takes_args = ['filename?']
1948
def run(self, filename=None):
1949
"""Print the branch root."""
1950
tree = WorkingTree.open_containing(filename)[0]
1951
self.outf.write(tree.basedir + '\n')
1954
def _parse_limit(limitstring):
1956
return int(limitstring)
1958
msg = "The limit argument must be an integer."
1959
raise errors.BzrCommandError(msg)
1962
def _parse_levels(s):
1966
msg = "The levels argument must be an integer."
1967
raise errors.BzrCommandError(msg)
1970
class cmd_log(Command):
1971
"""Show historical log for a branch or subset of a branch.
1973
log is bzr's default tool for exploring the history of a branch.
1974
The branch to use is taken from the first parameter. If no parameters
1975
are given, the branch containing the working directory is logged.
1976
Here are some simple examples::
1978
bzr log log the current branch
1979
bzr log foo.py log a file in its branch
1980
bzr log http://server/branch log a branch on a server
1982
The filtering, ordering and information shown for each revision can
1983
be controlled as explained below. By default, all revisions are
1984
shown sorted (topologically) so that newer revisions appear before
1985
older ones and descendants always appear before ancestors. If displayed,
1986
merged revisions are shown indented under the revision in which they
1991
The log format controls how information about each revision is
1992
displayed. The standard log formats are called ``long``, ``short``
1993
and ``line``. The default is long. See ``bzr help log-formats``
1994
for more details on log formats.
1996
The following options can be used to control what information is
1999
-l N display a maximum of N revisions
2000
-n N display N levels of revisions (0 for all, 1 for collapsed)
2001
-v display a status summary (delta) for each revision
2002
-p display a diff (patch) for each revision
2003
--show-ids display revision-ids (and file-ids), not just revnos
2005
Note that the default number of levels to display is a function of the
2006
log format. If the -n option is not used, the standard log formats show
2007
just the top level (mainline).
2009
Status summaries are shown using status flags like A, M, etc. To see
2010
the changes explained using words like ``added`` and ``modified``
2011
instead, use the -vv option.
2015
To display revisions from oldest to newest, use the --forward option.
2016
In most cases, using this option will have little impact on the total
2017
time taken to produce a log, though --forward does not incrementally
2018
display revisions like --reverse does when it can.
2020
:Revision filtering:
2022
The -r option can be used to specify what revision or range of revisions
2023
to filter against. The various forms are shown below::
2025
-rX display revision X
2026
-rX.. display revision X and later
2027
-r..Y display up to and including revision Y
2028
-rX..Y display from X to Y inclusive
2030
See ``bzr help revisionspec`` for details on how to specify X and Y.
2031
Some common examples are given below::
2033
-r-1 show just the tip
2034
-r-10.. show the last 10 mainline revisions
2035
-rsubmit:.. show what's new on this branch
2036
-rancestor:path.. show changes since the common ancestor of this
2037
branch and the one at location path
2038
-rdate:yesterday.. show changes since yesterday
2040
When logging a range of revisions using -rX..Y, log starts at
2041
revision Y and searches back in history through the primary
2042
("left-hand") parents until it finds X. When logging just the
2043
top level (using -n1), an error is reported if X is not found
2044
along the way. If multi-level logging is used (-n0), X may be
2045
a nested merge revision and the log will be truncated accordingly.
2049
If parameters are given and the first one is not a branch, the log
2050
will be filtered to show only those revisions that changed the
2051
nominated files or directories.
2053
Filenames are interpreted within their historical context. To log a
2054
deleted file, specify a revision range so that the file existed at
2055
the end or start of the range.
2057
Historical context is also important when interpreting pathnames of
2058
renamed files/directories. Consider the following example:
2060
* revision 1: add tutorial.txt
2061
* revision 2: modify tutorial.txt
2062
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2066
* ``bzr log guide.txt`` will log the file added in revision 1
2068
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2070
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2071
the original file in revision 2.
2073
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2074
was no file called guide.txt in revision 2.
2076
Renames are always followed by log. By design, there is no need to
2077
explicitly ask for this (and no way to stop logging a file back
2078
until it was last renamed).
2082
The --message option can be used for finding revisions that match a
2083
regular expression in a commit message.
2087
GUI tools and IDEs are often better at exploring history than command
2088
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2089
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2090
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2092
Web interfaces are often better at exploring history than command line
2093
tools, particularly for branches on servers. You may prefer Loggerhead
2094
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2096
You may find it useful to add the aliases below to ``bazaar.conf``::
2100
top = log -l10 --line
2103
``bzr tip`` will then show the latest revision while ``bzr top``
2104
will show the last 10 mainline revisions. To see the details of a
2105
particular revision X, ``bzr show -rX``.
2107
If you are interested in looking deeper into a particular merge X,
2108
use ``bzr log -n0 -rX``.
2110
``bzr log -v`` on a branch with lots of history is currently
2111
very slow. A fix for this issue is currently under development.
2112
With or without that fix, it is recommended that a revision range
2113
be given when using the -v option.
2115
bzr has a generic full-text matching plugin, bzr-search, that can be
2116
used to find revisions matching user names, commit messages, etc.
2117
Among other features, this plugin can find all revisions containing
2118
a list of words but not others.
2120
When exploring non-mainline history on large projects with deep
2121
history, the performance of log can be greatly improved by installing
2122
the historycache plugin. This plugin buffers historical information
2123
trading disk space for faster speed.
2125
takes_args = ['file*']
2126
_see_also = ['log-formats', 'revisionspec']
2129
help='Show from oldest to newest.'),
2131
custom_help('verbose',
2132
help='Show files changed in each revision.'),
2136
type=bzrlib.option._parse_revision_str,
2138
help='Show just the specified revision.'
2139
' See also "help revisionspec".'),
2143
help='Number of levels to display - 0 for all, 1 for flat.',
2145
type=_parse_levels),
2148
help='Show revisions whose message matches this '
2149
'regular expression.',
2153
help='Limit the output to the first N revisions.',
2158
help='Show changes made in each revision as a patch.'),
2159
Option('include-merges',
2160
help='Show merged revisions like --levels 0 does.'),
2162
encoding_type = 'replace'
2165
def run(self, file_list=None, timezone='original',
2176
include_merges=False):
2177
from bzrlib.log import (
2179
make_log_request_dict,
2180
_get_info_for_log_files,
2182
direction = (forward and 'forward') or 'reverse'
2187
raise errors.BzrCommandError(
2188
'--levels and --include-merges are mutually exclusive')
2190
if change is not None:
2192
raise errors.RangeInChangeOption()
2193
if revision is not None:
2194
raise errors.BzrCommandError(
2195
'--revision and --change are mutually exclusive')
2200
filter_by_dir = False
2202
# find the file ids to log and check for directory filtering
2203
b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2205
for relpath, file_id, kind in file_info_list:
2207
raise errors.BzrCommandError(
2208
"Path unknown at end or start of revision range: %s" %
2210
# If the relpath is the top of the tree, we log everything
2215
file_ids.append(file_id)
2216
filter_by_dir = filter_by_dir or (
2217
kind in ['directory', 'tree-reference'])
2220
# FIXME ? log the current subdir only RBC 20060203
2221
if revision is not None \
2222
and len(revision) > 0 and revision[0].get_branch():
2223
location = revision[0].get_branch()
2226
dir, relpath = bzrdir.BzrDir.open_containing(location)
2227
b = dir.open_branch()
2228
rev1, rev2 = _get_revision_range(revision, b, self.name())
2230
# Decide on the type of delta & diff filtering to use
2231
# TODO: add an --all-files option to make this configurable & consistent
2239
diff_type = 'partial'
2245
# Build the log formatter
2246
if log_format is None:
2247
log_format = log.log_formatter_registry.get_default(b)
2248
lf = log_format(show_ids=show_ids, to_file=self.outf,
2249
show_timezone=timezone,
2250
delta_format=get_verbosity_level(),
2252
show_advice=levels is None)
2254
# Choose the algorithm for doing the logging. It's annoying
2255
# having multiple code paths like this but necessary until
2256
# the underlying repository format is faster at generating
2257
# deltas or can provide everything we need from the indices.
2258
# The default algorithm - match-using-deltas - works for
2259
# multiple files and directories and is faster for small
2260
# amounts of history (200 revisions say). However, it's too
2261
# slow for logging a single file in a repository with deep
2262
# history, i.e. > 10K revisions. In the spirit of "do no
2263
# evil when adding features", we continue to use the
2264
# original algorithm - per-file-graph - for the "single
2265
# file that isn't a directory without showing a delta" case.
2266
partial_history = revision and b.repository._format.supports_chks
2267
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2268
or delta_type or partial_history)
2270
# Build the LogRequest and execute it
2271
if len(file_ids) == 0:
2273
rqst = make_log_request_dict(
2274
direction=direction, specific_fileids=file_ids,
2275
start_revision=rev1, end_revision=rev2, limit=limit,
2276
message_search=message, delta_type=delta_type,
2277
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2278
Logger(b, rqst).show(lf)
2283
def _get_revision_range(revisionspec_list, branch, command_name):
2284
"""Take the input of a revision option and turn it into a revision range.
2286
It returns RevisionInfo objects which can be used to obtain the rev_id's
2287
of the desired revisions. It does some user input validations.
2289
if revisionspec_list is None:
2292
elif len(revisionspec_list) == 1:
2293
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2294
elif len(revisionspec_list) == 2:
2295
start_spec = revisionspec_list[0]
2296
end_spec = revisionspec_list[1]
2297
if end_spec.get_branch() != start_spec.get_branch():
2298
# b is taken from revision[0].get_branch(), and
2299
# show_log will use its revision_history. Having
2300
# different branches will lead to weird behaviors.
2301
raise errors.BzrCommandError(
2302
"bzr %s doesn't accept two revisions in different"
2303
" branches." % command_name)
2304
rev1 = start_spec.in_history(branch)
2305
# Avoid loading all of history when we know a missing
2306
# end of range means the last revision ...
2307
if end_spec.spec is None:
2308
last_revno, last_revision_id = branch.last_revision_info()
2309
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2311
rev2 = end_spec.in_history(branch)
2313
raise errors.BzrCommandError(
2314
'bzr %s --revision takes one or two values.' % command_name)
2318
def _revision_range_to_revid_range(revision_range):
2321
if revision_range[0] is not None:
2322
rev_id1 = revision_range[0].rev_id
2323
if revision_range[1] is not None:
2324
rev_id2 = revision_range[1].rev_id
2325
return rev_id1, rev_id2
2327
def get_log_format(long=False, short=False, line=False, default='long'):
2328
log_format = default
2332
log_format = 'short'
2338
class cmd_touching_revisions(Command):
2339
"""Return revision-ids which affected a particular file.
2341
A more user-friendly interface is "bzr log FILE".
2345
takes_args = ["filename"]
2348
def run(self, filename):
2349
tree, relpath = WorkingTree.open_containing(filename)
2351
file_id = tree.path2id(relpath)
2352
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2353
self.outf.write("%6d %s\n" % (revno, what))
2356
class cmd_ls(Command):
2357
"""List files in a tree.
2360
_see_also = ['status', 'cat']
2361
takes_args = ['path?']
2365
Option('recursive', short_name='R',
2366
help='Recurse into subdirectories.'),
2368
help='Print paths relative to the root of the branch.'),
2369
Option('unknown', help='Print unknown files.'),
2370
Option('versioned', help='Print versioned files.',
2372
Option('ignored', help='Print ignored files.'),
2374
help='Write an ascii NUL (\\0) separator '
2375
'between files rather than a newline.'),
2377
help='List entries of a particular kind: file, directory, symlink.',
2382
def run(self, revision=None, verbose=False,
2383
recursive=False, from_root=False,
2384
unknown=False, versioned=False, ignored=False,
2385
null=False, kind=None, show_ids=False, path=None):
2387
if kind and kind not in ('file', 'directory', 'symlink'):
2388
raise errors.BzrCommandError('invalid kind specified')
2390
if verbose and null:
2391
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2392
all = not (unknown or versioned or ignored)
2394
selection = {'I':ignored, '?':unknown, 'V':versioned}
2400
raise errors.BzrCommandError('cannot specify both --from-root'
2403
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2406
# Calculate the prefix to use
2410
prefix = relpath + '/'
2411
elif fs_path != '.':
2412
prefix = fs_path + '/'
2414
if revision is not None or tree is None:
2415
tree = _get_one_revision_tree('ls', revision, branch=branch)
2418
if isinstance(tree, WorkingTree) and tree.supports_views():
2419
view_files = tree.views.lookup_view()
2422
view_str = views.view_display_str(view_files)
2423
note("Ignoring files outside view. View is %s" % view_str)
2427
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2428
from_dir=relpath, recursive=recursive):
2429
# Apply additional masking
2430
if not all and not selection[fc]:
2432
if kind is not None and fkind != kind:
2437
fullpath = osutils.pathjoin(relpath, fp)
2440
views.check_path_in_view(tree, fullpath)
2441
except errors.FileOutsideView:
2446
fp = osutils.pathjoin(prefix, fp)
2447
kindch = entry.kind_character()
2448
outstring = fp + kindch
2449
ui.ui_factory.clear_term()
2451
outstring = '%-8s %s' % (fc, outstring)
2452
if show_ids and fid is not None:
2453
outstring = "%-50s %s" % (outstring, fid)
2454
self.outf.write(outstring + '\n')
2456
self.outf.write(fp + '\0')
2459
self.outf.write(fid)
2460
self.outf.write('\0')
2468
self.outf.write('%-50s %s\n' % (outstring, my_id))
2470
self.outf.write(outstring + '\n')
2475
class cmd_unknowns(Command):
2476
"""List unknown files.
2484
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2485
self.outf.write(osutils.quotefn(f) + '\n')
2488
class cmd_ignore(Command):
2489
"""Ignore specified files or patterns.
2491
See ``bzr help patterns`` for details on the syntax of patterns.
2493
To remove patterns from the ignore list, edit the .bzrignore file.
2494
After adding, editing or deleting that file either indirectly by
2495
using this command or directly by using an editor, be sure to commit
2498
Note: ignore patterns containing shell wildcards must be quoted from
2502
Ignore the top level Makefile::
2504
bzr ignore ./Makefile
2506
Ignore class files in all directories::
2508
bzr ignore "*.class"
2510
Ignore .o files under the lib directory::
2512
bzr ignore "lib/**/*.o"
2514
Ignore .o files under the lib directory::
2516
bzr ignore "RE:lib/.*\.o"
2518
Ignore everything but the "debian" toplevel directory::
2520
bzr ignore "RE:(?!debian/).*"
2523
_see_also = ['status', 'ignored', 'patterns']
2524
takes_args = ['name_pattern*']
2526
Option('old-default-rules',
2527
help='Write out the ignore rules bzr < 0.9 always used.')
2530
def run(self, name_pattern_list=None, old_default_rules=None):
2531
from bzrlib import ignores
2532
if old_default_rules is not None:
2533
# dump the rules and exit
2534
for pattern in ignores.OLD_DEFAULTS:
2537
if not name_pattern_list:
2538
raise errors.BzrCommandError("ignore requires at least one "
2539
"NAME_PATTERN or --old-default-rules")
2540
name_pattern_list = [globbing.normalize_pattern(p)
2541
for p in name_pattern_list]
2542
for name_pattern in name_pattern_list:
2543
if (name_pattern[0] == '/' or
2544
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2545
raise errors.BzrCommandError(
2546
"NAME_PATTERN should not be an absolute path")
2547
tree, relpath = WorkingTree.open_containing(u'.')
2548
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2549
ignored = globbing.Globster(name_pattern_list)
2552
for entry in tree.list_files():
2556
if ignored.match(filename):
2557
matches.append(filename.encode('utf-8'))
2559
if len(matches) > 0:
2560
print "Warning: the following files are version controlled and" \
2561
" match your ignore pattern:\n%s" \
2562
"\nThese files will continue to be version controlled" \
2563
" unless you 'bzr remove' them." % ("\n".join(matches),)
2566
class cmd_ignored(Command):
2567
"""List ignored files and the patterns that matched them.
2569
List all the ignored files and the ignore pattern that caused the file to
2572
Alternatively, to list just the files::
2577
encoding_type = 'replace'
2578
_see_also = ['ignore', 'ls']
2582
tree = WorkingTree.open_containing(u'.')[0]
2585
for path, file_class, kind, file_id, entry in tree.list_files():
2586
if file_class != 'I':
2588
## XXX: Slightly inefficient since this was already calculated
2589
pat = tree.is_ignored(path)
2590
self.outf.write('%-50s %s\n' % (path, pat))
2595
class cmd_lookup_revision(Command):
2596
"""Lookup the revision-id from a revision-number
2599
bzr lookup-revision 33
2602
takes_args = ['revno']
2605
def run(self, revno):
2609
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2611
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2614
class cmd_export(Command):
2615
"""Export current or past revision to a destination directory or archive.
2617
If no revision is specified this exports the last committed revision.
2619
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2620
given, try to find the format with the extension. If no extension
2621
is found exports to a directory (equivalent to --format=dir).
2623
If root is supplied, it will be used as the root directory inside
2624
container formats (tar, zip, etc). If it is not supplied it will default
2625
to the exported filename. The root option has no effect for 'dir' format.
2627
If branch is omitted then the branch containing the current working
2628
directory will be used.
2630
Note: Export of tree with non-ASCII filenames to zip is not supported.
2632
================= =========================
2633
Supported formats Autodetected by extension
2634
================= =========================
2637
tbz2 .tar.bz2, .tbz2
2640
================= =========================
2642
takes_args = ['dest', 'branch_or_subdir?']
2645
help="Type of file to export to.",
2648
Option('filters', help='Apply content filters to export the '
2649
'convenient form.'),
2652
help="Name of the root directory inside the exported file."),
2654
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2655
root=None, filters=False):
2656
from bzrlib.export import export
2658
if branch_or_subdir is None:
2659
tree = WorkingTree.open_containing(u'.')[0]
2663
b, subdir = Branch.open_containing(branch_or_subdir)
2666
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2668
export(rev_tree, dest, format, root, subdir, filtered=filters)
2669
except errors.NoSuchExportFormat, e:
2670
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2673
class cmd_cat(Command):
2674
"""Write the contents of a file as of a given revision to standard output.
2676
If no revision is nominated, the last revision is used.
2678
Note: Take care to redirect standard output when using this command on a
2684
Option('name-from-revision', help='The path name in the old tree.'),
2685
Option('filters', help='Apply content filters to display the '
2686
'convenience form.'),
2689
takes_args = ['filename']
2690
encoding_type = 'exact'
2693
def run(self, filename, revision=None, name_from_revision=False,
2695
if revision is not None and len(revision) != 1:
2696
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2697
" one revision specifier")
2698
tree, branch, relpath = \
2699
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2702
return self._run(tree, branch, relpath, filename, revision,
2703
name_from_revision, filters)
2707
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2710
tree = b.basis_tree()
2711
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2713
old_file_id = rev_tree.path2id(relpath)
2715
if name_from_revision:
2716
# Try in revision if requested
2717
if old_file_id is None:
2718
raise errors.BzrCommandError(
2719
"%r is not present in revision %s" % (
2720
filename, rev_tree.get_revision_id()))
2722
content = rev_tree.get_file_text(old_file_id)
2724
cur_file_id = tree.path2id(relpath)
2726
if cur_file_id is not None:
2727
# Then try with the actual file id
2729
content = rev_tree.get_file_text(cur_file_id)
2731
except errors.NoSuchId:
2732
# The actual file id didn't exist at that time
2734
if not found and old_file_id is not None:
2735
# Finally try with the old file id
2736
content = rev_tree.get_file_text(old_file_id)
2739
# Can't be found anywhere
2740
raise errors.BzrCommandError(
2741
"%r is not present in revision %s" % (
2742
filename, rev_tree.get_revision_id()))
2744
from bzrlib.filters import (
2745
ContentFilterContext,
2746
filtered_output_bytes,
2748
filters = rev_tree._content_filter_stack(relpath)
2749
chunks = content.splitlines(True)
2750
content = filtered_output_bytes(chunks, filters,
2751
ContentFilterContext(relpath, rev_tree))
2752
self.outf.writelines(content)
2754
self.outf.write(content)
2757
class cmd_local_time_offset(Command):
2758
"""Show the offset in seconds from GMT to local time."""
2762
print osutils.local_time_offset()
2766
class cmd_commit(Command):
2767
"""Commit changes into a new revision.
2769
An explanatory message needs to be given for each commit. This is
2770
often done by using the --message option (getting the message from the
2771
command line) or by using the --file option (getting the message from
2772
a file). If neither of these options is given, an editor is opened for
2773
the user to enter the message. To see the changed files in the
2774
boilerplate text loaded into the editor, use the --show-diff option.
2776
By default, the entire tree is committed and the person doing the
2777
commit is assumed to be the author. These defaults can be overridden
2782
If selected files are specified, only changes to those files are
2783
committed. If a directory is specified then the directory and
2784
everything within it is committed.
2786
When excludes are given, they take precedence over selected files.
2787
For example, to commit only changes within foo, but not changes
2790
bzr commit foo -x foo/bar
2792
A selective commit after a merge is not yet supported.
2796
If the author of the change is not the same person as the committer,
2797
you can specify the author's name using the --author option. The
2798
name should be in the same format as a committer-id, e.g.
2799
"John Doe <jdoe@example.com>". If there is more than one author of
2800
the change you can specify the option multiple times, once for each
2805
A common mistake is to forget to add a new file or directory before
2806
running the commit command. The --strict option checks for unknown
2807
files and aborts the commit if any are found. More advanced pre-commit
2808
checks can be implemented by defining hooks. See ``bzr help hooks``
2813
If you accidentially commit the wrong changes or make a spelling
2814
mistake in the commit message say, you can use the uncommit command
2815
to undo it. See ``bzr help uncommit`` for details.
2817
Hooks can also be configured to run after a commit. This allows you
2818
to trigger updates to external systems like bug trackers. The --fixes
2819
option can be used to record the association between a revision and
2820
one or more bugs. See ``bzr help bugs`` for details.
2822
A selective commit may fail in some cases where the committed
2823
tree would be invalid. Consider::
2828
bzr commit foo -m "committing foo"
2829
bzr mv foo/bar foo/baz
2832
bzr commit foo/bar -m "committing bar but not baz"
2834
In the example above, the last commit will fail by design. This gives
2835
the user the opportunity to decide whether they want to commit the
2836
rename at the same time, separately first, or not at all. (As a general
2837
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2839
# TODO: Run hooks on tree to-be-committed, and after commit.
2841
# TODO: Strict commit that fails if there are deleted files.
2842
# (what does "deleted files" mean ??)
2844
# TODO: Give better message for -s, --summary, used by tla people
2846
# XXX: verbose currently does nothing
2848
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2849
takes_args = ['selected*']
2851
ListOption('exclude', type=str, short_name='x',
2852
help="Do not consider changes made to a given path."),
2853
Option('message', type=unicode,
2855
help="Description of the new revision."),
2858
help='Commit even if nothing has changed.'),
2859
Option('file', type=str,
2862
help='Take commit message from this file.'),
2864
help="Refuse to commit if there are unknown "
2865
"files in the working tree."),
2866
ListOption('fixes', type=str,
2867
help="Mark a bug as being fixed by this revision "
2868
"(see \"bzr help bugs\")."),
2869
ListOption('author', type=unicode,
2870
help="Set the author's name, if it's different "
2871
"from the committer."),
2873
help="Perform a local commit in a bound "
2874
"branch. Local commits are not pushed to "
2875
"the master branch until a normal commit "
2879
help='When no message is supplied, show the diff along'
2880
' with the status summary in the message editor.'),
2882
aliases = ['ci', 'checkin']
2884
def _iter_bug_fix_urls(self, fixes, branch):
2885
# Configure the properties for bug fixing attributes.
2886
for fixed_bug in fixes:
2887
tokens = fixed_bug.split(':')
2888
if len(tokens) != 2:
2889
raise errors.BzrCommandError(
2890
"Invalid bug %s. Must be in the form of 'tracker:id'. "
2891
"See \"bzr help bugs\" for more information on this "
2892
"feature.\nCommit refused." % fixed_bug)
2893
tag, bug_id = tokens
2895
yield bugtracker.get_bug_url(tag, branch, bug_id)
2896
except errors.UnknownBugTrackerAbbreviation:
2897
raise errors.BzrCommandError(
2898
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2899
except errors.MalformedBugIdentifier, e:
2900
raise errors.BzrCommandError(
2901
"%s\nCommit refused." % (str(e),))
2903
def run(self, message=None, file=None, verbose=False, selected_list=None,
2904
unchanged=False, strict=False, local=False, fixes=None,
2905
author=None, show_diff=False, exclude=None):
2906
from bzrlib.errors import (
2911
from bzrlib.msgeditor import (
2912
edit_commit_message_encoded,
2913
generate_commit_message_template,
2914
make_commit_message_template_encoded
2917
# TODO: Need a blackbox test for invoking the external editor; may be
2918
# slightly problematic to run this cross-platform.
2920
# TODO: do more checks that the commit will succeed before
2921
# spending the user's valuable time typing a commit message.
2925
tree, selected_list = tree_files(selected_list)
2926
if selected_list == ['']:
2927
# workaround - commit of root of tree should be exactly the same
2928
# as just default commit in that tree, and succeed even though
2929
# selected-file merge commit is not done yet
2934
bug_property = bugtracker.encode_fixes_bug_urls(
2935
self._iter_bug_fix_urls(fixes, tree.branch))
2937
properties['bugs'] = bug_property
2939
if local and not tree.branch.get_bound_location():
2940
raise errors.LocalRequiresBoundBranch()
2942
def get_message(commit_obj):
2943
"""Callback to get commit message"""
2944
my_message = message
2945
if my_message is None and not file:
2946
t = make_commit_message_template_encoded(tree,
2947
selected_list, diff=show_diff,
2948
output_encoding=osutils.get_user_encoding())
2949
start_message = generate_commit_message_template(commit_obj)
2950
my_message = edit_commit_message_encoded(t,
2951
start_message=start_message)
2952
if my_message is None:
2953
raise errors.BzrCommandError("please specify a commit"
2954
" message with either --message or --file")
2955
elif my_message and file:
2956
raise errors.BzrCommandError(
2957
"please specify either --message or --file")
2959
my_message = codecs.open(file, 'rt',
2960
osutils.get_user_encoding()).read()
2961
if my_message == "":
2962
raise errors.BzrCommandError("empty commit message specified")
2966
tree.commit(message_callback=get_message,
2967
specific_files=selected_list,
2968
allow_pointless=unchanged, strict=strict, local=local,
2969
reporter=None, verbose=verbose, revprops=properties,
2971
exclude=safe_relpath_files(tree, exclude))
2972
except PointlessCommit:
2973
# FIXME: This should really happen before the file is read in;
2974
# perhaps prepare the commit; get the message; then actually commit
2975
raise errors.BzrCommandError("No changes to commit."
2976
" Use --unchanged to commit anyhow.")
2977
except ConflictsInTree:
2978
raise errors.BzrCommandError('Conflicts detected in working '
2979
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2981
except StrictCommitFailed:
2982
raise errors.BzrCommandError("Commit refused because there are"
2983
" unknown files in the working tree.")
2984
except errors.BoundBranchOutOfDate, e:
2985
raise errors.BzrCommandError(str(e) + "\n"
2986
'To commit to master branch, run update and then commit.\n'
2987
'You can also pass --local to commit to continue working '
2991
class cmd_check(Command):
2992
"""Validate working tree structure, branch consistency and repository history.
2994
This command checks various invariants about branch and repository storage
2995
to detect data corruption or bzr bugs.
2997
The working tree and branch checks will only give output if a problem is
2998
detected. The output fields of the repository check are:
3000
revisions: This is just the number of revisions checked. It doesn't
3002
versionedfiles: This is just the number of versionedfiles checked. It
3003
doesn't indicate a problem.
3004
unreferenced ancestors: Texts that are ancestors of other texts, but
3005
are not properly referenced by the revision ancestry. This is a
3006
subtle problem that Bazaar can work around.
3007
unique file texts: This is the total number of unique file contents
3008
seen in the checked revisions. It does not indicate a problem.
3009
repeated file texts: This is the total number of repeated texts seen
3010
in the checked revisions. Texts can be repeated when their file
3011
entries are modified, but the file contents are not. It does not
3014
If no restrictions are specified, all Bazaar data that is found at the given
3015
location will be checked.
3019
Check the tree and branch at 'foo'::
3021
bzr check --tree --branch foo
3023
Check only the repository at 'bar'::
3025
bzr check --repo bar
3027
Check everything at 'baz'::
3032
_see_also = ['reconcile']
3033
takes_args = ['path?']
3034
takes_options = ['verbose',
3035
Option('branch', help="Check the branch related to the"
3036
" current directory."),
3037
Option('repo', help="Check the repository related to the"
3038
" current directory."),
3039
Option('tree', help="Check the working tree related to"
3040
" the current directory.")]
3042
def run(self, path=None, verbose=False, branch=False, repo=False,
3044
from bzrlib.check import check_dwim
3047
if not branch and not repo and not tree:
3048
branch = repo = tree = True
3049
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3052
class cmd_upgrade(Command):
3053
"""Upgrade branch storage to current format.
3055
The check command or bzr developers may sometimes advise you to run
3056
this command. When the default format has changed you may also be warned
3057
during other operations to upgrade.
3060
_see_also = ['check']
3061
takes_args = ['url?']
3063
RegistryOption('format',
3064
help='Upgrade to a specific format. See "bzr help'
3065
' formats" for details.',
3066
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3067
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3068
value_switches=True, title='Branch format'),
3071
def run(self, url='.', format=None):
3072
from bzrlib.upgrade import upgrade
3073
upgrade(url, format)
3076
class cmd_whoami(Command):
3077
"""Show or set bzr user id.
3080
Show the email of the current user::
3084
Set the current user::
3086
bzr whoami "Frank Chu <fchu@example.com>"
3088
takes_options = [ Option('email',
3089
help='Display email address only.'),
3091
help='Set identity for the current branch instead of '
3094
takes_args = ['name?']
3095
encoding_type = 'replace'
3098
def run(self, email=False, branch=False, name=None):
3100
# use branch if we're inside one; otherwise global config
3102
c = Branch.open_containing('.')[0].get_config()
3103
except errors.NotBranchError:
3104
c = config.GlobalConfig()
3106
self.outf.write(c.user_email() + '\n')
3108
self.outf.write(c.username() + '\n')
3111
# display a warning if an email address isn't included in the given name.
3113
config.extract_email_address(name)
3114
except errors.NoEmailInUsername, e:
3115
warning('"%s" does not seem to contain an email address. '
3116
'This is allowed, but not recommended.', name)
3118
# use global config unless --branch given
3120
c = Branch.open_containing('.')[0].get_config()
3122
c = config.GlobalConfig()
3123
c.set_user_option('email', name)
3126
class cmd_nick(Command):
3127
"""Print or set the branch nickname.
3129
If unset, the tree root directory name is used as the nickname.
3130
To print the current nickname, execute with no argument.
3132
Bound branches use the nickname of its master branch unless it is set
3136
_see_also = ['info']
3137
takes_args = ['nickname?']
3138
def run(self, nickname=None):
3139
branch = Branch.open_containing(u'.')[0]
3140
if nickname is None:
3141
self.printme(branch)
3143
branch.nick = nickname
3146
def printme(self, branch):
3150
class cmd_alias(Command):
3151
"""Set/unset and display aliases.
3154
Show the current aliases::
3158
Show the alias specified for 'll'::
3162
Set an alias for 'll'::
3164
bzr alias ll="log --line -r-10..-1"
3166
To remove an alias for 'll'::
3168
bzr alias --remove ll
3171
takes_args = ['name?']
3173
Option('remove', help='Remove the alias.'),
3176
def run(self, name=None, remove=False):
3178
self.remove_alias(name)
3180
self.print_aliases()
3182
equal_pos = name.find('=')
3184
self.print_alias(name)
3186
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3188
def remove_alias(self, alias_name):
3189
if alias_name is None:
3190
raise errors.BzrCommandError(
3191
'bzr alias --remove expects an alias to remove.')
3192
# If alias is not found, print something like:
3193
# unalias: foo: not found
3194
c = config.GlobalConfig()
3195
c.unset_alias(alias_name)
3198
def print_aliases(self):
3199
"""Print out the defined aliases in a similar format to bash."""
3200
aliases = config.GlobalConfig().get_aliases()
3201
for key, value in sorted(aliases.iteritems()):
3202
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3205
def print_alias(self, alias_name):
3206
from bzrlib.commands import get_alias
3207
alias = get_alias(alias_name)
3209
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3212
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3214
def set_alias(self, alias_name, alias_command):
3215
"""Save the alias in the global config."""
3216
c = config.GlobalConfig()
3217
c.set_alias(alias_name, alias_command)
3220
class cmd_selftest(Command):
3221
"""Run internal test suite.
3223
If arguments are given, they are regular expressions that say which tests
3224
should run. Tests matching any expression are run, and other tests are
3227
Alternatively if --first is given, matching tests are run first and then
3228
all other tests are run. This is useful if you have been working in a
3229
particular area, but want to make sure nothing else was broken.
3231
If --exclude is given, tests that match that regular expression are
3232
excluded, regardless of whether they match --first or not.
3234
To help catch accidential dependencies between tests, the --randomize
3235
option is useful. In most cases, the argument used is the word 'now'.
3236
Note that the seed used for the random number generator is displayed
3237
when this option is used. The seed can be explicitly passed as the
3238
argument to this option if required. This enables reproduction of the
3239
actual ordering used if and when an order sensitive problem is encountered.
3241
If --list-only is given, the tests that would be run are listed. This is
3242
useful when combined with --first, --exclude and/or --randomize to
3243
understand their impact. The test harness reports "Listed nn tests in ..."
3244
instead of "Ran nn tests in ..." when list mode is enabled.
3246
If the global option '--no-plugins' is given, plugins are not loaded
3247
before running the selftests. This has two effects: features provided or
3248
modified by plugins will not be tested, and tests provided by plugins will
3251
Tests that need working space on disk use a common temporary directory,
3252
typically inside $TMPDIR or /tmp.
3255
Run only tests relating to 'ignore'::
3259
Disable plugins and list tests as they're run::
3261
bzr --no-plugins selftest -v
3263
# NB: this is used from the class without creating an instance, which is
3264
# why it does not have a self parameter.
3265
def get_transport_type(typestring):
3266
"""Parse and return a transport specifier."""
3267
if typestring == "sftp":
3268
from bzrlib.transport.sftp import SFTPAbsoluteServer
3269
return SFTPAbsoluteServer
3270
if typestring == "memory":
3271
from bzrlib.transport.memory import MemoryServer
3273
if typestring == "fakenfs":
3274
from bzrlib.transport.fakenfs import FakeNFSServer
3275
return FakeNFSServer
3276
msg = "No known transport type %s. Supported types are: sftp\n" %\
3278
raise errors.BzrCommandError(msg)
3281
takes_args = ['testspecs*']
3282
takes_options = ['verbose',
3284
help='Stop when one test fails.',
3288
help='Use a different transport by default '
3289
'throughout the test suite.',
3290
type=get_transport_type),
3292
help='Run the benchmarks rather than selftests.'),
3293
Option('lsprof-timed',
3294
help='Generate lsprof output for benchmarked'
3295
' sections of code.'),
3296
Option('cache-dir', type=str,
3297
help='Cache intermediate benchmark output in this '
3300
help='Run all tests, but run specified tests first.',
3304
help='List the tests instead of running them.'),
3305
RegistryOption('parallel',
3306
help="Run the test suite in parallel.",
3307
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3308
value_switches=False,
3310
Option('randomize', type=str, argname="SEED",
3311
help='Randomize the order of tests using the given'
3312
' seed or "now" for the current time.'),
3313
Option('exclude', type=str, argname="PATTERN",
3315
help='Exclude tests that match this regular'
3318
help='Output test progress via subunit.'),
3319
Option('strict', help='Fail on missing dependencies or '
3321
Option('load-list', type=str, argname='TESTLISTFILE',
3322
help='Load a test id list from a text file.'),
3323
ListOption('debugflag', type=str, short_name='E',
3324
help='Turn on a selftest debug flag.'),
3325
ListOption('starting-with', type=str, argname='TESTID',
3326
param_name='starting_with', short_name='s',
3328
'Load only the tests starting with TESTID.'),
3330
encoding_type = 'replace'
3333
Command.__init__(self)
3334
self.additional_selftest_args = {}
3336
def run(self, testspecs_list=None, verbose=False, one=False,
3337
transport=None, benchmark=None,
3338
lsprof_timed=None, cache_dir=None,
3339
first=False, list_only=False,
3340
randomize=None, exclude=None, strict=False,
3341
load_list=None, debugflag=None, starting_with=None, subunit=False,
3343
from bzrlib.tests import selftest
3344
import bzrlib.benchmarks as benchmarks
3345
from bzrlib.benchmarks import tree_creator
3347
# Make deprecation warnings visible, unless -Werror is set
3348
symbol_versioning.activate_deprecation_warnings(override=False)
3350
if cache_dir is not None:
3351
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3352
if testspecs_list is not None:
3353
pattern = '|'.join(testspecs_list)
3358
from bzrlib.tests import SubUnitBzrRunner
3360
raise errors.BzrCommandError("subunit not available. subunit "
3361
"needs to be installed to use --subunit.")
3362
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3364
self.additional_selftest_args.setdefault(
3365
'suite_decorators', []).append(parallel)
3367
test_suite_factory = benchmarks.test_suite
3368
# Unless user explicitly asks for quiet, be verbose in benchmarks
3369
verbose = not is_quiet()
3370
# TODO: should possibly lock the history file...
3371
benchfile = open(".perf_history", "at", buffering=1)
3373
test_suite_factory = None
3376
selftest_kwargs = {"verbose": verbose,
3378
"stop_on_failure": one,
3379
"transport": transport,
3380
"test_suite_factory": test_suite_factory,
3381
"lsprof_timed": lsprof_timed,
3382
"bench_history": benchfile,
3383
"matching_tests_first": first,
3384
"list_only": list_only,
3385
"random_seed": randomize,
3386
"exclude_pattern": exclude,
3388
"load_list": load_list,
3389
"debug_flags": debugflag,
3390
"starting_with": starting_with
3392
selftest_kwargs.update(self.additional_selftest_args)
3393
result = selftest(**selftest_kwargs)
3395
if benchfile is not None:
3397
return int(not result)
3400
class cmd_version(Command):
3401
"""Show version of bzr."""
3403
encoding_type = 'replace'
3405
Option("short", help="Print just the version number."),
3409
def run(self, short=False):
3410
from bzrlib.version import show_version
3412
self.outf.write(bzrlib.version_string + '\n')
3414
show_version(to_file=self.outf)
3417
class cmd_rocks(Command):
3418
"""Statement of optimism."""
3424
print "It sure does!"
3427
class cmd_find_merge_base(Command):
3428
"""Find and print a base revision for merging two branches."""
3429
# TODO: Options to specify revisions on either side, as if
3430
# merging only part of the history.
3431
takes_args = ['branch', 'other']
3435
def run(self, branch, other):
3436
from bzrlib.revision import ensure_null
3438
branch1 = Branch.open_containing(branch)[0]
3439
branch2 = Branch.open_containing(other)[0]
3444
last1 = ensure_null(branch1.last_revision())
3445
last2 = ensure_null(branch2.last_revision())
3447
graph = branch1.repository.get_graph(branch2.repository)
3448
base_rev_id = graph.find_unique_lca(last1, last2)
3450
print 'merge base is revision %s' % base_rev_id
3457
class cmd_merge(Command):
3458
"""Perform a three-way merge.
3460
The source of the merge can be specified either in the form of a branch,
3461
or in the form of a path to a file containing a merge directive generated
3462
with bzr send. If neither is specified, the default is the upstream branch
3463
or the branch most recently merged using --remember.
3465
When merging a branch, by default the tip will be merged. To pick a different
3466
revision, pass --revision. If you specify two values, the first will be used as
3467
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3468
available revisions, like this is commonly referred to as "cherrypicking".
3470
Revision numbers are always relative to the branch being merged.
3472
By default, bzr will try to merge in all new work from the other
3473
branch, automatically determining an appropriate base. If this
3474
fails, you may need to give an explicit base.
3476
Merge will do its best to combine the changes in two branches, but there
3477
are some kinds of problems only a human can fix. When it encounters those,
3478
it will mark a conflict. A conflict means that you need to fix something,
3479
before you should commit.
3481
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3483
If there is no default branch set, the first merge will set it. After
3484
that, you can omit the branch to use the default. To change the
3485
default, use --remember. The value will only be saved if the remote
3486
location can be accessed.
3488
The results of the merge are placed into the destination working
3489
directory, where they can be reviewed (with bzr diff), tested, and then
3490
committed to record the result of the merge.
3492
merge refuses to run if there are any uncommitted changes, unless
3496
To merge the latest revision from bzr.dev::
3498
bzr merge ../bzr.dev
3500
To merge changes up to and including revision 82 from bzr.dev::
3502
bzr merge -r 82 ../bzr.dev
3504
To merge the changes introduced by 82, without previous changes::
3506
bzr merge -r 81..82 ../bzr.dev
3508
To apply a merge directive contained in /tmp/merge:
3510
bzr merge /tmp/merge
3513
encoding_type = 'exact'
3514
_see_also = ['update', 'remerge', 'status-flags', 'send']
3515
takes_args = ['location?']
3520
help='Merge even if the destination tree has uncommitted changes.'),
3524
Option('show-base', help="Show base revision text in "
3526
Option('uncommitted', help='Apply uncommitted changes'
3527
' from a working copy, instead of branch changes.'),
3528
Option('pull', help='If the destination is already'
3529
' completely merged into the source, pull from the'
3530
' source rather than merging. When this happens,'
3531
' you do not need to commit the result.'),
3533
help='Branch to merge into, '
3534
'rather than the one containing the working directory.',
3538
Option('preview', help='Instead of merging, show a diff of the merge.')
3541
def run(self, location=None, revision=None, force=False,
3542
merge_type=None, show_base=False, reprocess=None, remember=False,
3543
uncommitted=False, pull=False,
3547
if merge_type is None:
3548
merge_type = _mod_merge.Merge3Merger
3550
if directory is None: directory = u'.'
3551
possible_transports = []
3553
allow_pending = True
3554
verified = 'inapplicable'
3555
tree = WorkingTree.open_containing(directory)[0]
3557
# die as quickly as possible if there are uncommitted changes
3559
basis_tree = tree.revision_tree(tree.last_revision())
3560
except errors.NoSuchRevision:
3561
basis_tree = tree.basis_tree()
3563
changes = tree.changes_from(basis_tree)
3564
if changes.has_changed():
3565
raise errors.UncommittedChanges(tree)
3567
view_info = _get_view_info_for_change_reporter(tree)
3568
change_reporter = delta._ChangeReporter(
3569
unversioned_filter=tree.is_ignored, view_info=view_info)
3572
pb = ui.ui_factory.nested_progress_bar()
3573
cleanups.append(pb.finished)
3575
cleanups.append(tree.unlock)
3576
if location is not None:
3578
mergeable = bundle.read_mergeable_from_url(location,
3579
possible_transports=possible_transports)
3580
except errors.NotABundle:
3584
raise errors.BzrCommandError('Cannot use --uncommitted'
3585
' with bundles or merge directives.')
3587
if revision is not None:
3588
raise errors.BzrCommandError(
3589
'Cannot use -r with merge directives or bundles')
3590
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3593
if merger is None and uncommitted:
3594
if revision is not None and len(revision) > 0:
3595
raise errors.BzrCommandError('Cannot use --uncommitted and'
3596
' --revision at the same time.')
3597
location = self._select_branch_location(tree, location)[0]
3598
other_tree, other_path = WorkingTree.open_containing(location)
3599
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
3601
allow_pending = False
3602
if other_path != '':
3603
merger.interesting_files = [other_path]
3606
merger, allow_pending = self._get_merger_from_branch(tree,
3607
location, revision, remember, possible_transports, pb)
3609
merger.merge_type = merge_type
3610
merger.reprocess = reprocess
3611
merger.show_base = show_base
3612
self.sanity_check_merger(merger)
3613
if (merger.base_rev_id == merger.other_rev_id and
3614
merger.other_rev_id is not None):
3615
note('Nothing to do.')
3618
if merger.interesting_files is not None:
3619
raise errors.BzrCommandError('Cannot pull individual files')
3620
if (merger.base_rev_id == tree.last_revision()):
3621
result = tree.pull(merger.other_branch, False,
3622
merger.other_rev_id)
3623
result.report(self.outf)
3625
merger.check_basis(False)
3627
return self._do_preview(merger)
3629
return self._do_merge(merger, change_reporter, allow_pending,
3632
for cleanup in reversed(cleanups):
3635
def _do_preview(self, merger):
3636
from bzrlib.diff import show_diff_trees
3637
tree_merger = merger.make_merger()
3638
tt = tree_merger.make_preview_transform()
3640
result_tree = tt.get_preview_tree()
3641
show_diff_trees(merger.this_tree, result_tree, self.outf,
3642
old_label='', new_label='')
3646
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3647
merger.change_reporter = change_reporter
3648
conflict_count = merger.do_merge()
3650
merger.set_pending()
3651
if verified == 'failed':
3652
warning('Preview patch does not match changes')
3653
if conflict_count != 0:
3658
def sanity_check_merger(self, merger):
3659
if (merger.show_base and
3660
not merger.merge_type is _mod_merge.Merge3Merger):
3661
raise errors.BzrCommandError("Show-base is not supported for this"
3662
" merge type. %s" % merger.merge_type)
3663
if merger.reprocess is None:
3664
if merger.show_base:
3665
merger.reprocess = False
3667
# Use reprocess if the merger supports it
3668
merger.reprocess = merger.merge_type.supports_reprocess
3669
if merger.reprocess and not merger.merge_type.supports_reprocess:
3670
raise errors.BzrCommandError("Conflict reduction is not supported"
3671
" for merge type %s." %
3673
if merger.reprocess and merger.show_base:
3674
raise errors.BzrCommandError("Cannot do conflict reduction and"
3677
def _get_merger_from_branch(self, tree, location, revision, remember,
3678
possible_transports, pb):
3679
"""Produce a merger from a location, assuming it refers to a branch."""
3680
from bzrlib.tag import _merge_tags_if_possible
3681
# find the branch locations
3682
other_loc, user_location = self._select_branch_location(tree, location,
3684
if revision is not None and len(revision) == 2:
3685
base_loc, _unused = self._select_branch_location(tree,
3686
location, revision, 0)
3688
base_loc = other_loc
3690
other_branch, other_path = Branch.open_containing(other_loc,
3691
possible_transports)
3692
if base_loc == other_loc:
3693
base_branch = other_branch
3695
base_branch, base_path = Branch.open_containing(base_loc,
3696
possible_transports)
3697
# Find the revision ids
3698
if revision is None or len(revision) < 1 or revision[-1] is None:
3699
other_revision_id = _mod_revision.ensure_null(
3700
other_branch.last_revision())
3702
other_revision_id = revision[-1].as_revision_id(other_branch)
3703
if (revision is not None and len(revision) == 2
3704
and revision[0] is not None):
3705
base_revision_id = revision[0].as_revision_id(base_branch)
3707
base_revision_id = None
3708
# Remember where we merge from
3709
if ((remember or tree.branch.get_submit_branch() is None) and
3710
user_location is not None):
3711
tree.branch.set_submit_branch(other_branch.base)
3712
_merge_tags_if_possible(other_branch, tree.branch)
3713
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3714
other_revision_id, base_revision_id, other_branch, base_branch)
3715
if other_path != '':
3716
allow_pending = False
3717
merger.interesting_files = [other_path]
3719
allow_pending = True
3720
return merger, allow_pending
3722
def _select_branch_location(self, tree, user_location, revision=None,
3724
"""Select a branch location, according to possible inputs.
3726
If provided, branches from ``revision`` are preferred. (Both
3727
``revision`` and ``index`` must be supplied.)
3729
Otherwise, the ``location`` parameter is used. If it is None, then the
3730
``submit`` or ``parent`` location is used, and a note is printed.
3732
:param tree: The working tree to select a branch for merging into
3733
:param location: The location entered by the user
3734
:param revision: The revision parameter to the command
3735
:param index: The index to use for the revision parameter. Negative
3736
indices are permitted.
3737
:return: (selected_location, user_location). The default location
3738
will be the user-entered location.
3740
if (revision is not None and index is not None
3741
and revision[index] is not None):
3742
branch = revision[index].get_branch()
3743
if branch is not None:
3744
return branch, branch
3745
if user_location is None:
3746
location = self._get_remembered(tree, 'Merging from')
3748
location = user_location
3749
return location, user_location
3751
def _get_remembered(self, tree, verb_string):
3752
"""Use tree.branch's parent if none was supplied.
3754
Report if the remembered location was used.
3756
stored_location = tree.branch.get_submit_branch()
3757
stored_location_type = "submit"
3758
if stored_location is None:
3759
stored_location = tree.branch.get_parent()
3760
stored_location_type = "parent"
3761
mutter("%s", stored_location)
3762
if stored_location is None:
3763
raise errors.BzrCommandError("No location specified or remembered")
3764
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3765
note(u"%s remembered %s location %s", verb_string,
3766
stored_location_type, display_url)
3767
return stored_location
3770
class cmd_remerge(Command):
3773
Use this if you want to try a different merge technique while resolving
3774
conflicts. Some merge techniques are better than others, and remerge
3775
lets you try different ones on different files.
3777
The options for remerge have the same meaning and defaults as the ones for
3778
merge. The difference is that remerge can (only) be run when there is a
3779
pending merge, and it lets you specify particular files.
3782
Re-do the merge of all conflicted files, and show the base text in
3783
conflict regions, in addition to the usual THIS and OTHER texts::
3785
bzr remerge --show-base
3787
Re-do the merge of "foobar", using the weave merge algorithm, with
3788
additional processing to reduce the size of conflict regions::
3790
bzr remerge --merge-type weave --reprocess foobar
3792
takes_args = ['file*']
3797
help="Show base revision text in conflicts."),
3800
def run(self, file_list=None, merge_type=None, show_base=False,
3802
if merge_type is None:
3803
merge_type = _mod_merge.Merge3Merger
3804
tree, file_list = tree_files(file_list)
3807
parents = tree.get_parent_ids()
3808
if len(parents) != 2:
3809
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3810
" merges. Not cherrypicking or"
3812
repository = tree.branch.repository
3813
interesting_ids = None
3815
conflicts = tree.conflicts()
3816
if file_list is not None:
3817
interesting_ids = set()
3818
for filename in file_list:
3819
file_id = tree.path2id(filename)
3821
raise errors.NotVersionedError(filename)
3822
interesting_ids.add(file_id)
3823
if tree.kind(file_id) != "directory":
3826
for name, ie in tree.inventory.iter_entries(file_id):
3827
interesting_ids.add(ie.file_id)
3828
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3830
# Remerge only supports resolving contents conflicts
3831
allowed_conflicts = ('text conflict', 'contents conflict')
3832
restore_files = [c.path for c in conflicts
3833
if c.typestring in allowed_conflicts]
3834
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3835
tree.set_conflicts(ConflictList(new_conflicts))
3836
if file_list is not None:
3837
restore_files = file_list
3838
for filename in restore_files:
3840
restore(tree.abspath(filename))
3841
except errors.NotConflicted:
3843
# Disable pending merges, because the file texts we are remerging
3844
# have not had those merges performed. If we use the wrong parents
3845
# list, we imply that the working tree text has seen and rejected
3846
# all the changes from the other tree, when in fact those changes
3847
# have not yet been seen.
3848
pb = ui.ui_factory.nested_progress_bar()
3849
tree.set_parent_ids(parents[:1])
3851
merger = _mod_merge.Merger.from_revision_ids(pb,
3853
merger.interesting_ids = interesting_ids
3854
merger.merge_type = merge_type
3855
merger.show_base = show_base
3856
merger.reprocess = reprocess
3857
conflicts = merger.do_merge()
3859
tree.set_parent_ids(parents)
3869
class cmd_revert(Command):
3870
"""Revert files to a previous revision.
3872
Giving a list of files will revert only those files. Otherwise, all files
3873
will be reverted. If the revision is not specified with '--revision', the
3874
last committed revision is used.
3876
To remove only some changes, without reverting to a prior version, use
3877
merge instead. For example, "merge . --revision -2..-3" will remove the
3878
changes introduced by -2, without affecting the changes introduced by -1.
3879
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3881
By default, any files that have been manually changed will be backed up
3882
first. (Files changed only by merge are not backed up.) Backup files have
3883
'.~#~' appended to their name, where # is a number.
3885
When you provide files, you can use their current pathname or the pathname
3886
from the target revision. So you can use revert to "undelete" a file by
3887
name. If you name a directory, all the contents of that directory will be
3890
Any files that have been newly added since that revision will be deleted,
3891
with a backup kept if appropriate. Directories containing unknown files
3892
will not be deleted.
3894
The working tree contains a list of pending merged revisions, which will
3895
be included as parents in the next commit. Normally, revert clears that
3896
list as well as reverting the files. If any files are specified, revert
3897
leaves the pending merge list alone and reverts only the files. Use "bzr
3898
revert ." in the tree root to revert all files but keep the merge record,
3899
and "bzr revert --forget-merges" to clear the pending merge list without
3900
reverting any files.
3903
_see_also = ['cat', 'export']
3906
Option('no-backup', "Do not save backups of reverted files."),
3907
Option('forget-merges',
3908
'Remove pending merge marker, without changing any files.'),
3910
takes_args = ['file*']
3912
def run(self, revision=None, no_backup=False, file_list=None,
3913
forget_merges=None):
3914
tree, file_list = tree_files(file_list)
3918
tree.set_parent_ids(tree.get_parent_ids()[:1])
3920
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3925
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3926
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3927
pb = ui.ui_factory.nested_progress_bar()
3929
tree.revert(file_list, rev_tree, not no_backup, pb,
3930
report_changes=True)
3935
class cmd_assert_fail(Command):
3936
"""Test reporting of assertion failures"""
3937
# intended just for use in testing
3942
raise AssertionError("always fails")
3945
class cmd_help(Command):
3946
"""Show help on a command or other topic.
3949
_see_also = ['topics']
3951
Option('long', 'Show help on all commands.'),
3953
takes_args = ['topic?']
3954
aliases = ['?', '--help', '-?', '-h']
3957
def run(self, topic=None, long=False):
3959
if topic is None and long:
3961
bzrlib.help.help(topic)
3964
class cmd_shell_complete(Command):
3965
"""Show appropriate completions for context.
3967
For a list of all available commands, say 'bzr shell-complete'.
3969
takes_args = ['context?']
3974
def run(self, context=None):
3975
import shellcomplete
3976
shellcomplete.shellcomplete(context)
3979
class cmd_missing(Command):
3980
"""Show unmerged/unpulled revisions between two branches.
3982
OTHER_BRANCH may be local or remote.
3984
To filter on a range of revisions, you can use the command -r begin..end
3985
-r revision requests a specific revision, -r ..end or -r begin.. are
3990
Determine the missing revisions between this and the branch at the
3991
remembered pull location::
3995
Determine the missing revisions between this and another branch::
3997
bzr missing http://server/branch
3999
Determine the missing revisions up to a specific revision on the other
4002
bzr missing -r ..-10
4004
Determine the missing revisions up to a specific revision on this
4007
bzr missing --my-revision ..-10
4010
_see_also = ['merge', 'pull']
4011
takes_args = ['other_branch?']
4013
Option('reverse', 'Reverse the order of revisions.'),
4015
'Display changes in the local branch only.'),
4016
Option('this' , 'Same as --mine-only.'),
4017
Option('theirs-only',
4018
'Display changes in the remote branch only.'),
4019
Option('other', 'Same as --theirs-only.'),
4023
custom_help('revision',
4024
help='Filter on other branch revisions (inclusive). '
4025
'See "help revisionspec" for details.'),
4026
Option('my-revision',
4027
type=_parse_revision_str,
4028
help='Filter on local branch revisions (inclusive). '
4029
'See "help revisionspec" for details.'),
4030
Option('include-merges',
4031
'Show all revisions in addition to the mainline ones.'),
4033
encoding_type = 'replace'
4036
def run(self, other_branch=None, reverse=False, mine_only=False,
4038
log_format=None, long=False, short=False, line=False,
4039
show_ids=False, verbose=False, this=False, other=False,
4040
include_merges=False, revision=None, my_revision=None):
4041
from bzrlib.missing import find_unmerged, iter_log_revisions
4050
# TODO: We should probably check that we don't have mine-only and
4051
# theirs-only set, but it gets complicated because we also have
4052
# this and other which could be used.
4059
local_branch = Branch.open_containing(u".")[0]
4060
parent = local_branch.get_parent()
4061
if other_branch is None:
4062
other_branch = parent
4063
if other_branch is None:
4064
raise errors.BzrCommandError("No peer location known"
4066
display_url = urlutils.unescape_for_display(parent,
4068
message("Using saved parent location: "
4069
+ display_url + "\n")
4071
remote_branch = Branch.open(other_branch)
4072
if remote_branch.base == local_branch.base:
4073
remote_branch = local_branch
4075
local_revid_range = _revision_range_to_revid_range(
4076
_get_revision_range(my_revision, local_branch,
4079
remote_revid_range = _revision_range_to_revid_range(
4080
_get_revision_range(revision,
4081
remote_branch, self.name()))
4083
local_branch.lock_read()
4085
remote_branch.lock_read()
4087
local_extra, remote_extra = find_unmerged(
4088
local_branch, remote_branch, restrict,
4089
backward=not reverse,
4090
include_merges=include_merges,
4091
local_revid_range=local_revid_range,
4092
remote_revid_range=remote_revid_range)
4094
if log_format is None:
4095
registry = log.log_formatter_registry
4096
log_format = registry.get_default(local_branch)
4097
lf = log_format(to_file=self.outf,
4099
show_timezone='original')
4102
if local_extra and not theirs_only:
4103
message("You have %d extra revision(s):\n" %
4105
for revision in iter_log_revisions(local_extra,
4106
local_branch.repository,
4108
lf.log_revision(revision)
4109
printed_local = True
4112
printed_local = False
4114
if remote_extra and not mine_only:
4115
if printed_local is True:
4117
message("You are missing %d revision(s):\n" %
4119
for revision in iter_log_revisions(remote_extra,
4120
remote_branch.repository,
4122
lf.log_revision(revision)
4125
if mine_only and not local_extra:
4126
# We checked local, and found nothing extra
4127
message('This branch is up to date.\n')
4128
elif theirs_only and not remote_extra:
4129
# We checked remote, and found nothing extra
4130
message('Other branch is up to date.\n')
4131
elif not (mine_only or theirs_only or local_extra or
4133
# We checked both branches, and neither one had extra
4135
message("Branches are up to date.\n")
4137
remote_branch.unlock()
4139
local_branch.unlock()
4140
if not status_code and parent is None and other_branch is not None:
4141
local_branch.lock_write()
4143
# handle race conditions - a parent might be set while we run.
4144
if local_branch.get_parent() is None:
4145
local_branch.set_parent(remote_branch.base)
4147
local_branch.unlock()
4151
class cmd_pack(Command):
4152
"""Compress the data within a repository."""
4154
_see_also = ['repositories']
4155
takes_args = ['branch_or_repo?']
4157
def run(self, branch_or_repo='.'):
4158
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4160
branch = dir.open_branch()
4161
repository = branch.repository
4162
except errors.NotBranchError:
4163
repository = dir.open_repository()
4167
class cmd_plugins(Command):
4168
"""List the installed plugins.
4170
This command displays the list of installed plugins including
4171
version of plugin and a short description of each.
4173
--verbose shows the path where each plugin is located.
4175
A plugin is an external component for Bazaar that extends the
4176
revision control system, by adding or replacing code in Bazaar.
4177
Plugins can do a variety of things, including overriding commands,
4178
adding new commands, providing additional network transports and
4179
customizing log output.
4181
See the Bazaar web site, http://bazaar-vcs.org, for further
4182
information on plugins including where to find them and how to
4183
install them. Instructions are also provided there on how to
4184
write new plugins using the Python programming language.
4186
takes_options = ['verbose']
4189
def run(self, verbose=False):
4190
import bzrlib.plugin
4191
from inspect import getdoc
4193
for name, plugin in bzrlib.plugin.plugins().items():
4194
version = plugin.__version__
4195
if version == 'unknown':
4197
name_ver = '%s %s' % (name, version)
4198
d = getdoc(plugin.module)
4200
doc = d.split('\n')[0]
4202
doc = '(no description)'
4203
result.append((name_ver, doc, plugin.path()))
4204
for name_ver, doc, path in sorted(result):
4212
class cmd_testament(Command):
4213
"""Show testament (signing-form) of a revision."""
4216
Option('long', help='Produce long-format testament.'),
4218
help='Produce a strict-format testament.')]
4219
takes_args = ['branch?']
4221
def run(self, branch=u'.', revision=None, long=False, strict=False):
4222
from bzrlib.testament import Testament, StrictTestament
4224
testament_class = StrictTestament
4226
testament_class = Testament
4228
b = Branch.open_containing(branch)[0]
4230
b = Branch.open(branch)
4233
if revision is None:
4234
rev_id = b.last_revision()
4236
rev_id = revision[0].as_revision_id(b)
4237
t = testament_class.from_revision(b.repository, rev_id)
4239
sys.stdout.writelines(t.as_text_lines())
4241
sys.stdout.write(t.as_short_text())
4246
class cmd_annotate(Command):
4247
"""Show the origin of each line in a file.
4249
This prints out the given file with an annotation on the left side
4250
indicating which revision, author and date introduced the change.
4252
If the origin is the same for a run of consecutive lines, it is
4253
shown only at the top, unless the --all option is given.
4255
# TODO: annotate directories; showing when each file was last changed
4256
# TODO: if the working copy is modified, show annotations on that
4257
# with new uncommitted lines marked
4258
aliases = ['ann', 'blame', 'praise']
4259
takes_args = ['filename']
4260
takes_options = [Option('all', help='Show annotations on all lines.'),
4261
Option('long', help='Show commit date in annotations.'),
4265
encoding_type = 'exact'
4268
def run(self, filename, all=False, long=False, revision=None,
4270
from bzrlib.annotate import annotate_file, annotate_file_tree
4271
wt, branch, relpath = \
4272
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4278
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4280
file_id = wt.path2id(relpath)
4282
file_id = tree.path2id(relpath)
4284
raise errors.NotVersionedError(filename)
4285
file_version = tree.inventory[file_id].revision
4286
if wt is not None and revision is None:
4287
# If there is a tree and we're not annotating historical
4288
# versions, annotate the working tree's content.
4289
annotate_file_tree(wt, file_id, self.outf, long, all,
4292
annotate_file(branch, file_version, file_id, long, all, self.outf,
4301
class cmd_re_sign(Command):
4302
"""Create a digital signature for an existing revision."""
4303
# TODO be able to replace existing ones.
4305
hidden = True # is this right ?
4306
takes_args = ['revision_id*']
4307
takes_options = ['revision']
4309
def run(self, revision_id_list=None, revision=None):
4310
if revision_id_list is not None and revision is not None:
4311
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4312
if revision_id_list is None and revision is None:
4313
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4314
b = WorkingTree.open_containing(u'.')[0].branch
4317
return self._run(b, revision_id_list, revision)
4321
def _run(self, b, revision_id_list, revision):
4322
import bzrlib.gpg as gpg
4323
gpg_strategy = gpg.GPGStrategy(b.get_config())
4324
if revision_id_list is not None:
4325
b.repository.start_write_group()
4327
for revision_id in revision_id_list:
4328
b.repository.sign_revision(revision_id, gpg_strategy)
4330
b.repository.abort_write_group()
4333
b.repository.commit_write_group()
4334
elif revision is not None:
4335
if len(revision) == 1:
4336
revno, rev_id = revision[0].in_history(b)
4337
b.repository.start_write_group()
4339
b.repository.sign_revision(rev_id, gpg_strategy)
4341
b.repository.abort_write_group()
4344
b.repository.commit_write_group()
4345
elif len(revision) == 2:
4346
# are they both on rh- if so we can walk between them
4347
# might be nice to have a range helper for arbitrary
4348
# revision paths. hmm.
4349
from_revno, from_revid = revision[0].in_history(b)
4350
to_revno, to_revid = revision[1].in_history(b)
4351
if to_revid is None:
4352
to_revno = b.revno()
4353
if from_revno is None or to_revno is None:
4354
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4355
b.repository.start_write_group()
4357
for revno in range(from_revno, to_revno + 1):
4358
b.repository.sign_revision(b.get_rev_id(revno),
4361
b.repository.abort_write_group()
4364
b.repository.commit_write_group()
4366
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4369
class cmd_bind(Command):
4370
"""Convert the current branch into a checkout of the supplied branch.
4372
Once converted into a checkout, commits must succeed on the master branch
4373
before they will be applied to the local branch.
4375
Bound branches use the nickname of its master branch unless it is set
4376
locally, in which case binding will update the the local nickname to be
4380
_see_also = ['checkouts', 'unbind']
4381
takes_args = ['location?']
4384
def run(self, location=None):
4385
b, relpath = Branch.open_containing(u'.')
4386
if location is None:
4388
location = b.get_old_bound_location()
4389
except errors.UpgradeRequired:
4390
raise errors.BzrCommandError('No location supplied. '
4391
'This format does not remember old locations.')
4393
if location is None:
4394
raise errors.BzrCommandError('No location supplied and no '
4395
'previous location known')
4396
b_other = Branch.open(location)
4399
except errors.DivergedBranches:
4400
raise errors.BzrCommandError('These branches have diverged.'
4401
' Try merging, and then bind again.')
4402
if b.get_config().has_explicit_nickname():
4403
b.nick = b_other.nick
4406
class cmd_unbind(Command):
4407
"""Convert the current checkout into a regular branch.
4409
After unbinding, the local branch is considered independent and subsequent
4410
commits will be local only.
4413
_see_also = ['checkouts', 'bind']
4418
b, relpath = Branch.open_containing(u'.')
4420
raise errors.BzrCommandError('Local branch is not bound')
4423
class cmd_uncommit(Command):
4424
"""Remove the last committed revision.
4426
--verbose will print out what is being removed.
4427
--dry-run will go through all the motions, but not actually
4430
If --revision is specified, uncommit revisions to leave the branch at the
4431
specified revision. For example, "bzr uncommit -r 15" will leave the
4432
branch at revision 15.
4434
Uncommit leaves the working tree ready for a new commit. The only change
4435
it may make is to restore any pending merges that were present before
4439
# TODO: jam 20060108 Add an option to allow uncommit to remove
4440
# unreferenced information in 'branch-as-repository' branches.
4441
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4442
# information in shared branches as well.
4443
_see_also = ['commit']
4444
takes_options = ['verbose', 'revision',
4445
Option('dry-run', help='Don\'t actually make changes.'),
4446
Option('force', help='Say yes to all questions.'),
4448
help="Only remove the commits from the local branch"
4449
" when in a checkout."
4452
takes_args = ['location?']
4454
encoding_type = 'replace'
4456
def run(self, location=None,
4457
dry_run=False, verbose=False,
4458
revision=None, force=False, local=False):
4459
if location is None:
4461
control, relpath = bzrdir.BzrDir.open_containing(location)
4463
tree = control.open_workingtree()
4465
except (errors.NoWorkingTree, errors.NotLocalUrl):
4467
b = control.open_branch()
4469
if tree is not None:
4474
return self._run(b, tree, dry_run, verbose, revision, force,
4477
if tree is not None:
4482
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4483
from bzrlib.log import log_formatter, show_log
4484
from bzrlib.uncommit import uncommit
4486
last_revno, last_rev_id = b.last_revision_info()
4489
if revision is None:
4491
rev_id = last_rev_id
4493
# 'bzr uncommit -r 10' actually means uncommit
4494
# so that the final tree is at revno 10.
4495
# but bzrlib.uncommit.uncommit() actually uncommits
4496
# the revisions that are supplied.
4497
# So we need to offset it by one
4498
revno = revision[0].in_history(b).revno + 1
4499
if revno <= last_revno:
4500
rev_id = b.get_rev_id(revno)
4502
if rev_id is None or _mod_revision.is_null(rev_id):
4503
self.outf.write('No revisions to uncommit.\n')
4506
lf = log_formatter('short',
4508
show_timezone='original')
4513
direction='forward',
4514
start_revision=revno,
4515
end_revision=last_revno)
4518
print 'Dry-run, pretending to remove the above revisions.'
4520
val = raw_input('Press <enter> to continue')
4522
print 'The above revision(s) will be removed.'
4524
val = raw_input('Are you sure [y/N]? ')
4525
if val.lower() not in ('y', 'yes'):
4529
mutter('Uncommitting from {%s} to {%s}',
4530
last_rev_id, rev_id)
4531
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4532
revno=revno, local=local)
4533
note('You can restore the old tip by running:\n'
4534
' bzr pull . -r revid:%s', last_rev_id)
4537
class cmd_break_lock(Command):
4538
"""Break a dead lock on a repository, branch or working directory.
4540
CAUTION: Locks should only be broken when you are sure that the process
4541
holding the lock has been stopped.
4543
You can get information on what locks are open via the 'bzr info' command.
4548
takes_args = ['location?']
4550
def run(self, location=None, show=False):
4551
if location is None:
4553
control, relpath = bzrdir.BzrDir.open_containing(location)
4555
control.break_lock()
4556
except NotImplementedError:
4560
class cmd_wait_until_signalled(Command):
4561
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4563
This just prints a line to signal when it is ready, then blocks on stdin.
4569
sys.stdout.write("running\n")
4571
sys.stdin.readline()
4574
class cmd_serve(Command):
4575
"""Run the bzr server."""
4577
aliases = ['server']
4581
help='Serve on stdin/out for use from inetd or sshd.'),
4582
RegistryOption('protocol',
4583
help="Protocol to serve.",
4584
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4585
value_switches=True),
4587
help='Listen for connections on nominated port of the form '
4588
'[hostname:]portnumber. Passing 0 as the port number will '
4589
'result in a dynamically allocated port. The default port '
4590
'depends on the protocol.',
4593
help='Serve contents of this directory.',
4595
Option('allow-writes',
4596
help='By default the server is a readonly server. Supplying '
4597
'--allow-writes enables write access to the contents of '
4598
'the served directory and below.'
4602
def get_host_and_port(self, port):
4603
"""Return the host and port to run the smart server on.
4605
If 'port' is None, None will be returned for the host and port.
4607
If 'port' has a colon in it, the string before the colon will be
4608
interpreted as the host.
4610
:param port: A string of the port to run the server on.
4611
:return: A tuple of (host, port), where 'host' is a host name or IP,
4612
and port is an integer TCP/IP port.
4615
if port is not None:
4617
host, port = port.split(':')
4621
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4623
from bzrlib.transport import get_transport, transport_server_registry
4624
if directory is None:
4625
directory = os.getcwd()
4626
if protocol is None:
4627
protocol = transport_server_registry.get()
4628
host, port = self.get_host_and_port(port)
4629
url = urlutils.local_path_to_url(directory)
4630
if not allow_writes:
4631
url = 'readonly+' + url
4632
transport = get_transport(url)
4633
protocol(transport, host, port, inet)
4636
class cmd_join(Command):
4637
"""Combine a tree into its containing tree.
4639
This command requires the target tree to be in a rich-root format.
4641
The TREE argument should be an independent tree, inside another tree, but
4642
not part of it. (Such trees can be produced by "bzr split", but also by
4643
running "bzr branch" with the target inside a tree.)
4645
The result is a combined tree, with the subtree no longer an independant
4646
part. This is marked as a merge of the subtree into the containing tree,
4647
and all history is preserved.
4650
_see_also = ['split']
4651
takes_args = ['tree']
4653
Option('reference', help='Join by reference.', hidden=True),
4656
def run(self, tree, reference=False):
4657
sub_tree = WorkingTree.open(tree)
4658
parent_dir = osutils.dirname(sub_tree.basedir)
4659
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4660
repo = containing_tree.branch.repository
4661
if not repo.supports_rich_root():
4662
raise errors.BzrCommandError(
4663
"Can't join trees because %s doesn't support rich root data.\n"
4664
"You can use bzr upgrade on the repository."
4668
containing_tree.add_reference(sub_tree)
4669
except errors.BadReferenceTarget, e:
4670
# XXX: Would be better to just raise a nicely printable
4671
# exception from the real origin. Also below. mbp 20070306
4672
raise errors.BzrCommandError("Cannot join %s. %s" %
4676
containing_tree.subsume(sub_tree)
4677
except errors.BadSubsumeSource, e:
4678
raise errors.BzrCommandError("Cannot join %s. %s" %
4682
class cmd_split(Command):
4683
"""Split a subdirectory of a tree into a separate tree.
4685
This command will produce a target tree in a format that supports
4686
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4687
converted into earlier formats like 'dirstate-tags'.
4689
The TREE argument should be a subdirectory of a working tree. That
4690
subdirectory will be converted into an independent tree, with its own
4691
branch. Commits in the top-level tree will not apply to the new subtree.
4694
_see_also = ['join']
4695
takes_args = ['tree']
4697
def run(self, tree):
4698
containing_tree, subdir = WorkingTree.open_containing(tree)
4699
sub_id = containing_tree.path2id(subdir)
4701
raise errors.NotVersionedError(subdir)
4703
containing_tree.extract(sub_id)
4704
except errors.RootNotRich:
4705
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4708
class cmd_merge_directive(Command):
4709
"""Generate a merge directive for auto-merge tools.
4711
A directive requests a merge to be performed, and also provides all the
4712
information necessary to do so. This means it must either include a
4713
revision bundle, or the location of a branch containing the desired
4716
A submit branch (the location to merge into) must be supplied the first
4717
time the command is issued. After it has been supplied once, it will
4718
be remembered as the default.
4720
A public branch is optional if a revision bundle is supplied, but required
4721
if --diff or --plain is specified. It will be remembered as the default
4722
after the first use.
4725
takes_args = ['submit_branch?', 'public_branch?']
4729
_see_also = ['send']
4732
RegistryOption.from_kwargs('patch-type',
4733
'The type of patch to include in the directive.',
4735
value_switches=True,
4737
bundle='Bazaar revision bundle (default).',
4738
diff='Normal unified diff.',
4739
plain='No patch, just directive.'),
4740
Option('sign', help='GPG-sign the directive.'), 'revision',
4741
Option('mail-to', type=str,
4742
help='Instead of printing the directive, email to this address.'),
4743
Option('message', type=str, short_name='m',
4744
help='Message to use when committing this merge.')
4747
encoding_type = 'exact'
4749
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4750
sign=False, revision=None, mail_to=None, message=None):
4751
from bzrlib.revision import ensure_null, NULL_REVISION
4752
include_patch, include_bundle = {
4753
'plain': (False, False),
4754
'diff': (True, False),
4755
'bundle': (True, True),
4757
branch = Branch.open('.')
4758
stored_submit_branch = branch.get_submit_branch()
4759
if submit_branch is None:
4760
submit_branch = stored_submit_branch
4762
if stored_submit_branch is None:
4763
branch.set_submit_branch(submit_branch)
4764
if submit_branch is None:
4765
submit_branch = branch.get_parent()
4766
if submit_branch is None:
4767
raise errors.BzrCommandError('No submit branch specified or known')
4769
stored_public_branch = branch.get_public_branch()
4770
if public_branch is None:
4771
public_branch = stored_public_branch
4772
elif stored_public_branch is None:
4773
branch.set_public_branch(public_branch)
4774
if not include_bundle and public_branch is None:
4775
raise errors.BzrCommandError('No public branch specified or'
4777
base_revision_id = None
4778
if revision is not None:
4779
if len(revision) > 2:
4780
raise errors.BzrCommandError('bzr merge-directive takes '
4781
'at most two one revision identifiers')
4782
revision_id = revision[-1].as_revision_id(branch)
4783
if len(revision) == 2:
4784
base_revision_id = revision[0].as_revision_id(branch)
4786
revision_id = branch.last_revision()
4787
revision_id = ensure_null(revision_id)
4788
if revision_id == NULL_REVISION:
4789
raise errors.BzrCommandError('No revisions to bundle.')
4790
directive = merge_directive.MergeDirective2.from_objects(
4791
branch.repository, revision_id, time.time(),
4792
osutils.local_time_offset(), submit_branch,
4793
public_branch=public_branch, include_patch=include_patch,
4794
include_bundle=include_bundle, message=message,
4795
base_revision_id=base_revision_id)
4798
self.outf.write(directive.to_signed(branch))
4800
self.outf.writelines(directive.to_lines())
4802
message = directive.to_email(mail_to, branch, sign)
4803
s = SMTPConnection(branch.get_config())
4804
s.send_email(message)
4807
class cmd_send(Command):
4808
"""Mail or create a merge-directive for submitting changes.
4810
A merge directive provides many things needed for requesting merges:
4812
* A machine-readable description of the merge to perform
4814
* An optional patch that is a preview of the changes requested
4816
* An optional bundle of revision data, so that the changes can be applied
4817
directly from the merge directive, without retrieving data from a
4820
If --no-bundle is specified, then public_branch is needed (and must be
4821
up-to-date), so that the receiver can perform the merge using the
4822
public_branch. The public_branch is always included if known, so that
4823
people can check it later.
4825
The submit branch defaults to the parent, but can be overridden. Both
4826
submit branch and public branch will be remembered if supplied.
4828
If a public_branch is known for the submit_branch, that public submit
4829
branch is used in the merge instructions. This means that a local mirror
4830
can be used as your actual submit branch, once you have set public_branch
4833
Mail is sent using your preferred mail program. This should be transparent
4834
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4835
If the preferred client can't be found (or used), your editor will be used.
4837
To use a specific mail program, set the mail_client configuration option.
4838
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4839
specific clients are "claws", "evolution", "kmail", "mutt", and
4840
"thunderbird"; generic options are "default", "editor", "emacsclient",
4841
"mapi", and "xdg-email". Plugins may also add supported clients.
4843
If mail is being sent, a to address is required. This can be supplied
4844
either on the commandline, by setting the submit_to configuration
4845
option in the branch itself or the child_submit_to configuration option
4846
in the submit branch.
4848
Two formats are currently supported: "4" uses revision bundle format 4 and
4849
merge directive format 2. It is significantly faster and smaller than
4850
older formats. It is compatible with Bazaar 0.19 and later. It is the
4851
default. "0.9" uses revision bundle format 0.9 and merge directive
4852
format 1. It is compatible with Bazaar 0.12 - 0.18.
4854
The merge directives created by bzr send may be applied using bzr merge or
4855
bzr pull by specifying a file containing a merge directive as the location.
4858
encoding_type = 'exact'
4860
_see_also = ['merge', 'pull']
4862
takes_args = ['submit_branch?', 'public_branch?']
4866
help='Do not include a bundle in the merge directive.'),
4867
Option('no-patch', help='Do not include a preview patch in the merge'
4870
help='Remember submit and public branch.'),
4872
help='Branch to generate the submission from, '
4873
'rather than the one containing the working directory.',
4876
Option('output', short_name='o',
4877
help='Write merge directive to this file; '
4878
'use - for stdout.',
4880
Option('mail-to', help='Mail the request to this address.',
4884
Option('body', help='Body for the email.', type=unicode),
4885
RegistryOption('format',
4886
help='Use the specified output format.',
4887
lazy_registry=('bzrlib.send', 'format_registry'))
4890
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4891
no_patch=False, revision=None, remember=False, output=None,
4892
format=None, mail_to=None, message=None, body=None, **kwargs):
4893
from bzrlib.send import send
4894
return send(submit_branch, revision, public_branch, remember,
4895
format, no_bundle, no_patch, output,
4896
kwargs.get('from', '.'), mail_to, message, body,
4900
class cmd_bundle_revisions(cmd_send):
4901
"""Create a merge-directive for submitting changes.
4903
A merge directive provides many things needed for requesting merges:
4905
* A machine-readable description of the merge to perform
4907
* An optional patch that is a preview of the changes requested
4909
* An optional bundle of revision data, so that the changes can be applied
4910
directly from the merge directive, without retrieving data from a
4913
If --no-bundle is specified, then public_branch is needed (and must be
4914
up-to-date), so that the receiver can perform the merge using the
4915
public_branch. The public_branch is always included if known, so that
4916
people can check it later.
4918
The submit branch defaults to the parent, but can be overridden. Both
4919
submit branch and public branch will be remembered if supplied.
4921
If a public_branch is known for the submit_branch, that public submit
4922
branch is used in the merge instructions. This means that a local mirror
4923
can be used as your actual submit branch, once you have set public_branch
4926
Two formats are currently supported: "4" uses revision bundle format 4 and
4927
merge directive format 2. It is significantly faster and smaller than
4928
older formats. It is compatible with Bazaar 0.19 and later. It is the
4929
default. "0.9" uses revision bundle format 0.9 and merge directive
4930
format 1. It is compatible with Bazaar 0.12 - 0.18.
4935
help='Do not include a bundle in the merge directive.'),
4936
Option('no-patch', help='Do not include a preview patch in the merge'
4939
help='Remember submit and public branch.'),
4941
help='Branch to generate the submission from, '
4942
'rather than the one containing the working directory.',
4945
Option('output', short_name='o', help='Write directive to this file.',
4948
RegistryOption('format',
4949
help='Use the specified output format.',
4950
lazy_registry=('bzrlib.send', 'format_registry')),
4952
aliases = ['bundle']
4954
_see_also = ['send', 'merge']
4958
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4959
no_patch=False, revision=None, remember=False, output=None,
4960
format=None, **kwargs):
4963
from bzrlib.send import send
4964
return send(submit_branch, revision, public_branch, remember,
4965
format, no_bundle, no_patch, output,
4966
kwargs.get('from', '.'), None, None, None,
4970
class cmd_tag(Command):
4971
"""Create, remove or modify a tag naming a revision.
4973
Tags give human-meaningful names to revisions. Commands that take a -r
4974
(--revision) option can be given -rtag:X, where X is any previously
4977
Tags are stored in the branch. Tags are copied from one branch to another
4978
along when you branch, push, pull or merge.
4980
It is an error to give a tag name that already exists unless you pass
4981
--force, in which case the tag is moved to point to the new revision.
4983
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4984
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4987
_see_also = ['commit', 'tags']
4988
takes_args = ['tag_name']
4991
help='Delete this tag rather than placing it.',
4994
help='Branch in which to place the tag.',
4999
help='Replace existing tags.',
5004
def run(self, tag_name,
5010
branch, relpath = Branch.open_containing(directory)
5014
branch.tags.delete_tag(tag_name)
5015
self.outf.write('Deleted tag %s.\n' % tag_name)
5018
if len(revision) != 1:
5019
raise errors.BzrCommandError(
5020
"Tags can only be placed on a single revision, "
5022
revision_id = revision[0].as_revision_id(branch)
5024
revision_id = branch.last_revision()
5025
if (not force) and branch.tags.has_tag(tag_name):
5026
raise errors.TagAlreadyExists(tag_name)
5027
branch.tags.set_tag(tag_name, revision_id)
5028
self.outf.write('Created tag %s.\n' % tag_name)
5033
class cmd_tags(Command):
5036
This command shows a table of tag names and the revisions they reference.
5042
help='Branch whose tags should be displayed.',
5046
RegistryOption.from_kwargs('sort',
5047
'Sort tags by different criteria.', title='Sorting',
5048
alpha='Sort tags lexicographically (default).',
5049
time='Sort tags chronologically.',
5062
branch, relpath = Branch.open_containing(directory)
5064
tags = branch.tags.get_tag_dict().items()
5071
graph = branch.repository.get_graph()
5072
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5073
revid1, revid2 = rev1.rev_id, rev2.rev_id
5074
# only show revisions between revid1 and revid2 (inclusive)
5075
tags = [(tag, revid) for tag, revid in tags if
5076
graph.is_between(revid, revid1, revid2)]
5079
elif sort == 'time':
5081
for tag, revid in tags:
5083
revobj = branch.repository.get_revision(revid)
5084
except errors.NoSuchRevision:
5085
timestamp = sys.maxint # place them at the end
5087
timestamp = revobj.timestamp
5088
timestamps[revid] = timestamp
5089
tags.sort(key=lambda x: timestamps[x[1]])
5091
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5092
for index, (tag, revid) in enumerate(tags):
5094
revno = branch.revision_id_to_dotted_revno(revid)
5095
if isinstance(revno, tuple):
5096
revno = '.'.join(map(str, revno))
5097
except errors.NoSuchRevision:
5098
# Bad tag data/merges can lead to tagged revisions
5099
# which are not in this branch. Fail gracefully ...
5101
tags[index] = (tag, revno)
5104
for tag, revspec in tags:
5105
self.outf.write('%-20s %s\n' % (tag, revspec))
5108
class cmd_reconfigure(Command):
5109
"""Reconfigure the type of a bzr directory.
5111
A target configuration must be specified.
5113
For checkouts, the bind-to location will be auto-detected if not specified.
5114
The order of preference is
5115
1. For a lightweight checkout, the current bound location.
5116
2. For branches that used to be checkouts, the previously-bound location.
5117
3. The push location.
5118
4. The parent location.
5119
If none of these is available, --bind-to must be specified.
5122
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5123
takes_args = ['location?']
5125
RegistryOption.from_kwargs(
5127
title='Target type',
5128
help='The type to reconfigure the directory to.',
5129
value_switches=True, enum_switch=False,
5130
branch='Reconfigure to be an unbound branch with no working tree.',
5131
tree='Reconfigure to be an unbound branch with a working tree.',
5132
checkout='Reconfigure to be a bound branch with a working tree.',
5133
lightweight_checkout='Reconfigure to be a lightweight'
5134
' checkout (with no local history).',
5135
standalone='Reconfigure to be a standalone branch '
5136
'(i.e. stop using shared repository).',
5137
use_shared='Reconfigure to use a shared repository.',
5138
with_trees='Reconfigure repository to create '
5139
'working trees on branches by default.',
5140
with_no_trees='Reconfigure repository to not create '
5141
'working trees on branches by default.'
5143
Option('bind-to', help='Branch to bind checkout to.', type=str),
5145
help='Perform reconfiguration even if local changes'
5149
def run(self, location=None, target_type=None, bind_to=None, force=False):
5150
directory = bzrdir.BzrDir.open(location)
5151
if target_type is None:
5152
raise errors.BzrCommandError('No target configuration specified')
5153
elif target_type == 'branch':
5154
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5155
elif target_type == 'tree':
5156
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5157
elif target_type == 'checkout':
5158
reconfiguration = reconfigure.Reconfigure.to_checkout(
5160
elif target_type == 'lightweight-checkout':
5161
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5163
elif target_type == 'use-shared':
5164
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5165
elif target_type == 'standalone':
5166
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5167
elif target_type == 'with-trees':
5168
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5170
elif target_type == 'with-no-trees':
5171
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5173
reconfiguration.apply(force)
5176
class cmd_switch(Command):
5177
"""Set the branch of a checkout and update.
5179
For lightweight checkouts, this changes the branch being referenced.
5180
For heavyweight checkouts, this checks that there are no local commits
5181
versus the current bound branch, then it makes the local branch a mirror
5182
of the new location and binds to it.
5184
In both cases, the working tree is updated and uncommitted changes
5185
are merged. The user can commit or revert these as they desire.
5187
Pending merges need to be committed or reverted before using switch.
5189
The path to the branch to switch to can be specified relative to the parent
5190
directory of the current branch. For example, if you are currently in a
5191
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5194
Bound branches use the nickname of its master branch unless it is set
5195
locally, in which case switching will update the the local nickname to be
5199
takes_args = ['to_location']
5200
takes_options = [Option('force',
5201
help='Switch even if local commits will be lost.')
5204
def run(self, to_location, force=False):
5205
from bzrlib import switch
5207
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5209
branch = control_dir.open_branch()
5210
had_explicit_nick = branch.get_config().has_explicit_nickname()
5211
except errors.NotBranchError:
5212
had_explicit_nick = False
5214
to_branch = Branch.open(to_location)
5215
except errors.NotBranchError:
5216
this_url = self._get_branch_location(control_dir)
5217
to_branch = Branch.open(
5218
urlutils.join(this_url, '..', to_location))
5219
switch.switch(control_dir, to_branch, force)
5220
if had_explicit_nick:
5221
branch = control_dir.open_branch() #get the new branch!
5222
branch.nick = to_branch.nick
5223
note('Switched to branch: %s',
5224
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5226
def _get_branch_location(self, control_dir):
5227
"""Return location of branch for this control dir."""
5229
this_branch = control_dir.open_branch()
5230
# This may be a heavy checkout, where we want the master branch
5231
master_location = this_branch.get_bound_location()
5232
if master_location is not None:
5233
return master_location
5234
# If not, use a local sibling
5235
return this_branch.base
5236
except errors.NotBranchError:
5237
format = control_dir.find_branch_format()
5238
if getattr(format, 'get_reference', None) is not None:
5239
return format.get_reference(control_dir)
5241
return control_dir.root_transport.base
5244
class cmd_view(Command):
5245
"""Manage filtered views.
5247
Views provide a mask over the tree so that users can focus on
5248
a subset of a tree when doing their work. After creating a view,
5249
commands that support a list of files - status, diff, commit, etc -
5250
effectively have that list of files implicitly given each time.
5251
An explicit list of files can still be given but those files
5252
must be within the current view.
5254
In most cases, a view has a short life-span: it is created to make
5255
a selected change and is deleted once that change is committed.
5256
At other times, you may wish to create one or more named views
5257
and switch between them.
5259
To disable the current view without deleting it, you can switch to
5260
the pseudo view called ``off``. This can be useful when you need
5261
to see the whole tree for an operation or two (e.g. merge) but
5262
want to switch back to your view after that.
5265
To define the current view::
5267
bzr view file1 dir1 ...
5269
To list the current view::
5273
To delete the current view::
5277
To disable the current view without deleting it::
5279
bzr view --switch off
5281
To define a named view and switch to it::
5283
bzr view --name view-name file1 dir1 ...
5285
To list a named view::
5287
bzr view --name view-name
5289
To delete a named view::
5291
bzr view --name view-name --delete
5293
To switch to a named view::
5295
bzr view --switch view-name
5297
To list all views defined::
5301
To delete all views::
5303
bzr view --delete --all
5307
takes_args = ['file*']
5310
help='Apply list or delete action to all views.',
5313
help='Delete the view.',
5316
help='Name of the view to define, list or delete.',
5320
help='Name of the view to switch to.',
5325
def run(self, file_list,
5331
tree, file_list = tree_files(file_list, apply_view=False)
5332
current_view, view_dict = tree.views.get_view_info()
5337
raise errors.BzrCommandError(
5338
"Both --delete and a file list specified")
5340
raise errors.BzrCommandError(
5341
"Both --delete and --switch specified")
5343
tree.views.set_view_info(None, {})
5344
self.outf.write("Deleted all views.\n")
5346
raise errors.BzrCommandError("No current view to delete")
5348
tree.views.delete_view(name)
5349
self.outf.write("Deleted '%s' view.\n" % name)
5352
raise errors.BzrCommandError(
5353
"Both --switch and a file list specified")
5355
raise errors.BzrCommandError(
5356
"Both --switch and --all specified")
5357
elif switch == 'off':
5358
if current_view is None:
5359
raise errors.BzrCommandError("No current view to disable")
5360
tree.views.set_view_info(None, view_dict)
5361
self.outf.write("Disabled '%s' view.\n" % (current_view))
5363
tree.views.set_view_info(switch, view_dict)
5364
view_str = views.view_display_str(tree.views.lookup_view())
5365
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5368
self.outf.write('Views defined:\n')
5369
for view in sorted(view_dict):
5370
if view == current_view:
5374
view_str = views.view_display_str(view_dict[view])
5375
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5377
self.outf.write('No views defined.\n')
5380
# No name given and no current view set
5383
raise errors.BzrCommandError(
5384
"Cannot change the 'off' pseudo view")
5385
tree.views.set_view(name, sorted(file_list))
5386
view_str = views.view_display_str(tree.views.lookup_view())
5387
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5391
# No name given and no current view set
5392
self.outf.write('No current view.\n')
5394
view_str = views.view_display_str(tree.views.lookup_view(name))
5395
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5398
class cmd_hooks(Command):
5404
for hook_key in sorted(hooks.known_hooks.keys()):
5405
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5406
self.outf.write("%s:\n" % type(some_hooks).__name__)
5407
for hook_name, hook_point in sorted(some_hooks.items()):
5408
self.outf.write(" %s:\n" % (hook_name,))
5409
found_hooks = list(hook_point)
5411
for hook in found_hooks:
5412
self.outf.write(" %s\n" %
5413
(some_hooks.get_hook_name(hook),))
5415
self.outf.write(" <no hooks installed>\n")
5418
class cmd_shelve(Command):
5419
"""Temporarily set aside some changes from the current tree.
5421
Shelve allows you to temporarily put changes you've made "on the shelf",
5422
ie. out of the way, until a later time when you can bring them back from
5423
the shelf with the 'unshelve' command. The changes are stored alongside
5424
your working tree, and so they aren't propagated along with your branch nor
5425
will they survive its deletion.
5427
If shelve --list is specified, previously-shelved changes are listed.
5429
Shelve is intended to help separate several sets of changes that have
5430
been inappropriately mingled. If you just want to get rid of all changes
5431
and you don't need to restore them later, use revert. If you want to
5432
shelve all text changes at once, use shelve --all.
5434
If filenames are specified, only the changes to those files will be
5435
shelved. Other files will be left untouched.
5437
If a revision is specified, changes since that revision will be shelved.
5439
You can put multiple items on the shelf, and by default, 'unshelve' will
5440
restore the most recently shelved changes.
5443
takes_args = ['file*']
5447
Option('all', help='Shelve all changes.'),
5449
RegistryOption('writer', 'Method to use for writing diffs.',
5450
bzrlib.option.diff_writer_registry,
5451
value_switches=True, enum_switch=False),
5453
Option('list', help='List shelved changes.'),
5455
help='Destroy removed changes instead of shelving them.'),
5457
_see_also = ['unshelve']
5459
def run(self, revision=None, all=False, file_list=None, message=None,
5460
writer=None, list=False, destroy=False):
5462
return self.run_for_list()
5463
from bzrlib.shelf_ui import Shelver
5465
writer = bzrlib.option.diff_writer_registry.get()
5467
Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5468
message, destroy=destroy).run()
5469
except errors.UserAbort:
5472
def run_for_list(self):
5473
tree = WorkingTree.open_containing('.')[0]
5476
manager = tree.get_shelf_manager()
5477
shelves = manager.active_shelves()
5478
if len(shelves) == 0:
5479
note('No shelved changes.')
5481
for shelf_id in reversed(shelves):
5482
message = manager.get_metadata(shelf_id).get('message')
5484
message = '<no message>'
5485
self.outf.write('%3d: %s\n' % (shelf_id, message))
5491
class cmd_unshelve(Command):
5492
"""Restore shelved changes.
5494
By default, the most recently shelved changes are restored. However if you
5495
specify a shelf by id those changes will be restored instead. This works
5496
best when the changes don't depend on each other.
5499
takes_args = ['shelf_id?']
5501
RegistryOption.from_kwargs(
5502
'action', help="The action to perform.",
5503
enum_switch=False, value_switches=True,
5504
apply="Apply changes and remove from the shelf.",
5505
dry_run="Show changes, but do not apply or remove them.",
5506
delete_only="Delete changes without applying them."
5509
_see_also = ['shelve']
5511
def run(self, shelf_id=None, action='apply'):
5512
from bzrlib.shelf_ui import Unshelver
5513
Unshelver.from_args(shelf_id, action).run()
5516
class cmd_clean_tree(Command):
5517
"""Remove unwanted files from working tree.
5519
By default, only unknown files, not ignored files, are deleted. Versioned
5520
files are never deleted.
5522
Another class is 'detritus', which includes files emitted by bzr during
5523
normal operations and selftests. (The value of these files decreases with
5526
If no options are specified, unknown files are deleted. Otherwise, option
5527
flags are respected, and may be combined.
5529
To check what clean-tree will do, use --dry-run.
5531
takes_options = [Option('ignored', help='Delete all ignored files.'),
5532
Option('detritus', help='Delete conflict files, merge'
5533
' backups, and failed selftest dirs.'),
5535
help='Delete files unknown to bzr (default).'),
5536
Option('dry-run', help='Show files to delete instead of'
5538
Option('force', help='Do not prompt before deleting.')]
5539
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5541
from bzrlib.clean_tree import clean_tree
5542
if not (unknown or ignored or detritus):
5546
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5547
dry_run=dry_run, no_prompt=force)
5550
class cmd_reference(Command):
5551
"""list, view and set branch locations for nested trees.
5553
If no arguments are provided, lists the branch locations for nested trees.
5554
If one argument is provided, display the branch location for that tree.
5555
If two arguments are provided, set the branch location for that tree.
5560
takes_args = ['path?', 'location?']
5562
def run(self, path=None, location=None):
5564
if path is not None:
5566
tree, branch, relpath =(
5567
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5568
if path is not None:
5571
tree = branch.basis_tree()
5573
info = branch._get_all_reference_info().iteritems()
5574
self._display_reference_info(tree, branch, info)
5576
file_id = tree.path2id(path)
5578
raise errors.NotVersionedError(path)
5579
if location is None:
5580
info = [(file_id, branch.get_reference_info(file_id))]
5581
self._display_reference_info(tree, branch, info)
5583
branch.set_reference_info(file_id, path, location)
5585
def _display_reference_info(self, tree, branch, info):
5587
for file_id, (path, location) in info:
5589
path = tree.id2path(file_id)
5590
except errors.NoSuchId:
5592
ref_list.append((path, location))
5593
for path, location in sorted(ref_list):
5594
self.outf.write('%s %s\n' % (path, location))
5597
# these get imported and then picked up by the scan for cmd_*
5598
# TODO: Some more consistent way to split command definitions across files;
5599
# we do need to load at least some information about them to know of
5600
# aliases. ideally we would avoid loading the implementation until the
5601
# details were needed.
5602
from bzrlib.cmd_version_info import cmd_version_info
5603
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5604
from bzrlib.bundle.commands import (
5607
from bzrlib.foreign import cmd_dpush
5608
from bzrlib.sign_my_commits import cmd_sign_my_commits
5609
from bzrlib.weave_commands import cmd_versionedfile_list, \
5610
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
