1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
45
revision as _mod_revision,
53
from bzrlib.branch import Branch
54
from bzrlib.conflicts import ConflictList
55
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
56
from bzrlib.smtp_connection import SMTPConnection
57
from bzrlib.workingtree import WorkingTree
60
from bzrlib.commands import Command, display_command
61
from bzrlib.option import (
68
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
71
def tree_files(file_list, default_branch=u'.', canonicalize=True,
74
return internal_tree_files(file_list, default_branch, canonicalize,
76
except errors.FileInWrongBranch, e:
77
raise errors.BzrCommandError("%s is not in the same branch as %s" %
78
(e.path, file_list[0]))
81
def tree_files_for_add(file_list):
83
Return a tree and list of absolute paths from a file list.
85
Similar to tree_files, but add handles files a bit differently, so it a
86
custom implementation. In particular, MutableTreeTree.smart_add expects
87
absolute paths, which it immediately converts to relative paths.
89
# FIXME Would be nice to just return the relative paths like
90
# internal_tree_files does, but there are a large number of unit tests
91
# that assume the current interface to mutabletree.smart_add
93
tree, relpath = WorkingTree.open_containing(file_list[0])
94
if tree.supports_views():
95
view_files = tree.views.lookup_view()
97
for filename in file_list:
98
if not osutils.is_inside_any(view_files, filename):
99
raise errors.FileOutsideView(filename, view_files)
100
file_list = file_list[:]
101
file_list[0] = tree.abspath(relpath)
103
tree = WorkingTree.open_containing(u'.')[0]
104
if tree.supports_views():
105
view_files = tree.views.lookup_view()
107
file_list = view_files
108
view_str = views.view_display_str(view_files)
109
note("Ignoring files outside view. View is %s" % view_str)
110
return tree, file_list
113
def _get_one_revision(command_name, revisions):
114
if revisions is None:
116
if len(revisions) != 1:
117
raise errors.BzrCommandError(
118
'bzr %s --revision takes exactly one revision identifier' % (
123
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
126
if revisions is None:
128
rev_tree = tree.basis_tree()
130
rev_tree = branch.basis_tree()
132
revision = _get_one_revision(command_name, revisions)
133
rev_tree = revision.as_tree(branch)
137
# XXX: Bad function name; should possibly also be a class method of
138
# WorkingTree rather than a function.
139
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
141
"""Convert command-line paths to a WorkingTree and relative paths.
143
This is typically used for command-line processors that take one or
144
more filenames, and infer the workingtree that contains them.
146
The filenames given are not required to exist.
148
:param file_list: Filenames to convert.
150
:param default_branch: Fallback tree path to use if file_list is empty or
153
:param apply_view: if True and a view is set, apply it or check that
154
specified files are within it
156
:return: workingtree, [relative_paths]
158
if file_list is None or len(file_list) == 0:
159
tree = WorkingTree.open_containing(default_branch)[0]
160
if tree.supports_views() and apply_view:
161
view_files = tree.views.lookup_view()
163
file_list = view_files
164
view_str = views.view_display_str(view_files)
165
note("Ignoring files outside view. View is %s" % view_str)
166
return tree, file_list
167
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
168
return tree, safe_relpath_files(tree, file_list, canonicalize,
169
apply_view=apply_view)
172
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
173
"""Convert file_list into a list of relpaths in tree.
175
:param tree: A tree to operate on.
176
:param file_list: A list of user provided paths or None.
177
:param apply_view: if True and a view is set, apply it or check that
178
specified files are within it
179
:return: A list of relative paths.
180
:raises errors.PathNotChild: When a provided path is in a different tree
183
if file_list is None:
185
if tree.supports_views() and apply_view:
186
view_files = tree.views.lookup_view()
190
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
191
# doesn't - fix that up here before we enter the loop.
193
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
196
for filename in file_list:
198
relpath = fixer(osutils.dereference_path(filename))
199
if view_files and not osutils.is_inside_any(view_files, relpath):
200
raise errors.FileOutsideView(filename, view_files)
201
new_list.append(relpath)
202
except errors.PathNotChild:
203
raise errors.FileInWrongBranch(tree.branch, filename)
207
def _get_view_info_for_change_reporter(tree):
208
"""Get the view information from a tree for change reporting."""
211
current_view = tree.views.get_view_info()[0]
212
if current_view is not None:
213
view_info = (current_view, tree.views.lookup_view())
214
except errors.ViewsNotSupported:
219
# TODO: Make sure no commands unconditionally use the working directory as a
220
# branch. If a filename argument is used, the first of them should be used to
221
# specify the branch. (Perhaps this can be factored out into some kind of
222
# Argument class, representing a file in a branch, where the first occurrence
225
class cmd_status(Command):
226
"""Display status summary.
228
This reports on versioned and unknown files, reporting them
229
grouped by state. Possible states are:
232
Versioned in the working copy but not in the previous revision.
235
Versioned in the previous revision but removed or deleted
239
Path of this file changed from the previous revision;
240
the text may also have changed. This includes files whose
241
parent directory was renamed.
244
Text has changed since the previous revision.
247
File kind has been changed (e.g. from file to directory).
250
Not versioned and not matching an ignore pattern.
252
To see ignored files use 'bzr ignored'. For details on the
253
changes to file texts, use 'bzr diff'.
255
Note that --short or -S gives status flags for each item, similar
256
to Subversion's status command. To get output similar to svn -q,
259
If no arguments are specified, the status of the entire working
260
directory is shown. Otherwise, only the status of the specified
261
files or directories is reported. If a directory is given, status
262
is reported for everything inside that directory.
264
Before merges are committed, the pending merge tip revisions are
265
shown. To see all pending merge revisions, use the -v option.
266
To skip the display of pending merge information altogether, use
267
the no-pending option or specify a file/directory.
269
If a revision argument is given, the status is calculated against
270
that revision, or between two revisions if two are provided.
273
# TODO: --no-recurse, --recurse options
275
takes_args = ['file*']
276
takes_options = ['show-ids', 'revision', 'change', 'verbose',
277
Option('short', help='Use short status indicators.',
279
Option('versioned', help='Only show versioned files.',
281
Option('no-pending', help='Don\'t show pending merges.',
284
aliases = ['st', 'stat']
286
encoding_type = 'replace'
287
_see_also = ['diff', 'revert', 'status-flags']
290
def run(self, show_ids=False, file_list=None, revision=None, short=False,
291
versioned=False, no_pending=False, verbose=False):
292
from bzrlib.status import show_tree_status
294
if revision and len(revision) > 2:
295
raise errors.BzrCommandError('bzr status --revision takes exactly'
296
' one or two revision specifiers')
298
tree, relfile_list = tree_files(file_list)
299
# Avoid asking for specific files when that is not needed.
300
if relfile_list == ['']:
302
# Don't disable pending merges for full trees other than '.'.
303
if file_list == ['.']:
305
# A specific path within a tree was given.
306
elif relfile_list is not None:
308
show_tree_status(tree, show_ids=show_ids,
309
specific_files=relfile_list, revision=revision,
310
to_file=self.outf, short=short, versioned=versioned,
311
show_pending=(not no_pending), verbose=verbose)
314
class cmd_cat_revision(Command):
315
"""Write out metadata for a revision.
317
The revision to print can either be specified by a specific
318
revision identifier, or you can use --revision.
322
takes_args = ['revision_id?']
323
takes_options = ['revision']
324
# cat-revision is more for frontends so should be exact
328
def run(self, revision_id=None, revision=None):
329
if revision_id is not None and revision is not None:
330
raise errors.BzrCommandError('You can only supply one of'
331
' revision_id or --revision')
332
if revision_id is None and revision is None:
333
raise errors.BzrCommandError('You must supply either'
334
' --revision or a revision_id')
335
b = WorkingTree.open_containing(u'.')[0].branch
337
# TODO: jam 20060112 should cat-revision always output utf-8?
338
if revision_id is not None:
339
revision_id = osutils.safe_revision_id(revision_id, warn=False)
341
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
342
except errors.NoSuchRevision:
343
msg = "The repository %s contains no revision %s." % (b.repository.base,
345
raise errors.BzrCommandError(msg)
346
elif revision is not None:
349
raise errors.BzrCommandError('You cannot specify a NULL'
351
rev_id = rev.as_revision_id(b)
352
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
355
class cmd_dump_btree(Command):
356
"""Dump the contents of a btree index file to stdout.
358
PATH is a btree index file, it can be any URL. This includes things like
359
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
361
By default, the tuples stored in the index file will be displayed. With
362
--raw, we will uncompress the pages, but otherwise display the raw bytes
366
# TODO: Do we want to dump the internal nodes as well?
367
# TODO: It would be nice to be able to dump the un-parsed information,
368
# rather than only going through iter_all_entries. However, this is
369
# good enough for a start
371
encoding_type = 'exact'
372
takes_args = ['path']
373
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
374
' rather than the parsed tuples.'),
377
def run(self, path, raw=False):
378
dirname, basename = osutils.split(path)
379
t = transport.get_transport(dirname)
381
self._dump_raw_bytes(t, basename)
383
self._dump_entries(t, basename)
385
def _get_index_and_bytes(self, trans, basename):
386
"""Create a BTreeGraphIndex and raw bytes."""
387
bt = btree_index.BTreeGraphIndex(trans, basename, None)
388
bytes = trans.get_bytes(basename)
389
bt._file = cStringIO.StringIO(bytes)
390
bt._size = len(bytes)
393
def _dump_raw_bytes(self, trans, basename):
396
# We need to parse at least the root node.
397
# This is because the first page of every row starts with an
398
# uncompressed header.
399
bt, bytes = self._get_index_and_bytes(trans, basename)
400
for page_idx, page_start in enumerate(xrange(0, len(bytes),
401
btree_index._PAGE_SIZE)):
402
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
403
page_bytes = bytes[page_start:page_end]
405
self.outf.write('Root node:\n')
406
header_end, data = bt._parse_header_from_bytes(page_bytes)
407
self.outf.write(page_bytes[:header_end])
409
self.outf.write('\nPage %d\n' % (page_idx,))
410
decomp_bytes = zlib.decompress(page_bytes)
411
self.outf.write(decomp_bytes)
412
self.outf.write('\n')
414
def _dump_entries(self, trans, basename):
416
st = trans.stat(basename)
417
except errors.TransportNotPossible:
418
# We can't stat, so we'll fake it because we have to do the 'get()'
420
bt, _ = self._get_index_and_bytes(trans, basename)
422
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
423
for node in bt.iter_all_entries():
424
# Node is made up of:
425
# (index, key, value, [references])
426
self.outf.write('%s\n' % (node[1:],))
429
class cmd_remove_tree(Command):
430
"""Remove the working tree from a given branch/checkout.
432
Since a lightweight checkout is little more than a working tree
433
this will refuse to run against one.
435
To re-create the working tree, use "bzr checkout".
437
_see_also = ['checkout', 'working-trees']
438
takes_args = ['location?']
441
help='Remove the working tree even if it has '
442
'uncommitted changes.'),
445
def run(self, location='.', force=False):
446
d = bzrdir.BzrDir.open(location)
449
working = d.open_workingtree()
450
except errors.NoWorkingTree:
451
raise errors.BzrCommandError("No working tree to remove")
452
except errors.NotLocalUrl:
453
raise errors.BzrCommandError("You cannot remove the working tree of a "
456
changes = working.changes_from(working.basis_tree())
457
if changes.has_changed():
458
raise errors.UncommittedChanges(working)
460
working_path = working.bzrdir.root_transport.base
461
branch_path = working.branch.bzrdir.root_transport.base
462
if working_path != branch_path:
463
raise errors.BzrCommandError("You cannot remove the working tree from "
464
"a lightweight checkout")
466
d.destroy_workingtree()
469
class cmd_revno(Command):
470
"""Show current revision number.
472
This is equal to the number of revisions on this branch.
476
takes_args = ['location?']
479
def run(self, location=u'.'):
480
self.outf.write(str(Branch.open_containing(location)[0].revno()))
481
self.outf.write('\n')
484
class cmd_revision_info(Command):
485
"""Show revision number and revision id for a given revision identifier.
488
takes_args = ['revision_info*']
492
help='Branch to examine, '
493
'rather than the one containing the working directory.',
500
def run(self, revision=None, directory=u'.', revision_info_list=[]):
503
if revision is not None:
504
revs.extend(revision)
505
if revision_info_list is not None:
506
for rev in revision_info_list:
507
revs.append(RevisionSpec.from_string(rev))
509
b = Branch.open_containing(directory)[0]
512
revs.append(RevisionSpec.from_string('-1'))
515
revision_id = rev.as_revision_id(b)
517
revno = '%4d' % (b.revision_id_to_revno(revision_id))
518
except errors.NoSuchRevision:
519
dotted_map = b.get_revision_id_to_revno_map()
520
revno = '.'.join(str(i) for i in dotted_map[revision_id])
521
print '%s %s' % (revno, revision_id)
524
class cmd_add(Command):
525
"""Add specified files or directories.
527
In non-recursive mode, all the named items are added, regardless
528
of whether they were previously ignored. A warning is given if
529
any of the named files are already versioned.
531
In recursive mode (the default), files are treated the same way
532
but the behaviour for directories is different. Directories that
533
are already versioned do not give a warning. All directories,
534
whether already versioned or not, are searched for files or
535
subdirectories that are neither versioned or ignored, and these
536
are added. This search proceeds recursively into versioned
537
directories. If no names are given '.' is assumed.
539
Therefore simply saying 'bzr add' will version all files that
540
are currently unknown.
542
Adding a file whose parent directory is not versioned will
543
implicitly add the parent, and so on up to the root. This means
544
you should never need to explicitly add a directory, they'll just
545
get added when you add a file in the directory.
547
--dry-run will show which files would be added, but not actually
550
--file-ids-from will try to use the file ids from the supplied path.
551
It looks up ids trying to find a matching parent directory with the
552
same filename, and then by pure path. This option is rarely needed
553
but can be useful when adding the same logical file into two
554
branches that will be merged later (without showing the two different
555
adds as a conflict). It is also useful when merging another project
556
into a subdirectory of this one.
558
takes_args = ['file*']
561
help="Don't recursively add the contents of directories."),
563
help="Show what would be done, but don't actually do anything."),
565
Option('file-ids-from',
567
help='Lookup file ids from this tree.'),
569
encoding_type = 'replace'
570
_see_also = ['remove']
572
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
577
if file_ids_from is not None:
579
base_tree, base_path = WorkingTree.open_containing(
581
except errors.NoWorkingTree:
582
base_branch, base_path = Branch.open_containing(
584
base_tree = base_branch.basis_tree()
586
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
587
to_file=self.outf, should_print=(not is_quiet()))
589
action = bzrlib.add.AddAction(to_file=self.outf,
590
should_print=(not is_quiet()))
593
base_tree.lock_read()
595
file_list = self._maybe_expand_globs(file_list)
596
tree, file_list = tree_files_for_add(file_list)
597
added, ignored = tree.smart_add(file_list, not
598
no_recurse, action=action, save=not dry_run)
600
if base_tree is not None:
604
for glob in sorted(ignored.keys()):
605
for path in ignored[glob]:
606
self.outf.write("ignored %s matching \"%s\"\n"
610
for glob, paths in ignored.items():
611
match_len += len(paths)
612
self.outf.write("ignored %d file(s).\n" % match_len)
613
self.outf.write("If you wish to add ignored files, "
614
"please add them explicitly by name. "
615
"(\"bzr ignored\" gives a list)\n")
618
class cmd_mkdir(Command):
619
"""Create a new versioned directory.
621
This is equivalent to creating the directory and then adding it.
624
takes_args = ['dir+']
625
encoding_type = 'replace'
627
def run(self, dir_list):
630
wt, dd = WorkingTree.open_containing(d)
632
self.outf.write('added %s\n' % d)
635
class cmd_relpath(Command):
636
"""Show path of a file relative to root"""
638
takes_args = ['filename']
642
def run(self, filename):
643
# TODO: jam 20050106 Can relpath return a munged path if
644
# sys.stdout encoding cannot represent it?
645
tree, relpath = WorkingTree.open_containing(filename)
646
self.outf.write(relpath)
647
self.outf.write('\n')
650
class cmd_inventory(Command):
651
"""Show inventory of the current working copy or a revision.
653
It is possible to limit the output to a particular entry
654
type using the --kind option. For example: --kind file.
656
It is also possible to restrict the list of files to a specific
657
set. For example: bzr inventory --show-ids this/file
666
help='List entries of a particular kind: file, directory, symlink.',
669
takes_args = ['file*']
672
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
673
if kind and kind not in ['file', 'directory', 'symlink']:
674
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
676
revision = _get_one_revision('inventory', revision)
677
work_tree, file_list = tree_files(file_list)
678
work_tree.lock_read()
680
if revision is not None:
681
tree = revision.as_tree(work_tree.branch)
683
extra_trees = [work_tree]
689
if file_list is not None:
690
file_ids = tree.paths2ids(file_list, trees=extra_trees,
691
require_versioned=True)
692
# find_ids_across_trees may include some paths that don't
694
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
695
for file_id in file_ids if file_id in tree)
697
entries = tree.inventory.entries()
700
if tree is not work_tree:
703
for path, entry in entries:
704
if kind and kind != entry.kind:
707
self.outf.write('%-50s %s\n' % (path, entry.file_id))
709
self.outf.write(path)
710
self.outf.write('\n')
713
class cmd_mv(Command):
714
"""Move or rename a file.
717
bzr mv OLDNAME NEWNAME
719
bzr mv SOURCE... DESTINATION
721
If the last argument is a versioned directory, all the other names
722
are moved into it. Otherwise, there must be exactly two arguments
723
and the file is changed to a new name.
725
If OLDNAME does not exist on the filesystem but is versioned and
726
NEWNAME does exist on the filesystem but is not versioned, mv
727
assumes that the file has been manually moved and only updates
728
its internal inventory to reflect that change.
729
The same is valid when moving many SOURCE files to a DESTINATION.
731
Files cannot be moved between branches.
734
takes_args = ['names*']
735
takes_options = [Option("after", help="Move only the bzr identifier"
736
" of the file, because the file has already been moved."),
737
Option('auto', help='Automatically guess renames.'),
738
Option('dry-run', help='Avoid making changes when guessing renames.'),
740
aliases = ['move', 'rename']
741
encoding_type = 'replace'
743
def run(self, names_list, after=False, auto=False, dry_run=False):
745
return self.run_auto(names_list, after, dry_run)
747
raise errors.BzrCommandError('--dry-run requires --auto.')
748
if names_list is None:
750
if len(names_list) < 2:
751
raise errors.BzrCommandError("missing file argument")
752
tree, rel_names = tree_files(names_list, canonicalize=False)
755
self._run(tree, names_list, rel_names, after)
759
def run_auto(self, names_list, after, dry_run):
760
if names_list is not None and len(names_list) > 1:
761
raise errors.BzrCommandError('Only one path may be specified to'
764
raise errors.BzrCommandError('--after cannot be specified with'
766
work_tree, file_list = tree_files(names_list, default_branch='.')
767
work_tree.lock_write()
769
rename_map.RenameMap.guess_renames(work_tree, dry_run)
773
def _run(self, tree, names_list, rel_names, after):
774
into_existing = osutils.isdir(names_list[-1])
775
if into_existing and len(names_list) == 2:
777
# a. case-insensitive filesystem and change case of dir
778
# b. move directory after the fact (if the source used to be
779
# a directory, but now doesn't exist in the working tree
780
# and the target is an existing directory, just rename it)
781
if (not tree.case_sensitive
782
and rel_names[0].lower() == rel_names[1].lower()):
783
into_existing = False
786
# 'fix' the case of a potential 'from'
787
from_id = tree.path2id(
788
tree.get_canonical_inventory_path(rel_names[0]))
789
if (not osutils.lexists(names_list[0]) and
790
from_id and inv.get_file_kind(from_id) == "directory"):
791
into_existing = False
794
# move into existing directory
795
# All entries reference existing inventory items, so fix them up
796
# for cicp file-systems.
797
rel_names = tree.get_canonical_inventory_paths(rel_names)
798
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
799
self.outf.write("%s => %s\n" % pair)
801
if len(names_list) != 2:
802
raise errors.BzrCommandError('to mv multiple files the'
803
' destination must be a versioned'
806
# for cicp file-systems: the src references an existing inventory
808
src = tree.get_canonical_inventory_path(rel_names[0])
809
# Find the canonical version of the destination: In all cases, the
810
# parent of the target must be in the inventory, so we fetch the
811
# canonical version from there (we do not always *use* the
812
# canonicalized tail portion - we may be attempting to rename the
814
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
815
dest_parent = osutils.dirname(canon_dest)
816
spec_tail = osutils.basename(rel_names[1])
817
# For a CICP file-system, we need to avoid creating 2 inventory
818
# entries that differ only by case. So regardless of the case
819
# we *want* to use (ie, specified by the user or the file-system),
820
# we must always choose to use the case of any existing inventory
821
# items. The only exception to this is when we are attempting a
822
# case-only rename (ie, canonical versions of src and dest are
824
dest_id = tree.path2id(canon_dest)
825
if dest_id is None or tree.path2id(src) == dest_id:
826
# No existing item we care about, so work out what case we
827
# are actually going to use.
829
# If 'after' is specified, the tail must refer to a file on disk.
831
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
833
# pathjoin with an empty tail adds a slash, which breaks
835
dest_parent_fq = tree.basedir
837
dest_tail = osutils.canonical_relpath(
839
osutils.pathjoin(dest_parent_fq, spec_tail))
841
# not 'after', so case as specified is used
842
dest_tail = spec_tail
844
# Use the existing item so 'mv' fails with AlreadyVersioned.
845
dest_tail = os.path.basename(canon_dest)
846
dest = osutils.pathjoin(dest_parent, dest_tail)
847
mutter("attempting to move %s => %s", src, dest)
848
tree.rename_one(src, dest, after=after)
849
self.outf.write("%s => %s\n" % (src, dest))
852
class cmd_pull(Command):
853
"""Turn this branch into a mirror of another branch.
855
This command only works on branches that have not diverged. Branches are
856
considered diverged if the destination branch's most recent commit is one
857
that has not been merged (directly or indirectly) into the parent.
859
If branches have diverged, you can use 'bzr merge' to integrate the changes
860
from one into the other. Once one branch has merged, the other should
861
be able to pull it again.
863
If you want to forget your local changes and just update your branch to
864
match the remote one, use pull --overwrite.
866
If there is no default location set, the first pull will set it. After
867
that, you can omit the location to use the default. To change the
868
default, use --remember. The value will only be saved if the remote
869
location can be accessed.
871
Note: The location can be specified either in the form of a branch,
872
or in the form of a path to a file containing a merge directive generated
876
_see_also = ['push', 'update', 'status-flags', 'send']
877
takes_options = ['remember', 'overwrite', 'revision',
878
custom_help('verbose',
879
help='Show logs of pulled revisions.'),
881
help='Branch to pull into, '
882
'rather than the one containing the working directory.',
887
help="Perform a local pull in a bound "
888
"branch. Local pulls are not applied to "
892
takes_args = ['location?']
893
encoding_type = 'replace'
895
def run(self, location=None, remember=False, overwrite=False,
896
revision=None, verbose=False,
897
directory=None, local=False):
898
# FIXME: too much stuff is in the command class
901
if directory is None:
904
tree_to = WorkingTree.open_containing(directory)[0]
905
branch_to = tree_to.branch
906
except errors.NoWorkingTree:
908
branch_to = Branch.open_containing(directory)[0]
910
if local and not branch_to.get_bound_location():
911
raise errors.LocalRequiresBoundBranch()
913
possible_transports = []
914
if location is not None:
916
mergeable = bundle.read_mergeable_from_url(location,
917
possible_transports=possible_transports)
918
except errors.NotABundle:
921
stored_loc = branch_to.get_parent()
923
if stored_loc is None:
924
raise errors.BzrCommandError("No pull location known or"
927
display_url = urlutils.unescape_for_display(stored_loc,
930
self.outf.write("Using saved parent location: %s\n" % display_url)
931
location = stored_loc
933
revision = _get_one_revision('pull', revision)
934
if mergeable is not None:
935
if revision is not None:
936
raise errors.BzrCommandError(
937
'Cannot use -r with merge directives or bundles')
938
mergeable.install_revisions(branch_to.repository)
939
base_revision_id, revision_id, verified = \
940
mergeable.get_merge_request(branch_to.repository)
941
branch_from = branch_to
943
branch_from = Branch.open(location,
944
possible_transports=possible_transports)
946
if branch_to.get_parent() is None or remember:
947
branch_to.set_parent(branch_from.base)
949
if branch_from is not branch_to:
950
branch_from.lock_read()
952
if revision is not None:
953
revision_id = revision.as_revision_id(branch_from)
955
branch_to.lock_write()
957
if tree_to is not None:
958
view_info = _get_view_info_for_change_reporter(tree_to)
959
change_reporter = delta._ChangeReporter(
960
unversioned_filter=tree_to.is_ignored,
962
result = tree_to.pull(
963
branch_from, overwrite, revision_id, change_reporter,
964
possible_transports=possible_transports, local=local)
966
result = branch_to.pull(
967
branch_from, overwrite, revision_id, local=local)
969
result.report(self.outf)
970
if verbose and result.old_revid != result.new_revid:
971
log.show_branch_change(
972
branch_to, self.outf, result.old_revno,
977
if branch_from is not branch_to:
981
class cmd_push(Command):
982
"""Update a mirror of this branch.
984
The target branch will not have its working tree populated because this
985
is both expensive, and is not supported on remote file systems.
987
Some smart servers or protocols *may* put the working tree in place in
990
This command only works on branches that have not diverged. Branches are
991
considered diverged if the destination branch's most recent commit is one
992
that has not been merged (directly or indirectly) by the source branch.
994
If branches have diverged, you can use 'bzr push --overwrite' to replace
995
the other branch completely, discarding its unmerged changes.
997
If you want to ensure you have the different changes in the other branch,
998
do a merge (see bzr help merge) from the other branch, and commit that.
999
After that you will be able to do a push without '--overwrite'.
1001
If there is no default push location set, the first push will set it.
1002
After that, you can omit the location to use the default. To change the
1003
default, use --remember. The value will only be saved if the remote
1004
location can be accessed.
1007
_see_also = ['pull', 'update', 'working-trees']
1008
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1009
Option('create-prefix',
1010
help='Create the path leading up to the branch '
1011
'if it does not already exist.'),
1013
help='Branch to push from, '
1014
'rather than the one containing the working directory.',
1018
Option('use-existing-dir',
1019
help='By default push will fail if the target'
1020
' directory exists, but does not already'
1021
' have a control directory. This flag will'
1022
' allow push to proceed.'),
1024
help='Create a stacked branch that references the public location '
1025
'of the parent branch.'),
1026
Option('stacked-on',
1027
help='Create a stacked branch that refers to another branch '
1028
'for the commit history. Only the work not present in the '
1029
'referenced branch is included in the branch created.',
1032
help='Refuse to push if there are uncommitted changes in'
1033
' the working tree.'),
1035
takes_args = ['location?']
1036
encoding_type = 'replace'
1038
def run(self, location=None, remember=False, overwrite=False,
1039
create_prefix=False, verbose=False, revision=None,
1040
use_existing_dir=False, directory=None, stacked_on=None,
1041
stacked=False, strict=None):
1042
from bzrlib.push import _show_push_branch
1044
if directory is None:
1046
# Get the source branch
1048
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1050
strict = br_from.get_config().get_user_option('push_strict')
1051
if strict is not None:
1052
# FIXME: This should be better supported by config
1054
bools = dict(yes=True, no=False, on=True, off=False,
1055
true=True, false=False)
1057
strict = bools[strict.lower()]
1060
# Get the tip's revision_id
1061
revision = _get_one_revision('push', revision)
1062
if revision is not None:
1063
revision_id = revision.in_history(br_from).rev_id
1066
if (tree is not None and revision_id is None
1067
and (strict is None or strict)): # Default to True:
1068
changes = tree.changes_from(tree.basis_tree())
1069
if changes.has_changed() or len(tree.get_parent_ids()) > 1:
1070
raise errors.UncommittedChanges(tree)
1072
# Get the stacked_on branch, if any
1073
if stacked_on is not None:
1074
stacked_on = urlutils.normalize_url(stacked_on)
1076
parent_url = br_from.get_parent()
1078
parent = Branch.open(parent_url)
1079
stacked_on = parent.get_public_branch()
1081
# I considered excluding non-http url's here, thus forcing
1082
# 'public' branches only, but that only works for some
1083
# users, so it's best to just depend on the user spotting an
1084
# error by the feedback given to them. RBC 20080227.
1085
stacked_on = parent_url
1087
raise errors.BzrCommandError(
1088
"Could not determine branch to refer to.")
1090
# Get the destination location
1091
if location is None:
1092
stored_loc = br_from.get_push_location()
1093
if stored_loc is None:
1094
raise errors.BzrCommandError(
1095
"No push location known or specified.")
1097
display_url = urlutils.unescape_for_display(stored_loc,
1099
self.outf.write("Using saved push location: %s\n" % display_url)
1100
location = stored_loc
1102
_show_push_branch(br_from, revision_id, location, self.outf,
1103
verbose=verbose, overwrite=overwrite, remember=remember,
1104
stacked_on=stacked_on, create_prefix=create_prefix,
1105
use_existing_dir=use_existing_dir)
1108
class cmd_branch(Command):
1109
"""Create a new branch that is a copy of an existing branch.
1111
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1112
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1113
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1114
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1115
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1118
To retrieve the branch as of a particular revision, supply the --revision
1119
parameter, as in "branch foo/bar -r 5".
1122
_see_also = ['checkout']
1123
takes_args = ['from_location', 'to_location?']
1124
takes_options = ['revision', Option('hardlink',
1125
help='Hard-link working tree files where possible.'),
1127
help="Create a branch without a working-tree."),
1129
help='Create a stacked branch referring to the source branch. '
1130
'The new branch will depend on the availability of the source '
1131
'branch for all operations.'),
1132
Option('standalone',
1133
help='Do not use a shared repository, even if available.'),
1135
aliases = ['get', 'clone']
1137
def run(self, from_location, to_location=None, revision=None,
1138
hardlink=False, stacked=False, standalone=False, no_tree=False):
1139
from bzrlib.tag import _merge_tags_if_possible
1141
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1143
if (accelerator_tree is not None and
1144
accelerator_tree.supports_content_filtering()):
1145
accelerator_tree = None
1146
revision = _get_one_revision('branch', revision)
1149
if revision is not None:
1150
revision_id = revision.as_revision_id(br_from)
1152
# FIXME - wt.last_revision, fallback to branch, fall back to
1153
# None or perhaps NULL_REVISION to mean copy nothing
1155
revision_id = br_from.last_revision()
1156
if to_location is None:
1157
to_location = urlutils.derive_to_location(from_location)
1158
to_transport = transport.get_transport(to_location)
1160
to_transport.mkdir('.')
1161
except errors.FileExists:
1162
raise errors.BzrCommandError('Target directory "%s" already'
1163
' exists.' % to_location)
1164
except errors.NoSuchFile:
1165
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1168
# preserve whatever source format we have.
1169
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1170
possible_transports=[to_transport],
1171
accelerator_tree=accelerator_tree,
1172
hardlink=hardlink, stacked=stacked,
1173
force_new_repo=standalone,
1174
create_tree_if_local=not no_tree,
1175
source_branch=br_from)
1176
branch = dir.open_branch()
1177
except errors.NoSuchRevision:
1178
to_transport.delete_tree('.')
1179
msg = "The branch %s has no revision %s." % (from_location,
1181
raise errors.BzrCommandError(msg)
1182
_merge_tags_if_possible(br_from, branch)
1183
# If the source branch is stacked, the new branch may
1184
# be stacked whether we asked for that explicitly or not.
1185
# We therefore need a try/except here and not just 'if stacked:'
1187
note('Created new stacked branch referring to %s.' %
1188
branch.get_stacked_on_url())
1189
except (errors.NotStacked, errors.UnstackableBranchFormat,
1190
errors.UnstackableRepositoryFormat), e:
1191
note('Branched %d revision(s).' % branch.revno())
1196
class cmd_checkout(Command):
1197
"""Create a new checkout of an existing branch.
1199
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1200
the branch found in '.'. This is useful if you have removed the working tree
1201
or if it was never created - i.e. if you pushed the branch to its current
1202
location using SFTP.
1204
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1205
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1206
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1207
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1208
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1211
To retrieve the branch as of a particular revision, supply the --revision
1212
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1213
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1217
_see_also = ['checkouts', 'branch']
1218
takes_args = ['branch_location?', 'to_location?']
1219
takes_options = ['revision',
1220
Option('lightweight',
1221
help="Perform a lightweight checkout. Lightweight "
1222
"checkouts depend on access to the branch for "
1223
"every operation. Normal checkouts can perform "
1224
"common operations like diff and status without "
1225
"such access, and also support local commits."
1227
Option('files-from', type=str,
1228
help="Get file contents from this tree."),
1230
help='Hard-link working tree files where possible.'
1235
def run(self, branch_location=None, to_location=None, revision=None,
1236
lightweight=False, files_from=None, hardlink=False):
1237
if branch_location is None:
1238
branch_location = osutils.getcwd()
1239
to_location = branch_location
1240
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1242
revision = _get_one_revision('checkout', revision)
1243
if files_from is not None:
1244
accelerator_tree = WorkingTree.open(files_from)
1245
if revision is not None:
1246
revision_id = revision.as_revision_id(source)
1249
if to_location is None:
1250
to_location = urlutils.derive_to_location(branch_location)
1251
# if the source and to_location are the same,
1252
# and there is no working tree,
1253
# then reconstitute a branch
1254
if (osutils.abspath(to_location) ==
1255
osutils.abspath(branch_location)):
1257
source.bzrdir.open_workingtree()
1258
except errors.NoWorkingTree:
1259
source.bzrdir.create_workingtree(revision_id)
1261
source.create_checkout(to_location, revision_id, lightweight,
1262
accelerator_tree, hardlink)
1265
class cmd_renames(Command):
1266
"""Show list of renamed files.
1268
# TODO: Option to show renames between two historical versions.
1270
# TODO: Only show renames under dir, rather than in the whole branch.
1271
_see_also = ['status']
1272
takes_args = ['dir?']
1275
def run(self, dir=u'.'):
1276
tree = WorkingTree.open_containing(dir)[0]
1279
new_inv = tree.inventory
1280
old_tree = tree.basis_tree()
1281
old_tree.lock_read()
1283
old_inv = old_tree.inventory
1285
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1286
for f, paths, c, v, p, n, k, e in iterator:
1287
if paths[0] == paths[1]:
1291
renames.append(paths)
1293
for old_name, new_name in renames:
1294
self.outf.write("%s => %s\n" % (old_name, new_name))
1301
class cmd_update(Command):
1302
"""Update a tree to have the latest code committed to its branch.
1304
This will perform a merge into the working tree, and may generate
1305
conflicts. If you have any local changes, you will still
1306
need to commit them after the update for the update to be complete.
1308
If you want to discard your local changes, you can just do a
1309
'bzr revert' instead of 'bzr commit' after the update.
1312
_see_also = ['pull', 'working-trees', 'status-flags']
1313
takes_args = ['dir?']
1316
def run(self, dir='.'):
1317
tree = WorkingTree.open_containing(dir)[0]
1318
possible_transports = []
1319
master = tree.branch.get_master_branch(
1320
possible_transports=possible_transports)
1321
if master is not None:
1324
tree.lock_tree_write()
1326
existing_pending_merges = tree.get_parent_ids()[1:]
1327
last_rev = _mod_revision.ensure_null(tree.last_revision())
1328
if last_rev == _mod_revision.ensure_null(
1329
tree.branch.last_revision()):
1330
# may be up to date, check master too.
1331
if master is None or last_rev == _mod_revision.ensure_null(
1332
master.last_revision()):
1333
revno = tree.branch.revision_id_to_revno(last_rev)
1334
note("Tree is up to date at revision %d." % (revno,))
1336
view_info = _get_view_info_for_change_reporter(tree)
1337
conflicts = tree.update(
1338
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1339
view_info=view_info), possible_transports=possible_transports)
1340
revno = tree.branch.revision_id_to_revno(
1341
_mod_revision.ensure_null(tree.last_revision()))
1342
note('Updated to revision %d.' % (revno,))
1343
if tree.get_parent_ids()[1:] != existing_pending_merges:
1344
note('Your local commits will now show as pending merges with '
1345
"'bzr status', and can be committed with 'bzr commit'.")
1354
class cmd_info(Command):
1355
"""Show information about a working tree, branch or repository.
1357
This command will show all known locations and formats associated to the
1358
tree, branch or repository.
1360
In verbose mode, statistical information is included with each report.
1361
To see extended statistic information, use a verbosity level of 2 or
1362
higher by specifying the verbose option multiple times, e.g. -vv.
1364
Branches and working trees will also report any missing revisions.
1368
Display information on the format and related locations:
1372
Display the above together with extended format information and
1373
basic statistics (like the number of files in the working tree and
1374
number of revisions in the branch and repository):
1378
Display the above together with number of committers to the branch:
1382
_see_also = ['revno', 'working-trees', 'repositories']
1383
takes_args = ['location?']
1384
takes_options = ['verbose']
1385
encoding_type = 'replace'
1388
def run(self, location=None, verbose=False):
1390
noise_level = get_verbosity_level()
1393
from bzrlib.info import show_bzrdir_info
1394
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1395
verbose=noise_level, outfile=self.outf)
1398
class cmd_remove(Command):
1399
"""Remove files or directories.
1401
This makes bzr stop tracking changes to the specified files. bzr will delete
1402
them if they can easily be recovered using revert. If no options or
1403
parameters are given bzr will scan for files that are being tracked by bzr
1404
but missing in your tree and stop tracking them for you.
1406
takes_args = ['file*']
1407
takes_options = ['verbose',
1408
Option('new', help='Only remove files that have never been committed.'),
1409
RegistryOption.from_kwargs('file-deletion-strategy',
1410
'The file deletion mode to be used.',
1411
title='Deletion Strategy', value_switches=True, enum_switch=False,
1412
safe='Only delete files if they can be'
1413
' safely recovered (default).',
1414
keep="Don't delete any files.",
1415
force='Delete all the specified files, even if they can not be '
1416
'recovered and even if they are non-empty directories.')]
1417
aliases = ['rm', 'del']
1418
encoding_type = 'replace'
1420
def run(self, file_list, verbose=False, new=False,
1421
file_deletion_strategy='safe'):
1422
tree, file_list = tree_files(file_list)
1424
if file_list is not None:
1425
file_list = [f for f in file_list]
1429
# Heuristics should probably all move into tree.remove_smart or
1432
added = tree.changes_from(tree.basis_tree(),
1433
specific_files=file_list).added
1434
file_list = sorted([f[0] for f in added], reverse=True)
1435
if len(file_list) == 0:
1436
raise errors.BzrCommandError('No matching files.')
1437
elif file_list is None:
1438
# missing files show up in iter_changes(basis) as
1439
# versioned-with-no-kind.
1441
for change in tree.iter_changes(tree.basis_tree()):
1442
# Find paths in the working tree that have no kind:
1443
if change[1][1] is not None and change[6][1] is None:
1444
missing.append(change[1][1])
1445
file_list = sorted(missing, reverse=True)
1446
file_deletion_strategy = 'keep'
1447
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1448
keep_files=file_deletion_strategy=='keep',
1449
force=file_deletion_strategy=='force')
1454
class cmd_file_id(Command):
1455
"""Print file_id of a particular file or directory.
1457
The file_id is assigned when the file is first added and remains the
1458
same through all revisions where the file exists, even when it is
1463
_see_also = ['inventory', 'ls']
1464
takes_args = ['filename']
1467
def run(self, filename):
1468
tree, relpath = WorkingTree.open_containing(filename)
1469
i = tree.path2id(relpath)
1471
raise errors.NotVersionedError(filename)
1473
self.outf.write(i + '\n')
1476
class cmd_file_path(Command):
1477
"""Print path of file_ids to a file or directory.
1479
This prints one line for each directory down to the target,
1480
starting at the branch root.
1484
takes_args = ['filename']
1487
def run(self, filename):
1488
tree, relpath = WorkingTree.open_containing(filename)
1489
fid = tree.path2id(relpath)
1491
raise errors.NotVersionedError(filename)
1492
segments = osutils.splitpath(relpath)
1493
for pos in range(1, len(segments) + 1):
1494
path = osutils.joinpath(segments[:pos])
1495
self.outf.write("%s\n" % tree.path2id(path))
1498
class cmd_reconcile(Command):
1499
"""Reconcile bzr metadata in a branch.
1501
This can correct data mismatches that may have been caused by
1502
previous ghost operations or bzr upgrades. You should only
1503
need to run this command if 'bzr check' or a bzr developer
1504
advises you to run it.
1506
If a second branch is provided, cross-branch reconciliation is
1507
also attempted, which will check that data like the tree root
1508
id which was not present in very early bzr versions is represented
1509
correctly in both branches.
1511
At the same time it is run it may recompress data resulting in
1512
a potential saving in disk space or performance gain.
1514
The branch *MUST* be on a listable system such as local disk or sftp.
1517
_see_also = ['check']
1518
takes_args = ['branch?']
1520
def run(self, branch="."):
1521
from bzrlib.reconcile import reconcile
1522
dir = bzrdir.BzrDir.open(branch)
1526
class cmd_revision_history(Command):
1527
"""Display the list of revision ids on a branch."""
1530
takes_args = ['location?']
1535
def run(self, location="."):
1536
branch = Branch.open_containing(location)[0]
1537
for revid in branch.revision_history():
1538
self.outf.write(revid)
1539
self.outf.write('\n')
1542
class cmd_ancestry(Command):
1543
"""List all revisions merged into this branch."""
1545
_see_also = ['log', 'revision-history']
1546
takes_args = ['location?']
1551
def run(self, location="."):
1553
wt = WorkingTree.open_containing(location)[0]
1554
except errors.NoWorkingTree:
1555
b = Branch.open(location)
1556
last_revision = b.last_revision()
1559
last_revision = wt.last_revision()
1561
revision_ids = b.repository.get_ancestry(last_revision)
1563
for revision_id in revision_ids:
1564
self.outf.write(revision_id + '\n')
1567
class cmd_init(Command):
1568
"""Make a directory into a versioned branch.
1570
Use this to create an empty branch, or before importing an
1573
If there is a repository in a parent directory of the location, then
1574
the history of the branch will be stored in the repository. Otherwise
1575
init creates a standalone branch which carries its own history
1576
in the .bzr directory.
1578
If there is already a branch at the location but it has no working tree,
1579
the tree can be populated with 'bzr checkout'.
1581
Recipe for importing a tree of files::
1587
bzr commit -m "imported project"
1590
_see_also = ['init-repository', 'branch', 'checkout']
1591
takes_args = ['location?']
1593
Option('create-prefix',
1594
help='Create the path leading up to the branch '
1595
'if it does not already exist.'),
1596
RegistryOption('format',
1597
help='Specify a format for this branch. '
1598
'See "help formats".',
1599
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1600
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1601
value_switches=True,
1602
title="Branch Format",
1604
Option('append-revisions-only',
1605
help='Never change revnos or the existing log.'
1606
' Append revisions to it only.')
1608
def run(self, location=None, format=None, append_revisions_only=False,
1609
create_prefix=False):
1611
format = bzrdir.format_registry.make_bzrdir('default')
1612
if location is None:
1615
to_transport = transport.get_transport(location)
1617
# The path has to exist to initialize a
1618
# branch inside of it.
1619
# Just using os.mkdir, since I don't
1620
# believe that we want to create a bunch of
1621
# locations if the user supplies an extended path
1623
to_transport.ensure_base()
1624
except errors.NoSuchFile:
1625
if not create_prefix:
1626
raise errors.BzrCommandError("Parent directory of %s"
1628
"\nYou may supply --create-prefix to create all"
1629
" leading parent directories."
1631
to_transport.create_prefix()
1634
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1635
except errors.NotBranchError:
1636
# really a NotBzrDir error...
1637
create_branch = bzrdir.BzrDir.create_branch_convenience
1638
branch = create_branch(to_transport.base, format=format,
1639
possible_transports=[to_transport])
1640
a_bzrdir = branch.bzrdir
1642
from bzrlib.transport.local import LocalTransport
1643
if a_bzrdir.has_branch():
1644
if (isinstance(to_transport, LocalTransport)
1645
and not a_bzrdir.has_workingtree()):
1646
raise errors.BranchExistsWithoutWorkingTree(location)
1647
raise errors.AlreadyBranchError(location)
1648
branch = a_bzrdir.create_branch()
1649
a_bzrdir.create_workingtree()
1650
if append_revisions_only:
1652
branch.set_append_revisions_only(True)
1653
except errors.UpgradeRequired:
1654
raise errors.BzrCommandError('This branch format cannot be set'
1655
' to append-revisions-only. Try --default.')
1657
from bzrlib.info import describe_layout, describe_format
1659
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1660
except (errors.NoWorkingTree, errors.NotLocalUrl):
1662
repository = branch.repository
1663
layout = describe_layout(repository, branch, tree).lower()
1664
format = describe_format(a_bzrdir, repository, branch, tree)
1665
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1666
if repository.is_shared():
1667
#XXX: maybe this can be refactored into transport.path_or_url()
1668
url = repository.bzrdir.root_transport.external_url()
1670
url = urlutils.local_path_from_url(url)
1671
except errors.InvalidURL:
1673
self.outf.write("Using shared repository: %s\n" % url)
1676
class cmd_init_repository(Command):
1677
"""Create a shared repository to hold branches.
1679
New branches created under the repository directory will store their
1680
revisions in the repository, not in the branch directory.
1682
If the --no-trees option is used then the branches in the repository
1683
will not have working trees by default.
1686
Create a shared repositories holding just branches::
1688
bzr init-repo --no-trees repo
1691
Make a lightweight checkout elsewhere::
1693
bzr checkout --lightweight repo/trunk trunk-checkout
1698
_see_also = ['init', 'branch', 'checkout', 'repositories']
1699
takes_args = ["location"]
1700
takes_options = [RegistryOption('format',
1701
help='Specify a format for this repository. See'
1702
' "bzr help formats" for details.',
1703
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1704
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1705
value_switches=True, title='Repository format'),
1707
help='Branches in the repository will default to'
1708
' not having a working tree.'),
1710
aliases = ["init-repo"]
1712
def run(self, location, format=None, no_trees=False):
1714
format = bzrdir.format_registry.make_bzrdir('default')
1716
if location is None:
1719
to_transport = transport.get_transport(location)
1720
to_transport.ensure_base()
1722
newdir = format.initialize_on_transport(to_transport)
1723
repo = newdir.create_repository(shared=True)
1724
repo.set_make_working_trees(not no_trees)
1726
from bzrlib.info import show_bzrdir_info
1727
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1730
class cmd_diff(Command):
1731
"""Show differences in the working tree, between revisions or branches.
1733
If no arguments are given, all changes for the current tree are listed.
1734
If files are given, only the changes in those files are listed.
1735
Remote and multiple branches can be compared by using the --old and
1736
--new options. If not provided, the default for both is derived from
1737
the first argument, if any, or the current tree if no arguments are
1740
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1741
produces patches suitable for "patch -p1".
1745
2 - unrepresentable changes
1750
Shows the difference in the working tree versus the last commit::
1754
Difference between the working tree and revision 1::
1758
Difference between revision 2 and revision 1::
1762
Difference between revision 2 and revision 1 for branch xxx::
1766
Show just the differences for file NEWS::
1770
Show the differences in working tree xxx for file NEWS::
1774
Show the differences from branch xxx to this working tree:
1778
Show the differences between two branches for file NEWS::
1780
bzr diff --old xxx --new yyy NEWS
1782
Same as 'bzr diff' but prefix paths with old/ and new/::
1784
bzr diff --prefix old/:new/
1786
_see_also = ['status']
1787
takes_args = ['file*']
1789
Option('diff-options', type=str,
1790
help='Pass these options to the external diff program.'),
1791
Option('prefix', type=str,
1793
help='Set prefixes added to old and new filenames, as '
1794
'two values separated by a colon. (eg "old/:new/").'),
1796
help='Branch/tree to compare from.',
1800
help='Branch/tree to compare to.',
1806
help='Use this command to compare files.',
1810
aliases = ['di', 'dif']
1811
encoding_type = 'exact'
1814
def run(self, revision=None, file_list=None, diff_options=None,
1815
prefix=None, old=None, new=None, using=None):
1816
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1818
if (prefix is None) or (prefix == '0'):
1826
old_label, new_label = prefix.split(":")
1828
raise errors.BzrCommandError(
1829
'--prefix expects two values separated by a colon'
1830
' (eg "old/:new/")')
1832
if revision and len(revision) > 2:
1833
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1834
' one or two revision specifiers')
1836
old_tree, new_tree, specific_files, extra_trees = \
1837
_get_trees_to_diff(file_list, revision, old, new,
1839
return show_diff_trees(old_tree, new_tree, sys.stdout,
1840
specific_files=specific_files,
1841
external_diff_options=diff_options,
1842
old_label=old_label, new_label=new_label,
1843
extra_trees=extra_trees, using=using)
1846
class cmd_deleted(Command):
1847
"""List files deleted in the working tree.
1849
# TODO: Show files deleted since a previous revision, or
1850
# between two revisions.
1851
# TODO: Much more efficient way to do this: read in new
1852
# directories with readdir, rather than stating each one. Same
1853
# level of effort but possibly much less IO. (Or possibly not,
1854
# if the directories are very large...)
1855
_see_also = ['status', 'ls']
1856
takes_options = ['show-ids']
1859
def run(self, show_ids=False):
1860
tree = WorkingTree.open_containing(u'.')[0]
1863
old = tree.basis_tree()
1866
for path, ie in old.inventory.iter_entries():
1867
if not tree.has_id(ie.file_id):
1868
self.outf.write(path)
1870
self.outf.write(' ')
1871
self.outf.write(ie.file_id)
1872
self.outf.write('\n')
1879
class cmd_modified(Command):
1880
"""List files modified in working tree.
1884
_see_also = ['status', 'ls']
1887
help='Write an ascii NUL (\\0) separator '
1888
'between files rather than a newline.')
1892
def run(self, null=False):
1893
tree = WorkingTree.open_containing(u'.')[0]
1894
td = tree.changes_from(tree.basis_tree())
1895
for path, id, kind, text_modified, meta_modified in td.modified:
1897
self.outf.write(path + '\0')
1899
self.outf.write(osutils.quotefn(path) + '\n')
1902
class cmd_added(Command):
1903
"""List files added in working tree.
1907
_see_also = ['status', 'ls']
1910
help='Write an ascii NUL (\\0) separator '
1911
'between files rather than a newline.')
1915
def run(self, null=False):
1916
wt = WorkingTree.open_containing(u'.')[0]
1919
basis = wt.basis_tree()
1922
basis_inv = basis.inventory
1925
if file_id in basis_inv:
1927
if inv.is_root(file_id) and len(basis_inv) == 0:
1929
path = inv.id2path(file_id)
1930
if not os.access(osutils.abspath(path), os.F_OK):
1933
self.outf.write(path + '\0')
1935
self.outf.write(osutils.quotefn(path) + '\n')
1942
class cmd_root(Command):
1943
"""Show the tree root directory.
1945
The root is the nearest enclosing directory with a .bzr control
1948
takes_args = ['filename?']
1950
def run(self, filename=None):
1951
"""Print the branch root."""
1952
tree = WorkingTree.open_containing(filename)[0]
1953
self.outf.write(tree.basedir + '\n')
1956
def _parse_limit(limitstring):
1958
return int(limitstring)
1960
msg = "The limit argument must be an integer."
1961
raise errors.BzrCommandError(msg)
1964
def _parse_levels(s):
1968
msg = "The levels argument must be an integer."
1969
raise errors.BzrCommandError(msg)
1972
class cmd_log(Command):
1973
"""Show historical log for a branch or subset of a branch.
1975
log is bzr's default tool for exploring the history of a branch.
1976
The branch to use is taken from the first parameter. If no parameters
1977
are given, the branch containing the working directory is logged.
1978
Here are some simple examples::
1980
bzr log log the current branch
1981
bzr log foo.py log a file in its branch
1982
bzr log http://server/branch log a branch on a server
1984
The filtering, ordering and information shown for each revision can
1985
be controlled as explained below. By default, all revisions are
1986
shown sorted (topologically) so that newer revisions appear before
1987
older ones and descendants always appear before ancestors. If displayed,
1988
merged revisions are shown indented under the revision in which they
1993
The log format controls how information about each revision is
1994
displayed. The standard log formats are called ``long``, ``short``
1995
and ``line``. The default is long. See ``bzr help log-formats``
1996
for more details on log formats.
1998
The following options can be used to control what information is
2001
-l N display a maximum of N revisions
2002
-n N display N levels of revisions (0 for all, 1 for collapsed)
2003
-v display a status summary (delta) for each revision
2004
-p display a diff (patch) for each revision
2005
--show-ids display revision-ids (and file-ids), not just revnos
2007
Note that the default number of levels to display is a function of the
2008
log format. If the -n option is not used, the standard log formats show
2009
just the top level (mainline).
2011
Status summaries are shown using status flags like A, M, etc. To see
2012
the changes explained using words like ``added`` and ``modified``
2013
instead, use the -vv option.
2017
To display revisions from oldest to newest, use the --forward option.
2018
In most cases, using this option will have little impact on the total
2019
time taken to produce a log, though --forward does not incrementally
2020
display revisions like --reverse does when it can.
2022
:Revision filtering:
2024
The -r option can be used to specify what revision or range of revisions
2025
to filter against. The various forms are shown below::
2027
-rX display revision X
2028
-rX.. display revision X and later
2029
-r..Y display up to and including revision Y
2030
-rX..Y display from X to Y inclusive
2032
See ``bzr help revisionspec`` for details on how to specify X and Y.
2033
Some common examples are given below::
2035
-r-1 show just the tip
2036
-r-10.. show the last 10 mainline revisions
2037
-rsubmit:.. show what's new on this branch
2038
-rancestor:path.. show changes since the common ancestor of this
2039
branch and the one at location path
2040
-rdate:yesterday.. show changes since yesterday
2042
When logging a range of revisions using -rX..Y, log starts at
2043
revision Y and searches back in history through the primary
2044
("left-hand") parents until it finds X. When logging just the
2045
top level (using -n1), an error is reported if X is not found
2046
along the way. If multi-level logging is used (-n0), X may be
2047
a nested merge revision and the log will be truncated accordingly.
2051
If parameters are given and the first one is not a branch, the log
2052
will be filtered to show only those revisions that changed the
2053
nominated files or directories.
2055
Filenames are interpreted within their historical context. To log a
2056
deleted file, specify a revision range so that the file existed at
2057
the end or start of the range.
2059
Historical context is also important when interpreting pathnames of
2060
renamed files/directories. Consider the following example:
2062
* revision 1: add tutorial.txt
2063
* revision 2: modify tutorial.txt
2064
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2068
* ``bzr log guide.txt`` will log the file added in revision 1
2070
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2072
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2073
the original file in revision 2.
2075
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2076
was no file called guide.txt in revision 2.
2078
Renames are always followed by log. By design, there is no need to
2079
explicitly ask for this (and no way to stop logging a file back
2080
until it was last renamed).
2084
The --message option can be used for finding revisions that match a
2085
regular expression in a commit message.
2089
GUI tools and IDEs are often better at exploring history than command
2090
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2091
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2092
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2094
Web interfaces are often better at exploring history than command line
2095
tools, particularly for branches on servers. You may prefer Loggerhead
2096
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2098
You may find it useful to add the aliases below to ``bazaar.conf``::
2102
top = log -l10 --line
2105
``bzr tip`` will then show the latest revision while ``bzr top``
2106
will show the last 10 mainline revisions. To see the details of a
2107
particular revision X, ``bzr show -rX``.
2109
If you are interested in looking deeper into a particular merge X,
2110
use ``bzr log -n0 -rX``.
2112
``bzr log -v`` on a branch with lots of history is currently
2113
very slow. A fix for this issue is currently under development.
2114
With or without that fix, it is recommended that a revision range
2115
be given when using the -v option.
2117
bzr has a generic full-text matching plugin, bzr-search, that can be
2118
used to find revisions matching user names, commit messages, etc.
2119
Among other features, this plugin can find all revisions containing
2120
a list of words but not others.
2122
When exploring non-mainline history on large projects with deep
2123
history, the performance of log can be greatly improved by installing
2124
the historycache plugin. This plugin buffers historical information
2125
trading disk space for faster speed.
2127
takes_args = ['file*']
2128
_see_also = ['log-formats', 'revisionspec']
2131
help='Show from oldest to newest.'),
2133
custom_help('verbose',
2134
help='Show files changed in each revision.'),
2138
type=bzrlib.option._parse_revision_str,
2140
help='Show just the specified revision.'
2141
' See also "help revisionspec".'),
2145
help='Number of levels to display - 0 for all, 1 for flat.',
2147
type=_parse_levels),
2150
help='Show revisions whose message matches this '
2151
'regular expression.',
2155
help='Limit the output to the first N revisions.',
2160
help='Show changes made in each revision as a patch.'),
2161
Option('include-merges',
2162
help='Show merged revisions like --levels 0 does.'),
2164
encoding_type = 'replace'
2167
def run(self, file_list=None, timezone='original',
2178
include_merges=False):
2179
from bzrlib.log import (
2181
make_log_request_dict,
2182
_get_info_for_log_files,
2184
direction = (forward and 'forward') or 'reverse'
2189
raise errors.BzrCommandError(
2190
'--levels and --include-merges are mutually exclusive')
2192
if change is not None:
2194
raise errors.RangeInChangeOption()
2195
if revision is not None:
2196
raise errors.BzrCommandError(
2197
'--revision and --change are mutually exclusive')
2202
filter_by_dir = False
2204
# find the file ids to log and check for directory filtering
2205
b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2207
for relpath, file_id, kind in file_info_list:
2209
raise errors.BzrCommandError(
2210
"Path unknown at end or start of revision range: %s" %
2212
# If the relpath is the top of the tree, we log everything
2217
file_ids.append(file_id)
2218
filter_by_dir = filter_by_dir or (
2219
kind in ['directory', 'tree-reference'])
2222
# FIXME ? log the current subdir only RBC 20060203
2223
if revision is not None \
2224
and len(revision) > 0 and revision[0].get_branch():
2225
location = revision[0].get_branch()
2228
dir, relpath = bzrdir.BzrDir.open_containing(location)
2229
b = dir.open_branch()
2230
rev1, rev2 = _get_revision_range(revision, b, self.name())
2232
# Decide on the type of delta & diff filtering to use
2233
# TODO: add an --all-files option to make this configurable & consistent
2241
diff_type = 'partial'
2247
# Build the log formatter
2248
if log_format is None:
2249
log_format = log.log_formatter_registry.get_default(b)
2250
lf = log_format(show_ids=show_ids, to_file=self.outf,
2251
show_timezone=timezone,
2252
delta_format=get_verbosity_level(),
2254
show_advice=levels is None)
2256
# Choose the algorithm for doing the logging. It's annoying
2257
# having multiple code paths like this but necessary until
2258
# the underlying repository format is faster at generating
2259
# deltas or can provide everything we need from the indices.
2260
# The default algorithm - match-using-deltas - works for
2261
# multiple files and directories and is faster for small
2262
# amounts of history (200 revisions say). However, it's too
2263
# slow for logging a single file in a repository with deep
2264
# history, i.e. > 10K revisions. In the spirit of "do no
2265
# evil when adding features", we continue to use the
2266
# original algorithm - per-file-graph - for the "single
2267
# file that isn't a directory without showing a delta" case.
2268
partial_history = revision and b.repository._format.supports_chks
2269
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2270
or delta_type or partial_history)
2272
# Build the LogRequest and execute it
2273
if len(file_ids) == 0:
2275
rqst = make_log_request_dict(
2276
direction=direction, specific_fileids=file_ids,
2277
start_revision=rev1, end_revision=rev2, limit=limit,
2278
message_search=message, delta_type=delta_type,
2279
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2280
Logger(b, rqst).show(lf)
2285
def _get_revision_range(revisionspec_list, branch, command_name):
2286
"""Take the input of a revision option and turn it into a revision range.
2288
It returns RevisionInfo objects which can be used to obtain the rev_id's
2289
of the desired revisions. It does some user input validations.
2291
if revisionspec_list is None:
2294
elif len(revisionspec_list) == 1:
2295
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2296
elif len(revisionspec_list) == 2:
2297
start_spec = revisionspec_list[0]
2298
end_spec = revisionspec_list[1]
2299
if end_spec.get_branch() != start_spec.get_branch():
2300
# b is taken from revision[0].get_branch(), and
2301
# show_log will use its revision_history. Having
2302
# different branches will lead to weird behaviors.
2303
raise errors.BzrCommandError(
2304
"bzr %s doesn't accept two revisions in different"
2305
" branches." % command_name)
2306
rev1 = start_spec.in_history(branch)
2307
# Avoid loading all of history when we know a missing
2308
# end of range means the last revision ...
2309
if end_spec.spec is None:
2310
last_revno, last_revision_id = branch.last_revision_info()
2311
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2313
rev2 = end_spec.in_history(branch)
2315
raise errors.BzrCommandError(
2316
'bzr %s --revision takes one or two values.' % command_name)
2320
def _revision_range_to_revid_range(revision_range):
2323
if revision_range[0] is not None:
2324
rev_id1 = revision_range[0].rev_id
2325
if revision_range[1] is not None:
2326
rev_id2 = revision_range[1].rev_id
2327
return rev_id1, rev_id2
2329
def get_log_format(long=False, short=False, line=False, default='long'):
2330
log_format = default
2334
log_format = 'short'
2340
class cmd_touching_revisions(Command):
2341
"""Return revision-ids which affected a particular file.
2343
A more user-friendly interface is "bzr log FILE".
2347
takes_args = ["filename"]
2350
def run(self, filename):
2351
tree, relpath = WorkingTree.open_containing(filename)
2353
file_id = tree.path2id(relpath)
2354
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2355
self.outf.write("%6d %s\n" % (revno, what))
2358
class cmd_ls(Command):
2359
"""List files in a tree.
2362
_see_also = ['status', 'cat']
2363
takes_args = ['path?']
2367
Option('recursive', short_name='R',
2368
help='Recurse into subdirectories.'),
2370
help='Print paths relative to the root of the branch.'),
2371
Option('unknown', help='Print unknown files.'),
2372
Option('versioned', help='Print versioned files.',
2374
Option('ignored', help='Print ignored files.'),
2376
help='Write an ascii NUL (\\0) separator '
2377
'between files rather than a newline.'),
2379
help='List entries of a particular kind: file, directory, symlink.',
2384
def run(self, revision=None, verbose=False,
2385
recursive=False, from_root=False,
2386
unknown=False, versioned=False, ignored=False,
2387
null=False, kind=None, show_ids=False, path=None):
2389
if kind and kind not in ('file', 'directory', 'symlink'):
2390
raise errors.BzrCommandError('invalid kind specified')
2392
if verbose and null:
2393
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2394
all = not (unknown or versioned or ignored)
2396
selection = {'I':ignored, '?':unknown, 'V':versioned}
2402
raise errors.BzrCommandError('cannot specify both --from-root'
2405
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2408
# Calculate the prefix to use
2412
prefix = relpath + '/'
2413
elif fs_path != '.':
2414
prefix = fs_path + '/'
2416
if revision is not None or tree is None:
2417
tree = _get_one_revision_tree('ls', revision, branch=branch)
2420
if isinstance(tree, WorkingTree) and tree.supports_views():
2421
view_files = tree.views.lookup_view()
2424
view_str = views.view_display_str(view_files)
2425
note("Ignoring files outside view. View is %s" % view_str)
2429
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2430
from_dir=relpath, recursive=recursive):
2431
# Apply additional masking
2432
if not all and not selection[fc]:
2434
if kind is not None and fkind != kind:
2439
fullpath = osutils.pathjoin(relpath, fp)
2442
views.check_path_in_view(tree, fullpath)
2443
except errors.FileOutsideView:
2448
fp = osutils.pathjoin(prefix, fp)
2449
kindch = entry.kind_character()
2450
outstring = fp + kindch
2451
ui.ui_factory.clear_term()
2453
outstring = '%-8s %s' % (fc, outstring)
2454
if show_ids and fid is not None:
2455
outstring = "%-50s %s" % (outstring, fid)
2456
self.outf.write(outstring + '\n')
2458
self.outf.write(fp + '\0')
2461
self.outf.write(fid)
2462
self.outf.write('\0')
2470
self.outf.write('%-50s %s\n' % (outstring, my_id))
2472
self.outf.write(outstring + '\n')
2477
class cmd_unknowns(Command):
2478
"""List unknown files.
2486
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2487
self.outf.write(osutils.quotefn(f) + '\n')
2490
class cmd_ignore(Command):
2491
"""Ignore specified files or patterns.
2493
See ``bzr help patterns`` for details on the syntax of patterns.
2495
To remove patterns from the ignore list, edit the .bzrignore file.
2496
After adding, editing or deleting that file either indirectly by
2497
using this command or directly by using an editor, be sure to commit
2500
Note: ignore patterns containing shell wildcards must be quoted from
2504
Ignore the top level Makefile::
2506
bzr ignore ./Makefile
2508
Ignore class files in all directories::
2510
bzr ignore "*.class"
2512
Ignore .o files under the lib directory::
2514
bzr ignore "lib/**/*.o"
2516
Ignore .o files under the lib directory::
2518
bzr ignore "RE:lib/.*\.o"
2520
Ignore everything but the "debian" toplevel directory::
2522
bzr ignore "RE:(?!debian/).*"
2525
_see_also = ['status', 'ignored', 'patterns']
2526
takes_args = ['name_pattern*']
2528
Option('old-default-rules',
2529
help='Write out the ignore rules bzr < 0.9 always used.')
2532
def run(self, name_pattern_list=None, old_default_rules=None):
2533
from bzrlib import ignores
2534
if old_default_rules is not None:
2535
# dump the rules and exit
2536
for pattern in ignores.OLD_DEFAULTS:
2539
if not name_pattern_list:
2540
raise errors.BzrCommandError("ignore requires at least one "
2541
"NAME_PATTERN or --old-default-rules")
2542
name_pattern_list = [globbing.normalize_pattern(p)
2543
for p in name_pattern_list]
2544
for name_pattern in name_pattern_list:
2545
if (name_pattern[0] == '/' or
2546
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2547
raise errors.BzrCommandError(
2548
"NAME_PATTERN should not be an absolute path")
2549
tree, relpath = WorkingTree.open_containing(u'.')
2550
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2551
ignored = globbing.Globster(name_pattern_list)
2554
for entry in tree.list_files():
2558
if ignored.match(filename):
2559
matches.append(filename.encode('utf-8'))
2561
if len(matches) > 0:
2562
print "Warning: the following files are version controlled and" \
2563
" match your ignore pattern:\n%s" \
2564
"\nThese files will continue to be version controlled" \
2565
" unless you 'bzr remove' them." % ("\n".join(matches),)
2568
class cmd_ignored(Command):
2569
"""List ignored files and the patterns that matched them.
2571
List all the ignored files and the ignore pattern that caused the file to
2574
Alternatively, to list just the files::
2579
encoding_type = 'replace'
2580
_see_also = ['ignore', 'ls']
2584
tree = WorkingTree.open_containing(u'.')[0]
2587
for path, file_class, kind, file_id, entry in tree.list_files():
2588
if file_class != 'I':
2590
## XXX: Slightly inefficient since this was already calculated
2591
pat = tree.is_ignored(path)
2592
self.outf.write('%-50s %s\n' % (path, pat))
2597
class cmd_lookup_revision(Command):
2598
"""Lookup the revision-id from a revision-number
2601
bzr lookup-revision 33
2604
takes_args = ['revno']
2607
def run(self, revno):
2611
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2613
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2616
class cmd_export(Command):
2617
"""Export current or past revision to a destination directory or archive.
2619
If no revision is specified this exports the last committed revision.
2621
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2622
given, try to find the format with the extension. If no extension
2623
is found exports to a directory (equivalent to --format=dir).
2625
If root is supplied, it will be used as the root directory inside
2626
container formats (tar, zip, etc). If it is not supplied it will default
2627
to the exported filename. The root option has no effect for 'dir' format.
2629
If branch is omitted then the branch containing the current working
2630
directory will be used.
2632
Note: Export of tree with non-ASCII filenames to zip is not supported.
2634
================= =========================
2635
Supported formats Autodetected by extension
2636
================= =========================
2639
tbz2 .tar.bz2, .tbz2
2642
================= =========================
2644
takes_args = ['dest', 'branch_or_subdir?']
2647
help="Type of file to export to.",
2650
Option('filters', help='Apply content filters to export the '
2651
'convenient form.'),
2654
help="Name of the root directory inside the exported file."),
2656
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2657
root=None, filters=False):
2658
from bzrlib.export import export
2660
if branch_or_subdir is None:
2661
tree = WorkingTree.open_containing(u'.')[0]
2665
b, subdir = Branch.open_containing(branch_or_subdir)
2668
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2670
export(rev_tree, dest, format, root, subdir, filtered=filters)
2671
except errors.NoSuchExportFormat, e:
2672
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2675
class cmd_cat(Command):
2676
"""Write the contents of a file as of a given revision to standard output.
2678
If no revision is nominated, the last revision is used.
2680
Note: Take care to redirect standard output when using this command on a
2686
Option('name-from-revision', help='The path name in the old tree.'),
2687
Option('filters', help='Apply content filters to display the '
2688
'convenience form.'),
2691
takes_args = ['filename']
2692
encoding_type = 'exact'
2695
def run(self, filename, revision=None, name_from_revision=False,
2697
if revision is not None and len(revision) != 1:
2698
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2699
" one revision specifier")
2700
tree, branch, relpath = \
2701
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2704
return self._run(tree, branch, relpath, filename, revision,
2705
name_from_revision, filters)
2709
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2712
tree = b.basis_tree()
2713
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2715
old_file_id = rev_tree.path2id(relpath)
2717
if name_from_revision:
2718
# Try in revision if requested
2719
if old_file_id is None:
2720
raise errors.BzrCommandError(
2721
"%r is not present in revision %s" % (
2722
filename, rev_tree.get_revision_id()))
2724
content = rev_tree.get_file_text(old_file_id)
2726
cur_file_id = tree.path2id(relpath)
2728
if cur_file_id is not None:
2729
# Then try with the actual file id
2731
content = rev_tree.get_file_text(cur_file_id)
2733
except errors.NoSuchId:
2734
# The actual file id didn't exist at that time
2736
if not found and old_file_id is not None:
2737
# Finally try with the old file id
2738
content = rev_tree.get_file_text(old_file_id)
2741
# Can't be found anywhere
2742
raise errors.BzrCommandError(
2743
"%r is not present in revision %s" % (
2744
filename, rev_tree.get_revision_id()))
2746
from bzrlib.filters import (
2747
ContentFilterContext,
2748
filtered_output_bytes,
2750
filters = rev_tree._content_filter_stack(relpath)
2751
chunks = content.splitlines(True)
2752
content = filtered_output_bytes(chunks, filters,
2753
ContentFilterContext(relpath, rev_tree))
2754
self.outf.writelines(content)
2756
self.outf.write(content)
2759
class cmd_local_time_offset(Command):
2760
"""Show the offset in seconds from GMT to local time."""
2764
print osutils.local_time_offset()
2768
class cmd_commit(Command):
2769
"""Commit changes into a new revision.
2771
An explanatory message needs to be given for each commit. This is
2772
often done by using the --message option (getting the message from the
2773
command line) or by using the --file option (getting the message from
2774
a file). If neither of these options is given, an editor is opened for
2775
the user to enter the message. To see the changed files in the
2776
boilerplate text loaded into the editor, use the --show-diff option.
2778
By default, the entire tree is committed and the person doing the
2779
commit is assumed to be the author. These defaults can be overridden
2784
If selected files are specified, only changes to those files are
2785
committed. If a directory is specified then the directory and
2786
everything within it is committed.
2788
When excludes are given, they take precedence over selected files.
2789
For example, to commit only changes within foo, but not changes
2792
bzr commit foo -x foo/bar
2794
A selective commit after a merge is not yet supported.
2798
If the author of the change is not the same person as the committer,
2799
you can specify the author's name using the --author option. The
2800
name should be in the same format as a committer-id, e.g.
2801
"John Doe <jdoe@example.com>". If there is more than one author of
2802
the change you can specify the option multiple times, once for each
2807
A common mistake is to forget to add a new file or directory before
2808
running the commit command. The --strict option checks for unknown
2809
files and aborts the commit if any are found. More advanced pre-commit
2810
checks can be implemented by defining hooks. See ``bzr help hooks``
2815
If you accidentially commit the wrong changes or make a spelling
2816
mistake in the commit message say, you can use the uncommit command
2817
to undo it. See ``bzr help uncommit`` for details.
2819
Hooks can also be configured to run after a commit. This allows you
2820
to trigger updates to external systems like bug trackers. The --fixes
2821
option can be used to record the association between a revision and
2822
one or more bugs. See ``bzr help bugs`` for details.
2824
A selective commit may fail in some cases where the committed
2825
tree would be invalid. Consider::
2830
bzr commit foo -m "committing foo"
2831
bzr mv foo/bar foo/baz
2834
bzr commit foo/bar -m "committing bar but not baz"
2836
In the example above, the last commit will fail by design. This gives
2837
the user the opportunity to decide whether they want to commit the
2838
rename at the same time, separately first, or not at all. (As a general
2839
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2841
# TODO: Run hooks on tree to-be-committed, and after commit.
2843
# TODO: Strict commit that fails if there are deleted files.
2844
# (what does "deleted files" mean ??)
2846
# TODO: Give better message for -s, --summary, used by tla people
2848
# XXX: verbose currently does nothing
2850
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2851
takes_args = ['selected*']
2853
ListOption('exclude', type=str, short_name='x',
2854
help="Do not consider changes made to a given path."),
2855
Option('message', type=unicode,
2857
help="Description of the new revision."),
2860
help='Commit even if nothing has changed.'),
2861
Option('file', type=str,
2864
help='Take commit message from this file.'),
2866
help="Refuse to commit if there are unknown "
2867
"files in the working tree."),
2868
ListOption('fixes', type=str,
2869
help="Mark a bug as being fixed by this revision "
2870
"(see \"bzr help bugs\")."),
2871
ListOption('author', type=unicode,
2872
help="Set the author's name, if it's different "
2873
"from the committer."),
2875
help="Perform a local commit in a bound "
2876
"branch. Local commits are not pushed to "
2877
"the master branch until a normal commit "
2881
help='When no message is supplied, show the diff along'
2882
' with the status summary in the message editor.'),
2884
aliases = ['ci', 'checkin']
2886
def _iter_bug_fix_urls(self, fixes, branch):
2887
# Configure the properties for bug fixing attributes.
2888
for fixed_bug in fixes:
2889
tokens = fixed_bug.split(':')
2890
if len(tokens) != 2:
2891
raise errors.BzrCommandError(
2892
"Invalid bug %s. Must be in the form of 'tracker:id'. "
2893
"See \"bzr help bugs\" for more information on this "
2894
"feature.\nCommit refused." % fixed_bug)
2895
tag, bug_id = tokens
2897
yield bugtracker.get_bug_url(tag, branch, bug_id)
2898
except errors.UnknownBugTrackerAbbreviation:
2899
raise errors.BzrCommandError(
2900
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2901
except errors.MalformedBugIdentifier, e:
2902
raise errors.BzrCommandError(
2903
"%s\nCommit refused." % (str(e),))
2905
def run(self, message=None, file=None, verbose=False, selected_list=None,
2906
unchanged=False, strict=False, local=False, fixes=None,
2907
author=None, show_diff=False, exclude=None):
2908
from bzrlib.errors import (
2913
from bzrlib.msgeditor import (
2914
edit_commit_message_encoded,
2915
generate_commit_message_template,
2916
make_commit_message_template_encoded
2919
# TODO: Need a blackbox test for invoking the external editor; may be
2920
# slightly problematic to run this cross-platform.
2922
# TODO: do more checks that the commit will succeed before
2923
# spending the user's valuable time typing a commit message.
2927
tree, selected_list = tree_files(selected_list)
2928
if selected_list == ['']:
2929
# workaround - commit of root of tree should be exactly the same
2930
# as just default commit in that tree, and succeed even though
2931
# selected-file merge commit is not done yet
2936
bug_property = bugtracker.encode_fixes_bug_urls(
2937
self._iter_bug_fix_urls(fixes, tree.branch))
2939
properties['bugs'] = bug_property
2941
if local and not tree.branch.get_bound_location():
2942
raise errors.LocalRequiresBoundBranch()
2944
def get_message(commit_obj):
2945
"""Callback to get commit message"""
2946
my_message = message
2947
if my_message is None and not file:
2948
t = make_commit_message_template_encoded(tree,
2949
selected_list, diff=show_diff,
2950
output_encoding=osutils.get_user_encoding())
2951
start_message = generate_commit_message_template(commit_obj)
2952
my_message = edit_commit_message_encoded(t,
2953
start_message=start_message)
2954
if my_message is None:
2955
raise errors.BzrCommandError("please specify a commit"
2956
" message with either --message or --file")
2957
elif my_message and file:
2958
raise errors.BzrCommandError(
2959
"please specify either --message or --file")
2961
my_message = codecs.open(file, 'rt',
2962
osutils.get_user_encoding()).read()
2963
if my_message == "":
2964
raise errors.BzrCommandError("empty commit message specified")
2968
tree.commit(message_callback=get_message,
2969
specific_files=selected_list,
2970
allow_pointless=unchanged, strict=strict, local=local,
2971
reporter=None, verbose=verbose, revprops=properties,
2973
exclude=safe_relpath_files(tree, exclude))
2974
except PointlessCommit:
2975
# FIXME: This should really happen before the file is read in;
2976
# perhaps prepare the commit; get the message; then actually commit
2977
raise errors.BzrCommandError("No changes to commit."
2978
" Use --unchanged to commit anyhow.")
2979
except ConflictsInTree:
2980
raise errors.BzrCommandError('Conflicts detected in working '
2981
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2983
except StrictCommitFailed:
2984
raise errors.BzrCommandError("Commit refused because there are"
2985
" unknown files in the working tree.")
2986
except errors.BoundBranchOutOfDate, e:
2987
raise errors.BzrCommandError(str(e) + "\n"
2988
'To commit to master branch, run update and then commit.\n'
2989
'You can also pass --local to commit to continue working '
2993
class cmd_check(Command):
2994
"""Validate working tree structure, branch consistency and repository history.
2996
This command checks various invariants about branch and repository storage
2997
to detect data corruption or bzr bugs.
2999
The working tree and branch checks will only give output if a problem is
3000
detected. The output fields of the repository check are:
3003
This is just the number of revisions checked. It doesn't
3007
This is just the number of versionedfiles checked. It
3008
doesn't indicate a problem.
3010
unreferenced ancestors
3011
Texts that are ancestors of other texts, but
3012
are not properly referenced by the revision ancestry. This is a
3013
subtle problem that Bazaar can work around.
3016
This is the total number of unique file contents
3017
seen in the checked revisions. It does not indicate a problem.
3020
This is the total number of repeated texts seen
3021
in the checked revisions. Texts can be repeated when their file
3022
entries are modified, but the file contents are not. It does not
3025
If no restrictions are specified, all Bazaar data that is found at the given
3026
location will be checked.
3030
Check the tree and branch at 'foo'::
3032
bzr check --tree --branch foo
3034
Check only the repository at 'bar'::
3036
bzr check --repo bar
3038
Check everything at 'baz'::
3043
_see_also = ['reconcile']
3044
takes_args = ['path?']
3045
takes_options = ['verbose',
3046
Option('branch', help="Check the branch related to the"
3047
" current directory."),
3048
Option('repo', help="Check the repository related to the"
3049
" current directory."),
3050
Option('tree', help="Check the working tree related to"
3051
" the current directory.")]
3053
def run(self, path=None, verbose=False, branch=False, repo=False,
3055
from bzrlib.check import check_dwim
3058
if not branch and not repo and not tree:
3059
branch = repo = tree = True
3060
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3063
class cmd_upgrade(Command):
3064
"""Upgrade branch storage to current format.
3066
The check command or bzr developers may sometimes advise you to run
3067
this command. When the default format has changed you may also be warned
3068
during other operations to upgrade.
3071
_see_also = ['check']
3072
takes_args = ['url?']
3074
RegistryOption('format',
3075
help='Upgrade to a specific format. See "bzr help'
3076
' formats" for details.',
3077
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3078
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3079
value_switches=True, title='Branch format'),
3082
def run(self, url='.', format=None):
3083
from bzrlib.upgrade import upgrade
3084
upgrade(url, format)
3087
class cmd_whoami(Command):
3088
"""Show or set bzr user id.
3091
Show the email of the current user::
3095
Set the current user::
3097
bzr whoami "Frank Chu <fchu@example.com>"
3099
takes_options = [ Option('email',
3100
help='Display email address only.'),
3102
help='Set identity for the current branch instead of '
3105
takes_args = ['name?']
3106
encoding_type = 'replace'
3109
def run(self, email=False, branch=False, name=None):
3111
# use branch if we're inside one; otherwise global config
3113
c = Branch.open_containing('.')[0].get_config()
3114
except errors.NotBranchError:
3115
c = config.GlobalConfig()
3117
self.outf.write(c.user_email() + '\n')
3119
self.outf.write(c.username() + '\n')
3122
# display a warning if an email address isn't included in the given name.
3124
config.extract_email_address(name)
3125
except errors.NoEmailInUsername, e:
3126
warning('"%s" does not seem to contain an email address. '
3127
'This is allowed, but not recommended.', name)
3129
# use global config unless --branch given
3131
c = Branch.open_containing('.')[0].get_config()
3133
c = config.GlobalConfig()
3134
c.set_user_option('email', name)
3137
class cmd_nick(Command):
3138
"""Print or set the branch nickname.
3140
If unset, the tree root directory name is used as the nickname.
3141
To print the current nickname, execute with no argument.
3143
Bound branches use the nickname of its master branch unless it is set
3147
_see_also = ['info']
3148
takes_args = ['nickname?']
3149
def run(self, nickname=None):
3150
branch = Branch.open_containing(u'.')[0]
3151
if nickname is None:
3152
self.printme(branch)
3154
branch.nick = nickname
3157
def printme(self, branch):
3161
class cmd_alias(Command):
3162
"""Set/unset and display aliases.
3165
Show the current aliases::
3169
Show the alias specified for 'll'::
3173
Set an alias for 'll'::
3175
bzr alias ll="log --line -r-10..-1"
3177
To remove an alias for 'll'::
3179
bzr alias --remove ll
3182
takes_args = ['name?']
3184
Option('remove', help='Remove the alias.'),
3187
def run(self, name=None, remove=False):
3189
self.remove_alias(name)
3191
self.print_aliases()
3193
equal_pos = name.find('=')
3195
self.print_alias(name)
3197
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3199
def remove_alias(self, alias_name):
3200
if alias_name is None:
3201
raise errors.BzrCommandError(
3202
'bzr alias --remove expects an alias to remove.')
3203
# If alias is not found, print something like:
3204
# unalias: foo: not found
3205
c = config.GlobalConfig()
3206
c.unset_alias(alias_name)
3209
def print_aliases(self):
3210
"""Print out the defined aliases in a similar format to bash."""
3211
aliases = config.GlobalConfig().get_aliases()
3212
for key, value in sorted(aliases.iteritems()):
3213
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3216
def print_alias(self, alias_name):
3217
from bzrlib.commands import get_alias
3218
alias = get_alias(alias_name)
3220
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3223
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3225
def set_alias(self, alias_name, alias_command):
3226
"""Save the alias in the global config."""
3227
c = config.GlobalConfig()
3228
c.set_alias(alias_name, alias_command)
3231
class cmd_selftest(Command):
3232
"""Run internal test suite.
3234
If arguments are given, they are regular expressions that say which tests
3235
should run. Tests matching any expression are run, and other tests are
3238
Alternatively if --first is given, matching tests are run first and then
3239
all other tests are run. This is useful if you have been working in a
3240
particular area, but want to make sure nothing else was broken.
3242
If --exclude is given, tests that match that regular expression are
3243
excluded, regardless of whether they match --first or not.
3245
To help catch accidential dependencies between tests, the --randomize
3246
option is useful. In most cases, the argument used is the word 'now'.
3247
Note that the seed used for the random number generator is displayed
3248
when this option is used. The seed can be explicitly passed as the
3249
argument to this option if required. This enables reproduction of the
3250
actual ordering used if and when an order sensitive problem is encountered.
3252
If --list-only is given, the tests that would be run are listed. This is
3253
useful when combined with --first, --exclude and/or --randomize to
3254
understand their impact. The test harness reports "Listed nn tests in ..."
3255
instead of "Ran nn tests in ..." when list mode is enabled.
3257
If the global option '--no-plugins' is given, plugins are not loaded
3258
before running the selftests. This has two effects: features provided or
3259
modified by plugins will not be tested, and tests provided by plugins will
3262
Tests that need working space on disk use a common temporary directory,
3263
typically inside $TMPDIR or /tmp.
3266
Run only tests relating to 'ignore'::
3270
Disable plugins and list tests as they're run::
3272
bzr --no-plugins selftest -v
3274
# NB: this is used from the class without creating an instance, which is
3275
# why it does not have a self parameter.
3276
def get_transport_type(typestring):
3277
"""Parse and return a transport specifier."""
3278
if typestring == "sftp":
3279
from bzrlib.transport.sftp import SFTPAbsoluteServer
3280
return SFTPAbsoluteServer
3281
if typestring == "memory":
3282
from bzrlib.transport.memory import MemoryServer
3284
if typestring == "fakenfs":
3285
from bzrlib.transport.fakenfs import FakeNFSServer
3286
return FakeNFSServer
3287
msg = "No known transport type %s. Supported types are: sftp\n" %\
3289
raise errors.BzrCommandError(msg)
3292
takes_args = ['testspecs*']
3293
takes_options = ['verbose',
3295
help='Stop when one test fails.',
3299
help='Use a different transport by default '
3300
'throughout the test suite.',
3301
type=get_transport_type),
3303
help='Run the benchmarks rather than selftests.'),
3304
Option('lsprof-timed',
3305
help='Generate lsprof output for benchmarked'
3306
' sections of code.'),
3307
Option('cache-dir', type=str,
3308
help='Cache intermediate benchmark output in this '
3311
help='Run all tests, but run specified tests first.',
3315
help='List the tests instead of running them.'),
3316
RegistryOption('parallel',
3317
help="Run the test suite in parallel.",
3318
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3319
value_switches=False,
3321
Option('randomize', type=str, argname="SEED",
3322
help='Randomize the order of tests using the given'
3323
' seed or "now" for the current time.'),
3324
Option('exclude', type=str, argname="PATTERN",
3326
help='Exclude tests that match this regular'
3329
help='Output test progress via subunit.'),
3330
Option('strict', help='Fail on missing dependencies or '
3332
Option('load-list', type=str, argname='TESTLISTFILE',
3333
help='Load a test id list from a text file.'),
3334
ListOption('debugflag', type=str, short_name='E',
3335
help='Turn on a selftest debug flag.'),
3336
ListOption('starting-with', type=str, argname='TESTID',
3337
param_name='starting_with', short_name='s',
3339
'Load only the tests starting with TESTID.'),
3341
encoding_type = 'replace'
3344
Command.__init__(self)
3345
self.additional_selftest_args = {}
3347
def run(self, testspecs_list=None, verbose=False, one=False,
3348
transport=None, benchmark=None,
3349
lsprof_timed=None, cache_dir=None,
3350
first=False, list_only=False,
3351
randomize=None, exclude=None, strict=False,
3352
load_list=None, debugflag=None, starting_with=None, subunit=False,
3354
from bzrlib.tests import selftest
3355
import bzrlib.benchmarks as benchmarks
3356
from bzrlib.benchmarks import tree_creator
3358
# Make deprecation warnings visible, unless -Werror is set
3359
symbol_versioning.activate_deprecation_warnings(override=False)
3361
if cache_dir is not None:
3362
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3363
if testspecs_list is not None:
3364
pattern = '|'.join(testspecs_list)
3369
from bzrlib.tests import SubUnitBzrRunner
3371
raise errors.BzrCommandError("subunit not available. subunit "
3372
"needs to be installed to use --subunit.")
3373
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3375
self.additional_selftest_args.setdefault(
3376
'suite_decorators', []).append(parallel)
3378
test_suite_factory = benchmarks.test_suite
3379
# Unless user explicitly asks for quiet, be verbose in benchmarks
3380
verbose = not is_quiet()
3381
# TODO: should possibly lock the history file...
3382
benchfile = open(".perf_history", "at", buffering=1)
3384
test_suite_factory = None
3387
selftest_kwargs = {"verbose": verbose,
3389
"stop_on_failure": one,
3390
"transport": transport,
3391
"test_suite_factory": test_suite_factory,
3392
"lsprof_timed": lsprof_timed,
3393
"bench_history": benchfile,
3394
"matching_tests_first": first,
3395
"list_only": list_only,
3396
"random_seed": randomize,
3397
"exclude_pattern": exclude,
3399
"load_list": load_list,
3400
"debug_flags": debugflag,
3401
"starting_with": starting_with
3403
selftest_kwargs.update(self.additional_selftest_args)
3404
result = selftest(**selftest_kwargs)
3406
if benchfile is not None:
3408
return int(not result)
3411
class cmd_version(Command):
3412
"""Show version of bzr."""
3414
encoding_type = 'replace'
3416
Option("short", help="Print just the version number."),
3420
def run(self, short=False):
3421
from bzrlib.version import show_version
3423
self.outf.write(bzrlib.version_string + '\n')
3425
show_version(to_file=self.outf)
3428
class cmd_rocks(Command):
3429
"""Statement of optimism."""
3435
print "It sure does!"
3438
class cmd_find_merge_base(Command):
3439
"""Find and print a base revision for merging two branches."""
3440
# TODO: Options to specify revisions on either side, as if
3441
# merging only part of the history.
3442
takes_args = ['branch', 'other']
3446
def run(self, branch, other):
3447
from bzrlib.revision import ensure_null
3449
branch1 = Branch.open_containing(branch)[0]
3450
branch2 = Branch.open_containing(other)[0]
3455
last1 = ensure_null(branch1.last_revision())
3456
last2 = ensure_null(branch2.last_revision())
3458
graph = branch1.repository.get_graph(branch2.repository)
3459
base_rev_id = graph.find_unique_lca(last1, last2)
3461
print 'merge base is revision %s' % base_rev_id
3468
class cmd_merge(Command):
3469
"""Perform a three-way merge.
3471
The source of the merge can be specified either in the form of a branch,
3472
or in the form of a path to a file containing a merge directive generated
3473
with bzr send. If neither is specified, the default is the upstream branch
3474
or the branch most recently merged using --remember.
3476
When merging a branch, by default the tip will be merged. To pick a different
3477
revision, pass --revision. If you specify two values, the first will be used as
3478
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3479
available revisions, like this is commonly referred to as "cherrypicking".
3481
Revision numbers are always relative to the branch being merged.
3483
By default, bzr will try to merge in all new work from the other
3484
branch, automatically determining an appropriate base. If this
3485
fails, you may need to give an explicit base.
3487
Merge will do its best to combine the changes in two branches, but there
3488
are some kinds of problems only a human can fix. When it encounters those,
3489
it will mark a conflict. A conflict means that you need to fix something,
3490
before you should commit.
3492
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3494
If there is no default branch set, the first merge will set it. After
3495
that, you can omit the branch to use the default. To change the
3496
default, use --remember. The value will only be saved if the remote
3497
location can be accessed.
3499
The results of the merge are placed into the destination working
3500
directory, where they can be reviewed (with bzr diff), tested, and then
3501
committed to record the result of the merge.
3503
merge refuses to run if there are any uncommitted changes, unless
3507
To merge the latest revision from bzr.dev::
3509
bzr merge ../bzr.dev
3511
To merge changes up to and including revision 82 from bzr.dev::
3513
bzr merge -r 82 ../bzr.dev
3515
To merge the changes introduced by 82, without previous changes::
3517
bzr merge -r 81..82 ../bzr.dev
3519
To apply a merge directive contained in /tmp/merge:
3521
bzr merge /tmp/merge
3524
encoding_type = 'exact'
3525
_see_also = ['update', 'remerge', 'status-flags', 'send']
3526
takes_args = ['location?']
3531
help='Merge even if the destination tree has uncommitted changes.'),
3535
Option('show-base', help="Show base revision text in "
3537
Option('uncommitted', help='Apply uncommitted changes'
3538
' from a working copy, instead of branch changes.'),
3539
Option('pull', help='If the destination is already'
3540
' completely merged into the source, pull from the'
3541
' source rather than merging. When this happens,'
3542
' you do not need to commit the result.'),
3544
help='Branch to merge into, '
3545
'rather than the one containing the working directory.',
3549
Option('preview', help='Instead of merging, show a diff of the merge.')
3552
def run(self, location=None, revision=None, force=False,
3553
merge_type=None, show_base=False, reprocess=None, remember=False,
3554
uncommitted=False, pull=False,
3558
if merge_type is None:
3559
merge_type = _mod_merge.Merge3Merger
3561
if directory is None: directory = u'.'
3562
possible_transports = []
3564
allow_pending = True
3565
verified = 'inapplicable'
3566
tree = WorkingTree.open_containing(directory)[0]
3568
# die as quickly as possible if there are uncommitted changes
3570
basis_tree = tree.revision_tree(tree.last_revision())
3571
except errors.NoSuchRevision:
3572
basis_tree = tree.basis_tree()
3574
changes = tree.changes_from(basis_tree)
3575
if changes.has_changed():
3576
raise errors.UncommittedChanges(tree)
3578
view_info = _get_view_info_for_change_reporter(tree)
3579
change_reporter = delta._ChangeReporter(
3580
unversioned_filter=tree.is_ignored, view_info=view_info)
3583
pb = ui.ui_factory.nested_progress_bar()
3584
cleanups.append(pb.finished)
3586
cleanups.append(tree.unlock)
3587
if location is not None:
3589
mergeable = bundle.read_mergeable_from_url(location,
3590
possible_transports=possible_transports)
3591
except errors.NotABundle:
3595
raise errors.BzrCommandError('Cannot use --uncommitted'
3596
' with bundles or merge directives.')
3598
if revision is not None:
3599
raise errors.BzrCommandError(
3600
'Cannot use -r with merge directives or bundles')
3601
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3604
if merger is None and uncommitted:
3605
if revision is not None and len(revision) > 0:
3606
raise errors.BzrCommandError('Cannot use --uncommitted and'
3607
' --revision at the same time.')
3608
merger = self.get_merger_from_uncommitted(tree, location, pb,
3610
allow_pending = False
3613
merger, allow_pending = self._get_merger_from_branch(tree,
3614
location, revision, remember, possible_transports, pb)
3616
merger.merge_type = merge_type
3617
merger.reprocess = reprocess
3618
merger.show_base = show_base
3619
self.sanity_check_merger(merger)
3620
if (merger.base_rev_id == merger.other_rev_id and
3621
merger.other_rev_id is not None):
3622
note('Nothing to do.')
3625
if merger.interesting_files is not None:
3626
raise errors.BzrCommandError('Cannot pull individual files')
3627
if (merger.base_rev_id == tree.last_revision()):
3628
result = tree.pull(merger.other_branch, False,
3629
merger.other_rev_id)
3630
result.report(self.outf)
3632
merger.check_basis(False)
3634
return self._do_preview(merger)
3636
return self._do_merge(merger, change_reporter, allow_pending,
3639
for cleanup in reversed(cleanups):
3642
def _do_preview(self, merger):
3643
from bzrlib.diff import show_diff_trees
3644
tree_merger = merger.make_merger()
3645
tt = tree_merger.make_preview_transform()
3647
result_tree = tt.get_preview_tree()
3648
show_diff_trees(merger.this_tree, result_tree, self.outf,
3649
old_label='', new_label='')
3653
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3654
merger.change_reporter = change_reporter
3655
conflict_count = merger.do_merge()
3657
merger.set_pending()
3658
if verified == 'failed':
3659
warning('Preview patch does not match changes')
3660
if conflict_count != 0:
3665
def sanity_check_merger(self, merger):
3666
if (merger.show_base and
3667
not merger.merge_type is _mod_merge.Merge3Merger):
3668
raise errors.BzrCommandError("Show-base is not supported for this"
3669
" merge type. %s" % merger.merge_type)
3670
if merger.reprocess is None:
3671
if merger.show_base:
3672
merger.reprocess = False
3674
# Use reprocess if the merger supports it
3675
merger.reprocess = merger.merge_type.supports_reprocess
3676
if merger.reprocess and not merger.merge_type.supports_reprocess:
3677
raise errors.BzrCommandError("Conflict reduction is not supported"
3678
" for merge type %s." %
3680
if merger.reprocess and merger.show_base:
3681
raise errors.BzrCommandError("Cannot do conflict reduction and"
3684
def _get_merger_from_branch(self, tree, location, revision, remember,
3685
possible_transports, pb):
3686
"""Produce a merger from a location, assuming it refers to a branch."""
3687
from bzrlib.tag import _merge_tags_if_possible
3688
# find the branch locations
3689
other_loc, user_location = self._select_branch_location(tree, location,
3691
if revision is not None and len(revision) == 2:
3692
base_loc, _unused = self._select_branch_location(tree,
3693
location, revision, 0)
3695
base_loc = other_loc
3697
other_branch, other_path = Branch.open_containing(other_loc,
3698
possible_transports)
3699
if base_loc == other_loc:
3700
base_branch = other_branch
3702
base_branch, base_path = Branch.open_containing(base_loc,
3703
possible_transports)
3704
# Find the revision ids
3705
if revision is None or len(revision) < 1 or revision[-1] is None:
3706
other_revision_id = _mod_revision.ensure_null(
3707
other_branch.last_revision())
3709
other_revision_id = revision[-1].as_revision_id(other_branch)
3710
if (revision is not None and len(revision) == 2
3711
and revision[0] is not None):
3712
base_revision_id = revision[0].as_revision_id(base_branch)
3714
base_revision_id = None
3715
# Remember where we merge from
3716
if ((remember or tree.branch.get_submit_branch() is None) and
3717
user_location is not None):
3718
tree.branch.set_submit_branch(other_branch.base)
3719
_merge_tags_if_possible(other_branch, tree.branch)
3720
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3721
other_revision_id, base_revision_id, other_branch, base_branch)
3722
if other_path != '':
3723
allow_pending = False
3724
merger.interesting_files = [other_path]
3726
allow_pending = True
3727
return merger, allow_pending
3729
def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3730
"""Get a merger for uncommitted changes.
3732
:param tree: The tree the merger should apply to.
3733
:param location: The location containing uncommitted changes.
3734
:param pb: The progress bar to use for showing progress.
3735
:param cleanups: A list of operations to perform to clean up the
3736
temporary directories, unfinalized objects, etc.
3738
location = self._select_branch_location(tree, location)[0]
3739
other_tree, other_path = WorkingTree.open_containing(location)
3740
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3741
if other_path != '':
3742
merger.interesting_files = [other_path]
3745
def _select_branch_location(self, tree, user_location, revision=None,
3747
"""Select a branch location, according to possible inputs.
3749
If provided, branches from ``revision`` are preferred. (Both
3750
``revision`` and ``index`` must be supplied.)
3752
Otherwise, the ``location`` parameter is used. If it is None, then the
3753
``submit`` or ``parent`` location is used, and a note is printed.
3755
:param tree: The working tree to select a branch for merging into
3756
:param location: The location entered by the user
3757
:param revision: The revision parameter to the command
3758
:param index: The index to use for the revision parameter. Negative
3759
indices are permitted.
3760
:return: (selected_location, user_location). The default location
3761
will be the user-entered location.
3763
if (revision is not None and index is not None
3764
and revision[index] is not None):
3765
branch = revision[index].get_branch()
3766
if branch is not None:
3767
return branch, branch
3768
if user_location is None:
3769
location = self._get_remembered(tree, 'Merging from')
3771
location = user_location
3772
return location, user_location
3774
def _get_remembered(self, tree, verb_string):
3775
"""Use tree.branch's parent if none was supplied.
3777
Report if the remembered location was used.
3779
stored_location = tree.branch.get_submit_branch()
3780
stored_location_type = "submit"
3781
if stored_location is None:
3782
stored_location = tree.branch.get_parent()
3783
stored_location_type = "parent"
3784
mutter("%s", stored_location)
3785
if stored_location is None:
3786
raise errors.BzrCommandError("No location specified or remembered")
3787
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3788
note(u"%s remembered %s location %s", verb_string,
3789
stored_location_type, display_url)
3790
return stored_location
3793
class cmd_remerge(Command):
3796
Use this if you want to try a different merge technique while resolving
3797
conflicts. Some merge techniques are better than others, and remerge
3798
lets you try different ones on different files.
3800
The options for remerge have the same meaning and defaults as the ones for
3801
merge. The difference is that remerge can (only) be run when there is a
3802
pending merge, and it lets you specify particular files.
3805
Re-do the merge of all conflicted files, and show the base text in
3806
conflict regions, in addition to the usual THIS and OTHER texts::
3808
bzr remerge --show-base
3810
Re-do the merge of "foobar", using the weave merge algorithm, with
3811
additional processing to reduce the size of conflict regions::
3813
bzr remerge --merge-type weave --reprocess foobar
3815
takes_args = ['file*']
3820
help="Show base revision text in conflicts."),
3823
def run(self, file_list=None, merge_type=None, show_base=False,
3825
if merge_type is None:
3826
merge_type = _mod_merge.Merge3Merger
3827
tree, file_list = tree_files(file_list)
3830
parents = tree.get_parent_ids()
3831
if len(parents) != 2:
3832
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3833
" merges. Not cherrypicking or"
3835
repository = tree.branch.repository
3836
interesting_ids = None
3838
conflicts = tree.conflicts()
3839
if file_list is not None:
3840
interesting_ids = set()
3841
for filename in file_list:
3842
file_id = tree.path2id(filename)
3844
raise errors.NotVersionedError(filename)
3845
interesting_ids.add(file_id)
3846
if tree.kind(file_id) != "directory":
3849
for name, ie in tree.inventory.iter_entries(file_id):
3850
interesting_ids.add(ie.file_id)
3851
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3853
# Remerge only supports resolving contents conflicts
3854
allowed_conflicts = ('text conflict', 'contents conflict')
3855
restore_files = [c.path for c in conflicts
3856
if c.typestring in allowed_conflicts]
3857
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3858
tree.set_conflicts(ConflictList(new_conflicts))
3859
if file_list is not None:
3860
restore_files = file_list
3861
for filename in restore_files:
3863
restore(tree.abspath(filename))
3864
except errors.NotConflicted:
3866
# Disable pending merges, because the file texts we are remerging
3867
# have not had those merges performed. If we use the wrong parents
3868
# list, we imply that the working tree text has seen and rejected
3869
# all the changes from the other tree, when in fact those changes
3870
# have not yet been seen.
3871
pb = ui.ui_factory.nested_progress_bar()
3872
tree.set_parent_ids(parents[:1])
3874
merger = _mod_merge.Merger.from_revision_ids(pb,
3876
merger.interesting_ids = interesting_ids
3877
merger.merge_type = merge_type
3878
merger.show_base = show_base
3879
merger.reprocess = reprocess
3880
conflicts = merger.do_merge()
3882
tree.set_parent_ids(parents)
3892
class cmd_revert(Command):
3893
"""Revert files to a previous revision.
3895
Giving a list of files will revert only those files. Otherwise, all files
3896
will be reverted. If the revision is not specified with '--revision', the
3897
last committed revision is used.
3899
To remove only some changes, without reverting to a prior version, use
3900
merge instead. For example, "merge . --revision -2..-3" will remove the
3901
changes introduced by -2, without affecting the changes introduced by -1.
3902
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3904
By default, any files that have been manually changed will be backed up
3905
first. (Files changed only by merge are not backed up.) Backup files have
3906
'.~#~' appended to their name, where # is a number.
3908
When you provide files, you can use their current pathname or the pathname
3909
from the target revision. So you can use revert to "undelete" a file by
3910
name. If you name a directory, all the contents of that directory will be
3913
Any files that have been newly added since that revision will be deleted,
3914
with a backup kept if appropriate. Directories containing unknown files
3915
will not be deleted.
3917
The working tree contains a list of pending merged revisions, which will
3918
be included as parents in the next commit. Normally, revert clears that
3919
list as well as reverting the files. If any files are specified, revert
3920
leaves the pending merge list alone and reverts only the files. Use "bzr
3921
revert ." in the tree root to revert all files but keep the merge record,
3922
and "bzr revert --forget-merges" to clear the pending merge list without
3923
reverting any files.
3926
_see_also = ['cat', 'export']
3929
Option('no-backup', "Do not save backups of reverted files."),
3930
Option('forget-merges',
3931
'Remove pending merge marker, without changing any files.'),
3933
takes_args = ['file*']
3935
def run(self, revision=None, no_backup=False, file_list=None,
3936
forget_merges=None):
3937
tree, file_list = tree_files(file_list)
3941
tree.set_parent_ids(tree.get_parent_ids()[:1])
3943
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3948
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3949
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3950
pb = ui.ui_factory.nested_progress_bar()
3952
tree.revert(file_list, rev_tree, not no_backup, pb,
3953
report_changes=True)
3958
class cmd_assert_fail(Command):
3959
"""Test reporting of assertion failures"""
3960
# intended just for use in testing
3965
raise AssertionError("always fails")
3968
class cmd_help(Command):
3969
"""Show help on a command or other topic.
3972
_see_also = ['topics']
3974
Option('long', 'Show help on all commands.'),
3976
takes_args = ['topic?']
3977
aliases = ['?', '--help', '-?', '-h']
3980
def run(self, topic=None, long=False):
3982
if topic is None and long:
3984
bzrlib.help.help(topic)
3987
class cmd_shell_complete(Command):
3988
"""Show appropriate completions for context.
3990
For a list of all available commands, say 'bzr shell-complete'.
3992
takes_args = ['context?']
3997
def run(self, context=None):
3998
import shellcomplete
3999
shellcomplete.shellcomplete(context)
4002
class cmd_missing(Command):
4003
"""Show unmerged/unpulled revisions between two branches.
4005
OTHER_BRANCH may be local or remote.
4007
To filter on a range of revisions, you can use the command -r begin..end
4008
-r revision requests a specific revision, -r ..end or -r begin.. are
4013
Determine the missing revisions between this and the branch at the
4014
remembered pull location::
4018
Determine the missing revisions between this and another branch::
4020
bzr missing http://server/branch
4022
Determine the missing revisions up to a specific revision on the other
4025
bzr missing -r ..-10
4027
Determine the missing revisions up to a specific revision on this
4030
bzr missing --my-revision ..-10
4033
_see_also = ['merge', 'pull']
4034
takes_args = ['other_branch?']
4036
Option('reverse', 'Reverse the order of revisions.'),
4038
'Display changes in the local branch only.'),
4039
Option('this' , 'Same as --mine-only.'),
4040
Option('theirs-only',
4041
'Display changes in the remote branch only.'),
4042
Option('other', 'Same as --theirs-only.'),
4046
custom_help('revision',
4047
help='Filter on other branch revisions (inclusive). '
4048
'See "help revisionspec" for details.'),
4049
Option('my-revision',
4050
type=_parse_revision_str,
4051
help='Filter on local branch revisions (inclusive). '
4052
'See "help revisionspec" for details.'),
4053
Option('include-merges',
4054
'Show all revisions in addition to the mainline ones.'),
4056
encoding_type = 'replace'
4059
def run(self, other_branch=None, reverse=False, mine_only=False,
4061
log_format=None, long=False, short=False, line=False,
4062
show_ids=False, verbose=False, this=False, other=False,
4063
include_merges=False, revision=None, my_revision=None):
4064
from bzrlib.missing import find_unmerged, iter_log_revisions
4073
# TODO: We should probably check that we don't have mine-only and
4074
# theirs-only set, but it gets complicated because we also have
4075
# this and other which could be used.
4082
local_branch = Branch.open_containing(u".")[0]
4083
parent = local_branch.get_parent()
4084
if other_branch is None:
4085
other_branch = parent
4086
if other_branch is None:
4087
raise errors.BzrCommandError("No peer location known"
4089
display_url = urlutils.unescape_for_display(parent,
4091
message("Using saved parent location: "
4092
+ display_url + "\n")
4094
remote_branch = Branch.open(other_branch)
4095
if remote_branch.base == local_branch.base:
4096
remote_branch = local_branch
4098
local_revid_range = _revision_range_to_revid_range(
4099
_get_revision_range(my_revision, local_branch,
4102
remote_revid_range = _revision_range_to_revid_range(
4103
_get_revision_range(revision,
4104
remote_branch, self.name()))
4106
local_branch.lock_read()
4108
remote_branch.lock_read()
4110
local_extra, remote_extra = find_unmerged(
4111
local_branch, remote_branch, restrict,
4112
backward=not reverse,
4113
include_merges=include_merges,
4114
local_revid_range=local_revid_range,
4115
remote_revid_range=remote_revid_range)
4117
if log_format is None:
4118
registry = log.log_formatter_registry
4119
log_format = registry.get_default(local_branch)
4120
lf = log_format(to_file=self.outf,
4122
show_timezone='original')
4125
if local_extra and not theirs_only:
4126
message("You have %d extra revision(s):\n" %
4128
for revision in iter_log_revisions(local_extra,
4129
local_branch.repository,
4131
lf.log_revision(revision)
4132
printed_local = True
4135
printed_local = False
4137
if remote_extra and not mine_only:
4138
if printed_local is True:
4140
message("You are missing %d revision(s):\n" %
4142
for revision in iter_log_revisions(remote_extra,
4143
remote_branch.repository,
4145
lf.log_revision(revision)
4148
if mine_only and not local_extra:
4149
# We checked local, and found nothing extra
4150
message('This branch is up to date.\n')
4151
elif theirs_only and not remote_extra:
4152
# We checked remote, and found nothing extra
4153
message('Other branch is up to date.\n')
4154
elif not (mine_only or theirs_only or local_extra or
4156
# We checked both branches, and neither one had extra
4158
message("Branches are up to date.\n")
4160
remote_branch.unlock()
4162
local_branch.unlock()
4163
if not status_code and parent is None and other_branch is not None:
4164
local_branch.lock_write()
4166
# handle race conditions - a parent might be set while we run.
4167
if local_branch.get_parent() is None:
4168
local_branch.set_parent(remote_branch.base)
4170
local_branch.unlock()
4174
class cmd_pack(Command):
4175
"""Compress the data within a repository."""
4177
_see_also = ['repositories']
4178
takes_args = ['branch_or_repo?']
4180
def run(self, branch_or_repo='.'):
4181
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4183
branch = dir.open_branch()
4184
repository = branch.repository
4185
except errors.NotBranchError:
4186
repository = dir.open_repository()
4190
class cmd_plugins(Command):
4191
"""List the installed plugins.
4193
This command displays the list of installed plugins including
4194
version of plugin and a short description of each.
4196
--verbose shows the path where each plugin is located.
4198
A plugin is an external component for Bazaar that extends the
4199
revision control system, by adding or replacing code in Bazaar.
4200
Plugins can do a variety of things, including overriding commands,
4201
adding new commands, providing additional network transports and
4202
customizing log output.
4204
See the Bazaar web site, http://bazaar-vcs.org, for further
4205
information on plugins including where to find them and how to
4206
install them. Instructions are also provided there on how to
4207
write new plugins using the Python programming language.
4209
takes_options = ['verbose']
4212
def run(self, verbose=False):
4213
import bzrlib.plugin
4214
from inspect import getdoc
4216
for name, plugin in bzrlib.plugin.plugins().items():
4217
version = plugin.__version__
4218
if version == 'unknown':
4220
name_ver = '%s %s' % (name, version)
4221
d = getdoc(plugin.module)
4223
doc = d.split('\n')[0]
4225
doc = '(no description)'
4226
result.append((name_ver, doc, plugin.path()))
4227
for name_ver, doc, path in sorted(result):
4235
class cmd_testament(Command):
4236
"""Show testament (signing-form) of a revision."""
4239
Option('long', help='Produce long-format testament.'),
4241
help='Produce a strict-format testament.')]
4242
takes_args = ['branch?']
4244
def run(self, branch=u'.', revision=None, long=False, strict=False):
4245
from bzrlib.testament import Testament, StrictTestament
4247
testament_class = StrictTestament
4249
testament_class = Testament
4251
b = Branch.open_containing(branch)[0]
4253
b = Branch.open(branch)
4256
if revision is None:
4257
rev_id = b.last_revision()
4259
rev_id = revision[0].as_revision_id(b)
4260
t = testament_class.from_revision(b.repository, rev_id)
4262
sys.stdout.writelines(t.as_text_lines())
4264
sys.stdout.write(t.as_short_text())
4269
class cmd_annotate(Command):
4270
"""Show the origin of each line in a file.
4272
This prints out the given file with an annotation on the left side
4273
indicating which revision, author and date introduced the change.
4275
If the origin is the same for a run of consecutive lines, it is
4276
shown only at the top, unless the --all option is given.
4278
# TODO: annotate directories; showing when each file was last changed
4279
# TODO: if the working copy is modified, show annotations on that
4280
# with new uncommitted lines marked
4281
aliases = ['ann', 'blame', 'praise']
4282
takes_args = ['filename']
4283
takes_options = [Option('all', help='Show annotations on all lines.'),
4284
Option('long', help='Show commit date in annotations.'),
4288
encoding_type = 'exact'
4291
def run(self, filename, all=False, long=False, revision=None,
4293
from bzrlib.annotate import annotate_file, annotate_file_tree
4294
wt, branch, relpath = \
4295
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4301
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4303
file_id = wt.path2id(relpath)
4305
file_id = tree.path2id(relpath)
4307
raise errors.NotVersionedError(filename)
4308
file_version = tree.inventory[file_id].revision
4309
if wt is not None and revision is None:
4310
# If there is a tree and we're not annotating historical
4311
# versions, annotate the working tree's content.
4312
annotate_file_tree(wt, file_id, self.outf, long, all,
4315
annotate_file(branch, file_version, file_id, long, all, self.outf,
4324
class cmd_re_sign(Command):
4325
"""Create a digital signature for an existing revision."""
4326
# TODO be able to replace existing ones.
4328
hidden = True # is this right ?
4329
takes_args = ['revision_id*']
4330
takes_options = ['revision']
4332
def run(self, revision_id_list=None, revision=None):
4333
if revision_id_list is not None and revision is not None:
4334
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4335
if revision_id_list is None and revision is None:
4336
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4337
b = WorkingTree.open_containing(u'.')[0].branch
4340
return self._run(b, revision_id_list, revision)
4344
def _run(self, b, revision_id_list, revision):
4345
import bzrlib.gpg as gpg
4346
gpg_strategy = gpg.GPGStrategy(b.get_config())
4347
if revision_id_list is not None:
4348
b.repository.start_write_group()
4350
for revision_id in revision_id_list:
4351
b.repository.sign_revision(revision_id, gpg_strategy)
4353
b.repository.abort_write_group()
4356
b.repository.commit_write_group()
4357
elif revision is not None:
4358
if len(revision) == 1:
4359
revno, rev_id = revision[0].in_history(b)
4360
b.repository.start_write_group()
4362
b.repository.sign_revision(rev_id, gpg_strategy)
4364
b.repository.abort_write_group()
4367
b.repository.commit_write_group()
4368
elif len(revision) == 2:
4369
# are they both on rh- if so we can walk between them
4370
# might be nice to have a range helper for arbitrary
4371
# revision paths. hmm.
4372
from_revno, from_revid = revision[0].in_history(b)
4373
to_revno, to_revid = revision[1].in_history(b)
4374
if to_revid is None:
4375
to_revno = b.revno()
4376
if from_revno is None or to_revno is None:
4377
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4378
b.repository.start_write_group()
4380
for revno in range(from_revno, to_revno + 1):
4381
b.repository.sign_revision(b.get_rev_id(revno),
4384
b.repository.abort_write_group()
4387
b.repository.commit_write_group()
4389
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4392
class cmd_bind(Command):
4393
"""Convert the current branch into a checkout of the supplied branch.
4395
Once converted into a checkout, commits must succeed on the master branch
4396
before they will be applied to the local branch.
4398
Bound branches use the nickname of its master branch unless it is set
4399
locally, in which case binding will update the the local nickname to be
4403
_see_also = ['checkouts', 'unbind']
4404
takes_args = ['location?']
4407
def run(self, location=None):
4408
b, relpath = Branch.open_containing(u'.')
4409
if location is None:
4411
location = b.get_old_bound_location()
4412
except errors.UpgradeRequired:
4413
raise errors.BzrCommandError('No location supplied. '
4414
'This format does not remember old locations.')
4416
if location is None:
4417
raise errors.BzrCommandError('No location supplied and no '
4418
'previous location known')
4419
b_other = Branch.open(location)
4422
except errors.DivergedBranches:
4423
raise errors.BzrCommandError('These branches have diverged.'
4424
' Try merging, and then bind again.')
4425
if b.get_config().has_explicit_nickname():
4426
b.nick = b_other.nick
4429
class cmd_unbind(Command):
4430
"""Convert the current checkout into a regular branch.
4432
After unbinding, the local branch is considered independent and subsequent
4433
commits will be local only.
4436
_see_also = ['checkouts', 'bind']
4441
b, relpath = Branch.open_containing(u'.')
4443
raise errors.BzrCommandError('Local branch is not bound')
4446
class cmd_uncommit(Command):
4447
"""Remove the last committed revision.
4449
--verbose will print out what is being removed.
4450
--dry-run will go through all the motions, but not actually
4453
If --revision is specified, uncommit revisions to leave the branch at the
4454
specified revision. For example, "bzr uncommit -r 15" will leave the
4455
branch at revision 15.
4457
Uncommit leaves the working tree ready for a new commit. The only change
4458
it may make is to restore any pending merges that were present before
4462
# TODO: jam 20060108 Add an option to allow uncommit to remove
4463
# unreferenced information in 'branch-as-repository' branches.
4464
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4465
# information in shared branches as well.
4466
_see_also = ['commit']
4467
takes_options = ['verbose', 'revision',
4468
Option('dry-run', help='Don\'t actually make changes.'),
4469
Option('force', help='Say yes to all questions.'),
4471
help="Only remove the commits from the local branch"
4472
" when in a checkout."
4475
takes_args = ['location?']
4477
encoding_type = 'replace'
4479
def run(self, location=None,
4480
dry_run=False, verbose=False,
4481
revision=None, force=False, local=False):
4482
if location is None:
4484
control, relpath = bzrdir.BzrDir.open_containing(location)
4486
tree = control.open_workingtree()
4488
except (errors.NoWorkingTree, errors.NotLocalUrl):
4490
b = control.open_branch()
4492
if tree is not None:
4497
return self._run(b, tree, dry_run, verbose, revision, force,
4500
if tree is not None:
4505
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4506
from bzrlib.log import log_formatter, show_log
4507
from bzrlib.uncommit import uncommit
4509
last_revno, last_rev_id = b.last_revision_info()
4512
if revision is None:
4514
rev_id = last_rev_id
4516
# 'bzr uncommit -r 10' actually means uncommit
4517
# so that the final tree is at revno 10.
4518
# but bzrlib.uncommit.uncommit() actually uncommits
4519
# the revisions that are supplied.
4520
# So we need to offset it by one
4521
revno = revision[0].in_history(b).revno + 1
4522
if revno <= last_revno:
4523
rev_id = b.get_rev_id(revno)
4525
if rev_id is None or _mod_revision.is_null(rev_id):
4526
self.outf.write('No revisions to uncommit.\n')
4529
lf = log_formatter('short',
4531
show_timezone='original')
4536
direction='forward',
4537
start_revision=revno,
4538
end_revision=last_revno)
4541
print 'Dry-run, pretending to remove the above revisions.'
4543
val = raw_input('Press <enter> to continue')
4545
print 'The above revision(s) will be removed.'
4547
val = raw_input('Are you sure [y/N]? ')
4548
if val.lower() not in ('y', 'yes'):
4552
mutter('Uncommitting from {%s} to {%s}',
4553
last_rev_id, rev_id)
4554
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4555
revno=revno, local=local)
4556
note('You can restore the old tip by running:\n'
4557
' bzr pull . -r revid:%s', last_rev_id)
4560
class cmd_break_lock(Command):
4561
"""Break a dead lock on a repository, branch or working directory.
4563
CAUTION: Locks should only be broken when you are sure that the process
4564
holding the lock has been stopped.
4566
You can get information on what locks are open via the 'bzr info' command.
4571
takes_args = ['location?']
4573
def run(self, location=None, show=False):
4574
if location is None:
4576
control, relpath = bzrdir.BzrDir.open_containing(location)
4578
control.break_lock()
4579
except NotImplementedError:
4583
class cmd_wait_until_signalled(Command):
4584
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4586
This just prints a line to signal when it is ready, then blocks on stdin.
4592
sys.stdout.write("running\n")
4594
sys.stdin.readline()
4597
class cmd_serve(Command):
4598
"""Run the bzr server."""
4600
aliases = ['server']
4604
help='Serve on stdin/out for use from inetd or sshd.'),
4605
RegistryOption('protocol',
4606
help="Protocol to serve.",
4607
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4608
value_switches=True),
4610
help='Listen for connections on nominated port of the form '
4611
'[hostname:]portnumber. Passing 0 as the port number will '
4612
'result in a dynamically allocated port. The default port '
4613
'depends on the protocol.',
4616
help='Serve contents of this directory.',
4618
Option('allow-writes',
4619
help='By default the server is a readonly server. Supplying '
4620
'--allow-writes enables write access to the contents of '
4621
'the served directory and below.'
4625
def get_host_and_port(self, port):
4626
"""Return the host and port to run the smart server on.
4628
If 'port' is None, None will be returned for the host and port.
4630
If 'port' has a colon in it, the string before the colon will be
4631
interpreted as the host.
4633
:param port: A string of the port to run the server on.
4634
:return: A tuple of (host, port), where 'host' is a host name or IP,
4635
and port is an integer TCP/IP port.
4638
if port is not None:
4640
host, port = port.split(':')
4644
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4646
from bzrlib.transport import get_transport, transport_server_registry
4647
if directory is None:
4648
directory = os.getcwd()
4649
if protocol is None:
4650
protocol = transport_server_registry.get()
4651
host, port = self.get_host_and_port(port)
4652
url = urlutils.local_path_to_url(directory)
4653
if not allow_writes:
4654
url = 'readonly+' + url
4655
transport = get_transport(url)
4656
protocol(transport, host, port, inet)
4659
class cmd_join(Command):
4660
"""Combine a tree into its containing tree.
4662
This command requires the target tree to be in a rich-root format.
4664
The TREE argument should be an independent tree, inside another tree, but
4665
not part of it. (Such trees can be produced by "bzr split", but also by
4666
running "bzr branch" with the target inside a tree.)
4668
The result is a combined tree, with the subtree no longer an independant
4669
part. This is marked as a merge of the subtree into the containing tree,
4670
and all history is preserved.
4673
_see_also = ['split']
4674
takes_args = ['tree']
4676
Option('reference', help='Join by reference.', hidden=True),
4679
def run(self, tree, reference=False):
4680
sub_tree = WorkingTree.open(tree)
4681
parent_dir = osutils.dirname(sub_tree.basedir)
4682
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4683
repo = containing_tree.branch.repository
4684
if not repo.supports_rich_root():
4685
raise errors.BzrCommandError(
4686
"Can't join trees because %s doesn't support rich root data.\n"
4687
"You can use bzr upgrade on the repository."
4691
containing_tree.add_reference(sub_tree)
4692
except errors.BadReferenceTarget, e:
4693
# XXX: Would be better to just raise a nicely printable
4694
# exception from the real origin. Also below. mbp 20070306
4695
raise errors.BzrCommandError("Cannot join %s. %s" %
4699
containing_tree.subsume(sub_tree)
4700
except errors.BadSubsumeSource, e:
4701
raise errors.BzrCommandError("Cannot join %s. %s" %
4705
class cmd_split(Command):
4706
"""Split a subdirectory of a tree into a separate tree.
4708
This command will produce a target tree in a format that supports
4709
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4710
converted into earlier formats like 'dirstate-tags'.
4712
The TREE argument should be a subdirectory of a working tree. That
4713
subdirectory will be converted into an independent tree, with its own
4714
branch. Commits in the top-level tree will not apply to the new subtree.
4717
_see_also = ['join']
4718
takes_args = ['tree']
4720
def run(self, tree):
4721
containing_tree, subdir = WorkingTree.open_containing(tree)
4722
sub_id = containing_tree.path2id(subdir)
4724
raise errors.NotVersionedError(subdir)
4726
containing_tree.extract(sub_id)
4727
except errors.RootNotRich:
4728
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4731
class cmd_merge_directive(Command):
4732
"""Generate a merge directive for auto-merge tools.
4734
A directive requests a merge to be performed, and also provides all the
4735
information necessary to do so. This means it must either include a
4736
revision bundle, or the location of a branch containing the desired
4739
A submit branch (the location to merge into) must be supplied the first
4740
time the command is issued. After it has been supplied once, it will
4741
be remembered as the default.
4743
A public branch is optional if a revision bundle is supplied, but required
4744
if --diff or --plain is specified. It will be remembered as the default
4745
after the first use.
4748
takes_args = ['submit_branch?', 'public_branch?']
4752
_see_also = ['send']
4755
RegistryOption.from_kwargs('patch-type',
4756
'The type of patch to include in the directive.',
4758
value_switches=True,
4760
bundle='Bazaar revision bundle (default).',
4761
diff='Normal unified diff.',
4762
plain='No patch, just directive.'),
4763
Option('sign', help='GPG-sign the directive.'), 'revision',
4764
Option('mail-to', type=str,
4765
help='Instead of printing the directive, email to this address.'),
4766
Option('message', type=str, short_name='m',
4767
help='Message to use when committing this merge.')
4770
encoding_type = 'exact'
4772
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4773
sign=False, revision=None, mail_to=None, message=None):
4774
from bzrlib.revision import ensure_null, NULL_REVISION
4775
include_patch, include_bundle = {
4776
'plain': (False, False),
4777
'diff': (True, False),
4778
'bundle': (True, True),
4780
branch = Branch.open('.')
4781
stored_submit_branch = branch.get_submit_branch()
4782
if submit_branch is None:
4783
submit_branch = stored_submit_branch
4785
if stored_submit_branch is None:
4786
branch.set_submit_branch(submit_branch)
4787
if submit_branch is None:
4788
submit_branch = branch.get_parent()
4789
if submit_branch is None:
4790
raise errors.BzrCommandError('No submit branch specified or known')
4792
stored_public_branch = branch.get_public_branch()
4793
if public_branch is None:
4794
public_branch = stored_public_branch
4795
elif stored_public_branch is None:
4796
branch.set_public_branch(public_branch)
4797
if not include_bundle and public_branch is None:
4798
raise errors.BzrCommandError('No public branch specified or'
4800
base_revision_id = None
4801
if revision is not None:
4802
if len(revision) > 2:
4803
raise errors.BzrCommandError('bzr merge-directive takes '
4804
'at most two one revision identifiers')
4805
revision_id = revision[-1].as_revision_id(branch)
4806
if len(revision) == 2:
4807
base_revision_id = revision[0].as_revision_id(branch)
4809
revision_id = branch.last_revision()
4810
revision_id = ensure_null(revision_id)
4811
if revision_id == NULL_REVISION:
4812
raise errors.BzrCommandError('No revisions to bundle.')
4813
directive = merge_directive.MergeDirective2.from_objects(
4814
branch.repository, revision_id, time.time(),
4815
osutils.local_time_offset(), submit_branch,
4816
public_branch=public_branch, include_patch=include_patch,
4817
include_bundle=include_bundle, message=message,
4818
base_revision_id=base_revision_id)
4821
self.outf.write(directive.to_signed(branch))
4823
self.outf.writelines(directive.to_lines())
4825
message = directive.to_email(mail_to, branch, sign)
4826
s = SMTPConnection(branch.get_config())
4827
s.send_email(message)
4830
class cmd_send(Command):
4831
"""Mail or create a merge-directive for submitting changes.
4833
A merge directive provides many things needed for requesting merges:
4835
* A machine-readable description of the merge to perform
4837
* An optional patch that is a preview of the changes requested
4839
* An optional bundle of revision data, so that the changes can be applied
4840
directly from the merge directive, without retrieving data from a
4843
If --no-bundle is specified, then public_branch is needed (and must be
4844
up-to-date), so that the receiver can perform the merge using the
4845
public_branch. The public_branch is always included if known, so that
4846
people can check it later.
4848
The submit branch defaults to the parent, but can be overridden. Both
4849
submit branch and public branch will be remembered if supplied.
4851
If a public_branch is known for the submit_branch, that public submit
4852
branch is used in the merge instructions. This means that a local mirror
4853
can be used as your actual submit branch, once you have set public_branch
4856
Mail is sent using your preferred mail program. This should be transparent
4857
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4858
If the preferred client can't be found (or used), your editor will be used.
4860
To use a specific mail program, set the mail_client configuration option.
4861
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4862
specific clients are "claws", "evolution", "kmail", "mutt", and
4863
"thunderbird"; generic options are "default", "editor", "emacsclient",
4864
"mapi", and "xdg-email". Plugins may also add supported clients.
4866
If mail is being sent, a to address is required. This can be supplied
4867
either on the commandline, by setting the submit_to configuration
4868
option in the branch itself or the child_submit_to configuration option
4869
in the submit branch.
4871
Two formats are currently supported: "4" uses revision bundle format 4 and
4872
merge directive format 2. It is significantly faster and smaller than
4873
older formats. It is compatible with Bazaar 0.19 and later. It is the
4874
default. "0.9" uses revision bundle format 0.9 and merge directive
4875
format 1. It is compatible with Bazaar 0.12 - 0.18.
4877
The merge directives created by bzr send may be applied using bzr merge or
4878
bzr pull by specifying a file containing a merge directive as the location.
4881
encoding_type = 'exact'
4883
_see_also = ['merge', 'pull']
4885
takes_args = ['submit_branch?', 'public_branch?']
4889
help='Do not include a bundle in the merge directive.'),
4890
Option('no-patch', help='Do not include a preview patch in the merge'
4893
help='Remember submit and public branch.'),
4895
help='Branch to generate the submission from, '
4896
'rather than the one containing the working directory.',
4899
Option('output', short_name='o',
4900
help='Write merge directive to this file; '
4901
'use - for stdout.',
4903
Option('mail-to', help='Mail the request to this address.',
4907
Option('body', help='Body for the email.', type=unicode),
4908
RegistryOption('format',
4909
help='Use the specified output format.',
4910
lazy_registry=('bzrlib.send', 'format_registry'))
4913
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4914
no_patch=False, revision=None, remember=False, output=None,
4915
format=None, mail_to=None, message=None, body=None, **kwargs):
4916
from bzrlib.send import send
4917
return send(submit_branch, revision, public_branch, remember,
4918
format, no_bundle, no_patch, output,
4919
kwargs.get('from', '.'), mail_to, message, body,
4923
class cmd_bundle_revisions(cmd_send):
4924
"""Create a merge-directive for submitting changes.
4926
A merge directive provides many things needed for requesting merges:
4928
* A machine-readable description of the merge to perform
4930
* An optional patch that is a preview of the changes requested
4932
* An optional bundle of revision data, so that the changes can be applied
4933
directly from the merge directive, without retrieving data from a
4936
If --no-bundle is specified, then public_branch is needed (and must be
4937
up-to-date), so that the receiver can perform the merge using the
4938
public_branch. The public_branch is always included if known, so that
4939
people can check it later.
4941
The submit branch defaults to the parent, but can be overridden. Both
4942
submit branch and public branch will be remembered if supplied.
4944
If a public_branch is known for the submit_branch, that public submit
4945
branch is used in the merge instructions. This means that a local mirror
4946
can be used as your actual submit branch, once you have set public_branch
4949
Two formats are currently supported: "4" uses revision bundle format 4 and
4950
merge directive format 2. It is significantly faster and smaller than
4951
older formats. It is compatible with Bazaar 0.19 and later. It is the
4952
default. "0.9" uses revision bundle format 0.9 and merge directive
4953
format 1. It is compatible with Bazaar 0.12 - 0.18.
4958
help='Do not include a bundle in the merge directive.'),
4959
Option('no-patch', help='Do not include a preview patch in the merge'
4962
help='Remember submit and public branch.'),
4964
help='Branch to generate the submission from, '
4965
'rather than the one containing the working directory.',
4968
Option('output', short_name='o', help='Write directive to this file.',
4971
RegistryOption('format',
4972
help='Use the specified output format.',
4973
lazy_registry=('bzrlib.send', 'format_registry')),
4975
aliases = ['bundle']
4977
_see_also = ['send', 'merge']
4981
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4982
no_patch=False, revision=None, remember=False, output=None,
4983
format=None, **kwargs):
4986
from bzrlib.send import send
4987
return send(submit_branch, revision, public_branch, remember,
4988
format, no_bundle, no_patch, output,
4989
kwargs.get('from', '.'), None, None, None,
4993
class cmd_tag(Command):
4994
"""Create, remove or modify a tag naming a revision.
4996
Tags give human-meaningful names to revisions. Commands that take a -r
4997
(--revision) option can be given -rtag:X, where X is any previously
5000
Tags are stored in the branch. Tags are copied from one branch to another
5001
along when you branch, push, pull or merge.
5003
It is an error to give a tag name that already exists unless you pass
5004
--force, in which case the tag is moved to point to the new revision.
5006
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5007
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5010
_see_also = ['commit', 'tags']
5011
takes_args = ['tag_name']
5014
help='Delete this tag rather than placing it.',
5017
help='Branch in which to place the tag.',
5022
help='Replace existing tags.',
5027
def run(self, tag_name,
5033
branch, relpath = Branch.open_containing(directory)
5037
branch.tags.delete_tag(tag_name)
5038
self.outf.write('Deleted tag %s.\n' % tag_name)
5041
if len(revision) != 1:
5042
raise errors.BzrCommandError(
5043
"Tags can only be placed on a single revision, "
5045
revision_id = revision[0].as_revision_id(branch)
5047
revision_id = branch.last_revision()
5048
if (not force) and branch.tags.has_tag(tag_name):
5049
raise errors.TagAlreadyExists(tag_name)
5050
branch.tags.set_tag(tag_name, revision_id)
5051
self.outf.write('Created tag %s.\n' % tag_name)
5056
class cmd_tags(Command):
5059
This command shows a table of tag names and the revisions they reference.
5065
help='Branch whose tags should be displayed.',
5069
RegistryOption.from_kwargs('sort',
5070
'Sort tags by different criteria.', title='Sorting',
5071
alpha='Sort tags lexicographically (default).',
5072
time='Sort tags chronologically.',
5085
branch, relpath = Branch.open_containing(directory)
5087
tags = branch.tags.get_tag_dict().items()
5094
graph = branch.repository.get_graph()
5095
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5096
revid1, revid2 = rev1.rev_id, rev2.rev_id
5097
# only show revisions between revid1 and revid2 (inclusive)
5098
tags = [(tag, revid) for tag, revid in tags if
5099
graph.is_between(revid, revid1, revid2)]
5102
elif sort == 'time':
5104
for tag, revid in tags:
5106
revobj = branch.repository.get_revision(revid)
5107
except errors.NoSuchRevision:
5108
timestamp = sys.maxint # place them at the end
5110
timestamp = revobj.timestamp
5111
timestamps[revid] = timestamp
5112
tags.sort(key=lambda x: timestamps[x[1]])
5114
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5115
for index, (tag, revid) in enumerate(tags):
5117
revno = branch.revision_id_to_dotted_revno(revid)
5118
if isinstance(revno, tuple):
5119
revno = '.'.join(map(str, revno))
5120
except errors.NoSuchRevision:
5121
# Bad tag data/merges can lead to tagged revisions
5122
# which are not in this branch. Fail gracefully ...
5124
tags[index] = (tag, revno)
5127
for tag, revspec in tags:
5128
self.outf.write('%-20s %s\n' % (tag, revspec))
5131
class cmd_reconfigure(Command):
5132
"""Reconfigure the type of a bzr directory.
5134
A target configuration must be specified.
5136
For checkouts, the bind-to location will be auto-detected if not specified.
5137
The order of preference is
5138
1. For a lightweight checkout, the current bound location.
5139
2. For branches that used to be checkouts, the previously-bound location.
5140
3. The push location.
5141
4. The parent location.
5142
If none of these is available, --bind-to must be specified.
5145
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5146
takes_args = ['location?']
5148
RegistryOption.from_kwargs(
5150
title='Target type',
5151
help='The type to reconfigure the directory to.',
5152
value_switches=True, enum_switch=False,
5153
branch='Reconfigure to be an unbound branch with no working tree.',
5154
tree='Reconfigure to be an unbound branch with a working tree.',
5155
checkout='Reconfigure to be a bound branch with a working tree.',
5156
lightweight_checkout='Reconfigure to be a lightweight'
5157
' checkout (with no local history).',
5158
standalone='Reconfigure to be a standalone branch '
5159
'(i.e. stop using shared repository).',
5160
use_shared='Reconfigure to use a shared repository.',
5161
with_trees='Reconfigure repository to create '
5162
'working trees on branches by default.',
5163
with_no_trees='Reconfigure repository to not create '
5164
'working trees on branches by default.'
5166
Option('bind-to', help='Branch to bind checkout to.', type=str),
5168
help='Perform reconfiguration even if local changes'
5172
def run(self, location=None, target_type=None, bind_to=None, force=False):
5173
directory = bzrdir.BzrDir.open(location)
5174
if target_type is None:
5175
raise errors.BzrCommandError('No target configuration specified')
5176
elif target_type == 'branch':
5177
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5178
elif target_type == 'tree':
5179
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5180
elif target_type == 'checkout':
5181
reconfiguration = reconfigure.Reconfigure.to_checkout(
5183
elif target_type == 'lightweight-checkout':
5184
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5186
elif target_type == 'use-shared':
5187
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5188
elif target_type == 'standalone':
5189
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5190
elif target_type == 'with-trees':
5191
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5193
elif target_type == 'with-no-trees':
5194
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5196
reconfiguration.apply(force)
5199
class cmd_switch(Command):
5200
"""Set the branch of a checkout and update.
5202
For lightweight checkouts, this changes the branch being referenced.
5203
For heavyweight checkouts, this checks that there are no local commits
5204
versus the current bound branch, then it makes the local branch a mirror
5205
of the new location and binds to it.
5207
In both cases, the working tree is updated and uncommitted changes
5208
are merged. The user can commit or revert these as they desire.
5210
Pending merges need to be committed or reverted before using switch.
5212
The path to the branch to switch to can be specified relative to the parent
5213
directory of the current branch. For example, if you are currently in a
5214
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5217
Bound branches use the nickname of its master branch unless it is set
5218
locally, in which case switching will update the the local nickname to be
5222
takes_args = ['to_location']
5223
takes_options = [Option('force',
5224
help='Switch even if local commits will be lost.')
5227
def run(self, to_location, force=False):
5228
from bzrlib import switch
5230
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5232
branch = control_dir.open_branch()
5233
had_explicit_nick = branch.get_config().has_explicit_nickname()
5234
except errors.NotBranchError:
5235
had_explicit_nick = False
5237
to_branch = Branch.open(to_location)
5238
except errors.NotBranchError:
5239
this_url = self._get_branch_location(control_dir)
5240
to_branch = Branch.open(
5241
urlutils.join(this_url, '..', to_location))
5242
switch.switch(control_dir, to_branch, force)
5243
if had_explicit_nick:
5244
branch = control_dir.open_branch() #get the new branch!
5245
branch.nick = to_branch.nick
5246
note('Switched to branch: %s',
5247
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5249
def _get_branch_location(self, control_dir):
5250
"""Return location of branch for this control dir."""
5252
this_branch = control_dir.open_branch()
5253
# This may be a heavy checkout, where we want the master branch
5254
master_location = this_branch.get_bound_location()
5255
if master_location is not None:
5256
return master_location
5257
# If not, use a local sibling
5258
return this_branch.base
5259
except errors.NotBranchError:
5260
format = control_dir.find_branch_format()
5261
if getattr(format, 'get_reference', None) is not None:
5262
return format.get_reference(control_dir)
5264
return control_dir.root_transport.base
5267
class cmd_view(Command):
5268
"""Manage filtered views.
5270
Views provide a mask over the tree so that users can focus on
5271
a subset of a tree when doing their work. After creating a view,
5272
commands that support a list of files - status, diff, commit, etc -
5273
effectively have that list of files implicitly given each time.
5274
An explicit list of files can still be given but those files
5275
must be within the current view.
5277
In most cases, a view has a short life-span: it is created to make
5278
a selected change and is deleted once that change is committed.
5279
At other times, you may wish to create one or more named views
5280
and switch between them.
5282
To disable the current view without deleting it, you can switch to
5283
the pseudo view called ``off``. This can be useful when you need
5284
to see the whole tree for an operation or two (e.g. merge) but
5285
want to switch back to your view after that.
5288
To define the current view::
5290
bzr view file1 dir1 ...
5292
To list the current view::
5296
To delete the current view::
5300
To disable the current view without deleting it::
5302
bzr view --switch off
5304
To define a named view and switch to it::
5306
bzr view --name view-name file1 dir1 ...
5308
To list a named view::
5310
bzr view --name view-name
5312
To delete a named view::
5314
bzr view --name view-name --delete
5316
To switch to a named view::
5318
bzr view --switch view-name
5320
To list all views defined::
5324
To delete all views::
5326
bzr view --delete --all
5330
takes_args = ['file*']
5333
help='Apply list or delete action to all views.',
5336
help='Delete the view.',
5339
help='Name of the view to define, list or delete.',
5343
help='Name of the view to switch to.',
5348
def run(self, file_list,
5354
tree, file_list = tree_files(file_list, apply_view=False)
5355
current_view, view_dict = tree.views.get_view_info()
5360
raise errors.BzrCommandError(
5361
"Both --delete and a file list specified")
5363
raise errors.BzrCommandError(
5364
"Both --delete and --switch specified")
5366
tree.views.set_view_info(None, {})
5367
self.outf.write("Deleted all views.\n")
5369
raise errors.BzrCommandError("No current view to delete")
5371
tree.views.delete_view(name)
5372
self.outf.write("Deleted '%s' view.\n" % name)
5375
raise errors.BzrCommandError(
5376
"Both --switch and a file list specified")
5378
raise errors.BzrCommandError(
5379
"Both --switch and --all specified")
5380
elif switch == 'off':
5381
if current_view is None:
5382
raise errors.BzrCommandError("No current view to disable")
5383
tree.views.set_view_info(None, view_dict)
5384
self.outf.write("Disabled '%s' view.\n" % (current_view))
5386
tree.views.set_view_info(switch, view_dict)
5387
view_str = views.view_display_str(tree.views.lookup_view())
5388
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5391
self.outf.write('Views defined:\n')
5392
for view in sorted(view_dict):
5393
if view == current_view:
5397
view_str = views.view_display_str(view_dict[view])
5398
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5400
self.outf.write('No views defined.\n')
5403
# No name given and no current view set
5406
raise errors.BzrCommandError(
5407
"Cannot change the 'off' pseudo view")
5408
tree.views.set_view(name, sorted(file_list))
5409
view_str = views.view_display_str(tree.views.lookup_view())
5410
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5414
# No name given and no current view set
5415
self.outf.write('No current view.\n')
5417
view_str = views.view_display_str(tree.views.lookup_view(name))
5418
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5421
class cmd_hooks(Command):
5427
for hook_key in sorted(hooks.known_hooks.keys()):
5428
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5429
self.outf.write("%s:\n" % type(some_hooks).__name__)
5430
for hook_name, hook_point in sorted(some_hooks.items()):
5431
self.outf.write(" %s:\n" % (hook_name,))
5432
found_hooks = list(hook_point)
5434
for hook in found_hooks:
5435
self.outf.write(" %s\n" %
5436
(some_hooks.get_hook_name(hook),))
5438
self.outf.write(" <no hooks installed>\n")
5441
class cmd_shelve(Command):
5442
"""Temporarily set aside some changes from the current tree.
5444
Shelve allows you to temporarily put changes you've made "on the shelf",
5445
ie. out of the way, until a later time when you can bring them back from
5446
the shelf with the 'unshelve' command. The changes are stored alongside
5447
your working tree, and so they aren't propagated along with your branch nor
5448
will they survive its deletion.
5450
If shelve --list is specified, previously-shelved changes are listed.
5452
Shelve is intended to help separate several sets of changes that have
5453
been inappropriately mingled. If you just want to get rid of all changes
5454
and you don't need to restore them later, use revert. If you want to
5455
shelve all text changes at once, use shelve --all.
5457
If filenames are specified, only the changes to those files will be
5458
shelved. Other files will be left untouched.
5460
If a revision is specified, changes since that revision will be shelved.
5462
You can put multiple items on the shelf, and by default, 'unshelve' will
5463
restore the most recently shelved changes.
5466
takes_args = ['file*']
5470
Option('all', help='Shelve all changes.'),
5472
RegistryOption('writer', 'Method to use for writing diffs.',
5473
bzrlib.option.diff_writer_registry,
5474
value_switches=True, enum_switch=False),
5476
Option('list', help='List shelved changes.'),
5478
help='Destroy removed changes instead of shelving them.'),
5480
_see_also = ['unshelve']
5482
def run(self, revision=None, all=False, file_list=None, message=None,
5483
writer=None, list=False, destroy=False):
5485
return self.run_for_list()
5486
from bzrlib.shelf_ui import Shelver
5488
writer = bzrlib.option.diff_writer_registry.get()
5490
Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5491
message, destroy=destroy).run()
5492
except errors.UserAbort:
5495
def run_for_list(self):
5496
tree = WorkingTree.open_containing('.')[0]
5499
manager = tree.get_shelf_manager()
5500
shelves = manager.active_shelves()
5501
if len(shelves) == 0:
5502
note('No shelved changes.')
5504
for shelf_id in reversed(shelves):
5505
message = manager.get_metadata(shelf_id).get('message')
5507
message = '<no message>'
5508
self.outf.write('%3d: %s\n' % (shelf_id, message))
5514
class cmd_unshelve(Command):
5515
"""Restore shelved changes.
5517
By default, the most recently shelved changes are restored. However if you
5518
specify a shelf by id those changes will be restored instead. This works
5519
best when the changes don't depend on each other.
5522
takes_args = ['shelf_id?']
5524
RegistryOption.from_kwargs(
5525
'action', help="The action to perform.",
5526
enum_switch=False, value_switches=True,
5527
apply="Apply changes and remove from the shelf.",
5528
dry_run="Show changes, but do not apply or remove them.",
5529
delete_only="Delete changes without applying them."
5532
_see_also = ['shelve']
5534
def run(self, shelf_id=None, action='apply'):
5535
from bzrlib.shelf_ui import Unshelver
5536
Unshelver.from_args(shelf_id, action).run()
5539
class cmd_clean_tree(Command):
5540
"""Remove unwanted files from working tree.
5542
By default, only unknown files, not ignored files, are deleted. Versioned
5543
files are never deleted.
5545
Another class is 'detritus', which includes files emitted by bzr during
5546
normal operations and selftests. (The value of these files decreases with
5549
If no options are specified, unknown files are deleted. Otherwise, option
5550
flags are respected, and may be combined.
5552
To check what clean-tree will do, use --dry-run.
5554
takes_options = [Option('ignored', help='Delete all ignored files.'),
5555
Option('detritus', help='Delete conflict files, merge'
5556
' backups, and failed selftest dirs.'),
5558
help='Delete files unknown to bzr (default).'),
5559
Option('dry-run', help='Show files to delete instead of'
5561
Option('force', help='Do not prompt before deleting.')]
5562
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5564
from bzrlib.clean_tree import clean_tree
5565
if not (unknown or ignored or detritus):
5569
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5570
dry_run=dry_run, no_prompt=force)
5573
class cmd_reference(Command):
5574
"""list, view and set branch locations for nested trees.
5576
If no arguments are provided, lists the branch locations for nested trees.
5577
If one argument is provided, display the branch location for that tree.
5578
If two arguments are provided, set the branch location for that tree.
5583
takes_args = ['path?', 'location?']
5585
def run(self, path=None, location=None):
5587
if path is not None:
5589
tree, branch, relpath =(
5590
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5591
if path is not None:
5594
tree = branch.basis_tree()
5596
info = branch._get_all_reference_info().iteritems()
5597
self._display_reference_info(tree, branch, info)
5599
file_id = tree.path2id(path)
5601
raise errors.NotVersionedError(path)
5602
if location is None:
5603
info = [(file_id, branch.get_reference_info(file_id))]
5604
self._display_reference_info(tree, branch, info)
5606
branch.set_reference_info(file_id, path, location)
5608
def _display_reference_info(self, tree, branch, info):
5610
for file_id, (path, location) in info:
5612
path = tree.id2path(file_id)
5613
except errors.NoSuchId:
5615
ref_list.append((path, location))
5616
for path, location in sorted(ref_list):
5617
self.outf.write('%s %s\n' % (path, location))
5620
# these get imported and then picked up by the scan for cmd_*
5621
# TODO: Some more consistent way to split command definitions across files;
5622
# we do need to load at least some information about them to know of
5623
# aliases. ideally we would avoid loading the implementation until the
5624
# details were needed.
5625
from bzrlib.cmd_version_info import cmd_version_info
5626
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5627
from bzrlib.bundle.commands import (
5630
from bzrlib.foreign import cmd_dpush
5631
from bzrlib.sign_my_commits import cmd_sign_my_commits
5632
from bzrlib.weave_commands import cmd_versionedfile_list, \
5633
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
