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 revision is not None:
950
revision_id = revision.as_revision_id(branch_from)
952
branch_to.lock_write()
954
if tree_to is not None:
955
view_info = _get_view_info_for_change_reporter(tree_to)
956
change_reporter = delta._ChangeReporter(
957
unversioned_filter=tree_to.is_ignored, view_info=view_info)
958
result = tree_to.pull(branch_from, overwrite, revision_id,
960
possible_transports=possible_transports,
963
result = branch_to.pull(branch_from, overwrite, revision_id,
966
result.report(self.outf)
967
if verbose and result.old_revid != result.new_revid:
968
log.show_branch_change(branch_to, self.outf, result.old_revno,
974
class cmd_push(Command):
975
"""Update a mirror of this branch.
977
The target branch will not have its working tree populated because this
978
is both expensive, and is not supported on remote file systems.
980
Some smart servers or protocols *may* put the working tree in place in
983
This command only works on branches that have not diverged. Branches are
984
considered diverged if the destination branch's most recent commit is one
985
that has not been merged (directly or indirectly) by the source branch.
987
If branches have diverged, you can use 'bzr push --overwrite' to replace
988
the other branch completely, discarding its unmerged changes.
990
If you want to ensure you have the different changes in the other branch,
991
do a merge (see bzr help merge) from the other branch, and commit that.
992
After that you will be able to do a push without '--overwrite'.
994
If there is no default push location set, the first push will set it.
995
After that, you can omit the location to use the default. To change the
996
default, use --remember. The value will only be saved if the remote
997
location can be accessed.
1000
_see_also = ['pull', 'update', 'working-trees']
1001
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1002
Option('create-prefix',
1003
help='Create the path leading up to the branch '
1004
'if it does not already exist.'),
1006
help='Branch to push from, '
1007
'rather than the one containing the working directory.',
1011
Option('use-existing-dir',
1012
help='By default push will fail if the target'
1013
' directory exists, but does not already'
1014
' have a control directory. This flag will'
1015
' allow push to proceed.'),
1017
help='Create a stacked branch that references the public location '
1018
'of the parent branch.'),
1019
Option('stacked-on',
1020
help='Create a stacked branch that refers to another branch '
1021
'for the commit history. Only the work not present in the '
1022
'referenced branch is included in the branch created.',
1025
takes_args = ['location?']
1026
encoding_type = 'replace'
1028
def run(self, location=None, remember=False, overwrite=False,
1029
create_prefix=False, verbose=False, revision=None,
1030
use_existing_dir=False, directory=None, stacked_on=None,
1032
from bzrlib.push import _show_push_branch
1034
# Get the source branch and revision_id
1035
if directory is None:
1037
br_from = Branch.open_containing(directory)[0]
1038
revision = _get_one_revision('push', revision)
1039
if revision is not None:
1040
revision_id = revision.in_history(br_from).rev_id
1044
# Get the stacked_on branch, if any
1045
if stacked_on is not None:
1046
stacked_on = urlutils.normalize_url(stacked_on)
1048
parent_url = br_from.get_parent()
1050
parent = Branch.open(parent_url)
1051
stacked_on = parent.get_public_branch()
1053
# I considered excluding non-http url's here, thus forcing
1054
# 'public' branches only, but that only works for some
1055
# users, so it's best to just depend on the user spotting an
1056
# error by the feedback given to them. RBC 20080227.
1057
stacked_on = parent_url
1059
raise errors.BzrCommandError(
1060
"Could not determine branch to refer to.")
1062
# Get the destination location
1063
if location is None:
1064
stored_loc = br_from.get_push_location()
1065
if stored_loc is None:
1066
raise errors.BzrCommandError(
1067
"No push location known or specified.")
1069
display_url = urlutils.unescape_for_display(stored_loc,
1071
self.outf.write("Using saved push location: %s\n" % display_url)
1072
location = stored_loc
1074
_show_push_branch(br_from, revision_id, location, self.outf,
1075
verbose=verbose, overwrite=overwrite, remember=remember,
1076
stacked_on=stacked_on, create_prefix=create_prefix,
1077
use_existing_dir=use_existing_dir)
1080
class cmd_branch(Command):
1081
"""Create a new copy of a branch.
1083
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1084
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1085
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1086
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1087
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1090
To retrieve the branch as of a particular revision, supply the --revision
1091
parameter, as in "branch foo/bar -r 5".
1094
_see_also = ['checkout']
1095
takes_args = ['from_location', 'to_location?']
1096
takes_options = ['revision', Option('hardlink',
1097
help='Hard-link working tree files where possible.'),
1099
help="Create a branch without a working-tree."),
1101
help='Create a stacked branch referring to the source branch. '
1102
'The new branch will depend on the availability of the source '
1103
'branch for all operations.'),
1104
Option('standalone',
1105
help='Do not use a shared repository, even if available.'),
1107
aliases = ['get', 'clone']
1109
def run(self, from_location, to_location=None, revision=None,
1110
hardlink=False, stacked=False, standalone=False, no_tree=False):
1111
from bzrlib.tag import _merge_tags_if_possible
1113
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1115
revision = _get_one_revision('branch', revision)
1118
if revision is not None:
1119
revision_id = revision.as_revision_id(br_from)
1121
# FIXME - wt.last_revision, fallback to branch, fall back to
1122
# None or perhaps NULL_REVISION to mean copy nothing
1124
revision_id = br_from.last_revision()
1125
if to_location is None:
1126
to_location = urlutils.derive_to_location(from_location)
1127
to_transport = transport.get_transport(to_location)
1129
to_transport.mkdir('.')
1130
except errors.FileExists:
1131
raise errors.BzrCommandError('Target directory "%s" already'
1132
' exists.' % to_location)
1133
except errors.NoSuchFile:
1134
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1137
# preserve whatever source format we have.
1138
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1139
possible_transports=[to_transport],
1140
accelerator_tree=accelerator_tree,
1141
hardlink=hardlink, stacked=stacked,
1142
force_new_repo=standalone,
1143
create_tree_if_local=not no_tree,
1144
source_branch=br_from)
1145
branch = dir.open_branch()
1146
except errors.NoSuchRevision:
1147
to_transport.delete_tree('.')
1148
msg = "The branch %s has no revision %s." % (from_location,
1150
raise errors.BzrCommandError(msg)
1151
_merge_tags_if_possible(br_from, branch)
1152
# If the source branch is stacked, the new branch may
1153
# be stacked whether we asked for that explicitly or not.
1154
# We therefore need a try/except here and not just 'if stacked:'
1156
note('Created new stacked branch referring to %s.' %
1157
branch.get_stacked_on_url())
1158
except (errors.NotStacked, errors.UnstackableBranchFormat,
1159
errors.UnstackableRepositoryFormat), e:
1160
note('Branched %d revision(s).' % branch.revno())
1165
class cmd_checkout(Command):
1166
"""Create a new checkout of an existing branch.
1168
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1169
the branch found in '.'. This is useful if you have removed the working tree
1170
or if it was never created - i.e. if you pushed the branch to its current
1171
location using SFTP.
1173
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1174
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1175
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1176
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1177
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1180
To retrieve the branch as of a particular revision, supply the --revision
1181
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1182
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1186
_see_also = ['checkouts', 'branch']
1187
takes_args = ['branch_location?', 'to_location?']
1188
takes_options = ['revision',
1189
Option('lightweight',
1190
help="Perform a lightweight checkout. Lightweight "
1191
"checkouts depend on access to the branch for "
1192
"every operation. Normal checkouts can perform "
1193
"common operations like diff and status without "
1194
"such access, and also support local commits."
1196
Option('files-from', type=str,
1197
help="Get file contents from this tree."),
1199
help='Hard-link working tree files where possible.'
1204
def run(self, branch_location=None, to_location=None, revision=None,
1205
lightweight=False, files_from=None, hardlink=False):
1206
if branch_location is None:
1207
branch_location = osutils.getcwd()
1208
to_location = branch_location
1209
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1211
revision = _get_one_revision('checkout', revision)
1212
if files_from is not None:
1213
accelerator_tree = WorkingTree.open(files_from)
1214
if revision is not None:
1215
revision_id = revision.as_revision_id(source)
1218
if to_location is None:
1219
to_location = urlutils.derive_to_location(branch_location)
1220
# if the source and to_location are the same,
1221
# and there is no working tree,
1222
# then reconstitute a branch
1223
if (osutils.abspath(to_location) ==
1224
osutils.abspath(branch_location)):
1226
source.bzrdir.open_workingtree()
1227
except errors.NoWorkingTree:
1228
source.bzrdir.create_workingtree(revision_id)
1230
source.create_checkout(to_location, revision_id, lightweight,
1231
accelerator_tree, hardlink)
1234
class cmd_renames(Command):
1235
"""Show list of renamed files.
1237
# TODO: Option to show renames between two historical versions.
1239
# TODO: Only show renames under dir, rather than in the whole branch.
1240
_see_also = ['status']
1241
takes_args = ['dir?']
1244
def run(self, dir=u'.'):
1245
tree = WorkingTree.open_containing(dir)[0]
1248
new_inv = tree.inventory
1249
old_tree = tree.basis_tree()
1250
old_tree.lock_read()
1252
old_inv = old_tree.inventory
1254
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1255
for f, paths, c, v, p, n, k, e in iterator:
1256
if paths[0] == paths[1]:
1260
renames.append(paths)
1262
for old_name, new_name in renames:
1263
self.outf.write("%s => %s\n" % (old_name, new_name))
1270
class cmd_update(Command):
1271
"""Update a tree to have the latest code committed to its branch.
1273
This will perform a merge into the working tree, and may generate
1274
conflicts. If you have any local changes, you will still
1275
need to commit them after the update for the update to be complete.
1277
If you want to discard your local changes, you can just do a
1278
'bzr revert' instead of 'bzr commit' after the update.
1281
_see_also = ['pull', 'working-trees', 'status-flags']
1282
takes_args = ['dir?']
1285
def run(self, dir='.'):
1286
tree = WorkingTree.open_containing(dir)[0]
1287
possible_transports = []
1288
master = tree.branch.get_master_branch(
1289
possible_transports=possible_transports)
1290
if master is not None:
1293
tree.lock_tree_write()
1295
existing_pending_merges = tree.get_parent_ids()[1:]
1296
last_rev = _mod_revision.ensure_null(tree.last_revision())
1297
if last_rev == _mod_revision.ensure_null(
1298
tree.branch.last_revision()):
1299
# may be up to date, check master too.
1300
if master is None or last_rev == _mod_revision.ensure_null(
1301
master.last_revision()):
1302
revno = tree.branch.revision_id_to_revno(last_rev)
1303
note("Tree is up to date at revision %d." % (revno,))
1305
view_info = _get_view_info_for_change_reporter(tree)
1306
conflicts = tree.update(
1307
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1308
view_info=view_info), possible_transports=possible_transports)
1309
revno = tree.branch.revision_id_to_revno(
1310
_mod_revision.ensure_null(tree.last_revision()))
1311
note('Updated to revision %d.' % (revno,))
1312
if tree.get_parent_ids()[1:] != existing_pending_merges:
1313
note('Your local commits will now show as pending merges with '
1314
"'bzr status', and can be committed with 'bzr commit'.")
1323
class cmd_info(Command):
1324
"""Show information about a working tree, branch or repository.
1326
This command will show all known locations and formats associated to the
1327
tree, branch or repository.
1329
In verbose mode, statistical information is included with each report.
1330
To see extended statistic information, use a verbosity level of 2 or
1331
higher by specifying the verbose option multiple times, e.g. -vv.
1333
Branches and working trees will also report any missing revisions.
1337
Display information on the format and related locations:
1341
Display the above together with extended format information and
1342
basic statistics (like the number of files in the working tree and
1343
number of revisions in the branch and repository):
1347
Display the above together with number of committers to the branch:
1351
_see_also = ['revno', 'working-trees', 'repositories']
1352
takes_args = ['location?']
1353
takes_options = ['verbose']
1354
encoding_type = 'replace'
1357
def run(self, location=None, verbose=False):
1359
noise_level = get_verbosity_level()
1362
from bzrlib.info import show_bzrdir_info
1363
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1364
verbose=noise_level, outfile=self.outf)
1367
class cmd_remove(Command):
1368
"""Remove files or directories.
1370
This makes bzr stop tracking changes to the specified files. bzr will delete
1371
them if they can easily be recovered using revert. If no options or
1372
parameters are given bzr will scan for files that are being tracked by bzr
1373
but missing in your tree and stop tracking them for you.
1375
takes_args = ['file*']
1376
takes_options = ['verbose',
1377
Option('new', help='Only remove files that have never been committed.'),
1378
RegistryOption.from_kwargs('file-deletion-strategy',
1379
'The file deletion mode to be used.',
1380
title='Deletion Strategy', value_switches=True, enum_switch=False,
1381
safe='Only delete files if they can be'
1382
' safely recovered (default).',
1383
keep="Don't delete any files.",
1384
force='Delete all the specified files, even if they can not be '
1385
'recovered and even if they are non-empty directories.')]
1386
aliases = ['rm', 'del']
1387
encoding_type = 'replace'
1389
def run(self, file_list, verbose=False, new=False,
1390
file_deletion_strategy='safe'):
1391
tree, file_list = tree_files(file_list)
1393
if file_list is not None:
1394
file_list = [f for f in file_list]
1398
# Heuristics should probably all move into tree.remove_smart or
1401
added = tree.changes_from(tree.basis_tree(),
1402
specific_files=file_list).added
1403
file_list = sorted([f[0] for f in added], reverse=True)
1404
if len(file_list) == 0:
1405
raise errors.BzrCommandError('No matching files.')
1406
elif file_list is None:
1407
# missing files show up in iter_changes(basis) as
1408
# versioned-with-no-kind.
1410
for change in tree.iter_changes(tree.basis_tree()):
1411
# Find paths in the working tree that have no kind:
1412
if change[1][1] is not None and change[6][1] is None:
1413
missing.append(change[1][1])
1414
file_list = sorted(missing, reverse=True)
1415
file_deletion_strategy = 'keep'
1416
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1417
keep_files=file_deletion_strategy=='keep',
1418
force=file_deletion_strategy=='force')
1423
class cmd_file_id(Command):
1424
"""Print file_id of a particular file or directory.
1426
The file_id is assigned when the file is first added and remains the
1427
same through all revisions where the file exists, even when it is
1432
_see_also = ['inventory', 'ls']
1433
takes_args = ['filename']
1436
def run(self, filename):
1437
tree, relpath = WorkingTree.open_containing(filename)
1438
i = tree.path2id(relpath)
1440
raise errors.NotVersionedError(filename)
1442
self.outf.write(i + '\n')
1445
class cmd_file_path(Command):
1446
"""Print path of file_ids to a file or directory.
1448
This prints one line for each directory down to the target,
1449
starting at the branch root.
1453
takes_args = ['filename']
1456
def run(self, filename):
1457
tree, relpath = WorkingTree.open_containing(filename)
1458
fid = tree.path2id(relpath)
1460
raise errors.NotVersionedError(filename)
1461
segments = osutils.splitpath(relpath)
1462
for pos in range(1, len(segments) + 1):
1463
path = osutils.joinpath(segments[:pos])
1464
self.outf.write("%s\n" % tree.path2id(path))
1467
class cmd_reconcile(Command):
1468
"""Reconcile bzr metadata in a branch.
1470
This can correct data mismatches that may have been caused by
1471
previous ghost operations or bzr upgrades. You should only
1472
need to run this command if 'bzr check' or a bzr developer
1473
advises you to run it.
1475
If a second branch is provided, cross-branch reconciliation is
1476
also attempted, which will check that data like the tree root
1477
id which was not present in very early bzr versions is represented
1478
correctly in both branches.
1480
At the same time it is run it may recompress data resulting in
1481
a potential saving in disk space or performance gain.
1483
The branch *MUST* be on a listable system such as local disk or sftp.
1486
_see_also = ['check']
1487
takes_args = ['branch?']
1489
def run(self, branch="."):
1490
from bzrlib.reconcile import reconcile
1491
dir = bzrdir.BzrDir.open(branch)
1495
class cmd_revision_history(Command):
1496
"""Display the list of revision ids on a branch."""
1499
takes_args = ['location?']
1504
def run(self, location="."):
1505
branch = Branch.open_containing(location)[0]
1506
for revid in branch.revision_history():
1507
self.outf.write(revid)
1508
self.outf.write('\n')
1511
class cmd_ancestry(Command):
1512
"""List all revisions merged into this branch."""
1514
_see_also = ['log', 'revision-history']
1515
takes_args = ['location?']
1520
def run(self, location="."):
1522
wt = WorkingTree.open_containing(location)[0]
1523
except errors.NoWorkingTree:
1524
b = Branch.open(location)
1525
last_revision = b.last_revision()
1528
last_revision = wt.last_revision()
1530
revision_ids = b.repository.get_ancestry(last_revision)
1532
for revision_id in revision_ids:
1533
self.outf.write(revision_id + '\n')
1536
class cmd_init(Command):
1537
"""Make a directory into a versioned branch.
1539
Use this to create an empty branch, or before importing an
1542
If there is a repository in a parent directory of the location, then
1543
the history of the branch will be stored in the repository. Otherwise
1544
init creates a standalone branch which carries its own history
1545
in the .bzr directory.
1547
If there is already a branch at the location but it has no working tree,
1548
the tree can be populated with 'bzr checkout'.
1550
Recipe for importing a tree of files::
1556
bzr commit -m "imported project"
1559
_see_also = ['init-repository', 'branch', 'checkout']
1560
takes_args = ['location?']
1562
Option('create-prefix',
1563
help='Create the path leading up to the branch '
1564
'if it does not already exist.'),
1565
RegistryOption('format',
1566
help='Specify a format for this branch. '
1567
'See "help formats".',
1568
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1569
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1570
value_switches=True,
1571
title="Branch Format",
1573
Option('append-revisions-only',
1574
help='Never change revnos or the existing log.'
1575
' Append revisions to it only.')
1577
def run(self, location=None, format=None, append_revisions_only=False,
1578
create_prefix=False):
1580
format = bzrdir.format_registry.make_bzrdir('default')
1581
if location is None:
1584
to_transport = transport.get_transport(location)
1586
# The path has to exist to initialize a
1587
# branch inside of it.
1588
# Just using os.mkdir, since I don't
1589
# believe that we want to create a bunch of
1590
# locations if the user supplies an extended path
1592
to_transport.ensure_base()
1593
except errors.NoSuchFile:
1594
if not create_prefix:
1595
raise errors.BzrCommandError("Parent directory of %s"
1597
"\nYou may supply --create-prefix to create all"
1598
" leading parent directories."
1600
to_transport.create_prefix()
1603
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1604
except errors.NotBranchError:
1605
# really a NotBzrDir error...
1606
create_branch = bzrdir.BzrDir.create_branch_convenience
1607
branch = create_branch(to_transport.base, format=format,
1608
possible_transports=[to_transport])
1609
a_bzrdir = branch.bzrdir
1611
from bzrlib.transport.local import LocalTransport
1612
if a_bzrdir.has_branch():
1613
if (isinstance(to_transport, LocalTransport)
1614
and not a_bzrdir.has_workingtree()):
1615
raise errors.BranchExistsWithoutWorkingTree(location)
1616
raise errors.AlreadyBranchError(location)
1617
branch = a_bzrdir.create_branch()
1618
a_bzrdir.create_workingtree()
1619
if append_revisions_only:
1621
branch.set_append_revisions_only(True)
1622
except errors.UpgradeRequired:
1623
raise errors.BzrCommandError('This branch format cannot be set'
1624
' to append-revisions-only. Try --experimental-branch6')
1626
from bzrlib.info import describe_layout, describe_format
1628
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1629
except (errors.NoWorkingTree, errors.NotLocalUrl):
1631
repository = branch.repository
1632
layout = describe_layout(repository, branch, tree).lower()
1633
format = describe_format(a_bzrdir, repository, branch, tree)
1634
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1635
if repository.is_shared():
1636
#XXX: maybe this can be refactored into transport.path_or_url()
1637
url = repository.bzrdir.root_transport.external_url()
1639
url = urlutils.local_path_from_url(url)
1640
except errors.InvalidURL:
1642
self.outf.write("Using shared repository: %s\n" % url)
1645
class cmd_init_repository(Command):
1646
"""Create a shared repository to hold branches.
1648
New branches created under the repository directory will store their
1649
revisions in the repository, not in the branch directory.
1651
If the --no-trees option is used then the branches in the repository
1652
will not have working trees by default.
1655
Create a shared repositories holding just branches::
1657
bzr init-repo --no-trees repo
1660
Make a lightweight checkout elsewhere::
1662
bzr checkout --lightweight repo/trunk trunk-checkout
1667
_see_also = ['init', 'branch', 'checkout', 'repositories']
1668
takes_args = ["location"]
1669
takes_options = [RegistryOption('format',
1670
help='Specify a format for this repository. See'
1671
' "bzr help formats" for details.',
1672
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1673
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1674
value_switches=True, title='Repository format'),
1676
help='Branches in the repository will default to'
1677
' not having a working tree.'),
1679
aliases = ["init-repo"]
1681
def run(self, location, format=None, no_trees=False):
1683
format = bzrdir.format_registry.make_bzrdir('default')
1685
if location is None:
1688
to_transport = transport.get_transport(location)
1689
to_transport.ensure_base()
1691
newdir = format.initialize_on_transport(to_transport)
1692
repo = newdir.create_repository(shared=True)
1693
repo.set_make_working_trees(not no_trees)
1695
from bzrlib.info import show_bzrdir_info
1696
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1699
class cmd_diff(Command):
1700
"""Show differences in the working tree, between revisions or branches.
1702
If no arguments are given, all changes for the current tree are listed.
1703
If files are given, only the changes in those files are listed.
1704
Remote and multiple branches can be compared by using the --old and
1705
--new options. If not provided, the default for both is derived from
1706
the first argument, if any, or the current tree if no arguments are
1709
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1710
produces patches suitable for "patch -p1".
1714
2 - unrepresentable changes
1719
Shows the difference in the working tree versus the last commit::
1723
Difference between the working tree and revision 1::
1727
Difference between revision 2 and revision 1::
1731
Difference between revision 2 and revision 1 for branch xxx::
1735
Show just the differences for file NEWS::
1739
Show the differences in working tree xxx for file NEWS::
1743
Show the differences from branch xxx to this working tree:
1747
Show the differences between two branches for file NEWS::
1749
bzr diff --old xxx --new yyy NEWS
1751
Same as 'bzr diff' but prefix paths with old/ and new/::
1753
bzr diff --prefix old/:new/
1755
_see_also = ['status']
1756
takes_args = ['file*']
1758
Option('diff-options', type=str,
1759
help='Pass these options to the external diff program.'),
1760
Option('prefix', type=str,
1762
help='Set prefixes added to old and new filenames, as '
1763
'two values separated by a colon. (eg "old/:new/").'),
1765
help='Branch/tree to compare from.',
1769
help='Branch/tree to compare to.',
1775
help='Use this command to compare files.',
1779
aliases = ['di', 'dif']
1780
encoding_type = 'exact'
1783
def run(self, revision=None, file_list=None, diff_options=None,
1784
prefix=None, old=None, new=None, using=None):
1785
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1787
if (prefix is None) or (prefix == '0'):
1795
old_label, new_label = prefix.split(":")
1797
raise errors.BzrCommandError(
1798
'--prefix expects two values separated by a colon'
1799
' (eg "old/:new/")')
1801
if revision and len(revision) > 2:
1802
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1803
' one or two revision specifiers')
1805
old_tree, new_tree, specific_files, extra_trees = \
1806
_get_trees_to_diff(file_list, revision, old, new,
1808
return show_diff_trees(old_tree, new_tree, sys.stdout,
1809
specific_files=specific_files,
1810
external_diff_options=diff_options,
1811
old_label=old_label, new_label=new_label,
1812
extra_trees=extra_trees, using=using)
1815
class cmd_deleted(Command):
1816
"""List files deleted in the working tree.
1818
# TODO: Show files deleted since a previous revision, or
1819
# between two revisions.
1820
# TODO: Much more efficient way to do this: read in new
1821
# directories with readdir, rather than stating each one. Same
1822
# level of effort but possibly much less IO. (Or possibly not,
1823
# if the directories are very large...)
1824
_see_also = ['status', 'ls']
1825
takes_options = ['show-ids']
1828
def run(self, show_ids=False):
1829
tree = WorkingTree.open_containing(u'.')[0]
1832
old = tree.basis_tree()
1835
for path, ie in old.inventory.iter_entries():
1836
if not tree.has_id(ie.file_id):
1837
self.outf.write(path)
1839
self.outf.write(' ')
1840
self.outf.write(ie.file_id)
1841
self.outf.write('\n')
1848
class cmd_modified(Command):
1849
"""List files modified in working tree.
1853
_see_also = ['status', 'ls']
1856
help='Write an ascii NUL (\\0) separator '
1857
'between files rather than a newline.')
1861
def run(self, null=False):
1862
tree = WorkingTree.open_containing(u'.')[0]
1863
td = tree.changes_from(tree.basis_tree())
1864
for path, id, kind, text_modified, meta_modified in td.modified:
1866
self.outf.write(path + '\0')
1868
self.outf.write(osutils.quotefn(path) + '\n')
1871
class cmd_added(Command):
1872
"""List files added in working tree.
1876
_see_also = ['status', 'ls']
1879
help='Write an ascii NUL (\\0) separator '
1880
'between files rather than a newline.')
1884
def run(self, null=False):
1885
wt = WorkingTree.open_containing(u'.')[0]
1888
basis = wt.basis_tree()
1891
basis_inv = basis.inventory
1894
if file_id in basis_inv:
1896
if inv.is_root(file_id) and len(basis_inv) == 0:
1898
path = inv.id2path(file_id)
1899
if not os.access(osutils.abspath(path), os.F_OK):
1902
self.outf.write(path + '\0')
1904
self.outf.write(osutils.quotefn(path) + '\n')
1911
class cmd_root(Command):
1912
"""Show the tree root directory.
1914
The root is the nearest enclosing directory with a .bzr control
1917
takes_args = ['filename?']
1919
def run(self, filename=None):
1920
"""Print the branch root."""
1921
tree = WorkingTree.open_containing(filename)[0]
1922
self.outf.write(tree.basedir + '\n')
1925
def _parse_limit(limitstring):
1927
return int(limitstring)
1929
msg = "The limit argument must be an integer."
1930
raise errors.BzrCommandError(msg)
1933
def _parse_levels(s):
1937
msg = "The levels argument must be an integer."
1938
raise errors.BzrCommandError(msg)
1941
class cmd_log(Command):
1942
"""Show historical log for a branch or subset of a branch.
1944
log is bzr's default tool for exploring the history of a branch.
1945
The branch to use is taken from the first parameter. If no parameters
1946
are given, the branch containing the working directory is logged.
1947
Here are some simple examples::
1949
bzr log log the current branch
1950
bzr log foo.py log a file in its branch
1951
bzr log http://server/branch log a branch on a server
1953
The filtering, ordering and information shown for each revision can
1954
be controlled as explained below. By default, all revisions are
1955
shown sorted (topologically) so that newer revisions appear before
1956
older ones and descendants always appear before ancestors. If displayed,
1957
merged revisions are shown indented under the revision in which they
1962
The log format controls how information about each revision is
1963
displayed. The standard log formats are called ``long``, ``short``
1964
and ``line``. The default is long. See ``bzr help log-formats``
1965
for more details on log formats.
1967
The following options can be used to control what information is
1970
-l N display a maximum of N revisions
1971
-n N display N levels of revisions (0 for all, 1 for collapsed)
1972
-v display a status summary (delta) for each revision
1973
-p display a diff (patch) for each revision
1974
--show-ids display revision-ids (and file-ids), not just revnos
1976
Note that the default number of levels to display is a function of the
1977
log format. If the -n option is not used, the standard log formats show
1978
just the top level (mainline).
1980
Status summaries are shown using status flags like A, M, etc. To see
1981
the changes explained using words like ``added`` and ``modified``
1982
instead, use the -vv option.
1986
To display revisions from oldest to newest, use the --forward option.
1987
In most cases, using this option will have little impact on the total
1988
time taken to produce a log, though --forward does not incrementally
1989
display revisions like --reverse does when it can.
1991
:Revision filtering:
1993
The -r option can be used to specify what revision or range of revisions
1994
to filter against. The various forms are shown below::
1996
-rX display revision X
1997
-rX.. display revision X and later
1998
-r..Y display up to and including revision Y
1999
-rX..Y display from X to Y inclusive
2001
See ``bzr help revisionspec`` for details on how to specify X and Y.
2002
Some common examples are given below::
2004
-r-1 show just the tip
2005
-r-10.. show the last 10 mainline revisions
2006
-rsubmit:.. show what's new on this branch
2007
-rancestor:path.. show changes since the common ancestor of this
2008
branch and the one at location path
2009
-rdate:yesterday.. show changes since yesterday
2011
When logging a range of revisions using -rX..Y, log starts at
2012
revision Y and searches back in history through the primary
2013
("left-hand") parents until it finds X. When logging just the
2014
top level (using -n1), an error is reported if X is not found
2015
along the way. If multi-level logging is used (-n0), X may be
2016
a nested merge revision and the log will be truncated accordingly.
2020
If parameters are given and the first one is not a branch, the log
2021
will be filtered to show only those revisions that changed the
2022
nominated files or directories.
2024
Filenames are interpreted within their historical context. To log a
2025
deleted file, specify a revision range so that the file existed at
2026
the end or start of the range.
2028
Historical context is also important when interpreting pathnames of
2029
renamed files/directories. Consider the following example:
2031
* revision 1: add tutorial.txt
2032
* revision 2: modify tutorial.txt
2033
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2037
* ``bzr log guide.txt`` will log the file added in revision 1
2039
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2041
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2042
the original file in revision 2.
2044
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2045
was no file called guide.txt in revision 2.
2047
Renames are always followed by log. By design, there is no need to
2048
explicitly ask for this (and no way to stop logging a file back
2049
until it was last renamed).
2053
The --message option can be used for finding revisions that match a
2054
regular expression in a commit message.
2058
GUI tools and IDEs are often better at exploring history than command
2059
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2060
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2061
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2063
Web interfaces are often better at exploring history than command line
2064
tools, particularly for branches on servers. You may prefer Loggerhead
2065
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2067
You may find it useful to add the aliases below to ``bazaar.conf``::
2071
top = log -l10 --line
2074
``bzr tip`` will then show the latest revision while ``bzr top``
2075
will show the last 10 mainline revisions. To see the details of a
2076
particular revision X, ``bzr show -rX``.
2078
If you are interested in looking deeper into a particular merge X,
2079
use ``bzr log -n0 -rX``.
2081
``bzr log -v`` on a branch with lots of history is currently
2082
very slow. A fix for this issue is currently under development.
2083
With or without that fix, it is recommended that a revision range
2084
be given when using the -v option.
2086
bzr has a generic full-text matching plugin, bzr-search, that can be
2087
used to find revisions matching user names, commit messages, etc.
2088
Among other features, this plugin can find all revisions containing
2089
a list of words but not others.
2091
When exploring non-mainline history on large projects with deep
2092
history, the performance of log can be greatly improved by installing
2093
the historycache plugin. This plugin buffers historical information
2094
trading disk space for faster speed.
2096
takes_args = ['file*']
2097
_see_also = ['log-formats', 'revisionspec']
2100
help='Show from oldest to newest.'),
2102
custom_help('verbose',
2103
help='Show files changed in each revision.'),
2107
type=bzrlib.option._parse_revision_str,
2109
help='Show just the specified revision.'
2110
' See also "help revisionspec".'),
2114
help='Number of levels to display - 0 for all, 1 for flat.',
2116
type=_parse_levels),
2119
help='Show revisions whose message matches this '
2120
'regular expression.',
2124
help='Limit the output to the first N revisions.',
2129
help='Show changes made in each revision as a patch.'),
2130
Option('include-merges',
2131
help='Show merged revisions like --levels 0 does.'),
2133
encoding_type = 'replace'
2136
def run(self, file_list=None, timezone='original',
2147
include_merges=False):
2148
from bzrlib.log import (
2150
make_log_request_dict,
2151
_get_info_for_log_files,
2153
direction = (forward and 'forward') or 'reverse'
2158
raise errors.BzrCommandError(
2159
'--levels and --include-merges are mutually exclusive')
2161
if change is not None:
2163
raise errors.RangeInChangeOption()
2164
if revision is not None:
2165
raise errors.BzrCommandError(
2166
'--revision and --change are mutually exclusive')
2171
filter_by_dir = False
2173
# find the file ids to log and check for directory filtering
2174
b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2176
for relpath, file_id, kind in file_info_list:
2178
raise errors.BzrCommandError(
2179
"Path unknown at end or start of revision range: %s" %
2181
# If the relpath is the top of the tree, we log everything
2186
file_ids.append(file_id)
2187
filter_by_dir = filter_by_dir or (
2188
kind in ['directory', 'tree-reference'])
2191
# FIXME ? log the current subdir only RBC 20060203
2192
if revision is not None \
2193
and len(revision) > 0 and revision[0].get_branch():
2194
location = revision[0].get_branch()
2197
dir, relpath = bzrdir.BzrDir.open_containing(location)
2198
b = dir.open_branch()
2199
rev1, rev2 = _get_revision_range(revision, b, self.name())
2201
# Decide on the type of delta & diff filtering to use
2202
# TODO: add an --all-files option to make this configurable & consistent
2210
diff_type = 'partial'
2216
# Build the log formatter
2217
if log_format is None:
2218
log_format = log.log_formatter_registry.get_default(b)
2219
lf = log_format(show_ids=show_ids, to_file=self.outf,
2220
show_timezone=timezone,
2221
delta_format=get_verbosity_level(),
2223
show_advice=levels is None)
2225
# Choose the algorithm for doing the logging. It's annoying
2226
# having multiple code paths like this but necessary until
2227
# the underlying repository format is faster at generating
2228
# deltas or can provide everything we need from the indices.
2229
# The default algorithm - match-using-deltas - works for
2230
# multiple files and directories and is faster for small
2231
# amounts of history (200 revisions say). However, it's too
2232
# slow for logging a single file in a repository with deep
2233
# history, i.e. > 10K revisions. In the spirit of "do no
2234
# evil when adding features", we continue to use the
2235
# original algorithm - per-file-graph - for the "single
2236
# file that isn't a directory without showing a delta" case.
2237
partial_history = revision and b.repository._format.supports_chks
2238
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2239
or delta_type or partial_history)
2241
# Build the LogRequest and execute it
2242
if len(file_ids) == 0:
2244
rqst = make_log_request_dict(
2245
direction=direction, specific_fileids=file_ids,
2246
start_revision=rev1, end_revision=rev2, limit=limit,
2247
message_search=message, delta_type=delta_type,
2248
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2249
Logger(b, rqst).show(lf)
2254
def _get_revision_range(revisionspec_list, branch, command_name):
2255
"""Take the input of a revision option and turn it into a revision range.
2257
It returns RevisionInfo objects which can be used to obtain the rev_id's
2258
of the desired revisions. It does some user input validations.
2260
if revisionspec_list is None:
2263
elif len(revisionspec_list) == 1:
2264
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2265
elif len(revisionspec_list) == 2:
2266
start_spec = revisionspec_list[0]
2267
end_spec = revisionspec_list[1]
2268
if end_spec.get_branch() != start_spec.get_branch():
2269
# b is taken from revision[0].get_branch(), and
2270
# show_log will use its revision_history. Having
2271
# different branches will lead to weird behaviors.
2272
raise errors.BzrCommandError(
2273
"bzr %s doesn't accept two revisions in different"
2274
" branches." % command_name)
2275
rev1 = start_spec.in_history(branch)
2276
# Avoid loading all of history when we know a missing
2277
# end of range means the last revision ...
2278
if end_spec.spec is None:
2279
last_revno, last_revision_id = branch.last_revision_info()
2280
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2282
rev2 = end_spec.in_history(branch)
2284
raise errors.BzrCommandError(
2285
'bzr %s --revision takes one or two values.' % command_name)
2289
def _revision_range_to_revid_range(revision_range):
2292
if revision_range[0] is not None:
2293
rev_id1 = revision_range[0].rev_id
2294
if revision_range[1] is not None:
2295
rev_id2 = revision_range[1].rev_id
2296
return rev_id1, rev_id2
2298
def get_log_format(long=False, short=False, line=False, default='long'):
2299
log_format = default
2303
log_format = 'short'
2309
class cmd_touching_revisions(Command):
2310
"""Return revision-ids which affected a particular file.
2312
A more user-friendly interface is "bzr log FILE".
2316
takes_args = ["filename"]
2319
def run(self, filename):
2320
tree, relpath = WorkingTree.open_containing(filename)
2322
file_id = tree.path2id(relpath)
2323
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2324
self.outf.write("%6d %s\n" % (revno, what))
2327
class cmd_ls(Command):
2328
"""List files in a tree.
2331
_see_also = ['status', 'cat']
2332
takes_args = ['path?']
2336
Option('recursive', short_name='R',
2337
help='Recurse into subdirectories.'),
2339
help='Print paths relative to the root of the branch.'),
2340
Option('unknown', help='Print unknown files.'),
2341
Option('versioned', help='Print versioned files.',
2343
Option('ignored', help='Print ignored files.'),
2345
help='Write an ascii NUL (\\0) separator '
2346
'between files rather than a newline.'),
2348
help='List entries of a particular kind: file, directory, symlink.',
2353
def run(self, revision=None, verbose=False,
2354
recursive=False, from_root=False,
2355
unknown=False, versioned=False, ignored=False,
2356
null=False, kind=None, show_ids=False, path=None):
2358
if kind and kind not in ('file', 'directory', 'symlink'):
2359
raise errors.BzrCommandError('invalid kind specified')
2361
if verbose and null:
2362
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2363
all = not (unknown or versioned or ignored)
2365
selection = {'I':ignored, '?':unknown, 'V':versioned}
2372
raise errors.BzrCommandError('cannot specify both --from-root'
2376
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2382
if revision is not None or tree is None:
2383
tree = _get_one_revision_tree('ls', revision, branch=branch)
2386
if isinstance(tree, WorkingTree) and tree.supports_views():
2387
view_files = tree.views.lookup_view()
2390
view_str = views.view_display_str(view_files)
2391
note("Ignoring files outside view. View is %s" % view_str)
2395
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
2396
if fp.startswith(relpath):
2397
rp = fp[len(relpath):]
2398
fp = osutils.pathjoin(prefix, rp)
2399
if not recursive and '/' in rp:
2401
if not all and not selection[fc]:
2403
if kind is not None and fkind != kind:
2407
views.check_path_in_view(tree, fp)
2408
except errors.FileOutsideView:
2410
kindch = entry.kind_character()
2411
outstring = fp + kindch
2413
outstring = '%-8s %s' % (fc, outstring)
2414
if show_ids and fid is not None:
2415
outstring = "%-50s %s" % (outstring, fid)
2416
self.outf.write(outstring + '\n')
2418
self.outf.write(fp + '\0')
2421
self.outf.write(fid)
2422
self.outf.write('\0')
2430
self.outf.write('%-50s %s\n' % (outstring, my_id))
2432
self.outf.write(outstring + '\n')
2437
class cmd_unknowns(Command):
2438
"""List unknown files.
2446
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2447
self.outf.write(osutils.quotefn(f) + '\n')
2450
class cmd_ignore(Command):
2451
"""Ignore specified files or patterns.
2453
See ``bzr help patterns`` for details on the syntax of patterns.
2455
To remove patterns from the ignore list, edit the .bzrignore file.
2456
After adding, editing or deleting that file either indirectly by
2457
using this command or directly by using an editor, be sure to commit
2460
Note: ignore patterns containing shell wildcards must be quoted from
2464
Ignore the top level Makefile::
2466
bzr ignore ./Makefile
2468
Ignore class files in all directories::
2470
bzr ignore "*.class"
2472
Ignore .o files under the lib directory::
2474
bzr ignore "lib/**/*.o"
2476
Ignore .o files under the lib directory::
2478
bzr ignore "RE:lib/.*\.o"
2480
Ignore everything but the "debian" toplevel directory::
2482
bzr ignore "RE:(?!debian/).*"
2485
_see_also = ['status', 'ignored', 'patterns']
2486
takes_args = ['name_pattern*']
2488
Option('old-default-rules',
2489
help='Write out the ignore rules bzr < 0.9 always used.')
2492
def run(self, name_pattern_list=None, old_default_rules=None):
2493
from bzrlib import ignores
2494
if old_default_rules is not None:
2495
# dump the rules and exit
2496
for pattern in ignores.OLD_DEFAULTS:
2499
if not name_pattern_list:
2500
raise errors.BzrCommandError("ignore requires at least one "
2501
"NAME_PATTERN or --old-default-rules")
2502
name_pattern_list = [globbing.normalize_pattern(p)
2503
for p in name_pattern_list]
2504
for name_pattern in name_pattern_list:
2505
if (name_pattern[0] == '/' or
2506
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2507
raise errors.BzrCommandError(
2508
"NAME_PATTERN should not be an absolute path")
2509
tree, relpath = WorkingTree.open_containing(u'.')
2510
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2511
ignored = globbing.Globster(name_pattern_list)
2514
for entry in tree.list_files():
2518
if ignored.match(filename):
2519
matches.append(filename.encode('utf-8'))
2521
if len(matches) > 0:
2522
print "Warning: the following files are version controlled and" \
2523
" match your ignore pattern:\n%s" \
2524
"\nThese files will continue to be version controlled" \
2525
" unless you 'bzr remove' them." % ("\n".join(matches),)
2528
class cmd_ignored(Command):
2529
"""List ignored files and the patterns that matched them.
2531
List all the ignored files and the ignore pattern that caused the file to
2534
Alternatively, to list just the files::
2539
encoding_type = 'replace'
2540
_see_also = ['ignore', 'ls']
2544
tree = WorkingTree.open_containing(u'.')[0]
2547
for path, file_class, kind, file_id, entry in tree.list_files():
2548
if file_class != 'I':
2550
## XXX: Slightly inefficient since this was already calculated
2551
pat = tree.is_ignored(path)
2552
self.outf.write('%-50s %s\n' % (path, pat))
2557
class cmd_lookup_revision(Command):
2558
"""Lookup the revision-id from a revision-number
2561
bzr lookup-revision 33
2564
takes_args = ['revno']
2567
def run(self, revno):
2571
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2573
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2576
class cmd_export(Command):
2577
"""Export current or past revision to a destination directory or archive.
2579
If no revision is specified this exports the last committed revision.
2581
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2582
given, try to find the format with the extension. If no extension
2583
is found exports to a directory (equivalent to --format=dir).
2585
If root is supplied, it will be used as the root directory inside
2586
container formats (tar, zip, etc). If it is not supplied it will default
2587
to the exported filename. The root option has no effect for 'dir' format.
2589
If branch is omitted then the branch containing the current working
2590
directory will be used.
2592
Note: Export of tree with non-ASCII filenames to zip is not supported.
2594
================= =========================
2595
Supported formats Autodetected by extension
2596
================= =========================
2599
tbz2 .tar.bz2, .tbz2
2602
================= =========================
2604
takes_args = ['dest', 'branch_or_subdir?']
2607
help="Type of file to export to.",
2610
Option('filters', help='Apply content filters to export the '
2611
'convenient form.'),
2614
help="Name of the root directory inside the exported file."),
2616
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2617
root=None, filters=False):
2618
from bzrlib.export import export
2620
if branch_or_subdir is None:
2621
tree = WorkingTree.open_containing(u'.')[0]
2625
b, subdir = Branch.open_containing(branch_or_subdir)
2628
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2630
export(rev_tree, dest, format, root, subdir, filtered=filters)
2631
except errors.NoSuchExportFormat, e:
2632
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2635
class cmd_cat(Command):
2636
"""Write the contents of a file as of a given revision to standard output.
2638
If no revision is nominated, the last revision is used.
2640
Note: Take care to redirect standard output when using this command on a
2646
Option('name-from-revision', help='The path name in the old tree.'),
2647
Option('filters', help='Apply content filters to display the '
2648
'convenience form.'),
2651
takes_args = ['filename']
2652
encoding_type = 'exact'
2655
def run(self, filename, revision=None, name_from_revision=False,
2657
if revision is not None and len(revision) != 1:
2658
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2659
" one revision specifier")
2660
tree, branch, relpath = \
2661
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2664
return self._run(tree, branch, relpath, filename, revision,
2665
name_from_revision, filters)
2669
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2672
tree = b.basis_tree()
2673
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2675
old_file_id = rev_tree.path2id(relpath)
2677
if name_from_revision:
2678
# Try in revision if requested
2679
if old_file_id is None:
2680
raise errors.BzrCommandError(
2681
"%r is not present in revision %s" % (
2682
filename, rev_tree.get_revision_id()))
2684
content = rev_tree.get_file_text(old_file_id)
2686
cur_file_id = tree.path2id(relpath)
2688
if cur_file_id is not None:
2689
# Then try with the actual file id
2691
content = rev_tree.get_file_text(cur_file_id)
2693
except errors.NoSuchId:
2694
# The actual file id didn't exist at that time
2696
if not found and old_file_id is not None:
2697
# Finally try with the old file id
2698
content = rev_tree.get_file_text(old_file_id)
2701
# Can't be found anywhere
2702
raise errors.BzrCommandError(
2703
"%r is not present in revision %s" % (
2704
filename, rev_tree.get_revision_id()))
2706
from bzrlib.filters import (
2707
ContentFilterContext,
2708
filtered_output_bytes,
2710
filters = rev_tree._content_filter_stack(relpath)
2711
chunks = content.splitlines(True)
2712
content = filtered_output_bytes(chunks, filters,
2713
ContentFilterContext(relpath, rev_tree))
2714
self.outf.writelines(content)
2716
self.outf.write(content)
2719
class cmd_local_time_offset(Command):
2720
"""Show the offset in seconds from GMT to local time."""
2724
print osutils.local_time_offset()
2728
class cmd_commit(Command):
2729
"""Commit changes into a new revision.
2731
An explanatory message needs to be given for each commit. This is
2732
often done by using the --message option (getting the message from the
2733
command line) or by using the --file option (getting the message from
2734
a file). If neither of these options is given, an editor is opened for
2735
the user to enter the message. To see the changed files in the
2736
boilerplate text loaded into the editor, use the --show-diff option.
2738
By default, the entire tree is committed and the person doing the
2739
commit is assumed to be the author. These defaults can be overridden
2744
If selected files are specified, only changes to those files are
2745
committed. If a directory is specified then the directory and
2746
everything within it is committed.
2748
When excludes are given, they take precedence over selected files.
2749
For example, to commit only changes within foo, but not changes
2752
bzr commit foo -x foo/bar
2754
A selective commit after a merge is not yet supported.
2758
If the author of the change is not the same person as the committer,
2759
you can specify the author's name using the --author option. The
2760
name should be in the same format as a committer-id, e.g.
2761
"John Doe <jdoe@example.com>". If there is more than one author of
2762
the change you can specify the option multiple times, once for each
2767
A common mistake is to forget to add a new file or directory before
2768
running the commit command. The --strict option checks for unknown
2769
files and aborts the commit if any are found. More advanced pre-commit
2770
checks can be implemented by defining hooks. See ``bzr help hooks``
2775
If you accidentially commit the wrong changes or make a spelling
2776
mistake in the commit message say, you can use the uncommit command
2777
to undo it. See ``bzr help uncommit`` for details.
2779
Hooks can also be configured to run after a commit. This allows you
2780
to trigger updates to external systems like bug trackers. The --fixes
2781
option can be used to record the association between a revision and
2782
one or more bugs. See ``bzr help bugs`` for details.
2784
A selective commit may fail in some cases where the committed
2785
tree would be invalid. Consider::
2790
bzr commit foo -m "committing foo"
2791
bzr mv foo/bar foo/baz
2794
bzr commit foo/bar -m "committing bar but not baz"
2796
In the example above, the last commit will fail by design. This gives
2797
the user the opportunity to decide whether they want to commit the
2798
rename at the same time, separately first, or not at all. (As a general
2799
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2801
# TODO: Run hooks on tree to-be-committed, and after commit.
2803
# TODO: Strict commit that fails if there are deleted files.
2804
# (what does "deleted files" mean ??)
2806
# TODO: Give better message for -s, --summary, used by tla people
2808
# XXX: verbose currently does nothing
2810
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2811
takes_args = ['selected*']
2813
ListOption('exclude', type=str, short_name='x',
2814
help="Do not consider changes made to a given path."),
2815
Option('message', type=unicode,
2817
help="Description of the new revision."),
2820
help='Commit even if nothing has changed.'),
2821
Option('file', type=str,
2824
help='Take commit message from this file.'),
2826
help="Refuse to commit if there are unknown "
2827
"files in the working tree."),
2828
ListOption('fixes', type=str,
2829
help="Mark a bug as being fixed by this revision "
2830
"(see \"bzr help bugs\")."),
2831
ListOption('author', type=unicode,
2832
help="Set the author's name, if it's different "
2833
"from the committer."),
2835
help="Perform a local commit in a bound "
2836
"branch. Local commits are not pushed to "
2837
"the master branch until a normal commit "
2841
help='When no message is supplied, show the diff along'
2842
' with the status summary in the message editor.'),
2844
aliases = ['ci', 'checkin']
2846
def _iter_bug_fix_urls(self, fixes, branch):
2847
# Configure the properties for bug fixing attributes.
2848
for fixed_bug in fixes:
2849
tokens = fixed_bug.split(':')
2850
if len(tokens) != 2:
2851
raise errors.BzrCommandError(
2852
"Invalid bug %s. Must be in the form of 'tracker:id'. "
2853
"See \"bzr help bugs\" for more information on this "
2854
"feature.\nCommit refused." % fixed_bug)
2855
tag, bug_id = tokens
2857
yield bugtracker.get_bug_url(tag, branch, bug_id)
2858
except errors.UnknownBugTrackerAbbreviation:
2859
raise errors.BzrCommandError(
2860
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2861
except errors.MalformedBugIdentifier, e:
2862
raise errors.BzrCommandError(
2863
"%s\nCommit refused." % (str(e),))
2865
def run(self, message=None, file=None, verbose=False, selected_list=None,
2866
unchanged=False, strict=False, local=False, fixes=None,
2867
author=None, show_diff=False, exclude=None):
2868
from bzrlib.errors import (
2873
from bzrlib.msgeditor import (
2874
edit_commit_message_encoded,
2875
generate_commit_message_template,
2876
make_commit_message_template_encoded
2879
# TODO: Need a blackbox test for invoking the external editor; may be
2880
# slightly problematic to run this cross-platform.
2882
# TODO: do more checks that the commit will succeed before
2883
# spending the user's valuable time typing a commit message.
2887
tree, selected_list = tree_files(selected_list)
2888
if selected_list == ['']:
2889
# workaround - commit of root of tree should be exactly the same
2890
# as just default commit in that tree, and succeed even though
2891
# selected-file merge commit is not done yet
2896
bug_property = bugtracker.encode_fixes_bug_urls(
2897
self._iter_bug_fix_urls(fixes, tree.branch))
2899
properties['bugs'] = bug_property
2901
if local and not tree.branch.get_bound_location():
2902
raise errors.LocalRequiresBoundBranch()
2904
def get_message(commit_obj):
2905
"""Callback to get commit message"""
2906
my_message = message
2907
if my_message is None and not file:
2908
t = make_commit_message_template_encoded(tree,
2909
selected_list, diff=show_diff,
2910
output_encoding=osutils.get_user_encoding())
2911
start_message = generate_commit_message_template(commit_obj)
2912
my_message = edit_commit_message_encoded(t,
2913
start_message=start_message)
2914
if my_message is None:
2915
raise errors.BzrCommandError("please specify a commit"
2916
" message with either --message or --file")
2917
elif my_message and file:
2918
raise errors.BzrCommandError(
2919
"please specify either --message or --file")
2921
my_message = codecs.open(file, 'rt',
2922
osutils.get_user_encoding()).read()
2923
if my_message == "":
2924
raise errors.BzrCommandError("empty commit message specified")
2928
tree.commit(message_callback=get_message,
2929
specific_files=selected_list,
2930
allow_pointless=unchanged, strict=strict, local=local,
2931
reporter=None, verbose=verbose, revprops=properties,
2933
exclude=safe_relpath_files(tree, exclude))
2934
except PointlessCommit:
2935
# FIXME: This should really happen before the file is read in;
2936
# perhaps prepare the commit; get the message; then actually commit
2937
raise errors.BzrCommandError("No changes to commit."
2938
" Use --unchanged to commit anyhow.")
2939
except ConflictsInTree:
2940
raise errors.BzrCommandError('Conflicts detected in working '
2941
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2943
except StrictCommitFailed:
2944
raise errors.BzrCommandError("Commit refused because there are"
2945
" unknown files in the working tree.")
2946
except errors.BoundBranchOutOfDate, e:
2947
raise errors.BzrCommandError(str(e) + "\n"
2948
'To commit to master branch, run update and then commit.\n'
2949
'You can also pass --local to commit to continue working '
2953
class cmd_check(Command):
2954
"""Validate working tree structure, branch consistency and repository history.
2956
This command checks various invariants about branch and repository storage
2957
to detect data corruption or bzr bugs.
2959
The working tree and branch checks will only give output if a problem is
2960
detected. The output fields of the repository check are:
2962
revisions: This is just the number of revisions checked. It doesn't
2964
versionedfiles: This is just the number of versionedfiles checked. It
2965
doesn't indicate a problem.
2966
unreferenced ancestors: Texts that are ancestors of other texts, but
2967
are not properly referenced by the revision ancestry. This is a
2968
subtle problem that Bazaar can work around.
2969
unique file texts: This is the total number of unique file contents
2970
seen in the checked revisions. It does not indicate a problem.
2971
repeated file texts: This is the total number of repeated texts seen
2972
in the checked revisions. Texts can be repeated when their file
2973
entries are modified, but the file contents are not. It does not
2976
If no restrictions are specified, all Bazaar data that is found at the given
2977
location will be checked.
2981
Check the tree and branch at 'foo'::
2983
bzr check --tree --branch foo
2985
Check only the repository at 'bar'::
2987
bzr check --repo bar
2989
Check everything at 'baz'::
2994
_see_also = ['reconcile']
2995
takes_args = ['path?']
2996
takes_options = ['verbose',
2997
Option('branch', help="Check the branch related to the"
2998
" current directory."),
2999
Option('repo', help="Check the repository related to the"
3000
" current directory."),
3001
Option('tree', help="Check the working tree related to"
3002
" the current directory.")]
3004
def run(self, path=None, verbose=False, branch=False, repo=False,
3006
from bzrlib.check import check_dwim
3009
if not branch and not repo and not tree:
3010
branch = repo = tree = True
3011
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3014
class cmd_upgrade(Command):
3015
"""Upgrade branch storage to current format.
3017
The check command or bzr developers may sometimes advise you to run
3018
this command. When the default format has changed you may also be warned
3019
during other operations to upgrade.
3022
_see_also = ['check']
3023
takes_args = ['url?']
3025
RegistryOption('format',
3026
help='Upgrade to a specific format. See "bzr help'
3027
' formats" for details.',
3028
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3029
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3030
value_switches=True, title='Branch format'),
3033
def run(self, url='.', format=None):
3034
from bzrlib.upgrade import upgrade
3035
upgrade(url, format)
3038
class cmd_whoami(Command):
3039
"""Show or set bzr user id.
3042
Show the email of the current user::
3046
Set the current user::
3048
bzr whoami "Frank Chu <fchu@example.com>"
3050
takes_options = [ Option('email',
3051
help='Display email address only.'),
3053
help='Set identity for the current branch instead of '
3056
takes_args = ['name?']
3057
encoding_type = 'replace'
3060
def run(self, email=False, branch=False, name=None):
3062
# use branch if we're inside one; otherwise global config
3064
c = Branch.open_containing('.')[0].get_config()
3065
except errors.NotBranchError:
3066
c = config.GlobalConfig()
3068
self.outf.write(c.user_email() + '\n')
3070
self.outf.write(c.username() + '\n')
3073
# display a warning if an email address isn't included in the given name.
3075
config.extract_email_address(name)
3076
except errors.NoEmailInUsername, e:
3077
warning('"%s" does not seem to contain an email address. '
3078
'This is allowed, but not recommended.', name)
3080
# use global config unless --branch given
3082
c = Branch.open_containing('.')[0].get_config()
3084
c = config.GlobalConfig()
3085
c.set_user_option('email', name)
3088
class cmd_nick(Command):
3089
"""Print or set the branch nickname.
3091
If unset, the tree root directory name is used as the nickname.
3092
To print the current nickname, execute with no argument.
3094
Bound branches use the nickname of its master branch unless it is set
3098
_see_also = ['info']
3099
takes_args = ['nickname?']
3100
def run(self, nickname=None):
3101
branch = Branch.open_containing(u'.')[0]
3102
if nickname is None:
3103
self.printme(branch)
3105
branch.nick = nickname
3108
def printme(self, branch):
3112
class cmd_alias(Command):
3113
"""Set/unset and display aliases.
3116
Show the current aliases::
3120
Show the alias specified for 'll'::
3124
Set an alias for 'll'::
3126
bzr alias ll="log --line -r-10..-1"
3128
To remove an alias for 'll'::
3130
bzr alias --remove ll
3133
takes_args = ['name?']
3135
Option('remove', help='Remove the alias.'),
3138
def run(self, name=None, remove=False):
3140
self.remove_alias(name)
3142
self.print_aliases()
3144
equal_pos = name.find('=')
3146
self.print_alias(name)
3148
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3150
def remove_alias(self, alias_name):
3151
if alias_name is None:
3152
raise errors.BzrCommandError(
3153
'bzr alias --remove expects an alias to remove.')
3154
# If alias is not found, print something like:
3155
# unalias: foo: not found
3156
c = config.GlobalConfig()
3157
c.unset_alias(alias_name)
3160
def print_aliases(self):
3161
"""Print out the defined aliases in a similar format to bash."""
3162
aliases = config.GlobalConfig().get_aliases()
3163
for key, value in sorted(aliases.iteritems()):
3164
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3167
def print_alias(self, alias_name):
3168
from bzrlib.commands import get_alias
3169
alias = get_alias(alias_name)
3171
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3174
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3176
def set_alias(self, alias_name, alias_command):
3177
"""Save the alias in the global config."""
3178
c = config.GlobalConfig()
3179
c.set_alias(alias_name, alias_command)
3182
class cmd_selftest(Command):
3183
"""Run internal test suite.
3185
If arguments are given, they are regular expressions that say which tests
3186
should run. Tests matching any expression are run, and other tests are
3189
Alternatively if --first is given, matching tests are run first and then
3190
all other tests are run. This is useful if you have been working in a
3191
particular area, but want to make sure nothing else was broken.
3193
If --exclude is given, tests that match that regular expression are
3194
excluded, regardless of whether they match --first or not.
3196
To help catch accidential dependencies between tests, the --randomize
3197
option is useful. In most cases, the argument used is the word 'now'.
3198
Note that the seed used for the random number generator is displayed
3199
when this option is used. The seed can be explicitly passed as the
3200
argument to this option if required. This enables reproduction of the
3201
actual ordering used if and when an order sensitive problem is encountered.
3203
If --list-only is given, the tests that would be run are listed. This is
3204
useful when combined with --first, --exclude and/or --randomize to
3205
understand their impact. The test harness reports "Listed nn tests in ..."
3206
instead of "Ran nn tests in ..." when list mode is enabled.
3208
If the global option '--no-plugins' is given, plugins are not loaded
3209
before running the selftests. This has two effects: features provided or
3210
modified by plugins will not be tested, and tests provided by plugins will
3213
Tests that need working space on disk use a common temporary directory,
3214
typically inside $TMPDIR or /tmp.
3217
Run only tests relating to 'ignore'::
3221
Disable plugins and list tests as they're run::
3223
bzr --no-plugins selftest -v
3225
# NB: this is used from the class without creating an instance, which is
3226
# why it does not have a self parameter.
3227
def get_transport_type(typestring):
3228
"""Parse and return a transport specifier."""
3229
if typestring == "sftp":
3230
from bzrlib.transport.sftp import SFTPAbsoluteServer
3231
return SFTPAbsoluteServer
3232
if typestring == "memory":
3233
from bzrlib.transport.memory import MemoryServer
3235
if typestring == "fakenfs":
3236
from bzrlib.transport.fakenfs import FakeNFSServer
3237
return FakeNFSServer
3238
msg = "No known transport type %s. Supported types are: sftp\n" %\
3240
raise errors.BzrCommandError(msg)
3243
takes_args = ['testspecs*']
3244
takes_options = ['verbose',
3246
help='Stop when one test fails.',
3250
help='Use a different transport by default '
3251
'throughout the test suite.',
3252
type=get_transport_type),
3254
help='Run the benchmarks rather than selftests.'),
3255
Option('lsprof-timed',
3256
help='Generate lsprof output for benchmarked'
3257
' sections of code.'),
3258
Option('cache-dir', type=str,
3259
help='Cache intermediate benchmark output in this '
3262
help='Run all tests, but run specified tests first.',
3266
help='List the tests instead of running them.'),
3267
RegistryOption('parallel',
3268
help="Run the test suite in parallel.",
3269
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3270
value_switches=False,
3272
Option('randomize', type=str, argname="SEED",
3273
help='Randomize the order of tests using the given'
3274
' seed or "now" for the current time.'),
3275
Option('exclude', type=str, argname="PATTERN",
3277
help='Exclude tests that match this regular'
3280
help='Output test progress via subunit.'),
3281
Option('strict', help='Fail on missing dependencies or '
3283
Option('load-list', type=str, argname='TESTLISTFILE',
3284
help='Load a test id list from a text file.'),
3285
ListOption('debugflag', type=str, short_name='E',
3286
help='Turn on a selftest debug flag.'),
3287
ListOption('starting-with', type=str, argname='TESTID',
3288
param_name='starting_with', short_name='s',
3290
'Load only the tests starting with TESTID.'),
3292
encoding_type = 'replace'
3295
Command.__init__(self)
3296
self.additional_selftest_args = {}
3298
def run(self, testspecs_list=None, verbose=False, one=False,
3299
transport=None, benchmark=None,
3300
lsprof_timed=None, cache_dir=None,
3301
first=False, list_only=False,
3302
randomize=None, exclude=None, strict=False,
3303
load_list=None, debugflag=None, starting_with=None, subunit=False,
3305
from bzrlib.tests import selftest
3306
import bzrlib.benchmarks as benchmarks
3307
from bzrlib.benchmarks import tree_creator
3309
# Make deprecation warnings visible, unless -Werror is set
3310
symbol_versioning.activate_deprecation_warnings(override=False)
3312
if cache_dir is not None:
3313
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3314
if testspecs_list is not None:
3315
pattern = '|'.join(testspecs_list)
3320
from bzrlib.tests import SubUnitBzrRunner
3322
raise errors.BzrCommandError("subunit not available. subunit "
3323
"needs to be installed to use --subunit.")
3324
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3326
self.additional_selftest_args.setdefault(
3327
'suite_decorators', []).append(parallel)
3329
test_suite_factory = benchmarks.test_suite
3330
# Unless user explicitly asks for quiet, be verbose in benchmarks
3331
verbose = not is_quiet()
3332
# TODO: should possibly lock the history file...
3333
benchfile = open(".perf_history", "at", buffering=1)
3335
test_suite_factory = None
3338
selftest_kwargs = {"verbose": verbose,
3340
"stop_on_failure": one,
3341
"transport": transport,
3342
"test_suite_factory": test_suite_factory,
3343
"lsprof_timed": lsprof_timed,
3344
"bench_history": benchfile,
3345
"matching_tests_first": first,
3346
"list_only": list_only,
3347
"random_seed": randomize,
3348
"exclude_pattern": exclude,
3350
"load_list": load_list,
3351
"debug_flags": debugflag,
3352
"starting_with": starting_with
3354
selftest_kwargs.update(self.additional_selftest_args)
3355
result = selftest(**selftest_kwargs)
3357
if benchfile is not None:
3359
return int(not result)
3362
class cmd_version(Command):
3363
"""Show version of bzr."""
3365
encoding_type = 'replace'
3367
Option("short", help="Print just the version number."),
3371
def run(self, short=False):
3372
from bzrlib.version import show_version
3374
self.outf.write(bzrlib.version_string + '\n')
3376
show_version(to_file=self.outf)
3379
class cmd_rocks(Command):
3380
"""Statement of optimism."""
3386
print "It sure does!"
3389
class cmd_find_merge_base(Command):
3390
"""Find and print a base revision for merging two branches."""
3391
# TODO: Options to specify revisions on either side, as if
3392
# merging only part of the history.
3393
takes_args = ['branch', 'other']
3397
def run(self, branch, other):
3398
from bzrlib.revision import ensure_null
3400
branch1 = Branch.open_containing(branch)[0]
3401
branch2 = Branch.open_containing(other)[0]
3406
last1 = ensure_null(branch1.last_revision())
3407
last2 = ensure_null(branch2.last_revision())
3409
graph = branch1.repository.get_graph(branch2.repository)
3410
base_rev_id = graph.find_unique_lca(last1, last2)
3412
print 'merge base is revision %s' % base_rev_id
3419
class cmd_merge(Command):
3420
"""Perform a three-way merge.
3422
The source of the merge can be specified either in the form of a branch,
3423
or in the form of a path to a file containing a merge directive generated
3424
with bzr send. If neither is specified, the default is the upstream branch
3425
or the branch most recently merged using --remember.
3427
When merging a branch, by default the tip will be merged. To pick a different
3428
revision, pass --revision. If you specify two values, the first will be used as
3429
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3430
available revisions, like this is commonly referred to as "cherrypicking".
3432
Revision numbers are always relative to the branch being merged.
3434
By default, bzr will try to merge in all new work from the other
3435
branch, automatically determining an appropriate base. If this
3436
fails, you may need to give an explicit base.
3438
Merge will do its best to combine the changes in two branches, but there
3439
are some kinds of problems only a human can fix. When it encounters those,
3440
it will mark a conflict. A conflict means that you need to fix something,
3441
before you should commit.
3443
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3445
If there is no default branch set, the first merge will set it. After
3446
that, you can omit the branch to use the default. To change the
3447
default, use --remember. The value will only be saved if the remote
3448
location can be accessed.
3450
The results of the merge are placed into the destination working
3451
directory, where they can be reviewed (with bzr diff), tested, and then
3452
committed to record the result of the merge.
3454
merge refuses to run if there are any uncommitted changes, unless
3458
To merge the latest revision from bzr.dev::
3460
bzr merge ../bzr.dev
3462
To merge changes up to and including revision 82 from bzr.dev::
3464
bzr merge -r 82 ../bzr.dev
3466
To merge the changes introduced by 82, without previous changes::
3468
bzr merge -r 81..82 ../bzr.dev
3470
To apply a merge directive contained in /tmp/merge:
3472
bzr merge /tmp/merge
3475
encoding_type = 'exact'
3476
_see_also = ['update', 'remerge', 'status-flags', 'send']
3477
takes_args = ['location?']
3482
help='Merge even if the destination tree has uncommitted changes.'),
3486
Option('show-base', help="Show base revision text in "
3488
Option('uncommitted', help='Apply uncommitted changes'
3489
' from a working copy, instead of branch changes.'),
3490
Option('pull', help='If the destination is already'
3491
' completely merged into the source, pull from the'
3492
' source rather than merging. When this happens,'
3493
' you do not need to commit the result.'),
3495
help='Branch to merge into, '
3496
'rather than the one containing the working directory.',
3500
Option('preview', help='Instead of merging, show a diff of the merge.')
3503
def run(self, location=None, revision=None, force=False,
3504
merge_type=None, show_base=False, reprocess=None, remember=False,
3505
uncommitted=False, pull=False,
3509
if merge_type is None:
3510
merge_type = _mod_merge.Merge3Merger
3512
if directory is None: directory = u'.'
3513
possible_transports = []
3515
allow_pending = True
3516
verified = 'inapplicable'
3517
tree = WorkingTree.open_containing(directory)[0]
3519
# die as quickly as possible if there are uncommitted changes
3521
basis_tree = tree.revision_tree(tree.last_revision())
3522
except errors.NoSuchRevision:
3523
basis_tree = tree.basis_tree()
3525
changes = tree.changes_from(basis_tree)
3526
if changes.has_changed():
3527
raise errors.UncommittedChanges(tree)
3529
view_info = _get_view_info_for_change_reporter(tree)
3530
change_reporter = delta._ChangeReporter(
3531
unversioned_filter=tree.is_ignored, view_info=view_info)
3534
pb = ui.ui_factory.nested_progress_bar()
3535
cleanups.append(pb.finished)
3537
cleanups.append(tree.unlock)
3538
if location is not None:
3540
mergeable = bundle.read_mergeable_from_url(location,
3541
possible_transports=possible_transports)
3542
except errors.NotABundle:
3546
raise errors.BzrCommandError('Cannot use --uncommitted'
3547
' with bundles or merge directives.')
3549
if revision is not None:
3550
raise errors.BzrCommandError(
3551
'Cannot use -r with merge directives or bundles')
3552
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3555
if merger is None and uncommitted:
3556
if revision is not None and len(revision) > 0:
3557
raise errors.BzrCommandError('Cannot use --uncommitted and'
3558
' --revision at the same time.')
3559
location = self._select_branch_location(tree, location)[0]
3560
other_tree, other_path = WorkingTree.open_containing(location)
3561
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
3563
allow_pending = False
3564
if other_path != '':
3565
merger.interesting_files = [other_path]
3568
merger, allow_pending = self._get_merger_from_branch(tree,
3569
location, revision, remember, possible_transports, pb)
3571
merger.merge_type = merge_type
3572
merger.reprocess = reprocess
3573
merger.show_base = show_base
3574
self.sanity_check_merger(merger)
3575
if (merger.base_rev_id == merger.other_rev_id and
3576
merger.other_rev_id is not None):
3577
note('Nothing to do.')
3580
if merger.interesting_files is not None:
3581
raise errors.BzrCommandError('Cannot pull individual files')
3582
if (merger.base_rev_id == tree.last_revision()):
3583
result = tree.pull(merger.other_branch, False,
3584
merger.other_rev_id)
3585
result.report(self.outf)
3587
merger.check_basis(False)
3589
return self._do_preview(merger)
3591
return self._do_merge(merger, change_reporter, allow_pending,
3594
for cleanup in reversed(cleanups):
3597
def _do_preview(self, merger):
3598
from bzrlib.diff import show_diff_trees
3599
tree_merger = merger.make_merger()
3600
tt = tree_merger.make_preview_transform()
3602
result_tree = tt.get_preview_tree()
3603
show_diff_trees(merger.this_tree, result_tree, self.outf,
3604
old_label='', new_label='')
3608
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3609
merger.change_reporter = change_reporter
3610
conflict_count = merger.do_merge()
3612
merger.set_pending()
3613
if verified == 'failed':
3614
warning('Preview patch does not match changes')
3615
if conflict_count != 0:
3620
def sanity_check_merger(self, merger):
3621
if (merger.show_base and
3622
not merger.merge_type is _mod_merge.Merge3Merger):
3623
raise errors.BzrCommandError("Show-base is not supported for this"
3624
" merge type. %s" % merger.merge_type)
3625
if merger.reprocess is None:
3626
if merger.show_base:
3627
merger.reprocess = False
3629
# Use reprocess if the merger supports it
3630
merger.reprocess = merger.merge_type.supports_reprocess
3631
if merger.reprocess and not merger.merge_type.supports_reprocess:
3632
raise errors.BzrCommandError("Conflict reduction is not supported"
3633
" for merge type %s." %
3635
if merger.reprocess and merger.show_base:
3636
raise errors.BzrCommandError("Cannot do conflict reduction and"
3639
def _get_merger_from_branch(self, tree, location, revision, remember,
3640
possible_transports, pb):
3641
"""Produce a merger from a location, assuming it refers to a branch."""
3642
from bzrlib.tag import _merge_tags_if_possible
3643
# find the branch locations
3644
other_loc, user_location = self._select_branch_location(tree, location,
3646
if revision is not None and len(revision) == 2:
3647
base_loc, _unused = self._select_branch_location(tree,
3648
location, revision, 0)
3650
base_loc = other_loc
3652
other_branch, other_path = Branch.open_containing(other_loc,
3653
possible_transports)
3654
if base_loc == other_loc:
3655
base_branch = other_branch
3657
base_branch, base_path = Branch.open_containing(base_loc,
3658
possible_transports)
3659
# Find the revision ids
3660
if revision is None or len(revision) < 1 or revision[-1] is None:
3661
other_revision_id = _mod_revision.ensure_null(
3662
other_branch.last_revision())
3664
other_revision_id = revision[-1].as_revision_id(other_branch)
3665
if (revision is not None and len(revision) == 2
3666
and revision[0] is not None):
3667
base_revision_id = revision[0].as_revision_id(base_branch)
3669
base_revision_id = None
3670
# Remember where we merge from
3671
if ((remember or tree.branch.get_submit_branch() is None) and
3672
user_location is not None):
3673
tree.branch.set_submit_branch(other_branch.base)
3674
_merge_tags_if_possible(other_branch, tree.branch)
3675
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3676
other_revision_id, base_revision_id, other_branch, base_branch)
3677
if other_path != '':
3678
allow_pending = False
3679
merger.interesting_files = [other_path]
3681
allow_pending = True
3682
return merger, allow_pending
3684
def _select_branch_location(self, tree, user_location, revision=None,
3686
"""Select a branch location, according to possible inputs.
3688
If provided, branches from ``revision`` are preferred. (Both
3689
``revision`` and ``index`` must be supplied.)
3691
Otherwise, the ``location`` parameter is used. If it is None, then the
3692
``submit`` or ``parent`` location is used, and a note is printed.
3694
:param tree: The working tree to select a branch for merging into
3695
:param location: The location entered by the user
3696
:param revision: The revision parameter to the command
3697
:param index: The index to use for the revision parameter. Negative
3698
indices are permitted.
3699
:return: (selected_location, user_location). The default location
3700
will be the user-entered location.
3702
if (revision is not None and index is not None
3703
and revision[index] is not None):
3704
branch = revision[index].get_branch()
3705
if branch is not None:
3706
return branch, branch
3707
if user_location is None:
3708
location = self._get_remembered(tree, 'Merging from')
3710
location = user_location
3711
return location, user_location
3713
def _get_remembered(self, tree, verb_string):
3714
"""Use tree.branch's parent if none was supplied.
3716
Report if the remembered location was used.
3718
stored_location = tree.branch.get_submit_branch()
3719
stored_location_type = "submit"
3720
if stored_location is None:
3721
stored_location = tree.branch.get_parent()
3722
stored_location_type = "parent"
3723
mutter("%s", stored_location)
3724
if stored_location is None:
3725
raise errors.BzrCommandError("No location specified or remembered")
3726
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3727
note(u"%s remembered %s location %s", verb_string,
3728
stored_location_type, display_url)
3729
return stored_location
3732
class cmd_remerge(Command):
3735
Use this if you want to try a different merge technique while resolving
3736
conflicts. Some merge techniques are better than others, and remerge
3737
lets you try different ones on different files.
3739
The options for remerge have the same meaning and defaults as the ones for
3740
merge. The difference is that remerge can (only) be run when there is a
3741
pending merge, and it lets you specify particular files.
3744
Re-do the merge of all conflicted files, and show the base text in
3745
conflict regions, in addition to the usual THIS and OTHER texts::
3747
bzr remerge --show-base
3749
Re-do the merge of "foobar", using the weave merge algorithm, with
3750
additional processing to reduce the size of conflict regions::
3752
bzr remerge --merge-type weave --reprocess foobar
3754
takes_args = ['file*']
3759
help="Show base revision text in conflicts."),
3762
def run(self, file_list=None, merge_type=None, show_base=False,
3764
if merge_type is None:
3765
merge_type = _mod_merge.Merge3Merger
3766
tree, file_list = tree_files(file_list)
3769
parents = tree.get_parent_ids()
3770
if len(parents) != 2:
3771
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3772
" merges. Not cherrypicking or"
3774
repository = tree.branch.repository
3775
interesting_ids = None
3777
conflicts = tree.conflicts()
3778
if file_list is not None:
3779
interesting_ids = set()
3780
for filename in file_list:
3781
file_id = tree.path2id(filename)
3783
raise errors.NotVersionedError(filename)
3784
interesting_ids.add(file_id)
3785
if tree.kind(file_id) != "directory":
3788
for name, ie in tree.inventory.iter_entries(file_id):
3789
interesting_ids.add(ie.file_id)
3790
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3792
# Remerge only supports resolving contents conflicts
3793
allowed_conflicts = ('text conflict', 'contents conflict')
3794
restore_files = [c.path for c in conflicts
3795
if c.typestring in allowed_conflicts]
3796
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3797
tree.set_conflicts(ConflictList(new_conflicts))
3798
if file_list is not None:
3799
restore_files = file_list
3800
for filename in restore_files:
3802
restore(tree.abspath(filename))
3803
except errors.NotConflicted:
3805
# Disable pending merges, because the file texts we are remerging
3806
# have not had those merges performed. If we use the wrong parents
3807
# list, we imply that the working tree text has seen and rejected
3808
# all the changes from the other tree, when in fact those changes
3809
# have not yet been seen.
3810
pb = ui.ui_factory.nested_progress_bar()
3811
tree.set_parent_ids(parents[:1])
3813
merger = _mod_merge.Merger.from_revision_ids(pb,
3815
merger.interesting_ids = interesting_ids
3816
merger.merge_type = merge_type
3817
merger.show_base = show_base
3818
merger.reprocess = reprocess
3819
conflicts = merger.do_merge()
3821
tree.set_parent_ids(parents)
3831
class cmd_revert(Command):
3832
"""Revert files to a previous revision.
3834
Giving a list of files will revert only those files. Otherwise, all files
3835
will be reverted. If the revision is not specified with '--revision', the
3836
last committed revision is used.
3838
To remove only some changes, without reverting to a prior version, use
3839
merge instead. For example, "merge . --revision -2..-3" will remove the
3840
changes introduced by -2, without affecting the changes introduced by -1.
3841
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3843
By default, any files that have been manually changed will be backed up
3844
first. (Files changed only by merge are not backed up.) Backup files have
3845
'.~#~' appended to their name, where # is a number.
3847
When you provide files, you can use their current pathname or the pathname
3848
from the target revision. So you can use revert to "undelete" a file by
3849
name. If you name a directory, all the contents of that directory will be
3852
Any files that have been newly added since that revision will be deleted,
3853
with a backup kept if appropriate. Directories containing unknown files
3854
will not be deleted.
3856
The working tree contains a list of pending merged revisions, which will
3857
be included as parents in the next commit. Normally, revert clears that
3858
list as well as reverting the files. If any files are specified, revert
3859
leaves the pending merge list alone and reverts only the files. Use "bzr
3860
revert ." in the tree root to revert all files but keep the merge record,
3861
and "bzr revert --forget-merges" to clear the pending merge list without
3862
reverting any files.
3865
_see_also = ['cat', 'export']
3868
Option('no-backup', "Do not save backups of reverted files."),
3869
Option('forget-merges',
3870
'Remove pending merge marker, without changing any files.'),
3872
takes_args = ['file*']
3874
def run(self, revision=None, no_backup=False, file_list=None,
3875
forget_merges=None):
3876
tree, file_list = tree_files(file_list)
3880
tree.set_parent_ids(tree.get_parent_ids()[:1])
3882
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3887
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3888
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3889
pb = ui.ui_factory.nested_progress_bar()
3891
tree.revert(file_list, rev_tree, not no_backup, pb,
3892
report_changes=True)
3897
class cmd_assert_fail(Command):
3898
"""Test reporting of assertion failures"""
3899
# intended just for use in testing
3904
raise AssertionError("always fails")
3907
class cmd_help(Command):
3908
"""Show help on a command or other topic.
3911
_see_also = ['topics']
3913
Option('long', 'Show help on all commands.'),
3915
takes_args = ['topic?']
3916
aliases = ['?', '--help', '-?', '-h']
3919
def run(self, topic=None, long=False):
3921
if topic is None and long:
3923
bzrlib.help.help(topic)
3926
class cmd_shell_complete(Command):
3927
"""Show appropriate completions for context.
3929
For a list of all available commands, say 'bzr shell-complete'.
3931
takes_args = ['context?']
3936
def run(self, context=None):
3937
import shellcomplete
3938
shellcomplete.shellcomplete(context)
3941
class cmd_missing(Command):
3942
"""Show unmerged/unpulled revisions between two branches.
3944
OTHER_BRANCH may be local or remote.
3946
To filter on a range of revisions, you can use the command -r begin..end
3947
-r revision requests a specific revision, -r ..end or -r begin.. are
3952
Determine the missing revisions between this and the branch at the
3953
remembered pull location::
3957
Determine the missing revisions between this and another branch::
3959
bzr missing http://server/branch
3961
Determine the missing revisions up to a specific revision on the other
3964
bzr missing -r ..-10
3966
Determine the missing revisions up to a specific revision on this
3969
bzr missing --my-revision ..-10
3972
_see_also = ['merge', 'pull']
3973
takes_args = ['other_branch?']
3975
Option('reverse', 'Reverse the order of revisions.'),
3977
'Display changes in the local branch only.'),
3978
Option('this' , 'Same as --mine-only.'),
3979
Option('theirs-only',
3980
'Display changes in the remote branch only.'),
3981
Option('other', 'Same as --theirs-only.'),
3985
custom_help('revision',
3986
help='Filter on other branch revisions (inclusive). '
3987
'See "help revisionspec" for details.'),
3988
Option('my-revision',
3989
type=_parse_revision_str,
3990
help='Filter on local branch revisions (inclusive). '
3991
'See "help revisionspec" for details.'),
3992
Option('include-merges',
3993
'Show all revisions in addition to the mainline ones.'),
3995
encoding_type = 'replace'
3998
def run(self, other_branch=None, reverse=False, mine_only=False,
4000
log_format=None, long=False, short=False, line=False,
4001
show_ids=False, verbose=False, this=False, other=False,
4002
include_merges=False, revision=None, my_revision=None):
4003
from bzrlib.missing import find_unmerged, iter_log_revisions
4012
# TODO: We should probably check that we don't have mine-only and
4013
# theirs-only set, but it gets complicated because we also have
4014
# this and other which could be used.
4021
local_branch = Branch.open_containing(u".")[0]
4022
parent = local_branch.get_parent()
4023
if other_branch is None:
4024
other_branch = parent
4025
if other_branch is None:
4026
raise errors.BzrCommandError("No peer location known"
4028
display_url = urlutils.unescape_for_display(parent,
4030
message("Using saved parent location: "
4031
+ display_url + "\n")
4033
remote_branch = Branch.open(other_branch)
4034
if remote_branch.base == local_branch.base:
4035
remote_branch = local_branch
4037
local_revid_range = _revision_range_to_revid_range(
4038
_get_revision_range(my_revision, local_branch,
4041
remote_revid_range = _revision_range_to_revid_range(
4042
_get_revision_range(revision,
4043
remote_branch, self.name()))
4045
local_branch.lock_read()
4047
remote_branch.lock_read()
4049
local_extra, remote_extra = find_unmerged(
4050
local_branch, remote_branch, restrict,
4051
backward=not reverse,
4052
include_merges=include_merges,
4053
local_revid_range=local_revid_range,
4054
remote_revid_range=remote_revid_range)
4056
if log_format is None:
4057
registry = log.log_formatter_registry
4058
log_format = registry.get_default(local_branch)
4059
lf = log_format(to_file=self.outf,
4061
show_timezone='original')
4064
if local_extra and not theirs_only:
4065
message("You have %d extra revision(s):\n" %
4067
for revision in iter_log_revisions(local_extra,
4068
local_branch.repository,
4070
lf.log_revision(revision)
4071
printed_local = True
4074
printed_local = False
4076
if remote_extra and not mine_only:
4077
if printed_local is True:
4079
message("You are missing %d revision(s):\n" %
4081
for revision in iter_log_revisions(remote_extra,
4082
remote_branch.repository,
4084
lf.log_revision(revision)
4087
if mine_only and not local_extra:
4088
# We checked local, and found nothing extra
4089
message('This branch is up to date.\n')
4090
elif theirs_only and not remote_extra:
4091
# We checked remote, and found nothing extra
4092
message('Other branch is up to date.\n')
4093
elif not (mine_only or theirs_only or local_extra or
4095
# We checked both branches, and neither one had extra
4097
message("Branches are up to date.\n")
4099
remote_branch.unlock()
4101
local_branch.unlock()
4102
if not status_code and parent is None and other_branch is not None:
4103
local_branch.lock_write()
4105
# handle race conditions - a parent might be set while we run.
4106
if local_branch.get_parent() is None:
4107
local_branch.set_parent(remote_branch.base)
4109
local_branch.unlock()
4113
class cmd_pack(Command):
4114
"""Compress the data within a repository."""
4116
_see_also = ['repositories']
4117
takes_args = ['branch_or_repo?']
4119
def run(self, branch_or_repo='.'):
4120
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4122
branch = dir.open_branch()
4123
repository = branch.repository
4124
except errors.NotBranchError:
4125
repository = dir.open_repository()
4129
class cmd_plugins(Command):
4130
"""List the installed plugins.
4132
This command displays the list of installed plugins including
4133
version of plugin and a short description of each.
4135
--verbose shows the path where each plugin is located.
4137
A plugin is an external component for Bazaar that extends the
4138
revision control system, by adding or replacing code in Bazaar.
4139
Plugins can do a variety of things, including overriding commands,
4140
adding new commands, providing additional network transports and
4141
customizing log output.
4143
See the Bazaar web site, http://bazaar-vcs.org, for further
4144
information on plugins including where to find them and how to
4145
install them. Instructions are also provided there on how to
4146
write new plugins using the Python programming language.
4148
takes_options = ['verbose']
4151
def run(self, verbose=False):
4152
import bzrlib.plugin
4153
from inspect import getdoc
4155
for name, plugin in bzrlib.plugin.plugins().items():
4156
version = plugin.__version__
4157
if version == 'unknown':
4159
name_ver = '%s %s' % (name, version)
4160
d = getdoc(plugin.module)
4162
doc = d.split('\n')[0]
4164
doc = '(no description)'
4165
result.append((name_ver, doc, plugin.path()))
4166
for name_ver, doc, path in sorted(result):
4174
class cmd_testament(Command):
4175
"""Show testament (signing-form) of a revision."""
4178
Option('long', help='Produce long-format testament.'),
4180
help='Produce a strict-format testament.')]
4181
takes_args = ['branch?']
4183
def run(self, branch=u'.', revision=None, long=False, strict=False):
4184
from bzrlib.testament import Testament, StrictTestament
4186
testament_class = StrictTestament
4188
testament_class = Testament
4190
b = Branch.open_containing(branch)[0]
4192
b = Branch.open(branch)
4195
if revision is None:
4196
rev_id = b.last_revision()
4198
rev_id = revision[0].as_revision_id(b)
4199
t = testament_class.from_revision(b.repository, rev_id)
4201
sys.stdout.writelines(t.as_text_lines())
4203
sys.stdout.write(t.as_short_text())
4208
class cmd_annotate(Command):
4209
"""Show the origin of each line in a file.
4211
This prints out the given file with an annotation on the left side
4212
indicating which revision, author and date introduced the change.
4214
If the origin is the same for a run of consecutive lines, it is
4215
shown only at the top, unless the --all option is given.
4217
# TODO: annotate directories; showing when each file was last changed
4218
# TODO: if the working copy is modified, show annotations on that
4219
# with new uncommitted lines marked
4220
aliases = ['ann', 'blame', 'praise']
4221
takes_args = ['filename']
4222
takes_options = [Option('all', help='Show annotations on all lines.'),
4223
Option('long', help='Show commit date in annotations.'),
4227
encoding_type = 'exact'
4230
def run(self, filename, all=False, long=False, revision=None,
4232
from bzrlib.annotate import annotate_file, annotate_file_tree
4233
wt, branch, relpath = \
4234
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4240
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4242
file_id = wt.path2id(relpath)
4244
file_id = tree.path2id(relpath)
4246
raise errors.NotVersionedError(filename)
4247
file_version = tree.inventory[file_id].revision
4248
if wt is not None and revision is None:
4249
# If there is a tree and we're not annotating historical
4250
# versions, annotate the working tree's content.
4251
annotate_file_tree(wt, file_id, self.outf, long, all,
4254
annotate_file(branch, file_version, file_id, long, all, self.outf,
4263
class cmd_re_sign(Command):
4264
"""Create a digital signature for an existing revision."""
4265
# TODO be able to replace existing ones.
4267
hidden = True # is this right ?
4268
takes_args = ['revision_id*']
4269
takes_options = ['revision']
4271
def run(self, revision_id_list=None, revision=None):
4272
if revision_id_list is not None and revision is not None:
4273
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4274
if revision_id_list is None and revision is None:
4275
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4276
b = WorkingTree.open_containing(u'.')[0].branch
4279
return self._run(b, revision_id_list, revision)
4283
def _run(self, b, revision_id_list, revision):
4284
import bzrlib.gpg as gpg
4285
gpg_strategy = gpg.GPGStrategy(b.get_config())
4286
if revision_id_list is not None:
4287
b.repository.start_write_group()
4289
for revision_id in revision_id_list:
4290
b.repository.sign_revision(revision_id, gpg_strategy)
4292
b.repository.abort_write_group()
4295
b.repository.commit_write_group()
4296
elif revision is not None:
4297
if len(revision) == 1:
4298
revno, rev_id = revision[0].in_history(b)
4299
b.repository.start_write_group()
4301
b.repository.sign_revision(rev_id, gpg_strategy)
4303
b.repository.abort_write_group()
4306
b.repository.commit_write_group()
4307
elif len(revision) == 2:
4308
# are they both on rh- if so we can walk between them
4309
# might be nice to have a range helper for arbitrary
4310
# revision paths. hmm.
4311
from_revno, from_revid = revision[0].in_history(b)
4312
to_revno, to_revid = revision[1].in_history(b)
4313
if to_revid is None:
4314
to_revno = b.revno()
4315
if from_revno is None or to_revno is None:
4316
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4317
b.repository.start_write_group()
4319
for revno in range(from_revno, to_revno + 1):
4320
b.repository.sign_revision(b.get_rev_id(revno),
4323
b.repository.abort_write_group()
4326
b.repository.commit_write_group()
4328
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4331
class cmd_bind(Command):
4332
"""Convert the current branch into a checkout of the supplied branch.
4334
Once converted into a checkout, commits must succeed on the master branch
4335
before they will be applied to the local branch.
4337
Bound branches use the nickname of its master branch unless it is set
4338
locally, in which case binding will update the the local nickname to be
4342
_see_also = ['checkouts', 'unbind']
4343
takes_args = ['location?']
4346
def run(self, location=None):
4347
b, relpath = Branch.open_containing(u'.')
4348
if location is None:
4350
location = b.get_old_bound_location()
4351
except errors.UpgradeRequired:
4352
raise errors.BzrCommandError('No location supplied. '
4353
'This format does not remember old locations.')
4355
if location is None:
4356
raise errors.BzrCommandError('No location supplied and no '
4357
'previous location known')
4358
b_other = Branch.open(location)
4361
except errors.DivergedBranches:
4362
raise errors.BzrCommandError('These branches have diverged.'
4363
' Try merging, and then bind again.')
4364
if b.get_config().has_explicit_nickname():
4365
b.nick = b_other.nick
4368
class cmd_unbind(Command):
4369
"""Convert the current checkout into a regular branch.
4371
After unbinding, the local branch is considered independent and subsequent
4372
commits will be local only.
4375
_see_also = ['checkouts', 'bind']
4380
b, relpath = Branch.open_containing(u'.')
4382
raise errors.BzrCommandError('Local branch is not bound')
4385
class cmd_uncommit(Command):
4386
"""Remove the last committed revision.
4388
--verbose will print out what is being removed.
4389
--dry-run will go through all the motions, but not actually
4392
If --revision is specified, uncommit revisions to leave the branch at the
4393
specified revision. For example, "bzr uncommit -r 15" will leave the
4394
branch at revision 15.
4396
Uncommit leaves the working tree ready for a new commit. The only change
4397
it may make is to restore any pending merges that were present before
4401
# TODO: jam 20060108 Add an option to allow uncommit to remove
4402
# unreferenced information in 'branch-as-repository' branches.
4403
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4404
# information in shared branches as well.
4405
_see_also = ['commit']
4406
takes_options = ['verbose', 'revision',
4407
Option('dry-run', help='Don\'t actually make changes.'),
4408
Option('force', help='Say yes to all questions.'),
4410
help="Only remove the commits from the local branch"
4411
" when in a checkout."
4414
takes_args = ['location?']
4416
encoding_type = 'replace'
4418
def run(self, location=None,
4419
dry_run=False, verbose=False,
4420
revision=None, force=False, local=False):
4421
if location is None:
4423
control, relpath = bzrdir.BzrDir.open_containing(location)
4425
tree = control.open_workingtree()
4427
except (errors.NoWorkingTree, errors.NotLocalUrl):
4429
b = control.open_branch()
4431
if tree is not None:
4436
return self._run(b, tree, dry_run, verbose, revision, force,
4439
if tree is not None:
4444
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4445
from bzrlib.log import log_formatter, show_log
4446
from bzrlib.uncommit import uncommit
4448
last_revno, last_rev_id = b.last_revision_info()
4451
if revision is None:
4453
rev_id = last_rev_id
4455
# 'bzr uncommit -r 10' actually means uncommit
4456
# so that the final tree is at revno 10.
4457
# but bzrlib.uncommit.uncommit() actually uncommits
4458
# the revisions that are supplied.
4459
# So we need to offset it by one
4460
revno = revision[0].in_history(b).revno + 1
4461
if revno <= last_revno:
4462
rev_id = b.get_rev_id(revno)
4464
if rev_id is None or _mod_revision.is_null(rev_id):
4465
self.outf.write('No revisions to uncommit.\n')
4468
lf = log_formatter('short',
4470
show_timezone='original')
4475
direction='forward',
4476
start_revision=revno,
4477
end_revision=last_revno)
4480
print 'Dry-run, pretending to remove the above revisions.'
4482
val = raw_input('Press <enter> to continue')
4484
print 'The above revision(s) will be removed.'
4486
val = raw_input('Are you sure [y/N]? ')
4487
if val.lower() not in ('y', 'yes'):
4491
mutter('Uncommitting from {%s} to {%s}',
4492
last_rev_id, rev_id)
4493
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4494
revno=revno, local=local)
4495
note('You can restore the old tip by running:\n'
4496
' bzr pull . -r revid:%s', last_rev_id)
4499
class cmd_break_lock(Command):
4500
"""Break a dead lock on a repository, branch or working directory.
4502
CAUTION: Locks should only be broken when you are sure that the process
4503
holding the lock has been stopped.
4505
You can get information on what locks are open via the 'bzr info' command.
4510
takes_args = ['location?']
4512
def run(self, location=None, show=False):
4513
if location is None:
4515
control, relpath = bzrdir.BzrDir.open_containing(location)
4517
control.break_lock()
4518
except NotImplementedError:
4522
class cmd_wait_until_signalled(Command):
4523
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4525
This just prints a line to signal when it is ready, then blocks on stdin.
4531
sys.stdout.write("running\n")
4533
sys.stdin.readline()
4536
class cmd_serve(Command):
4537
"""Run the bzr server."""
4539
aliases = ['server']
4543
help='Serve on stdin/out for use from inetd or sshd.'),
4544
RegistryOption('protocol',
4545
help="Protocol to serve.",
4546
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4547
value_switches=True),
4549
help='Listen for connections on nominated port of the form '
4550
'[hostname:]portnumber. Passing 0 as the port number will '
4551
'result in a dynamically allocated port. The default port '
4552
'depends on the protocol.',
4555
help='Serve contents of this directory.',
4557
Option('allow-writes',
4558
help='By default the server is a readonly server. Supplying '
4559
'--allow-writes enables write access to the contents of '
4560
'the served directory and below.'
4564
def get_host_and_port(self, port):
4565
"""Return the host and port to run the smart server on.
4567
If 'port' is None, None will be returned for the host and port.
4569
If 'port' has a colon in it, the string before the colon will be
4570
interpreted as the host.
4572
:param port: A string of the port to run the server on.
4573
:return: A tuple of (host, port), where 'host' is a host name or IP,
4574
and port is an integer TCP/IP port.
4577
if port is not None:
4579
host, port = port.split(':')
4583
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4585
from bzrlib.transport import get_transport, transport_server_registry
4586
if directory is None:
4587
directory = os.getcwd()
4588
if protocol is None:
4589
protocol = transport_server_registry.get()
4590
host, port = self.get_host_and_port(port)
4591
url = urlutils.local_path_to_url(directory)
4592
if not allow_writes:
4593
url = 'readonly+' + url
4594
transport = get_transport(url)
4595
protocol(transport, host, port, inet)
4598
class cmd_join(Command):
4599
"""Combine a tree into its containing tree.
4601
This command requires the target tree to be in a rich-root format.
4603
The TREE argument should be an independent tree, inside another tree, but
4604
not part of it. (Such trees can be produced by "bzr split", but also by
4605
running "bzr branch" with the target inside a tree.)
4607
The result is a combined tree, with the subtree no longer an independant
4608
part. This is marked as a merge of the subtree into the containing tree,
4609
and all history is preserved.
4612
_see_also = ['split']
4613
takes_args = ['tree']
4615
Option('reference', help='Join by reference.', hidden=True),
4618
def run(self, tree, reference=False):
4619
sub_tree = WorkingTree.open(tree)
4620
parent_dir = osutils.dirname(sub_tree.basedir)
4621
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4622
repo = containing_tree.branch.repository
4623
if not repo.supports_rich_root():
4624
raise errors.BzrCommandError(
4625
"Can't join trees because %s doesn't support rich root data.\n"
4626
"You can use bzr upgrade on the repository."
4630
containing_tree.add_reference(sub_tree)
4631
except errors.BadReferenceTarget, e:
4632
# XXX: Would be better to just raise a nicely printable
4633
# exception from the real origin. Also below. mbp 20070306
4634
raise errors.BzrCommandError("Cannot join %s. %s" %
4638
containing_tree.subsume(sub_tree)
4639
except errors.BadSubsumeSource, e:
4640
raise errors.BzrCommandError("Cannot join %s. %s" %
4644
class cmd_split(Command):
4645
"""Split a subdirectory of a tree into a separate tree.
4647
This command will produce a target tree in a format that supports
4648
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4649
converted into earlier formats like 'dirstate-tags'.
4651
The TREE argument should be a subdirectory of a working tree. That
4652
subdirectory will be converted into an independent tree, with its own
4653
branch. Commits in the top-level tree will not apply to the new subtree.
4656
_see_also = ['join']
4657
takes_args = ['tree']
4659
def run(self, tree):
4660
containing_tree, subdir = WorkingTree.open_containing(tree)
4661
sub_id = containing_tree.path2id(subdir)
4663
raise errors.NotVersionedError(subdir)
4665
containing_tree.extract(sub_id)
4666
except errors.RootNotRich:
4667
raise errors.UpgradeRequired(containing_tree.branch.base)
4670
class cmd_merge_directive(Command):
4671
"""Generate a merge directive for auto-merge tools.
4673
A directive requests a merge to be performed, and also provides all the
4674
information necessary to do so. This means it must either include a
4675
revision bundle, or the location of a branch containing the desired
4678
A submit branch (the location to merge into) must be supplied the first
4679
time the command is issued. After it has been supplied once, it will
4680
be remembered as the default.
4682
A public branch is optional if a revision bundle is supplied, but required
4683
if --diff or --plain is specified. It will be remembered as the default
4684
after the first use.
4687
takes_args = ['submit_branch?', 'public_branch?']
4691
_see_also = ['send']
4694
RegistryOption.from_kwargs('patch-type',
4695
'The type of patch to include in the directive.',
4697
value_switches=True,
4699
bundle='Bazaar revision bundle (default).',
4700
diff='Normal unified diff.',
4701
plain='No patch, just directive.'),
4702
Option('sign', help='GPG-sign the directive.'), 'revision',
4703
Option('mail-to', type=str,
4704
help='Instead of printing the directive, email to this address.'),
4705
Option('message', type=str, short_name='m',
4706
help='Message to use when committing this merge.')
4709
encoding_type = 'exact'
4711
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4712
sign=False, revision=None, mail_to=None, message=None):
4713
from bzrlib.revision import ensure_null, NULL_REVISION
4714
include_patch, include_bundle = {
4715
'plain': (False, False),
4716
'diff': (True, False),
4717
'bundle': (True, True),
4719
branch = Branch.open('.')
4720
stored_submit_branch = branch.get_submit_branch()
4721
if submit_branch is None:
4722
submit_branch = stored_submit_branch
4724
if stored_submit_branch is None:
4725
branch.set_submit_branch(submit_branch)
4726
if submit_branch is None:
4727
submit_branch = branch.get_parent()
4728
if submit_branch is None:
4729
raise errors.BzrCommandError('No submit branch specified or known')
4731
stored_public_branch = branch.get_public_branch()
4732
if public_branch is None:
4733
public_branch = stored_public_branch
4734
elif stored_public_branch is None:
4735
branch.set_public_branch(public_branch)
4736
if not include_bundle and public_branch is None:
4737
raise errors.BzrCommandError('No public branch specified or'
4739
base_revision_id = None
4740
if revision is not None:
4741
if len(revision) > 2:
4742
raise errors.BzrCommandError('bzr merge-directive takes '
4743
'at most two one revision identifiers')
4744
revision_id = revision[-1].as_revision_id(branch)
4745
if len(revision) == 2:
4746
base_revision_id = revision[0].as_revision_id(branch)
4748
revision_id = branch.last_revision()
4749
revision_id = ensure_null(revision_id)
4750
if revision_id == NULL_REVISION:
4751
raise errors.BzrCommandError('No revisions to bundle.')
4752
directive = merge_directive.MergeDirective2.from_objects(
4753
branch.repository, revision_id, time.time(),
4754
osutils.local_time_offset(), submit_branch,
4755
public_branch=public_branch, include_patch=include_patch,
4756
include_bundle=include_bundle, message=message,
4757
base_revision_id=base_revision_id)
4760
self.outf.write(directive.to_signed(branch))
4762
self.outf.writelines(directive.to_lines())
4764
message = directive.to_email(mail_to, branch, sign)
4765
s = SMTPConnection(branch.get_config())
4766
s.send_email(message)
4769
class cmd_send(Command):
4770
"""Mail or create a merge-directive for submitting changes.
4772
A merge directive provides many things needed for requesting merges:
4774
* A machine-readable description of the merge to perform
4776
* An optional patch that is a preview of the changes requested
4778
* An optional bundle of revision data, so that the changes can be applied
4779
directly from the merge directive, without retrieving data from a
4782
If --no-bundle is specified, then public_branch is needed (and must be
4783
up-to-date), so that the receiver can perform the merge using the
4784
public_branch. The public_branch is always included if known, so that
4785
people can check it later.
4787
The submit branch defaults to the parent, but can be overridden. Both
4788
submit branch and public branch will be remembered if supplied.
4790
If a public_branch is known for the submit_branch, that public submit
4791
branch is used in the merge instructions. This means that a local mirror
4792
can be used as your actual submit branch, once you have set public_branch
4795
Mail is sent using your preferred mail program. This should be transparent
4796
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4797
If the preferred client can't be found (or used), your editor will be used.
4799
To use a specific mail program, set the mail_client configuration option.
4800
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4801
specific clients are "claws", "evolution", "kmail", "mutt", and
4802
"thunderbird"; generic options are "default", "editor", "emacsclient",
4803
"mapi", and "xdg-email". Plugins may also add supported clients.
4805
If mail is being sent, a to address is required. This can be supplied
4806
either on the commandline, by setting the submit_to configuration
4807
option in the branch itself or the child_submit_to configuration option
4808
in the submit branch.
4810
Two formats are currently supported: "4" uses revision bundle format 4 and
4811
merge directive format 2. It is significantly faster and smaller than
4812
older formats. It is compatible with Bazaar 0.19 and later. It is the
4813
default. "0.9" uses revision bundle format 0.9 and merge directive
4814
format 1. It is compatible with Bazaar 0.12 - 0.18.
4816
The merge directives created by bzr send may be applied using bzr merge or
4817
bzr pull by specifying a file containing a merge directive as the location.
4820
encoding_type = 'exact'
4822
_see_also = ['merge', 'pull']
4824
takes_args = ['submit_branch?', 'public_branch?']
4828
help='Do not include a bundle in the merge directive.'),
4829
Option('no-patch', help='Do not include a preview patch in the merge'
4832
help='Remember submit and public branch.'),
4834
help='Branch to generate the submission from, '
4835
'rather than the one containing the working directory.',
4838
Option('output', short_name='o',
4839
help='Write merge directive to this file; '
4840
'use - for stdout.',
4842
Option('mail-to', help='Mail the request to this address.',
4846
Option('body', help='Body for the email.', type=unicode),
4847
RegistryOption('format',
4848
help='Use the specified output format.',
4849
lazy_registry=('bzrlib.send', 'format_registry'))
4852
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4853
no_patch=False, revision=None, remember=False, output=None,
4854
format=None, mail_to=None, message=None, body=None, **kwargs):
4855
from bzrlib.send import send
4856
return send(submit_branch, revision, public_branch, remember,
4857
format, no_bundle, no_patch, output,
4858
kwargs.get('from', '.'), mail_to, message, body,
4862
class cmd_bundle_revisions(cmd_send):
4863
"""Create a merge-directive for submitting changes.
4865
A merge directive provides many things needed for requesting merges:
4867
* A machine-readable description of the merge to perform
4869
* An optional patch that is a preview of the changes requested
4871
* An optional bundle of revision data, so that the changes can be applied
4872
directly from the merge directive, without retrieving data from a
4875
If --no-bundle is specified, then public_branch is needed (and must be
4876
up-to-date), so that the receiver can perform the merge using the
4877
public_branch. The public_branch is always included if known, so that
4878
people can check it later.
4880
The submit branch defaults to the parent, but can be overridden. Both
4881
submit branch and public branch will be remembered if supplied.
4883
If a public_branch is known for the submit_branch, that public submit
4884
branch is used in the merge instructions. This means that a local mirror
4885
can be used as your actual submit branch, once you have set public_branch
4888
Two formats are currently supported: "4" uses revision bundle format 4 and
4889
merge directive format 2. It is significantly faster and smaller than
4890
older formats. It is compatible with Bazaar 0.19 and later. It is the
4891
default. "0.9" uses revision bundle format 0.9 and merge directive
4892
format 1. It is compatible with Bazaar 0.12 - 0.18.
4897
help='Do not include a bundle in the merge directive.'),
4898
Option('no-patch', help='Do not include a preview patch in the merge'
4901
help='Remember submit and public branch.'),
4903
help='Branch to generate the submission from, '
4904
'rather than the one containing the working directory.',
4907
Option('output', short_name='o', help='Write directive to this file.',
4910
RegistryOption('format',
4911
help='Use the specified output format.',
4912
lazy_registry=('bzrlib.send', 'format_registry')),
4914
aliases = ['bundle']
4916
_see_also = ['send', 'merge']
4920
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4921
no_patch=False, revision=None, remember=False, output=None,
4922
format=None, **kwargs):
4925
from bzrlib.send import send
4926
return send(submit_branch, revision, public_branch, remember,
4927
format, no_bundle, no_patch, output,
4928
kwargs.get('from', '.'), None, None, None,
4932
class cmd_tag(Command):
4933
"""Create, remove or modify a tag naming a revision.
4935
Tags give human-meaningful names to revisions. Commands that take a -r
4936
(--revision) option can be given -rtag:X, where X is any previously
4939
Tags are stored in the branch. Tags are copied from one branch to another
4940
along when you branch, push, pull or merge.
4942
It is an error to give a tag name that already exists unless you pass
4943
--force, in which case the tag is moved to point to the new revision.
4945
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4946
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4949
_see_also = ['commit', 'tags']
4950
takes_args = ['tag_name']
4953
help='Delete this tag rather than placing it.',
4956
help='Branch in which to place the tag.',
4961
help='Replace existing tags.',
4966
def run(self, tag_name,
4972
branch, relpath = Branch.open_containing(directory)
4976
branch.tags.delete_tag(tag_name)
4977
self.outf.write('Deleted tag %s.\n' % tag_name)
4980
if len(revision) != 1:
4981
raise errors.BzrCommandError(
4982
"Tags can only be placed on a single revision, "
4984
revision_id = revision[0].as_revision_id(branch)
4986
revision_id = branch.last_revision()
4987
if (not force) and branch.tags.has_tag(tag_name):
4988
raise errors.TagAlreadyExists(tag_name)
4989
branch.tags.set_tag(tag_name, revision_id)
4990
self.outf.write('Created tag %s.\n' % tag_name)
4995
class cmd_tags(Command):
4998
This command shows a table of tag names and the revisions they reference.
5004
help='Branch whose tags should be displayed.',
5008
RegistryOption.from_kwargs('sort',
5009
'Sort tags by different criteria.', title='Sorting',
5010
alpha='Sort tags lexicographically (default).',
5011
time='Sort tags chronologically.',
5024
branch, relpath = Branch.open_containing(directory)
5026
tags = branch.tags.get_tag_dict().items()
5033
graph = branch.repository.get_graph()
5034
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5035
revid1, revid2 = rev1.rev_id, rev2.rev_id
5036
# only show revisions between revid1 and revid2 (inclusive)
5037
tags = [(tag, revid) for tag, revid in tags if
5038
graph.is_between(revid, revid1, revid2)]
5043
elif sort == 'time':
5045
for tag, revid in tags:
5047
revobj = branch.repository.get_revision(revid)
5048
except errors.NoSuchRevision:
5049
timestamp = sys.maxint # place them at the end
5051
timestamp = revobj.timestamp
5052
timestamps[revid] = timestamp
5053
tags.sort(key=lambda x: timestamps[x[1]])
5055
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5056
for index, (tag, revid) in enumerate(tags):
5058
revno = branch.revision_id_to_dotted_revno(revid)
5059
if isinstance(revno, tuple):
5060
revno = '.'.join(map(str, revno))
5061
except errors.NoSuchRevision:
5062
# Bad tag data/merges can lead to tagged revisions
5063
# which are not in this branch. Fail gracefully ...
5065
tags[index] = (tag, revno)
5066
for tag, revspec in tags:
5067
self.outf.write('%-20s %s\n' % (tag, revspec))
5070
class cmd_reconfigure(Command):
5071
"""Reconfigure the type of a bzr directory.
5073
A target configuration must be specified.
5075
For checkouts, the bind-to location will be auto-detected if not specified.
5076
The order of preference is
5077
1. For a lightweight checkout, the current bound location.
5078
2. For branches that used to be checkouts, the previously-bound location.
5079
3. The push location.
5080
4. The parent location.
5081
If none of these is available, --bind-to must be specified.
5084
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5085
takes_args = ['location?']
5087
RegistryOption.from_kwargs(
5089
title='Target type',
5090
help='The type to reconfigure the directory to.',
5091
value_switches=True, enum_switch=False,
5092
branch='Reconfigure to be an unbound branch with no working tree.',
5093
tree='Reconfigure to be an unbound branch with a working tree.',
5094
checkout='Reconfigure to be a bound branch with a working tree.',
5095
lightweight_checkout='Reconfigure to be a lightweight'
5096
' checkout (with no local history).',
5097
standalone='Reconfigure to be a standalone branch '
5098
'(i.e. stop using shared repository).',
5099
use_shared='Reconfigure to use a shared repository.',
5100
with_trees='Reconfigure repository to create '
5101
'working trees on branches by default.',
5102
with_no_trees='Reconfigure repository to not create '
5103
'working trees on branches by default.'
5105
Option('bind-to', help='Branch to bind checkout to.', type=str),
5107
help='Perform reconfiguration even if local changes'
5111
def run(self, location=None, target_type=None, bind_to=None, force=False):
5112
directory = bzrdir.BzrDir.open(location)
5113
if target_type is None:
5114
raise errors.BzrCommandError('No target configuration specified')
5115
elif target_type == 'branch':
5116
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5117
elif target_type == 'tree':
5118
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5119
elif target_type == 'checkout':
5120
reconfiguration = reconfigure.Reconfigure.to_checkout(
5122
elif target_type == 'lightweight-checkout':
5123
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5125
elif target_type == 'use-shared':
5126
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5127
elif target_type == 'standalone':
5128
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5129
elif target_type == 'with-trees':
5130
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5132
elif target_type == 'with-no-trees':
5133
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5135
reconfiguration.apply(force)
5138
class cmd_switch(Command):
5139
"""Set the branch of a checkout and update.
5141
For lightweight checkouts, this changes the branch being referenced.
5142
For heavyweight checkouts, this checks that there are no local commits
5143
versus the current bound branch, then it makes the local branch a mirror
5144
of the new location and binds to it.
5146
In both cases, the working tree is updated and uncommitted changes
5147
are merged. The user can commit or revert these as they desire.
5149
Pending merges need to be committed or reverted before using switch.
5151
The path to the branch to switch to can be specified relative to the parent
5152
directory of the current branch. For example, if you are currently in a
5153
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5156
Bound branches use the nickname of its master branch unless it is set
5157
locally, in which case switching will update the the local nickname to be
5161
takes_args = ['to_location']
5162
takes_options = [Option('force',
5163
help='Switch even if local commits will be lost.')
5166
def run(self, to_location, force=False):
5167
from bzrlib import switch
5169
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5171
branch = control_dir.open_branch()
5172
had_explicit_nick = branch.get_config().has_explicit_nickname()
5173
except errors.NotBranchError:
5174
had_explicit_nick = False
5176
to_branch = Branch.open(to_location)
5177
except errors.NotBranchError:
5178
this_url = self._get_branch_location(control_dir)
5179
to_branch = Branch.open(
5180
urlutils.join(this_url, '..', to_location))
5181
switch.switch(control_dir, to_branch, force)
5182
if had_explicit_nick:
5183
branch = control_dir.open_branch() #get the new branch!
5184
branch.nick = to_branch.nick
5185
note('Switched to branch: %s',
5186
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5188
def _get_branch_location(self, control_dir):
5189
"""Return location of branch for this control dir."""
5191
this_branch = control_dir.open_branch()
5192
# This may be a heavy checkout, where we want the master branch
5193
master_location = this_branch.get_bound_location()
5194
if master_location is not None:
5195
return master_location
5196
# If not, use a local sibling
5197
return this_branch.base
5198
except errors.NotBranchError:
5199
format = control_dir.find_branch_format()
5200
if getattr(format, 'get_reference', None) is not None:
5201
return format.get_reference(control_dir)
5203
return control_dir.root_transport.base
5206
class cmd_view(Command):
5207
"""Manage filtered views.
5209
Views provide a mask over the tree so that users can focus on
5210
a subset of a tree when doing their work. After creating a view,
5211
commands that support a list of files - status, diff, commit, etc -
5212
effectively have that list of files implicitly given each time.
5213
An explicit list of files can still be given but those files
5214
must be within the current view.
5216
In most cases, a view has a short life-span: it is created to make
5217
a selected change and is deleted once that change is committed.
5218
At other times, you may wish to create one or more named views
5219
and switch between them.
5221
To disable the current view without deleting it, you can switch to
5222
the pseudo view called ``off``. This can be useful when you need
5223
to see the whole tree for an operation or two (e.g. merge) but
5224
want to switch back to your view after that.
5227
To define the current view::
5229
bzr view file1 dir1 ...
5231
To list the current view::
5235
To delete the current view::
5239
To disable the current view without deleting it::
5241
bzr view --switch off
5243
To define a named view and switch to it::
5245
bzr view --name view-name file1 dir1 ...
5247
To list a named view::
5249
bzr view --name view-name
5251
To delete a named view::
5253
bzr view --name view-name --delete
5255
To switch to a named view::
5257
bzr view --switch view-name
5259
To list all views defined::
5263
To delete all views::
5265
bzr view --delete --all
5269
takes_args = ['file*']
5272
help='Apply list or delete action to all views.',
5275
help='Delete the view.',
5278
help='Name of the view to define, list or delete.',
5282
help='Name of the view to switch to.',
5287
def run(self, file_list,
5293
tree, file_list = tree_files(file_list, apply_view=False)
5294
current_view, view_dict = tree.views.get_view_info()
5299
raise errors.BzrCommandError(
5300
"Both --delete and a file list specified")
5302
raise errors.BzrCommandError(
5303
"Both --delete and --switch specified")
5305
tree.views.set_view_info(None, {})
5306
self.outf.write("Deleted all views.\n")
5308
raise errors.BzrCommandError("No current view to delete")
5310
tree.views.delete_view(name)
5311
self.outf.write("Deleted '%s' view.\n" % name)
5314
raise errors.BzrCommandError(
5315
"Both --switch and a file list specified")
5317
raise errors.BzrCommandError(
5318
"Both --switch and --all specified")
5319
elif switch == 'off':
5320
if current_view is None:
5321
raise errors.BzrCommandError("No current view to disable")
5322
tree.views.set_view_info(None, view_dict)
5323
self.outf.write("Disabled '%s' view.\n" % (current_view))
5325
tree.views.set_view_info(switch, view_dict)
5326
view_str = views.view_display_str(tree.views.lookup_view())
5327
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5330
self.outf.write('Views defined:\n')
5331
for view in sorted(view_dict):
5332
if view == current_view:
5336
view_str = views.view_display_str(view_dict[view])
5337
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5339
self.outf.write('No views defined.\n')
5342
# No name given and no current view set
5345
raise errors.BzrCommandError(
5346
"Cannot change the 'off' pseudo view")
5347
tree.views.set_view(name, sorted(file_list))
5348
view_str = views.view_display_str(tree.views.lookup_view())
5349
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5353
# No name given and no current view set
5354
self.outf.write('No current view.\n')
5356
view_str = views.view_display_str(tree.views.lookup_view(name))
5357
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5360
class cmd_hooks(Command):
5366
for hook_key in sorted(hooks.known_hooks.keys()):
5367
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5368
self.outf.write("%s:\n" % type(some_hooks).__name__)
5369
for hook_name, hook_point in sorted(some_hooks.items()):
5370
self.outf.write(" %s:\n" % (hook_name,))
5371
found_hooks = list(hook_point)
5373
for hook in found_hooks:
5374
self.outf.write(" %s\n" %
5375
(some_hooks.get_hook_name(hook),))
5377
self.outf.write(" <no hooks installed>\n")
5380
class cmd_shelve(Command):
5381
"""Temporarily set aside some changes from the current tree.
5383
Shelve allows you to temporarily put changes you've made "on the shelf",
5384
ie. out of the way, until a later time when you can bring them back from
5385
the shelf with the 'unshelve' command. The changes are stored alongside
5386
your working tree, and so they aren't propagated along with your branch nor
5387
will they survive its deletion.
5389
If shelve --list is specified, previously-shelved changes are listed.
5391
Shelve is intended to help separate several sets of changes that have
5392
been inappropriately mingled. If you just want to get rid of all changes
5393
and you don't need to restore them later, use revert. If you want to
5394
shelve all text changes at once, use shelve --all.
5396
If filenames are specified, only the changes to those files will be
5397
shelved. Other files will be left untouched.
5399
If a revision is specified, changes since that revision will be shelved.
5401
You can put multiple items on the shelf, and by default, 'unshelve' will
5402
restore the most recently shelved changes.
5405
takes_args = ['file*']
5409
Option('all', help='Shelve all changes.'),
5411
RegistryOption('writer', 'Method to use for writing diffs.',
5412
bzrlib.option.diff_writer_registry,
5413
value_switches=True, enum_switch=False),
5415
Option('list', help='List shelved changes.'),
5417
help='Destroy removed changes instead of shelving them.'),
5419
_see_also = ['unshelve']
5421
def run(self, revision=None, all=False, file_list=None, message=None,
5422
writer=None, list=False, destroy=False):
5424
return self.run_for_list()
5425
from bzrlib.shelf_ui import Shelver
5427
writer = bzrlib.option.diff_writer_registry.get()
5429
Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5430
message, destroy=destroy).run()
5431
except errors.UserAbort:
5434
def run_for_list(self):
5435
tree = WorkingTree.open_containing('.')[0]
5438
manager = tree.get_shelf_manager()
5439
shelves = manager.active_shelves()
5440
if len(shelves) == 0:
5441
note('No shelved changes.')
5443
for shelf_id in reversed(shelves):
5444
message = manager.get_metadata(shelf_id).get('message')
5446
message = '<no message>'
5447
self.outf.write('%3d: %s\n' % (shelf_id, message))
5453
class cmd_unshelve(Command):
5454
"""Restore shelved changes.
5456
By default, the most recently shelved changes are restored. However if you
5457
specify a shelf by id those changes will be restored instead. This works
5458
best when the changes don't depend on each other.
5461
takes_args = ['shelf_id?']
5463
RegistryOption.from_kwargs(
5464
'action', help="The action to perform.",
5465
enum_switch=False, value_switches=True,
5466
apply="Apply changes and remove from the shelf.",
5467
dry_run="Show changes, but do not apply or remove them.",
5468
delete_only="Delete changes without applying them."
5471
_see_also = ['shelve']
5473
def run(self, shelf_id=None, action='apply'):
5474
from bzrlib.shelf_ui import Unshelver
5475
Unshelver.from_args(shelf_id, action).run()
5478
class cmd_clean_tree(Command):
5479
"""Remove unwanted files from working tree.
5481
By default, only unknown files, not ignored files, are deleted. Versioned
5482
files are never deleted.
5484
Another class is 'detritus', which includes files emitted by bzr during
5485
normal operations and selftests. (The value of these files decreases with
5488
If no options are specified, unknown files are deleted. Otherwise, option
5489
flags are respected, and may be combined.
5491
To check what clean-tree will do, use --dry-run.
5493
takes_options = [Option('ignored', help='Delete all ignored files.'),
5494
Option('detritus', help='Delete conflict files, merge'
5495
' backups, and failed selftest dirs.'),
5497
help='Delete files unknown to bzr (default).'),
5498
Option('dry-run', help='Show files to delete instead of'
5500
Option('force', help='Do not prompt before deleting.')]
5501
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5503
from bzrlib.clean_tree import clean_tree
5504
if not (unknown or ignored or detritus):
5508
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5509
dry_run=dry_run, no_prompt=force)
5512
class cmd_reference(Command):
5513
"""list, view and set branch locations for nested trees.
5515
If no arguments are provided, lists the branch locations for nested trees.
5516
If one argument is provided, display the branch location for that tree.
5517
If two arguments are provided, set the branch location for that tree.
5522
takes_args = ['path?', 'location?']
5524
def run(self, path=None, location=None):
5526
if path is not None:
5528
tree, branch, relpath =(
5529
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5530
if path is not None:
5533
tree = branch.basis_tree()
5535
info = branch._get_all_reference_info().iteritems()
5536
self._display_reference_info(tree, branch, info)
5538
file_id = tree.path2id(path)
5540
raise errors.NotVersionedError(path)
5541
if location is None:
5542
info = [(file_id, branch.get_reference_info(file_id))]
5543
self._display_reference_info(tree, branch, info)
5545
branch.set_reference_info(file_id, path, location)
5547
def _display_reference_info(self, tree, branch, info):
5549
for file_id, (path, location) in info:
5551
path = tree.id2path(file_id)
5552
except errors.NoSuchId:
5554
ref_list.append((path, location))
5555
for path, location in sorted(ref_list):
5556
self.outf.write('%s %s\n' % (path, location))
5559
# these get imported and then picked up by the scan for cmd_*
5560
# TODO: Some more consistent way to split command definitions across files;
5561
# we do need to load at least some information about them to know of
5562
# aliases. ideally we would avoid loading the implementation until the
5563
# details were needed.
5564
from bzrlib.cmd_version_info import cmd_version_info
5565
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5566
from bzrlib.bundle.commands import (
5569
from bzrlib.foreign import cmd_dpush
5570
from bzrlib.sign_my_commits import cmd_sign_my_commits
5571
from bzrlib.weave_commands import cmd_versionedfile_list, \
5572
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
