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.
1392
If the tree's branch is bound to a master branch, it will also update
1393
the branch from the master.
1396
_see_also = ['pull', 'working-trees', 'status-flags']
1397
takes_args = ['dir?']
1398
takes_options = ['revision']
1401
def run(self, dir='.', revision=None):
1402
if revision is not None and len(revision) != 1:
1403
raise errors.BzrCommandError(
1404
"bzr update --revision takes exactly one revision")
1405
tree = WorkingTree.open_containing(dir)[0]
1406
branch = tree.branch
1407
possible_transports = []
1408
master = branch.get_master_branch(
1409
possible_transports=possible_transports)
1410
if master is not None:
1412
branch_location = master.base
1414
tree.lock_tree_write()
1415
branch_location = tree.branch.base
1416
# get rid of the final '/' and be ready for display
1417
branch_location = urlutils.unescape_for_display(branch_location[:-1],
1420
existing_pending_merges = tree.get_parent_ids()[1:]
1424
# may need to fetch data into a heavyweight checkout
1425
# XXX: this may take some time, maybe we should display a
1427
old_tip = branch.update(possible_transports)
1428
if revision is not None:
1429
revision_id = revision[0].as_revision_id(branch)
1431
revision_id = branch.last_revision()
1432
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1433
revno = branch.revision_id_to_revno(revision_id)
1434
note("Tree is up to date at revision %d of branch %s" %
1435
(revno, branch_location))
1437
view_info = _get_view_info_for_change_reporter(tree)
1438
change_reporter = delta._ChangeReporter(
1439
unversioned_filter=tree.is_ignored,
1440
view_info=view_info)
1442
conflicts = tree.update(
1444
possible_transports=possible_transports,
1445
revision=revision_id,
1447
except errors.NoSuchRevision, e:
1448
raise errors.BzrCommandError(
1449
"branch has no revision %s\n"
1450
"bzr update --revision only works"
1451
" for a revision in the branch history"
1453
revno = tree.branch.revision_id_to_revno(
1454
_mod_revision.ensure_null(tree.last_revision()))
1455
note('Updated to revision %d of branch %s' %
1456
(revno, branch_location))
1457
if tree.get_parent_ids()[1:] != existing_pending_merges:
1458
note('Your local commits will now show as pending merges with '
1459
"'bzr status', and can be committed with 'bzr commit'.")
1468
class cmd_info(Command):
1469
"""Show information about a working tree, branch or repository.
1471
This command will show all known locations and formats associated to the
1472
tree, branch or repository.
1474
In verbose mode, statistical information is included with each report.
1475
To see extended statistic information, use a verbosity level of 2 or
1476
higher by specifying the verbose option multiple times, e.g. -vv.
1478
Branches and working trees will also report any missing revisions.
1482
Display information on the format and related locations:
1486
Display the above together with extended format information and
1487
basic statistics (like the number of files in the working tree and
1488
number of revisions in the branch and repository):
1492
Display the above together with number of committers to the branch:
1496
_see_also = ['revno', 'working-trees', 'repositories']
1497
takes_args = ['location?']
1498
takes_options = ['verbose']
1499
encoding_type = 'replace'
1502
def run(self, location=None, verbose=False):
1504
noise_level = get_verbosity_level()
1507
from bzrlib.info import show_bzrdir_info
1508
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1509
verbose=noise_level, outfile=self.outf)
1512
class cmd_remove(Command):
1513
"""Remove files or directories.
1515
This makes bzr stop tracking changes to the specified files. bzr will delete
1516
them if they can easily be recovered using revert. If no options or
1517
parameters are given bzr will scan for files that are being tracked by bzr
1518
but missing in your tree and stop tracking them for you.
1520
takes_args = ['file*']
1521
takes_options = ['verbose',
1522
Option('new', help='Only remove files that have never been committed.'),
1523
RegistryOption.from_kwargs('file-deletion-strategy',
1524
'The file deletion mode to be used.',
1525
title='Deletion Strategy', value_switches=True, enum_switch=False,
1526
safe='Only delete files if they can be'
1527
' safely recovered (default).',
1528
keep='Delete from bzr but leave the working copy.',
1529
force='Delete all the specified files, even if they can not be '
1530
'recovered and even if they are non-empty directories.')]
1531
aliases = ['rm', 'del']
1532
encoding_type = 'replace'
1534
def run(self, file_list, verbose=False, new=False,
1535
file_deletion_strategy='safe'):
1536
tree, file_list = tree_files(file_list)
1538
if file_list is not None:
1539
file_list = [f for f in file_list]
1543
# Heuristics should probably all move into tree.remove_smart or
1546
added = tree.changes_from(tree.basis_tree(),
1547
specific_files=file_list).added
1548
file_list = sorted([f[0] for f in added], reverse=True)
1549
if len(file_list) == 0:
1550
raise errors.BzrCommandError('No matching files.')
1551
elif file_list is None:
1552
# missing files show up in iter_changes(basis) as
1553
# versioned-with-no-kind.
1555
for change in tree.iter_changes(tree.basis_tree()):
1556
# Find paths in the working tree that have no kind:
1557
if change[1][1] is not None and change[6][1] is None:
1558
missing.append(change[1][1])
1559
file_list = sorted(missing, reverse=True)
1560
file_deletion_strategy = 'keep'
1561
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1562
keep_files=file_deletion_strategy=='keep',
1563
force=file_deletion_strategy=='force')
1568
class cmd_file_id(Command):
1569
"""Print file_id of a particular file or directory.
1571
The file_id is assigned when the file is first added and remains the
1572
same through all revisions where the file exists, even when it is
1577
_see_also = ['inventory', 'ls']
1578
takes_args = ['filename']
1581
def run(self, filename):
1582
tree, relpath = WorkingTree.open_containing(filename)
1583
i = tree.path2id(relpath)
1585
raise errors.NotVersionedError(filename)
1587
self.outf.write(i + '\n')
1590
class cmd_file_path(Command):
1591
"""Print path of file_ids to a file or directory.
1593
This prints one line for each directory down to the target,
1594
starting at the branch root.
1598
takes_args = ['filename']
1601
def run(self, filename):
1602
tree, relpath = WorkingTree.open_containing(filename)
1603
fid = tree.path2id(relpath)
1605
raise errors.NotVersionedError(filename)
1606
segments = osutils.splitpath(relpath)
1607
for pos in range(1, len(segments) + 1):
1608
path = osutils.joinpath(segments[:pos])
1609
self.outf.write("%s\n" % tree.path2id(path))
1612
class cmd_reconcile(Command):
1613
"""Reconcile bzr metadata in a branch.
1615
This can correct data mismatches that may have been caused by
1616
previous ghost operations or bzr upgrades. You should only
1617
need to run this command if 'bzr check' or a bzr developer
1618
advises you to run it.
1620
If a second branch is provided, cross-branch reconciliation is
1621
also attempted, which will check that data like the tree root
1622
id which was not present in very early bzr versions is represented
1623
correctly in both branches.
1625
At the same time it is run it may recompress data resulting in
1626
a potential saving in disk space or performance gain.
1628
The branch *MUST* be on a listable system such as local disk or sftp.
1631
_see_also = ['check']
1632
takes_args = ['branch?']
1634
def run(self, branch="."):
1635
from bzrlib.reconcile import reconcile
1636
dir = bzrdir.BzrDir.open(branch)
1640
class cmd_revision_history(Command):
1641
"""Display the list of revision ids on a branch."""
1644
takes_args = ['location?']
1649
def run(self, location="."):
1650
branch = Branch.open_containing(location)[0]
1651
for revid in branch.revision_history():
1652
self.outf.write(revid)
1653
self.outf.write('\n')
1656
class cmd_ancestry(Command):
1657
"""List all revisions merged into this branch."""
1659
_see_also = ['log', 'revision-history']
1660
takes_args = ['location?']
1665
def run(self, location="."):
1667
wt = WorkingTree.open_containing(location)[0]
1668
except errors.NoWorkingTree:
1669
b = Branch.open(location)
1670
last_revision = b.last_revision()
1673
last_revision = wt.last_revision()
1675
revision_ids = b.repository.get_ancestry(last_revision)
1677
for revision_id in revision_ids:
1678
self.outf.write(revision_id + '\n')
1681
class cmd_init(Command):
1682
"""Make a directory into a versioned branch.
1684
Use this to create an empty branch, or before importing an
1687
If there is a repository in a parent directory of the location, then
1688
the history of the branch will be stored in the repository. Otherwise
1689
init creates a standalone branch which carries its own history
1690
in the .bzr directory.
1692
If there is already a branch at the location but it has no working tree,
1693
the tree can be populated with 'bzr checkout'.
1695
Recipe for importing a tree of files::
1701
bzr commit -m "imported project"
1704
_see_also = ['init-repository', 'branch', 'checkout']
1705
takes_args = ['location?']
1707
Option('create-prefix',
1708
help='Create the path leading up to the branch '
1709
'if it does not already exist.'),
1710
RegistryOption('format',
1711
help='Specify a format for this branch. '
1712
'See "help formats".',
1713
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1714
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1715
value_switches=True,
1716
title="Branch format",
1718
Option('append-revisions-only',
1719
help='Never change revnos or the existing log.'
1720
' Append revisions to it only.')
1722
def run(self, location=None, format=None, append_revisions_only=False,
1723
create_prefix=False):
1725
format = bzrdir.format_registry.make_bzrdir('default')
1726
if location is None:
1729
to_transport = transport.get_transport(location)
1731
# The path has to exist to initialize a
1732
# branch inside of it.
1733
# Just using os.mkdir, since I don't
1734
# believe that we want to create a bunch of
1735
# locations if the user supplies an extended path
1737
to_transport.ensure_base()
1738
except errors.NoSuchFile:
1739
if not create_prefix:
1740
raise errors.BzrCommandError("Parent directory of %s"
1742
"\nYou may supply --create-prefix to create all"
1743
" leading parent directories."
1745
to_transport.create_prefix()
1748
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1749
except errors.NotBranchError:
1750
# really a NotBzrDir error...
1751
create_branch = bzrdir.BzrDir.create_branch_convenience
1752
branch = create_branch(to_transport.base, format=format,
1753
possible_transports=[to_transport])
1754
a_bzrdir = branch.bzrdir
1756
from bzrlib.transport.local import LocalTransport
1757
if a_bzrdir.has_branch():
1758
if (isinstance(to_transport, LocalTransport)
1759
and not a_bzrdir.has_workingtree()):
1760
raise errors.BranchExistsWithoutWorkingTree(location)
1761
raise errors.AlreadyBranchError(location)
1762
branch = a_bzrdir.create_branch()
1763
a_bzrdir.create_workingtree()
1764
if append_revisions_only:
1766
branch.set_append_revisions_only(True)
1767
except errors.UpgradeRequired:
1768
raise errors.BzrCommandError('This branch format cannot be set'
1769
' to append-revisions-only. Try --default.')
1771
from bzrlib.info import describe_layout, describe_format
1773
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1774
except (errors.NoWorkingTree, errors.NotLocalUrl):
1776
repository = branch.repository
1777
layout = describe_layout(repository, branch, tree).lower()
1778
format = describe_format(a_bzrdir, repository, branch, tree)
1779
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1780
if repository.is_shared():
1781
#XXX: maybe this can be refactored into transport.path_or_url()
1782
url = repository.bzrdir.root_transport.external_url()
1784
url = urlutils.local_path_from_url(url)
1785
except errors.InvalidURL:
1787
self.outf.write("Using shared repository: %s\n" % url)
1790
class cmd_init_repository(Command):
1791
"""Create a shared repository for branches to share storage space.
1793
New branches created under the repository directory will store their
1794
revisions in the repository, not in the branch directory. For branches
1795
with shared history, this reduces the amount of storage needed and
1796
speeds up the creation of new branches.
1798
If the --no-trees option is given then the branches in the repository
1799
will not have working trees by default. They will still exist as
1800
directories on disk, but they will not have separate copies of the
1801
files at a certain revision. This can be useful for repositories that
1802
store branches which are interacted with through checkouts or remote
1803
branches, such as on a server.
1806
Create a shared repository holding just branches::
1808
bzr init-repo --no-trees repo
1811
Make a lightweight checkout elsewhere::
1813
bzr checkout --lightweight repo/trunk trunk-checkout
1818
_see_also = ['init', 'branch', 'checkout', 'repositories']
1819
takes_args = ["location"]
1820
takes_options = [RegistryOption('format',
1821
help='Specify a format for this repository. See'
1822
' "bzr help formats" for details.',
1823
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1824
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1825
value_switches=True, title='Repository format'),
1827
help='Branches in the repository will default to'
1828
' not having a working tree.'),
1830
aliases = ["init-repo"]
1832
def run(self, location, format=None, no_trees=False):
1834
format = bzrdir.format_registry.make_bzrdir('default')
1836
if location is None:
1839
to_transport = transport.get_transport(location)
1840
to_transport.ensure_base()
1842
newdir = format.initialize_on_transport(to_transport)
1843
repo = newdir.create_repository(shared=True)
1844
repo.set_make_working_trees(not no_trees)
1846
from bzrlib.info import show_bzrdir_info
1847
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1850
class cmd_diff(Command):
1851
"""Show differences in the working tree, between revisions or branches.
1853
If no arguments are given, all changes for the current tree are listed.
1854
If files are given, only the changes in those files are listed.
1855
Remote and multiple branches can be compared by using the --old and
1856
--new options. If not provided, the default for both is derived from
1857
the first argument, if any, or the current tree if no arguments are
1860
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1861
produces patches suitable for "patch -p1".
1865
2 - unrepresentable changes
1870
Shows the difference in the working tree versus the last commit::
1874
Difference between the working tree and revision 1::
1878
Difference between revision 3 and revision 1::
1882
Difference between revision 3 and revision 1 for branch xxx::
1886
To see the changes introduced in revision X::
1890
Note that in the case of a merge, the -c option shows the changes
1891
compared to the left hand parent. To see the changes against
1892
another parent, use::
1894
bzr diff -r<chosen_parent>..X
1896
The changes introduced by revision 2 (equivalent to -r1..2)::
1900
Show just the differences for file NEWS::
1904
Show the differences in working tree xxx for file NEWS::
1908
Show the differences from branch xxx to this working tree:
1912
Show the differences between two branches for file NEWS::
1914
bzr diff --old xxx --new yyy NEWS
1916
Same as 'bzr diff' but prefix paths with old/ and new/::
1918
bzr diff --prefix old/:new/
1920
_see_also = ['status']
1921
takes_args = ['file*']
1923
Option('diff-options', type=str,
1924
help='Pass these options to the external diff program.'),
1925
Option('prefix', type=str,
1927
help='Set prefixes added to old and new filenames, as '
1928
'two values separated by a colon. (eg "old/:new/").'),
1930
help='Branch/tree to compare from.',
1934
help='Branch/tree to compare to.',
1940
help='Use this command to compare files.',
1944
aliases = ['di', 'dif']
1945
encoding_type = 'exact'
1948
def run(self, revision=None, file_list=None, diff_options=None,
1949
prefix=None, old=None, new=None, using=None):
1950
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1952
if (prefix is None) or (prefix == '0'):
1960
old_label, new_label = prefix.split(":")
1962
raise errors.BzrCommandError(
1963
'--prefix expects two values separated by a colon'
1964
' (eg "old/:new/")')
1966
if revision and len(revision) > 2:
1967
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1968
' one or two revision specifiers')
1970
(old_tree, new_tree,
1971
old_branch, new_branch,
1972
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1973
file_list, revision, old, new, apply_view=True)
1974
return show_diff_trees(old_tree, new_tree, sys.stdout,
1975
specific_files=specific_files,
1976
external_diff_options=diff_options,
1977
old_label=old_label, new_label=new_label,
1978
extra_trees=extra_trees, using=using)
1981
class cmd_deleted(Command):
1982
"""List files deleted in the working tree.
1984
# TODO: Show files deleted since a previous revision, or
1985
# between two revisions.
1986
# TODO: Much more efficient way to do this: read in new
1987
# directories with readdir, rather than stating each one. Same
1988
# level of effort but possibly much less IO. (Or possibly not,
1989
# if the directories are very large...)
1990
_see_also = ['status', 'ls']
1991
takes_options = ['show-ids']
1994
def run(self, show_ids=False):
1995
tree = WorkingTree.open_containing(u'.')[0]
1998
old = tree.basis_tree()
2001
for path, ie in old.inventory.iter_entries():
2002
if not tree.has_id(ie.file_id):
2003
self.outf.write(path)
2005
self.outf.write(' ')
2006
self.outf.write(ie.file_id)
2007
self.outf.write('\n')
2014
class cmd_modified(Command):
2015
"""List files modified in working tree.
2019
_see_also = ['status', 'ls']
2022
help='Write an ascii NUL (\\0) separator '
2023
'between files rather than a newline.')
2027
def run(self, null=False):
2028
tree = WorkingTree.open_containing(u'.')[0]
2029
td = tree.changes_from(tree.basis_tree())
2030
for path, id, kind, text_modified, meta_modified in td.modified:
2032
self.outf.write(path + '\0')
2034
self.outf.write(osutils.quotefn(path) + '\n')
2037
class cmd_added(Command):
2038
"""List files added in working tree.
2042
_see_also = ['status', 'ls']
2045
help='Write an ascii NUL (\\0) separator '
2046
'between files rather than a newline.')
2050
def run(self, null=False):
2051
wt = WorkingTree.open_containing(u'.')[0]
2054
basis = wt.basis_tree()
2057
basis_inv = basis.inventory
2060
if file_id in basis_inv:
2062
if inv.is_root(file_id) and len(basis_inv) == 0:
2064
path = inv.id2path(file_id)
2065
if not os.access(osutils.abspath(path), os.F_OK):
2068
self.outf.write(path + '\0')
2070
self.outf.write(osutils.quotefn(path) + '\n')
2077
class cmd_root(Command):
2078
"""Show the tree root directory.
2080
The root is the nearest enclosing directory with a .bzr control
2083
takes_args = ['filename?']
2085
def run(self, filename=None):
2086
"""Print the branch root."""
2087
tree = WorkingTree.open_containing(filename)[0]
2088
self.outf.write(tree.basedir + '\n')
2091
def _parse_limit(limitstring):
2093
return int(limitstring)
2095
msg = "The limit argument must be an integer."
2096
raise errors.BzrCommandError(msg)
2099
def _parse_levels(s):
2103
msg = "The levels argument must be an integer."
2104
raise errors.BzrCommandError(msg)
2107
class cmd_log(Command):
2108
"""Show historical log for a branch or subset of a branch.
2110
log is bzr's default tool for exploring the history of a branch.
2111
The branch to use is taken from the first parameter. If no parameters
2112
are given, the branch containing the working directory is logged.
2113
Here are some simple examples::
2115
bzr log log the current branch
2116
bzr log foo.py log a file in its branch
2117
bzr log http://server/branch log a branch on a server
2119
The filtering, ordering and information shown for each revision can
2120
be controlled as explained below. By default, all revisions are
2121
shown sorted (topologically) so that newer revisions appear before
2122
older ones and descendants always appear before ancestors. If displayed,
2123
merged revisions are shown indented under the revision in which they
2128
The log format controls how information about each revision is
2129
displayed. The standard log formats are called ``long``, ``short``
2130
and ``line``. The default is long. See ``bzr help log-formats``
2131
for more details on log formats.
2133
The following options can be used to control what information is
2136
-l N display a maximum of N revisions
2137
-n N display N levels of revisions (0 for all, 1 for collapsed)
2138
-v display a status summary (delta) for each revision
2139
-p display a diff (patch) for each revision
2140
--show-ids display revision-ids (and file-ids), not just revnos
2142
Note that the default number of levels to display is a function of the
2143
log format. If the -n option is not used, the standard log formats show
2144
just the top level (mainline).
2146
Status summaries are shown using status flags like A, M, etc. To see
2147
the changes explained using words like ``added`` and ``modified``
2148
instead, use the -vv option.
2152
To display revisions from oldest to newest, use the --forward option.
2153
In most cases, using this option will have little impact on the total
2154
time taken to produce a log, though --forward does not incrementally
2155
display revisions like --reverse does when it can.
2157
:Revision filtering:
2159
The -r option can be used to specify what revision or range of revisions
2160
to filter against. The various forms are shown below::
2162
-rX display revision X
2163
-rX.. display revision X and later
2164
-r..Y display up to and including revision Y
2165
-rX..Y display from X to Y inclusive
2167
See ``bzr help revisionspec`` for details on how to specify X and Y.
2168
Some common examples are given below::
2170
-r-1 show just the tip
2171
-r-10.. show the last 10 mainline revisions
2172
-rsubmit:.. show what's new on this branch
2173
-rancestor:path.. show changes since the common ancestor of this
2174
branch and the one at location path
2175
-rdate:yesterday.. show changes since yesterday
2177
When logging a range of revisions using -rX..Y, log starts at
2178
revision Y and searches back in history through the primary
2179
("left-hand") parents until it finds X. When logging just the
2180
top level (using -n1), an error is reported if X is not found
2181
along the way. If multi-level logging is used (-n0), X may be
2182
a nested merge revision and the log will be truncated accordingly.
2186
If parameters are given and the first one is not a branch, the log
2187
will be filtered to show only those revisions that changed the
2188
nominated files or directories.
2190
Filenames are interpreted within their historical context. To log a
2191
deleted file, specify a revision range so that the file existed at
2192
the end or start of the range.
2194
Historical context is also important when interpreting pathnames of
2195
renamed files/directories. Consider the following example:
2197
* revision 1: add tutorial.txt
2198
* revision 2: modify tutorial.txt
2199
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2203
* ``bzr log guide.txt`` will log the file added in revision 1
2205
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2207
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2208
the original file in revision 2.
2210
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2211
was no file called guide.txt in revision 2.
2213
Renames are always followed by log. By design, there is no need to
2214
explicitly ask for this (and no way to stop logging a file back
2215
until it was last renamed).
2219
The --message option can be used for finding revisions that match a
2220
regular expression in a commit message.
2224
GUI tools and IDEs are often better at exploring history than command
2225
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2226
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2227
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2229
Web interfaces are often better at exploring history than command line
2230
tools, particularly for branches on servers. You may prefer Loggerhead
2231
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2233
You may find it useful to add the aliases below to ``bazaar.conf``::
2237
top = log -l10 --line
2240
``bzr tip`` will then show the latest revision while ``bzr top``
2241
will show the last 10 mainline revisions. To see the details of a
2242
particular revision X, ``bzr show -rX``.
2244
If you are interested in looking deeper into a particular merge X,
2245
use ``bzr log -n0 -rX``.
2247
``bzr log -v`` on a branch with lots of history is currently
2248
very slow. A fix for this issue is currently under development.
2249
With or without that fix, it is recommended that a revision range
2250
be given when using the -v option.
2252
bzr has a generic full-text matching plugin, bzr-search, that can be
2253
used to find revisions matching user names, commit messages, etc.
2254
Among other features, this plugin can find all revisions containing
2255
a list of words but not others.
2257
When exploring non-mainline history on large projects with deep
2258
history, the performance of log can be greatly improved by installing
2259
the historycache plugin. This plugin buffers historical information
2260
trading disk space for faster speed.
2262
takes_args = ['file*']
2263
_see_also = ['log-formats', 'revisionspec']
2266
help='Show from oldest to newest.'),
2268
custom_help('verbose',
2269
help='Show files changed in each revision.'),
2273
type=bzrlib.option._parse_revision_str,
2275
help='Show just the specified revision.'
2276
' See also "help revisionspec".'),
2280
help='Number of levels to display - 0 for all, 1 for flat.',
2282
type=_parse_levels),
2285
help='Show revisions whose message matches this '
2286
'regular expression.',
2290
help='Limit the output to the first N revisions.',
2295
help='Show changes made in each revision as a patch.'),
2296
Option('include-merges',
2297
help='Show merged revisions like --levels 0 does.'),
2299
encoding_type = 'replace'
2302
def run(self, file_list=None, timezone='original',
2313
include_merges=False):
2314
from bzrlib.log import (
2316
make_log_request_dict,
2317
_get_info_for_log_files,
2319
direction = (forward and 'forward') or 'reverse'
2324
raise errors.BzrCommandError(
2325
'--levels and --include-merges are mutually exclusive')
2327
if change is not None:
2329
raise errors.RangeInChangeOption()
2330
if revision is not None:
2331
raise errors.BzrCommandError(
2332
'--revision and --change are mutually exclusive')
2337
filter_by_dir = False
2341
# find the file ids to log and check for directory filtering
2342
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2343
revision, file_list)
2344
for relpath, file_id, kind in file_info_list:
2346
raise errors.BzrCommandError(
2347
"Path unknown at end or start of revision range: %s" %
2349
# If the relpath is the top of the tree, we log everything
2354
file_ids.append(file_id)
2355
filter_by_dir = filter_by_dir or (
2356
kind in ['directory', 'tree-reference'])
2359
# FIXME ? log the current subdir only RBC 20060203
2360
if revision is not None \
2361
and len(revision) > 0 and revision[0].get_branch():
2362
location = revision[0].get_branch()
2365
dir, relpath = bzrdir.BzrDir.open_containing(location)
2366
b = dir.open_branch()
2368
rev1, rev2 = _get_revision_range(revision, b, self.name())
2370
# Decide on the type of delta & diff filtering to use
2371
# TODO: add an --all-files option to make this configurable & consistent
2379
diff_type = 'partial'
2383
# Build the log formatter
2384
if log_format is None:
2385
log_format = log.log_formatter_registry.get_default(b)
2386
# Make a non-encoding output to include the diffs - bug 328007
2387
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2388
lf = log_format(show_ids=show_ids, to_file=self.outf,
2389
to_exact_file=unencoded_output,
2390
show_timezone=timezone,
2391
delta_format=get_verbosity_level(),
2393
show_advice=levels is None)
2395
# Choose the algorithm for doing the logging. It's annoying
2396
# having multiple code paths like this but necessary until
2397
# the underlying repository format is faster at generating
2398
# deltas or can provide everything we need from the indices.
2399
# The default algorithm - match-using-deltas - works for
2400
# multiple files and directories and is faster for small
2401
# amounts of history (200 revisions say). However, it's too
2402
# slow for logging a single file in a repository with deep
2403
# history, i.e. > 10K revisions. In the spirit of "do no
2404
# evil when adding features", we continue to use the
2405
# original algorithm - per-file-graph - for the "single
2406
# file that isn't a directory without showing a delta" case.
2407
partial_history = revision and b.repository._format.supports_chks
2408
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2409
or delta_type or partial_history)
2411
# Build the LogRequest and execute it
2412
if len(file_ids) == 0:
2414
rqst = make_log_request_dict(
2415
direction=direction, specific_fileids=file_ids,
2416
start_revision=rev1, end_revision=rev2, limit=limit,
2417
message_search=message, delta_type=delta_type,
2418
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2419
Logger(b, rqst).show(lf)
2425
def _get_revision_range(revisionspec_list, branch, command_name):
2426
"""Take the input of a revision option and turn it into a revision range.
2428
It returns RevisionInfo objects which can be used to obtain the rev_id's
2429
of the desired revisions. It does some user input validations.
2431
if revisionspec_list is None:
2434
elif len(revisionspec_list) == 1:
2435
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2436
elif len(revisionspec_list) == 2:
2437
start_spec = revisionspec_list[0]
2438
end_spec = revisionspec_list[1]
2439
if end_spec.get_branch() != start_spec.get_branch():
2440
# b is taken from revision[0].get_branch(), and
2441
# show_log will use its revision_history. Having
2442
# different branches will lead to weird behaviors.
2443
raise errors.BzrCommandError(
2444
"bzr %s doesn't accept two revisions in different"
2445
" branches." % command_name)
2446
rev1 = start_spec.in_history(branch)
2447
# Avoid loading all of history when we know a missing
2448
# end of range means the last revision ...
2449
if end_spec.spec is None:
2450
last_revno, last_revision_id = branch.last_revision_info()
2451
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2453
rev2 = end_spec.in_history(branch)
2455
raise errors.BzrCommandError(
2456
'bzr %s --revision takes one or two values.' % command_name)
2460
def _revision_range_to_revid_range(revision_range):
2463
if revision_range[0] is not None:
2464
rev_id1 = revision_range[0].rev_id
2465
if revision_range[1] is not None:
2466
rev_id2 = revision_range[1].rev_id
2467
return rev_id1, rev_id2
2469
def get_log_format(long=False, short=False, line=False, default='long'):
2470
log_format = default
2474
log_format = 'short'
2480
class cmd_touching_revisions(Command):
2481
"""Return revision-ids which affected a particular file.
2483
A more user-friendly interface is "bzr log FILE".
2487
takes_args = ["filename"]
2490
def run(self, filename):
2491
tree, relpath = WorkingTree.open_containing(filename)
2492
file_id = tree.path2id(relpath)
2496
touching_revs = log.find_touching_revisions(b, file_id)
2497
for revno, revision_id, what in touching_revs:
2498
self.outf.write("%6d %s\n" % (revno, what))
2503
class cmd_ls(Command):
2504
"""List files in a tree.
2507
_see_also = ['status', 'cat']
2508
takes_args = ['path?']
2512
Option('recursive', short_name='R',
2513
help='Recurse into subdirectories.'),
2515
help='Print paths relative to the root of the branch.'),
2516
Option('unknown', help='Print unknown files.'),
2517
Option('versioned', help='Print versioned files.',
2519
Option('ignored', help='Print ignored files.'),
2521
help='Write an ascii NUL (\\0) separator '
2522
'between files rather than a newline.'),
2524
help='List entries of a particular kind: file, directory, symlink.',
2529
def run(self, revision=None, verbose=False,
2530
recursive=False, from_root=False,
2531
unknown=False, versioned=False, ignored=False,
2532
null=False, kind=None, show_ids=False, path=None):
2534
if kind and kind not in ('file', 'directory', 'symlink'):
2535
raise errors.BzrCommandError('invalid kind specified')
2537
if verbose and null:
2538
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2539
all = not (unknown or versioned or ignored)
2541
selection = {'I':ignored, '?':unknown, 'V':versioned}
2547
raise errors.BzrCommandError('cannot specify both --from-root'
2550
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2553
# Calculate the prefix to use
2557
prefix = relpath + '/'
2558
elif fs_path != '.' and not fs_path.endswith('/'):
2559
prefix = fs_path + '/'
2561
if revision is not None or tree is None:
2562
tree = _get_one_revision_tree('ls', revision, branch=branch)
2565
if isinstance(tree, WorkingTree) and tree.supports_views():
2566
view_files = tree.views.lookup_view()
2569
view_str = views.view_display_str(view_files)
2570
note("Ignoring files outside view. View is %s" % view_str)
2574
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2575
from_dir=relpath, recursive=recursive):
2576
# Apply additional masking
2577
if not all and not selection[fc]:
2579
if kind is not None and fkind != kind:
2584
fullpath = osutils.pathjoin(relpath, fp)
2587
views.check_path_in_view(tree, fullpath)
2588
except errors.FileOutsideView:
2593
fp = osutils.pathjoin(prefix, fp)
2594
kindch = entry.kind_character()
2595
outstring = fp + kindch
2596
ui.ui_factory.clear_term()
2598
outstring = '%-8s %s' % (fc, outstring)
2599
if show_ids and fid is not None:
2600
outstring = "%-50s %s" % (outstring, fid)
2601
self.outf.write(outstring + '\n')
2603
self.outf.write(fp + '\0')
2606
self.outf.write(fid)
2607
self.outf.write('\0')
2615
self.outf.write('%-50s %s\n' % (outstring, my_id))
2617
self.outf.write(outstring + '\n')
2622
class cmd_unknowns(Command):
2623
"""List unknown files.
2631
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2632
self.outf.write(osutils.quotefn(f) + '\n')
2635
class cmd_ignore(Command):
2636
"""Ignore specified files or patterns.
2638
See ``bzr help patterns`` for details on the syntax of patterns.
2640
If a .bzrignore file does not exist, the ignore command
2641
will create one and add the specified files or patterns to the newly
2642
created file. The ignore command will also automatically add the
2643
.bzrignore file to be versioned. Creating a .bzrignore file without
2644
the use of the ignore command will require an explicit add command.
2646
To remove patterns from the ignore list, edit the .bzrignore file.
2647
After adding, editing or deleting that file either indirectly by
2648
using this command or directly by using an editor, be sure to commit
2651
Note: ignore patterns containing shell wildcards must be quoted from
2655
Ignore the top level Makefile::
2657
bzr ignore ./Makefile
2659
Ignore class files in all directories::
2661
bzr ignore "*.class"
2663
Ignore .o files under the lib directory::
2665
bzr ignore "lib/**/*.o"
2667
Ignore .o files under the lib directory::
2669
bzr ignore "RE:lib/.*\.o"
2671
Ignore everything but the "debian" toplevel directory::
2673
bzr ignore "RE:(?!debian/).*"
2676
_see_also = ['status', 'ignored', 'patterns']
2677
takes_args = ['name_pattern*']
2679
Option('old-default-rules',
2680
help='Write out the ignore rules bzr < 0.9 always used.')
2683
def run(self, name_pattern_list=None, old_default_rules=None):
2684
from bzrlib import ignores
2685
if old_default_rules is not None:
2686
# dump the rules and exit
2687
for pattern in ignores.OLD_DEFAULTS:
2690
if not name_pattern_list:
2691
raise errors.BzrCommandError("ignore requires at least one "
2692
"NAME_PATTERN or --old-default-rules")
2693
name_pattern_list = [globbing.normalize_pattern(p)
2694
for p in name_pattern_list]
2695
for name_pattern in name_pattern_list:
2696
if (name_pattern[0] == '/' or
2697
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2698
raise errors.BzrCommandError(
2699
"NAME_PATTERN should not be an absolute path")
2700
tree, relpath = WorkingTree.open_containing(u'.')
2701
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2702
ignored = globbing.Globster(name_pattern_list)
2705
for entry in tree.list_files():
2709
if ignored.match(filename):
2710
matches.append(filename.encode('utf-8'))
2712
if len(matches) > 0:
2713
print "Warning: the following files are version controlled and" \
2714
" match your ignore pattern:\n%s" \
2715
"\nThese files will continue to be version controlled" \
2716
" unless you 'bzr remove' them." % ("\n".join(matches),)
2719
class cmd_ignored(Command):
2720
"""List ignored files and the patterns that matched them.
2722
List all the ignored files and the ignore pattern that caused the file to
2725
Alternatively, to list just the files::
2730
encoding_type = 'replace'
2731
_see_also = ['ignore', 'ls']
2735
tree = WorkingTree.open_containing(u'.')[0]
2738
for path, file_class, kind, file_id, entry in tree.list_files():
2739
if file_class != 'I':
2741
## XXX: Slightly inefficient since this was already calculated
2742
pat = tree.is_ignored(path)
2743
self.outf.write('%-50s %s\n' % (path, pat))
2748
class cmd_lookup_revision(Command):
2749
"""Lookup the revision-id from a revision-number
2752
bzr lookup-revision 33
2755
takes_args = ['revno']
2758
def run(self, revno):
2762
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2764
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2767
class cmd_export(Command):
2768
"""Export current or past revision to a destination directory or archive.
2770
If no revision is specified this exports the last committed revision.
2772
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2773
given, try to find the format with the extension. If no extension
2774
is found exports to a directory (equivalent to --format=dir).
2776
If root is supplied, it will be used as the root directory inside
2777
container formats (tar, zip, etc). If it is not supplied it will default
2778
to the exported filename. The root option has no effect for 'dir' format.
2780
If branch is omitted then the branch containing the current working
2781
directory will be used.
2783
Note: Export of tree with non-ASCII filenames to zip is not supported.
2785
================= =========================
2786
Supported formats Autodetected by extension
2787
================= =========================
2790
tbz2 .tar.bz2, .tbz2
2793
================= =========================
2795
takes_args = ['dest', 'branch_or_subdir?']
2798
help="Type of file to export to.",
2801
Option('filters', help='Apply content filters to export the '
2802
'convenient form.'),
2805
help="Name of the root directory inside the exported file."),
2807
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2808
root=None, filters=False):
2809
from bzrlib.export import export
2811
if branch_or_subdir is None:
2812
tree = WorkingTree.open_containing(u'.')[0]
2816
b, subdir = Branch.open_containing(branch_or_subdir)
2819
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2821
export(rev_tree, dest, format, root, subdir, filtered=filters)
2822
except errors.NoSuchExportFormat, e:
2823
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2826
class cmd_cat(Command):
2827
"""Write the contents of a file as of a given revision to standard output.
2829
If no revision is nominated, the last revision is used.
2831
Note: Take care to redirect standard output when using this command on a
2837
Option('name-from-revision', help='The path name in the old tree.'),
2838
Option('filters', help='Apply content filters to display the '
2839
'convenience form.'),
2842
takes_args = ['filename']
2843
encoding_type = 'exact'
2846
def run(self, filename, revision=None, name_from_revision=False,
2848
if revision is not None and len(revision) != 1:
2849
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2850
" one revision specifier")
2851
tree, branch, relpath = \
2852
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2855
return self._run(tree, branch, relpath, filename, revision,
2856
name_from_revision, filters)
2860
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2863
tree = b.basis_tree()
2864
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2866
old_file_id = rev_tree.path2id(relpath)
2868
if name_from_revision:
2869
# Try in revision if requested
2870
if old_file_id is None:
2871
raise errors.BzrCommandError(
2872
"%r is not present in revision %s" % (
2873
filename, rev_tree.get_revision_id()))
2875
content = rev_tree.get_file_text(old_file_id)
2877
cur_file_id = tree.path2id(relpath)
2879
if cur_file_id is not None:
2880
# Then try with the actual file id
2882
content = rev_tree.get_file_text(cur_file_id)
2884
except errors.NoSuchId:
2885
# The actual file id didn't exist at that time
2887
if not found and old_file_id is not None:
2888
# Finally try with the old file id
2889
content = rev_tree.get_file_text(old_file_id)
2892
# Can't be found anywhere
2893
raise errors.BzrCommandError(
2894
"%r is not present in revision %s" % (
2895
filename, rev_tree.get_revision_id()))
2897
from bzrlib.filters import (
2898
ContentFilterContext,
2899
filtered_output_bytes,
2901
filters = rev_tree._content_filter_stack(relpath)
2902
chunks = content.splitlines(True)
2903
content = filtered_output_bytes(chunks, filters,
2904
ContentFilterContext(relpath, rev_tree))
2905
self.outf.writelines(content)
2907
self.outf.write(content)
2910
class cmd_local_time_offset(Command):
2911
"""Show the offset in seconds from GMT to local time."""
2915
print osutils.local_time_offset()
2919
class cmd_commit(Command):
2920
"""Commit changes into a new revision.
2922
An explanatory message needs to be given for each commit. This is
2923
often done by using the --message option (getting the message from the
2924
command line) or by using the --file option (getting the message from
2925
a file). If neither of these options is given, an editor is opened for
2926
the user to enter the message. To see the changed files in the
2927
boilerplate text loaded into the editor, use the --show-diff option.
2929
By default, the entire tree is committed and the person doing the
2930
commit is assumed to be the author. These defaults can be overridden
2935
If selected files are specified, only changes to those files are
2936
committed. If a directory is specified then the directory and
2937
everything within it is committed.
2939
When excludes are given, they take precedence over selected files.
2940
For example, to commit only changes within foo, but not changes
2943
bzr commit foo -x foo/bar
2945
A selective commit after a merge is not yet supported.
2949
If the author of the change is not the same person as the committer,
2950
you can specify the author's name using the --author option. The
2951
name should be in the same format as a committer-id, e.g.
2952
"John Doe <jdoe@example.com>". If there is more than one author of
2953
the change you can specify the option multiple times, once for each
2958
A common mistake is to forget to add a new file or directory before
2959
running the commit command. The --strict option checks for unknown
2960
files and aborts the commit if any are found. More advanced pre-commit
2961
checks can be implemented by defining hooks. See ``bzr help hooks``
2966
If you accidentially commit the wrong changes or make a spelling
2967
mistake in the commit message say, you can use the uncommit command
2968
to undo it. See ``bzr help uncommit`` for details.
2970
Hooks can also be configured to run after a commit. This allows you
2971
to trigger updates to external systems like bug trackers. The --fixes
2972
option can be used to record the association between a revision and
2973
one or more bugs. See ``bzr help bugs`` for details.
2975
A selective commit may fail in some cases where the committed
2976
tree would be invalid. Consider::
2981
bzr commit foo -m "committing foo"
2982
bzr mv foo/bar foo/baz
2985
bzr commit foo/bar -m "committing bar but not baz"
2987
In the example above, the last commit will fail by design. This gives
2988
the user the opportunity to decide whether they want to commit the
2989
rename at the same time, separately first, or not at all. (As a general
2990
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2992
# TODO: Run hooks on tree to-be-committed, and after commit.
2994
# TODO: Strict commit that fails if there are deleted files.
2995
# (what does "deleted files" mean ??)
2997
# TODO: Give better message for -s, --summary, used by tla people
2999
# XXX: verbose currently does nothing
3001
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3002
takes_args = ['selected*']
3004
ListOption('exclude', type=str, short_name='x',
3005
help="Do not consider changes made to a given path."),
3006
Option('message', type=unicode,
3008
help="Description of the new revision."),
3011
help='Commit even if nothing has changed.'),
3012
Option('file', type=str,
3015
help='Take commit message from this file.'),
3017
help="Refuse to commit if there are unknown "
3018
"files in the working tree."),
3019
Option('commit-time', type=str,
3020
help="Manually set a commit time using commit date "
3021
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3022
ListOption('fixes', type=str,
3023
help="Mark a bug as being fixed by this revision "
3024
"(see \"bzr help bugs\")."),
3025
ListOption('author', type=unicode,
3026
help="Set the author's name, if it's different "
3027
"from the committer."),
3029
help="Perform a local commit in a bound "
3030
"branch. Local commits are not pushed to "
3031
"the master branch until a normal commit "
3035
help='When no message is supplied, show the diff along'
3036
' with the status summary in the message editor.'),
3038
aliases = ['ci', 'checkin']
3040
def _iter_bug_fix_urls(self, fixes, branch):
3041
# Configure the properties for bug fixing attributes.
3042
for fixed_bug in fixes:
3043
tokens = fixed_bug.split(':')
3044
if len(tokens) != 2:
3045
raise errors.BzrCommandError(
3046
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3047
"See \"bzr help bugs\" for more information on this "
3048
"feature.\nCommit refused." % fixed_bug)
3049
tag, bug_id = tokens
3051
yield bugtracker.get_bug_url(tag, branch, bug_id)
3052
except errors.UnknownBugTrackerAbbreviation:
3053
raise errors.BzrCommandError(
3054
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3055
except errors.MalformedBugIdentifier, e:
3056
raise errors.BzrCommandError(
3057
"%s\nCommit refused." % (str(e),))
3059
def run(self, message=None, file=None, verbose=False, selected_list=None,
3060
unchanged=False, strict=False, local=False, fixes=None,
3061
author=None, show_diff=False, exclude=None, commit_time=None):
3062
from bzrlib.errors import (
3067
from bzrlib.msgeditor import (
3068
edit_commit_message_encoded,
3069
generate_commit_message_template,
3070
make_commit_message_template_encoded
3073
commit_stamp = offset = None
3074
if commit_time is not None:
3076
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3077
except ValueError, e:
3078
raise errors.BzrCommandError(
3079
"Could not parse --commit-time: " + str(e))
3081
# TODO: Need a blackbox test for invoking the external editor; may be
3082
# slightly problematic to run this cross-platform.
3084
# TODO: do more checks that the commit will succeed before
3085
# spending the user's valuable time typing a commit message.
3089
tree, selected_list = tree_files(selected_list)
3090
if selected_list == ['']:
3091
# workaround - commit of root of tree should be exactly the same
3092
# as just default commit in that tree, and succeed even though
3093
# selected-file merge commit is not done yet
3098
bug_property = bugtracker.encode_fixes_bug_urls(
3099
self._iter_bug_fix_urls(fixes, tree.branch))
3101
properties['bugs'] = bug_property
3103
if local and not tree.branch.get_bound_location():
3104
raise errors.LocalRequiresBoundBranch()
3106
if message is not None:
3108
file_exists = osutils.lexists(message)
3109
except UnicodeError:
3110
# The commit message contains unicode characters that can't be
3111
# represented in the filesystem encoding, so that can't be a
3116
'The commit message is a file name: "%(f)s".\n'
3117
'(use --file "%(f)s" to take commit message from that file)'
3119
ui.ui_factory.show_warning(warning_msg)
3121
def get_message(commit_obj):
3122
"""Callback to get commit message"""
3123
my_message = message
3124
if my_message is not None and '\r' in my_message:
3125
my_message = my_message.replace('\r\n', '\n')
3126
my_message = my_message.replace('\r', '\n')
3127
if my_message is None and not file:
3128
t = make_commit_message_template_encoded(tree,
3129
selected_list, diff=show_diff,
3130
output_encoding=osutils.get_user_encoding())
3131
start_message = generate_commit_message_template(commit_obj)
3132
my_message = edit_commit_message_encoded(t,
3133
start_message=start_message)
3134
if my_message is None:
3135
raise errors.BzrCommandError("please specify a commit"
3136
" message with either --message or --file")
3137
elif my_message and file:
3138
raise errors.BzrCommandError(
3139
"please specify either --message or --file")
3141
my_message = codecs.open(file, 'rt',
3142
osutils.get_user_encoding()).read()
3143
if my_message == "":
3144
raise errors.BzrCommandError("empty commit message specified")
3147
# The API permits a commit with a filter of [] to mean 'select nothing'
3148
# but the command line should not do that.
3149
if not selected_list:
3150
selected_list = None
3152
tree.commit(message_callback=get_message,
3153
specific_files=selected_list,
3154
allow_pointless=unchanged, strict=strict, local=local,
3155
reporter=None, verbose=verbose, revprops=properties,
3156
authors=author, timestamp=commit_stamp,
3158
exclude=safe_relpath_files(tree, exclude))
3159
except PointlessCommit:
3160
# FIXME: This should really happen before the file is read in;
3161
# perhaps prepare the commit; get the message; then actually commit
3162
raise errors.BzrCommandError("No changes to commit."
3163
" Use --unchanged to commit anyhow.")
3164
except ConflictsInTree:
3165
raise errors.BzrCommandError('Conflicts detected in working '
3166
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3168
except StrictCommitFailed:
3169
raise errors.BzrCommandError("Commit refused because there are"
3170
" unknown files in the working tree.")
3171
except errors.BoundBranchOutOfDate, e:
3172
raise errors.BzrCommandError(str(e) + "\n"
3173
'To commit to master branch, run update and then commit.\n'
3174
'You can also pass --local to commit to continue working '
3178
class cmd_check(Command):
3179
"""Validate working tree structure, branch consistency and repository history.
3181
This command checks various invariants about branch and repository storage
3182
to detect data corruption or bzr bugs.
3184
The working tree and branch checks will only give output if a problem is
3185
detected. The output fields of the repository check are:
3188
This is just the number of revisions checked. It doesn't
3192
This is just the number of versionedfiles checked. It
3193
doesn't indicate a problem.
3195
unreferenced ancestors
3196
Texts that are ancestors of other texts, but
3197
are not properly referenced by the revision ancestry. This is a
3198
subtle problem that Bazaar can work around.
3201
This is the total number of unique file contents
3202
seen in the checked revisions. It does not indicate a problem.
3205
This is the total number of repeated texts seen
3206
in the checked revisions. Texts can be repeated when their file
3207
entries are modified, but the file contents are not. It does not
3210
If no restrictions are specified, all Bazaar data that is found at the given
3211
location will be checked.
3215
Check the tree and branch at 'foo'::
3217
bzr check --tree --branch foo
3219
Check only the repository at 'bar'::
3221
bzr check --repo bar
3223
Check everything at 'baz'::
3228
_see_also = ['reconcile']
3229
takes_args = ['path?']
3230
takes_options = ['verbose',
3231
Option('branch', help="Check the branch related to the"
3232
" current directory."),
3233
Option('repo', help="Check the repository related to the"
3234
" current directory."),
3235
Option('tree', help="Check the working tree related to"
3236
" the current directory.")]
3238
def run(self, path=None, verbose=False, branch=False, repo=False,
3240
from bzrlib.check import check_dwim
3243
if not branch and not repo and not tree:
3244
branch = repo = tree = True
3245
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3248
class cmd_upgrade(Command):
3249
"""Upgrade branch storage to current format.
3251
The check command or bzr developers may sometimes advise you to run
3252
this command. When the default format has changed you may also be warned
3253
during other operations to upgrade.
3256
_see_also = ['check']
3257
takes_args = ['url?']
3259
RegistryOption('format',
3260
help='Upgrade to a specific format. See "bzr help'
3261
' formats" for details.',
3262
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3263
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3264
value_switches=True, title='Branch format'),
3267
def run(self, url='.', format=None):
3268
from bzrlib.upgrade import upgrade
3269
upgrade(url, format)
3272
class cmd_whoami(Command):
3273
"""Show or set bzr user id.
3276
Show the email of the current user::
3280
Set the current user::
3282
bzr whoami "Frank Chu <fchu@example.com>"
3284
takes_options = [ Option('email',
3285
help='Display email address only.'),
3287
help='Set identity for the current branch instead of '
3290
takes_args = ['name?']
3291
encoding_type = 'replace'
3294
def run(self, email=False, branch=False, name=None):
3296
# use branch if we're inside one; otherwise global config
3298
c = Branch.open_containing('.')[0].get_config()
3299
except errors.NotBranchError:
3300
c = config.GlobalConfig()
3302
self.outf.write(c.user_email() + '\n')
3304
self.outf.write(c.username() + '\n')
3307
# display a warning if an email address isn't included in the given name.
3309
config.extract_email_address(name)
3310
except errors.NoEmailInUsername, e:
3311
warning('"%s" does not seem to contain an email address. '
3312
'This is allowed, but not recommended.', name)
3314
# use global config unless --branch given
3316
c = Branch.open_containing('.')[0].get_config()
3318
c = config.GlobalConfig()
3319
c.set_user_option('email', name)
3322
class cmd_nick(Command):
3323
"""Print or set the branch nickname.
3325
If unset, the tree root directory name is used as the nickname.
3326
To print the current nickname, execute with no argument.
3328
Bound branches use the nickname of its master branch unless it is set
3332
_see_also = ['info']
3333
takes_args = ['nickname?']
3334
def run(self, nickname=None):
3335
branch = Branch.open_containing(u'.')[0]
3336
if nickname is None:
3337
self.printme(branch)
3339
branch.nick = nickname
3342
def printme(self, branch):
3346
class cmd_alias(Command):
3347
"""Set/unset and display aliases.
3350
Show the current aliases::
3354
Show the alias specified for 'll'::
3358
Set an alias for 'll'::
3360
bzr alias ll="log --line -r-10..-1"
3362
To remove an alias for 'll'::
3364
bzr alias --remove ll
3367
takes_args = ['name?']
3369
Option('remove', help='Remove the alias.'),
3372
def run(self, name=None, remove=False):
3374
self.remove_alias(name)
3376
self.print_aliases()
3378
equal_pos = name.find('=')
3380
self.print_alias(name)
3382
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3384
def remove_alias(self, alias_name):
3385
if alias_name is None:
3386
raise errors.BzrCommandError(
3387
'bzr alias --remove expects an alias to remove.')
3388
# If alias is not found, print something like:
3389
# unalias: foo: not found
3390
c = config.GlobalConfig()
3391
c.unset_alias(alias_name)
3394
def print_aliases(self):
3395
"""Print out the defined aliases in a similar format to bash."""
3396
aliases = config.GlobalConfig().get_aliases()
3397
for key, value in sorted(aliases.iteritems()):
3398
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3401
def print_alias(self, alias_name):
3402
from bzrlib.commands import get_alias
3403
alias = get_alias(alias_name)
3405
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3408
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3410
def set_alias(self, alias_name, alias_command):
3411
"""Save the alias in the global config."""
3412
c = config.GlobalConfig()
3413
c.set_alias(alias_name, alias_command)
3416
class cmd_selftest(Command):
3417
"""Run internal test suite.
3419
If arguments are given, they are regular expressions that say which tests
3420
should run. Tests matching any expression are run, and other tests are
3423
Alternatively if --first is given, matching tests are run first and then
3424
all other tests are run. This is useful if you have been working in a
3425
particular area, but want to make sure nothing else was broken.
3427
If --exclude is given, tests that match that regular expression are
3428
excluded, regardless of whether they match --first or not.
3430
To help catch accidential dependencies between tests, the --randomize
3431
option is useful. In most cases, the argument used is the word 'now'.
3432
Note that the seed used for the random number generator is displayed
3433
when this option is used. The seed can be explicitly passed as the
3434
argument to this option if required. This enables reproduction of the
3435
actual ordering used if and when an order sensitive problem is encountered.
3437
If --list-only is given, the tests that would be run are listed. This is
3438
useful when combined with --first, --exclude and/or --randomize to
3439
understand their impact. The test harness reports "Listed nn tests in ..."
3440
instead of "Ran nn tests in ..." when list mode is enabled.
3442
If the global option '--no-plugins' is given, plugins are not loaded
3443
before running the selftests. This has two effects: features provided or
3444
modified by plugins will not be tested, and tests provided by plugins will
3447
Tests that need working space on disk use a common temporary directory,
3448
typically inside $TMPDIR or /tmp.
3450
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3451
into a pdb postmortem session.
3454
Run only tests relating to 'ignore'::
3458
Disable plugins and list tests as they're run::
3460
bzr --no-plugins selftest -v
3462
# NB: this is used from the class without creating an instance, which is
3463
# why it does not have a self parameter.
3464
def get_transport_type(typestring):
3465
"""Parse and return a transport specifier."""
3466
if typestring == "sftp":
3467
from bzrlib.transport.sftp import SFTPAbsoluteServer
3468
return SFTPAbsoluteServer
3469
if typestring == "memory":
3470
from bzrlib.transport.memory import MemoryServer
3472
if typestring == "fakenfs":
3473
from bzrlib.transport.fakenfs import FakeNFSServer
3474
return FakeNFSServer
3475
msg = "No known transport type %s. Supported types are: sftp\n" %\
3477
raise errors.BzrCommandError(msg)
3480
takes_args = ['testspecs*']
3481
takes_options = ['verbose',
3483
help='Stop when one test fails.',
3487
help='Use a different transport by default '
3488
'throughout the test suite.',
3489
type=get_transport_type),
3491
help='Run the benchmarks rather than selftests.'),
3492
Option('lsprof-timed',
3493
help='Generate lsprof output for benchmarked'
3494
' sections of code.'),
3495
Option('lsprof-tests',
3496
help='Generate lsprof output for each test.'),
3497
Option('cache-dir', type=str,
3498
help='Cache intermediate benchmark output in this '
3501
help='Run all tests, but run specified tests first.',
3505
help='List the tests instead of running them.'),
3506
RegistryOption('parallel',
3507
help="Run the test suite in parallel.",
3508
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3509
value_switches=False,
3511
Option('randomize', type=str, argname="SEED",
3512
help='Randomize the order of tests using the given'
3513
' seed or "now" for the current time.'),
3514
Option('exclude', type=str, argname="PATTERN",
3516
help='Exclude tests that match this regular'
3519
help='Output test progress via subunit.'),
3520
Option('strict', help='Fail on missing dependencies or '
3522
Option('load-list', type=str, argname='TESTLISTFILE',
3523
help='Load a test id list from a text file.'),
3524
ListOption('debugflag', type=str, short_name='E',
3525
help='Turn on a selftest debug flag.'),
3526
ListOption('starting-with', type=str, argname='TESTID',
3527
param_name='starting_with', short_name='s',
3529
'Load only the tests starting with TESTID.'),
3531
encoding_type = 'replace'
3534
Command.__init__(self)
3535
self.additional_selftest_args = {}
3537
def run(self, testspecs_list=None, verbose=False, one=False,
3538
transport=None, benchmark=None,
3539
lsprof_timed=None, cache_dir=None,
3540
first=False, list_only=False,
3541
randomize=None, exclude=None, strict=False,
3542
load_list=None, debugflag=None, starting_with=None, subunit=False,
3543
parallel=None, lsprof_tests=False):
3544
from bzrlib.tests import selftest
3545
import bzrlib.benchmarks as benchmarks
3546
from bzrlib.benchmarks import tree_creator
3548
# Make deprecation warnings visible, unless -Werror is set
3549
symbol_versioning.activate_deprecation_warnings(override=False)
3551
if cache_dir is not None:
3552
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3553
if testspecs_list is not None:
3554
pattern = '|'.join(testspecs_list)
3559
from bzrlib.tests import SubUnitBzrRunner
3561
raise errors.BzrCommandError("subunit not available. subunit "
3562
"needs to be installed to use --subunit.")
3563
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3565
self.additional_selftest_args.setdefault(
3566
'suite_decorators', []).append(parallel)
3568
test_suite_factory = benchmarks.test_suite
3569
# Unless user explicitly asks for quiet, be verbose in benchmarks
3570
verbose = not is_quiet()
3571
# TODO: should possibly lock the history file...
3572
benchfile = open(".perf_history", "at", buffering=1)
3574
test_suite_factory = None
3577
selftest_kwargs = {"verbose": verbose,
3579
"stop_on_failure": one,
3580
"transport": transport,
3581
"test_suite_factory": test_suite_factory,
3582
"lsprof_timed": lsprof_timed,
3583
"lsprof_tests": lsprof_tests,
3584
"bench_history": benchfile,
3585
"matching_tests_first": first,
3586
"list_only": list_only,
3587
"random_seed": randomize,
3588
"exclude_pattern": exclude,
3590
"load_list": load_list,
3591
"debug_flags": debugflag,
3592
"starting_with": starting_with
3594
selftest_kwargs.update(self.additional_selftest_args)
3595
result = selftest(**selftest_kwargs)
3597
if benchfile is not None:
3599
return int(not result)
3602
class cmd_version(Command):
3603
"""Show version of bzr."""
3605
encoding_type = 'replace'
3607
Option("short", help="Print just the version number."),
3611
def run(self, short=False):
3612
from bzrlib.version import show_version
3614
self.outf.write(bzrlib.version_string + '\n')
3616
show_version(to_file=self.outf)
3619
class cmd_rocks(Command):
3620
"""Statement of optimism."""
3626
print "It sure does!"
3629
class cmd_find_merge_base(Command):
3630
"""Find and print a base revision for merging two branches."""
3631
# TODO: Options to specify revisions on either side, as if
3632
# merging only part of the history.
3633
takes_args = ['branch', 'other']
3637
def run(self, branch, other):
3638
from bzrlib.revision import ensure_null
3640
branch1 = Branch.open_containing(branch)[0]
3641
branch2 = Branch.open_containing(other)[0]
3646
last1 = ensure_null(branch1.last_revision())
3647
last2 = ensure_null(branch2.last_revision())
3649
graph = branch1.repository.get_graph(branch2.repository)
3650
base_rev_id = graph.find_unique_lca(last1, last2)
3652
print 'merge base is revision %s' % base_rev_id
3659
class cmd_merge(Command):
3660
"""Perform a three-way merge.
3662
The source of the merge can be specified either in the form of a branch,
3663
or in the form of a path to a file containing a merge directive generated
3664
with bzr send. If neither is specified, the default is the upstream branch
3665
or the branch most recently merged using --remember.
3667
When merging a branch, by default the tip will be merged. To pick a different
3668
revision, pass --revision. If you specify two values, the first will be used as
3669
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3670
available revisions, like this is commonly referred to as "cherrypicking".
3672
Revision numbers are always relative to the branch being merged.
3674
By default, bzr will try to merge in all new work from the other
3675
branch, automatically determining an appropriate base. If this
3676
fails, you may need to give an explicit base.
3678
Merge will do its best to combine the changes in two branches, but there
3679
are some kinds of problems only a human can fix. When it encounters those,
3680
it will mark a conflict. A conflict means that you need to fix something,
3681
before you should commit.
3683
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3685
If there is no default branch set, the first merge will set it. After
3686
that, you can omit the branch to use the default. To change the
3687
default, use --remember. The value will only be saved if the remote
3688
location can be accessed.
3690
The results of the merge are placed into the destination working
3691
directory, where they can be reviewed (with bzr diff), tested, and then
3692
committed to record the result of the merge.
3694
merge refuses to run if there are any uncommitted changes, unless
3697
To select only some changes to merge, use "merge -i", which will prompt
3698
you to apply each diff hunk and file change, similar to "shelve".
3701
To merge the latest revision from bzr.dev::
3703
bzr merge ../bzr.dev
3705
To merge changes up to and including revision 82 from bzr.dev::
3707
bzr merge -r 82 ../bzr.dev
3709
To merge the changes introduced by 82, without previous changes::
3711
bzr merge -r 81..82 ../bzr.dev
3713
To apply a merge directive contained in /tmp/merge::
3715
bzr merge /tmp/merge
3718
encoding_type = 'exact'
3719
_see_also = ['update', 'remerge', 'status-flags', 'send']
3720
takes_args = ['location?']
3725
help='Merge even if the destination tree has uncommitted changes.'),
3729
Option('show-base', help="Show base revision text in "
3731
Option('uncommitted', help='Apply uncommitted changes'
3732
' from a working copy, instead of branch changes.'),
3733
Option('pull', help='If the destination is already'
3734
' completely merged into the source, pull from the'
3735
' source rather than merging. When this happens,'
3736
' you do not need to commit the result.'),
3738
help='Branch to merge into, '
3739
'rather than the one containing the working directory.',
3743
Option('preview', help='Instead of merging, show a diff of the'
3745
Option('interactive', help='Select changes interactively.',
3749
def run(self, location=None, revision=None, force=False,
3750
merge_type=None, show_base=False, reprocess=None, remember=False,
3751
uncommitted=False, pull=False,
3756
if merge_type is None:
3757
merge_type = _mod_merge.Merge3Merger
3759
if directory is None: directory = u'.'
3760
possible_transports = []
3762
allow_pending = True
3763
verified = 'inapplicable'
3764
tree = WorkingTree.open_containing(directory)[0]
3767
basis_tree = tree.revision_tree(tree.last_revision())
3768
except errors.NoSuchRevision:
3769
basis_tree = tree.basis_tree()
3771
# die as quickly as possible if there are uncommitted changes
3773
if tree.has_changes():
3774
raise errors.UncommittedChanges(tree)
3776
view_info = _get_view_info_for_change_reporter(tree)
3777
change_reporter = delta._ChangeReporter(
3778
unversioned_filter=tree.is_ignored, view_info=view_info)
3781
pb = ui.ui_factory.nested_progress_bar()
3782
cleanups.append(pb.finished)
3784
cleanups.append(tree.unlock)
3785
if location is not None:
3787
mergeable = bundle.read_mergeable_from_url(location,
3788
possible_transports=possible_transports)
3789
except errors.NotABundle:
3793
raise errors.BzrCommandError('Cannot use --uncommitted'
3794
' with bundles or merge directives.')
3796
if revision is not None:
3797
raise errors.BzrCommandError(
3798
'Cannot use -r with merge directives or bundles')
3799
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3802
if merger is None and uncommitted:
3803
if revision is not None and len(revision) > 0:
3804
raise errors.BzrCommandError('Cannot use --uncommitted and'
3805
' --revision at the same time.')
3806
merger = self.get_merger_from_uncommitted(tree, location, pb,
3808
allow_pending = False
3811
merger, allow_pending = self._get_merger_from_branch(tree,
3812
location, revision, remember, possible_transports, pb)
3814
merger.merge_type = merge_type
3815
merger.reprocess = reprocess
3816
merger.show_base = show_base
3817
self.sanity_check_merger(merger)
3818
if (merger.base_rev_id == merger.other_rev_id and
3819
merger.other_rev_id is not None):
3820
note('Nothing to do.')
3823
if merger.interesting_files is not None:
3824
raise errors.BzrCommandError('Cannot pull individual files')
3825
if (merger.base_rev_id == tree.last_revision()):
3826
result = tree.pull(merger.other_branch, False,
3827
merger.other_rev_id)
3828
result.report(self.outf)
3830
if merger.this_basis is None:
3831
raise errors.BzrCommandError(
3832
"This branch has no commits."
3833
" (perhaps you would prefer 'bzr pull')")
3835
return self._do_preview(merger, cleanups)
3837
return self._do_interactive(merger, cleanups)
3839
return self._do_merge(merger, change_reporter, allow_pending,
3842
for cleanup in reversed(cleanups):
3845
def _get_preview(self, merger, cleanups):
3846
tree_merger = merger.make_merger()
3847
tt = tree_merger.make_preview_transform()
3848
cleanups.append(tt.finalize)
3849
result_tree = tt.get_preview_tree()
3852
def _do_preview(self, merger, cleanups):
3853
from bzrlib.diff import show_diff_trees
3854
result_tree = self._get_preview(merger, cleanups)
3855
show_diff_trees(merger.this_tree, result_tree, self.outf,
3856
old_label='', new_label='')
3858
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3859
merger.change_reporter = change_reporter
3860
conflict_count = merger.do_merge()
3862
merger.set_pending()
3863
if verified == 'failed':
3864
warning('Preview patch does not match changes')
3865
if conflict_count != 0:
3870
def _do_interactive(self, merger, cleanups):
3871
"""Perform an interactive merge.
3873
This works by generating a preview tree of the merge, then using
3874
Shelver to selectively remove the differences between the working tree
3875
and the preview tree.
3877
from bzrlib import shelf_ui
3878
result_tree = self._get_preview(merger, cleanups)
3879
writer = bzrlib.option.diff_writer_registry.get()
3880
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3881
reporter=shelf_ui.ApplyReporter(),
3882
diff_writer=writer(sys.stdout))
3888
def sanity_check_merger(self, merger):
3889
if (merger.show_base and
3890
not merger.merge_type is _mod_merge.Merge3Merger):
3891
raise errors.BzrCommandError("Show-base is not supported for this"
3892
" merge type. %s" % merger.merge_type)
3893
if merger.reprocess is None:
3894
if merger.show_base:
3895
merger.reprocess = False
3897
# Use reprocess if the merger supports it
3898
merger.reprocess = merger.merge_type.supports_reprocess
3899
if merger.reprocess and not merger.merge_type.supports_reprocess:
3900
raise errors.BzrCommandError("Conflict reduction is not supported"
3901
" for merge type %s." %
3903
if merger.reprocess and merger.show_base:
3904
raise errors.BzrCommandError("Cannot do conflict reduction and"
3907
def _get_merger_from_branch(self, tree, location, revision, remember,
3908
possible_transports, pb):
3909
"""Produce a merger from a location, assuming it refers to a branch."""
3910
from bzrlib.tag import _merge_tags_if_possible
3911
# find the branch locations
3912
other_loc, user_location = self._select_branch_location(tree, location,
3914
if revision is not None and len(revision) == 2:
3915
base_loc, _unused = self._select_branch_location(tree,
3916
location, revision, 0)
3918
base_loc = other_loc
3920
other_branch, other_path = Branch.open_containing(other_loc,
3921
possible_transports)
3922
if base_loc == other_loc:
3923
base_branch = other_branch
3925
base_branch, base_path = Branch.open_containing(base_loc,
3926
possible_transports)
3927
# Find the revision ids
3928
other_revision_id = None
3929
base_revision_id = None
3930
if revision is not None:
3931
if len(revision) >= 1:
3932
other_revision_id = revision[-1].as_revision_id(other_branch)
3933
if len(revision) == 2:
3934
base_revision_id = revision[0].as_revision_id(base_branch)
3935
if other_revision_id is None:
3936
other_revision_id = _mod_revision.ensure_null(
3937
other_branch.last_revision())
3938
# Remember where we merge from
3939
if ((remember or tree.branch.get_submit_branch() is None) and
3940
user_location is not None):
3941
tree.branch.set_submit_branch(other_branch.base)
3942
_merge_tags_if_possible(other_branch, tree.branch)
3943
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3944
other_revision_id, base_revision_id, other_branch, base_branch)
3945
if other_path != '':
3946
allow_pending = False
3947
merger.interesting_files = [other_path]
3949
allow_pending = True
3950
return merger, allow_pending
3952
def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3953
"""Get a merger for uncommitted changes.
3955
:param tree: The tree the merger should apply to.
3956
:param location: The location containing uncommitted changes.
3957
:param pb: The progress bar to use for showing progress.
3958
:param cleanups: A list of operations to perform to clean up the
3959
temporary directories, unfinalized objects, etc.
3961
location = self._select_branch_location(tree, location)[0]
3962
other_tree, other_path = WorkingTree.open_containing(location)
3963
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3964
if other_path != '':
3965
merger.interesting_files = [other_path]
3968
def _select_branch_location(self, tree, user_location, revision=None,
3970
"""Select a branch location, according to possible inputs.
3972
If provided, branches from ``revision`` are preferred. (Both
3973
``revision`` and ``index`` must be supplied.)
3975
Otherwise, the ``location`` parameter is used. If it is None, then the
3976
``submit`` or ``parent`` location is used, and a note is printed.
3978
:param tree: The working tree to select a branch for merging into
3979
:param location: The location entered by the user
3980
:param revision: The revision parameter to the command
3981
:param index: The index to use for the revision parameter. Negative
3982
indices are permitted.
3983
:return: (selected_location, user_location). The default location
3984
will be the user-entered location.
3986
if (revision is not None and index is not None
3987
and revision[index] is not None):
3988
branch = revision[index].get_branch()
3989
if branch is not None:
3990
return branch, branch
3991
if user_location is None:
3992
location = self._get_remembered(tree, 'Merging from')
3994
location = user_location
3995
return location, user_location
3997
def _get_remembered(self, tree, verb_string):
3998
"""Use tree.branch's parent if none was supplied.
4000
Report if the remembered location was used.
4002
stored_location = tree.branch.get_submit_branch()
4003
stored_location_type = "submit"
4004
if stored_location is None:
4005
stored_location = tree.branch.get_parent()
4006
stored_location_type = "parent"
4007
mutter("%s", stored_location)
4008
if stored_location is None:
4009
raise errors.BzrCommandError("No location specified or remembered")
4010
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4011
note(u"%s remembered %s location %s", verb_string,
4012
stored_location_type, display_url)
4013
return stored_location
4016
class cmd_remerge(Command):
4019
Use this if you want to try a different merge technique while resolving
4020
conflicts. Some merge techniques are better than others, and remerge
4021
lets you try different ones on different files.
4023
The options for remerge have the same meaning and defaults as the ones for
4024
merge. The difference is that remerge can (only) be run when there is a
4025
pending merge, and it lets you specify particular files.
4028
Re-do the merge of all conflicted files, and show the base text in
4029
conflict regions, in addition to the usual THIS and OTHER texts::
4031
bzr remerge --show-base
4033
Re-do the merge of "foobar", using the weave merge algorithm, with
4034
additional processing to reduce the size of conflict regions::
4036
bzr remerge --merge-type weave --reprocess foobar
4038
takes_args = ['file*']
4043
help="Show base revision text in conflicts."),
4046
def run(self, file_list=None, merge_type=None, show_base=False,
4048
if merge_type is None:
4049
merge_type = _mod_merge.Merge3Merger
4050
tree, file_list = tree_files(file_list)
4053
parents = tree.get_parent_ids()
4054
if len(parents) != 2:
4055
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4056
" merges. Not cherrypicking or"
4058
repository = tree.branch.repository
4059
interesting_ids = None
4061
conflicts = tree.conflicts()
4062
if file_list is not None:
4063
interesting_ids = set()
4064
for filename in file_list:
4065
file_id = tree.path2id(filename)
4067
raise errors.NotVersionedError(filename)
4068
interesting_ids.add(file_id)
4069
if tree.kind(file_id) != "directory":
4072
for name, ie in tree.inventory.iter_entries(file_id):
4073
interesting_ids.add(ie.file_id)
4074
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4076
# Remerge only supports resolving contents conflicts
4077
allowed_conflicts = ('text conflict', 'contents conflict')
4078
restore_files = [c.path for c in conflicts
4079
if c.typestring in allowed_conflicts]
4080
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4081
tree.set_conflicts(ConflictList(new_conflicts))
4082
if file_list is not None:
4083
restore_files = file_list
4084
for filename in restore_files:
4086
restore(tree.abspath(filename))
4087
except errors.NotConflicted:
4089
# Disable pending merges, because the file texts we are remerging
4090
# have not had those merges performed. If we use the wrong parents
4091
# list, we imply that the working tree text has seen and rejected
4092
# all the changes from the other tree, when in fact those changes
4093
# have not yet been seen.
4094
pb = ui.ui_factory.nested_progress_bar()
4095
tree.set_parent_ids(parents[:1])
4097
merger = _mod_merge.Merger.from_revision_ids(pb,
4099
merger.interesting_ids = interesting_ids
4100
merger.merge_type = merge_type
4101
merger.show_base = show_base
4102
merger.reprocess = reprocess
4103
conflicts = merger.do_merge()
4105
tree.set_parent_ids(parents)
4115
class cmd_revert(Command):
4116
"""Revert files to a previous revision.
4118
Giving a list of files will revert only those files. Otherwise, all files
4119
will be reverted. If the revision is not specified with '--revision', the
4120
last committed revision is used.
4122
To remove only some changes, without reverting to a prior version, use
4123
merge instead. For example, "merge . --revision -2..-3" will remove the
4124
changes introduced by -2, without affecting the changes introduced by -1.
4125
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4127
By default, any files that have been manually changed will be backed up
4128
first. (Files changed only by merge are not backed up.) Backup files have
4129
'.~#~' appended to their name, where # is a number.
4131
When you provide files, you can use their current pathname or the pathname
4132
from the target revision. So you can use revert to "undelete" a file by
4133
name. If you name a directory, all the contents of that directory will be
4136
If you have newly added files since the target revision, they will be
4137
removed. If the files to be removed have been changed, backups will be
4138
created as above. Directories containing unknown files will not be
4141
The working tree contains a list of pending merged revisions, which will
4142
be included as parents in the next commit. Normally, revert clears that
4143
list as well as reverting the files. If any files are specified, revert
4144
leaves the pending merge list alone and reverts only the files. Use "bzr
4145
revert ." in the tree root to revert all files but keep the merge record,
4146
and "bzr revert --forget-merges" to clear the pending merge list without
4147
reverting any files.
4149
Using "bzr revert --forget-merges", it is possible to apply the changes
4150
from an arbitrary merge as a single revision. To do this, perform the
4151
merge as desired. Then doing revert with the "--forget-merges" option will
4152
keep the content of the tree as it was, but it will clear the list of
4153
pending merges. The next commit will then contain all of the changes that
4154
would have been in the merge, but without any mention of the other parent
4155
revisions. Because this technique forgets where these changes originated,
4156
it may cause additional conflicts on later merges involving the source and
4160
_see_also = ['cat', 'export']
4163
Option('no-backup', "Do not save backups of reverted files."),
4164
Option('forget-merges',
4165
'Remove pending merge marker, without changing any files.'),
4167
takes_args = ['file*']
4169
def run(self, revision=None, no_backup=False, file_list=None,
4170
forget_merges=None):
4171
tree, file_list = tree_files(file_list)
4175
tree.set_parent_ids(tree.get_parent_ids()[:1])
4177
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4182
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4183
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4184
pb = ui.ui_factory.nested_progress_bar()
4186
tree.revert(file_list, rev_tree, not no_backup, pb,
4187
report_changes=True)
4192
class cmd_assert_fail(Command):
4193
"""Test reporting of assertion failures"""
4194
# intended just for use in testing
4199
raise AssertionError("always fails")
4202
class cmd_help(Command):
4203
"""Show help on a command or other topic.
4206
_see_also = ['topics']
4208
Option('long', 'Show help on all commands.'),
4210
takes_args = ['topic?']
4211
aliases = ['?', '--help', '-?', '-h']
4214
def run(self, topic=None, long=False):
4216
if topic is None and long:
4218
bzrlib.help.help(topic)
4221
class cmd_shell_complete(Command):
4222
"""Show appropriate completions for context.
4224
For a list of all available commands, say 'bzr shell-complete'.
4226
takes_args = ['context?']
4231
def run(self, context=None):
4232
import shellcomplete
4233
shellcomplete.shellcomplete(context)
4236
class cmd_missing(Command):
4237
"""Show unmerged/unpulled revisions between two branches.
4239
OTHER_BRANCH may be local or remote.
4241
To filter on a range of revisions, you can use the command -r begin..end
4242
-r revision requests a specific revision, -r ..end or -r begin.. are
4246
1 - some missing revisions
4247
0 - no missing revisions
4251
Determine the missing revisions between this and the branch at the
4252
remembered pull location::
4256
Determine the missing revisions between this and another branch::
4258
bzr missing http://server/branch
4260
Determine the missing revisions up to a specific revision on the other
4263
bzr missing -r ..-10
4265
Determine the missing revisions up to a specific revision on this
4268
bzr missing --my-revision ..-10
4271
_see_also = ['merge', 'pull']
4272
takes_args = ['other_branch?']
4274
Option('reverse', 'Reverse the order of revisions.'),
4276
'Display changes in the local branch only.'),
4277
Option('this' , 'Same as --mine-only.'),
4278
Option('theirs-only',
4279
'Display changes in the remote branch only.'),
4280
Option('other', 'Same as --theirs-only.'),
4284
custom_help('revision',
4285
help='Filter on other branch revisions (inclusive). '
4286
'See "help revisionspec" for details.'),
4287
Option('my-revision',
4288
type=_parse_revision_str,
4289
help='Filter on local branch revisions (inclusive). '
4290
'See "help revisionspec" for details.'),
4291
Option('include-merges',
4292
'Show all revisions in addition to the mainline ones.'),
4294
encoding_type = 'replace'
4297
def run(self, other_branch=None, reverse=False, mine_only=False,
4299
log_format=None, long=False, short=False, line=False,
4300
show_ids=False, verbose=False, this=False, other=False,
4301
include_merges=False, revision=None, my_revision=None):
4302
from bzrlib.missing import find_unmerged, iter_log_revisions
4311
# TODO: We should probably check that we don't have mine-only and
4312
# theirs-only set, but it gets complicated because we also have
4313
# this and other which could be used.
4320
local_branch = Branch.open_containing(u".")[0]
4321
parent = local_branch.get_parent()
4322
if other_branch is None:
4323
other_branch = parent
4324
if other_branch is None:
4325
raise errors.BzrCommandError("No peer location known"
4327
display_url = urlutils.unescape_for_display(parent,
4329
message("Using saved parent location: "
4330
+ display_url + "\n")
4332
remote_branch = Branch.open(other_branch)
4333
if remote_branch.base == local_branch.base:
4334
remote_branch = local_branch
4336
local_revid_range = _revision_range_to_revid_range(
4337
_get_revision_range(my_revision, local_branch,
4340
remote_revid_range = _revision_range_to_revid_range(
4341
_get_revision_range(revision,
4342
remote_branch, self.name()))
4344
local_branch.lock_read()
4346
remote_branch.lock_read()
4348
local_extra, remote_extra = find_unmerged(
4349
local_branch, remote_branch, restrict,
4350
backward=not reverse,
4351
include_merges=include_merges,
4352
local_revid_range=local_revid_range,
4353
remote_revid_range=remote_revid_range)
4355
if log_format is None:
4356
registry = log.log_formatter_registry
4357
log_format = registry.get_default(local_branch)
4358
lf = log_format(to_file=self.outf,
4360
show_timezone='original')
4363
if local_extra and not theirs_only:
4364
message("You have %d extra revision(s):\n" %
4366
for revision in iter_log_revisions(local_extra,
4367
local_branch.repository,
4369
lf.log_revision(revision)
4370
printed_local = True
4373
printed_local = False
4375
if remote_extra and not mine_only:
4376
if printed_local is True:
4378
message("You are missing %d revision(s):\n" %
4380
for revision in iter_log_revisions(remote_extra,
4381
remote_branch.repository,
4383
lf.log_revision(revision)
4386
if mine_only and not local_extra:
4387
# We checked local, and found nothing extra
4388
message('This branch is up to date.\n')
4389
elif theirs_only and not remote_extra:
4390
# We checked remote, and found nothing extra
4391
message('Other branch is up to date.\n')
4392
elif not (mine_only or theirs_only or local_extra or
4394
# We checked both branches, and neither one had extra
4396
message("Branches are up to date.\n")
4398
remote_branch.unlock()
4400
local_branch.unlock()
4401
if not status_code and parent is None and other_branch is not None:
4402
local_branch.lock_write()
4404
# handle race conditions - a parent might be set while we run.
4405
if local_branch.get_parent() is None:
4406
local_branch.set_parent(remote_branch.base)
4408
local_branch.unlock()
4412
class cmd_pack(Command):
4413
"""Compress the data within a repository."""
4415
_see_also = ['repositories']
4416
takes_args = ['branch_or_repo?']
4418
def run(self, branch_or_repo='.'):
4419
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4421
branch = dir.open_branch()
4422
repository = branch.repository
4423
except errors.NotBranchError:
4424
repository = dir.open_repository()
4428
class cmd_plugins(Command):
4429
"""List the installed plugins.
4431
This command displays the list of installed plugins including
4432
version of plugin and a short description of each.
4434
--verbose shows the path where each plugin is located.
4436
A plugin is an external component for Bazaar that extends the
4437
revision control system, by adding or replacing code in Bazaar.
4438
Plugins can do a variety of things, including overriding commands,
4439
adding new commands, providing additional network transports and
4440
customizing log output.
4442
See the Bazaar web site, http://bazaar-vcs.org, for further
4443
information on plugins including where to find them and how to
4444
install them. Instructions are also provided there on how to
4445
write new plugins using the Python programming language.
4447
takes_options = ['verbose']
4450
def run(self, verbose=False):
4451
import bzrlib.plugin
4452
from inspect import getdoc
4454
for name, plugin in bzrlib.plugin.plugins().items():
4455
version = plugin.__version__
4456
if version == 'unknown':
4458
name_ver = '%s %s' % (name, version)
4459
d = getdoc(plugin.module)
4461
doc = d.split('\n')[0]
4463
doc = '(no description)'
4464
result.append((name_ver, doc, plugin.path()))
4465
for name_ver, doc, path in sorted(result):
4473
class cmd_testament(Command):
4474
"""Show testament (signing-form) of a revision."""
4477
Option('long', help='Produce long-format testament.'),
4479
help='Produce a strict-format testament.')]
4480
takes_args = ['branch?']
4482
def run(self, branch=u'.', revision=None, long=False, strict=False):
4483
from bzrlib.testament import Testament, StrictTestament
4485
testament_class = StrictTestament
4487
testament_class = Testament
4489
b = Branch.open_containing(branch)[0]
4491
b = Branch.open(branch)
4494
if revision is None:
4495
rev_id = b.last_revision()
4497
rev_id = revision[0].as_revision_id(b)
4498
t = testament_class.from_revision(b.repository, rev_id)
4500
sys.stdout.writelines(t.as_text_lines())
4502
sys.stdout.write(t.as_short_text())
4507
class cmd_annotate(Command):
4508
"""Show the origin of each line in a file.
4510
This prints out the given file with an annotation on the left side
4511
indicating which revision, author and date introduced the change.
4513
If the origin is the same for a run of consecutive lines, it is
4514
shown only at the top, unless the --all option is given.
4516
# TODO: annotate directories; showing when each file was last changed
4517
# TODO: if the working copy is modified, show annotations on that
4518
# with new uncommitted lines marked
4519
aliases = ['ann', 'blame', 'praise']
4520
takes_args = ['filename']
4521
takes_options = [Option('all', help='Show annotations on all lines.'),
4522
Option('long', help='Show commit date in annotations.'),
4526
encoding_type = 'exact'
4529
def run(self, filename, all=False, long=False, revision=None,
4531
from bzrlib.annotate import annotate_file, annotate_file_tree
4532
wt, branch, relpath = \
4533
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4539
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4541
file_id = wt.path2id(relpath)
4543
file_id = tree.path2id(relpath)
4545
raise errors.NotVersionedError(filename)
4546
file_version = tree.inventory[file_id].revision
4547
if wt is not None and revision is None:
4548
# If there is a tree and we're not annotating historical
4549
# versions, annotate the working tree's content.
4550
annotate_file_tree(wt, file_id, self.outf, long, all,
4553
annotate_file(branch, file_version, file_id, long, all, self.outf,
4562
class cmd_re_sign(Command):
4563
"""Create a digital signature for an existing revision."""
4564
# TODO be able to replace existing ones.
4566
hidden = True # is this right ?
4567
takes_args = ['revision_id*']
4568
takes_options = ['revision']
4570
def run(self, revision_id_list=None, revision=None):
4571
if revision_id_list is not None and revision is not None:
4572
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4573
if revision_id_list is None and revision is None:
4574
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4575
b = WorkingTree.open_containing(u'.')[0].branch
4578
return self._run(b, revision_id_list, revision)
4582
def _run(self, b, revision_id_list, revision):
4583
import bzrlib.gpg as gpg
4584
gpg_strategy = gpg.GPGStrategy(b.get_config())
4585
if revision_id_list is not None:
4586
b.repository.start_write_group()
4588
for revision_id in revision_id_list:
4589
b.repository.sign_revision(revision_id, gpg_strategy)
4591
b.repository.abort_write_group()
4594
b.repository.commit_write_group()
4595
elif revision is not None:
4596
if len(revision) == 1:
4597
revno, rev_id = revision[0].in_history(b)
4598
b.repository.start_write_group()
4600
b.repository.sign_revision(rev_id, gpg_strategy)
4602
b.repository.abort_write_group()
4605
b.repository.commit_write_group()
4606
elif len(revision) == 2:
4607
# are they both on rh- if so we can walk between them
4608
# might be nice to have a range helper for arbitrary
4609
# revision paths. hmm.
4610
from_revno, from_revid = revision[0].in_history(b)
4611
to_revno, to_revid = revision[1].in_history(b)
4612
if to_revid is None:
4613
to_revno = b.revno()
4614
if from_revno is None or to_revno is None:
4615
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4616
b.repository.start_write_group()
4618
for revno in range(from_revno, to_revno + 1):
4619
b.repository.sign_revision(b.get_rev_id(revno),
4622
b.repository.abort_write_group()
4625
b.repository.commit_write_group()
4627
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4630
class cmd_bind(Command):
4631
"""Convert the current branch into a checkout of the supplied branch.
4633
Once converted into a checkout, commits must succeed on the master branch
4634
before they will be applied to the local branch.
4636
Bound branches use the nickname of its master branch unless it is set
4637
locally, in which case binding will update the local nickname to be
4641
_see_also = ['checkouts', 'unbind']
4642
takes_args = ['location?']
4645
def run(self, location=None):
4646
b, relpath = Branch.open_containing(u'.')
4647
if location is None:
4649
location = b.get_old_bound_location()
4650
except errors.UpgradeRequired:
4651
raise errors.BzrCommandError('No location supplied. '
4652
'This format does not remember old locations.')
4654
if location is None:
4655
raise errors.BzrCommandError('No location supplied and no '
4656
'previous location known')
4657
b_other = Branch.open(location)
4660
except errors.DivergedBranches:
4661
raise errors.BzrCommandError('These branches have diverged.'
4662
' Try merging, and then bind again.')
4663
if b.get_config().has_explicit_nickname():
4664
b.nick = b_other.nick
4667
class cmd_unbind(Command):
4668
"""Convert the current checkout into a regular branch.
4670
After unbinding, the local branch is considered independent and subsequent
4671
commits will be local only.
4674
_see_also = ['checkouts', 'bind']
4679
b, relpath = Branch.open_containing(u'.')
4681
raise errors.BzrCommandError('Local branch is not bound')
4684
class cmd_uncommit(Command):
4685
"""Remove the last committed revision.
4687
--verbose will print out what is being removed.
4688
--dry-run will go through all the motions, but not actually
4691
If --revision is specified, uncommit revisions to leave the branch at the
4692
specified revision. For example, "bzr uncommit -r 15" will leave the
4693
branch at revision 15.
4695
Uncommit leaves the working tree ready for a new commit. The only change
4696
it may make is to restore any pending merges that were present before
4700
# TODO: jam 20060108 Add an option to allow uncommit to remove
4701
# unreferenced information in 'branch-as-repository' branches.
4702
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4703
# information in shared branches as well.
4704
_see_also = ['commit']
4705
takes_options = ['verbose', 'revision',
4706
Option('dry-run', help='Don\'t actually make changes.'),
4707
Option('force', help='Say yes to all questions.'),
4709
help="Only remove the commits from the local branch"
4710
" when in a checkout."
4713
takes_args = ['location?']
4715
encoding_type = 'replace'
4717
def run(self, location=None,
4718
dry_run=False, verbose=False,
4719
revision=None, force=False, local=False):
4720
if location is None:
4722
control, relpath = bzrdir.BzrDir.open_containing(location)
4724
tree = control.open_workingtree()
4726
except (errors.NoWorkingTree, errors.NotLocalUrl):
4728
b = control.open_branch()
4730
if tree is not None:
4735
return self._run(b, tree, dry_run, verbose, revision, force,
4738
if tree is not None:
4743
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4744
from bzrlib.log import log_formatter, show_log
4745
from bzrlib.uncommit import uncommit
4747
last_revno, last_rev_id = b.last_revision_info()
4750
if revision is None:
4752
rev_id = last_rev_id
4754
# 'bzr uncommit -r 10' actually means uncommit
4755
# so that the final tree is at revno 10.
4756
# but bzrlib.uncommit.uncommit() actually uncommits
4757
# the revisions that are supplied.
4758
# So we need to offset it by one
4759
revno = revision[0].in_history(b).revno + 1
4760
if revno <= last_revno:
4761
rev_id = b.get_rev_id(revno)
4763
if rev_id is None or _mod_revision.is_null(rev_id):
4764
self.outf.write('No revisions to uncommit.\n')
4767
lf = log_formatter('short',
4769
show_timezone='original')
4774
direction='forward',
4775
start_revision=revno,
4776
end_revision=last_revno)
4779
print 'Dry-run, pretending to remove the above revisions.'
4781
val = raw_input('Press <enter> to continue')
4783
print 'The above revision(s) will be removed.'
4785
val = raw_input('Are you sure [y/N]? ')
4786
if val.lower() not in ('y', 'yes'):
4790
mutter('Uncommitting from {%s} to {%s}',
4791
last_rev_id, rev_id)
4792
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4793
revno=revno, local=local)
4794
note('You can restore the old tip by running:\n'
4795
' bzr pull . -r revid:%s', last_rev_id)
4798
class cmd_break_lock(Command):
4799
"""Break a dead lock on a repository, branch or working directory.
4801
CAUTION: Locks should only be broken when you are sure that the process
4802
holding the lock has been stopped.
4804
You can get information on what locks are open via the 'bzr info' command.
4809
takes_args = ['location?']
4811
def run(self, location=None, show=False):
4812
if location is None:
4814
control, relpath = bzrdir.BzrDir.open_containing(location)
4816
control.break_lock()
4817
except NotImplementedError:
4821
class cmd_wait_until_signalled(Command):
4822
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4824
This just prints a line to signal when it is ready, then blocks on stdin.
4830
sys.stdout.write("running\n")
4832
sys.stdin.readline()
4835
class cmd_serve(Command):
4836
"""Run the bzr server."""
4838
aliases = ['server']
4842
help='Serve on stdin/out for use from inetd or sshd.'),
4843
RegistryOption('protocol',
4844
help="Protocol to serve.",
4845
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4846
value_switches=True),
4848
help='Listen for connections on nominated port of the form '
4849
'[hostname:]portnumber. Passing 0 as the port number will '
4850
'result in a dynamically allocated port. The default port '
4851
'depends on the protocol.',
4854
help='Serve contents of this directory.',
4856
Option('allow-writes',
4857
help='By default the server is a readonly server. Supplying '
4858
'--allow-writes enables write access to the contents of '
4859
'the served directory and below. Note that ``bzr serve`` '
4860
'does not perform authentication, so unless some form of '
4861
'external authentication is arranged supplying this '
4862
'option leads to global uncontrolled write access to your '
4867
def get_host_and_port(self, port):
4868
"""Return the host and port to run the smart server on.
4870
If 'port' is None, None will be returned for the host and port.
4872
If 'port' has a colon in it, the string before the colon will be
4873
interpreted as the host.
4875
:param port: A string of the port to run the server on.
4876
:return: A tuple of (host, port), where 'host' is a host name or IP,
4877
and port is an integer TCP/IP port.
4880
if port is not None:
4882
host, port = port.split(':')
4886
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4888
from bzrlib.transport import get_transport, transport_server_registry
4889
if directory is None:
4890
directory = os.getcwd()
4891
if protocol is None:
4892
protocol = transport_server_registry.get()
4893
host, port = self.get_host_and_port(port)
4894
url = urlutils.local_path_to_url(directory)
4895
if not allow_writes:
4896
url = 'readonly+' + url
4897
transport = get_transport(url)
4898
protocol(transport, host, port, inet)
4901
class cmd_join(Command):
4902
"""Combine a tree into its containing tree.
4904
This command requires the target tree to be in a rich-root format.
4906
The TREE argument should be an independent tree, inside another tree, but
4907
not part of it. (Such trees can be produced by "bzr split", but also by
4908
running "bzr branch" with the target inside a tree.)
4910
The result is a combined tree, with the subtree no longer an independant
4911
part. This is marked as a merge of the subtree into the containing tree,
4912
and all history is preserved.
4915
_see_also = ['split']
4916
takes_args = ['tree']
4918
Option('reference', help='Join by reference.', hidden=True),
4921
def run(self, tree, reference=False):
4922
sub_tree = WorkingTree.open(tree)
4923
parent_dir = osutils.dirname(sub_tree.basedir)
4924
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4925
repo = containing_tree.branch.repository
4926
if not repo.supports_rich_root():
4927
raise errors.BzrCommandError(
4928
"Can't join trees because %s doesn't support rich root data.\n"
4929
"You can use bzr upgrade on the repository."
4933
containing_tree.add_reference(sub_tree)
4934
except errors.BadReferenceTarget, e:
4935
# XXX: Would be better to just raise a nicely printable
4936
# exception from the real origin. Also below. mbp 20070306
4937
raise errors.BzrCommandError("Cannot join %s. %s" %
4941
containing_tree.subsume(sub_tree)
4942
except errors.BadSubsumeSource, e:
4943
raise errors.BzrCommandError("Cannot join %s. %s" %
4947
class cmd_split(Command):
4948
"""Split a subdirectory of a tree into a separate tree.
4950
This command will produce a target tree in a format that supports
4951
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4952
converted into earlier formats like 'dirstate-tags'.
4954
The TREE argument should be a subdirectory of a working tree. That
4955
subdirectory will be converted into an independent tree, with its own
4956
branch. Commits in the top-level tree will not apply to the new subtree.
4959
_see_also = ['join']
4960
takes_args = ['tree']
4962
def run(self, tree):
4963
containing_tree, subdir = WorkingTree.open_containing(tree)
4964
sub_id = containing_tree.path2id(subdir)
4966
raise errors.NotVersionedError(subdir)
4968
containing_tree.extract(sub_id)
4969
except errors.RootNotRich:
4970
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4973
class cmd_merge_directive(Command):
4974
"""Generate a merge directive for auto-merge tools.
4976
A directive requests a merge to be performed, and also provides all the
4977
information necessary to do so. This means it must either include a
4978
revision bundle, or the location of a branch containing the desired
4981
A submit branch (the location to merge into) must be supplied the first
4982
time the command is issued. After it has been supplied once, it will
4983
be remembered as the default.
4985
A public branch is optional if a revision bundle is supplied, but required
4986
if --diff or --plain is specified. It will be remembered as the default
4987
after the first use.
4990
takes_args = ['submit_branch?', 'public_branch?']
4994
_see_also = ['send']
4997
RegistryOption.from_kwargs('patch-type',
4998
'The type of patch to include in the directive.',
5000
value_switches=True,
5002
bundle='Bazaar revision bundle (default).',
5003
diff='Normal unified diff.',
5004
plain='No patch, just directive.'),
5005
Option('sign', help='GPG-sign the directive.'), 'revision',
5006
Option('mail-to', type=str,
5007
help='Instead of printing the directive, email to this address.'),
5008
Option('message', type=str, short_name='m',
5009
help='Message to use when committing this merge.')
5012
encoding_type = 'exact'
5014
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5015
sign=False, revision=None, mail_to=None, message=None):
5016
from bzrlib.revision import ensure_null, NULL_REVISION
5017
include_patch, include_bundle = {
5018
'plain': (False, False),
5019
'diff': (True, False),
5020
'bundle': (True, True),
5022
branch = Branch.open('.')
5023
stored_submit_branch = branch.get_submit_branch()
5024
if submit_branch is None:
5025
submit_branch = stored_submit_branch
5027
if stored_submit_branch is None:
5028
branch.set_submit_branch(submit_branch)
5029
if submit_branch is None:
5030
submit_branch = branch.get_parent()
5031
if submit_branch is None:
5032
raise errors.BzrCommandError('No submit branch specified or known')
5034
stored_public_branch = branch.get_public_branch()
5035
if public_branch is None:
5036
public_branch = stored_public_branch
5037
elif stored_public_branch is None:
5038
branch.set_public_branch(public_branch)
5039
if not include_bundle and public_branch is None:
5040
raise errors.BzrCommandError('No public branch specified or'
5042
base_revision_id = None
5043
if revision is not None:
5044
if len(revision) > 2:
5045
raise errors.BzrCommandError('bzr merge-directive takes '
5046
'at most two one revision identifiers')
5047
revision_id = revision[-1].as_revision_id(branch)
5048
if len(revision) == 2:
5049
base_revision_id = revision[0].as_revision_id(branch)
5051
revision_id = branch.last_revision()
5052
revision_id = ensure_null(revision_id)
5053
if revision_id == NULL_REVISION:
5054
raise errors.BzrCommandError('No revisions to bundle.')
5055
directive = merge_directive.MergeDirective2.from_objects(
5056
branch.repository, revision_id, time.time(),
5057
osutils.local_time_offset(), submit_branch,
5058
public_branch=public_branch, include_patch=include_patch,
5059
include_bundle=include_bundle, message=message,
5060
base_revision_id=base_revision_id)
5063
self.outf.write(directive.to_signed(branch))
5065
self.outf.writelines(directive.to_lines())
5067
message = directive.to_email(mail_to, branch, sign)
5068
s = SMTPConnection(branch.get_config())
5069
s.send_email(message)
5072
class cmd_send(Command):
5073
"""Mail or create a merge-directive for submitting changes.
5075
A merge directive provides many things needed for requesting merges:
5077
* A machine-readable description of the merge to perform
5079
* An optional patch that is a preview of the changes requested
5081
* An optional bundle of revision data, so that the changes can be applied
5082
directly from the merge directive, without retrieving data from a
5085
If --no-bundle is specified, then public_branch is needed (and must be
5086
up-to-date), so that the receiver can perform the merge using the
5087
public_branch. The public_branch is always included if known, so that
5088
people can check it later.
5090
The submit branch defaults to the parent, but can be overridden. Both
5091
submit branch and public branch will be remembered if supplied.
5093
If a public_branch is known for the submit_branch, that public submit
5094
branch is used in the merge instructions. This means that a local mirror
5095
can be used as your actual submit branch, once you have set public_branch
5098
Mail is sent using your preferred mail program. This should be transparent
5099
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5100
If the preferred client can't be found (or used), your editor will be used.
5102
To use a specific mail program, set the mail_client configuration option.
5103
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5104
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5105
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5106
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5109
If mail is being sent, a to address is required. This can be supplied
5110
either on the commandline, by setting the submit_to configuration
5111
option in the branch itself or the child_submit_to configuration option
5112
in the submit branch.
5114
Two formats are currently supported: "4" uses revision bundle format 4 and
5115
merge directive format 2. It is significantly faster and smaller than
5116
older formats. It is compatible with Bazaar 0.19 and later. It is the
5117
default. "0.9" uses revision bundle format 0.9 and merge directive
5118
format 1. It is compatible with Bazaar 0.12 - 0.18.
5120
The merge directives created by bzr send may be applied using bzr merge or
5121
bzr pull by specifying a file containing a merge directive as the location.
5124
encoding_type = 'exact'
5126
_see_also = ['merge', 'pull']
5128
takes_args = ['submit_branch?', 'public_branch?']
5132
help='Do not include a bundle in the merge directive.'),
5133
Option('no-patch', help='Do not include a preview patch in the merge'
5136
help='Remember submit and public branch.'),
5138
help='Branch to generate the submission from, '
5139
'rather than the one containing the working directory.',
5142
Option('output', short_name='o',
5143
help='Write merge directive to this file; '
5144
'use - for stdout.',
5147
help='Refuse to send if there are uncommitted changes in'
5148
' the working tree, --no-strict disables the check.'),
5149
Option('mail-to', help='Mail the request to this address.',
5153
Option('body', help='Body for the email.', type=unicode),
5154
RegistryOption('format',
5155
help='Use the specified output format.',
5156
lazy_registry=('bzrlib.send', 'format_registry')),
5159
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5160
no_patch=False, revision=None, remember=False, output=None,
5161
format=None, mail_to=None, message=None, body=None,
5162
strict=None, **kwargs):
5163
from bzrlib.send import send
5164
return send(submit_branch, revision, public_branch, remember,
5165
format, no_bundle, no_patch, output,
5166
kwargs.get('from', '.'), mail_to, message, body,
5171
class cmd_bundle_revisions(cmd_send):
5172
"""Create a merge-directive for submitting changes.
5174
A merge directive provides many things needed for requesting merges:
5176
* A machine-readable description of the merge to perform
5178
* An optional patch that is a preview of the changes requested
5180
* An optional bundle of revision data, so that the changes can be applied
5181
directly from the merge directive, without retrieving data from a
5184
If --no-bundle is specified, then public_branch is needed (and must be
5185
up-to-date), so that the receiver can perform the merge using the
5186
public_branch. The public_branch is always included if known, so that
5187
people can check it later.
5189
The submit branch defaults to the parent, but can be overridden. Both
5190
submit branch and public branch will be remembered if supplied.
5192
If a public_branch is known for the submit_branch, that public submit
5193
branch is used in the merge instructions. This means that a local mirror
5194
can be used as your actual submit branch, once you have set public_branch
5197
Two formats are currently supported: "4" uses revision bundle format 4 and
5198
merge directive format 2. It is significantly faster and smaller than
5199
older formats. It is compatible with Bazaar 0.19 and later. It is the
5200
default. "0.9" uses revision bundle format 0.9 and merge directive
5201
format 1. It is compatible with Bazaar 0.12 - 0.18.
5206
help='Do not include a bundle in the merge directive.'),
5207
Option('no-patch', help='Do not include a preview patch in the merge'
5210
help='Remember submit and public branch.'),
5212
help='Branch to generate the submission from, '
5213
'rather than the one containing the working directory.',
5216
Option('output', short_name='o', help='Write directive to this file.',
5219
help='Refuse to bundle revisions if there are uncommitted'
5220
' changes in the working tree, --no-strict disables the check.'),
5222
RegistryOption('format',
5223
help='Use the specified output format.',
5224
lazy_registry=('bzrlib.send', 'format_registry')),
5226
aliases = ['bundle']
5228
_see_also = ['send', 'merge']
5232
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5233
no_patch=False, revision=None, remember=False, output=None,
5234
format=None, strict=None, **kwargs):
5237
from bzrlib.send import send
5238
return send(submit_branch, revision, public_branch, remember,
5239
format, no_bundle, no_patch, output,
5240
kwargs.get('from', '.'), None, None, None,
5241
self.outf, strict=strict)
5244
class cmd_tag(Command):
5245
"""Create, remove or modify a tag naming a revision.
5247
Tags give human-meaningful names to revisions. Commands that take a -r
5248
(--revision) option can be given -rtag:X, where X is any previously
5251
Tags are stored in the branch. Tags are copied from one branch to another
5252
along when you branch, push, pull or merge.
5254
It is an error to give a tag name that already exists unless you pass
5255
--force, in which case the tag is moved to point to the new revision.
5257
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5258
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5261
_see_also = ['commit', 'tags']
5262
takes_args = ['tag_name']
5265
help='Delete this tag rather than placing it.',
5268
help='Branch in which to place the tag.',
5273
help='Replace existing tags.',
5278
def run(self, tag_name,
5284
branch, relpath = Branch.open_containing(directory)
5288
branch.tags.delete_tag(tag_name)
5289
self.outf.write('Deleted tag %s.\n' % tag_name)
5292
if len(revision) != 1:
5293
raise errors.BzrCommandError(
5294
"Tags can only be placed on a single revision, "
5296
revision_id = revision[0].as_revision_id(branch)
5298
revision_id = branch.last_revision()
5299
if (not force) and branch.tags.has_tag(tag_name):
5300
raise errors.TagAlreadyExists(tag_name)
5301
branch.tags.set_tag(tag_name, revision_id)
5302
self.outf.write('Created tag %s.\n' % tag_name)
5307
class cmd_tags(Command):
5310
This command shows a table of tag names and the revisions they reference.
5316
help='Branch whose tags should be displayed.',
5320
RegistryOption.from_kwargs('sort',
5321
'Sort tags by different criteria.', title='Sorting',
5322
alpha='Sort tags lexicographically (default).',
5323
time='Sort tags chronologically.',
5336
branch, relpath = Branch.open_containing(directory)
5338
tags = branch.tags.get_tag_dict().items()
5345
graph = branch.repository.get_graph()
5346
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5347
revid1, revid2 = rev1.rev_id, rev2.rev_id
5348
# only show revisions between revid1 and revid2 (inclusive)
5349
tags = [(tag, revid) for tag, revid in tags if
5350
graph.is_between(revid, revid1, revid2)]
5353
elif sort == 'time':
5355
for tag, revid in tags:
5357
revobj = branch.repository.get_revision(revid)
5358
except errors.NoSuchRevision:
5359
timestamp = sys.maxint # place them at the end
5361
timestamp = revobj.timestamp
5362
timestamps[revid] = timestamp
5363
tags.sort(key=lambda x: timestamps[x[1]])
5365
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5366
for index, (tag, revid) in enumerate(tags):
5368
revno = branch.revision_id_to_dotted_revno(revid)
5369
if isinstance(revno, tuple):
5370
revno = '.'.join(map(str, revno))
5371
except errors.NoSuchRevision:
5372
# Bad tag data/merges can lead to tagged revisions
5373
# which are not in this branch. Fail gracefully ...
5375
tags[index] = (tag, revno)
5378
for tag, revspec in tags:
5379
self.outf.write('%-20s %s\n' % (tag, revspec))
5382
class cmd_reconfigure(Command):
5383
"""Reconfigure the type of a bzr directory.
5385
A target configuration must be specified.
5387
For checkouts, the bind-to location will be auto-detected if not specified.
5388
The order of preference is
5389
1. For a lightweight checkout, the current bound location.
5390
2. For branches that used to be checkouts, the previously-bound location.
5391
3. The push location.
5392
4. The parent location.
5393
If none of these is available, --bind-to must be specified.
5396
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5397
takes_args = ['location?']
5399
RegistryOption.from_kwargs(
5401
title='Target type',
5402
help='The type to reconfigure the directory to.',
5403
value_switches=True, enum_switch=False,
5404
branch='Reconfigure to be an unbound branch with no working tree.',
5405
tree='Reconfigure to be an unbound branch with a working tree.',
5406
checkout='Reconfigure to be a bound branch with a working tree.',
5407
lightweight_checkout='Reconfigure to be a lightweight'
5408
' checkout (with no local history).',
5409
standalone='Reconfigure to be a standalone branch '
5410
'(i.e. stop using shared repository).',
5411
use_shared='Reconfigure to use a shared repository.',
5412
with_trees='Reconfigure repository to create '
5413
'working trees on branches by default.',
5414
with_no_trees='Reconfigure repository to not create '
5415
'working trees on branches by default.'
5417
Option('bind-to', help='Branch to bind checkout to.', type=str),
5419
help='Perform reconfiguration even if local changes'
5421
Option('stacked-on',
5422
help='Reconfigure a branch to be stacked on another branch.',
5426
help='Reconfigure a branch to be unstacked. This '
5427
'may require copying substantial data into it.',
5431
def run(self, location=None, target_type=None, bind_to=None, force=False,
5434
directory = bzrdir.BzrDir.open(location)
5435
if stacked_on and unstacked:
5436
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5437
elif stacked_on is not None:
5438
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5440
reconfigure.ReconfigureUnstacked().apply(directory)
5441
# At the moment you can use --stacked-on and a different
5442
# reconfiguration shape at the same time; there seems no good reason
5444
if target_type is None:
5445
if stacked_on or unstacked:
5448
raise errors.BzrCommandError('No target configuration '
5450
elif target_type == 'branch':
5451
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5452
elif target_type == 'tree':
5453
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5454
elif target_type == 'checkout':
5455
reconfiguration = reconfigure.Reconfigure.to_checkout(
5457
elif target_type == 'lightweight-checkout':
5458
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5460
elif target_type == 'use-shared':
5461
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5462
elif target_type == 'standalone':
5463
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5464
elif target_type == 'with-trees':
5465
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5467
elif target_type == 'with-no-trees':
5468
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5470
reconfiguration.apply(force)
5473
class cmd_switch(Command):
5474
"""Set the branch of a checkout and update.
5476
For lightweight checkouts, this changes the branch being referenced.
5477
For heavyweight checkouts, this checks that there are no local commits
5478
versus the current bound branch, then it makes the local branch a mirror
5479
of the new location and binds to it.
5481
In both cases, the working tree is updated and uncommitted changes
5482
are merged. The user can commit or revert these as they desire.
5484
Pending merges need to be committed or reverted before using switch.
5486
The path to the branch to switch to can be specified relative to the parent
5487
directory of the current branch. For example, if you are currently in a
5488
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5491
Bound branches use the nickname of its master branch unless it is set
5492
locally, in which case switching will update the local nickname to be
5496
takes_args = ['to_location']
5497
takes_options = [Option('force',
5498
help='Switch even if local commits will be lost.'),
5499
Option('create-branch', short_name='b',
5500
help='Create the target branch from this one before'
5501
' switching to it.'),
5504
def run(self, to_location, force=False, create_branch=False):
5505
from bzrlib import switch
5507
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5509
branch = control_dir.open_branch()
5510
had_explicit_nick = branch.get_config().has_explicit_nickname()
5511
except errors.NotBranchError:
5513
had_explicit_nick = False
5516
raise errors.BzrCommandError('cannot create branch without'
5518
to_location = directory_service.directories.dereference(
5520
if '/' not in to_location and '\\' not in to_location:
5521
# This path is meant to be relative to the existing branch
5522
this_url = self._get_branch_location(control_dir)
5523
to_location = urlutils.join(this_url, '..', to_location)
5524
to_branch = branch.bzrdir.sprout(to_location,
5525
possible_transports=[branch.bzrdir.root_transport],
5526
source_branch=branch).open_branch()
5528
# from_branch = control_dir.open_branch()
5529
# except errors.NotBranchError:
5530
# raise BzrCommandError('Cannot create a branch from this'
5531
# ' location when we cannot open this branch')
5532
# from_branch.bzrdir.sprout(
5536
to_branch = Branch.open(to_location)
5537
except errors.NotBranchError:
5538
this_url = self._get_branch_location(control_dir)
5539
to_branch = Branch.open(
5540
urlutils.join(this_url, '..', to_location))
5541
switch.switch(control_dir, to_branch, force)
5542
if had_explicit_nick:
5543
branch = control_dir.open_branch() #get the new branch!
5544
branch.nick = to_branch.nick
5545
note('Switched to branch: %s',
5546
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5548
def _get_branch_location(self, control_dir):
5549
"""Return location of branch for this control dir."""
5551
this_branch = control_dir.open_branch()
5552
# This may be a heavy checkout, where we want the master branch
5553
master_location = this_branch.get_bound_location()
5554
if master_location is not None:
5555
return master_location
5556
# If not, use a local sibling
5557
return this_branch.base
5558
except errors.NotBranchError:
5559
format = control_dir.find_branch_format()
5560
if getattr(format, 'get_reference', None) is not None:
5561
return format.get_reference(control_dir)
5563
return control_dir.root_transport.base
5566
class cmd_view(Command):
5567
"""Manage filtered views.
5569
Views provide a mask over the tree so that users can focus on
5570
a subset of a tree when doing their work. After creating a view,
5571
commands that support a list of files - status, diff, commit, etc -
5572
effectively have that list of files implicitly given each time.
5573
An explicit list of files can still be given but those files
5574
must be within the current view.
5576
In most cases, a view has a short life-span: it is created to make
5577
a selected change and is deleted once that change is committed.
5578
At other times, you may wish to create one or more named views
5579
and switch between them.
5581
To disable the current view without deleting it, you can switch to
5582
the pseudo view called ``off``. This can be useful when you need
5583
to see the whole tree for an operation or two (e.g. merge) but
5584
want to switch back to your view after that.
5587
To define the current view::
5589
bzr view file1 dir1 ...
5591
To list the current view::
5595
To delete the current view::
5599
To disable the current view without deleting it::
5601
bzr view --switch off
5603
To define a named view and switch to it::
5605
bzr view --name view-name file1 dir1 ...
5607
To list a named view::
5609
bzr view --name view-name
5611
To delete a named view::
5613
bzr view --name view-name --delete
5615
To switch to a named view::
5617
bzr view --switch view-name
5619
To list all views defined::
5623
To delete all views::
5625
bzr view --delete --all
5629
takes_args = ['file*']
5632
help='Apply list or delete action to all views.',
5635
help='Delete the view.',
5638
help='Name of the view to define, list or delete.',
5642
help='Name of the view to switch to.',
5647
def run(self, file_list,
5653
tree, file_list = tree_files(file_list, apply_view=False)
5654
current_view, view_dict = tree.views.get_view_info()
5659
raise errors.BzrCommandError(
5660
"Both --delete and a file list specified")
5662
raise errors.BzrCommandError(
5663
"Both --delete and --switch specified")
5665
tree.views.set_view_info(None, {})
5666
self.outf.write("Deleted all views.\n")
5668
raise errors.BzrCommandError("No current view to delete")
5670
tree.views.delete_view(name)
5671
self.outf.write("Deleted '%s' view.\n" % name)
5674
raise errors.BzrCommandError(
5675
"Both --switch and a file list specified")
5677
raise errors.BzrCommandError(
5678
"Both --switch and --all specified")
5679
elif switch == 'off':
5680
if current_view is None:
5681
raise errors.BzrCommandError("No current view to disable")
5682
tree.views.set_view_info(None, view_dict)
5683
self.outf.write("Disabled '%s' view.\n" % (current_view))
5685
tree.views.set_view_info(switch, view_dict)
5686
view_str = views.view_display_str(tree.views.lookup_view())
5687
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5690
self.outf.write('Views defined:\n')
5691
for view in sorted(view_dict):
5692
if view == current_view:
5696
view_str = views.view_display_str(view_dict[view])
5697
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5699
self.outf.write('No views defined.\n')
5702
# No name given and no current view set
5705
raise errors.BzrCommandError(
5706
"Cannot change the 'off' pseudo view")
5707
tree.views.set_view(name, sorted(file_list))
5708
view_str = views.view_display_str(tree.views.lookup_view())
5709
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5713
# No name given and no current view set
5714
self.outf.write('No current view.\n')
5716
view_str = views.view_display_str(tree.views.lookup_view(name))
5717
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5720
class cmd_hooks(Command):
5726
for hook_key in sorted(hooks.known_hooks.keys()):
5727
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5728
self.outf.write("%s:\n" % type(some_hooks).__name__)
5729
for hook_name, hook_point in sorted(some_hooks.items()):
5730
self.outf.write(" %s:\n" % (hook_name,))
5731
found_hooks = list(hook_point)
5733
for hook in found_hooks:
5734
self.outf.write(" %s\n" %
5735
(some_hooks.get_hook_name(hook),))
5737
self.outf.write(" <no hooks installed>\n")
5740
class cmd_shelve(Command):
5741
"""Temporarily set aside some changes from the current tree.
5743
Shelve allows you to temporarily put changes you've made "on the shelf",
5744
ie. out of the way, until a later time when you can bring them back from
5745
the shelf with the 'unshelve' command. The changes are stored alongside
5746
your working tree, and so they aren't propagated along with your branch nor
5747
will they survive its deletion.
5749
If shelve --list is specified, previously-shelved changes are listed.
5751
Shelve is intended to help separate several sets of changes that have
5752
been inappropriately mingled. If you just want to get rid of all changes
5753
and you don't need to restore them later, use revert. If you want to
5754
shelve all text changes at once, use shelve --all.
5756
If filenames are specified, only the changes to those files will be
5757
shelved. Other files will be left untouched.
5759
If a revision is specified, changes since that revision will be shelved.
5761
You can put multiple items on the shelf, and by default, 'unshelve' will
5762
restore the most recently shelved changes.
5765
takes_args = ['file*']
5769
Option('all', help='Shelve all changes.'),
5771
RegistryOption('writer', 'Method to use for writing diffs.',
5772
bzrlib.option.diff_writer_registry,
5773
value_switches=True, enum_switch=False),
5775
Option('list', help='List shelved changes.'),
5777
help='Destroy removed changes instead of shelving them.'),
5779
_see_also = ['unshelve']
5781
def run(self, revision=None, all=False, file_list=None, message=None,
5782
writer=None, list=False, destroy=False):
5784
return self.run_for_list()
5785
from bzrlib.shelf_ui import Shelver
5787
writer = bzrlib.option.diff_writer_registry.get()
5789
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5790
file_list, message, destroy=destroy)
5795
except errors.UserAbort:
5798
def run_for_list(self):
5799
tree = WorkingTree.open_containing('.')[0]
5802
manager = tree.get_shelf_manager()
5803
shelves = manager.active_shelves()
5804
if len(shelves) == 0:
5805
note('No shelved changes.')
5807
for shelf_id in reversed(shelves):
5808
message = manager.get_metadata(shelf_id).get('message')
5810
message = '<no message>'
5811
self.outf.write('%3d: %s\n' % (shelf_id, message))
5817
class cmd_unshelve(Command):
5818
"""Restore shelved changes.
5820
By default, the most recently shelved changes are restored. However if you
5821
specify a shelf by id those changes will be restored instead. This works
5822
best when the changes don't depend on each other.
5825
takes_args = ['shelf_id?']
5827
RegistryOption.from_kwargs(
5828
'action', help="The action to perform.",
5829
enum_switch=False, value_switches=True,
5830
apply="Apply changes and remove from the shelf.",
5831
dry_run="Show changes, but do not apply or remove them.",
5832
delete_only="Delete changes without applying them.",
5833
keep="Apply changes but don't delete them.",
5836
_see_also = ['shelve']
5838
def run(self, shelf_id=None, action='apply'):
5839
from bzrlib.shelf_ui import Unshelver
5840
unshelver = Unshelver.from_args(shelf_id, action)
5844
unshelver.tree.unlock()
5847
class cmd_clean_tree(Command):
5848
"""Remove unwanted files from working tree.
5850
By default, only unknown files, not ignored files, are deleted. Versioned
5851
files are never deleted.
5853
Another class is 'detritus', which includes files emitted by bzr during
5854
normal operations and selftests. (The value of these files decreases with
5857
If no options are specified, unknown files are deleted. Otherwise, option
5858
flags are respected, and may be combined.
5860
To check what clean-tree will do, use --dry-run.
5862
takes_options = [Option('ignored', help='Delete all ignored files.'),
5863
Option('detritus', help='Delete conflict files, merge'
5864
' backups, and failed selftest dirs.'),
5866
help='Delete files unknown to bzr (default).'),
5867
Option('dry-run', help='Show files to delete instead of'
5869
Option('force', help='Do not prompt before deleting.')]
5870
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5872
from bzrlib.clean_tree import clean_tree
5873
if not (unknown or ignored or detritus):
5877
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5878
dry_run=dry_run, no_prompt=force)
5881
class cmd_reference(Command):
5882
"""list, view and set branch locations for nested trees.
5884
If no arguments are provided, lists the branch locations for nested trees.
5885
If one argument is provided, display the branch location for that tree.
5886
If two arguments are provided, set the branch location for that tree.
5891
takes_args = ['path?', 'location?']
5893
def run(self, path=None, location=None):
5895
if path is not None:
5897
tree, branch, relpath =(
5898
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5899
if path is not None:
5902
tree = branch.basis_tree()
5904
info = branch._get_all_reference_info().iteritems()
5905
self._display_reference_info(tree, branch, info)
5907
file_id = tree.path2id(path)
5909
raise errors.NotVersionedError(path)
5910
if location is None:
5911
info = [(file_id, branch.get_reference_info(file_id))]
5912
self._display_reference_info(tree, branch, info)
5914
branch.set_reference_info(file_id, path, location)
5916
def _display_reference_info(self, tree, branch, info):
5918
for file_id, (path, location) in info:
5920
path = tree.id2path(file_id)
5921
except errors.NoSuchId:
5923
ref_list.append((path, location))
5924
for path, location in sorted(ref_list):
5925
self.outf.write('%s %s\n' % (path, location))
5928
# these get imported and then picked up by the scan for cmd_*
5929
# TODO: Some more consistent way to split command definitions across files;
5930
# we do need to load at least some information about them to know of
5931
# aliases. ideally we would avoid loading the implementation until the
5932
# details were needed.
5933
from bzrlib.cmd_version_info import cmd_version_info
5934
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5935
from bzrlib.bundle.commands import (
5938
from bzrlib.foreign import cmd_dpush
5939
from bzrlib.sign_my_commits import cmd_sign_my_commits
5940
from bzrlib.weave_commands import cmd_versionedfile_list, \
5941
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
