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(), """
46
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
58
from bzrlib.smtp_connection import SMTPConnection
59
from bzrlib.workingtree import WorkingTree
62
from bzrlib.commands import Command, display_command
63
from bzrlib.option import (
70
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
73
def tree_files(file_list, default_branch=u'.', canonicalize=True,
76
return internal_tree_files(file_list, default_branch, canonicalize,
78
except errors.FileInWrongBranch, e:
79
raise errors.BzrCommandError("%s is not in the same branch as %s" %
80
(e.path, file_list[0]))
83
def tree_files_for_add(file_list):
85
Return a tree and list of absolute paths from a file list.
87
Similar to tree_files, but add handles files a bit differently, so it a
88
custom implementation. In particular, MutableTreeTree.smart_add expects
89
absolute paths, which it immediately converts to relative paths.
91
# FIXME Would be nice to just return the relative paths like
92
# internal_tree_files does, but there are a large number of unit tests
93
# that assume the current interface to mutabletree.smart_add
95
tree, relpath = WorkingTree.open_containing(file_list[0])
96
if tree.supports_views():
97
view_files = tree.views.lookup_view()
99
for filename in file_list:
100
if not osutils.is_inside_any(view_files, filename):
101
raise errors.FileOutsideView(filename, view_files)
102
file_list = file_list[:]
103
file_list[0] = tree.abspath(relpath)
105
tree = WorkingTree.open_containing(u'.')[0]
106
if tree.supports_views():
107
view_files = tree.views.lookup_view()
109
file_list = view_files
110
view_str = views.view_display_str(view_files)
111
note("Ignoring files outside view. View is %s" % view_str)
112
return tree, file_list
115
def _get_one_revision(command_name, revisions):
116
if revisions is None:
118
if len(revisions) != 1:
119
raise errors.BzrCommandError(
120
'bzr %s --revision takes exactly one revision identifier' % (
125
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
126
"""Get a revision tree. Not suitable for commands that change the tree.
128
Specifically, the basis tree in dirstate trees is coupled to the dirstate
129
and doing a commit/uncommit/pull will at best fail due to changing the
132
If tree is passed in, it should be already locked, for lifetime management
133
of the trees internal cached state.
137
if revisions is None:
139
rev_tree = tree.basis_tree()
141
rev_tree = branch.basis_tree()
143
revision = _get_one_revision(command_name, revisions)
144
rev_tree = revision.as_tree(branch)
148
# XXX: Bad function name; should possibly also be a class method of
149
# WorkingTree rather than a function.
150
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
152
"""Convert command-line paths to a WorkingTree and relative paths.
154
This is typically used for command-line processors that take one or
155
more filenames, and infer the workingtree that contains them.
157
The filenames given are not required to exist.
159
:param file_list: Filenames to convert.
161
:param default_branch: Fallback tree path to use if file_list is empty or
164
:param apply_view: if True and a view is set, apply it or check that
165
specified files are within it
167
:return: workingtree, [relative_paths]
169
if file_list is None or len(file_list) == 0:
170
tree = WorkingTree.open_containing(default_branch)[0]
171
if tree.supports_views() and apply_view:
172
view_files = tree.views.lookup_view()
174
file_list = view_files
175
view_str = views.view_display_str(view_files)
176
note("Ignoring files outside view. View is %s" % view_str)
177
return tree, file_list
178
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
179
return tree, safe_relpath_files(tree, file_list, canonicalize,
180
apply_view=apply_view)
183
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
184
"""Convert file_list into a list of relpaths in tree.
186
:param tree: A tree to operate on.
187
:param file_list: A list of user provided paths or None.
188
:param apply_view: if True and a view is set, apply it or check that
189
specified files are within it
190
:return: A list of relative paths.
191
:raises errors.PathNotChild: When a provided path is in a different tree
194
if file_list is None:
196
if tree.supports_views() and apply_view:
197
view_files = tree.views.lookup_view()
201
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
202
# doesn't - fix that up here before we enter the loop.
204
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
207
for filename in file_list:
209
relpath = fixer(osutils.dereference_path(filename))
210
if view_files and not osutils.is_inside_any(view_files, relpath):
211
raise errors.FileOutsideView(filename, view_files)
212
new_list.append(relpath)
213
except errors.PathNotChild:
214
raise errors.FileInWrongBranch(tree.branch, filename)
218
def _get_view_info_for_change_reporter(tree):
219
"""Get the view information from a tree for change reporting."""
222
current_view = tree.views.get_view_info()[0]
223
if current_view is not None:
224
view_info = (current_view, tree.views.lookup_view())
225
except errors.ViewsNotSupported:
230
# TODO: Make sure no commands unconditionally use the working directory as a
231
# branch. If a filename argument is used, the first of them should be used to
232
# specify the branch. (Perhaps this can be factored out into some kind of
233
# Argument class, representing a file in a branch, where the first occurrence
236
class cmd_status(Command):
237
"""Display status summary.
239
This reports on versioned and unknown files, reporting them
240
grouped by state. Possible states are:
243
Versioned in the working copy but not in the previous revision.
246
Versioned in the previous revision but removed or deleted
250
Path of this file changed from the previous revision;
251
the text may also have changed. This includes files whose
252
parent directory was renamed.
255
Text has changed since the previous revision.
258
File kind has been changed (e.g. from file to directory).
261
Not versioned and not matching an ignore pattern.
263
Additionally for directories, symlinks and files with an executable
264
bit, Bazaar indicates their type using a trailing character: '/', '@'
267
To see ignored files use 'bzr ignored'. For details on the
268
changes to file texts, use 'bzr diff'.
270
Note that --short or -S gives status flags for each item, similar
271
to Subversion's status command. To get output similar to svn -q,
274
If no arguments are specified, the status of the entire working
275
directory is shown. Otherwise, only the status of the specified
276
files or directories is reported. If a directory is given, status
277
is reported for everything inside that directory.
279
Before merges are committed, the pending merge tip revisions are
280
shown. To see all pending merge revisions, use the -v option.
281
To skip the display of pending merge information altogether, use
282
the no-pending option or specify a file/directory.
284
If a revision argument is given, the status is calculated against
285
that revision, or between two revisions if two are provided.
288
# TODO: --no-recurse, --recurse options
290
takes_args = ['file*']
291
takes_options = ['show-ids', 'revision', 'change', 'verbose',
292
Option('short', help='Use short status indicators.',
294
Option('versioned', help='Only show versioned files.',
296
Option('no-pending', help='Don\'t show pending merges.',
299
aliases = ['st', 'stat']
301
encoding_type = 'replace'
302
_see_also = ['diff', 'revert', 'status-flags']
305
def run(self, show_ids=False, file_list=None, revision=None, short=False,
306
versioned=False, no_pending=False, verbose=False):
307
from bzrlib.status import show_tree_status
309
if revision and len(revision) > 2:
310
raise errors.BzrCommandError('bzr status --revision takes exactly'
311
' one or two revision specifiers')
313
tree, relfile_list = tree_files(file_list)
314
# Avoid asking for specific files when that is not needed.
315
if relfile_list == ['']:
317
# Don't disable pending merges for full trees other than '.'.
318
if file_list == ['.']:
320
# A specific path within a tree was given.
321
elif relfile_list is not None:
323
show_tree_status(tree, show_ids=show_ids,
324
specific_files=relfile_list, revision=revision,
325
to_file=self.outf, short=short, versioned=versioned,
326
show_pending=(not no_pending), verbose=verbose)
329
class cmd_cat_revision(Command):
330
"""Write out metadata for a revision.
332
The revision to print can either be specified by a specific
333
revision identifier, or you can use --revision.
337
takes_args = ['revision_id?']
338
takes_options = ['revision']
339
# cat-revision is more for frontends so should be exact
343
def run(self, revision_id=None, revision=None):
344
if revision_id is not None and revision is not None:
345
raise errors.BzrCommandError('You can only supply one of'
346
' revision_id or --revision')
347
if revision_id is None and revision is None:
348
raise errors.BzrCommandError('You must supply either'
349
' --revision or a revision_id')
350
b = WorkingTree.open_containing(u'.')[0].branch
352
# TODO: jam 20060112 should cat-revision always output utf-8?
353
if revision_id is not None:
354
revision_id = osutils.safe_revision_id(revision_id, warn=False)
356
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
357
except errors.NoSuchRevision:
358
msg = "The repository %s contains no revision %s." % (b.repository.base,
360
raise errors.BzrCommandError(msg)
361
elif revision is not None:
364
raise errors.BzrCommandError('You cannot specify a NULL'
366
rev_id = rev.as_revision_id(b)
367
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
370
class cmd_dump_btree(Command):
371
"""Dump the contents of a btree index file to stdout.
373
PATH is a btree index file, it can be any URL. This includes things like
374
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
376
By default, the tuples stored in the index file will be displayed. With
377
--raw, we will uncompress the pages, but otherwise display the raw bytes
381
# TODO: Do we want to dump the internal nodes as well?
382
# TODO: It would be nice to be able to dump the un-parsed information,
383
# rather than only going through iter_all_entries. However, this is
384
# good enough for a start
386
encoding_type = 'exact'
387
takes_args = ['path']
388
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
389
' rather than the parsed tuples.'),
392
def run(self, path, raw=False):
393
dirname, basename = osutils.split(path)
394
t = transport.get_transport(dirname)
396
self._dump_raw_bytes(t, basename)
398
self._dump_entries(t, basename)
400
def _get_index_and_bytes(self, trans, basename):
401
"""Create a BTreeGraphIndex and raw bytes."""
402
bt = btree_index.BTreeGraphIndex(trans, basename, None)
403
bytes = trans.get_bytes(basename)
404
bt._file = cStringIO.StringIO(bytes)
405
bt._size = len(bytes)
408
def _dump_raw_bytes(self, trans, basename):
411
# We need to parse at least the root node.
412
# This is because the first page of every row starts with an
413
# uncompressed header.
414
bt, bytes = self._get_index_and_bytes(trans, basename)
415
for page_idx, page_start in enumerate(xrange(0, len(bytes),
416
btree_index._PAGE_SIZE)):
417
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
418
page_bytes = bytes[page_start:page_end]
420
self.outf.write('Root node:\n')
421
header_end, data = bt._parse_header_from_bytes(page_bytes)
422
self.outf.write(page_bytes[:header_end])
424
self.outf.write('\nPage %d\n' % (page_idx,))
425
decomp_bytes = zlib.decompress(page_bytes)
426
self.outf.write(decomp_bytes)
427
self.outf.write('\n')
429
def _dump_entries(self, trans, basename):
431
st = trans.stat(basename)
432
except errors.TransportNotPossible:
433
# We can't stat, so we'll fake it because we have to do the 'get()'
435
bt, _ = self._get_index_and_bytes(trans, basename)
437
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
438
for node in bt.iter_all_entries():
439
# Node is made up of:
440
# (index, key, value, [references])
441
refs_as_tuples = static_tuple.as_tuples(node[3])
442
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
443
self.outf.write('%s\n' % (as_tuple,))
446
class cmd_remove_tree(Command):
447
"""Remove the working tree from a given branch/checkout.
449
Since a lightweight checkout is little more than a working tree
450
this will refuse to run against one.
452
To re-create the working tree, use "bzr checkout".
454
_see_also = ['checkout', 'working-trees']
455
takes_args = ['location?']
458
help='Remove the working tree even if it has '
459
'uncommitted changes.'),
462
def run(self, location='.', force=False):
463
d = bzrdir.BzrDir.open(location)
466
working = d.open_workingtree()
467
except errors.NoWorkingTree:
468
raise errors.BzrCommandError("No working tree to remove")
469
except errors.NotLocalUrl:
470
raise errors.BzrCommandError("You cannot remove the working tree"
473
if (working.has_changes()):
474
raise errors.UncommittedChanges(working)
476
working_path = working.bzrdir.root_transport.base
477
branch_path = working.branch.bzrdir.root_transport.base
478
if working_path != branch_path:
479
raise errors.BzrCommandError("You cannot remove the working tree"
480
" from a lightweight checkout")
482
d.destroy_workingtree()
485
class cmd_revno(Command):
486
"""Show current revision number.
488
This is equal to the number of revisions on this branch.
492
takes_args = ['location?']
494
Option('tree', help='Show revno of working tree'),
498
def run(self, tree=False, location=u'.'):
501
wt = WorkingTree.open_containing(location)[0]
503
except (errors.NoWorkingTree, errors.NotLocalUrl):
504
raise errors.NoWorkingTree(location)
506
revid = wt.last_revision()
508
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
509
except errors.NoSuchRevision:
511
revno = ".".join(str(n) for n in revno_t)
515
b = Branch.open_containing(location)[0]
522
self.outf.write(str(revno) + '\n')
525
class cmd_revision_info(Command):
526
"""Show revision number and revision id for a given revision identifier.
529
takes_args = ['revision_info*']
533
help='Branch to examine, '
534
'rather than the one containing the working directory.',
538
Option('tree', help='Show revno of working tree'),
542
def run(self, revision=None, directory=u'.', tree=False,
543
revision_info_list=[]):
546
wt = WorkingTree.open_containing(directory)[0]
549
except (errors.NoWorkingTree, errors.NotLocalUrl):
551
b = Branch.open_containing(directory)[0]
555
if revision is not None:
556
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
557
if revision_info_list is not None:
558
for rev_str in revision_info_list:
559
rev_spec = RevisionSpec.from_string(rev_str)
560
revision_ids.append(rev_spec.as_revision_id(b))
561
# No arguments supplied, default to the last revision
562
if len(revision_ids) == 0:
565
raise errors.NoWorkingTree(directory)
566
revision_ids.append(wt.last_revision())
568
revision_ids.append(b.last_revision())
572
for revision_id in revision_ids:
574
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
575
revno = '.'.join(str(i) for i in dotted_revno)
576
except errors.NoSuchRevision:
578
maxlen = max(maxlen, len(revno))
579
revinfos.append([revno, revision_id])
587
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
590
class cmd_add(Command):
591
"""Add specified files or directories.
593
In non-recursive mode, all the named items are added, regardless
594
of whether they were previously ignored. A warning is given if
595
any of the named files are already versioned.
597
In recursive mode (the default), files are treated the same way
598
but the behaviour for directories is different. Directories that
599
are already versioned do not give a warning. All directories,
600
whether already versioned or not, are searched for files or
601
subdirectories that are neither versioned or ignored, and these
602
are added. This search proceeds recursively into versioned
603
directories. If no names are given '.' is assumed.
605
Therefore simply saying 'bzr add' will version all files that
606
are currently unknown.
608
Adding a file whose parent directory is not versioned will
609
implicitly add the parent, and so on up to the root. This means
610
you should never need to explicitly add a directory, they'll just
611
get added when you add a file in the directory.
613
--dry-run will show which files would be added, but not actually
616
--file-ids-from will try to use the file ids from the supplied path.
617
It looks up ids trying to find a matching parent directory with the
618
same filename, and then by pure path. This option is rarely needed
619
but can be useful when adding the same logical file into two
620
branches that will be merged later (without showing the two different
621
adds as a conflict). It is also useful when merging another project
622
into a subdirectory of this one.
624
Any files matching patterns in the ignore list will not be added
625
unless they are explicitly mentioned.
627
takes_args = ['file*']
630
help="Don't recursively add the contents of directories."),
632
help="Show what would be done, but don't actually do anything."),
634
Option('file-ids-from',
636
help='Lookup file ids from this tree.'),
638
encoding_type = 'replace'
639
_see_also = ['remove', 'ignore']
641
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
646
if file_ids_from is not None:
648
base_tree, base_path = WorkingTree.open_containing(
650
except errors.NoWorkingTree:
651
base_branch, base_path = Branch.open_containing(
653
base_tree = base_branch.basis_tree()
655
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
656
to_file=self.outf, should_print=(not is_quiet()))
658
action = bzrlib.add.AddAction(to_file=self.outf,
659
should_print=(not is_quiet()))
662
base_tree.lock_read()
664
tree, file_list = tree_files_for_add(file_list)
665
added, ignored = tree.smart_add(file_list, not
666
no_recurse, action=action, save=not dry_run)
668
if base_tree is not None:
672
for glob in sorted(ignored.keys()):
673
for path in ignored[glob]:
674
self.outf.write("ignored %s matching \"%s\"\n"
678
class cmd_mkdir(Command):
679
"""Create a new versioned directory.
681
This is equivalent to creating the directory and then adding it.
684
takes_args = ['dir+']
685
encoding_type = 'replace'
687
def run(self, dir_list):
690
wt, dd = WorkingTree.open_containing(d)
692
self.outf.write('added %s\n' % d)
695
class cmd_relpath(Command):
696
"""Show path of a file relative to root"""
698
takes_args = ['filename']
702
def run(self, filename):
703
# TODO: jam 20050106 Can relpath return a munged path if
704
# sys.stdout encoding cannot represent it?
705
tree, relpath = WorkingTree.open_containing(filename)
706
self.outf.write(relpath)
707
self.outf.write('\n')
710
class cmd_inventory(Command):
711
"""Show inventory of the current working copy or a revision.
713
It is possible to limit the output to a particular entry
714
type using the --kind option. For example: --kind file.
716
It is also possible to restrict the list of files to a specific
717
set. For example: bzr inventory --show-ids this/file
726
help='List entries of a particular kind: file, directory, symlink.',
729
takes_args = ['file*']
732
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
733
if kind and kind not in ['file', 'directory', 'symlink']:
734
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
736
revision = _get_one_revision('inventory', revision)
737
work_tree, file_list = tree_files(file_list)
738
work_tree.lock_read()
740
if revision is not None:
741
tree = revision.as_tree(work_tree.branch)
743
extra_trees = [work_tree]
749
if file_list is not None:
750
file_ids = tree.paths2ids(file_list, trees=extra_trees,
751
require_versioned=True)
752
# find_ids_across_trees may include some paths that don't
754
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
755
for file_id in file_ids if file_id in tree)
757
entries = tree.inventory.entries()
760
if tree is not work_tree:
763
for path, entry in entries:
764
if kind and kind != entry.kind:
767
self.outf.write('%-50s %s\n' % (path, entry.file_id))
769
self.outf.write(path)
770
self.outf.write('\n')
773
class cmd_mv(Command):
774
"""Move or rename a file.
777
bzr mv OLDNAME NEWNAME
779
bzr mv SOURCE... DESTINATION
781
If the last argument is a versioned directory, all the other names
782
are moved into it. Otherwise, there must be exactly two arguments
783
and the file is changed to a new name.
785
If OLDNAME does not exist on the filesystem but is versioned and
786
NEWNAME does exist on the filesystem but is not versioned, mv
787
assumes that the file has been manually moved and only updates
788
its internal inventory to reflect that change.
789
The same is valid when moving many SOURCE files to a DESTINATION.
791
Files cannot be moved between branches.
794
takes_args = ['names*']
795
takes_options = [Option("after", help="Move only the bzr identifier"
796
" of the file, because the file has already been moved."),
797
Option('auto', help='Automatically guess renames.'),
798
Option('dry-run', help='Avoid making changes when guessing renames.'),
800
aliases = ['move', 'rename']
801
encoding_type = 'replace'
803
def run(self, names_list, after=False, auto=False, dry_run=False):
805
return self.run_auto(names_list, after, dry_run)
807
raise errors.BzrCommandError('--dry-run requires --auto.')
808
if names_list is None:
810
if len(names_list) < 2:
811
raise errors.BzrCommandError("missing file argument")
812
tree, rel_names = tree_files(names_list, canonicalize=False)
813
tree.lock_tree_write()
815
self._run(tree, names_list, rel_names, after)
819
def run_auto(self, names_list, after, dry_run):
820
if names_list is not None and len(names_list) > 1:
821
raise errors.BzrCommandError('Only one path may be specified to'
824
raise errors.BzrCommandError('--after cannot be specified with'
826
work_tree, file_list = tree_files(names_list, default_branch='.')
827
work_tree.lock_tree_write()
829
rename_map.RenameMap.guess_renames(work_tree, dry_run)
833
def _run(self, tree, names_list, rel_names, after):
834
into_existing = osutils.isdir(names_list[-1])
835
if into_existing and len(names_list) == 2:
837
# a. case-insensitive filesystem and change case of dir
838
# b. move directory after the fact (if the source used to be
839
# a directory, but now doesn't exist in the working tree
840
# and the target is an existing directory, just rename it)
841
if (not tree.case_sensitive
842
and rel_names[0].lower() == rel_names[1].lower()):
843
into_existing = False
846
# 'fix' the case of a potential 'from'
847
from_id = tree.path2id(
848
tree.get_canonical_inventory_path(rel_names[0]))
849
if (not osutils.lexists(names_list[0]) and
850
from_id and inv.get_file_kind(from_id) == "directory"):
851
into_existing = False
854
# move into existing directory
855
# All entries reference existing inventory items, so fix them up
856
# for cicp file-systems.
857
rel_names = tree.get_canonical_inventory_paths(rel_names)
858
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
860
self.outf.write("%s => %s\n" % (src, dest))
862
if len(names_list) != 2:
863
raise errors.BzrCommandError('to mv multiple files the'
864
' destination must be a versioned'
867
# for cicp file-systems: the src references an existing inventory
869
src = tree.get_canonical_inventory_path(rel_names[0])
870
# Find the canonical version of the destination: In all cases, the
871
# parent of the target must be in the inventory, so we fetch the
872
# canonical version from there (we do not always *use* the
873
# canonicalized tail portion - we may be attempting to rename the
875
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
876
dest_parent = osutils.dirname(canon_dest)
877
spec_tail = osutils.basename(rel_names[1])
878
# For a CICP file-system, we need to avoid creating 2 inventory
879
# entries that differ only by case. So regardless of the case
880
# we *want* to use (ie, specified by the user or the file-system),
881
# we must always choose to use the case of any existing inventory
882
# items. The only exception to this is when we are attempting a
883
# case-only rename (ie, canonical versions of src and dest are
885
dest_id = tree.path2id(canon_dest)
886
if dest_id is None or tree.path2id(src) == dest_id:
887
# No existing item we care about, so work out what case we
888
# are actually going to use.
890
# If 'after' is specified, the tail must refer to a file on disk.
892
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
894
# pathjoin with an empty tail adds a slash, which breaks
896
dest_parent_fq = tree.basedir
898
dest_tail = osutils.canonical_relpath(
900
osutils.pathjoin(dest_parent_fq, spec_tail))
902
# not 'after', so case as specified is used
903
dest_tail = spec_tail
905
# Use the existing item so 'mv' fails with AlreadyVersioned.
906
dest_tail = os.path.basename(canon_dest)
907
dest = osutils.pathjoin(dest_parent, dest_tail)
908
mutter("attempting to move %s => %s", src, dest)
909
tree.rename_one(src, dest, after=after)
911
self.outf.write("%s => %s\n" % (src, dest))
914
class cmd_pull(Command):
915
"""Turn this branch into a mirror of another branch.
917
By default, this command only works on branches that have not diverged.
918
Branches are considered diverged if the destination branch's most recent
919
commit is one that has not been merged (directly or indirectly) into the
922
If branches have diverged, you can use 'bzr merge' to integrate the changes
923
from one into the other. Once one branch has merged, the other should
924
be able to pull it again.
926
If you want to replace your local changes and just want your branch to
927
match the remote one, use pull --overwrite. This will work even if the two
928
branches have diverged.
930
If there is no default location set, the first pull will set it. After
931
that, you can omit the location to use the default. To change the
932
default, use --remember. The value will only be saved if the remote
933
location can be accessed.
935
Note: The location can be specified either in the form of a branch,
936
or in the form of a path to a file containing a merge directive generated
940
_see_also = ['push', 'update', 'status-flags', 'send']
941
takes_options = ['remember', 'overwrite', 'revision',
942
custom_help('verbose',
943
help='Show logs of pulled revisions.'),
945
help='Branch to pull into, '
946
'rather than the one containing the working directory.',
951
help="Perform a local pull in a bound "
952
"branch. Local pulls are not applied to "
956
takes_args = ['location?']
957
encoding_type = 'replace'
959
def run(self, location=None, remember=False, overwrite=False,
960
revision=None, verbose=False,
961
directory=None, local=False):
962
# FIXME: too much stuff is in the command class
965
if directory is None:
968
tree_to = WorkingTree.open_containing(directory)[0]
969
branch_to = tree_to.branch
970
except errors.NoWorkingTree:
972
branch_to = Branch.open_containing(directory)[0]
974
if local and not branch_to.get_bound_location():
975
raise errors.LocalRequiresBoundBranch()
977
possible_transports = []
978
if location is not None:
980
mergeable = bundle.read_mergeable_from_url(location,
981
possible_transports=possible_transports)
982
except errors.NotABundle:
985
stored_loc = branch_to.get_parent()
987
if stored_loc is None:
988
raise errors.BzrCommandError("No pull location known or"
991
display_url = urlutils.unescape_for_display(stored_loc,
994
self.outf.write("Using saved parent location: %s\n" % display_url)
995
location = stored_loc
997
revision = _get_one_revision('pull', revision)
998
if mergeable is not None:
999
if revision is not None:
1000
raise errors.BzrCommandError(
1001
'Cannot use -r with merge directives or bundles')
1002
mergeable.install_revisions(branch_to.repository)
1003
base_revision_id, revision_id, verified = \
1004
mergeable.get_merge_request(branch_to.repository)
1005
branch_from = branch_to
1007
branch_from = Branch.open(location,
1008
possible_transports=possible_transports)
1010
if branch_to.get_parent() is None or remember:
1011
branch_to.set_parent(branch_from.base)
1013
if branch_from is not branch_to:
1014
branch_from.lock_read()
1016
if revision is not None:
1017
revision_id = revision.as_revision_id(branch_from)
1019
branch_to.lock_write()
1021
if tree_to is not None:
1022
view_info = _get_view_info_for_change_reporter(tree_to)
1023
change_reporter = delta._ChangeReporter(
1024
unversioned_filter=tree_to.is_ignored,
1025
view_info=view_info)
1026
result = tree_to.pull(
1027
branch_from, overwrite, revision_id, change_reporter,
1028
possible_transports=possible_transports, local=local)
1030
result = branch_to.pull(
1031
branch_from, overwrite, revision_id, local=local)
1033
result.report(self.outf)
1034
if verbose and result.old_revid != result.new_revid:
1035
log.show_branch_change(
1036
branch_to, self.outf, result.old_revno,
1041
if branch_from is not branch_to:
1042
branch_from.unlock()
1045
class cmd_push(Command):
1046
"""Update a mirror of this branch.
1048
The target branch will not have its working tree populated because this
1049
is both expensive, and is not supported on remote file systems.
1051
Some smart servers or protocols *may* put the working tree in place in
1054
This command only works on branches that have not diverged. Branches are
1055
considered diverged if the destination branch's most recent commit is one
1056
that has not been merged (directly or indirectly) by the source branch.
1058
If branches have diverged, you can use 'bzr push --overwrite' to replace
1059
the other branch completely, discarding its unmerged changes.
1061
If you want to ensure you have the different changes in the other branch,
1062
do a merge (see bzr help merge) from the other branch, and commit that.
1063
After that you will be able to do a push without '--overwrite'.
1065
If there is no default push location set, the first push will set it.
1066
After that, you can omit the location to use the default. To change the
1067
default, use --remember. The value will only be saved if the remote
1068
location can be accessed.
1071
_see_also = ['pull', 'update', 'working-trees']
1072
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1073
Option('create-prefix',
1074
help='Create the path leading up to the branch '
1075
'if it does not already exist.'),
1077
help='Branch to push from, '
1078
'rather than the one containing the working directory.',
1082
Option('use-existing-dir',
1083
help='By default push will fail if the target'
1084
' directory exists, but does not already'
1085
' have a control directory. This flag will'
1086
' allow push to proceed.'),
1088
help='Create a stacked branch that references the public location '
1089
'of the parent branch.'),
1090
Option('stacked-on',
1091
help='Create a stacked branch that refers to another branch '
1092
'for the commit history. Only the work not present in the '
1093
'referenced branch is included in the branch created.',
1096
help='Refuse to push if there are uncommitted changes in'
1097
' the working tree, --no-strict disables the check.'),
1099
takes_args = ['location?']
1100
encoding_type = 'replace'
1102
def run(self, location=None, remember=False, overwrite=False,
1103
create_prefix=False, verbose=False, revision=None,
1104
use_existing_dir=False, directory=None, stacked_on=None,
1105
stacked=False, strict=None):
1106
from bzrlib.push import _show_push_branch
1108
if directory is None:
1110
# Get the source branch
1112
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1114
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1115
if strict is None: strict = True # default value
1116
# Get the tip's revision_id
1117
revision = _get_one_revision('push', revision)
1118
if revision is not None:
1119
revision_id = revision.in_history(br_from).rev_id
1122
if strict and tree is not None and revision_id is None:
1123
if (tree.has_changes()):
1124
raise errors.UncommittedChanges(
1125
tree, more='Use --no-strict to force the push.')
1126
if tree.last_revision() != tree.branch.last_revision():
1127
# The tree has lost sync with its branch, there is little
1128
# chance that the user is aware of it but he can still force
1129
# the push with --no-strict
1130
raise errors.OutOfDateTree(
1131
tree, more='Use --no-strict to force the push.')
1133
# Get the stacked_on branch, if any
1134
if stacked_on is not None:
1135
stacked_on = urlutils.normalize_url(stacked_on)
1137
parent_url = br_from.get_parent()
1139
parent = Branch.open(parent_url)
1140
stacked_on = parent.get_public_branch()
1142
# I considered excluding non-http url's here, thus forcing
1143
# 'public' branches only, but that only works for some
1144
# users, so it's best to just depend on the user spotting an
1145
# error by the feedback given to them. RBC 20080227.
1146
stacked_on = parent_url
1148
raise errors.BzrCommandError(
1149
"Could not determine branch to refer to.")
1151
# Get the destination location
1152
if location is None:
1153
stored_loc = br_from.get_push_location()
1154
if stored_loc is None:
1155
raise errors.BzrCommandError(
1156
"No push location known or specified.")
1158
display_url = urlutils.unescape_for_display(stored_loc,
1160
self.outf.write("Using saved push location: %s\n" % display_url)
1161
location = stored_loc
1163
_show_push_branch(br_from, revision_id, location, self.outf,
1164
verbose=verbose, overwrite=overwrite, remember=remember,
1165
stacked_on=stacked_on, create_prefix=create_prefix,
1166
use_existing_dir=use_existing_dir)
1169
class cmd_branch(Command):
1170
"""Create a new branch that is a copy of an existing branch.
1172
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1173
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1174
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1175
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1176
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1179
To retrieve the branch as of a particular revision, supply the --revision
1180
parameter, as in "branch foo/bar -r 5".
1183
_see_also = ['checkout']
1184
takes_args = ['from_location', 'to_location?']
1185
takes_options = ['revision', Option('hardlink',
1186
help='Hard-link working tree files where possible.'),
1188
help="Create a branch without a working-tree."),
1190
help="Switch the checkout in the current directory "
1191
"to the new branch."),
1193
help='Create a stacked branch referring to the source branch. '
1194
'The new branch will depend on the availability of the source '
1195
'branch for all operations.'),
1196
Option('standalone',
1197
help='Do not use a shared repository, even if available.'),
1198
Option('use-existing-dir',
1199
help='By default branch will fail if the target'
1200
' directory exists, but does not already'
1201
' have a control directory. This flag will'
1202
' allow branch to proceed.'),
1204
aliases = ['get', 'clone']
1206
def run(self, from_location, to_location=None, revision=None,
1207
hardlink=False, stacked=False, standalone=False, no_tree=False,
1208
use_existing_dir=False, switch=False):
1209
from bzrlib import switch as _mod_switch
1210
from bzrlib.tag import _merge_tags_if_possible
1211
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1213
revision = _get_one_revision('branch', revision)
1216
if revision is not None:
1217
revision_id = revision.as_revision_id(br_from)
1219
# FIXME - wt.last_revision, fallback to branch, fall back to
1220
# None or perhaps NULL_REVISION to mean copy nothing
1222
revision_id = br_from.last_revision()
1223
if to_location is None:
1224
to_location = urlutils.derive_to_location(from_location)
1225
to_transport = transport.get_transport(to_location)
1227
to_transport.mkdir('.')
1228
except errors.FileExists:
1229
if not use_existing_dir:
1230
raise errors.BzrCommandError('Target directory "%s" '
1231
'already exists.' % to_location)
1234
bzrdir.BzrDir.open_from_transport(to_transport)
1235
except errors.NotBranchError:
1238
raise errors.AlreadyBranchError(to_location)
1239
except errors.NoSuchFile:
1240
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1243
# preserve whatever source format we have.
1244
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1245
possible_transports=[to_transport],
1246
accelerator_tree=accelerator_tree,
1247
hardlink=hardlink, stacked=stacked,
1248
force_new_repo=standalone,
1249
create_tree_if_local=not no_tree,
1250
source_branch=br_from)
1251
branch = dir.open_branch()
1252
except errors.NoSuchRevision:
1253
to_transport.delete_tree('.')
1254
msg = "The branch %s has no revision %s." % (from_location,
1256
raise errors.BzrCommandError(msg)
1257
_merge_tags_if_possible(br_from, branch)
1258
# If the source branch is stacked, the new branch may
1259
# be stacked whether we asked for that explicitly or not.
1260
# We therefore need a try/except here and not just 'if stacked:'
1262
note('Created new stacked branch referring to %s.' %
1263
branch.get_stacked_on_url())
1264
except (errors.NotStacked, errors.UnstackableBranchFormat,
1265
errors.UnstackableRepositoryFormat), e:
1266
note('Branched %d revision(s).' % branch.revno())
1268
# Switch to the new branch
1269
wt, _ = WorkingTree.open_containing('.')
1270
_mod_switch.switch(wt.bzrdir, branch)
1271
note('Switched to branch: %s',
1272
urlutils.unescape_for_display(branch.base, 'utf-8'))
1277
class cmd_checkout(Command):
1278
"""Create a new checkout of an existing branch.
1280
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1281
the branch found in '.'. This is useful if you have removed the working tree
1282
or if it was never created - i.e. if you pushed the branch to its current
1283
location using SFTP.
1285
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1286
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1287
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1288
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1289
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1292
To retrieve the branch as of a particular revision, supply the --revision
1293
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1294
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1298
_see_also = ['checkouts', 'branch']
1299
takes_args = ['branch_location?', 'to_location?']
1300
takes_options = ['revision',
1301
Option('lightweight',
1302
help="Perform a lightweight checkout. Lightweight "
1303
"checkouts depend on access to the branch for "
1304
"every operation. Normal checkouts can perform "
1305
"common operations like diff and status without "
1306
"such access, and also support local commits."
1308
Option('files-from', type=str,
1309
help="Get file contents from this tree."),
1311
help='Hard-link working tree files where possible.'
1316
def run(self, branch_location=None, to_location=None, revision=None,
1317
lightweight=False, files_from=None, hardlink=False):
1318
if branch_location is None:
1319
branch_location = osutils.getcwd()
1320
to_location = branch_location
1321
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1323
revision = _get_one_revision('checkout', revision)
1324
if files_from is not None:
1325
accelerator_tree = WorkingTree.open(files_from)
1326
if revision is not None:
1327
revision_id = revision.as_revision_id(source)
1330
if to_location is None:
1331
to_location = urlutils.derive_to_location(branch_location)
1332
# if the source and to_location are the same,
1333
# and there is no working tree,
1334
# then reconstitute a branch
1335
if (osutils.abspath(to_location) ==
1336
osutils.abspath(branch_location)):
1338
source.bzrdir.open_workingtree()
1339
except errors.NoWorkingTree:
1340
source.bzrdir.create_workingtree(revision_id)
1342
source.create_checkout(to_location, revision_id, lightweight,
1343
accelerator_tree, hardlink)
1346
class cmd_renames(Command):
1347
"""Show list of renamed files.
1349
# TODO: Option to show renames between two historical versions.
1351
# TODO: Only show renames under dir, rather than in the whole branch.
1352
_see_also = ['status']
1353
takes_args = ['dir?']
1356
def run(self, dir=u'.'):
1357
tree = WorkingTree.open_containing(dir)[0]
1360
new_inv = tree.inventory
1361
old_tree = tree.basis_tree()
1362
old_tree.lock_read()
1364
old_inv = old_tree.inventory
1366
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1367
for f, paths, c, v, p, n, k, e in iterator:
1368
if paths[0] == paths[1]:
1372
renames.append(paths)
1374
for old_name, new_name in renames:
1375
self.outf.write("%s => %s\n" % (old_name, new_name))
1382
class cmd_update(Command):
1383
"""Update a tree to have the latest code committed to its branch.
1385
This will perform a merge into the working tree, and may generate
1386
conflicts. If you have any local changes, you will still
1387
need to commit them after the update for the update to be complete.
1389
If you want to discard your local changes, you can just do a
1390
'bzr revert' instead of 'bzr commit' after the update.
1393
_see_also = ['pull', 'working-trees', 'status-flags']
1394
takes_args = ['dir?']
1397
def run(self, dir='.'):
1398
tree = WorkingTree.open_containing(dir)[0]
1399
possible_transports = []
1400
master = tree.branch.get_master_branch(
1401
possible_transports=possible_transports)
1402
if master is not None:
1404
branch_location = master.base
1406
tree.lock_tree_write()
1407
branch_location = tree.branch.base
1408
# get rid of the final '/' and be ready for display
1409
branch_location = urlutils.unescape_for_display(branch_location[:-1],
1412
existing_pending_merges = tree.get_parent_ids()[1:]
1413
last_rev = _mod_revision.ensure_null(tree.last_revision())
1414
if last_rev == _mod_revision.ensure_null(
1415
tree.branch.last_revision()):
1416
# may be up to date, check master too.
1417
if master is None or last_rev == _mod_revision.ensure_null(
1418
master.last_revision()):
1419
revno = tree.branch.revision_id_to_revno(last_rev)
1420
note('Tree is up to date at revision %d of branch %s'
1421
% (revno, branch_location))
1423
view_info = _get_view_info_for_change_reporter(tree)
1424
conflicts = tree.update(
1425
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1426
view_info=view_info), possible_transports=possible_transports)
1427
revno = tree.branch.revision_id_to_revno(
1428
_mod_revision.ensure_null(tree.last_revision()))
1429
note('Updated to revision %d of branch %s' %
1430
(revno, branch_location))
1431
if tree.get_parent_ids()[1:] != existing_pending_merges:
1432
note('Your local commits will now show as pending merges with '
1433
"'bzr status', and can be committed with 'bzr commit'.")
1442
class cmd_info(Command):
1443
"""Show information about a working tree, branch or repository.
1445
This command will show all known locations and formats associated to the
1446
tree, branch or repository.
1448
In verbose mode, statistical information is included with each report.
1449
To see extended statistic information, use a verbosity level of 2 or
1450
higher by specifying the verbose option multiple times, e.g. -vv.
1452
Branches and working trees will also report any missing revisions.
1456
Display information on the format and related locations:
1460
Display the above together with extended format information and
1461
basic statistics (like the number of files in the working tree and
1462
number of revisions in the branch and repository):
1466
Display the above together with number of committers to the branch:
1470
_see_also = ['revno', 'working-trees', 'repositories']
1471
takes_args = ['location?']
1472
takes_options = ['verbose']
1473
encoding_type = 'replace'
1476
def run(self, location=None, verbose=False):
1478
noise_level = get_verbosity_level()
1481
from bzrlib.info import show_bzrdir_info
1482
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1483
verbose=noise_level, outfile=self.outf)
1486
class cmd_remove(Command):
1487
"""Remove files or directories.
1489
This makes bzr stop tracking changes to the specified files. bzr will delete
1490
them if they can easily be recovered using revert. If no options or
1491
parameters are given bzr will scan for files that are being tracked by bzr
1492
but missing in your tree and stop tracking them for you.
1494
takes_args = ['file*']
1495
takes_options = ['verbose',
1496
Option('new', help='Only remove files that have never been committed.'),
1497
RegistryOption.from_kwargs('file-deletion-strategy',
1498
'The file deletion mode to be used.',
1499
title='Deletion Strategy', value_switches=True, enum_switch=False,
1500
safe='Only delete files if they can be'
1501
' safely recovered (default).',
1502
keep='Delete from bzr but leave the working copy.',
1503
force='Delete all the specified files, even if they can not be '
1504
'recovered and even if they are non-empty directories.')]
1505
aliases = ['rm', 'del']
1506
encoding_type = 'replace'
1508
def run(self, file_list, verbose=False, new=False,
1509
file_deletion_strategy='safe'):
1510
tree, file_list = tree_files(file_list)
1512
if file_list is not None:
1513
file_list = [f for f in file_list]
1517
# Heuristics should probably all move into tree.remove_smart or
1520
added = tree.changes_from(tree.basis_tree(),
1521
specific_files=file_list).added
1522
file_list = sorted([f[0] for f in added], reverse=True)
1523
if len(file_list) == 0:
1524
raise errors.BzrCommandError('No matching files.')
1525
elif file_list is None:
1526
# missing files show up in iter_changes(basis) as
1527
# versioned-with-no-kind.
1529
for change in tree.iter_changes(tree.basis_tree()):
1530
# Find paths in the working tree that have no kind:
1531
if change[1][1] is not None and change[6][1] is None:
1532
missing.append(change[1][1])
1533
file_list = sorted(missing, reverse=True)
1534
file_deletion_strategy = 'keep'
1535
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1536
keep_files=file_deletion_strategy=='keep',
1537
force=file_deletion_strategy=='force')
1542
class cmd_file_id(Command):
1543
"""Print file_id of a particular file or directory.
1545
The file_id is assigned when the file is first added and remains the
1546
same through all revisions where the file exists, even when it is
1551
_see_also = ['inventory', 'ls']
1552
takes_args = ['filename']
1555
def run(self, filename):
1556
tree, relpath = WorkingTree.open_containing(filename)
1557
i = tree.path2id(relpath)
1559
raise errors.NotVersionedError(filename)
1561
self.outf.write(i + '\n')
1564
class cmd_file_path(Command):
1565
"""Print path of file_ids to a file or directory.
1567
This prints one line for each directory down to the target,
1568
starting at the branch root.
1572
takes_args = ['filename']
1575
def run(self, filename):
1576
tree, relpath = WorkingTree.open_containing(filename)
1577
fid = tree.path2id(relpath)
1579
raise errors.NotVersionedError(filename)
1580
segments = osutils.splitpath(relpath)
1581
for pos in range(1, len(segments) + 1):
1582
path = osutils.joinpath(segments[:pos])
1583
self.outf.write("%s\n" % tree.path2id(path))
1586
class cmd_reconcile(Command):
1587
"""Reconcile bzr metadata in a branch.
1589
This can correct data mismatches that may have been caused by
1590
previous ghost operations or bzr upgrades. You should only
1591
need to run this command if 'bzr check' or a bzr developer
1592
advises you to run it.
1594
If a second branch is provided, cross-branch reconciliation is
1595
also attempted, which will check that data like the tree root
1596
id which was not present in very early bzr versions is represented
1597
correctly in both branches.
1599
At the same time it is run it may recompress data resulting in
1600
a potential saving in disk space or performance gain.
1602
The branch *MUST* be on a listable system such as local disk or sftp.
1605
_see_also = ['check']
1606
takes_args = ['branch?']
1608
def run(self, branch="."):
1609
from bzrlib.reconcile import reconcile
1610
dir = bzrdir.BzrDir.open(branch)
1614
class cmd_revision_history(Command):
1615
"""Display the list of revision ids on a branch."""
1618
takes_args = ['location?']
1623
def run(self, location="."):
1624
branch = Branch.open_containing(location)[0]
1625
for revid in branch.revision_history():
1626
self.outf.write(revid)
1627
self.outf.write('\n')
1630
class cmd_ancestry(Command):
1631
"""List all revisions merged into this branch."""
1633
_see_also = ['log', 'revision-history']
1634
takes_args = ['location?']
1639
def run(self, location="."):
1641
wt = WorkingTree.open_containing(location)[0]
1642
except errors.NoWorkingTree:
1643
b = Branch.open(location)
1644
last_revision = b.last_revision()
1647
last_revision = wt.last_revision()
1649
revision_ids = b.repository.get_ancestry(last_revision)
1651
for revision_id in revision_ids:
1652
self.outf.write(revision_id + '\n')
1655
class cmd_init(Command):
1656
"""Make a directory into a versioned branch.
1658
Use this to create an empty branch, or before importing an
1661
If there is a repository in a parent directory of the location, then
1662
the history of the branch will be stored in the repository. Otherwise
1663
init creates a standalone branch which carries its own history
1664
in the .bzr directory.
1666
If there is already a branch at the location but it has no working tree,
1667
the tree can be populated with 'bzr checkout'.
1669
Recipe for importing a tree of files::
1675
bzr commit -m "imported project"
1678
_see_also = ['init-repository', 'branch', 'checkout']
1679
takes_args = ['location?']
1681
Option('create-prefix',
1682
help='Create the path leading up to the branch '
1683
'if it does not already exist.'),
1684
RegistryOption('format',
1685
help='Specify a format for this branch. '
1686
'See "help formats".',
1687
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1688
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1689
value_switches=True,
1690
title="Branch format",
1692
Option('append-revisions-only',
1693
help='Never change revnos or the existing log.'
1694
' Append revisions to it only.')
1696
def run(self, location=None, format=None, append_revisions_only=False,
1697
create_prefix=False):
1699
format = bzrdir.format_registry.make_bzrdir('default')
1700
if location is None:
1703
to_transport = transport.get_transport(location)
1705
# The path has to exist to initialize a
1706
# branch inside of it.
1707
# Just using os.mkdir, since I don't
1708
# believe that we want to create a bunch of
1709
# locations if the user supplies an extended path
1711
to_transport.ensure_base()
1712
except errors.NoSuchFile:
1713
if not create_prefix:
1714
raise errors.BzrCommandError("Parent directory of %s"
1716
"\nYou may supply --create-prefix to create all"
1717
" leading parent directories."
1719
to_transport.create_prefix()
1722
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1723
except errors.NotBranchError:
1724
# really a NotBzrDir error...
1725
create_branch = bzrdir.BzrDir.create_branch_convenience
1726
branch = create_branch(to_transport.base, format=format,
1727
possible_transports=[to_transport])
1728
a_bzrdir = branch.bzrdir
1730
from bzrlib.transport.local import LocalTransport
1731
if a_bzrdir.has_branch():
1732
if (isinstance(to_transport, LocalTransport)
1733
and not a_bzrdir.has_workingtree()):
1734
raise errors.BranchExistsWithoutWorkingTree(location)
1735
raise errors.AlreadyBranchError(location)
1736
branch = a_bzrdir.create_branch()
1737
a_bzrdir.create_workingtree()
1738
if append_revisions_only:
1740
branch.set_append_revisions_only(True)
1741
except errors.UpgradeRequired:
1742
raise errors.BzrCommandError('This branch format cannot be set'
1743
' to append-revisions-only. Try --default.')
1745
from bzrlib.info import describe_layout, describe_format
1747
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1748
except (errors.NoWorkingTree, errors.NotLocalUrl):
1750
repository = branch.repository
1751
layout = describe_layout(repository, branch, tree).lower()
1752
format = describe_format(a_bzrdir, repository, branch, tree)
1753
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1754
if repository.is_shared():
1755
#XXX: maybe this can be refactored into transport.path_or_url()
1756
url = repository.bzrdir.root_transport.external_url()
1758
url = urlutils.local_path_from_url(url)
1759
except errors.InvalidURL:
1761
self.outf.write("Using shared repository: %s\n" % url)
1764
class cmd_init_repository(Command):
1765
"""Create a shared repository for branches to share storage space.
1767
New branches created under the repository directory will store their
1768
revisions in the repository, not in the branch directory. For branches
1769
with shared history, this reduces the amount of storage needed and
1770
speeds up the creation of new branches.
1772
If the --no-trees option is given then the branches in the repository
1773
will not have working trees by default. They will still exist as
1774
directories on disk, but they will not have separate copies of the
1775
files at a certain revision. This can be useful for repositories that
1776
store branches which are interacted with through checkouts or remote
1777
branches, such as on a server.
1780
Create a shared repository holding just branches::
1782
bzr init-repo --no-trees repo
1785
Make a lightweight checkout elsewhere::
1787
bzr checkout --lightweight repo/trunk trunk-checkout
1792
_see_also = ['init', 'branch', 'checkout', 'repositories']
1793
takes_args = ["location"]
1794
takes_options = [RegistryOption('format',
1795
help='Specify a format for this repository. See'
1796
' "bzr help formats" for details.',
1797
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1798
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1799
value_switches=True, title='Repository format'),
1801
help='Branches in the repository will default to'
1802
' not having a working tree.'),
1804
aliases = ["init-repo"]
1806
def run(self, location, format=None, no_trees=False):
1808
format = bzrdir.format_registry.make_bzrdir('default')
1810
if location is None:
1813
to_transport = transport.get_transport(location)
1814
to_transport.ensure_base()
1816
newdir = format.initialize_on_transport(to_transport)
1817
repo = newdir.create_repository(shared=True)
1818
repo.set_make_working_trees(not no_trees)
1820
from bzrlib.info import show_bzrdir_info
1821
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1824
class cmd_diff(Command):
1825
"""Show differences in the working tree, between revisions or branches.
1827
If no arguments are given, all changes for the current tree are listed.
1828
If files are given, only the changes in those files are listed.
1829
Remote and multiple branches can be compared by using the --old and
1830
--new options. If not provided, the default for both is derived from
1831
the first argument, if any, or the current tree if no arguments are
1834
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1835
produces patches suitable for "patch -p1".
1839
2 - unrepresentable changes
1844
Shows the difference in the working tree versus the last commit::
1848
Difference between the working tree and revision 1::
1852
Difference between revision 3 and revision 1::
1856
Difference between revision 3 and revision 1 for branch xxx::
1860
To see the changes introduced in revision X::
1864
Note that in the case of a merge, the -c option shows the changes
1865
compared to the left hand parent. To see the changes against
1866
another parent, use::
1868
bzr diff -r<chosen_parent>..X
1870
The changes introduced by revision 2 (equivalent to -r1..2)::
1874
Show just the differences for file NEWS::
1878
Show the differences in working tree xxx for file NEWS::
1882
Show the differences from branch xxx to this working tree:
1886
Show the differences between two branches for file NEWS::
1888
bzr diff --old xxx --new yyy NEWS
1890
Same as 'bzr diff' but prefix paths with old/ and new/::
1892
bzr diff --prefix old/:new/
1894
_see_also = ['status']
1895
takes_args = ['file*']
1897
Option('diff-options', type=str,
1898
help='Pass these options to the external diff program.'),
1899
Option('prefix', type=str,
1901
help='Set prefixes added to old and new filenames, as '
1902
'two values separated by a colon. (eg "old/:new/").'),
1904
help='Branch/tree to compare from.',
1908
help='Branch/tree to compare to.',
1914
help='Use this command to compare files.',
1918
aliases = ['di', 'dif']
1919
encoding_type = 'exact'
1922
def run(self, revision=None, file_list=None, diff_options=None,
1923
prefix=None, old=None, new=None, using=None):
1924
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1926
if (prefix is None) or (prefix == '0'):
1934
old_label, new_label = prefix.split(":")
1936
raise errors.BzrCommandError(
1937
'--prefix expects two values separated by a colon'
1938
' (eg "old/:new/")')
1940
if revision and len(revision) > 2:
1941
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1942
' one or two revision specifiers')
1944
(old_tree, new_tree,
1945
old_branch, new_branch,
1946
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1947
file_list, revision, old, new, apply_view=True)
1948
return show_diff_trees(old_tree, new_tree, sys.stdout,
1949
specific_files=specific_files,
1950
external_diff_options=diff_options,
1951
old_label=old_label, new_label=new_label,
1952
extra_trees=extra_trees, using=using)
1955
class cmd_deleted(Command):
1956
"""List files deleted in the working tree.
1958
# TODO: Show files deleted since a previous revision, or
1959
# between two revisions.
1960
# TODO: Much more efficient way to do this: read in new
1961
# directories with readdir, rather than stating each one. Same
1962
# level of effort but possibly much less IO. (Or possibly not,
1963
# if the directories are very large...)
1964
_see_also = ['status', 'ls']
1965
takes_options = ['show-ids']
1968
def run(self, show_ids=False):
1969
tree = WorkingTree.open_containing(u'.')[0]
1972
old = tree.basis_tree()
1975
for path, ie in old.inventory.iter_entries():
1976
if not tree.has_id(ie.file_id):
1977
self.outf.write(path)
1979
self.outf.write(' ')
1980
self.outf.write(ie.file_id)
1981
self.outf.write('\n')
1988
class cmd_modified(Command):
1989
"""List files modified in working tree.
1993
_see_also = ['status', 'ls']
1996
help='Write an ascii NUL (\\0) separator '
1997
'between files rather than a newline.')
2001
def run(self, null=False):
2002
tree = WorkingTree.open_containing(u'.')[0]
2003
td = tree.changes_from(tree.basis_tree())
2004
for path, id, kind, text_modified, meta_modified in td.modified:
2006
self.outf.write(path + '\0')
2008
self.outf.write(osutils.quotefn(path) + '\n')
2011
class cmd_added(Command):
2012
"""List files added in working tree.
2016
_see_also = ['status', 'ls']
2019
help='Write an ascii NUL (\\0) separator '
2020
'between files rather than a newline.')
2024
def run(self, null=False):
2025
wt = WorkingTree.open_containing(u'.')[0]
2028
basis = wt.basis_tree()
2031
basis_inv = basis.inventory
2034
if file_id in basis_inv:
2036
if inv.is_root(file_id) and len(basis_inv) == 0:
2038
path = inv.id2path(file_id)
2039
if not os.access(osutils.abspath(path), os.F_OK):
2042
self.outf.write(path + '\0')
2044
self.outf.write(osutils.quotefn(path) + '\n')
2051
class cmd_root(Command):
2052
"""Show the tree root directory.
2054
The root is the nearest enclosing directory with a .bzr control
2057
takes_args = ['filename?']
2059
def run(self, filename=None):
2060
"""Print the branch root."""
2061
tree = WorkingTree.open_containing(filename)[0]
2062
self.outf.write(tree.basedir + '\n')
2065
def _parse_limit(limitstring):
2067
return int(limitstring)
2069
msg = "The limit argument must be an integer."
2070
raise errors.BzrCommandError(msg)
2073
def _parse_levels(s):
2077
msg = "The levels argument must be an integer."
2078
raise errors.BzrCommandError(msg)
2081
class cmd_log(Command):
2082
"""Show historical log for a branch or subset of a branch.
2084
log is bzr's default tool for exploring the history of a branch.
2085
The branch to use is taken from the first parameter. If no parameters
2086
are given, the branch containing the working directory is logged.
2087
Here are some simple examples::
2089
bzr log log the current branch
2090
bzr log foo.py log a file in its branch
2091
bzr log http://server/branch log a branch on a server
2093
The filtering, ordering and information shown for each revision can
2094
be controlled as explained below. By default, all revisions are
2095
shown sorted (topologically) so that newer revisions appear before
2096
older ones and descendants always appear before ancestors. If displayed,
2097
merged revisions are shown indented under the revision in which they
2102
The log format controls how information about each revision is
2103
displayed. The standard log formats are called ``long``, ``short``
2104
and ``line``. The default is long. See ``bzr help log-formats``
2105
for more details on log formats.
2107
The following options can be used to control what information is
2110
-l N display a maximum of N revisions
2111
-n N display N levels of revisions (0 for all, 1 for collapsed)
2112
-v display a status summary (delta) for each revision
2113
-p display a diff (patch) for each revision
2114
--show-ids display revision-ids (and file-ids), not just revnos
2116
Note that the default number of levels to display is a function of the
2117
log format. If the -n option is not used, the standard log formats show
2118
just the top level (mainline).
2120
Status summaries are shown using status flags like A, M, etc. To see
2121
the changes explained using words like ``added`` and ``modified``
2122
instead, use the -vv option.
2126
To display revisions from oldest to newest, use the --forward option.
2127
In most cases, using this option will have little impact on the total
2128
time taken to produce a log, though --forward does not incrementally
2129
display revisions like --reverse does when it can.
2131
:Revision filtering:
2133
The -r option can be used to specify what revision or range of revisions
2134
to filter against. The various forms are shown below::
2136
-rX display revision X
2137
-rX.. display revision X and later
2138
-r..Y display up to and including revision Y
2139
-rX..Y display from X to Y inclusive
2141
See ``bzr help revisionspec`` for details on how to specify X and Y.
2142
Some common examples are given below::
2144
-r-1 show just the tip
2145
-r-10.. show the last 10 mainline revisions
2146
-rsubmit:.. show what's new on this branch
2147
-rancestor:path.. show changes since the common ancestor of this
2148
branch and the one at location path
2149
-rdate:yesterday.. show changes since yesterday
2151
When logging a range of revisions using -rX..Y, log starts at
2152
revision Y and searches back in history through the primary
2153
("left-hand") parents until it finds X. When logging just the
2154
top level (using -n1), an error is reported if X is not found
2155
along the way. If multi-level logging is used (-n0), X may be
2156
a nested merge revision and the log will be truncated accordingly.
2160
If parameters are given and the first one is not a branch, the log
2161
will be filtered to show only those revisions that changed the
2162
nominated files or directories.
2164
Filenames are interpreted within their historical context. To log a
2165
deleted file, specify a revision range so that the file existed at
2166
the end or start of the range.
2168
Historical context is also important when interpreting pathnames of
2169
renamed files/directories. Consider the following example:
2171
* revision 1: add tutorial.txt
2172
* revision 2: modify tutorial.txt
2173
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2177
* ``bzr log guide.txt`` will log the file added in revision 1
2179
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2181
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2182
the original file in revision 2.
2184
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2185
was no file called guide.txt in revision 2.
2187
Renames are always followed by log. By design, there is no need to
2188
explicitly ask for this (and no way to stop logging a file back
2189
until it was last renamed).
2193
The --message option can be used for finding revisions that match a
2194
regular expression in a commit message.
2198
GUI tools and IDEs are often better at exploring history than command
2199
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2200
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2201
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2203
Web interfaces are often better at exploring history than command line
2204
tools, particularly for branches on servers. You may prefer Loggerhead
2205
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2207
You may find it useful to add the aliases below to ``bazaar.conf``::
2211
top = log -l10 --line
2214
``bzr tip`` will then show the latest revision while ``bzr top``
2215
will show the last 10 mainline revisions. To see the details of a
2216
particular revision X, ``bzr show -rX``.
2218
If you are interested in looking deeper into a particular merge X,
2219
use ``bzr log -n0 -rX``.
2221
``bzr log -v`` on a branch with lots of history is currently
2222
very slow. A fix for this issue is currently under development.
2223
With or without that fix, it is recommended that a revision range
2224
be given when using the -v option.
2226
bzr has a generic full-text matching plugin, bzr-search, that can be
2227
used to find revisions matching user names, commit messages, etc.
2228
Among other features, this plugin can find all revisions containing
2229
a list of words but not others.
2231
When exploring non-mainline history on large projects with deep
2232
history, the performance of log can be greatly improved by installing
2233
the historycache plugin. This plugin buffers historical information
2234
trading disk space for faster speed.
2236
takes_args = ['file*']
2237
_see_also = ['log-formats', 'revisionspec']
2240
help='Show from oldest to newest.'),
2242
custom_help('verbose',
2243
help='Show files changed in each revision.'),
2247
type=bzrlib.option._parse_revision_str,
2249
help='Show just the specified revision.'
2250
' See also "help revisionspec".'),
2254
help='Number of levels to display - 0 for all, 1 for flat.',
2256
type=_parse_levels),
2259
help='Show revisions whose message matches this '
2260
'regular expression.',
2264
help='Limit the output to the first N revisions.',
2269
help='Show changes made in each revision as a patch.'),
2270
Option('include-merges',
2271
help='Show merged revisions like --levels 0 does.'),
2273
encoding_type = 'replace'
2276
def run(self, file_list=None, timezone='original',
2287
include_merges=False):
2288
from bzrlib.log import (
2290
make_log_request_dict,
2291
_get_info_for_log_files,
2293
direction = (forward and 'forward') or 'reverse'
2298
raise errors.BzrCommandError(
2299
'--levels and --include-merges are mutually exclusive')
2301
if change is not None:
2303
raise errors.RangeInChangeOption()
2304
if revision is not None:
2305
raise errors.BzrCommandError(
2306
'--revision and --change are mutually exclusive')
2311
filter_by_dir = False
2315
# find the file ids to log and check for directory filtering
2316
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2317
revision, file_list)
2318
for relpath, file_id, kind in file_info_list:
2320
raise errors.BzrCommandError(
2321
"Path unknown at end or start of revision range: %s" %
2323
# If the relpath is the top of the tree, we log everything
2328
file_ids.append(file_id)
2329
filter_by_dir = filter_by_dir or (
2330
kind in ['directory', 'tree-reference'])
2333
# FIXME ? log the current subdir only RBC 20060203
2334
if revision is not None \
2335
and len(revision) > 0 and revision[0].get_branch():
2336
location = revision[0].get_branch()
2339
dir, relpath = bzrdir.BzrDir.open_containing(location)
2340
b = dir.open_branch()
2342
rev1, rev2 = _get_revision_range(revision, b, self.name())
2344
# Decide on the type of delta & diff filtering to use
2345
# TODO: add an --all-files option to make this configurable & consistent
2353
diff_type = 'partial'
2357
# Build the log formatter
2358
if log_format is None:
2359
log_format = log.log_formatter_registry.get_default(b)
2360
# Make a non-encoding output to include the diffs - bug 328007
2361
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2362
lf = log_format(show_ids=show_ids, to_file=self.outf,
2363
to_exact_file=unencoded_output,
2364
show_timezone=timezone,
2365
delta_format=get_verbosity_level(),
2367
show_advice=levels is None)
2369
# Choose the algorithm for doing the logging. It's annoying
2370
# having multiple code paths like this but necessary until
2371
# the underlying repository format is faster at generating
2372
# deltas or can provide everything we need from the indices.
2373
# The default algorithm - match-using-deltas - works for
2374
# multiple files and directories and is faster for small
2375
# amounts of history (200 revisions say). However, it's too
2376
# slow for logging a single file in a repository with deep
2377
# history, i.e. > 10K revisions. In the spirit of "do no
2378
# evil when adding features", we continue to use the
2379
# original algorithm - per-file-graph - for the "single
2380
# file that isn't a directory without showing a delta" case.
2381
partial_history = revision and b.repository._format.supports_chks
2382
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2383
or delta_type or partial_history)
2385
# Build the LogRequest and execute it
2386
if len(file_ids) == 0:
2388
rqst = make_log_request_dict(
2389
direction=direction, specific_fileids=file_ids,
2390
start_revision=rev1, end_revision=rev2, limit=limit,
2391
message_search=message, delta_type=delta_type,
2392
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2393
Logger(b, rqst).show(lf)
2399
def _get_revision_range(revisionspec_list, branch, command_name):
2400
"""Take the input of a revision option and turn it into a revision range.
2402
It returns RevisionInfo objects which can be used to obtain the rev_id's
2403
of the desired revisions. It does some user input validations.
2405
if revisionspec_list is None:
2408
elif len(revisionspec_list) == 1:
2409
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2410
elif len(revisionspec_list) == 2:
2411
start_spec = revisionspec_list[0]
2412
end_spec = revisionspec_list[1]
2413
if end_spec.get_branch() != start_spec.get_branch():
2414
# b is taken from revision[0].get_branch(), and
2415
# show_log will use its revision_history. Having
2416
# different branches will lead to weird behaviors.
2417
raise errors.BzrCommandError(
2418
"bzr %s doesn't accept two revisions in different"
2419
" branches." % command_name)
2420
rev1 = start_spec.in_history(branch)
2421
# Avoid loading all of history when we know a missing
2422
# end of range means the last revision ...
2423
if end_spec.spec is None:
2424
last_revno, last_revision_id = branch.last_revision_info()
2425
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2427
rev2 = end_spec.in_history(branch)
2429
raise errors.BzrCommandError(
2430
'bzr %s --revision takes one or two values.' % command_name)
2434
def _revision_range_to_revid_range(revision_range):
2437
if revision_range[0] is not None:
2438
rev_id1 = revision_range[0].rev_id
2439
if revision_range[1] is not None:
2440
rev_id2 = revision_range[1].rev_id
2441
return rev_id1, rev_id2
2443
def get_log_format(long=False, short=False, line=False, default='long'):
2444
log_format = default
2448
log_format = 'short'
2454
class cmd_touching_revisions(Command):
2455
"""Return revision-ids which affected a particular file.
2457
A more user-friendly interface is "bzr log FILE".
2461
takes_args = ["filename"]
2464
def run(self, filename):
2465
tree, relpath = WorkingTree.open_containing(filename)
2466
file_id = tree.path2id(relpath)
2470
touching_revs = log.find_touching_revisions(b, file_id)
2471
for revno, revision_id, what in touching_revs:
2472
self.outf.write("%6d %s\n" % (revno, what))
2477
class cmd_ls(Command):
2478
"""List files in a tree.
2481
_see_also = ['status', 'cat']
2482
takes_args = ['path?']
2486
Option('recursive', short_name='R',
2487
help='Recurse into subdirectories.'),
2489
help='Print paths relative to the root of the branch.'),
2490
Option('unknown', help='Print unknown files.'),
2491
Option('versioned', help='Print versioned files.',
2493
Option('ignored', help='Print ignored files.'),
2495
help='Write an ascii NUL (\\0) separator '
2496
'between files rather than a newline.'),
2498
help='List entries of a particular kind: file, directory, symlink.',
2503
def run(self, revision=None, verbose=False,
2504
recursive=False, from_root=False,
2505
unknown=False, versioned=False, ignored=False,
2506
null=False, kind=None, show_ids=False, path=None):
2508
if kind and kind not in ('file', 'directory', 'symlink'):
2509
raise errors.BzrCommandError('invalid kind specified')
2511
if verbose and null:
2512
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2513
all = not (unknown or versioned or ignored)
2515
selection = {'I':ignored, '?':unknown, 'V':versioned}
2521
raise errors.BzrCommandError('cannot specify both --from-root'
2524
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2527
# Calculate the prefix to use
2531
prefix = relpath + '/'
2532
elif fs_path != '.' and not fs_path.endswith('/'):
2533
prefix = fs_path + '/'
2535
if revision is not None or tree is None:
2536
tree = _get_one_revision_tree('ls', revision, branch=branch)
2539
if isinstance(tree, WorkingTree) and tree.supports_views():
2540
view_files = tree.views.lookup_view()
2543
view_str = views.view_display_str(view_files)
2544
note("Ignoring files outside view. View is %s" % view_str)
2548
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2549
from_dir=relpath, recursive=recursive):
2550
# Apply additional masking
2551
if not all and not selection[fc]:
2553
if kind is not None and fkind != kind:
2558
fullpath = osutils.pathjoin(relpath, fp)
2561
views.check_path_in_view(tree, fullpath)
2562
except errors.FileOutsideView:
2567
fp = osutils.pathjoin(prefix, fp)
2568
kindch = entry.kind_character()
2569
outstring = fp + kindch
2570
ui.ui_factory.clear_term()
2572
outstring = '%-8s %s' % (fc, outstring)
2573
if show_ids and fid is not None:
2574
outstring = "%-50s %s" % (outstring, fid)
2575
self.outf.write(outstring + '\n')
2577
self.outf.write(fp + '\0')
2580
self.outf.write(fid)
2581
self.outf.write('\0')
2589
self.outf.write('%-50s %s\n' % (outstring, my_id))
2591
self.outf.write(outstring + '\n')
2596
class cmd_unknowns(Command):
2597
"""List unknown files.
2605
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2606
self.outf.write(osutils.quotefn(f) + '\n')
2609
class cmd_ignore(Command):
2610
"""Ignore specified files or patterns.
2612
See ``bzr help patterns`` for details on the syntax of patterns.
2614
If a .bzrignore file does not exist, the ignore command
2615
will create one and add the specified files or patterns to the newly
2616
created file. The ignore command will also automatically add the
2617
.bzrignore file to be versioned. Creating a .bzrignore file without
2618
the use of the ignore command will require an explicit add command.
2620
To remove patterns from the ignore list, edit the .bzrignore file.
2621
After adding, editing or deleting that file either indirectly by
2622
using this command or directly by using an editor, be sure to commit
2625
Note: ignore patterns containing shell wildcards must be quoted from
2629
Ignore the top level Makefile::
2631
bzr ignore ./Makefile
2633
Ignore class files in all directories::
2635
bzr ignore "*.class"
2637
Ignore .o files under the lib directory::
2639
bzr ignore "lib/**/*.o"
2641
Ignore .o files under the lib directory::
2643
bzr ignore "RE:lib/.*\.o"
2645
Ignore everything but the "debian" toplevel directory::
2647
bzr ignore "RE:(?!debian/).*"
2650
_see_also = ['status', 'ignored', 'patterns']
2651
takes_args = ['name_pattern*']
2653
Option('old-default-rules',
2654
help='Write out the ignore rules bzr < 0.9 always used.')
2657
def run(self, name_pattern_list=None, old_default_rules=None):
2658
from bzrlib import ignores
2659
if old_default_rules is not None:
2660
# dump the rules and exit
2661
for pattern in ignores.OLD_DEFAULTS:
2664
if not name_pattern_list:
2665
raise errors.BzrCommandError("ignore requires at least one "
2666
"NAME_PATTERN or --old-default-rules")
2667
name_pattern_list = [globbing.normalize_pattern(p)
2668
for p in name_pattern_list]
2669
for name_pattern in name_pattern_list:
2670
if (name_pattern[0] == '/' or
2671
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2672
raise errors.BzrCommandError(
2673
"NAME_PATTERN should not be an absolute path")
2674
tree, relpath = WorkingTree.open_containing(u'.')
2675
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2676
ignored = globbing.Globster(name_pattern_list)
2679
for entry in tree.list_files():
2683
if ignored.match(filename):
2684
matches.append(filename.encode('utf-8'))
2686
if len(matches) > 0:
2687
print "Warning: the following files are version controlled and" \
2688
" match your ignore pattern:\n%s" \
2689
"\nThese files will continue to be version controlled" \
2690
" unless you 'bzr remove' them." % ("\n".join(matches),)
2693
class cmd_ignored(Command):
2694
"""List ignored files and the patterns that matched them.
2696
List all the ignored files and the ignore pattern that caused the file to
2699
Alternatively, to list just the files::
2704
encoding_type = 'replace'
2705
_see_also = ['ignore', 'ls']
2709
tree = WorkingTree.open_containing(u'.')[0]
2712
for path, file_class, kind, file_id, entry in tree.list_files():
2713
if file_class != 'I':
2715
## XXX: Slightly inefficient since this was already calculated
2716
pat = tree.is_ignored(path)
2717
self.outf.write('%-50s %s\n' % (path, pat))
2722
class cmd_lookup_revision(Command):
2723
"""Lookup the revision-id from a revision-number
2726
bzr lookup-revision 33
2729
takes_args = ['revno']
2732
def run(self, revno):
2736
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2738
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2741
class cmd_export(Command):
2742
"""Export current or past revision to a destination directory or archive.
2744
If no revision is specified this exports the last committed revision.
2746
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2747
given, try to find the format with the extension. If no extension
2748
is found exports to a directory (equivalent to --format=dir).
2750
If root is supplied, it will be used as the root directory inside
2751
container formats (tar, zip, etc). If it is not supplied it will default
2752
to the exported filename. The root option has no effect for 'dir' format.
2754
If branch is omitted then the branch containing the current working
2755
directory will be used.
2757
Note: Export of tree with non-ASCII filenames to zip is not supported.
2759
================= =========================
2760
Supported formats Autodetected by extension
2761
================= =========================
2764
tbz2 .tar.bz2, .tbz2
2767
================= =========================
2769
takes_args = ['dest', 'branch_or_subdir?']
2772
help="Type of file to export to.",
2775
Option('filters', help='Apply content filters to export the '
2776
'convenient form.'),
2779
help="Name of the root directory inside the exported file."),
2781
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2782
root=None, filters=False):
2783
from bzrlib.export import export
2785
if branch_or_subdir is None:
2786
tree = WorkingTree.open_containing(u'.')[0]
2790
b, subdir = Branch.open_containing(branch_or_subdir)
2793
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2795
export(rev_tree, dest, format, root, subdir, filtered=filters)
2796
except errors.NoSuchExportFormat, e:
2797
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2800
class cmd_cat(Command):
2801
"""Write the contents of a file as of a given revision to standard output.
2803
If no revision is nominated, the last revision is used.
2805
Note: Take care to redirect standard output when using this command on a
2811
Option('name-from-revision', help='The path name in the old tree.'),
2812
Option('filters', help='Apply content filters to display the '
2813
'convenience form.'),
2816
takes_args = ['filename']
2817
encoding_type = 'exact'
2820
def run(self, filename, revision=None, name_from_revision=False,
2822
if revision is not None and len(revision) != 1:
2823
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2824
" one revision specifier")
2825
tree, branch, relpath = \
2826
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2829
return self._run(tree, branch, relpath, filename, revision,
2830
name_from_revision, filters)
2834
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2837
tree = b.basis_tree()
2838
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2840
old_file_id = rev_tree.path2id(relpath)
2842
if name_from_revision:
2843
# Try in revision if requested
2844
if old_file_id is None:
2845
raise errors.BzrCommandError(
2846
"%r is not present in revision %s" % (
2847
filename, rev_tree.get_revision_id()))
2849
content = rev_tree.get_file_text(old_file_id)
2851
cur_file_id = tree.path2id(relpath)
2853
if cur_file_id is not None:
2854
# Then try with the actual file id
2856
content = rev_tree.get_file_text(cur_file_id)
2858
except errors.NoSuchId:
2859
# The actual file id didn't exist at that time
2861
if not found and old_file_id is not None:
2862
# Finally try with the old file id
2863
content = rev_tree.get_file_text(old_file_id)
2866
# Can't be found anywhere
2867
raise errors.BzrCommandError(
2868
"%r is not present in revision %s" % (
2869
filename, rev_tree.get_revision_id()))
2871
from bzrlib.filters import (
2872
ContentFilterContext,
2873
filtered_output_bytes,
2875
filters = rev_tree._content_filter_stack(relpath)
2876
chunks = content.splitlines(True)
2877
content = filtered_output_bytes(chunks, filters,
2878
ContentFilterContext(relpath, rev_tree))
2879
self.outf.writelines(content)
2881
self.outf.write(content)
2884
class cmd_local_time_offset(Command):
2885
"""Show the offset in seconds from GMT to local time."""
2889
print osutils.local_time_offset()
2893
class cmd_commit(Command):
2894
"""Commit changes into a new revision.
2896
An explanatory message needs to be given for each commit. This is
2897
often done by using the --message option (getting the message from the
2898
command line) or by using the --file option (getting the message from
2899
a file). If neither of these options is given, an editor is opened for
2900
the user to enter the message. To see the changed files in the
2901
boilerplate text loaded into the editor, use the --show-diff option.
2903
By default, the entire tree is committed and the person doing the
2904
commit is assumed to be the author. These defaults can be overridden
2909
If selected files are specified, only changes to those files are
2910
committed. If a directory is specified then the directory and
2911
everything within it is committed.
2913
When excludes are given, they take precedence over selected files.
2914
For example, to commit only changes within foo, but not changes
2917
bzr commit foo -x foo/bar
2919
A selective commit after a merge is not yet supported.
2923
If the author of the change is not the same person as the committer,
2924
you can specify the author's name using the --author option. The
2925
name should be in the same format as a committer-id, e.g.
2926
"John Doe <jdoe@example.com>". If there is more than one author of
2927
the change you can specify the option multiple times, once for each
2932
A common mistake is to forget to add a new file or directory before
2933
running the commit command. The --strict option checks for unknown
2934
files and aborts the commit if any are found. More advanced pre-commit
2935
checks can be implemented by defining hooks. See ``bzr help hooks``
2940
If you accidentially commit the wrong changes or make a spelling
2941
mistake in the commit message say, you can use the uncommit command
2942
to undo it. See ``bzr help uncommit`` for details.
2944
Hooks can also be configured to run after a commit. This allows you
2945
to trigger updates to external systems like bug trackers. The --fixes
2946
option can be used to record the association between a revision and
2947
one or more bugs. See ``bzr help bugs`` for details.
2949
A selective commit may fail in some cases where the committed
2950
tree would be invalid. Consider::
2955
bzr commit foo -m "committing foo"
2956
bzr mv foo/bar foo/baz
2959
bzr commit foo/bar -m "committing bar but not baz"
2961
In the example above, the last commit will fail by design. This gives
2962
the user the opportunity to decide whether they want to commit the
2963
rename at the same time, separately first, or not at all. (As a general
2964
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2966
# TODO: Run hooks on tree to-be-committed, and after commit.
2968
# TODO: Strict commit that fails if there are deleted files.
2969
# (what does "deleted files" mean ??)
2971
# TODO: Give better message for -s, --summary, used by tla people
2973
# XXX: verbose currently does nothing
2975
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2976
takes_args = ['selected*']
2978
ListOption('exclude', type=str, short_name='x',
2979
help="Do not consider changes made to a given path."),
2980
Option('message', type=unicode,
2982
help="Description of the new revision."),
2985
help='Commit even if nothing has changed.'),
2986
Option('file', type=str,
2989
help='Take commit message from this file.'),
2991
help="Refuse to commit if there are unknown "
2992
"files in the working tree."),
2993
Option('commit-time', type=str,
2994
help="Manually set a commit time using commit date "
2995
"format, e.g. '2009-10-10 08:00:00 +0100'."),
2996
ListOption('fixes', type=str,
2997
help="Mark a bug as being fixed by this revision "
2998
"(see \"bzr help bugs\")."),
2999
ListOption('author', type=unicode,
3000
help="Set the author's name, if it's different "
3001
"from the committer."),
3003
help="Perform a local commit in a bound "
3004
"branch. Local commits are not pushed to "
3005
"the master branch until a normal commit "
3009
help='When no message is supplied, show the diff along'
3010
' with the status summary in the message editor.'),
3012
aliases = ['ci', 'checkin']
3014
def _iter_bug_fix_urls(self, fixes, branch):
3015
# Configure the properties for bug fixing attributes.
3016
for fixed_bug in fixes:
3017
tokens = fixed_bug.split(':')
3018
if len(tokens) != 2:
3019
raise errors.BzrCommandError(
3020
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3021
"See \"bzr help bugs\" for more information on this "
3022
"feature.\nCommit refused." % fixed_bug)
3023
tag, bug_id = tokens
3025
yield bugtracker.get_bug_url(tag, branch, bug_id)
3026
except errors.UnknownBugTrackerAbbreviation:
3027
raise errors.BzrCommandError(
3028
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3029
except errors.MalformedBugIdentifier, e:
3030
raise errors.BzrCommandError(
3031
"%s\nCommit refused." % (str(e),))
3033
def run(self, message=None, file=None, verbose=False, selected_list=None,
3034
unchanged=False, strict=False, local=False, fixes=None,
3035
author=None, show_diff=False, exclude=None, commit_time=None):
3036
from bzrlib.errors import (
3041
from bzrlib.msgeditor import (
3042
edit_commit_message_encoded,
3043
generate_commit_message_template,
3044
make_commit_message_template_encoded
3047
commit_stamp = offset = None
3048
if commit_time is not None:
3050
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3051
except ValueError, e:
3052
raise errors.BzrCommandError(
3053
"Could not parse --commit-time: " + str(e))
3055
# TODO: Need a blackbox test for invoking the external editor; may be
3056
# slightly problematic to run this cross-platform.
3058
# TODO: do more checks that the commit will succeed before
3059
# spending the user's valuable time typing a commit message.
3063
tree, selected_list = tree_files(selected_list)
3064
if selected_list == ['']:
3065
# workaround - commit of root of tree should be exactly the same
3066
# as just default commit in that tree, and succeed even though
3067
# selected-file merge commit is not done yet
3072
bug_property = bugtracker.encode_fixes_bug_urls(
3073
self._iter_bug_fix_urls(fixes, tree.branch))
3075
properties['bugs'] = bug_property
3077
if local and not tree.branch.get_bound_location():
3078
raise errors.LocalRequiresBoundBranch()
3080
if message is not None:
3082
file_exists = osutils.lexists(message)
3083
except UnicodeError:
3084
# The commit message contains unicode characters that can't be
3085
# represented in the filesystem encoding, so that can't be a
3090
'The commit message is a file name: "%(f)s".\n'
3091
'(use --file "%(f)s" to take commit message from that file)'
3093
ui.ui_factory.show_warning(warning_msg)
3095
def get_message(commit_obj):
3096
"""Callback to get commit message"""
3097
my_message = message
3098
if my_message is not None and '\r' in my_message:
3099
my_message = my_message.replace('\r\n', '\n')
3100
my_message = my_message.replace('\r', '\n')
3101
if my_message is None and not file:
3102
t = make_commit_message_template_encoded(tree,
3103
selected_list, diff=show_diff,
3104
output_encoding=osutils.get_user_encoding())
3105
start_message = generate_commit_message_template(commit_obj)
3106
my_message = edit_commit_message_encoded(t,
3107
start_message=start_message)
3108
if my_message is None:
3109
raise errors.BzrCommandError("please specify a commit"
3110
" message with either --message or --file")
3111
elif my_message and file:
3112
raise errors.BzrCommandError(
3113
"please specify either --message or --file")
3115
my_message = codecs.open(file, 'rt',
3116
osutils.get_user_encoding()).read()
3117
if my_message == "":
3118
raise errors.BzrCommandError("empty commit message specified")
3121
# The API permits a commit with a filter of [] to mean 'select nothing'
3122
# but the command line should not do that.
3123
if not selected_list:
3124
selected_list = None
3126
tree.commit(message_callback=get_message,
3127
specific_files=selected_list,
3128
allow_pointless=unchanged, strict=strict, local=local,
3129
reporter=None, verbose=verbose, revprops=properties,
3130
authors=author, timestamp=commit_stamp,
3132
exclude=safe_relpath_files(tree, exclude))
3133
except PointlessCommit:
3134
# FIXME: This should really happen before the file is read in;
3135
# perhaps prepare the commit; get the message; then actually commit
3136
raise errors.BzrCommandError("No changes to commit."
3137
" Use --unchanged to commit anyhow.")
3138
except ConflictsInTree:
3139
raise errors.BzrCommandError('Conflicts detected in working '
3140
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3142
except StrictCommitFailed:
3143
raise errors.BzrCommandError("Commit refused because there are"
3144
" unknown files in the working tree.")
3145
except errors.BoundBranchOutOfDate, e:
3146
raise errors.BzrCommandError(str(e) + "\n"
3147
'To commit to master branch, run update and then commit.\n'
3148
'You can also pass --local to commit to continue working '
3152
class cmd_check(Command):
3153
"""Validate working tree structure, branch consistency and repository history.
3155
This command checks various invariants about branch and repository storage
3156
to detect data corruption or bzr bugs.
3158
The working tree and branch checks will only give output if a problem is
3159
detected. The output fields of the repository check are:
3162
This is just the number of revisions checked. It doesn't
3166
This is just the number of versionedfiles checked. It
3167
doesn't indicate a problem.
3169
unreferenced ancestors
3170
Texts that are ancestors of other texts, but
3171
are not properly referenced by the revision ancestry. This is a
3172
subtle problem that Bazaar can work around.
3175
This is the total number of unique file contents
3176
seen in the checked revisions. It does not indicate a problem.
3179
This is the total number of repeated texts seen
3180
in the checked revisions. Texts can be repeated when their file
3181
entries are modified, but the file contents are not. It does not
3184
If no restrictions are specified, all Bazaar data that is found at the given
3185
location will be checked.
3189
Check the tree and branch at 'foo'::
3191
bzr check --tree --branch foo
3193
Check only the repository at 'bar'::
3195
bzr check --repo bar
3197
Check everything at 'baz'::
3202
_see_also = ['reconcile']
3203
takes_args = ['path?']
3204
takes_options = ['verbose',
3205
Option('branch', help="Check the branch related to the"
3206
" current directory."),
3207
Option('repo', help="Check the repository related to the"
3208
" current directory."),
3209
Option('tree', help="Check the working tree related to"
3210
" the current directory.")]
3212
def run(self, path=None, verbose=False, branch=False, repo=False,
3214
from bzrlib.check import check_dwim
3217
if not branch and not repo and not tree:
3218
branch = repo = tree = True
3219
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3222
class cmd_upgrade(Command):
3223
"""Upgrade branch storage to current format.
3225
The check command or bzr developers may sometimes advise you to run
3226
this command. When the default format has changed you may also be warned
3227
during other operations to upgrade.
3230
_see_also = ['check']
3231
takes_args = ['url?']
3233
RegistryOption('format',
3234
help='Upgrade to a specific format. See "bzr help'
3235
' formats" for details.',
3236
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3237
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3238
value_switches=True, title='Branch format'),
3241
def run(self, url='.', format=None):
3242
from bzrlib.upgrade import upgrade
3243
upgrade(url, format)
3246
class cmd_whoami(Command):
3247
"""Show or set bzr user id.
3250
Show the email of the current user::
3254
Set the current user::
3256
bzr whoami "Frank Chu <fchu@example.com>"
3258
takes_options = [ Option('email',
3259
help='Display email address only.'),
3261
help='Set identity for the current branch instead of '
3264
takes_args = ['name?']
3265
encoding_type = 'replace'
3268
def run(self, email=False, branch=False, name=None):
3270
# use branch if we're inside one; otherwise global config
3272
c = Branch.open_containing('.')[0].get_config()
3273
except errors.NotBranchError:
3274
c = config.GlobalConfig()
3276
self.outf.write(c.user_email() + '\n')
3278
self.outf.write(c.username() + '\n')
3281
# display a warning if an email address isn't included in the given name.
3283
config.extract_email_address(name)
3284
except errors.NoEmailInUsername, e:
3285
warning('"%s" does not seem to contain an email address. '
3286
'This is allowed, but not recommended.', name)
3288
# use global config unless --branch given
3290
c = Branch.open_containing('.')[0].get_config()
3292
c = config.GlobalConfig()
3293
c.set_user_option('email', name)
3296
class cmd_nick(Command):
3297
"""Print or set the branch nickname.
3299
If unset, the tree root directory name is used as the nickname.
3300
To print the current nickname, execute with no argument.
3302
Bound branches use the nickname of its master branch unless it is set
3306
_see_also = ['info']
3307
takes_args = ['nickname?']
3308
def run(self, nickname=None):
3309
branch = Branch.open_containing(u'.')[0]
3310
if nickname is None:
3311
self.printme(branch)
3313
branch.nick = nickname
3316
def printme(self, branch):
3320
class cmd_alias(Command):
3321
"""Set/unset and display aliases.
3324
Show the current aliases::
3328
Show the alias specified for 'll'::
3332
Set an alias for 'll'::
3334
bzr alias ll="log --line -r-10..-1"
3336
To remove an alias for 'll'::
3338
bzr alias --remove ll
3341
takes_args = ['name?']
3343
Option('remove', help='Remove the alias.'),
3346
def run(self, name=None, remove=False):
3348
self.remove_alias(name)
3350
self.print_aliases()
3352
equal_pos = name.find('=')
3354
self.print_alias(name)
3356
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3358
def remove_alias(self, alias_name):
3359
if alias_name is None:
3360
raise errors.BzrCommandError(
3361
'bzr alias --remove expects an alias to remove.')
3362
# If alias is not found, print something like:
3363
# unalias: foo: not found
3364
c = config.GlobalConfig()
3365
c.unset_alias(alias_name)
3368
def print_aliases(self):
3369
"""Print out the defined aliases in a similar format to bash."""
3370
aliases = config.GlobalConfig().get_aliases()
3371
for key, value in sorted(aliases.iteritems()):
3372
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3375
def print_alias(self, alias_name):
3376
from bzrlib.commands import get_alias
3377
alias = get_alias(alias_name)
3379
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3382
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3384
def set_alias(self, alias_name, alias_command):
3385
"""Save the alias in the global config."""
3386
c = config.GlobalConfig()
3387
c.set_alias(alias_name, alias_command)
3390
class cmd_selftest(Command):
3391
"""Run internal test suite.
3393
If arguments are given, they are regular expressions that say which tests
3394
should run. Tests matching any expression are run, and other tests are
3397
Alternatively if --first is given, matching tests are run first and then
3398
all other tests are run. This is useful if you have been working in a
3399
particular area, but want to make sure nothing else was broken.
3401
If --exclude is given, tests that match that regular expression are
3402
excluded, regardless of whether they match --first or not.
3404
To help catch accidential dependencies between tests, the --randomize
3405
option is useful. In most cases, the argument used is the word 'now'.
3406
Note that the seed used for the random number generator is displayed
3407
when this option is used. The seed can be explicitly passed as the
3408
argument to this option if required. This enables reproduction of the
3409
actual ordering used if and when an order sensitive problem is encountered.
3411
If --list-only is given, the tests that would be run are listed. This is
3412
useful when combined with --first, --exclude and/or --randomize to
3413
understand their impact. The test harness reports "Listed nn tests in ..."
3414
instead of "Ran nn tests in ..." when list mode is enabled.
3416
If the global option '--no-plugins' is given, plugins are not loaded
3417
before running the selftests. This has two effects: features provided or
3418
modified by plugins will not be tested, and tests provided by plugins will
3421
Tests that need working space on disk use a common temporary directory,
3422
typically inside $TMPDIR or /tmp.
3424
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3425
into a pdb postmortem session.
3428
Run only tests relating to 'ignore'::
3432
Disable plugins and list tests as they're run::
3434
bzr --no-plugins selftest -v
3436
# NB: this is used from the class without creating an instance, which is
3437
# why it does not have a self parameter.
3438
def get_transport_type(typestring):
3439
"""Parse and return a transport specifier."""
3440
if typestring == "sftp":
3441
from bzrlib.transport.sftp import SFTPAbsoluteServer
3442
return SFTPAbsoluteServer
3443
if typestring == "memory":
3444
from bzrlib.transport.memory import MemoryServer
3446
if typestring == "fakenfs":
3447
from bzrlib.transport.fakenfs import FakeNFSServer
3448
return FakeNFSServer
3449
msg = "No known transport type %s. Supported types are: sftp\n" %\
3451
raise errors.BzrCommandError(msg)
3454
takes_args = ['testspecs*']
3455
takes_options = ['verbose',
3457
help='Stop when one test fails.',
3461
help='Use a different transport by default '
3462
'throughout the test suite.',
3463
type=get_transport_type),
3465
help='Run the benchmarks rather than selftests.'),
3466
Option('lsprof-timed',
3467
help='Generate lsprof output for benchmarked'
3468
' sections of code.'),
3469
Option('lsprof-tests',
3470
help='Generate lsprof output for each test.'),
3471
Option('cache-dir', type=str,
3472
help='Cache intermediate benchmark output in this '
3475
help='Run all tests, but run specified tests first.',
3479
help='List the tests instead of running them.'),
3480
RegistryOption('parallel',
3481
help="Run the test suite in parallel.",
3482
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3483
value_switches=False,
3485
Option('randomize', type=str, argname="SEED",
3486
help='Randomize the order of tests using the given'
3487
' seed or "now" for the current time.'),
3488
Option('exclude', type=str, argname="PATTERN",
3490
help='Exclude tests that match this regular'
3493
help='Output test progress via subunit.'),
3494
Option('strict', help='Fail on missing dependencies or '
3496
Option('load-list', type=str, argname='TESTLISTFILE',
3497
help='Load a test id list from a text file.'),
3498
ListOption('debugflag', type=str, short_name='E',
3499
help='Turn on a selftest debug flag.'),
3500
ListOption('starting-with', type=str, argname='TESTID',
3501
param_name='starting_with', short_name='s',
3503
'Load only the tests starting with TESTID.'),
3505
encoding_type = 'replace'
3508
Command.__init__(self)
3509
self.additional_selftest_args = {}
3511
def run(self, testspecs_list=None, verbose=False, one=False,
3512
transport=None, benchmark=None,
3513
lsprof_timed=None, cache_dir=None,
3514
first=False, list_only=False,
3515
randomize=None, exclude=None, strict=False,
3516
load_list=None, debugflag=None, starting_with=None, subunit=False,
3517
parallel=None, lsprof_tests=False):
3518
from bzrlib.tests import selftest
3519
import bzrlib.benchmarks as benchmarks
3520
from bzrlib.benchmarks import tree_creator
3522
# Make deprecation warnings visible, unless -Werror is set
3523
symbol_versioning.activate_deprecation_warnings(override=False)
3525
if cache_dir is not None:
3526
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3527
if testspecs_list is not None:
3528
pattern = '|'.join(testspecs_list)
3533
from bzrlib.tests import SubUnitBzrRunner
3535
raise errors.BzrCommandError("subunit not available. subunit "
3536
"needs to be installed to use --subunit.")
3537
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3539
self.additional_selftest_args.setdefault(
3540
'suite_decorators', []).append(parallel)
3542
test_suite_factory = benchmarks.test_suite
3543
# Unless user explicitly asks for quiet, be verbose in benchmarks
3544
verbose = not is_quiet()
3545
# TODO: should possibly lock the history file...
3546
benchfile = open(".perf_history", "at", buffering=1)
3548
test_suite_factory = None
3551
selftest_kwargs = {"verbose": verbose,
3553
"stop_on_failure": one,
3554
"transport": transport,
3555
"test_suite_factory": test_suite_factory,
3556
"lsprof_timed": lsprof_timed,
3557
"lsprof_tests": lsprof_tests,
3558
"bench_history": benchfile,
3559
"matching_tests_first": first,
3560
"list_only": list_only,
3561
"random_seed": randomize,
3562
"exclude_pattern": exclude,
3564
"load_list": load_list,
3565
"debug_flags": debugflag,
3566
"starting_with": starting_with
3568
selftest_kwargs.update(self.additional_selftest_args)
3569
result = selftest(**selftest_kwargs)
3571
if benchfile is not None:
3573
return int(not result)
3576
class cmd_version(Command):
3577
"""Show version of bzr."""
3579
encoding_type = 'replace'
3581
Option("short", help="Print just the version number."),
3585
def run(self, short=False):
3586
from bzrlib.version import show_version
3588
self.outf.write(bzrlib.version_string + '\n')
3590
show_version(to_file=self.outf)
3593
class cmd_rocks(Command):
3594
"""Statement of optimism."""
3600
print "It sure does!"
3603
class cmd_find_merge_base(Command):
3604
"""Find and print a base revision for merging two branches."""
3605
# TODO: Options to specify revisions on either side, as if
3606
# merging only part of the history.
3607
takes_args = ['branch', 'other']
3611
def run(self, branch, other):
3612
from bzrlib.revision import ensure_null
3614
branch1 = Branch.open_containing(branch)[0]
3615
branch2 = Branch.open_containing(other)[0]
3620
last1 = ensure_null(branch1.last_revision())
3621
last2 = ensure_null(branch2.last_revision())
3623
graph = branch1.repository.get_graph(branch2.repository)
3624
base_rev_id = graph.find_unique_lca(last1, last2)
3626
print 'merge base is revision %s' % base_rev_id
3633
class cmd_merge(Command):
3634
"""Perform a three-way merge.
3636
The source of the merge can be specified either in the form of a branch,
3637
or in the form of a path to a file containing a merge directive generated
3638
with bzr send. If neither is specified, the default is the upstream branch
3639
or the branch most recently merged using --remember.
3641
When merging a branch, by default the tip will be merged. To pick a different
3642
revision, pass --revision. If you specify two values, the first will be used as
3643
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3644
available revisions, like this is commonly referred to as "cherrypicking".
3646
Revision numbers are always relative to the branch being merged.
3648
By default, bzr will try to merge in all new work from the other
3649
branch, automatically determining an appropriate base. If this
3650
fails, you may need to give an explicit base.
3652
Merge will do its best to combine the changes in two branches, but there
3653
are some kinds of problems only a human can fix. When it encounters those,
3654
it will mark a conflict. A conflict means that you need to fix something,
3655
before you should commit.
3657
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3659
If there is no default branch set, the first merge will set it. After
3660
that, you can omit the branch to use the default. To change the
3661
default, use --remember. The value will only be saved if the remote
3662
location can be accessed.
3664
The results of the merge are placed into the destination working
3665
directory, where they can be reviewed (with bzr diff), tested, and then
3666
committed to record the result of the merge.
3668
merge refuses to run if there are any uncommitted changes, unless
3671
To select only some changes to merge, use "merge -i", which will prompt
3672
you to apply each diff hunk and file change, similar to "shelve".
3675
To merge the latest revision from bzr.dev::
3677
bzr merge ../bzr.dev
3679
To merge changes up to and including revision 82 from bzr.dev::
3681
bzr merge -r 82 ../bzr.dev
3683
To merge the changes introduced by 82, without previous changes::
3685
bzr merge -r 81..82 ../bzr.dev
3687
To apply a merge directive contained in /tmp/merge::
3689
bzr merge /tmp/merge
3692
encoding_type = 'exact'
3693
_see_also = ['update', 'remerge', 'status-flags', 'send']
3694
takes_args = ['location?']
3699
help='Merge even if the destination tree has uncommitted changes.'),
3703
Option('show-base', help="Show base revision text in "
3705
Option('uncommitted', help='Apply uncommitted changes'
3706
' from a working copy, instead of branch changes.'),
3707
Option('pull', help='If the destination is already'
3708
' completely merged into the source, pull from the'
3709
' source rather than merging. When this happens,'
3710
' you do not need to commit the result.'),
3712
help='Branch to merge into, '
3713
'rather than the one containing the working directory.',
3717
Option('preview', help='Instead of merging, show a diff of the'
3719
Option('interactive', help='Select changes interactively.',
3723
def run(self, location=None, revision=None, force=False,
3724
merge_type=None, show_base=False, reprocess=None, remember=False,
3725
uncommitted=False, pull=False,
3730
if merge_type is None:
3731
merge_type = _mod_merge.Merge3Merger
3733
if directory is None: directory = u'.'
3734
possible_transports = []
3736
allow_pending = True
3737
verified = 'inapplicable'
3738
tree = WorkingTree.open_containing(directory)[0]
3741
basis_tree = tree.revision_tree(tree.last_revision())
3742
except errors.NoSuchRevision:
3743
basis_tree = tree.basis_tree()
3745
# die as quickly as possible if there are uncommitted changes
3747
if tree.has_changes():
3748
raise errors.UncommittedChanges(tree)
3750
view_info = _get_view_info_for_change_reporter(tree)
3751
change_reporter = delta._ChangeReporter(
3752
unversioned_filter=tree.is_ignored, view_info=view_info)
3755
pb = ui.ui_factory.nested_progress_bar()
3756
cleanups.append(pb.finished)
3758
cleanups.append(tree.unlock)
3759
if location is not None:
3761
mergeable = bundle.read_mergeable_from_url(location,
3762
possible_transports=possible_transports)
3763
except errors.NotABundle:
3767
raise errors.BzrCommandError('Cannot use --uncommitted'
3768
' with bundles or merge directives.')
3770
if revision is not None:
3771
raise errors.BzrCommandError(
3772
'Cannot use -r with merge directives or bundles')
3773
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3776
if merger is None and uncommitted:
3777
if revision is not None and len(revision) > 0:
3778
raise errors.BzrCommandError('Cannot use --uncommitted and'
3779
' --revision at the same time.')
3780
merger = self.get_merger_from_uncommitted(tree, location, pb,
3782
allow_pending = False
3785
merger, allow_pending = self._get_merger_from_branch(tree,
3786
location, revision, remember, possible_transports, pb)
3788
merger.merge_type = merge_type
3789
merger.reprocess = reprocess
3790
merger.show_base = show_base
3791
self.sanity_check_merger(merger)
3792
if (merger.base_rev_id == merger.other_rev_id and
3793
merger.other_rev_id is not None):
3794
note('Nothing to do.')
3797
if merger.interesting_files is not None:
3798
raise errors.BzrCommandError('Cannot pull individual files')
3799
if (merger.base_rev_id == tree.last_revision()):
3800
result = tree.pull(merger.other_branch, False,
3801
merger.other_rev_id)
3802
result.report(self.outf)
3804
if merger.this_basis is None:
3805
raise errors.BzrCommandError(
3806
"This branch has no commits."
3807
" (perhaps you would prefer 'bzr pull')")
3809
return self._do_preview(merger, cleanups)
3811
return self._do_interactive(merger, cleanups)
3813
return self._do_merge(merger, change_reporter, allow_pending,
3816
for cleanup in reversed(cleanups):
3819
def _get_preview(self, merger, cleanups):
3820
tree_merger = merger.make_merger()
3821
tt = tree_merger.make_preview_transform()
3822
cleanups.append(tt.finalize)
3823
result_tree = tt.get_preview_tree()
3826
def _do_preview(self, merger, cleanups):
3827
from bzrlib.diff import show_diff_trees
3828
result_tree = self._get_preview(merger, cleanups)
3829
show_diff_trees(merger.this_tree, result_tree, self.outf,
3830
old_label='', new_label='')
3832
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3833
merger.change_reporter = change_reporter
3834
conflict_count = merger.do_merge()
3836
merger.set_pending()
3837
if verified == 'failed':
3838
warning('Preview patch does not match changes')
3839
if conflict_count != 0:
3844
def _do_interactive(self, merger, cleanups):
3845
"""Perform an interactive merge.
3847
This works by generating a preview tree of the merge, then using
3848
Shelver to selectively remove the differences between the working tree
3849
and the preview tree.
3851
from bzrlib import shelf_ui
3852
result_tree = self._get_preview(merger, cleanups)
3853
writer = bzrlib.option.diff_writer_registry.get()
3854
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3855
reporter=shelf_ui.ApplyReporter(),
3856
diff_writer=writer(sys.stdout))
3862
def sanity_check_merger(self, merger):
3863
if (merger.show_base and
3864
not merger.merge_type is _mod_merge.Merge3Merger):
3865
raise errors.BzrCommandError("Show-base is not supported for this"
3866
" merge type. %s" % merger.merge_type)
3867
if merger.reprocess is None:
3868
if merger.show_base:
3869
merger.reprocess = False
3871
# Use reprocess if the merger supports it
3872
merger.reprocess = merger.merge_type.supports_reprocess
3873
if merger.reprocess and not merger.merge_type.supports_reprocess:
3874
raise errors.BzrCommandError("Conflict reduction is not supported"
3875
" for merge type %s." %
3877
if merger.reprocess and merger.show_base:
3878
raise errors.BzrCommandError("Cannot do conflict reduction and"
3881
def _get_merger_from_branch(self, tree, location, revision, remember,
3882
possible_transports, pb):
3883
"""Produce a merger from a location, assuming it refers to a branch."""
3884
from bzrlib.tag import _merge_tags_if_possible
3885
# find the branch locations
3886
other_loc, user_location = self._select_branch_location(tree, location,
3888
if revision is not None and len(revision) == 2:
3889
base_loc, _unused = self._select_branch_location(tree,
3890
location, revision, 0)
3892
base_loc = other_loc
3894
other_branch, other_path = Branch.open_containing(other_loc,
3895
possible_transports)
3896
if base_loc == other_loc:
3897
base_branch = other_branch
3899
base_branch, base_path = Branch.open_containing(base_loc,
3900
possible_transports)
3901
# Find the revision ids
3902
other_revision_id = None
3903
base_revision_id = None
3904
if revision is not None:
3905
if len(revision) >= 1:
3906
other_revision_id = revision[-1].as_revision_id(other_branch)
3907
if len(revision) == 2:
3908
base_revision_id = revision[0].as_revision_id(base_branch)
3909
if other_revision_id is None:
3910
other_revision_id = _mod_revision.ensure_null(
3911
other_branch.last_revision())
3912
# Remember where we merge from
3913
if ((remember or tree.branch.get_submit_branch() is None) and
3914
user_location is not None):
3915
tree.branch.set_submit_branch(other_branch.base)
3916
_merge_tags_if_possible(other_branch, tree.branch)
3917
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3918
other_revision_id, base_revision_id, other_branch, base_branch)
3919
if other_path != '':
3920
allow_pending = False
3921
merger.interesting_files = [other_path]
3923
allow_pending = True
3924
return merger, allow_pending
3926
def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3927
"""Get a merger for uncommitted changes.
3929
:param tree: The tree the merger should apply to.
3930
:param location: The location containing uncommitted changes.
3931
:param pb: The progress bar to use for showing progress.
3932
:param cleanups: A list of operations to perform to clean up the
3933
temporary directories, unfinalized objects, etc.
3935
location = self._select_branch_location(tree, location)[0]
3936
other_tree, other_path = WorkingTree.open_containing(location)
3937
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3938
if other_path != '':
3939
merger.interesting_files = [other_path]
3942
def _select_branch_location(self, tree, user_location, revision=None,
3944
"""Select a branch location, according to possible inputs.
3946
If provided, branches from ``revision`` are preferred. (Both
3947
``revision`` and ``index`` must be supplied.)
3949
Otherwise, the ``location`` parameter is used. If it is None, then the
3950
``submit`` or ``parent`` location is used, and a note is printed.
3952
:param tree: The working tree to select a branch for merging into
3953
:param location: The location entered by the user
3954
:param revision: The revision parameter to the command
3955
:param index: The index to use for the revision parameter. Negative
3956
indices are permitted.
3957
:return: (selected_location, user_location). The default location
3958
will be the user-entered location.
3960
if (revision is not None and index is not None
3961
and revision[index] is not None):
3962
branch = revision[index].get_branch()
3963
if branch is not None:
3964
return branch, branch
3965
if user_location is None:
3966
location = self._get_remembered(tree, 'Merging from')
3968
location = user_location
3969
return location, user_location
3971
def _get_remembered(self, tree, verb_string):
3972
"""Use tree.branch's parent if none was supplied.
3974
Report if the remembered location was used.
3976
stored_location = tree.branch.get_submit_branch()
3977
stored_location_type = "submit"
3978
if stored_location is None:
3979
stored_location = tree.branch.get_parent()
3980
stored_location_type = "parent"
3981
mutter("%s", stored_location)
3982
if stored_location is None:
3983
raise errors.BzrCommandError("No location specified or remembered")
3984
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3985
note(u"%s remembered %s location %s", verb_string,
3986
stored_location_type, display_url)
3987
return stored_location
3990
class cmd_remerge(Command):
3993
Use this if you want to try a different merge technique while resolving
3994
conflicts. Some merge techniques are better than others, and remerge
3995
lets you try different ones on different files.
3997
The options for remerge have the same meaning and defaults as the ones for
3998
merge. The difference is that remerge can (only) be run when there is a
3999
pending merge, and it lets you specify particular files.
4002
Re-do the merge of all conflicted files, and show the base text in
4003
conflict regions, in addition to the usual THIS and OTHER texts::
4005
bzr remerge --show-base
4007
Re-do the merge of "foobar", using the weave merge algorithm, with
4008
additional processing to reduce the size of conflict regions::
4010
bzr remerge --merge-type weave --reprocess foobar
4012
takes_args = ['file*']
4017
help="Show base revision text in conflicts."),
4020
def run(self, file_list=None, merge_type=None, show_base=False,
4022
if merge_type is None:
4023
merge_type = _mod_merge.Merge3Merger
4024
tree, file_list = tree_files(file_list)
4027
parents = tree.get_parent_ids()
4028
if len(parents) != 2:
4029
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4030
" merges. Not cherrypicking or"
4032
repository = tree.branch.repository
4033
interesting_ids = None
4035
conflicts = tree.conflicts()
4036
if file_list is not None:
4037
interesting_ids = set()
4038
for filename in file_list:
4039
file_id = tree.path2id(filename)
4041
raise errors.NotVersionedError(filename)
4042
interesting_ids.add(file_id)
4043
if tree.kind(file_id) != "directory":
4046
for name, ie in tree.inventory.iter_entries(file_id):
4047
interesting_ids.add(ie.file_id)
4048
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4050
# Remerge only supports resolving contents conflicts
4051
allowed_conflicts = ('text conflict', 'contents conflict')
4052
restore_files = [c.path for c in conflicts
4053
if c.typestring in allowed_conflicts]
4054
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4055
tree.set_conflicts(ConflictList(new_conflicts))
4056
if file_list is not None:
4057
restore_files = file_list
4058
for filename in restore_files:
4060
restore(tree.abspath(filename))
4061
except errors.NotConflicted:
4063
# Disable pending merges, because the file texts we are remerging
4064
# have not had those merges performed. If we use the wrong parents
4065
# list, we imply that the working tree text has seen and rejected
4066
# all the changes from the other tree, when in fact those changes
4067
# have not yet been seen.
4068
pb = ui.ui_factory.nested_progress_bar()
4069
tree.set_parent_ids(parents[:1])
4071
merger = _mod_merge.Merger.from_revision_ids(pb,
4073
merger.interesting_ids = interesting_ids
4074
merger.merge_type = merge_type
4075
merger.show_base = show_base
4076
merger.reprocess = reprocess
4077
conflicts = merger.do_merge()
4079
tree.set_parent_ids(parents)
4089
class cmd_revert(Command):
4090
"""Revert files to a previous revision.
4092
Giving a list of files will revert only those files. Otherwise, all files
4093
will be reverted. If the revision is not specified with '--revision', the
4094
last committed revision is used.
4096
To remove only some changes, without reverting to a prior version, use
4097
merge instead. For example, "merge . --revision -2..-3" will remove the
4098
changes introduced by -2, without affecting the changes introduced by -1.
4099
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4101
By default, any files that have been manually changed will be backed up
4102
first. (Files changed only by merge are not backed up.) Backup files have
4103
'.~#~' appended to their name, where # is a number.
4105
When you provide files, you can use their current pathname or the pathname
4106
from the target revision. So you can use revert to "undelete" a file by
4107
name. If you name a directory, all the contents of that directory will be
4110
If you have newly added files since the target revision, they will be
4111
removed. If the files to be removed have been changed, backups will be
4112
created as above. Directories containing unknown files will not be
4115
The working tree contains a list of pending merged revisions, which will
4116
be included as parents in the next commit. Normally, revert clears that
4117
list as well as reverting the files. If any files are specified, revert
4118
leaves the pending merge list alone and reverts only the files. Use "bzr
4119
revert ." in the tree root to revert all files but keep the merge record,
4120
and "bzr revert --forget-merges" to clear the pending merge list without
4121
reverting any files.
4123
Using "bzr revert --forget-merges", it is possible to apply the changes
4124
from an arbitrary merge as a single revision. To do this, perform the
4125
merge as desired. Then doing revert with the "--forget-merges" option will
4126
keep the content of the tree as it was, but it will clear the list of
4127
pending merges. The next commit will then contain all of the changes that
4128
would have been in the merge, but without any mention of the other parent
4129
revisions. Because this technique forgets where these changes originated,
4130
it may cause additional conflicts on later merges involving the source and
4134
_see_also = ['cat', 'export']
4137
Option('no-backup', "Do not save backups of reverted files."),
4138
Option('forget-merges',
4139
'Remove pending merge marker, without changing any files.'),
4141
takes_args = ['file*']
4143
def run(self, revision=None, no_backup=False, file_list=None,
4144
forget_merges=None):
4145
tree, file_list = tree_files(file_list)
4149
tree.set_parent_ids(tree.get_parent_ids()[:1])
4151
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4156
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4157
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4158
pb = ui.ui_factory.nested_progress_bar()
4160
tree.revert(file_list, rev_tree, not no_backup, pb,
4161
report_changes=True)
4166
class cmd_assert_fail(Command):
4167
"""Test reporting of assertion failures"""
4168
# intended just for use in testing
4173
raise AssertionError("always fails")
4176
class cmd_help(Command):
4177
"""Show help on a command or other topic.
4180
_see_also = ['topics']
4182
Option('long', 'Show help on all commands.'),
4184
takes_args = ['topic?']
4185
aliases = ['?', '--help', '-?', '-h']
4188
def run(self, topic=None, long=False):
4190
if topic is None and long:
4192
bzrlib.help.help(topic)
4195
class cmd_shell_complete(Command):
4196
"""Show appropriate completions for context.
4198
For a list of all available commands, say 'bzr shell-complete'.
4200
takes_args = ['context?']
4205
def run(self, context=None):
4206
import shellcomplete
4207
shellcomplete.shellcomplete(context)
4210
class cmd_missing(Command):
4211
"""Show unmerged/unpulled revisions between two branches.
4213
OTHER_BRANCH may be local or remote.
4215
To filter on a range of revisions, you can use the command -r begin..end
4216
-r revision requests a specific revision, -r ..end or -r begin.. are
4220
1 - some missing revisions
4221
0 - no missing revisions
4225
Determine the missing revisions between this and the branch at the
4226
remembered pull location::
4230
Determine the missing revisions between this and another branch::
4232
bzr missing http://server/branch
4234
Determine the missing revisions up to a specific revision on the other
4237
bzr missing -r ..-10
4239
Determine the missing revisions up to a specific revision on this
4242
bzr missing --my-revision ..-10
4245
_see_also = ['merge', 'pull']
4246
takes_args = ['other_branch?']
4248
Option('reverse', 'Reverse the order of revisions.'),
4250
'Display changes in the local branch only.'),
4251
Option('this' , 'Same as --mine-only.'),
4252
Option('theirs-only',
4253
'Display changes in the remote branch only.'),
4254
Option('other', 'Same as --theirs-only.'),
4258
custom_help('revision',
4259
help='Filter on other branch revisions (inclusive). '
4260
'See "help revisionspec" for details.'),
4261
Option('my-revision',
4262
type=_parse_revision_str,
4263
help='Filter on local branch revisions (inclusive). '
4264
'See "help revisionspec" for details.'),
4265
Option('include-merges',
4266
'Show all revisions in addition to the mainline ones.'),
4268
encoding_type = 'replace'
4271
def run(self, other_branch=None, reverse=False, mine_only=False,
4273
log_format=None, long=False, short=False, line=False,
4274
show_ids=False, verbose=False, this=False, other=False,
4275
include_merges=False, revision=None, my_revision=None):
4276
from bzrlib.missing import find_unmerged, iter_log_revisions
4285
# TODO: We should probably check that we don't have mine-only and
4286
# theirs-only set, but it gets complicated because we also have
4287
# this and other which could be used.
4294
local_branch = Branch.open_containing(u".")[0]
4295
parent = local_branch.get_parent()
4296
if other_branch is None:
4297
other_branch = parent
4298
if other_branch is None:
4299
raise errors.BzrCommandError("No peer location known"
4301
display_url = urlutils.unescape_for_display(parent,
4303
message("Using saved parent location: "
4304
+ display_url + "\n")
4306
remote_branch = Branch.open(other_branch)
4307
if remote_branch.base == local_branch.base:
4308
remote_branch = local_branch
4310
local_revid_range = _revision_range_to_revid_range(
4311
_get_revision_range(my_revision, local_branch,
4314
remote_revid_range = _revision_range_to_revid_range(
4315
_get_revision_range(revision,
4316
remote_branch, self.name()))
4318
local_branch.lock_read()
4320
remote_branch.lock_read()
4322
local_extra, remote_extra = find_unmerged(
4323
local_branch, remote_branch, restrict,
4324
backward=not reverse,
4325
include_merges=include_merges,
4326
local_revid_range=local_revid_range,
4327
remote_revid_range=remote_revid_range)
4329
if log_format is None:
4330
registry = log.log_formatter_registry
4331
log_format = registry.get_default(local_branch)
4332
lf = log_format(to_file=self.outf,
4334
show_timezone='original')
4337
if local_extra and not theirs_only:
4338
message("You have %d extra revision(s):\n" %
4340
for revision in iter_log_revisions(local_extra,
4341
local_branch.repository,
4343
lf.log_revision(revision)
4344
printed_local = True
4347
printed_local = False
4349
if remote_extra and not mine_only:
4350
if printed_local is True:
4352
message("You are missing %d revision(s):\n" %
4354
for revision in iter_log_revisions(remote_extra,
4355
remote_branch.repository,
4357
lf.log_revision(revision)
4360
if mine_only and not local_extra:
4361
# We checked local, and found nothing extra
4362
message('This branch is up to date.\n')
4363
elif theirs_only and not remote_extra:
4364
# We checked remote, and found nothing extra
4365
message('Other branch is up to date.\n')
4366
elif not (mine_only or theirs_only or local_extra or
4368
# We checked both branches, and neither one had extra
4370
message("Branches are up to date.\n")
4372
remote_branch.unlock()
4374
local_branch.unlock()
4375
if not status_code and parent is None and other_branch is not None:
4376
local_branch.lock_write()
4378
# handle race conditions - a parent might be set while we run.
4379
if local_branch.get_parent() is None:
4380
local_branch.set_parent(remote_branch.base)
4382
local_branch.unlock()
4386
class cmd_pack(Command):
4387
"""Compress the data within a repository."""
4389
_see_also = ['repositories']
4390
takes_args = ['branch_or_repo?']
4392
def run(self, branch_or_repo='.'):
4393
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4395
branch = dir.open_branch()
4396
repository = branch.repository
4397
except errors.NotBranchError:
4398
repository = dir.open_repository()
4402
class cmd_plugins(Command):
4403
"""List the installed plugins.
4405
This command displays the list of installed plugins including
4406
version of plugin and a short description of each.
4408
--verbose shows the path where each plugin is located.
4410
A plugin is an external component for Bazaar that extends the
4411
revision control system, by adding or replacing code in Bazaar.
4412
Plugins can do a variety of things, including overriding commands,
4413
adding new commands, providing additional network transports and
4414
customizing log output.
4416
See the Bazaar web site, http://bazaar-vcs.org, for further
4417
information on plugins including where to find them and how to
4418
install them. Instructions are also provided there on how to
4419
write new plugins using the Python programming language.
4421
takes_options = ['verbose']
4424
def run(self, verbose=False):
4425
import bzrlib.plugin
4426
from inspect import getdoc
4428
for name, plugin in bzrlib.plugin.plugins().items():
4429
version = plugin.__version__
4430
if version == 'unknown':
4432
name_ver = '%s %s' % (name, version)
4433
d = getdoc(plugin.module)
4435
doc = d.split('\n')[0]
4437
doc = '(no description)'
4438
result.append((name_ver, doc, plugin.path()))
4439
for name_ver, doc, path in sorted(result):
4447
class cmd_testament(Command):
4448
"""Show testament (signing-form) of a revision."""
4451
Option('long', help='Produce long-format testament.'),
4453
help='Produce a strict-format testament.')]
4454
takes_args = ['branch?']
4456
def run(self, branch=u'.', revision=None, long=False, strict=False):
4457
from bzrlib.testament import Testament, StrictTestament
4459
testament_class = StrictTestament
4461
testament_class = Testament
4463
b = Branch.open_containing(branch)[0]
4465
b = Branch.open(branch)
4468
if revision is None:
4469
rev_id = b.last_revision()
4471
rev_id = revision[0].as_revision_id(b)
4472
t = testament_class.from_revision(b.repository, rev_id)
4474
sys.stdout.writelines(t.as_text_lines())
4476
sys.stdout.write(t.as_short_text())
4481
class cmd_annotate(Command):
4482
"""Show the origin of each line in a file.
4484
This prints out the given file with an annotation on the left side
4485
indicating which revision, author and date introduced the change.
4487
If the origin is the same for a run of consecutive lines, it is
4488
shown only at the top, unless the --all option is given.
4490
# TODO: annotate directories; showing when each file was last changed
4491
# TODO: if the working copy is modified, show annotations on that
4492
# with new uncommitted lines marked
4493
aliases = ['ann', 'blame', 'praise']
4494
takes_args = ['filename']
4495
takes_options = [Option('all', help='Show annotations on all lines.'),
4496
Option('long', help='Show commit date in annotations.'),
4500
encoding_type = 'exact'
4503
def run(self, filename, all=False, long=False, revision=None,
4505
from bzrlib.annotate import annotate_file, annotate_file_tree
4506
wt, branch, relpath = \
4507
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4513
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4515
file_id = wt.path2id(relpath)
4517
file_id = tree.path2id(relpath)
4519
raise errors.NotVersionedError(filename)
4520
file_version = tree.inventory[file_id].revision
4521
if wt is not None and revision is None:
4522
# If there is a tree and we're not annotating historical
4523
# versions, annotate the working tree's content.
4524
annotate_file_tree(wt, file_id, self.outf, long, all,
4527
annotate_file(branch, file_version, file_id, long, all, self.outf,
4536
class cmd_re_sign(Command):
4537
"""Create a digital signature for an existing revision."""
4538
# TODO be able to replace existing ones.
4540
hidden = True # is this right ?
4541
takes_args = ['revision_id*']
4542
takes_options = ['revision']
4544
def run(self, revision_id_list=None, revision=None):
4545
if revision_id_list is not None and revision is not None:
4546
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4547
if revision_id_list is None and revision is None:
4548
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4549
b = WorkingTree.open_containing(u'.')[0].branch
4552
return self._run(b, revision_id_list, revision)
4556
def _run(self, b, revision_id_list, revision):
4557
import bzrlib.gpg as gpg
4558
gpg_strategy = gpg.GPGStrategy(b.get_config())
4559
if revision_id_list is not None:
4560
b.repository.start_write_group()
4562
for revision_id in revision_id_list:
4563
b.repository.sign_revision(revision_id, gpg_strategy)
4565
b.repository.abort_write_group()
4568
b.repository.commit_write_group()
4569
elif revision is not None:
4570
if len(revision) == 1:
4571
revno, rev_id = revision[0].in_history(b)
4572
b.repository.start_write_group()
4574
b.repository.sign_revision(rev_id, gpg_strategy)
4576
b.repository.abort_write_group()
4579
b.repository.commit_write_group()
4580
elif len(revision) == 2:
4581
# are they both on rh- if so we can walk between them
4582
# might be nice to have a range helper for arbitrary
4583
# revision paths. hmm.
4584
from_revno, from_revid = revision[0].in_history(b)
4585
to_revno, to_revid = revision[1].in_history(b)
4586
if to_revid is None:
4587
to_revno = b.revno()
4588
if from_revno is None or to_revno is None:
4589
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4590
b.repository.start_write_group()
4592
for revno in range(from_revno, to_revno + 1):
4593
b.repository.sign_revision(b.get_rev_id(revno),
4596
b.repository.abort_write_group()
4599
b.repository.commit_write_group()
4601
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4604
class cmd_bind(Command):
4605
"""Convert the current branch into a checkout of the supplied branch.
4607
Once converted into a checkout, commits must succeed on the master branch
4608
before they will be applied to the local branch.
4610
Bound branches use the nickname of its master branch unless it is set
4611
locally, in which case binding will update the local nickname to be
4615
_see_also = ['checkouts', 'unbind']
4616
takes_args = ['location?']
4619
def run(self, location=None):
4620
b, relpath = Branch.open_containing(u'.')
4621
if location is None:
4623
location = b.get_old_bound_location()
4624
except errors.UpgradeRequired:
4625
raise errors.BzrCommandError('No location supplied. '
4626
'This format does not remember old locations.')
4628
if location is None:
4629
raise errors.BzrCommandError('No location supplied and no '
4630
'previous location known')
4631
b_other = Branch.open(location)
4634
except errors.DivergedBranches:
4635
raise errors.BzrCommandError('These branches have diverged.'
4636
' Try merging, and then bind again.')
4637
if b.get_config().has_explicit_nickname():
4638
b.nick = b_other.nick
4641
class cmd_unbind(Command):
4642
"""Convert the current checkout into a regular branch.
4644
After unbinding, the local branch is considered independent and subsequent
4645
commits will be local only.
4648
_see_also = ['checkouts', 'bind']
4653
b, relpath = Branch.open_containing(u'.')
4655
raise errors.BzrCommandError('Local branch is not bound')
4658
class cmd_uncommit(Command):
4659
"""Remove the last committed revision.
4661
--verbose will print out what is being removed.
4662
--dry-run will go through all the motions, but not actually
4665
If --revision is specified, uncommit revisions to leave the branch at the
4666
specified revision. For example, "bzr uncommit -r 15" will leave the
4667
branch at revision 15.
4669
Uncommit leaves the working tree ready for a new commit. The only change
4670
it may make is to restore any pending merges that were present before
4674
# TODO: jam 20060108 Add an option to allow uncommit to remove
4675
# unreferenced information in 'branch-as-repository' branches.
4676
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4677
# information in shared branches as well.
4678
_see_also = ['commit']
4679
takes_options = ['verbose', 'revision',
4680
Option('dry-run', help='Don\'t actually make changes.'),
4681
Option('force', help='Say yes to all questions.'),
4683
help="Only remove the commits from the local branch"
4684
" when in a checkout."
4687
takes_args = ['location?']
4689
encoding_type = 'replace'
4691
def run(self, location=None,
4692
dry_run=False, verbose=False,
4693
revision=None, force=False, local=False):
4694
if location is None:
4696
control, relpath = bzrdir.BzrDir.open_containing(location)
4698
tree = control.open_workingtree()
4700
except (errors.NoWorkingTree, errors.NotLocalUrl):
4702
b = control.open_branch()
4704
if tree is not None:
4709
return self._run(b, tree, dry_run, verbose, revision, force,
4712
if tree is not None:
4717
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4718
from bzrlib.log import log_formatter, show_log
4719
from bzrlib.uncommit import uncommit
4721
last_revno, last_rev_id = b.last_revision_info()
4724
if revision is None:
4726
rev_id = last_rev_id
4728
# 'bzr uncommit -r 10' actually means uncommit
4729
# so that the final tree is at revno 10.
4730
# but bzrlib.uncommit.uncommit() actually uncommits
4731
# the revisions that are supplied.
4732
# So we need to offset it by one
4733
revno = revision[0].in_history(b).revno + 1
4734
if revno <= last_revno:
4735
rev_id = b.get_rev_id(revno)
4737
if rev_id is None or _mod_revision.is_null(rev_id):
4738
self.outf.write('No revisions to uncommit.\n')
4741
lf = log_formatter('short',
4743
show_timezone='original')
4748
direction='forward',
4749
start_revision=revno,
4750
end_revision=last_revno)
4753
print 'Dry-run, pretending to remove the above revisions.'
4755
val = raw_input('Press <enter> to continue')
4757
print 'The above revision(s) will be removed.'
4759
val = raw_input('Are you sure [y/N]? ')
4760
if val.lower() not in ('y', 'yes'):
4764
mutter('Uncommitting from {%s} to {%s}',
4765
last_rev_id, rev_id)
4766
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4767
revno=revno, local=local)
4768
note('You can restore the old tip by running:\n'
4769
' bzr pull . -r revid:%s', last_rev_id)
4772
class cmd_break_lock(Command):
4773
"""Break a dead lock on a repository, branch or working directory.
4775
CAUTION: Locks should only be broken when you are sure that the process
4776
holding the lock has been stopped.
4778
You can get information on what locks are open via the 'bzr info' command.
4783
takes_args = ['location?']
4785
def run(self, location=None, show=False):
4786
if location is None:
4788
control, relpath = bzrdir.BzrDir.open_containing(location)
4790
control.break_lock()
4791
except NotImplementedError:
4795
class cmd_wait_until_signalled(Command):
4796
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4798
This just prints a line to signal when it is ready, then blocks on stdin.
4804
sys.stdout.write("running\n")
4806
sys.stdin.readline()
4809
class cmd_serve(Command):
4810
"""Run the bzr server."""
4812
aliases = ['server']
4816
help='Serve on stdin/out for use from inetd or sshd.'),
4817
RegistryOption('protocol',
4818
help="Protocol to serve.",
4819
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4820
value_switches=True),
4822
help='Listen for connections on nominated port of the form '
4823
'[hostname:]portnumber. Passing 0 as the port number will '
4824
'result in a dynamically allocated port. The default port '
4825
'depends on the protocol.',
4828
help='Serve contents of this directory.',
4830
Option('allow-writes',
4831
help='By default the server is a readonly server. Supplying '
4832
'--allow-writes enables write access to the contents of '
4833
'the served directory and below. Note that ``bzr serve`` '
4834
'does not perform authentication, so unless some form of '
4835
'external authentication is arranged supplying this '
4836
'option leads to global uncontrolled write access to your '
4841
def get_host_and_port(self, port):
4842
"""Return the host and port to run the smart server on.
4844
If 'port' is None, None will be returned for the host and port.
4846
If 'port' has a colon in it, the string before the colon will be
4847
interpreted as the host.
4849
:param port: A string of the port to run the server on.
4850
:return: A tuple of (host, port), where 'host' is a host name or IP,
4851
and port is an integer TCP/IP port.
4854
if port is not None:
4856
host, port = port.split(':')
4860
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4862
from bzrlib.transport import get_transport, transport_server_registry
4863
if directory is None:
4864
directory = os.getcwd()
4865
if protocol is None:
4866
protocol = transport_server_registry.get()
4867
host, port = self.get_host_and_port(port)
4868
url = urlutils.local_path_to_url(directory)
4869
if not allow_writes:
4870
url = 'readonly+' + url
4871
transport = get_transport(url)
4872
protocol(transport, host, port, inet)
4875
class cmd_join(Command):
4876
"""Combine a tree into its containing tree.
4878
This command requires the target tree to be in a rich-root format.
4880
The TREE argument should be an independent tree, inside another tree, but
4881
not part of it. (Such trees can be produced by "bzr split", but also by
4882
running "bzr branch" with the target inside a tree.)
4884
The result is a combined tree, with the subtree no longer an independant
4885
part. This is marked as a merge of the subtree into the containing tree,
4886
and all history is preserved.
4889
_see_also = ['split']
4890
takes_args = ['tree']
4892
Option('reference', help='Join by reference.', hidden=True),
4895
def run(self, tree, reference=False):
4896
sub_tree = WorkingTree.open(tree)
4897
parent_dir = osutils.dirname(sub_tree.basedir)
4898
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4899
repo = containing_tree.branch.repository
4900
if not repo.supports_rich_root():
4901
raise errors.BzrCommandError(
4902
"Can't join trees because %s doesn't support rich root data.\n"
4903
"You can use bzr upgrade on the repository."
4907
containing_tree.add_reference(sub_tree)
4908
except errors.BadReferenceTarget, e:
4909
# XXX: Would be better to just raise a nicely printable
4910
# exception from the real origin. Also below. mbp 20070306
4911
raise errors.BzrCommandError("Cannot join %s. %s" %
4915
containing_tree.subsume(sub_tree)
4916
except errors.BadSubsumeSource, e:
4917
raise errors.BzrCommandError("Cannot join %s. %s" %
4921
class cmd_split(Command):
4922
"""Split a subdirectory of a tree into a separate tree.
4924
This command will produce a target tree in a format that supports
4925
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4926
converted into earlier formats like 'dirstate-tags'.
4928
The TREE argument should be a subdirectory of a working tree. That
4929
subdirectory will be converted into an independent tree, with its own
4930
branch. Commits in the top-level tree will not apply to the new subtree.
4933
_see_also = ['join']
4934
takes_args = ['tree']
4936
def run(self, tree):
4937
containing_tree, subdir = WorkingTree.open_containing(tree)
4938
sub_id = containing_tree.path2id(subdir)
4940
raise errors.NotVersionedError(subdir)
4942
containing_tree.extract(sub_id)
4943
except errors.RootNotRich:
4944
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4947
class cmd_merge_directive(Command):
4948
"""Generate a merge directive for auto-merge tools.
4950
A directive requests a merge to be performed, and also provides all the
4951
information necessary to do so. This means it must either include a
4952
revision bundle, or the location of a branch containing the desired
4955
A submit branch (the location to merge into) must be supplied the first
4956
time the command is issued. After it has been supplied once, it will
4957
be remembered as the default.
4959
A public branch is optional if a revision bundle is supplied, but required
4960
if --diff or --plain is specified. It will be remembered as the default
4961
after the first use.
4964
takes_args = ['submit_branch?', 'public_branch?']
4968
_see_also = ['send']
4971
RegistryOption.from_kwargs('patch-type',
4972
'The type of patch to include in the directive.',
4974
value_switches=True,
4976
bundle='Bazaar revision bundle (default).',
4977
diff='Normal unified diff.',
4978
plain='No patch, just directive.'),
4979
Option('sign', help='GPG-sign the directive.'), 'revision',
4980
Option('mail-to', type=str,
4981
help='Instead of printing the directive, email to this address.'),
4982
Option('message', type=str, short_name='m',
4983
help='Message to use when committing this merge.')
4986
encoding_type = 'exact'
4988
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4989
sign=False, revision=None, mail_to=None, message=None):
4990
from bzrlib.revision import ensure_null, NULL_REVISION
4991
include_patch, include_bundle = {
4992
'plain': (False, False),
4993
'diff': (True, False),
4994
'bundle': (True, True),
4996
branch = Branch.open('.')
4997
stored_submit_branch = branch.get_submit_branch()
4998
if submit_branch is None:
4999
submit_branch = stored_submit_branch
5001
if stored_submit_branch is None:
5002
branch.set_submit_branch(submit_branch)
5003
if submit_branch is None:
5004
submit_branch = branch.get_parent()
5005
if submit_branch is None:
5006
raise errors.BzrCommandError('No submit branch specified or known')
5008
stored_public_branch = branch.get_public_branch()
5009
if public_branch is None:
5010
public_branch = stored_public_branch
5011
elif stored_public_branch is None:
5012
branch.set_public_branch(public_branch)
5013
if not include_bundle and public_branch is None:
5014
raise errors.BzrCommandError('No public branch specified or'
5016
base_revision_id = None
5017
if revision is not None:
5018
if len(revision) > 2:
5019
raise errors.BzrCommandError('bzr merge-directive takes '
5020
'at most two one revision identifiers')
5021
revision_id = revision[-1].as_revision_id(branch)
5022
if len(revision) == 2:
5023
base_revision_id = revision[0].as_revision_id(branch)
5025
revision_id = branch.last_revision()
5026
revision_id = ensure_null(revision_id)
5027
if revision_id == NULL_REVISION:
5028
raise errors.BzrCommandError('No revisions to bundle.')
5029
directive = merge_directive.MergeDirective2.from_objects(
5030
branch.repository, revision_id, time.time(),
5031
osutils.local_time_offset(), submit_branch,
5032
public_branch=public_branch, include_patch=include_patch,
5033
include_bundle=include_bundle, message=message,
5034
base_revision_id=base_revision_id)
5037
self.outf.write(directive.to_signed(branch))
5039
self.outf.writelines(directive.to_lines())
5041
message = directive.to_email(mail_to, branch, sign)
5042
s = SMTPConnection(branch.get_config())
5043
s.send_email(message)
5046
class cmd_send(Command):
5047
"""Mail or create a merge-directive for submitting changes.
5049
A merge directive provides many things needed for requesting merges:
5051
* A machine-readable description of the merge to perform
5053
* An optional patch that is a preview of the changes requested
5055
* An optional bundle of revision data, so that the changes can be applied
5056
directly from the merge directive, without retrieving data from a
5059
If --no-bundle is specified, then public_branch is needed (and must be
5060
up-to-date), so that the receiver can perform the merge using the
5061
public_branch. The public_branch is always included if known, so that
5062
people can check it later.
5064
The submit branch defaults to the parent, but can be overridden. Both
5065
submit branch and public branch will be remembered if supplied.
5067
If a public_branch is known for the submit_branch, that public submit
5068
branch is used in the merge instructions. This means that a local mirror
5069
can be used as your actual submit branch, once you have set public_branch
5072
Mail is sent using your preferred mail program. This should be transparent
5073
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5074
If the preferred client can't be found (or used), your editor will be used.
5076
To use a specific mail program, set the mail_client configuration option.
5077
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5078
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5079
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5080
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5083
If mail is being sent, a to address is required. This can be supplied
5084
either on the commandline, by setting the submit_to configuration
5085
option in the branch itself or the child_submit_to configuration option
5086
in the submit branch.
5088
Two formats are currently supported: "4" uses revision bundle format 4 and
5089
merge directive format 2. It is significantly faster and smaller than
5090
older formats. It is compatible with Bazaar 0.19 and later. It is the
5091
default. "0.9" uses revision bundle format 0.9 and merge directive
5092
format 1. It is compatible with Bazaar 0.12 - 0.18.
5094
The merge directives created by bzr send may be applied using bzr merge or
5095
bzr pull by specifying a file containing a merge directive as the location.
5098
encoding_type = 'exact'
5100
_see_also = ['merge', 'pull']
5102
takes_args = ['submit_branch?', 'public_branch?']
5106
help='Do not include a bundle in the merge directive.'),
5107
Option('no-patch', help='Do not include a preview patch in the merge'
5110
help='Remember submit and public branch.'),
5112
help='Branch to generate the submission from, '
5113
'rather than the one containing the working directory.',
5116
Option('output', short_name='o',
5117
help='Write merge directive to this file; '
5118
'use - for stdout.',
5121
help='Refuse to send if there are uncommitted changes in'
5122
' the working tree, --no-strict disables the check.'),
5123
Option('mail-to', help='Mail the request to this address.',
5127
Option('body', help='Body for the email.', type=unicode),
5128
RegistryOption('format',
5129
help='Use the specified output format.',
5130
lazy_registry=('bzrlib.send', 'format_registry')),
5133
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5134
no_patch=False, revision=None, remember=False, output=None,
5135
format=None, mail_to=None, message=None, body=None,
5136
strict=None, **kwargs):
5137
from bzrlib.send import send
5138
return send(submit_branch, revision, public_branch, remember,
5139
format, no_bundle, no_patch, output,
5140
kwargs.get('from', '.'), mail_to, message, body,
5145
class cmd_bundle_revisions(cmd_send):
5146
"""Create a merge-directive for submitting changes.
5148
A merge directive provides many things needed for requesting merges:
5150
* A machine-readable description of the merge to perform
5152
* An optional patch that is a preview of the changes requested
5154
* An optional bundle of revision data, so that the changes can be applied
5155
directly from the merge directive, without retrieving data from a
5158
If --no-bundle is specified, then public_branch is needed (and must be
5159
up-to-date), so that the receiver can perform the merge using the
5160
public_branch. The public_branch is always included if known, so that
5161
people can check it later.
5163
The submit branch defaults to the parent, but can be overridden. Both
5164
submit branch and public branch will be remembered if supplied.
5166
If a public_branch is known for the submit_branch, that public submit
5167
branch is used in the merge instructions. This means that a local mirror
5168
can be used as your actual submit branch, once you have set public_branch
5171
Two formats are currently supported: "4" uses revision bundle format 4 and
5172
merge directive format 2. It is significantly faster and smaller than
5173
older formats. It is compatible with Bazaar 0.19 and later. It is the
5174
default. "0.9" uses revision bundle format 0.9 and merge directive
5175
format 1. It is compatible with Bazaar 0.12 - 0.18.
5180
help='Do not include a bundle in the merge directive.'),
5181
Option('no-patch', help='Do not include a preview patch in the merge'
5184
help='Remember submit and public branch.'),
5186
help='Branch to generate the submission from, '
5187
'rather than the one containing the working directory.',
5190
Option('output', short_name='o', help='Write directive to this file.',
5193
help='Refuse to bundle revisions if there are uncommitted'
5194
' changes in the working tree, --no-strict disables the check.'),
5196
RegistryOption('format',
5197
help='Use the specified output format.',
5198
lazy_registry=('bzrlib.send', 'format_registry')),
5200
aliases = ['bundle']
5202
_see_also = ['send', 'merge']
5206
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5207
no_patch=False, revision=None, remember=False, output=None,
5208
format=None, strict=None, **kwargs):
5211
from bzrlib.send import send
5212
return send(submit_branch, revision, public_branch, remember,
5213
format, no_bundle, no_patch, output,
5214
kwargs.get('from', '.'), None, None, None,
5215
self.outf, strict=strict)
5218
class cmd_tag(Command):
5219
"""Create, remove or modify a tag naming a revision.
5221
Tags give human-meaningful names to revisions. Commands that take a -r
5222
(--revision) option can be given -rtag:X, where X is any previously
5225
Tags are stored in the branch. Tags are copied from one branch to another
5226
along when you branch, push, pull or merge.
5228
It is an error to give a tag name that already exists unless you pass
5229
--force, in which case the tag is moved to point to the new revision.
5231
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5232
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5235
_see_also = ['commit', 'tags']
5236
takes_args = ['tag_name']
5239
help='Delete this tag rather than placing it.',
5242
help='Branch in which to place the tag.',
5247
help='Replace existing tags.',
5252
def run(self, tag_name,
5258
branch, relpath = Branch.open_containing(directory)
5262
branch.tags.delete_tag(tag_name)
5263
self.outf.write('Deleted tag %s.\n' % tag_name)
5266
if len(revision) != 1:
5267
raise errors.BzrCommandError(
5268
"Tags can only be placed on a single revision, "
5270
revision_id = revision[0].as_revision_id(branch)
5272
revision_id = branch.last_revision()
5273
if (not force) and branch.tags.has_tag(tag_name):
5274
raise errors.TagAlreadyExists(tag_name)
5275
branch.tags.set_tag(tag_name, revision_id)
5276
self.outf.write('Created tag %s.\n' % tag_name)
5281
class cmd_tags(Command):
5284
This command shows a table of tag names and the revisions they reference.
5290
help='Branch whose tags should be displayed.',
5294
RegistryOption.from_kwargs('sort',
5295
'Sort tags by different criteria.', title='Sorting',
5296
alpha='Sort tags lexicographically (default).',
5297
time='Sort tags chronologically.',
5310
branch, relpath = Branch.open_containing(directory)
5312
tags = branch.tags.get_tag_dict().items()
5319
graph = branch.repository.get_graph()
5320
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5321
revid1, revid2 = rev1.rev_id, rev2.rev_id
5322
# only show revisions between revid1 and revid2 (inclusive)
5323
tags = [(tag, revid) for tag, revid in tags if
5324
graph.is_between(revid, revid1, revid2)]
5327
elif sort == 'time':
5329
for tag, revid in tags:
5331
revobj = branch.repository.get_revision(revid)
5332
except errors.NoSuchRevision:
5333
timestamp = sys.maxint # place them at the end
5335
timestamp = revobj.timestamp
5336
timestamps[revid] = timestamp
5337
tags.sort(key=lambda x: timestamps[x[1]])
5339
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5340
for index, (tag, revid) in enumerate(tags):
5342
revno = branch.revision_id_to_dotted_revno(revid)
5343
if isinstance(revno, tuple):
5344
revno = '.'.join(map(str, revno))
5345
except errors.NoSuchRevision:
5346
# Bad tag data/merges can lead to tagged revisions
5347
# which are not in this branch. Fail gracefully ...
5349
tags[index] = (tag, revno)
5352
for tag, revspec in tags:
5353
self.outf.write('%-20s %s\n' % (tag, revspec))
5356
class cmd_reconfigure(Command):
5357
"""Reconfigure the type of a bzr directory.
5359
A target configuration must be specified.
5361
For checkouts, the bind-to location will be auto-detected if not specified.
5362
The order of preference is
5363
1. For a lightweight checkout, the current bound location.
5364
2. For branches that used to be checkouts, the previously-bound location.
5365
3. The push location.
5366
4. The parent location.
5367
If none of these is available, --bind-to must be specified.
5370
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5371
takes_args = ['location?']
5373
RegistryOption.from_kwargs(
5375
title='Target type',
5376
help='The type to reconfigure the directory to.',
5377
value_switches=True, enum_switch=False,
5378
branch='Reconfigure to be an unbound branch with no working tree.',
5379
tree='Reconfigure to be an unbound branch with a working tree.',
5380
checkout='Reconfigure to be a bound branch with a working tree.',
5381
lightweight_checkout='Reconfigure to be a lightweight'
5382
' checkout (with no local history).',
5383
standalone='Reconfigure to be a standalone branch '
5384
'(i.e. stop using shared repository).',
5385
use_shared='Reconfigure to use a shared repository.',
5386
with_trees='Reconfigure repository to create '
5387
'working trees on branches by default.',
5388
with_no_trees='Reconfigure repository to not create '
5389
'working trees on branches by default.'
5391
Option('bind-to', help='Branch to bind checkout to.', type=str),
5393
help='Perform reconfiguration even if local changes'
5395
Option('stacked-on',
5396
help='Reconfigure a branch to be stacked on another branch.',
5400
help='Reconfigure a branch to be unstacked. This '
5401
'may require copying substantial data into it.',
5405
def run(self, location=None, target_type=None, bind_to=None, force=False,
5408
directory = bzrdir.BzrDir.open(location)
5409
if stacked_on and unstacked:
5410
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5411
elif stacked_on is not None:
5412
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5414
reconfigure.ReconfigureUnstacked().apply(directory)
5415
# At the moment you can use --stacked-on and a different
5416
# reconfiguration shape at the same time; there seems no good reason
5418
if target_type is None:
5419
if stacked_on or unstacked:
5422
raise errors.BzrCommandError('No target configuration '
5424
elif target_type == 'branch':
5425
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5426
elif target_type == 'tree':
5427
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5428
elif target_type == 'checkout':
5429
reconfiguration = reconfigure.Reconfigure.to_checkout(
5431
elif target_type == 'lightweight-checkout':
5432
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5434
elif target_type == 'use-shared':
5435
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5436
elif target_type == 'standalone':
5437
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5438
elif target_type == 'with-trees':
5439
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5441
elif target_type == 'with-no-trees':
5442
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5444
reconfiguration.apply(force)
5447
class cmd_switch(Command):
5448
"""Set the branch of a checkout and update.
5450
For lightweight checkouts, this changes the branch being referenced.
5451
For heavyweight checkouts, this checks that there are no local commits
5452
versus the current bound branch, then it makes the local branch a mirror
5453
of the new location and binds to it.
5455
In both cases, the working tree is updated and uncommitted changes
5456
are merged. The user can commit or revert these as they desire.
5458
Pending merges need to be committed or reverted before using switch.
5460
The path to the branch to switch to can be specified relative to the parent
5461
directory of the current branch. For example, if you are currently in a
5462
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5465
Bound branches use the nickname of its master branch unless it is set
5466
locally, in which case switching will update the local nickname to be
5470
takes_args = ['to_location']
5471
takes_options = [Option('force',
5472
help='Switch even if local commits will be lost.'),
5473
Option('create-branch', short_name='b',
5474
help='Create the target branch from this one before'
5475
' switching to it.'),
5478
def run(self, to_location, force=False, create_branch=False):
5479
from bzrlib import switch
5481
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5483
branch = control_dir.open_branch()
5484
had_explicit_nick = branch.get_config().has_explicit_nickname()
5485
except errors.NotBranchError:
5487
had_explicit_nick = False
5490
raise errors.BzrCommandError('cannot create branch without'
5492
to_location = directory_service.directories.dereference(
5494
if '/' not in to_location and '\\' not in to_location:
5495
# This path is meant to be relative to the existing branch
5496
this_url = self._get_branch_location(control_dir)
5497
to_location = urlutils.join(this_url, '..', to_location)
5498
to_branch = branch.bzrdir.sprout(to_location,
5499
possible_transports=[branch.bzrdir.root_transport],
5500
source_branch=branch).open_branch()
5502
# from_branch = control_dir.open_branch()
5503
# except errors.NotBranchError:
5504
# raise BzrCommandError('Cannot create a branch from this'
5505
# ' location when we cannot open this branch')
5506
# from_branch.bzrdir.sprout(
5510
to_branch = Branch.open(to_location)
5511
except errors.NotBranchError:
5512
this_url = self._get_branch_location(control_dir)
5513
to_branch = Branch.open(
5514
urlutils.join(this_url, '..', to_location))
5515
switch.switch(control_dir, to_branch, force)
5516
if had_explicit_nick:
5517
branch = control_dir.open_branch() #get the new branch!
5518
branch.nick = to_branch.nick
5519
note('Switched to branch: %s',
5520
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5522
def _get_branch_location(self, control_dir):
5523
"""Return location of branch for this control dir."""
5525
this_branch = control_dir.open_branch()
5526
# This may be a heavy checkout, where we want the master branch
5527
master_location = this_branch.get_bound_location()
5528
if master_location is not None:
5529
return master_location
5530
# If not, use a local sibling
5531
return this_branch.base
5532
except errors.NotBranchError:
5533
format = control_dir.find_branch_format()
5534
if getattr(format, 'get_reference', None) is not None:
5535
return format.get_reference(control_dir)
5537
return control_dir.root_transport.base
5540
class cmd_view(Command):
5541
"""Manage filtered views.
5543
Views provide a mask over the tree so that users can focus on
5544
a subset of a tree when doing their work. After creating a view,
5545
commands that support a list of files - status, diff, commit, etc -
5546
effectively have that list of files implicitly given each time.
5547
An explicit list of files can still be given but those files
5548
must be within the current view.
5550
In most cases, a view has a short life-span: it is created to make
5551
a selected change and is deleted once that change is committed.
5552
At other times, you may wish to create one or more named views
5553
and switch between them.
5555
To disable the current view without deleting it, you can switch to
5556
the pseudo view called ``off``. This can be useful when you need
5557
to see the whole tree for an operation or two (e.g. merge) but
5558
want to switch back to your view after that.
5561
To define the current view::
5563
bzr view file1 dir1 ...
5565
To list the current view::
5569
To delete the current view::
5573
To disable the current view without deleting it::
5575
bzr view --switch off
5577
To define a named view and switch to it::
5579
bzr view --name view-name file1 dir1 ...
5581
To list a named view::
5583
bzr view --name view-name
5585
To delete a named view::
5587
bzr view --name view-name --delete
5589
To switch to a named view::
5591
bzr view --switch view-name
5593
To list all views defined::
5597
To delete all views::
5599
bzr view --delete --all
5603
takes_args = ['file*']
5606
help='Apply list or delete action to all views.',
5609
help='Delete the view.',
5612
help='Name of the view to define, list or delete.',
5616
help='Name of the view to switch to.',
5621
def run(self, file_list,
5627
tree, file_list = tree_files(file_list, apply_view=False)
5628
current_view, view_dict = tree.views.get_view_info()
5633
raise errors.BzrCommandError(
5634
"Both --delete and a file list specified")
5636
raise errors.BzrCommandError(
5637
"Both --delete and --switch specified")
5639
tree.views.set_view_info(None, {})
5640
self.outf.write("Deleted all views.\n")
5642
raise errors.BzrCommandError("No current view to delete")
5644
tree.views.delete_view(name)
5645
self.outf.write("Deleted '%s' view.\n" % name)
5648
raise errors.BzrCommandError(
5649
"Both --switch and a file list specified")
5651
raise errors.BzrCommandError(
5652
"Both --switch and --all specified")
5653
elif switch == 'off':
5654
if current_view is None:
5655
raise errors.BzrCommandError("No current view to disable")
5656
tree.views.set_view_info(None, view_dict)
5657
self.outf.write("Disabled '%s' view.\n" % (current_view))
5659
tree.views.set_view_info(switch, view_dict)
5660
view_str = views.view_display_str(tree.views.lookup_view())
5661
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5664
self.outf.write('Views defined:\n')
5665
for view in sorted(view_dict):
5666
if view == current_view:
5670
view_str = views.view_display_str(view_dict[view])
5671
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5673
self.outf.write('No views defined.\n')
5676
# No name given and no current view set
5679
raise errors.BzrCommandError(
5680
"Cannot change the 'off' pseudo view")
5681
tree.views.set_view(name, sorted(file_list))
5682
view_str = views.view_display_str(tree.views.lookup_view())
5683
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5687
# No name given and no current view set
5688
self.outf.write('No current view.\n')
5690
view_str = views.view_display_str(tree.views.lookup_view(name))
5691
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5694
class cmd_hooks(Command):
5700
for hook_key in sorted(hooks.known_hooks.keys()):
5701
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5702
self.outf.write("%s:\n" % type(some_hooks).__name__)
5703
for hook_name, hook_point in sorted(some_hooks.items()):
5704
self.outf.write(" %s:\n" % (hook_name,))
5705
found_hooks = list(hook_point)
5707
for hook in found_hooks:
5708
self.outf.write(" %s\n" %
5709
(some_hooks.get_hook_name(hook),))
5711
self.outf.write(" <no hooks installed>\n")
5714
class cmd_shelve(Command):
5715
"""Temporarily set aside some changes from the current tree.
5717
Shelve allows you to temporarily put changes you've made "on the shelf",
5718
ie. out of the way, until a later time when you can bring them back from
5719
the shelf with the 'unshelve' command. The changes are stored alongside
5720
your working tree, and so they aren't propagated along with your branch nor
5721
will they survive its deletion.
5723
If shelve --list is specified, previously-shelved changes are listed.
5725
Shelve is intended to help separate several sets of changes that have
5726
been inappropriately mingled. If you just want to get rid of all changes
5727
and you don't need to restore them later, use revert. If you want to
5728
shelve all text changes at once, use shelve --all.
5730
If filenames are specified, only the changes to those files will be
5731
shelved. Other files will be left untouched.
5733
If a revision is specified, changes since that revision will be shelved.
5735
You can put multiple items on the shelf, and by default, 'unshelve' will
5736
restore the most recently shelved changes.
5739
takes_args = ['file*']
5743
Option('all', help='Shelve all changes.'),
5745
RegistryOption('writer', 'Method to use for writing diffs.',
5746
bzrlib.option.diff_writer_registry,
5747
value_switches=True, enum_switch=False),
5749
Option('list', help='List shelved changes.'),
5751
help='Destroy removed changes instead of shelving them.'),
5753
_see_also = ['unshelve']
5755
def run(self, revision=None, all=False, file_list=None, message=None,
5756
writer=None, list=False, destroy=False):
5758
return self.run_for_list()
5759
from bzrlib.shelf_ui import Shelver
5761
writer = bzrlib.option.diff_writer_registry.get()
5763
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5764
file_list, message, destroy=destroy)
5769
except errors.UserAbort:
5772
def run_for_list(self):
5773
tree = WorkingTree.open_containing('.')[0]
5776
manager = tree.get_shelf_manager()
5777
shelves = manager.active_shelves()
5778
if len(shelves) == 0:
5779
note('No shelved changes.')
5781
for shelf_id in reversed(shelves):
5782
message = manager.get_metadata(shelf_id).get('message')
5784
message = '<no message>'
5785
self.outf.write('%3d: %s\n' % (shelf_id, message))
5791
class cmd_unshelve(Command):
5792
"""Restore shelved changes.
5794
By default, the most recently shelved changes are restored. However if you
5795
specify a shelf by id those changes will be restored instead. This works
5796
best when the changes don't depend on each other.
5799
takes_args = ['shelf_id?']
5801
RegistryOption.from_kwargs(
5802
'action', help="The action to perform.",
5803
enum_switch=False, value_switches=True,
5804
apply="Apply changes and remove from the shelf.",
5805
dry_run="Show changes, but do not apply or remove them.",
5806
delete_only="Delete changes without applying them.",
5807
keep="Apply changes but don't delete them.",
5810
_see_also = ['shelve']
5812
def run(self, shelf_id=None, action='apply'):
5813
from bzrlib.shelf_ui import Unshelver
5814
unshelver = Unshelver.from_args(shelf_id, action)
5818
unshelver.tree.unlock()
5821
class cmd_clean_tree(Command):
5822
"""Remove unwanted files from working tree.
5824
By default, only unknown files, not ignored files, are deleted. Versioned
5825
files are never deleted.
5827
Another class is 'detritus', which includes files emitted by bzr during
5828
normal operations and selftests. (The value of these files decreases with
5831
If no options are specified, unknown files are deleted. Otherwise, option
5832
flags are respected, and may be combined.
5834
To check what clean-tree will do, use --dry-run.
5836
takes_options = [Option('ignored', help='Delete all ignored files.'),
5837
Option('detritus', help='Delete conflict files, merge'
5838
' backups, and failed selftest dirs.'),
5840
help='Delete files unknown to bzr (default).'),
5841
Option('dry-run', help='Show files to delete instead of'
5843
Option('force', help='Do not prompt before deleting.')]
5844
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5846
from bzrlib.clean_tree import clean_tree
5847
if not (unknown or ignored or detritus):
5851
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5852
dry_run=dry_run, no_prompt=force)
5855
class cmd_reference(Command):
5856
"""list, view and set branch locations for nested trees.
5858
If no arguments are provided, lists the branch locations for nested trees.
5859
If one argument is provided, display the branch location for that tree.
5860
If two arguments are provided, set the branch location for that tree.
5865
takes_args = ['path?', 'location?']
5867
def run(self, path=None, location=None):
5869
if path is not None:
5871
tree, branch, relpath =(
5872
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5873
if path is not None:
5876
tree = branch.basis_tree()
5878
info = branch._get_all_reference_info().iteritems()
5879
self._display_reference_info(tree, branch, info)
5881
file_id = tree.path2id(path)
5883
raise errors.NotVersionedError(path)
5884
if location is None:
5885
info = [(file_id, branch.get_reference_info(file_id))]
5886
self._display_reference_info(tree, branch, info)
5888
branch.set_reference_info(file_id, path, location)
5890
def _display_reference_info(self, tree, branch, info):
5892
for file_id, (path, location) in info:
5894
path = tree.id2path(file_id)
5895
except errors.NoSuchId:
5897
ref_list.append((path, location))
5898
for path, location in sorted(ref_list):
5899
self.outf.write('%s %s\n' % (path, location))
5902
# these get imported and then picked up by the scan for cmd_*
5903
# TODO: Some more consistent way to split command definitions across files;
5904
# we do need to load at least some information about them to know of
5905
# aliases. ideally we would avoid loading the implementation until the
5906
# details were needed.
5907
from bzrlib.cmd_version_info import cmd_version_info
5908
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5909
from bzrlib.bundle.commands import (
5912
from bzrlib.foreign import cmd_dpush
5913
from bzrlib.sign_my_commits import cmd_sign_my_commits
5914
from bzrlib.weave_commands import cmd_versionedfile_list, \
5915
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
