1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
46
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
58
from bzrlib.smtp_connection import SMTPConnection
59
from bzrlib.workingtree import WorkingTree
62
from bzrlib.commands import Command, display_command
63
from bzrlib.option import (
70
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
73
def tree_files(file_list, default_branch=u'.', canonicalize=True,
76
return internal_tree_files(file_list, default_branch, canonicalize,
78
except errors.FileInWrongBranch, e:
79
raise errors.BzrCommandError("%s is not in the same branch as %s" %
80
(e.path, file_list[0]))
83
def tree_files_for_add(file_list):
85
Return a tree and list of absolute paths from a file list.
87
Similar to tree_files, but add handles files a bit differently, so it a
88
custom implementation. In particular, MutableTreeTree.smart_add expects
89
absolute paths, which it immediately converts to relative paths.
91
# FIXME Would be nice to just return the relative paths like
92
# internal_tree_files does, but there are a large number of unit tests
93
# that assume the current interface to mutabletree.smart_add
95
tree, relpath = WorkingTree.open_containing(file_list[0])
96
if tree.supports_views():
97
view_files = tree.views.lookup_view()
99
for filename in file_list:
100
if not osutils.is_inside_any(view_files, filename):
101
raise errors.FileOutsideView(filename, view_files)
102
file_list = file_list[:]
103
file_list[0] = tree.abspath(relpath)
105
tree = WorkingTree.open_containing(u'.')[0]
106
if tree.supports_views():
107
view_files = tree.views.lookup_view()
109
file_list = view_files
110
view_str = views.view_display_str(view_files)
111
note("Ignoring files outside view. View is %s" % view_str)
112
return tree, file_list
115
def _get_one_revision(command_name, revisions):
116
if revisions is None:
118
if len(revisions) != 1:
119
raise errors.BzrCommandError(
120
'bzr %s --revision takes exactly one revision identifier' % (
125
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
126
"""Get a revision tree. Not suitable for commands that change the tree.
128
Specifically, the basis tree in dirstate trees is coupled to the dirstate
129
and doing a commit/uncommit/pull will at best fail due to changing the
132
If tree is passed in, it should be already locked, for lifetime management
133
of the trees internal cached state.
137
if revisions is None:
139
rev_tree = tree.basis_tree()
141
rev_tree = branch.basis_tree()
143
revision = _get_one_revision(command_name, revisions)
144
rev_tree = revision.as_tree(branch)
148
# XXX: Bad function name; should possibly also be a class method of
149
# WorkingTree rather than a function.
150
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
152
"""Convert command-line paths to a WorkingTree and relative paths.
154
This is typically used for command-line processors that take one or
155
more filenames, and infer the workingtree that contains them.
157
The filenames given are not required to exist.
159
:param file_list: Filenames to convert.
161
:param default_branch: Fallback tree path to use if file_list is empty or
164
:param apply_view: if True and a view is set, apply it or check that
165
specified files are within it
167
:return: workingtree, [relative_paths]
169
if file_list is None or len(file_list) == 0:
170
tree = WorkingTree.open_containing(default_branch)[0]
171
if tree.supports_views() and apply_view:
172
view_files = tree.views.lookup_view()
174
file_list = view_files
175
view_str = views.view_display_str(view_files)
176
note("Ignoring files outside view. View is %s" % view_str)
177
return tree, file_list
178
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
179
return tree, safe_relpath_files(tree, file_list, canonicalize,
180
apply_view=apply_view)
183
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
184
"""Convert file_list into a list of relpaths in tree.
186
:param tree: A tree to operate on.
187
:param file_list: A list of user provided paths or None.
188
:param apply_view: if True and a view is set, apply it or check that
189
specified files are within it
190
:return: A list of relative paths.
191
:raises errors.PathNotChild: When a provided path is in a different tree
194
if file_list is None:
196
if tree.supports_views() and apply_view:
197
view_files = tree.views.lookup_view()
201
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
202
# doesn't - fix that up here before we enter the loop.
204
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
207
for filename in file_list:
209
relpath = fixer(osutils.dereference_path(filename))
210
if view_files and not osutils.is_inside_any(view_files, relpath):
211
raise errors.FileOutsideView(filename, view_files)
212
new_list.append(relpath)
213
except errors.PathNotChild:
214
raise errors.FileInWrongBranch(tree.branch, filename)
218
def _get_view_info_for_change_reporter(tree):
219
"""Get the view information from a tree for change reporting."""
222
current_view = tree.views.get_view_info()[0]
223
if current_view is not None:
224
view_info = (current_view, tree.views.lookup_view())
225
except errors.ViewsNotSupported:
230
# TODO: Make sure no commands unconditionally use the working directory as a
231
# branch. If a filename argument is used, the first of them should be used to
232
# specify the branch. (Perhaps this can be factored out into some kind of
233
# Argument class, representing a file in a branch, where the first occurrence
236
class cmd_status(Command):
237
"""Display status summary.
239
This reports on versioned and unknown files, reporting them
240
grouped by state. Possible states are:
243
Versioned in the working copy but not in the previous revision.
246
Versioned in the previous revision but removed or deleted
250
Path of this file changed from the previous revision;
251
the text may also have changed. This includes files whose
252
parent directory was renamed.
255
Text has changed since the previous revision.
258
File kind has been changed (e.g. from file to directory).
261
Not versioned and not matching an ignore pattern.
263
Additionally for directories, symlinks and files with an executable
264
bit, Bazaar indicates their type using a trailing character: '/', '@'
267
To see ignored files use 'bzr ignored'. For details on the
268
changes to file texts, use 'bzr diff'.
270
Note that --short or -S gives status flags for each item, similar
271
to Subversion's status command. To get output similar to svn -q,
274
If no arguments are specified, the status of the entire working
275
directory is shown. Otherwise, only the status of the specified
276
files or directories is reported. If a directory is given, status
277
is reported for everything inside that directory.
279
Before merges are committed, the pending merge tip revisions are
280
shown. To see all pending merge revisions, use the -v option.
281
To skip the display of pending merge information altogether, use
282
the no-pending option or specify a file/directory.
284
If a revision argument is given, the status is calculated against
285
that revision, or between two revisions if two are provided.
288
# TODO: --no-recurse, --recurse options
290
takes_args = ['file*']
291
takes_options = ['show-ids', 'revision', 'change', 'verbose',
292
Option('short', help='Use short status indicators.',
294
Option('versioned', help='Only show versioned files.',
296
Option('no-pending', help='Don\'t show pending merges.',
299
aliases = ['st', 'stat']
301
encoding_type = 'replace'
302
_see_also = ['diff', 'revert', 'status-flags']
305
def run(self, show_ids=False, file_list=None, revision=None, short=False,
306
versioned=False, no_pending=False, verbose=False):
307
from bzrlib.status import show_tree_status
309
if revision and len(revision) > 2:
310
raise errors.BzrCommandError('bzr status --revision takes exactly'
311
' one or two revision specifiers')
313
tree, relfile_list = tree_files(file_list)
314
# Avoid asking for specific files when that is not needed.
315
if relfile_list == ['']:
317
# Don't disable pending merges for full trees other than '.'.
318
if file_list == ['.']:
320
# A specific path within a tree was given.
321
elif relfile_list is not None:
323
show_tree_status(tree, show_ids=show_ids,
324
specific_files=relfile_list, revision=revision,
325
to_file=self.outf, short=short, versioned=versioned,
326
show_pending=(not no_pending), verbose=verbose)
329
class cmd_cat_revision(Command):
330
"""Write out metadata for a revision.
332
The revision to print can either be specified by a specific
333
revision identifier, or you can use --revision.
337
takes_args = ['revision_id?']
338
takes_options = ['revision']
339
# cat-revision is more for frontends so should be exact
343
def run(self, revision_id=None, revision=None):
344
if revision_id is not None and revision is not None:
345
raise errors.BzrCommandError('You can only supply one of'
346
' revision_id or --revision')
347
if revision_id is None and revision is None:
348
raise errors.BzrCommandError('You must supply either'
349
' --revision or a revision_id')
350
b = WorkingTree.open_containing(u'.')[0].branch
352
# TODO: jam 20060112 should cat-revision always output utf-8?
353
if revision_id is not None:
354
revision_id = osutils.safe_revision_id(revision_id, warn=False)
356
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
357
except errors.NoSuchRevision:
358
msg = "The repository %s contains no revision %s." % (b.repository.base,
360
raise errors.BzrCommandError(msg)
361
elif revision is not None:
364
raise errors.BzrCommandError('You cannot specify a NULL'
366
rev_id = rev.as_revision_id(b)
367
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
370
class cmd_dump_btree(Command):
371
"""Dump the contents of a btree index file to stdout.
373
PATH is a btree index file, it can be any URL. This includes things like
374
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
376
By default, the tuples stored in the index file will be displayed. With
377
--raw, we will uncompress the pages, but otherwise display the raw bytes
381
# TODO: Do we want to dump the internal nodes as well?
382
# TODO: It would be nice to be able to dump the un-parsed information,
383
# rather than only going through iter_all_entries. However, this is
384
# good enough for a start
386
encoding_type = 'exact'
387
takes_args = ['path']
388
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
389
' rather than the parsed tuples.'),
392
def run(self, path, raw=False):
393
dirname, basename = osutils.split(path)
394
t = transport.get_transport(dirname)
396
self._dump_raw_bytes(t, basename)
398
self._dump_entries(t, basename)
400
def _get_index_and_bytes(self, trans, basename):
401
"""Create a BTreeGraphIndex and raw bytes."""
402
bt = btree_index.BTreeGraphIndex(trans, basename, None)
403
bytes = trans.get_bytes(basename)
404
bt._file = cStringIO.StringIO(bytes)
405
bt._size = len(bytes)
408
def _dump_raw_bytes(self, trans, basename):
411
# We need to parse at least the root node.
412
# This is because the first page of every row starts with an
413
# uncompressed header.
414
bt, bytes = self._get_index_and_bytes(trans, basename)
415
for page_idx, page_start in enumerate(xrange(0, len(bytes),
416
btree_index._PAGE_SIZE)):
417
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
418
page_bytes = bytes[page_start:page_end]
420
self.outf.write('Root node:\n')
421
header_end, data = bt._parse_header_from_bytes(page_bytes)
422
self.outf.write(page_bytes[:header_end])
424
self.outf.write('\nPage %d\n' % (page_idx,))
425
decomp_bytes = zlib.decompress(page_bytes)
426
self.outf.write(decomp_bytes)
427
self.outf.write('\n')
429
def _dump_entries(self, trans, basename):
431
st = trans.stat(basename)
432
except errors.TransportNotPossible:
433
# We can't stat, so we'll fake it because we have to do the 'get()'
435
bt, _ = self._get_index_and_bytes(trans, basename)
437
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
438
for node in bt.iter_all_entries():
439
# Node is made up of:
440
# (index, key, value, [references])
441
refs_as_tuples = static_tuple.as_tuples(node[3])
442
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
443
self.outf.write('%s\n' % (as_tuple,))
446
class cmd_remove_tree(Command):
447
"""Remove the working tree from a given branch/checkout.
449
Since a lightweight checkout is little more than a working tree
450
this will refuse to run against one.
452
To re-create the working tree, use "bzr checkout".
454
_see_also = ['checkout', 'working-trees']
455
takes_args = ['location?']
458
help='Remove the working tree even if it has '
459
'uncommitted changes.'),
462
def run(self, location='.', force=False):
463
d = bzrdir.BzrDir.open(location)
466
working = d.open_workingtree()
467
except errors.NoWorkingTree:
468
raise errors.BzrCommandError("No working tree to remove")
469
except errors.NotLocalUrl:
470
raise errors.BzrCommandError("You cannot remove the working tree"
473
if (working.has_changes()):
474
raise errors.UncommittedChanges(working)
476
working_path = working.bzrdir.root_transport.base
477
branch_path = working.branch.bzrdir.root_transport.base
478
if working_path != branch_path:
479
raise errors.BzrCommandError("You cannot remove the working tree"
480
" from a lightweight checkout")
482
d.destroy_workingtree()
485
class cmd_revno(Command):
486
"""Show current revision number.
488
This is equal to the number of revisions on this branch.
492
takes_args = ['location?']
494
Option('tree', help='Show revno of working tree'),
498
def run(self, tree=False, location=u'.'):
501
wt = WorkingTree.open_containing(location)[0]
503
except (errors.NoWorkingTree, errors.NotLocalUrl):
504
raise errors.NoWorkingTree(location)
506
revid = wt.last_revision()
508
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
509
except errors.NoSuchRevision:
511
revno = ".".join(str(n) for n in revno_t)
515
b = Branch.open_containing(location)[0]
522
self.outf.write(str(revno) + '\n')
525
class cmd_revision_info(Command):
526
"""Show revision number and revision id for a given revision identifier.
529
takes_args = ['revision_info*']
533
help='Branch to examine, '
534
'rather than the one containing the working directory.',
538
Option('tree', help='Show revno of working tree'),
542
def run(self, revision=None, directory=u'.', tree=False,
543
revision_info_list=[]):
546
wt = WorkingTree.open_containing(directory)[0]
549
except (errors.NoWorkingTree, errors.NotLocalUrl):
551
b = Branch.open_containing(directory)[0]
555
if revision is not None:
556
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
557
if revision_info_list is not None:
558
for rev_str in revision_info_list:
559
rev_spec = RevisionSpec.from_string(rev_str)
560
revision_ids.append(rev_spec.as_revision_id(b))
561
# No arguments supplied, default to the last revision
562
if len(revision_ids) == 0:
565
raise errors.NoWorkingTree(directory)
566
revision_ids.append(wt.last_revision())
568
revision_ids.append(b.last_revision())
572
for revision_id in revision_ids:
574
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
575
revno = '.'.join(str(i) for i in dotted_revno)
576
except errors.NoSuchRevision:
578
maxlen = max(maxlen, len(revno))
579
revinfos.append([revno, revision_id])
587
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
590
class cmd_add(Command):
591
"""Add specified files or directories.
593
In non-recursive mode, all the named items are added, regardless
594
of whether they were previously ignored. A warning is given if
595
any of the named files are already versioned.
597
In recursive mode (the default), files are treated the same way
598
but the behaviour for directories is different. Directories that
599
are already versioned do not give a warning. All directories,
600
whether already versioned or not, are searched for files or
601
subdirectories that are neither versioned or ignored, and these
602
are added. This search proceeds recursively into versioned
603
directories. If no names are given '.' is assumed.
605
Therefore simply saying 'bzr add' will version all files that
606
are currently unknown.
608
Adding a file whose parent directory is not versioned will
609
implicitly add the parent, and so on up to the root. This means
610
you should never need to explicitly add a directory, they'll just
611
get added when you add a file in the directory.
613
--dry-run will show which files would be added, but not actually
616
--file-ids-from will try to use the file ids from the supplied path.
617
It looks up ids trying to find a matching parent directory with the
618
same filename, and then by pure path. This option is rarely needed
619
but can be useful when adding the same logical file into two
620
branches that will be merged later (without showing the two different
621
adds as a conflict). It is also useful when merging another project
622
into a subdirectory of this one.
624
Any files matching patterns in the ignore list will not be added
625
unless they are explicitly mentioned.
627
takes_args = ['file*']
630
help="Don't recursively add the contents of directories."),
632
help="Show what would be done, but don't actually do anything."),
634
Option('file-ids-from',
636
help='Lookup file ids from this tree.'),
638
encoding_type = 'replace'
639
_see_also = ['remove', 'ignore']
641
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
646
if file_ids_from is not None:
648
base_tree, base_path = WorkingTree.open_containing(
650
except errors.NoWorkingTree:
651
base_branch, base_path = Branch.open_containing(
653
base_tree = base_branch.basis_tree()
655
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
656
to_file=self.outf, should_print=(not is_quiet()))
658
action = bzrlib.add.AddAction(to_file=self.outf,
659
should_print=(not is_quiet()))
662
base_tree.lock_read()
664
tree, file_list = tree_files_for_add(file_list)
665
added, ignored = tree.smart_add(file_list, not
666
no_recurse, action=action, save=not dry_run)
668
if base_tree is not None:
672
for glob in sorted(ignored.keys()):
673
for path in ignored[glob]:
674
self.outf.write("ignored %s matching \"%s\"\n"
678
class cmd_mkdir(Command):
679
"""Create a new versioned directory.
681
This is equivalent to creating the directory and then adding it.
684
takes_args = ['dir+']
685
encoding_type = 'replace'
687
def run(self, dir_list):
690
wt, dd = WorkingTree.open_containing(d)
692
self.outf.write('added %s\n' % d)
695
class cmd_relpath(Command):
696
"""Show path of a file relative to root"""
698
takes_args = ['filename']
702
def run(self, filename):
703
# TODO: jam 20050106 Can relpath return a munged path if
704
# sys.stdout encoding cannot represent it?
705
tree, relpath = WorkingTree.open_containing(filename)
706
self.outf.write(relpath)
707
self.outf.write('\n')
710
class cmd_inventory(Command):
711
"""Show inventory of the current working copy or a revision.
713
It is possible to limit the output to a particular entry
714
type using the --kind option. For example: --kind file.
716
It is also possible to restrict the list of files to a specific
717
set. For example: bzr inventory --show-ids this/file
726
help='List entries of a particular kind: file, directory, symlink.',
729
takes_args = ['file*']
732
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
733
if kind and kind not in ['file', 'directory', 'symlink']:
734
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
736
revision = _get_one_revision('inventory', revision)
737
work_tree, file_list = tree_files(file_list)
738
work_tree.lock_read()
740
if revision is not None:
741
tree = revision.as_tree(work_tree.branch)
743
extra_trees = [work_tree]
749
if file_list is not None:
750
file_ids = tree.paths2ids(file_list, trees=extra_trees,
751
require_versioned=True)
752
# find_ids_across_trees may include some paths that don't
754
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
755
for file_id in file_ids if file_id in tree)
757
entries = tree.inventory.entries()
760
if tree is not work_tree:
763
for path, entry in entries:
764
if kind and kind != entry.kind:
767
self.outf.write('%-50s %s\n' % (path, entry.file_id))
769
self.outf.write(path)
770
self.outf.write('\n')
773
class cmd_mv(Command):
774
"""Move or rename a file.
777
bzr mv OLDNAME NEWNAME
779
bzr mv SOURCE... DESTINATION
781
If the last argument is a versioned directory, all the other names
782
are moved into it. Otherwise, there must be exactly two arguments
783
and the file is changed to a new name.
785
If OLDNAME does not exist on the filesystem but is versioned and
786
NEWNAME does exist on the filesystem but is not versioned, mv
787
assumes that the file has been manually moved and only updates
788
its internal inventory to reflect that change.
789
The same is valid when moving many SOURCE files to a DESTINATION.
791
Files cannot be moved between branches.
794
takes_args = ['names*']
795
takes_options = [Option("after", help="Move only the bzr identifier"
796
" of the file, because the file has already been moved."),
797
Option('auto', help='Automatically guess renames.'),
798
Option('dry-run', help='Avoid making changes when guessing renames.'),
800
aliases = ['move', 'rename']
801
encoding_type = 'replace'
803
def run(self, names_list, after=False, auto=False, dry_run=False):
805
return self.run_auto(names_list, after, dry_run)
807
raise errors.BzrCommandError('--dry-run requires --auto.')
808
if names_list is None:
810
if len(names_list) < 2:
811
raise errors.BzrCommandError("missing file argument")
812
tree, rel_names = tree_files(names_list, canonicalize=False)
813
tree.lock_tree_write()
815
self._run(tree, names_list, rel_names, after)
819
def run_auto(self, names_list, after, dry_run):
820
if names_list is not None and len(names_list) > 1:
821
raise errors.BzrCommandError('Only one path may be specified to'
824
raise errors.BzrCommandError('--after cannot be specified with'
826
work_tree, file_list = tree_files(names_list, default_branch='.')
827
work_tree.lock_tree_write()
829
rename_map.RenameMap.guess_renames(work_tree, dry_run)
833
def _run(self, tree, names_list, rel_names, after):
834
into_existing = osutils.isdir(names_list[-1])
835
if into_existing and len(names_list) == 2:
837
# a. case-insensitive filesystem and change case of dir
838
# b. move directory after the fact (if the source used to be
839
# a directory, but now doesn't exist in the working tree
840
# and the target is an existing directory, just rename it)
841
if (not tree.case_sensitive
842
and rel_names[0].lower() == rel_names[1].lower()):
843
into_existing = False
846
# 'fix' the case of a potential 'from'
847
from_id = tree.path2id(
848
tree.get_canonical_inventory_path(rel_names[0]))
849
if (not osutils.lexists(names_list[0]) and
850
from_id and inv.get_file_kind(from_id) == "directory"):
851
into_existing = False
854
# move into existing directory
855
# All entries reference existing inventory items, so fix them up
856
# for cicp file-systems.
857
rel_names = tree.get_canonical_inventory_paths(rel_names)
858
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
860
self.outf.write("%s => %s\n" % (src, dest))
862
if len(names_list) != 2:
863
raise errors.BzrCommandError('to mv multiple files the'
864
' destination must be a versioned'
867
# for cicp file-systems: the src references an existing inventory
869
src = tree.get_canonical_inventory_path(rel_names[0])
870
# Find the canonical version of the destination: In all cases, the
871
# parent of the target must be in the inventory, so we fetch the
872
# canonical version from there (we do not always *use* the
873
# canonicalized tail portion - we may be attempting to rename the
875
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
876
dest_parent = osutils.dirname(canon_dest)
877
spec_tail = osutils.basename(rel_names[1])
878
# For a CICP file-system, we need to avoid creating 2 inventory
879
# entries that differ only by case. So regardless of the case
880
# we *want* to use (ie, specified by the user or the file-system),
881
# we must always choose to use the case of any existing inventory
882
# items. The only exception to this is when we are attempting a
883
# case-only rename (ie, canonical versions of src and dest are
885
dest_id = tree.path2id(canon_dest)
886
if dest_id is None or tree.path2id(src) == dest_id:
887
# No existing item we care about, so work out what case we
888
# are actually going to use.
890
# If 'after' is specified, the tail must refer to a file on disk.
892
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
894
# pathjoin with an empty tail adds a slash, which breaks
896
dest_parent_fq = tree.basedir
898
dest_tail = osutils.canonical_relpath(
900
osutils.pathjoin(dest_parent_fq, spec_tail))
902
# not 'after', so case as specified is used
903
dest_tail = spec_tail
905
# Use the existing item so 'mv' fails with AlreadyVersioned.
906
dest_tail = os.path.basename(canon_dest)
907
dest = osutils.pathjoin(dest_parent, dest_tail)
908
mutter("attempting to move %s => %s", src, dest)
909
tree.rename_one(src, dest, after=after)
911
self.outf.write("%s => %s\n" % (src, dest))
914
class cmd_pull(Command):
915
"""Turn this branch into a mirror of another branch.
917
By default, this command only works on branches that have not diverged.
918
Branches are considered diverged if the destination branch's most recent
919
commit is one that has not been merged (directly or indirectly) into the
922
If branches have diverged, you can use 'bzr merge' to integrate the changes
923
from one into the other. Once one branch has merged, the other should
924
be able to pull it again.
926
If you want to replace your local changes and just want your branch to
927
match the remote one, use pull --overwrite. This will work even if the two
928
branches have diverged.
930
If there is no default location set, the first pull will set it. After
931
that, you can omit the location to use the default. To change the
932
default, use --remember. The value will only be saved if the remote
933
location can be accessed.
935
Note: The location can be specified either in the form of a branch,
936
or in the form of a path to a file containing a merge directive generated
940
_see_also = ['push', 'update', 'status-flags', 'send']
941
takes_options = ['remember', 'overwrite', 'revision',
942
custom_help('verbose',
943
help='Show logs of pulled revisions.'),
945
help='Branch to pull into, '
946
'rather than the one containing the working directory.',
951
help="Perform a local pull in a bound "
952
"branch. Local pulls are not applied to "
956
takes_args = ['location?']
957
encoding_type = 'replace'
959
def run(self, location=None, remember=False, overwrite=False,
960
revision=None, verbose=False,
961
directory=None, local=False):
962
# FIXME: too much stuff is in the command class
965
if directory is None:
968
tree_to = WorkingTree.open_containing(directory)[0]
969
branch_to = tree_to.branch
970
except errors.NoWorkingTree:
972
branch_to = Branch.open_containing(directory)[0]
974
if local and not branch_to.get_bound_location():
975
raise errors.LocalRequiresBoundBranch()
977
possible_transports = []
978
if location is not None:
980
mergeable = bundle.read_mergeable_from_url(location,
981
possible_transports=possible_transports)
982
except errors.NotABundle:
985
stored_loc = branch_to.get_parent()
987
if stored_loc is None:
988
raise errors.BzrCommandError("No pull location known or"
991
display_url = urlutils.unescape_for_display(stored_loc,
994
self.outf.write("Using saved parent location: %s\n" % display_url)
995
location = stored_loc
997
revision = _get_one_revision('pull', revision)
998
if mergeable is not None:
999
if revision is not None:
1000
raise errors.BzrCommandError(
1001
'Cannot use -r with merge directives or bundles')
1002
mergeable.install_revisions(branch_to.repository)
1003
base_revision_id, revision_id, verified = \
1004
mergeable.get_merge_request(branch_to.repository)
1005
branch_from = branch_to
1007
branch_from = Branch.open(location,
1008
possible_transports=possible_transports)
1010
if branch_to.get_parent() is None or remember:
1011
branch_to.set_parent(branch_from.base)
1013
if branch_from is not branch_to:
1014
branch_from.lock_read()
1016
if revision is not None:
1017
revision_id = revision.as_revision_id(branch_from)
1019
branch_to.lock_write()
1021
if tree_to is not None:
1022
view_info = _get_view_info_for_change_reporter(tree_to)
1023
change_reporter = delta._ChangeReporter(
1024
unversioned_filter=tree_to.is_ignored,
1025
view_info=view_info)
1026
result = tree_to.pull(
1027
branch_from, overwrite, revision_id, change_reporter,
1028
possible_transports=possible_transports, local=local)
1030
result = branch_to.pull(
1031
branch_from, overwrite, revision_id, local=local)
1033
result.report(self.outf)
1034
if verbose and result.old_revid != result.new_revid:
1035
log.show_branch_change(
1036
branch_to, self.outf, result.old_revno,
1041
if branch_from is not branch_to:
1042
branch_from.unlock()
1045
class cmd_push(Command):
1046
"""Update a mirror of this branch.
1048
The target branch will not have its working tree populated because this
1049
is both expensive, and is not supported on remote file systems.
1051
Some smart servers or protocols *may* put the working tree in place in
1054
This command only works on branches that have not diverged. Branches are
1055
considered diverged if the destination branch's most recent commit is one
1056
that has not been merged (directly or indirectly) by the source branch.
1058
If branches have diverged, you can use 'bzr push --overwrite' to replace
1059
the other branch completely, discarding its unmerged changes.
1061
If you want to ensure you have the different changes in the other branch,
1062
do a merge (see bzr help merge) from the other branch, and commit that.
1063
After that you will be able to do a push without '--overwrite'.
1065
If there is no default push location set, the first push will set it.
1066
After that, you can omit the location to use the default. To change the
1067
default, use --remember. The value will only be saved if the remote
1068
location can be accessed.
1071
_see_also = ['pull', 'update', 'working-trees']
1072
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1073
Option('create-prefix',
1074
help='Create the path leading up to the branch '
1075
'if it does not already exist.'),
1077
help='Branch to push from, '
1078
'rather than the one containing the working directory.',
1082
Option('use-existing-dir',
1083
help='By default push will fail if the target'
1084
' directory exists, but does not already'
1085
' have a control directory. This flag will'
1086
' allow push to proceed.'),
1088
help='Create a stacked branch that references the public location '
1089
'of the parent branch.'),
1090
Option('stacked-on',
1091
help='Create a stacked branch that refers to another branch '
1092
'for the commit history. Only the work not present in the '
1093
'referenced branch is included in the branch created.',
1096
help='Refuse to push if there are uncommitted changes in'
1097
' the working tree, --no-strict disables the check.'),
1099
takes_args = ['location?']
1100
encoding_type = 'replace'
1102
def run(self, location=None, remember=False, overwrite=False,
1103
create_prefix=False, verbose=False, revision=None,
1104
use_existing_dir=False, directory=None, stacked_on=None,
1105
stacked=False, strict=None):
1106
from bzrlib.push import _show_push_branch
1108
if directory is None:
1110
# Get the source branch
1112
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1114
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1115
if strict is None: strict = True # default value
1116
# Get the tip's revision_id
1117
revision = _get_one_revision('push', revision)
1118
if revision is not None:
1119
revision_id = revision.in_history(br_from).rev_id
1122
if strict and tree is not None and revision_id is None:
1123
if (tree.has_changes()):
1124
raise errors.UncommittedChanges(
1125
tree, more='Use --no-strict to force the push.')
1126
if tree.last_revision() != tree.branch.last_revision():
1127
# The tree has lost sync with its branch, there is little
1128
# chance that the user is aware of it but he can still force
1129
# the push with --no-strict
1130
raise errors.OutOfDateTree(
1131
tree, more='Use --no-strict to force the push.')
1133
# Get the stacked_on branch, if any
1134
if stacked_on is not None:
1135
stacked_on = urlutils.normalize_url(stacked_on)
1137
parent_url = br_from.get_parent()
1139
parent = Branch.open(parent_url)
1140
stacked_on = parent.get_public_branch()
1142
# I considered excluding non-http url's here, thus forcing
1143
# 'public' branches only, but that only works for some
1144
# users, so it's best to just depend on the user spotting an
1145
# error by the feedback given to them. RBC 20080227.
1146
stacked_on = parent_url
1148
raise errors.BzrCommandError(
1149
"Could not determine branch to refer to.")
1151
# Get the destination location
1152
if location is None:
1153
stored_loc = br_from.get_push_location()
1154
if stored_loc is None:
1155
raise errors.BzrCommandError(
1156
"No push location known or specified.")
1158
display_url = urlutils.unescape_for_display(stored_loc,
1160
self.outf.write("Using saved push location: %s\n" % display_url)
1161
location = stored_loc
1163
_show_push_branch(br_from, revision_id, location, self.outf,
1164
verbose=verbose, overwrite=overwrite, remember=remember,
1165
stacked_on=stacked_on, create_prefix=create_prefix,
1166
use_existing_dir=use_existing_dir)
1169
class cmd_branch(Command):
1170
"""Create a new branch that is a copy of an existing branch.
1172
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1173
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1174
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1175
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1176
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1179
To retrieve the branch as of a particular revision, supply the --revision
1180
parameter, as in "branch foo/bar -r 5".
1183
_see_also = ['checkout']
1184
takes_args = ['from_location', 'to_location?']
1185
takes_options = ['revision', Option('hardlink',
1186
help='Hard-link working tree files where possible.'),
1188
help="Create a branch without a working-tree."),
1190
help="Switch the checkout in the current directory "
1191
"to the new branch."),
1193
help='Create a stacked branch referring to the source branch. '
1194
'The new branch will depend on the availability of the source '
1195
'branch for all operations.'),
1196
Option('standalone',
1197
help='Do not use a shared repository, even if available.'),
1198
Option('use-existing-dir',
1199
help='By default branch will fail if the target'
1200
' directory exists, but does not already'
1201
' have a control directory. This flag will'
1202
' allow branch to proceed.'),
1204
aliases = ['get', 'clone']
1206
def run(self, from_location, to_location=None, revision=None,
1207
hardlink=False, stacked=False, standalone=False, no_tree=False,
1208
use_existing_dir=False, switch=False):
1209
from bzrlib import switch as _mod_switch
1210
from bzrlib.tag import _merge_tags_if_possible
1211
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1213
revision = _get_one_revision('branch', revision)
1216
if revision is not None:
1217
revision_id = revision.as_revision_id(br_from)
1219
# FIXME - wt.last_revision, fallback to branch, fall back to
1220
# None or perhaps NULL_REVISION to mean copy nothing
1222
revision_id = br_from.last_revision()
1223
if to_location is None:
1224
to_location = urlutils.derive_to_location(from_location)
1225
to_transport = transport.get_transport(to_location)
1227
to_transport.mkdir('.')
1228
except errors.FileExists:
1229
if not use_existing_dir:
1230
raise errors.BzrCommandError('Target directory "%s" '
1231
'already exists.' % to_location)
1234
bzrdir.BzrDir.open_from_transport(to_transport)
1235
except errors.NotBranchError:
1238
raise errors.AlreadyBranchError(to_location)
1239
except errors.NoSuchFile:
1240
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1243
# preserve whatever source format we have.
1244
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1245
possible_transports=[to_transport],
1246
accelerator_tree=accelerator_tree,
1247
hardlink=hardlink, stacked=stacked,
1248
force_new_repo=standalone,
1249
create_tree_if_local=not no_tree,
1250
source_branch=br_from)
1251
branch = dir.open_branch()
1252
except errors.NoSuchRevision:
1253
to_transport.delete_tree('.')
1254
msg = "The branch %s has no revision %s." % (from_location,
1256
raise errors.BzrCommandError(msg)
1257
_merge_tags_if_possible(br_from, branch)
1258
# If the source branch is stacked, the new branch may
1259
# be stacked whether we asked for that explicitly or not.
1260
# We therefore need a try/except here and not just 'if stacked:'
1262
note('Created new stacked branch referring to %s.' %
1263
branch.get_stacked_on_url())
1264
except (errors.NotStacked, errors.UnstackableBranchFormat,
1265
errors.UnstackableRepositoryFormat), e:
1266
note('Branched %d revision(s).' % branch.revno())
1268
# Switch to the new branch
1269
wt, _ = WorkingTree.open_containing('.')
1270
_mod_switch.switch(wt.bzrdir, branch)
1271
note('Switched to branch: %s',
1272
urlutils.unescape_for_display(branch.base, 'utf-8'))
1277
class cmd_checkout(Command):
1278
"""Create a new checkout of an existing branch.
1280
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1281
the branch found in '.'. This is useful if you have removed the working tree
1282
or if it was never created - i.e. if you pushed the branch to its current
1283
location using SFTP.
1285
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1286
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1287
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1288
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1289
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1292
To retrieve the branch as of a particular revision, supply the --revision
1293
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1294
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1298
_see_also = ['checkouts', 'branch']
1299
takes_args = ['branch_location?', 'to_location?']
1300
takes_options = ['revision',
1301
Option('lightweight',
1302
help="Perform a lightweight checkout. Lightweight "
1303
"checkouts depend on access to the branch for "
1304
"every operation. Normal checkouts can perform "
1305
"common operations like diff and status without "
1306
"such access, and also support local commits."
1308
Option('files-from', type=str,
1309
help="Get file contents from this tree."),
1311
help='Hard-link working tree files where possible.'
1316
def run(self, branch_location=None, to_location=None, revision=None,
1317
lightweight=False, files_from=None, hardlink=False):
1318
if branch_location is None:
1319
branch_location = osutils.getcwd()
1320
to_location = branch_location
1321
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1323
revision = _get_one_revision('checkout', revision)
1324
if files_from is not None:
1325
accelerator_tree = WorkingTree.open(files_from)
1326
if revision is not None:
1327
revision_id = revision.as_revision_id(source)
1330
if to_location is None:
1331
to_location = urlutils.derive_to_location(branch_location)
1332
# if the source and to_location are the same,
1333
# and there is no working tree,
1334
# then reconstitute a branch
1335
if (osutils.abspath(to_location) ==
1336
osutils.abspath(branch_location)):
1338
source.bzrdir.open_workingtree()
1339
except errors.NoWorkingTree:
1340
source.bzrdir.create_workingtree(revision_id)
1342
source.create_checkout(to_location, revision_id, lightweight,
1343
accelerator_tree, hardlink)
1346
class cmd_renames(Command):
1347
"""Show list of renamed files.
1349
# TODO: Option to show renames between two historical versions.
1351
# TODO: Only show renames under dir, rather than in the whole branch.
1352
_see_also = ['status']
1353
takes_args = ['dir?']
1356
def run(self, dir=u'.'):
1357
tree = WorkingTree.open_containing(dir)[0]
1360
new_inv = tree.inventory
1361
old_tree = tree.basis_tree()
1362
old_tree.lock_read()
1364
old_inv = old_tree.inventory
1366
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1367
for f, paths, c, v, p, n, k, e in iterator:
1368
if paths[0] == paths[1]:
1372
renames.append(paths)
1374
for old_name, new_name in renames:
1375
self.outf.write("%s => %s\n" % (old_name, new_name))
1382
class cmd_update(Command):
1383
"""Update a tree to have the latest code committed to its branch.
1385
This will perform a merge into the working tree, and may generate
1386
conflicts. If you have any local changes, you will still
1387
need to commit them after the update for the update to be complete.
1389
If you want to discard your local changes, you can just do a
1390
'bzr revert' instead of 'bzr commit' after the update.
1393
_see_also = ['pull', 'working-trees', 'status-flags']
1394
takes_args = ['dir?']
1395
takes_options = ['revision']
1398
def run(self, dir='.', revision=None):
1399
if revision is not None and len(revision) != 1:
1400
raise errors.BzrCommandError(
1401
"bzr update --revision takes exactly one revision")
1402
tree = WorkingTree.open_containing(dir)[0]
1403
branch = tree.branch
1404
possible_transports = []
1405
master = branch.get_master_branch(
1406
possible_transports=possible_transports)
1407
if master is not None:
1409
branch_location = master.base
1411
tree.lock_tree_write()
1412
branch_location = tree.branch.base
1413
# get rid of the final '/' and be ready for display
1414
branch_location = urlutils.unescape_for_display(branch_location[:-1],
1417
existing_pending_merges = tree.get_parent_ids()[1:]
1418
# potentially get new revisions from the master branch.
1419
# needed for the case where -r N is given, with N not yet
1420
# in the local branch for a heavyweight checkout.
1421
if revision is not None:
1423
rev = revision[0].in_history(branch).rev_id
1424
# no need to run branch.update()
1426
except (errors.NoSuchRevision, errors.InvalidRevisionSpec):
1427
# revision was not there, but is maybe in the master.
1428
old_tip = branch.update(possible_transports)
1429
rev = revision[0].in_history(branch).rev_id
1434
old_tip = branch.update(possible_transports)
1435
rev = branch.last_revision()
1436
if rev == _mod_revision.ensure_null(tree.last_revision()):
1437
revno = branch.revision_id_to_revno(rev)
1438
# XXX: Should say which branch it's up to date with
1439
note("Tree is up to date at revision %d." %
1442
view_info = _get_view_info_for_change_reporter(tree)
1444
conflicts = tree.update(
1445
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1446
possible_transports=possible_transports,
1449
view_info=view_info)
1450
except errors.NoSuchRevision, e:
1451
raise errors.BzrCommandError(
1452
"branch has no revision %s\n"
1453
"bzr update --revision only works"
1454
" for a revision in the branch history"
1456
revno = branch.revision_id_to_revno(
1457
_mod_revision.ensure_null(rev))
1458
note('Updated to revision %d.' % (revno,))
1459
if tree.get_parent_ids()[1:] != existing_pending_merges:
1460
note('Your local commits will now show as pending merges with '
1461
"'bzr status', and can be committed with 'bzr commit'.")
1470
class cmd_info(Command):
1471
"""Show information about a working tree, branch or repository.
1473
This command will show all known locations and formats associated to the
1474
tree, branch or repository.
1476
In verbose mode, statistical information is included with each report.
1477
To see extended statistic information, use a verbosity level of 2 or
1478
higher by specifying the verbose option multiple times, e.g. -vv.
1480
Branches and working trees will also report any missing revisions.
1484
Display information on the format and related locations:
1488
Display the above together with extended format information and
1489
basic statistics (like the number of files in the working tree and
1490
number of revisions in the branch and repository):
1494
Display the above together with number of committers to the branch:
1498
_see_also = ['revno', 'working-trees', 'repositories']
1499
takes_args = ['location?']
1500
takes_options = ['verbose']
1501
encoding_type = 'replace'
1504
def run(self, location=None, verbose=False):
1506
noise_level = get_verbosity_level()
1509
from bzrlib.info import show_bzrdir_info
1510
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1511
verbose=noise_level, outfile=self.outf)
1514
class cmd_remove(Command):
1515
"""Remove files or directories.
1517
This makes bzr stop tracking changes to the specified files. bzr will delete
1518
them if they can easily be recovered using revert. If no options or
1519
parameters are given bzr will scan for files that are being tracked by bzr
1520
but missing in your tree and stop tracking them for you.
1522
takes_args = ['file*']
1523
takes_options = ['verbose',
1524
Option('new', help='Only remove files that have never been committed.'),
1525
RegistryOption.from_kwargs('file-deletion-strategy',
1526
'The file deletion mode to be used.',
1527
title='Deletion Strategy', value_switches=True, enum_switch=False,
1528
safe='Only delete files if they can be'
1529
' safely recovered (default).',
1530
keep='Delete from bzr but leave the working copy.',
1531
force='Delete all the specified files, even if they can not be '
1532
'recovered and even if they are non-empty directories.')]
1533
aliases = ['rm', 'del']
1534
encoding_type = 'replace'
1536
def run(self, file_list, verbose=False, new=False,
1537
file_deletion_strategy='safe'):
1538
tree, file_list = tree_files(file_list)
1540
if file_list is not None:
1541
file_list = [f for f in file_list]
1545
# Heuristics should probably all move into tree.remove_smart or
1548
added = tree.changes_from(tree.basis_tree(),
1549
specific_files=file_list).added
1550
file_list = sorted([f[0] for f in added], reverse=True)
1551
if len(file_list) == 0:
1552
raise errors.BzrCommandError('No matching files.')
1553
elif file_list is None:
1554
# missing files show up in iter_changes(basis) as
1555
# versioned-with-no-kind.
1557
for change in tree.iter_changes(tree.basis_tree()):
1558
# Find paths in the working tree that have no kind:
1559
if change[1][1] is not None and change[6][1] is None:
1560
missing.append(change[1][1])
1561
file_list = sorted(missing, reverse=True)
1562
file_deletion_strategy = 'keep'
1563
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1564
keep_files=file_deletion_strategy=='keep',
1565
force=file_deletion_strategy=='force')
1570
class cmd_file_id(Command):
1571
"""Print file_id of a particular file or directory.
1573
The file_id is assigned when the file is first added and remains the
1574
same through all revisions where the file exists, even when it is
1579
_see_also = ['inventory', 'ls']
1580
takes_args = ['filename']
1583
def run(self, filename):
1584
tree, relpath = WorkingTree.open_containing(filename)
1585
i = tree.path2id(relpath)
1587
raise errors.NotVersionedError(filename)
1589
self.outf.write(i + '\n')
1592
class cmd_file_path(Command):
1593
"""Print path of file_ids to a file or directory.
1595
This prints one line for each directory down to the target,
1596
starting at the branch root.
1600
takes_args = ['filename']
1603
def run(self, filename):
1604
tree, relpath = WorkingTree.open_containing(filename)
1605
fid = tree.path2id(relpath)
1607
raise errors.NotVersionedError(filename)
1608
segments = osutils.splitpath(relpath)
1609
for pos in range(1, len(segments) + 1):
1610
path = osutils.joinpath(segments[:pos])
1611
self.outf.write("%s\n" % tree.path2id(path))
1614
class cmd_reconcile(Command):
1615
"""Reconcile bzr metadata in a branch.
1617
This can correct data mismatches that may have been caused by
1618
previous ghost operations or bzr upgrades. You should only
1619
need to run this command if 'bzr check' or a bzr developer
1620
advises you to run it.
1622
If a second branch is provided, cross-branch reconciliation is
1623
also attempted, which will check that data like the tree root
1624
id which was not present in very early bzr versions is represented
1625
correctly in both branches.
1627
At the same time it is run it may recompress data resulting in
1628
a potential saving in disk space or performance gain.
1630
The branch *MUST* be on a listable system such as local disk or sftp.
1633
_see_also = ['check']
1634
takes_args = ['branch?']
1636
def run(self, branch="."):
1637
from bzrlib.reconcile import reconcile
1638
dir = bzrdir.BzrDir.open(branch)
1642
class cmd_revision_history(Command):
1643
"""Display the list of revision ids on a branch."""
1646
takes_args = ['location?']
1651
def run(self, location="."):
1652
branch = Branch.open_containing(location)[0]
1653
for revid in branch.revision_history():
1654
self.outf.write(revid)
1655
self.outf.write('\n')
1658
class cmd_ancestry(Command):
1659
"""List all revisions merged into this branch."""
1661
_see_also = ['log', 'revision-history']
1662
takes_args = ['location?']
1667
def run(self, location="."):
1669
wt = WorkingTree.open_containing(location)[0]
1670
except errors.NoWorkingTree:
1671
b = Branch.open(location)
1672
last_revision = b.last_revision()
1675
last_revision = wt.last_revision()
1677
revision_ids = b.repository.get_ancestry(last_revision)
1679
for revision_id in revision_ids:
1680
self.outf.write(revision_id + '\n')
1683
class cmd_init(Command):
1684
"""Make a directory into a versioned branch.
1686
Use this to create an empty branch, or before importing an
1689
If there is a repository in a parent directory of the location, then
1690
the history of the branch will be stored in the repository. Otherwise
1691
init creates a standalone branch which carries its own history
1692
in the .bzr directory.
1694
If there is already a branch at the location but it has no working tree,
1695
the tree can be populated with 'bzr checkout'.
1697
Recipe for importing a tree of files::
1703
bzr commit -m "imported project"
1706
_see_also = ['init-repository', 'branch', 'checkout']
1707
takes_args = ['location?']
1709
Option('create-prefix',
1710
help='Create the path leading up to the branch '
1711
'if it does not already exist.'),
1712
RegistryOption('format',
1713
help='Specify a format for this branch. '
1714
'See "help formats".',
1715
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1716
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1717
value_switches=True,
1718
title="Branch format",
1720
Option('append-revisions-only',
1721
help='Never change revnos or the existing log.'
1722
' Append revisions to it only.')
1724
def run(self, location=None, format=None, append_revisions_only=False,
1725
create_prefix=False):
1727
format = bzrdir.format_registry.make_bzrdir('default')
1728
if location is None:
1731
to_transport = transport.get_transport(location)
1733
# The path has to exist to initialize a
1734
# branch inside of it.
1735
# Just using os.mkdir, since I don't
1736
# believe that we want to create a bunch of
1737
# locations if the user supplies an extended path
1739
to_transport.ensure_base()
1740
except errors.NoSuchFile:
1741
if not create_prefix:
1742
raise errors.BzrCommandError("Parent directory of %s"
1744
"\nYou may supply --create-prefix to create all"
1745
" leading parent directories."
1747
to_transport.create_prefix()
1750
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1751
except errors.NotBranchError:
1752
# really a NotBzrDir error...
1753
create_branch = bzrdir.BzrDir.create_branch_convenience
1754
branch = create_branch(to_transport.base, format=format,
1755
possible_transports=[to_transport])
1756
a_bzrdir = branch.bzrdir
1758
from bzrlib.transport.local import LocalTransport
1759
if a_bzrdir.has_branch():
1760
if (isinstance(to_transport, LocalTransport)
1761
and not a_bzrdir.has_workingtree()):
1762
raise errors.BranchExistsWithoutWorkingTree(location)
1763
raise errors.AlreadyBranchError(location)
1764
branch = a_bzrdir.create_branch()
1765
a_bzrdir.create_workingtree()
1766
if append_revisions_only:
1768
branch.set_append_revisions_only(True)
1769
except errors.UpgradeRequired:
1770
raise errors.BzrCommandError('This branch format cannot be set'
1771
' to append-revisions-only. Try --default.')
1773
from bzrlib.info import describe_layout, describe_format
1775
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1776
except (errors.NoWorkingTree, errors.NotLocalUrl):
1778
repository = branch.repository
1779
layout = describe_layout(repository, branch, tree).lower()
1780
format = describe_format(a_bzrdir, repository, branch, tree)
1781
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1782
if repository.is_shared():
1783
#XXX: maybe this can be refactored into transport.path_or_url()
1784
url = repository.bzrdir.root_transport.external_url()
1786
url = urlutils.local_path_from_url(url)
1787
except errors.InvalidURL:
1789
self.outf.write("Using shared repository: %s\n" % url)
1792
class cmd_init_repository(Command):
1793
"""Create a shared repository for branches to share storage space.
1795
New branches created under the repository directory will store their
1796
revisions in the repository, not in the branch directory. For branches
1797
with shared history, this reduces the amount of storage needed and
1798
speeds up the creation of new branches.
1800
If the --no-trees option is given then the branches in the repository
1801
will not have working trees by default. They will still exist as
1802
directories on disk, but they will not have separate copies of the
1803
files at a certain revision. This can be useful for repositories that
1804
store branches which are interacted with through checkouts or remote
1805
branches, such as on a server.
1808
Create a shared repository holding just branches::
1810
bzr init-repo --no-trees repo
1813
Make a lightweight checkout elsewhere::
1815
bzr checkout --lightweight repo/trunk trunk-checkout
1820
_see_also = ['init', 'branch', 'checkout', 'repositories']
1821
takes_args = ["location"]
1822
takes_options = [RegistryOption('format',
1823
help='Specify a format for this repository. See'
1824
' "bzr help formats" for details.',
1825
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1826
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1827
value_switches=True, title='Repository format'),
1829
help='Branches in the repository will default to'
1830
' not having a working tree.'),
1832
aliases = ["init-repo"]
1834
def run(self, location, format=None, no_trees=False):
1836
format = bzrdir.format_registry.make_bzrdir('default')
1838
if location is None:
1841
to_transport = transport.get_transport(location)
1842
to_transport.ensure_base()
1844
newdir = format.initialize_on_transport(to_transport)
1845
repo = newdir.create_repository(shared=True)
1846
repo.set_make_working_trees(not no_trees)
1848
from bzrlib.info import show_bzrdir_info
1849
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1852
class cmd_diff(Command):
1853
"""Show differences in the working tree, between revisions or branches.
1855
If no arguments are given, all changes for the current tree are listed.
1856
If files are given, only the changes in those files are listed.
1857
Remote and multiple branches can be compared by using the --old and
1858
--new options. If not provided, the default for both is derived from
1859
the first argument, if any, or the current tree if no arguments are
1862
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1863
produces patches suitable for "patch -p1".
1867
2 - unrepresentable changes
1872
Shows the difference in the working tree versus the last commit::
1876
Difference between the working tree and revision 1::
1880
Difference between revision 3 and revision 1::
1884
Difference between revision 3 and revision 1 for branch xxx::
1888
To see the changes introduced in revision X::
1892
Note that in the case of a merge, the -c option shows the changes
1893
compared to the left hand parent. To see the changes against
1894
another parent, use::
1896
bzr diff -r<chosen_parent>..X
1898
The changes introduced by revision 2 (equivalent to -r1..2)::
1902
Show just the differences for file NEWS::
1906
Show the differences in working tree xxx for file NEWS::
1910
Show the differences from branch xxx to this working tree:
1914
Show the differences between two branches for file NEWS::
1916
bzr diff --old xxx --new yyy NEWS
1918
Same as 'bzr diff' but prefix paths with old/ and new/::
1920
bzr diff --prefix old/:new/
1922
_see_also = ['status']
1923
takes_args = ['file*']
1925
Option('diff-options', type=str,
1926
help='Pass these options to the external diff program.'),
1927
Option('prefix', type=str,
1929
help='Set prefixes added to old and new filenames, as '
1930
'two values separated by a colon. (eg "old/:new/").'),
1932
help='Branch/tree to compare from.',
1936
help='Branch/tree to compare to.',
1942
help='Use this command to compare files.',
1946
aliases = ['di', 'dif']
1947
encoding_type = 'exact'
1950
def run(self, revision=None, file_list=None, diff_options=None,
1951
prefix=None, old=None, new=None, using=None):
1952
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1954
if (prefix is None) or (prefix == '0'):
1962
old_label, new_label = prefix.split(":")
1964
raise errors.BzrCommandError(
1965
'--prefix expects two values separated by a colon'
1966
' (eg "old/:new/")')
1968
if revision and len(revision) > 2:
1969
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1970
' one or two revision specifiers')
1972
(old_tree, new_tree,
1973
old_branch, new_branch,
1974
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1975
file_list, revision, old, new, apply_view=True)
1976
return show_diff_trees(old_tree, new_tree, sys.stdout,
1977
specific_files=specific_files,
1978
external_diff_options=diff_options,
1979
old_label=old_label, new_label=new_label,
1980
extra_trees=extra_trees, using=using)
1983
class cmd_deleted(Command):
1984
"""List files deleted in the working tree.
1986
# TODO: Show files deleted since a previous revision, or
1987
# between two revisions.
1988
# TODO: Much more efficient way to do this: read in new
1989
# directories with readdir, rather than stating each one. Same
1990
# level of effort but possibly much less IO. (Or possibly not,
1991
# if the directories are very large...)
1992
_see_also = ['status', 'ls']
1993
takes_options = ['show-ids']
1996
def run(self, show_ids=False):
1997
tree = WorkingTree.open_containing(u'.')[0]
2000
old = tree.basis_tree()
2003
for path, ie in old.inventory.iter_entries():
2004
if not tree.has_id(ie.file_id):
2005
self.outf.write(path)
2007
self.outf.write(' ')
2008
self.outf.write(ie.file_id)
2009
self.outf.write('\n')
2016
class cmd_modified(Command):
2017
"""List files modified in working tree.
2021
_see_also = ['status', 'ls']
2024
help='Write an ascii NUL (\\0) separator '
2025
'between files rather than a newline.')
2029
def run(self, null=False):
2030
tree = WorkingTree.open_containing(u'.')[0]
2031
td = tree.changes_from(tree.basis_tree())
2032
for path, id, kind, text_modified, meta_modified in td.modified:
2034
self.outf.write(path + '\0')
2036
self.outf.write(osutils.quotefn(path) + '\n')
2039
class cmd_added(Command):
2040
"""List files added in working tree.
2044
_see_also = ['status', 'ls']
2047
help='Write an ascii NUL (\\0) separator '
2048
'between files rather than a newline.')
2052
def run(self, null=False):
2053
wt = WorkingTree.open_containing(u'.')[0]
2056
basis = wt.basis_tree()
2059
basis_inv = basis.inventory
2062
if file_id in basis_inv:
2064
if inv.is_root(file_id) and len(basis_inv) == 0:
2066
path = inv.id2path(file_id)
2067
if not os.access(osutils.abspath(path), os.F_OK):
2070
self.outf.write(path + '\0')
2072
self.outf.write(osutils.quotefn(path) + '\n')
2079
class cmd_root(Command):
2080
"""Show the tree root directory.
2082
The root is the nearest enclosing directory with a .bzr control
2085
takes_args = ['filename?']
2087
def run(self, filename=None):
2088
"""Print the branch root."""
2089
tree = WorkingTree.open_containing(filename)[0]
2090
self.outf.write(tree.basedir + '\n')
2093
def _parse_limit(limitstring):
2095
return int(limitstring)
2097
msg = "The limit argument must be an integer."
2098
raise errors.BzrCommandError(msg)
2101
def _parse_levels(s):
2105
msg = "The levels argument must be an integer."
2106
raise errors.BzrCommandError(msg)
2109
class cmd_log(Command):
2110
"""Show historical log for a branch or subset of a branch.
2112
log is bzr's default tool for exploring the history of a branch.
2113
The branch to use is taken from the first parameter. If no parameters
2114
are given, the branch containing the working directory is logged.
2115
Here are some simple examples::
2117
bzr log log the current branch
2118
bzr log foo.py log a file in its branch
2119
bzr log http://server/branch log a branch on a server
2121
The filtering, ordering and information shown for each revision can
2122
be controlled as explained below. By default, all revisions are
2123
shown sorted (topologically) so that newer revisions appear before
2124
older ones and descendants always appear before ancestors. If displayed,
2125
merged revisions are shown indented under the revision in which they
2130
The log format controls how information about each revision is
2131
displayed. The standard log formats are called ``long``, ``short``
2132
and ``line``. The default is long. See ``bzr help log-formats``
2133
for more details on log formats.
2135
The following options can be used to control what information is
2138
-l N display a maximum of N revisions
2139
-n N display N levels of revisions (0 for all, 1 for collapsed)
2140
-v display a status summary (delta) for each revision
2141
-p display a diff (patch) for each revision
2142
--show-ids display revision-ids (and file-ids), not just revnos
2144
Note that the default number of levels to display is a function of the
2145
log format. If the -n option is not used, the standard log formats show
2146
just the top level (mainline).
2148
Status summaries are shown using status flags like A, M, etc. To see
2149
the changes explained using words like ``added`` and ``modified``
2150
instead, use the -vv option.
2154
To display revisions from oldest to newest, use the --forward option.
2155
In most cases, using this option will have little impact on the total
2156
time taken to produce a log, though --forward does not incrementally
2157
display revisions like --reverse does when it can.
2159
:Revision filtering:
2161
The -r option can be used to specify what revision or range of revisions
2162
to filter against. The various forms are shown below::
2164
-rX display revision X
2165
-rX.. display revision X and later
2166
-r..Y display up to and including revision Y
2167
-rX..Y display from X to Y inclusive
2169
See ``bzr help revisionspec`` for details on how to specify X and Y.
2170
Some common examples are given below::
2172
-r-1 show just the tip
2173
-r-10.. show the last 10 mainline revisions
2174
-rsubmit:.. show what's new on this branch
2175
-rancestor:path.. show changes since the common ancestor of this
2176
branch and the one at location path
2177
-rdate:yesterday.. show changes since yesterday
2179
When logging a range of revisions using -rX..Y, log starts at
2180
revision Y and searches back in history through the primary
2181
("left-hand") parents until it finds X. When logging just the
2182
top level (using -n1), an error is reported if X is not found
2183
along the way. If multi-level logging is used (-n0), X may be
2184
a nested merge revision and the log will be truncated accordingly.
2188
If parameters are given and the first one is not a branch, the log
2189
will be filtered to show only those revisions that changed the
2190
nominated files or directories.
2192
Filenames are interpreted within their historical context. To log a
2193
deleted file, specify a revision range so that the file existed at
2194
the end or start of the range.
2196
Historical context is also important when interpreting pathnames of
2197
renamed files/directories. Consider the following example:
2199
* revision 1: add tutorial.txt
2200
* revision 2: modify tutorial.txt
2201
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2205
* ``bzr log guide.txt`` will log the file added in revision 1
2207
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2209
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2210
the original file in revision 2.
2212
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2213
was no file called guide.txt in revision 2.
2215
Renames are always followed by log. By design, there is no need to
2216
explicitly ask for this (and no way to stop logging a file back
2217
until it was last renamed).
2221
The --message option can be used for finding revisions that match a
2222
regular expression in a commit message.
2226
GUI tools and IDEs are often better at exploring history than command
2227
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2228
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2229
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2231
Web interfaces are often better at exploring history than command line
2232
tools, particularly for branches on servers. You may prefer Loggerhead
2233
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2235
You may find it useful to add the aliases below to ``bazaar.conf``::
2239
top = log -l10 --line
2242
``bzr tip`` will then show the latest revision while ``bzr top``
2243
will show the last 10 mainline revisions. To see the details of a
2244
particular revision X, ``bzr show -rX``.
2246
If you are interested in looking deeper into a particular merge X,
2247
use ``bzr log -n0 -rX``.
2249
``bzr log -v`` on a branch with lots of history is currently
2250
very slow. A fix for this issue is currently under development.
2251
With or without that fix, it is recommended that a revision range
2252
be given when using the -v option.
2254
bzr has a generic full-text matching plugin, bzr-search, that can be
2255
used to find revisions matching user names, commit messages, etc.
2256
Among other features, this plugin can find all revisions containing
2257
a list of words but not others.
2259
When exploring non-mainline history on large projects with deep
2260
history, the performance of log can be greatly improved by installing
2261
the historycache plugin. This plugin buffers historical information
2262
trading disk space for faster speed.
2264
takes_args = ['file*']
2265
_see_also = ['log-formats', 'revisionspec']
2268
help='Show from oldest to newest.'),
2270
custom_help('verbose',
2271
help='Show files changed in each revision.'),
2275
type=bzrlib.option._parse_revision_str,
2277
help='Show just the specified revision.'
2278
' See also "help revisionspec".'),
2282
help='Number of levels to display - 0 for all, 1 for flat.',
2284
type=_parse_levels),
2287
help='Show revisions whose message matches this '
2288
'regular expression.',
2292
help='Limit the output to the first N revisions.',
2297
help='Show changes made in each revision as a patch.'),
2298
Option('include-merges',
2299
help='Show merged revisions like --levels 0 does.'),
2301
encoding_type = 'replace'
2304
def run(self, file_list=None, timezone='original',
2315
include_merges=False):
2316
from bzrlib.log import (
2318
make_log_request_dict,
2319
_get_info_for_log_files,
2321
direction = (forward and 'forward') or 'reverse'
2326
raise errors.BzrCommandError(
2327
'--levels and --include-merges are mutually exclusive')
2329
if change is not None:
2331
raise errors.RangeInChangeOption()
2332
if revision is not None:
2333
raise errors.BzrCommandError(
2334
'--revision and --change are mutually exclusive')
2339
filter_by_dir = False
2343
# find the file ids to log and check for directory filtering
2344
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2345
revision, file_list)
2346
for relpath, file_id, kind in file_info_list:
2348
raise errors.BzrCommandError(
2349
"Path unknown at end or start of revision range: %s" %
2351
# If the relpath is the top of the tree, we log everything
2356
file_ids.append(file_id)
2357
filter_by_dir = filter_by_dir or (
2358
kind in ['directory', 'tree-reference'])
2361
# FIXME ? log the current subdir only RBC 20060203
2362
if revision is not None \
2363
and len(revision) > 0 and revision[0].get_branch():
2364
location = revision[0].get_branch()
2367
dir, relpath = bzrdir.BzrDir.open_containing(location)
2368
b = dir.open_branch()
2370
rev1, rev2 = _get_revision_range(revision, b, self.name())
2372
# Decide on the type of delta & diff filtering to use
2373
# TODO: add an --all-files option to make this configurable & consistent
2381
diff_type = 'partial'
2385
# Build the log formatter
2386
if log_format is None:
2387
log_format = log.log_formatter_registry.get_default(b)
2388
# Make a non-encoding output to include the diffs - bug 328007
2389
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2390
lf = log_format(show_ids=show_ids, to_file=self.outf,
2391
to_exact_file=unencoded_output,
2392
show_timezone=timezone,
2393
delta_format=get_verbosity_level(),
2395
show_advice=levels is None)
2397
# Choose the algorithm for doing the logging. It's annoying
2398
# having multiple code paths like this but necessary until
2399
# the underlying repository format is faster at generating
2400
# deltas or can provide everything we need from the indices.
2401
# The default algorithm - match-using-deltas - works for
2402
# multiple files and directories and is faster for small
2403
# amounts of history (200 revisions say). However, it's too
2404
# slow for logging a single file in a repository with deep
2405
# history, i.e. > 10K revisions. In the spirit of "do no
2406
# evil when adding features", we continue to use the
2407
# original algorithm - per-file-graph - for the "single
2408
# file that isn't a directory without showing a delta" case.
2409
partial_history = revision and b.repository._format.supports_chks
2410
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2411
or delta_type or partial_history)
2413
# Build the LogRequest and execute it
2414
if len(file_ids) == 0:
2416
rqst = make_log_request_dict(
2417
direction=direction, specific_fileids=file_ids,
2418
start_revision=rev1, end_revision=rev2, limit=limit,
2419
message_search=message, delta_type=delta_type,
2420
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2421
Logger(b, rqst).show(lf)
2427
def _get_revision_range(revisionspec_list, branch, command_name):
2428
"""Take the input of a revision option and turn it into a revision range.
2430
It returns RevisionInfo objects which can be used to obtain the rev_id's
2431
of the desired revisions. It does some user input validations.
2433
if revisionspec_list is None:
2436
elif len(revisionspec_list) == 1:
2437
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2438
elif len(revisionspec_list) == 2:
2439
start_spec = revisionspec_list[0]
2440
end_spec = revisionspec_list[1]
2441
if end_spec.get_branch() != start_spec.get_branch():
2442
# b is taken from revision[0].get_branch(), and
2443
# show_log will use its revision_history. Having
2444
# different branches will lead to weird behaviors.
2445
raise errors.BzrCommandError(
2446
"bzr %s doesn't accept two revisions in different"
2447
" branches." % command_name)
2448
rev1 = start_spec.in_history(branch)
2449
# Avoid loading all of history when we know a missing
2450
# end of range means the last revision ...
2451
if end_spec.spec is None:
2452
last_revno, last_revision_id = branch.last_revision_info()
2453
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2455
rev2 = end_spec.in_history(branch)
2457
raise errors.BzrCommandError(
2458
'bzr %s --revision takes one or two values.' % command_name)
2462
def _revision_range_to_revid_range(revision_range):
2465
if revision_range[0] is not None:
2466
rev_id1 = revision_range[0].rev_id
2467
if revision_range[1] is not None:
2468
rev_id2 = revision_range[1].rev_id
2469
return rev_id1, rev_id2
2471
def get_log_format(long=False, short=False, line=False, default='long'):
2472
log_format = default
2476
log_format = 'short'
2482
class cmd_touching_revisions(Command):
2483
"""Return revision-ids which affected a particular file.
2485
A more user-friendly interface is "bzr log FILE".
2489
takes_args = ["filename"]
2492
def run(self, filename):
2493
tree, relpath = WorkingTree.open_containing(filename)
2494
file_id = tree.path2id(relpath)
2498
touching_revs = log.find_touching_revisions(b, file_id)
2499
for revno, revision_id, what in touching_revs:
2500
self.outf.write("%6d %s\n" % (revno, what))
2505
class cmd_ls(Command):
2506
"""List files in a tree.
2509
_see_also = ['status', 'cat']
2510
takes_args = ['path?']
2514
Option('recursive', short_name='R',
2515
help='Recurse into subdirectories.'),
2517
help='Print paths relative to the root of the branch.'),
2518
Option('unknown', help='Print unknown files.'),
2519
Option('versioned', help='Print versioned files.',
2521
Option('ignored', help='Print ignored files.'),
2523
help='Write an ascii NUL (\\0) separator '
2524
'between files rather than a newline.'),
2526
help='List entries of a particular kind: file, directory, symlink.',
2531
def run(self, revision=None, verbose=False,
2532
recursive=False, from_root=False,
2533
unknown=False, versioned=False, ignored=False,
2534
null=False, kind=None, show_ids=False, path=None):
2536
if kind and kind not in ('file', 'directory', 'symlink'):
2537
raise errors.BzrCommandError('invalid kind specified')
2539
if verbose and null:
2540
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2541
all = not (unknown or versioned or ignored)
2543
selection = {'I':ignored, '?':unknown, 'V':versioned}
2549
raise errors.BzrCommandError('cannot specify both --from-root'
2552
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2555
# Calculate the prefix to use
2559
prefix = relpath + '/'
2560
elif fs_path != '.' and not fs_path.endswith('/'):
2561
prefix = fs_path + '/'
2563
if revision is not None or tree is None:
2564
tree = _get_one_revision_tree('ls', revision, branch=branch)
2567
if isinstance(tree, WorkingTree) and tree.supports_views():
2568
view_files = tree.views.lookup_view()
2571
view_str = views.view_display_str(view_files)
2572
note("Ignoring files outside view. View is %s" % view_str)
2576
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2577
from_dir=relpath, recursive=recursive):
2578
# Apply additional masking
2579
if not all and not selection[fc]:
2581
if kind is not None and fkind != kind:
2586
fullpath = osutils.pathjoin(relpath, fp)
2589
views.check_path_in_view(tree, fullpath)
2590
except errors.FileOutsideView:
2595
fp = osutils.pathjoin(prefix, fp)
2596
kindch = entry.kind_character()
2597
outstring = fp + kindch
2598
ui.ui_factory.clear_term()
2600
outstring = '%-8s %s' % (fc, outstring)
2601
if show_ids and fid is not None:
2602
outstring = "%-50s %s" % (outstring, fid)
2603
self.outf.write(outstring + '\n')
2605
self.outf.write(fp + '\0')
2608
self.outf.write(fid)
2609
self.outf.write('\0')
2617
self.outf.write('%-50s %s\n' % (outstring, my_id))
2619
self.outf.write(outstring + '\n')
2624
class cmd_unknowns(Command):
2625
"""List unknown files.
2633
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2634
self.outf.write(osutils.quotefn(f) + '\n')
2637
class cmd_ignore(Command):
2638
"""Ignore specified files or patterns.
2640
See ``bzr help patterns`` for details on the syntax of patterns.
2642
If a .bzrignore file does not exist, the ignore command
2643
will create one and add the specified files or patterns to the newly
2644
created file. The ignore command will also automatically add the
2645
.bzrignore file to be versioned. Creating a .bzrignore file without
2646
the use of the ignore command will require an explicit add command.
2648
To remove patterns from the ignore list, edit the .bzrignore file.
2649
After adding, editing or deleting that file either indirectly by
2650
using this command or directly by using an editor, be sure to commit
2653
Note: ignore patterns containing shell wildcards must be quoted from
2657
Ignore the top level Makefile::
2659
bzr ignore ./Makefile
2661
Ignore class files in all directories::
2663
bzr ignore "*.class"
2665
Ignore .o files under the lib directory::
2667
bzr ignore "lib/**/*.o"
2669
Ignore .o files under the lib directory::
2671
bzr ignore "RE:lib/.*\.o"
2673
Ignore everything but the "debian" toplevel directory::
2675
bzr ignore "RE:(?!debian/).*"
2678
_see_also = ['status', 'ignored', 'patterns']
2679
takes_args = ['name_pattern*']
2681
Option('old-default-rules',
2682
help='Write out the ignore rules bzr < 0.9 always used.')
2685
def run(self, name_pattern_list=None, old_default_rules=None):
2686
from bzrlib import ignores
2687
if old_default_rules is not None:
2688
# dump the rules and exit
2689
for pattern in ignores.OLD_DEFAULTS:
2692
if not name_pattern_list:
2693
raise errors.BzrCommandError("ignore requires at least one "
2694
"NAME_PATTERN or --old-default-rules")
2695
name_pattern_list = [globbing.normalize_pattern(p)
2696
for p in name_pattern_list]
2697
for name_pattern in name_pattern_list:
2698
if (name_pattern[0] == '/' or
2699
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2700
raise errors.BzrCommandError(
2701
"NAME_PATTERN should not be an absolute path")
2702
tree, relpath = WorkingTree.open_containing(u'.')
2703
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2704
ignored = globbing.Globster(name_pattern_list)
2707
for entry in tree.list_files():
2711
if ignored.match(filename):
2712
matches.append(filename.encode('utf-8'))
2714
if len(matches) > 0:
2715
print "Warning: the following files are version controlled and" \
2716
" match your ignore pattern:\n%s" \
2717
"\nThese files will continue to be version controlled" \
2718
" unless you 'bzr remove' them." % ("\n".join(matches),)
2721
class cmd_ignored(Command):
2722
"""List ignored files and the patterns that matched them.
2724
List all the ignored files and the ignore pattern that caused the file to
2727
Alternatively, to list just the files::
2732
encoding_type = 'replace'
2733
_see_also = ['ignore', 'ls']
2737
tree = WorkingTree.open_containing(u'.')[0]
2740
for path, file_class, kind, file_id, entry in tree.list_files():
2741
if file_class != 'I':
2743
## XXX: Slightly inefficient since this was already calculated
2744
pat = tree.is_ignored(path)
2745
self.outf.write('%-50s %s\n' % (path, pat))
2750
class cmd_lookup_revision(Command):
2751
"""Lookup the revision-id from a revision-number
2754
bzr lookup-revision 33
2757
takes_args = ['revno']
2760
def run(self, revno):
2764
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2766
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2769
class cmd_export(Command):
2770
"""Export current or past revision to a destination directory or archive.
2772
If no revision is specified this exports the last committed revision.
2774
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2775
given, try to find the format with the extension. If no extension
2776
is found exports to a directory (equivalent to --format=dir).
2778
If root is supplied, it will be used as the root directory inside
2779
container formats (tar, zip, etc). If it is not supplied it will default
2780
to the exported filename. The root option has no effect for 'dir' format.
2782
If branch is omitted then the branch containing the current working
2783
directory will be used.
2785
Note: Export of tree with non-ASCII filenames to zip is not supported.
2787
================= =========================
2788
Supported formats Autodetected by extension
2789
================= =========================
2792
tbz2 .tar.bz2, .tbz2
2795
================= =========================
2797
takes_args = ['dest', 'branch_or_subdir?']
2800
help="Type of file to export to.",
2803
Option('filters', help='Apply content filters to export the '
2804
'convenient form.'),
2807
help="Name of the root directory inside the exported file."),
2809
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2810
root=None, filters=False):
2811
from bzrlib.export import export
2813
if branch_or_subdir is None:
2814
tree = WorkingTree.open_containing(u'.')[0]
2818
b, subdir = Branch.open_containing(branch_or_subdir)
2821
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2823
export(rev_tree, dest, format, root, subdir, filtered=filters)
2824
except errors.NoSuchExportFormat, e:
2825
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2828
class cmd_cat(Command):
2829
"""Write the contents of a file as of a given revision to standard output.
2831
If no revision is nominated, the last revision is used.
2833
Note: Take care to redirect standard output when using this command on a
2839
Option('name-from-revision', help='The path name in the old tree.'),
2840
Option('filters', help='Apply content filters to display the '
2841
'convenience form.'),
2844
takes_args = ['filename']
2845
encoding_type = 'exact'
2848
def run(self, filename, revision=None, name_from_revision=False,
2850
if revision is not None and len(revision) != 1:
2851
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2852
" one revision specifier")
2853
tree, branch, relpath = \
2854
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2857
return self._run(tree, branch, relpath, filename, revision,
2858
name_from_revision, filters)
2862
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2865
tree = b.basis_tree()
2866
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2868
old_file_id = rev_tree.path2id(relpath)
2870
if name_from_revision:
2871
# Try in revision if requested
2872
if old_file_id is None:
2873
raise errors.BzrCommandError(
2874
"%r is not present in revision %s" % (
2875
filename, rev_tree.get_revision_id()))
2877
content = rev_tree.get_file_text(old_file_id)
2879
cur_file_id = tree.path2id(relpath)
2881
if cur_file_id is not None:
2882
# Then try with the actual file id
2884
content = rev_tree.get_file_text(cur_file_id)
2886
except errors.NoSuchId:
2887
# The actual file id didn't exist at that time
2889
if not found and old_file_id is not None:
2890
# Finally try with the old file id
2891
content = rev_tree.get_file_text(old_file_id)
2894
# Can't be found anywhere
2895
raise errors.BzrCommandError(
2896
"%r is not present in revision %s" % (
2897
filename, rev_tree.get_revision_id()))
2899
from bzrlib.filters import (
2900
ContentFilterContext,
2901
filtered_output_bytes,
2903
filters = rev_tree._content_filter_stack(relpath)
2904
chunks = content.splitlines(True)
2905
content = filtered_output_bytes(chunks, filters,
2906
ContentFilterContext(relpath, rev_tree))
2907
self.outf.writelines(content)
2909
self.outf.write(content)
2912
class cmd_local_time_offset(Command):
2913
"""Show the offset in seconds from GMT to local time."""
2917
print osutils.local_time_offset()
2921
class cmd_commit(Command):
2922
"""Commit changes into a new revision.
2924
An explanatory message needs to be given for each commit. This is
2925
often done by using the --message option (getting the message from the
2926
command line) or by using the --file option (getting the message from
2927
a file). If neither of these options is given, an editor is opened for
2928
the user to enter the message. To see the changed files in the
2929
boilerplate text loaded into the editor, use the --show-diff option.
2931
By default, the entire tree is committed and the person doing the
2932
commit is assumed to be the author. These defaults can be overridden
2937
If selected files are specified, only changes to those files are
2938
committed. If a directory is specified then the directory and
2939
everything within it is committed.
2941
When excludes are given, they take precedence over selected files.
2942
For example, to commit only changes within foo, but not changes
2945
bzr commit foo -x foo/bar
2947
A selective commit after a merge is not yet supported.
2951
If the author of the change is not the same person as the committer,
2952
you can specify the author's name using the --author option. The
2953
name should be in the same format as a committer-id, e.g.
2954
"John Doe <jdoe@example.com>". If there is more than one author of
2955
the change you can specify the option multiple times, once for each
2960
A common mistake is to forget to add a new file or directory before
2961
running the commit command. The --strict option checks for unknown
2962
files and aborts the commit if any are found. More advanced pre-commit
2963
checks can be implemented by defining hooks. See ``bzr help hooks``
2968
If you accidentially commit the wrong changes or make a spelling
2969
mistake in the commit message say, you can use the uncommit command
2970
to undo it. See ``bzr help uncommit`` for details.
2972
Hooks can also be configured to run after a commit. This allows you
2973
to trigger updates to external systems like bug trackers. The --fixes
2974
option can be used to record the association between a revision and
2975
one or more bugs. See ``bzr help bugs`` for details.
2977
A selective commit may fail in some cases where the committed
2978
tree would be invalid. Consider::
2983
bzr commit foo -m "committing foo"
2984
bzr mv foo/bar foo/baz
2987
bzr commit foo/bar -m "committing bar but not baz"
2989
In the example above, the last commit will fail by design. This gives
2990
the user the opportunity to decide whether they want to commit the
2991
rename at the same time, separately first, or not at all. (As a general
2992
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2994
# TODO: Run hooks on tree to-be-committed, and after commit.
2996
# TODO: Strict commit that fails if there are deleted files.
2997
# (what does "deleted files" mean ??)
2999
# TODO: Give better message for -s, --summary, used by tla people
3001
# XXX: verbose currently does nothing
3003
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3004
takes_args = ['selected*']
3006
ListOption('exclude', type=str, short_name='x',
3007
help="Do not consider changes made to a given path."),
3008
Option('message', type=unicode,
3010
help="Description of the new revision."),
3013
help='Commit even if nothing has changed.'),
3014
Option('file', type=str,
3017
help='Take commit message from this file.'),
3019
help="Refuse to commit if there are unknown "
3020
"files in the working tree."),
3021
Option('commit-time', type=str,
3022
help="Manually set a commit time using commit date "
3023
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3024
ListOption('fixes', type=str,
3025
help="Mark a bug as being fixed by this revision "
3026
"(see \"bzr help bugs\")."),
3027
ListOption('author', type=unicode,
3028
help="Set the author's name, if it's different "
3029
"from the committer."),
3031
help="Perform a local commit in a bound "
3032
"branch. Local commits are not pushed to "
3033
"the master branch until a normal commit "
3037
help='When no message is supplied, show the diff along'
3038
' with the status summary in the message editor.'),
3040
aliases = ['ci', 'checkin']
3042
def _iter_bug_fix_urls(self, fixes, branch):
3043
# Configure the properties for bug fixing attributes.
3044
for fixed_bug in fixes:
3045
tokens = fixed_bug.split(':')
3046
if len(tokens) != 2:
3047
raise errors.BzrCommandError(
3048
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3049
"See \"bzr help bugs\" for more information on this "
3050
"feature.\nCommit refused." % fixed_bug)
3051
tag, bug_id = tokens
3053
yield bugtracker.get_bug_url(tag, branch, bug_id)
3054
except errors.UnknownBugTrackerAbbreviation:
3055
raise errors.BzrCommandError(
3056
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3057
except errors.MalformedBugIdentifier, e:
3058
raise errors.BzrCommandError(
3059
"%s\nCommit refused." % (str(e),))
3061
def run(self, message=None, file=None, verbose=False, selected_list=None,
3062
unchanged=False, strict=False, local=False, fixes=None,
3063
author=None, show_diff=False, exclude=None, commit_time=None):
3064
from bzrlib.errors import (
3069
from bzrlib.msgeditor import (
3070
edit_commit_message_encoded,
3071
generate_commit_message_template,
3072
make_commit_message_template_encoded
3075
commit_stamp = offset = None
3076
if commit_time is not None:
3078
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3079
except ValueError, e:
3080
raise errors.BzrCommandError(
3081
"Could not parse --commit-time: " + str(e))
3083
# TODO: Need a blackbox test for invoking the external editor; may be
3084
# slightly problematic to run this cross-platform.
3086
# TODO: do more checks that the commit will succeed before
3087
# spending the user's valuable time typing a commit message.
3091
tree, selected_list = tree_files(selected_list)
3092
if selected_list == ['']:
3093
# workaround - commit of root of tree should be exactly the same
3094
# as just default commit in that tree, and succeed even though
3095
# selected-file merge commit is not done yet
3100
bug_property = bugtracker.encode_fixes_bug_urls(
3101
self._iter_bug_fix_urls(fixes, tree.branch))
3103
properties['bugs'] = bug_property
3105
if local and not tree.branch.get_bound_location():
3106
raise errors.LocalRequiresBoundBranch()
3108
if message is not None:
3110
file_exists = osutils.lexists(message)
3111
except UnicodeError:
3112
# The commit message contains unicode characters that can't be
3113
# represented in the filesystem encoding, so that can't be a
3118
'The commit message is a file name: "%(f)s".\n'
3119
'(use --file "%(f)s" to take commit message from that file)'
3121
ui.ui_factory.show_warning(warning_msg)
3123
def get_message(commit_obj):
3124
"""Callback to get commit message"""
3125
my_message = message
3126
if my_message is not None and '\r' in my_message:
3127
my_message = my_message.replace('\r\n', '\n')
3128
my_message = my_message.replace('\r', '\n')
3129
if my_message is None and not file:
3130
t = make_commit_message_template_encoded(tree,
3131
selected_list, diff=show_diff,
3132
output_encoding=osutils.get_user_encoding())
3133
start_message = generate_commit_message_template(commit_obj)
3134
my_message = edit_commit_message_encoded(t,
3135
start_message=start_message)
3136
if my_message is None:
3137
raise errors.BzrCommandError("please specify a commit"
3138
" message with either --message or --file")
3139
elif my_message and file:
3140
raise errors.BzrCommandError(
3141
"please specify either --message or --file")
3143
my_message = codecs.open(file, 'rt',
3144
osutils.get_user_encoding()).read()
3145
if my_message == "":
3146
raise errors.BzrCommandError("empty commit message specified")
3149
# The API permits a commit with a filter of [] to mean 'select nothing'
3150
# but the command line should not do that.
3151
if not selected_list:
3152
selected_list = None
3154
tree.commit(message_callback=get_message,
3155
specific_files=selected_list,
3156
allow_pointless=unchanged, strict=strict, local=local,
3157
reporter=None, verbose=verbose, revprops=properties,
3158
authors=author, timestamp=commit_stamp,
3160
exclude=safe_relpath_files(tree, exclude))
3161
except PointlessCommit:
3162
# FIXME: This should really happen before the file is read in;
3163
# perhaps prepare the commit; get the message; then actually commit
3164
raise errors.BzrCommandError("No changes to commit."
3165
" Use --unchanged to commit anyhow.")
3166
except ConflictsInTree:
3167
raise errors.BzrCommandError('Conflicts detected in working '
3168
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3170
except StrictCommitFailed:
3171
raise errors.BzrCommandError("Commit refused because there are"
3172
" unknown files in the working tree.")
3173
except errors.BoundBranchOutOfDate, e:
3174
raise errors.BzrCommandError(str(e) + "\n"
3175
'To commit to master branch, run update and then commit.\n'
3176
'You can also pass --local to commit to continue working '
3180
class cmd_check(Command):
3181
"""Validate working tree structure, branch consistency and repository history.
3183
This command checks various invariants about branch and repository storage
3184
to detect data corruption or bzr bugs.
3186
The working tree and branch checks will only give output if a problem is
3187
detected. The output fields of the repository check are:
3190
This is just the number of revisions checked. It doesn't
3194
This is just the number of versionedfiles checked. It
3195
doesn't indicate a problem.
3197
unreferenced ancestors
3198
Texts that are ancestors of other texts, but
3199
are not properly referenced by the revision ancestry. This is a
3200
subtle problem that Bazaar can work around.
3203
This is the total number of unique file contents
3204
seen in the checked revisions. It does not indicate a problem.
3207
This is the total number of repeated texts seen
3208
in the checked revisions. Texts can be repeated when their file
3209
entries are modified, but the file contents are not. It does not
3212
If no restrictions are specified, all Bazaar data that is found at the given
3213
location will be checked.
3217
Check the tree and branch at 'foo'::
3219
bzr check --tree --branch foo
3221
Check only the repository at 'bar'::
3223
bzr check --repo bar
3225
Check everything at 'baz'::
3230
_see_also = ['reconcile']
3231
takes_args = ['path?']
3232
takes_options = ['verbose',
3233
Option('branch', help="Check the branch related to the"
3234
" current directory."),
3235
Option('repo', help="Check the repository related to the"
3236
" current directory."),
3237
Option('tree', help="Check the working tree related to"
3238
" the current directory.")]
3240
def run(self, path=None, verbose=False, branch=False, repo=False,
3242
from bzrlib.check import check_dwim
3245
if not branch and not repo and not tree:
3246
branch = repo = tree = True
3247
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3250
class cmd_upgrade(Command):
3251
"""Upgrade branch storage to current format.
3253
The check command or bzr developers may sometimes advise you to run
3254
this command. When the default format has changed you may also be warned
3255
during other operations to upgrade.
3258
_see_also = ['check']
3259
takes_args = ['url?']
3261
RegistryOption('format',
3262
help='Upgrade to a specific format. See "bzr help'
3263
' formats" for details.',
3264
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3265
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3266
value_switches=True, title='Branch format'),
3269
def run(self, url='.', format=None):
3270
from bzrlib.upgrade import upgrade
3271
upgrade(url, format)
3274
class cmd_whoami(Command):
3275
"""Show or set bzr user id.
3278
Show the email of the current user::
3282
Set the current user::
3284
bzr whoami "Frank Chu <fchu@example.com>"
3286
takes_options = [ Option('email',
3287
help='Display email address only.'),
3289
help='Set identity for the current branch instead of '
3292
takes_args = ['name?']
3293
encoding_type = 'replace'
3296
def run(self, email=False, branch=False, name=None):
3298
# use branch if we're inside one; otherwise global config
3300
c = Branch.open_containing('.')[0].get_config()
3301
except errors.NotBranchError:
3302
c = config.GlobalConfig()
3304
self.outf.write(c.user_email() + '\n')
3306
self.outf.write(c.username() + '\n')
3309
# display a warning if an email address isn't included in the given name.
3311
config.extract_email_address(name)
3312
except errors.NoEmailInUsername, e:
3313
warning('"%s" does not seem to contain an email address. '
3314
'This is allowed, but not recommended.', name)
3316
# use global config unless --branch given
3318
c = Branch.open_containing('.')[0].get_config()
3320
c = config.GlobalConfig()
3321
c.set_user_option('email', name)
3324
class cmd_nick(Command):
3325
"""Print or set the branch nickname.
3327
If unset, the tree root directory name is used as the nickname.
3328
To print the current nickname, execute with no argument.
3330
Bound branches use the nickname of its master branch unless it is set
3334
_see_also = ['info']
3335
takes_args = ['nickname?']
3336
def run(self, nickname=None):
3337
branch = Branch.open_containing(u'.')[0]
3338
if nickname is None:
3339
self.printme(branch)
3341
branch.nick = nickname
3344
def printme(self, branch):
3348
class cmd_alias(Command):
3349
"""Set/unset and display aliases.
3352
Show the current aliases::
3356
Show the alias specified for 'll'::
3360
Set an alias for 'll'::
3362
bzr alias ll="log --line -r-10..-1"
3364
To remove an alias for 'll'::
3366
bzr alias --remove ll
3369
takes_args = ['name?']
3371
Option('remove', help='Remove the alias.'),
3374
def run(self, name=None, remove=False):
3376
self.remove_alias(name)
3378
self.print_aliases()
3380
equal_pos = name.find('=')
3382
self.print_alias(name)
3384
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3386
def remove_alias(self, alias_name):
3387
if alias_name is None:
3388
raise errors.BzrCommandError(
3389
'bzr alias --remove expects an alias to remove.')
3390
# If alias is not found, print something like:
3391
# unalias: foo: not found
3392
c = config.GlobalConfig()
3393
c.unset_alias(alias_name)
3396
def print_aliases(self):
3397
"""Print out the defined aliases in a similar format to bash."""
3398
aliases = config.GlobalConfig().get_aliases()
3399
for key, value in sorted(aliases.iteritems()):
3400
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3403
def print_alias(self, alias_name):
3404
from bzrlib.commands import get_alias
3405
alias = get_alias(alias_name)
3407
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3410
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3412
def set_alias(self, alias_name, alias_command):
3413
"""Save the alias in the global config."""
3414
c = config.GlobalConfig()
3415
c.set_alias(alias_name, alias_command)
3418
class cmd_selftest(Command):
3419
"""Run internal test suite.
3421
If arguments are given, they are regular expressions that say which tests
3422
should run. Tests matching any expression are run, and other tests are
3425
Alternatively if --first is given, matching tests are run first and then
3426
all other tests are run. This is useful if you have been working in a
3427
particular area, but want to make sure nothing else was broken.
3429
If --exclude is given, tests that match that regular expression are
3430
excluded, regardless of whether they match --first or not.
3432
To help catch accidential dependencies between tests, the --randomize
3433
option is useful. In most cases, the argument used is the word 'now'.
3434
Note that the seed used for the random number generator is displayed
3435
when this option is used. The seed can be explicitly passed as the
3436
argument to this option if required. This enables reproduction of the
3437
actual ordering used if and when an order sensitive problem is encountered.
3439
If --list-only is given, the tests that would be run are listed. This is
3440
useful when combined with --first, --exclude and/or --randomize to
3441
understand their impact. The test harness reports "Listed nn tests in ..."
3442
instead of "Ran nn tests in ..." when list mode is enabled.
3444
If the global option '--no-plugins' is given, plugins are not loaded
3445
before running the selftests. This has two effects: features provided or
3446
modified by plugins will not be tested, and tests provided by plugins will
3449
Tests that need working space on disk use a common temporary directory,
3450
typically inside $TMPDIR or /tmp.
3452
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3453
into a pdb postmortem session.
3456
Run only tests relating to 'ignore'::
3460
Disable plugins and list tests as they're run::
3462
bzr --no-plugins selftest -v
3464
# NB: this is used from the class without creating an instance, which is
3465
# why it does not have a self parameter.
3466
def get_transport_type(typestring):
3467
"""Parse and return a transport specifier."""
3468
if typestring == "sftp":
3469
from bzrlib.transport.sftp import SFTPAbsoluteServer
3470
return SFTPAbsoluteServer
3471
if typestring == "memory":
3472
from bzrlib.transport.memory import MemoryServer
3474
if typestring == "fakenfs":
3475
from bzrlib.transport.fakenfs import FakeNFSServer
3476
return FakeNFSServer
3477
msg = "No known transport type %s. Supported types are: sftp\n" %\
3479
raise errors.BzrCommandError(msg)
3482
takes_args = ['testspecs*']
3483
takes_options = ['verbose',
3485
help='Stop when one test fails.',
3489
help='Use a different transport by default '
3490
'throughout the test suite.',
3491
type=get_transport_type),
3493
help='Run the benchmarks rather than selftests.'),
3494
Option('lsprof-timed',
3495
help='Generate lsprof output for benchmarked'
3496
' sections of code.'),
3497
Option('lsprof-tests',
3498
help='Generate lsprof output for each test.'),
3499
Option('cache-dir', type=str,
3500
help='Cache intermediate benchmark output in this '
3503
help='Run all tests, but run specified tests first.',
3507
help='List the tests instead of running them.'),
3508
RegistryOption('parallel',
3509
help="Run the test suite in parallel.",
3510
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3511
value_switches=False,
3513
Option('randomize', type=str, argname="SEED",
3514
help='Randomize the order of tests using the given'
3515
' seed or "now" for the current time.'),
3516
Option('exclude', type=str, argname="PATTERN",
3518
help='Exclude tests that match this regular'
3521
help='Output test progress via subunit.'),
3522
Option('strict', help='Fail on missing dependencies or '
3524
Option('load-list', type=str, argname='TESTLISTFILE',
3525
help='Load a test id list from a text file.'),
3526
ListOption('debugflag', type=str, short_name='E',
3527
help='Turn on a selftest debug flag.'),
3528
ListOption('starting-with', type=str, argname='TESTID',
3529
param_name='starting_with', short_name='s',
3531
'Load only the tests starting with TESTID.'),
3533
encoding_type = 'replace'
3536
Command.__init__(self)
3537
self.additional_selftest_args = {}
3539
def run(self, testspecs_list=None, verbose=False, one=False,
3540
transport=None, benchmark=None,
3541
lsprof_timed=None, cache_dir=None,
3542
first=False, list_only=False,
3543
randomize=None, exclude=None, strict=False,
3544
load_list=None, debugflag=None, starting_with=None, subunit=False,
3545
parallel=None, lsprof_tests=False):
3546
from bzrlib.tests import selftest
3547
import bzrlib.benchmarks as benchmarks
3548
from bzrlib.benchmarks import tree_creator
3550
# Make deprecation warnings visible, unless -Werror is set
3551
symbol_versioning.activate_deprecation_warnings(override=False)
3553
if cache_dir is not None:
3554
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3555
if testspecs_list is not None:
3556
pattern = '|'.join(testspecs_list)
3561
from bzrlib.tests import SubUnitBzrRunner
3563
raise errors.BzrCommandError("subunit not available. subunit "
3564
"needs to be installed to use --subunit.")
3565
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3567
self.additional_selftest_args.setdefault(
3568
'suite_decorators', []).append(parallel)
3570
test_suite_factory = benchmarks.test_suite
3571
# Unless user explicitly asks for quiet, be verbose in benchmarks
3572
verbose = not is_quiet()
3573
# TODO: should possibly lock the history file...
3574
benchfile = open(".perf_history", "at", buffering=1)
3576
test_suite_factory = None
3579
selftest_kwargs = {"verbose": verbose,
3581
"stop_on_failure": one,
3582
"transport": transport,
3583
"test_suite_factory": test_suite_factory,
3584
"lsprof_timed": lsprof_timed,
3585
"lsprof_tests": lsprof_tests,
3586
"bench_history": benchfile,
3587
"matching_tests_first": first,
3588
"list_only": list_only,
3589
"random_seed": randomize,
3590
"exclude_pattern": exclude,
3592
"load_list": load_list,
3593
"debug_flags": debugflag,
3594
"starting_with": starting_with
3596
selftest_kwargs.update(self.additional_selftest_args)
3597
result = selftest(**selftest_kwargs)
3599
if benchfile is not None:
3601
return int(not result)
3604
class cmd_version(Command):
3605
"""Show version of bzr."""
3607
encoding_type = 'replace'
3609
Option("short", help="Print just the version number."),
3613
def run(self, short=False):
3614
from bzrlib.version import show_version
3616
self.outf.write(bzrlib.version_string + '\n')
3618
show_version(to_file=self.outf)
3621
class cmd_rocks(Command):
3622
"""Statement of optimism."""
3628
print "It sure does!"
3631
class cmd_find_merge_base(Command):
3632
"""Find and print a base revision for merging two branches."""
3633
# TODO: Options to specify revisions on either side, as if
3634
# merging only part of the history.
3635
takes_args = ['branch', 'other']
3639
def run(self, branch, other):
3640
from bzrlib.revision import ensure_null
3642
branch1 = Branch.open_containing(branch)[0]
3643
branch2 = Branch.open_containing(other)[0]
3648
last1 = ensure_null(branch1.last_revision())
3649
last2 = ensure_null(branch2.last_revision())
3651
graph = branch1.repository.get_graph(branch2.repository)
3652
base_rev_id = graph.find_unique_lca(last1, last2)
3654
print 'merge base is revision %s' % base_rev_id
3661
class cmd_merge(Command):
3662
"""Perform a three-way merge.
3664
The source of the merge can be specified either in the form of a branch,
3665
or in the form of a path to a file containing a merge directive generated
3666
with bzr send. If neither is specified, the default is the upstream branch
3667
or the branch most recently merged using --remember.
3669
When merging a branch, by default the tip will be merged. To pick a different
3670
revision, pass --revision. If you specify two values, the first will be used as
3671
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3672
available revisions, like this is commonly referred to as "cherrypicking".
3674
Revision numbers are always relative to the branch being merged.
3676
By default, bzr will try to merge in all new work from the other
3677
branch, automatically determining an appropriate base. If this
3678
fails, you may need to give an explicit base.
3680
Merge will do its best to combine the changes in two branches, but there
3681
are some kinds of problems only a human can fix. When it encounters those,
3682
it will mark a conflict. A conflict means that you need to fix something,
3683
before you should commit.
3685
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3687
If there is no default branch set, the first merge will set it. After
3688
that, you can omit the branch to use the default. To change the
3689
default, use --remember. The value will only be saved if the remote
3690
location can be accessed.
3692
The results of the merge are placed into the destination working
3693
directory, where they can be reviewed (with bzr diff), tested, and then
3694
committed to record the result of the merge.
3696
merge refuses to run if there are any uncommitted changes, unless
3699
To select only some changes to merge, use "merge -i", which will prompt
3700
you to apply each diff hunk and file change, similar to "shelve".
3703
To merge the latest revision from bzr.dev::
3705
bzr merge ../bzr.dev
3707
To merge changes up to and including revision 82 from bzr.dev::
3709
bzr merge -r 82 ../bzr.dev
3711
To merge the changes introduced by 82, without previous changes::
3713
bzr merge -r 81..82 ../bzr.dev
3715
To apply a merge directive contained in /tmp/merge::
3717
bzr merge /tmp/merge
3720
encoding_type = 'exact'
3721
_see_also = ['update', 'remerge', 'status-flags', 'send']
3722
takes_args = ['location?']
3727
help='Merge even if the destination tree has uncommitted changes.'),
3731
Option('show-base', help="Show base revision text in "
3733
Option('uncommitted', help='Apply uncommitted changes'
3734
' from a working copy, instead of branch changes.'),
3735
Option('pull', help='If the destination is already'
3736
' completely merged into the source, pull from the'
3737
' source rather than merging. When this happens,'
3738
' you do not need to commit the result.'),
3740
help='Branch to merge into, '
3741
'rather than the one containing the working directory.',
3745
Option('preview', help='Instead of merging, show a diff of the'
3747
Option('interactive', help='Select changes interactively.',
3751
def run(self, location=None, revision=None, force=False,
3752
merge_type=None, show_base=False, reprocess=None, remember=False,
3753
uncommitted=False, pull=False,
3758
if merge_type is None:
3759
merge_type = _mod_merge.Merge3Merger
3761
if directory is None: directory = u'.'
3762
possible_transports = []
3764
allow_pending = True
3765
verified = 'inapplicable'
3766
tree = WorkingTree.open_containing(directory)[0]
3769
basis_tree = tree.revision_tree(tree.last_revision())
3770
except errors.NoSuchRevision:
3771
basis_tree = tree.basis_tree()
3773
# die as quickly as possible if there are uncommitted changes
3775
if tree.has_changes():
3776
raise errors.UncommittedChanges(tree)
3778
view_info = _get_view_info_for_change_reporter(tree)
3779
change_reporter = delta._ChangeReporter(
3780
unversioned_filter=tree.is_ignored, view_info=view_info)
3783
pb = ui.ui_factory.nested_progress_bar()
3784
cleanups.append(pb.finished)
3786
cleanups.append(tree.unlock)
3787
if location is not None:
3789
mergeable = bundle.read_mergeable_from_url(location,
3790
possible_transports=possible_transports)
3791
except errors.NotABundle:
3795
raise errors.BzrCommandError('Cannot use --uncommitted'
3796
' with bundles or merge directives.')
3798
if revision is not None:
3799
raise errors.BzrCommandError(
3800
'Cannot use -r with merge directives or bundles')
3801
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3804
if merger is None and uncommitted:
3805
if revision is not None and len(revision) > 0:
3806
raise errors.BzrCommandError('Cannot use --uncommitted and'
3807
' --revision at the same time.')
3808
merger = self.get_merger_from_uncommitted(tree, location, pb,
3810
allow_pending = False
3813
merger, allow_pending = self._get_merger_from_branch(tree,
3814
location, revision, remember, possible_transports, pb)
3816
merger.merge_type = merge_type
3817
merger.reprocess = reprocess
3818
merger.show_base = show_base
3819
self.sanity_check_merger(merger)
3820
if (merger.base_rev_id == merger.other_rev_id and
3821
merger.other_rev_id is not None):
3822
note('Nothing to do.')
3825
if merger.interesting_files is not None:
3826
raise errors.BzrCommandError('Cannot pull individual files')
3827
if (merger.base_rev_id == tree.last_revision()):
3828
result = tree.pull(merger.other_branch, False,
3829
merger.other_rev_id)
3830
result.report(self.outf)
3832
if merger.this_basis is None:
3833
raise errors.BzrCommandError(
3834
"This branch has no commits."
3835
" (perhaps you would prefer 'bzr pull')")
3837
return self._do_preview(merger, cleanups)
3839
return self._do_interactive(merger, cleanups)
3841
return self._do_merge(merger, change_reporter, allow_pending,
3844
for cleanup in reversed(cleanups):
3847
def _get_preview(self, merger, cleanups):
3848
tree_merger = merger.make_merger()
3849
tt = tree_merger.make_preview_transform()
3850
cleanups.append(tt.finalize)
3851
result_tree = tt.get_preview_tree()
3854
def _do_preview(self, merger, cleanups):
3855
from bzrlib.diff import show_diff_trees
3856
result_tree = self._get_preview(merger, cleanups)
3857
show_diff_trees(merger.this_tree, result_tree, self.outf,
3858
old_label='', new_label='')
3860
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3861
merger.change_reporter = change_reporter
3862
conflict_count = merger.do_merge()
3864
merger.set_pending()
3865
if verified == 'failed':
3866
warning('Preview patch does not match changes')
3867
if conflict_count != 0:
3872
def _do_interactive(self, merger, cleanups):
3873
"""Perform an interactive merge.
3875
This works by generating a preview tree of the merge, then using
3876
Shelver to selectively remove the differences between the working tree
3877
and the preview tree.
3879
from bzrlib import shelf_ui
3880
result_tree = self._get_preview(merger, cleanups)
3881
writer = bzrlib.option.diff_writer_registry.get()
3882
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3883
reporter=shelf_ui.ApplyReporter(),
3884
diff_writer=writer(sys.stdout))
3890
def sanity_check_merger(self, merger):
3891
if (merger.show_base and
3892
not merger.merge_type is _mod_merge.Merge3Merger):
3893
raise errors.BzrCommandError("Show-base is not supported for this"
3894
" merge type. %s" % merger.merge_type)
3895
if merger.reprocess is None:
3896
if merger.show_base:
3897
merger.reprocess = False
3899
# Use reprocess if the merger supports it
3900
merger.reprocess = merger.merge_type.supports_reprocess
3901
if merger.reprocess and not merger.merge_type.supports_reprocess:
3902
raise errors.BzrCommandError("Conflict reduction is not supported"
3903
" for merge type %s." %
3905
if merger.reprocess and merger.show_base:
3906
raise errors.BzrCommandError("Cannot do conflict reduction and"
3909
def _get_merger_from_branch(self, tree, location, revision, remember,
3910
possible_transports, pb):
3911
"""Produce a merger from a location, assuming it refers to a branch."""
3912
from bzrlib.tag import _merge_tags_if_possible
3913
# find the branch locations
3914
other_loc, user_location = self._select_branch_location(tree, location,
3916
if revision is not None and len(revision) == 2:
3917
base_loc, _unused = self._select_branch_location(tree,
3918
location, revision, 0)
3920
base_loc = other_loc
3922
other_branch, other_path = Branch.open_containing(other_loc,
3923
possible_transports)
3924
if base_loc == other_loc:
3925
base_branch = other_branch
3927
base_branch, base_path = Branch.open_containing(base_loc,
3928
possible_transports)
3929
# Find the revision ids
3930
other_revision_id = None
3931
base_revision_id = None
3932
if revision is not None:
3933
if len(revision) >= 1:
3934
other_revision_id = revision[-1].as_revision_id(other_branch)
3935
if len(revision) == 2:
3936
base_revision_id = revision[0].as_revision_id(base_branch)
3937
if other_revision_id is None:
3938
other_revision_id = _mod_revision.ensure_null(
3939
other_branch.last_revision())
3940
# Remember where we merge from
3941
if ((remember or tree.branch.get_submit_branch() is None) and
3942
user_location is not None):
3943
tree.branch.set_submit_branch(other_branch.base)
3944
_merge_tags_if_possible(other_branch, tree.branch)
3945
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3946
other_revision_id, base_revision_id, other_branch, base_branch)
3947
if other_path != '':
3948
allow_pending = False
3949
merger.interesting_files = [other_path]
3951
allow_pending = True
3952
return merger, allow_pending
3954
def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3955
"""Get a merger for uncommitted changes.
3957
:param tree: The tree the merger should apply to.
3958
:param location: The location containing uncommitted changes.
3959
:param pb: The progress bar to use for showing progress.
3960
:param cleanups: A list of operations to perform to clean up the
3961
temporary directories, unfinalized objects, etc.
3963
location = self._select_branch_location(tree, location)[0]
3964
other_tree, other_path = WorkingTree.open_containing(location)
3965
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3966
if other_path != '':
3967
merger.interesting_files = [other_path]
3970
def _select_branch_location(self, tree, user_location, revision=None,
3972
"""Select a branch location, according to possible inputs.
3974
If provided, branches from ``revision`` are preferred. (Both
3975
``revision`` and ``index`` must be supplied.)
3977
Otherwise, the ``location`` parameter is used. If it is None, then the
3978
``submit`` or ``parent`` location is used, and a note is printed.
3980
:param tree: The working tree to select a branch for merging into
3981
:param location: The location entered by the user
3982
:param revision: The revision parameter to the command
3983
:param index: The index to use for the revision parameter. Negative
3984
indices are permitted.
3985
:return: (selected_location, user_location). The default location
3986
will be the user-entered location.
3988
if (revision is not None and index is not None
3989
and revision[index] is not None):
3990
branch = revision[index].get_branch()
3991
if branch is not None:
3992
return branch, branch
3993
if user_location is None:
3994
location = self._get_remembered(tree, 'Merging from')
3996
location = user_location
3997
return location, user_location
3999
def _get_remembered(self, tree, verb_string):
4000
"""Use tree.branch's parent if none was supplied.
4002
Report if the remembered location was used.
4004
stored_location = tree.branch.get_submit_branch()
4005
stored_location_type = "submit"
4006
if stored_location is None:
4007
stored_location = tree.branch.get_parent()
4008
stored_location_type = "parent"
4009
mutter("%s", stored_location)
4010
if stored_location is None:
4011
raise errors.BzrCommandError("No location specified or remembered")
4012
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4013
note(u"%s remembered %s location %s", verb_string,
4014
stored_location_type, display_url)
4015
return stored_location
4018
class cmd_remerge(Command):
4021
Use this if you want to try a different merge technique while resolving
4022
conflicts. Some merge techniques are better than others, and remerge
4023
lets you try different ones on different files.
4025
The options for remerge have the same meaning and defaults as the ones for
4026
merge. The difference is that remerge can (only) be run when there is a
4027
pending merge, and it lets you specify particular files.
4030
Re-do the merge of all conflicted files, and show the base text in
4031
conflict regions, in addition to the usual THIS and OTHER texts::
4033
bzr remerge --show-base
4035
Re-do the merge of "foobar", using the weave merge algorithm, with
4036
additional processing to reduce the size of conflict regions::
4038
bzr remerge --merge-type weave --reprocess foobar
4040
takes_args = ['file*']
4045
help="Show base revision text in conflicts."),
4048
def run(self, file_list=None, merge_type=None, show_base=False,
4050
if merge_type is None:
4051
merge_type = _mod_merge.Merge3Merger
4052
tree, file_list = tree_files(file_list)
4055
parents = tree.get_parent_ids()
4056
if len(parents) != 2:
4057
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4058
" merges. Not cherrypicking or"
4060
repository = tree.branch.repository
4061
interesting_ids = None
4063
conflicts = tree.conflicts()
4064
if file_list is not None:
4065
interesting_ids = set()
4066
for filename in file_list:
4067
file_id = tree.path2id(filename)
4069
raise errors.NotVersionedError(filename)
4070
interesting_ids.add(file_id)
4071
if tree.kind(file_id) != "directory":
4074
for name, ie in tree.inventory.iter_entries(file_id):
4075
interesting_ids.add(ie.file_id)
4076
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4078
# Remerge only supports resolving contents conflicts
4079
allowed_conflicts = ('text conflict', 'contents conflict')
4080
restore_files = [c.path for c in conflicts
4081
if c.typestring in allowed_conflicts]
4082
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4083
tree.set_conflicts(ConflictList(new_conflicts))
4084
if file_list is not None:
4085
restore_files = file_list
4086
for filename in restore_files:
4088
restore(tree.abspath(filename))
4089
except errors.NotConflicted:
4091
# Disable pending merges, because the file texts we are remerging
4092
# have not had those merges performed. If we use the wrong parents
4093
# list, we imply that the working tree text has seen and rejected
4094
# all the changes from the other tree, when in fact those changes
4095
# have not yet been seen.
4096
pb = ui.ui_factory.nested_progress_bar()
4097
tree.set_parent_ids(parents[:1])
4099
merger = _mod_merge.Merger.from_revision_ids(pb,
4101
merger.interesting_ids = interesting_ids
4102
merger.merge_type = merge_type
4103
merger.show_base = show_base
4104
merger.reprocess = reprocess
4105
conflicts = merger.do_merge()
4107
tree.set_parent_ids(parents)
4117
class cmd_revert(Command):
4118
"""Revert files to a previous revision.
4120
Giving a list of files will revert only those files. Otherwise, all files
4121
will be reverted. If the revision is not specified with '--revision', the
4122
last committed revision is used.
4124
To remove only some changes, without reverting to a prior version, use
4125
merge instead. For example, "merge . --revision -2..-3" will remove the
4126
changes introduced by -2, without affecting the changes introduced by -1.
4127
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4129
By default, any files that have been manually changed will be backed up
4130
first. (Files changed only by merge are not backed up.) Backup files have
4131
'.~#~' appended to their name, where # is a number.
4133
When you provide files, you can use their current pathname or the pathname
4134
from the target revision. So you can use revert to "undelete" a file by
4135
name. If you name a directory, all the contents of that directory will be
4138
If you have newly added files since the target revision, they will be
4139
removed. If the files to be removed have been changed, backups will be
4140
created as above. Directories containing unknown files will not be
4143
The working tree contains a list of pending merged revisions, which will
4144
be included as parents in the next commit. Normally, revert clears that
4145
list as well as reverting the files. If any files are specified, revert
4146
leaves the pending merge list alone and reverts only the files. Use "bzr
4147
revert ." in the tree root to revert all files but keep the merge record,
4148
and "bzr revert --forget-merges" to clear the pending merge list without
4149
reverting any files.
4151
Using "bzr revert --forget-merges", it is possible to apply the changes
4152
from an arbitrary merge as a single revision. To do this, perform the
4153
merge as desired. Then doing revert with the "--forget-merges" option will
4154
keep the content of the tree as it was, but it will clear the list of
4155
pending merges. The next commit will then contain all of the changes that
4156
would have been in the merge, but without any mention of the other parent
4157
revisions. Because this technique forgets where these changes originated,
4158
it may cause additional conflicts on later merges involving the source and
4162
_see_also = ['cat', 'export']
4165
Option('no-backup', "Do not save backups of reverted files."),
4166
Option('forget-merges',
4167
'Remove pending merge marker, without changing any files.'),
4169
takes_args = ['file*']
4171
def run(self, revision=None, no_backup=False, file_list=None,
4172
forget_merges=None):
4173
tree, file_list = tree_files(file_list)
4177
tree.set_parent_ids(tree.get_parent_ids()[:1])
4179
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4184
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4185
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4186
pb = ui.ui_factory.nested_progress_bar()
4188
tree.revert(file_list, rev_tree, not no_backup, pb,
4189
report_changes=True)
4194
class cmd_assert_fail(Command):
4195
"""Test reporting of assertion failures"""
4196
# intended just for use in testing
4201
raise AssertionError("always fails")
4204
class cmd_help(Command):
4205
"""Show help on a command or other topic.
4208
_see_also = ['topics']
4210
Option('long', 'Show help on all commands.'),
4212
takes_args = ['topic?']
4213
aliases = ['?', '--help', '-?', '-h']
4216
def run(self, topic=None, long=False):
4218
if topic is None and long:
4220
bzrlib.help.help(topic)
4223
class cmd_shell_complete(Command):
4224
"""Show appropriate completions for context.
4226
For a list of all available commands, say 'bzr shell-complete'.
4228
takes_args = ['context?']
4233
def run(self, context=None):
4234
import shellcomplete
4235
shellcomplete.shellcomplete(context)
4238
class cmd_missing(Command):
4239
"""Show unmerged/unpulled revisions between two branches.
4241
OTHER_BRANCH may be local or remote.
4243
To filter on a range of revisions, you can use the command -r begin..end
4244
-r revision requests a specific revision, -r ..end or -r begin.. are
4248
1 - some missing revisions
4249
0 - no missing revisions
4253
Determine the missing revisions between this and the branch at the
4254
remembered pull location::
4258
Determine the missing revisions between this and another branch::
4260
bzr missing http://server/branch
4262
Determine the missing revisions up to a specific revision on the other
4265
bzr missing -r ..-10
4267
Determine the missing revisions up to a specific revision on this
4270
bzr missing --my-revision ..-10
4273
_see_also = ['merge', 'pull']
4274
takes_args = ['other_branch?']
4276
Option('reverse', 'Reverse the order of revisions.'),
4278
'Display changes in the local branch only.'),
4279
Option('this' , 'Same as --mine-only.'),
4280
Option('theirs-only',
4281
'Display changes in the remote branch only.'),
4282
Option('other', 'Same as --theirs-only.'),
4286
custom_help('revision',
4287
help='Filter on other branch revisions (inclusive). '
4288
'See "help revisionspec" for details.'),
4289
Option('my-revision',
4290
type=_parse_revision_str,
4291
help='Filter on local branch revisions (inclusive). '
4292
'See "help revisionspec" for details.'),
4293
Option('include-merges',
4294
'Show all revisions in addition to the mainline ones.'),
4296
encoding_type = 'replace'
4299
def run(self, other_branch=None, reverse=False, mine_only=False,
4301
log_format=None, long=False, short=False, line=False,
4302
show_ids=False, verbose=False, this=False, other=False,
4303
include_merges=False, revision=None, my_revision=None):
4304
from bzrlib.missing import find_unmerged, iter_log_revisions
4313
# TODO: We should probably check that we don't have mine-only and
4314
# theirs-only set, but it gets complicated because we also have
4315
# this and other which could be used.
4322
local_branch = Branch.open_containing(u".")[0]
4323
parent = local_branch.get_parent()
4324
if other_branch is None:
4325
other_branch = parent
4326
if other_branch is None:
4327
raise errors.BzrCommandError("No peer location known"
4329
display_url = urlutils.unescape_for_display(parent,
4331
message("Using saved parent location: "
4332
+ display_url + "\n")
4334
remote_branch = Branch.open(other_branch)
4335
if remote_branch.base == local_branch.base:
4336
remote_branch = local_branch
4338
local_revid_range = _revision_range_to_revid_range(
4339
_get_revision_range(my_revision, local_branch,
4342
remote_revid_range = _revision_range_to_revid_range(
4343
_get_revision_range(revision,
4344
remote_branch, self.name()))
4346
local_branch.lock_read()
4348
remote_branch.lock_read()
4350
local_extra, remote_extra = find_unmerged(
4351
local_branch, remote_branch, restrict,
4352
backward=not reverse,
4353
include_merges=include_merges,
4354
local_revid_range=local_revid_range,
4355
remote_revid_range=remote_revid_range)
4357
if log_format is None:
4358
registry = log.log_formatter_registry
4359
log_format = registry.get_default(local_branch)
4360
lf = log_format(to_file=self.outf,
4362
show_timezone='original')
4365
if local_extra and not theirs_only:
4366
message("You have %d extra revision(s):\n" %
4368
for revision in iter_log_revisions(local_extra,
4369
local_branch.repository,
4371
lf.log_revision(revision)
4372
printed_local = True
4375
printed_local = False
4377
if remote_extra and not mine_only:
4378
if printed_local is True:
4380
message("You are missing %d revision(s):\n" %
4382
for revision in iter_log_revisions(remote_extra,
4383
remote_branch.repository,
4385
lf.log_revision(revision)
4388
if mine_only and not local_extra:
4389
# We checked local, and found nothing extra
4390
message('This branch is up to date.\n')
4391
elif theirs_only and not remote_extra:
4392
# We checked remote, and found nothing extra
4393
message('Other branch is up to date.\n')
4394
elif not (mine_only or theirs_only or local_extra or
4396
# We checked both branches, and neither one had extra
4398
message("Branches are up to date.\n")
4400
remote_branch.unlock()
4402
local_branch.unlock()
4403
if not status_code and parent is None and other_branch is not None:
4404
local_branch.lock_write()
4406
# handle race conditions - a parent might be set while we run.
4407
if local_branch.get_parent() is None:
4408
local_branch.set_parent(remote_branch.base)
4410
local_branch.unlock()
4414
class cmd_pack(Command):
4415
"""Compress the data within a repository."""
4417
_see_also = ['repositories']
4418
takes_args = ['branch_or_repo?']
4420
def run(self, branch_or_repo='.'):
4421
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4423
branch = dir.open_branch()
4424
repository = branch.repository
4425
except errors.NotBranchError:
4426
repository = dir.open_repository()
4430
class cmd_plugins(Command):
4431
"""List the installed plugins.
4433
This command displays the list of installed plugins including
4434
version of plugin and a short description of each.
4436
--verbose shows the path where each plugin is located.
4438
A plugin is an external component for Bazaar that extends the
4439
revision control system, by adding or replacing code in Bazaar.
4440
Plugins can do a variety of things, including overriding commands,
4441
adding new commands, providing additional network transports and
4442
customizing log output.
4444
See the Bazaar web site, http://bazaar-vcs.org, for further
4445
information on plugins including where to find them and how to
4446
install them. Instructions are also provided there on how to
4447
write new plugins using the Python programming language.
4449
takes_options = ['verbose']
4452
def run(self, verbose=False):
4453
import bzrlib.plugin
4454
from inspect import getdoc
4456
for name, plugin in bzrlib.plugin.plugins().items():
4457
version = plugin.__version__
4458
if version == 'unknown':
4460
name_ver = '%s %s' % (name, version)
4461
d = getdoc(plugin.module)
4463
doc = d.split('\n')[0]
4465
doc = '(no description)'
4466
result.append((name_ver, doc, plugin.path()))
4467
for name_ver, doc, path in sorted(result):
4475
class cmd_testament(Command):
4476
"""Show testament (signing-form) of a revision."""
4479
Option('long', help='Produce long-format testament.'),
4481
help='Produce a strict-format testament.')]
4482
takes_args = ['branch?']
4484
def run(self, branch=u'.', revision=None, long=False, strict=False):
4485
from bzrlib.testament import Testament, StrictTestament
4487
testament_class = StrictTestament
4489
testament_class = Testament
4491
b = Branch.open_containing(branch)[0]
4493
b = Branch.open(branch)
4496
if revision is None:
4497
rev_id = b.last_revision()
4499
rev_id = revision[0].as_revision_id(b)
4500
t = testament_class.from_revision(b.repository, rev_id)
4502
sys.stdout.writelines(t.as_text_lines())
4504
sys.stdout.write(t.as_short_text())
4509
class cmd_annotate(Command):
4510
"""Show the origin of each line in a file.
4512
This prints out the given file with an annotation on the left side
4513
indicating which revision, author and date introduced the change.
4515
If the origin is the same for a run of consecutive lines, it is
4516
shown only at the top, unless the --all option is given.
4518
# TODO: annotate directories; showing when each file was last changed
4519
# TODO: if the working copy is modified, show annotations on that
4520
# with new uncommitted lines marked
4521
aliases = ['ann', 'blame', 'praise']
4522
takes_args = ['filename']
4523
takes_options = [Option('all', help='Show annotations on all lines.'),
4524
Option('long', help='Show commit date in annotations.'),
4528
encoding_type = 'exact'
4531
def run(self, filename, all=False, long=False, revision=None,
4533
from bzrlib.annotate import annotate_file, annotate_file_tree
4534
wt, branch, relpath = \
4535
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4541
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4543
file_id = wt.path2id(relpath)
4545
file_id = tree.path2id(relpath)
4547
raise errors.NotVersionedError(filename)
4548
file_version = tree.inventory[file_id].revision
4549
if wt is not None and revision is None:
4550
# If there is a tree and we're not annotating historical
4551
# versions, annotate the working tree's content.
4552
annotate_file_tree(wt, file_id, self.outf, long, all,
4555
annotate_file(branch, file_version, file_id, long, all, self.outf,
4564
class cmd_re_sign(Command):
4565
"""Create a digital signature for an existing revision."""
4566
# TODO be able to replace existing ones.
4568
hidden = True # is this right ?
4569
takes_args = ['revision_id*']
4570
takes_options = ['revision']
4572
def run(self, revision_id_list=None, revision=None):
4573
if revision_id_list is not None and revision is not None:
4574
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4575
if revision_id_list is None and revision is None:
4576
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4577
b = WorkingTree.open_containing(u'.')[0].branch
4580
return self._run(b, revision_id_list, revision)
4584
def _run(self, b, revision_id_list, revision):
4585
import bzrlib.gpg as gpg
4586
gpg_strategy = gpg.GPGStrategy(b.get_config())
4587
if revision_id_list is not None:
4588
b.repository.start_write_group()
4590
for revision_id in revision_id_list:
4591
b.repository.sign_revision(revision_id, gpg_strategy)
4593
b.repository.abort_write_group()
4596
b.repository.commit_write_group()
4597
elif revision is not None:
4598
if len(revision) == 1:
4599
revno, rev_id = revision[0].in_history(b)
4600
b.repository.start_write_group()
4602
b.repository.sign_revision(rev_id, gpg_strategy)
4604
b.repository.abort_write_group()
4607
b.repository.commit_write_group()
4608
elif len(revision) == 2:
4609
# are they both on rh- if so we can walk between them
4610
# might be nice to have a range helper for arbitrary
4611
# revision paths. hmm.
4612
from_revno, from_revid = revision[0].in_history(b)
4613
to_revno, to_revid = revision[1].in_history(b)
4614
if to_revid is None:
4615
to_revno = b.revno()
4616
if from_revno is None or to_revno is None:
4617
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4618
b.repository.start_write_group()
4620
for revno in range(from_revno, to_revno + 1):
4621
b.repository.sign_revision(b.get_rev_id(revno),
4624
b.repository.abort_write_group()
4627
b.repository.commit_write_group()
4629
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4632
class cmd_bind(Command):
4633
"""Convert the current branch into a checkout of the supplied branch.
4635
Once converted into a checkout, commits must succeed on the master branch
4636
before they will be applied to the local branch.
4638
Bound branches use the nickname of its master branch unless it is set
4639
locally, in which case binding will update the local nickname to be
4643
_see_also = ['checkouts', 'unbind']
4644
takes_args = ['location?']
4647
def run(self, location=None):
4648
b, relpath = Branch.open_containing(u'.')
4649
if location is None:
4651
location = b.get_old_bound_location()
4652
except errors.UpgradeRequired:
4653
raise errors.BzrCommandError('No location supplied. '
4654
'This format does not remember old locations.')
4656
if location is None:
4657
raise errors.BzrCommandError('No location supplied and no '
4658
'previous location known')
4659
b_other = Branch.open(location)
4662
except errors.DivergedBranches:
4663
raise errors.BzrCommandError('These branches have diverged.'
4664
' Try merging, and then bind again.')
4665
if b.get_config().has_explicit_nickname():
4666
b.nick = b_other.nick
4669
class cmd_unbind(Command):
4670
"""Convert the current checkout into a regular branch.
4672
After unbinding, the local branch is considered independent and subsequent
4673
commits will be local only.
4676
_see_also = ['checkouts', 'bind']
4681
b, relpath = Branch.open_containing(u'.')
4683
raise errors.BzrCommandError('Local branch is not bound')
4686
class cmd_uncommit(Command):
4687
"""Remove the last committed revision.
4689
--verbose will print out what is being removed.
4690
--dry-run will go through all the motions, but not actually
4693
If --revision is specified, uncommit revisions to leave the branch at the
4694
specified revision. For example, "bzr uncommit -r 15" will leave the
4695
branch at revision 15.
4697
Uncommit leaves the working tree ready for a new commit. The only change
4698
it may make is to restore any pending merges that were present before
4702
# TODO: jam 20060108 Add an option to allow uncommit to remove
4703
# unreferenced information in 'branch-as-repository' branches.
4704
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4705
# information in shared branches as well.
4706
_see_also = ['commit']
4707
takes_options = ['verbose', 'revision',
4708
Option('dry-run', help='Don\'t actually make changes.'),
4709
Option('force', help='Say yes to all questions.'),
4711
help="Only remove the commits from the local branch"
4712
" when in a checkout."
4715
takes_args = ['location?']
4717
encoding_type = 'replace'
4719
def run(self, location=None,
4720
dry_run=False, verbose=False,
4721
revision=None, force=False, local=False):
4722
if location is None:
4724
control, relpath = bzrdir.BzrDir.open_containing(location)
4726
tree = control.open_workingtree()
4728
except (errors.NoWorkingTree, errors.NotLocalUrl):
4730
b = control.open_branch()
4732
if tree is not None:
4737
return self._run(b, tree, dry_run, verbose, revision, force,
4740
if tree is not None:
4745
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4746
from bzrlib.log import log_formatter, show_log
4747
from bzrlib.uncommit import uncommit
4749
last_revno, last_rev_id = b.last_revision_info()
4752
if revision is None:
4754
rev_id = last_rev_id
4756
# 'bzr uncommit -r 10' actually means uncommit
4757
# so that the final tree is at revno 10.
4758
# but bzrlib.uncommit.uncommit() actually uncommits
4759
# the revisions that are supplied.
4760
# So we need to offset it by one
4761
revno = revision[0].in_history(b).revno + 1
4762
if revno <= last_revno:
4763
rev_id = b.get_rev_id(revno)
4765
if rev_id is None or _mod_revision.is_null(rev_id):
4766
self.outf.write('No revisions to uncommit.\n')
4769
lf = log_formatter('short',
4771
show_timezone='original')
4776
direction='forward',
4777
start_revision=revno,
4778
end_revision=last_revno)
4781
print 'Dry-run, pretending to remove the above revisions.'
4783
val = raw_input('Press <enter> to continue')
4785
print 'The above revision(s) will be removed.'
4787
val = raw_input('Are you sure [y/N]? ')
4788
if val.lower() not in ('y', 'yes'):
4792
mutter('Uncommitting from {%s} to {%s}',
4793
last_rev_id, rev_id)
4794
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4795
revno=revno, local=local)
4796
note('You can restore the old tip by running:\n'
4797
' bzr pull . -r revid:%s', last_rev_id)
4800
class cmd_break_lock(Command):
4801
"""Break a dead lock on a repository, branch or working directory.
4803
CAUTION: Locks should only be broken when you are sure that the process
4804
holding the lock has been stopped.
4806
You can get information on what locks are open via the 'bzr info' command.
4811
takes_args = ['location?']
4813
def run(self, location=None, show=False):
4814
if location is None:
4816
control, relpath = bzrdir.BzrDir.open_containing(location)
4818
control.break_lock()
4819
except NotImplementedError:
4823
class cmd_wait_until_signalled(Command):
4824
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4826
This just prints a line to signal when it is ready, then blocks on stdin.
4832
sys.stdout.write("running\n")
4834
sys.stdin.readline()
4837
class cmd_serve(Command):
4838
"""Run the bzr server."""
4840
aliases = ['server']
4844
help='Serve on stdin/out for use from inetd or sshd.'),
4845
RegistryOption('protocol',
4846
help="Protocol to serve.",
4847
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4848
value_switches=True),
4850
help='Listen for connections on nominated port of the form '
4851
'[hostname:]portnumber. Passing 0 as the port number will '
4852
'result in a dynamically allocated port. The default port '
4853
'depends on the protocol.',
4856
help='Serve contents of this directory.',
4858
Option('allow-writes',
4859
help='By default the server is a readonly server. Supplying '
4860
'--allow-writes enables write access to the contents of '
4861
'the served directory and below. Note that ``bzr serve`` '
4862
'does not perform authentication, so unless some form of '
4863
'external authentication is arranged supplying this '
4864
'option leads to global uncontrolled write access to your '
4869
def get_host_and_port(self, port):
4870
"""Return the host and port to run the smart server on.
4872
If 'port' is None, None will be returned for the host and port.
4874
If 'port' has a colon in it, the string before the colon will be
4875
interpreted as the host.
4877
:param port: A string of the port to run the server on.
4878
:return: A tuple of (host, port), where 'host' is a host name or IP,
4879
and port is an integer TCP/IP port.
4882
if port is not None:
4884
host, port = port.split(':')
4888
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4890
from bzrlib.transport import get_transport, transport_server_registry
4891
if directory is None:
4892
directory = os.getcwd()
4893
if protocol is None:
4894
protocol = transport_server_registry.get()
4895
host, port = self.get_host_and_port(port)
4896
url = urlutils.local_path_to_url(directory)
4897
if not allow_writes:
4898
url = 'readonly+' + url
4899
transport = get_transport(url)
4900
protocol(transport, host, port, inet)
4903
class cmd_join(Command):
4904
"""Combine a tree into its containing tree.
4906
This command requires the target tree to be in a rich-root format.
4908
The TREE argument should be an independent tree, inside another tree, but
4909
not part of it. (Such trees can be produced by "bzr split", but also by
4910
running "bzr branch" with the target inside a tree.)
4912
The result is a combined tree, with the subtree no longer an independant
4913
part. This is marked as a merge of the subtree into the containing tree,
4914
and all history is preserved.
4917
_see_also = ['split']
4918
takes_args = ['tree']
4920
Option('reference', help='Join by reference.', hidden=True),
4923
def run(self, tree, reference=False):
4924
sub_tree = WorkingTree.open(tree)
4925
parent_dir = osutils.dirname(sub_tree.basedir)
4926
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4927
repo = containing_tree.branch.repository
4928
if not repo.supports_rich_root():
4929
raise errors.BzrCommandError(
4930
"Can't join trees because %s doesn't support rich root data.\n"
4931
"You can use bzr upgrade on the repository."
4935
containing_tree.add_reference(sub_tree)
4936
except errors.BadReferenceTarget, e:
4937
# XXX: Would be better to just raise a nicely printable
4938
# exception from the real origin. Also below. mbp 20070306
4939
raise errors.BzrCommandError("Cannot join %s. %s" %
4943
containing_tree.subsume(sub_tree)
4944
except errors.BadSubsumeSource, e:
4945
raise errors.BzrCommandError("Cannot join %s. %s" %
4949
class cmd_split(Command):
4950
"""Split a subdirectory of a tree into a separate tree.
4952
This command will produce a target tree in a format that supports
4953
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4954
converted into earlier formats like 'dirstate-tags'.
4956
The TREE argument should be a subdirectory of a working tree. That
4957
subdirectory will be converted into an independent tree, with its own
4958
branch. Commits in the top-level tree will not apply to the new subtree.
4961
_see_also = ['join']
4962
takes_args = ['tree']
4964
def run(self, tree):
4965
containing_tree, subdir = WorkingTree.open_containing(tree)
4966
sub_id = containing_tree.path2id(subdir)
4968
raise errors.NotVersionedError(subdir)
4970
containing_tree.extract(sub_id)
4971
except errors.RootNotRich:
4972
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4975
class cmd_merge_directive(Command):
4976
"""Generate a merge directive for auto-merge tools.
4978
A directive requests a merge to be performed, and also provides all the
4979
information necessary to do so. This means it must either include a
4980
revision bundle, or the location of a branch containing the desired
4983
A submit branch (the location to merge into) must be supplied the first
4984
time the command is issued. After it has been supplied once, it will
4985
be remembered as the default.
4987
A public branch is optional if a revision bundle is supplied, but required
4988
if --diff or --plain is specified. It will be remembered as the default
4989
after the first use.
4992
takes_args = ['submit_branch?', 'public_branch?']
4996
_see_also = ['send']
4999
RegistryOption.from_kwargs('patch-type',
5000
'The type of patch to include in the directive.',
5002
value_switches=True,
5004
bundle='Bazaar revision bundle (default).',
5005
diff='Normal unified diff.',
5006
plain='No patch, just directive.'),
5007
Option('sign', help='GPG-sign the directive.'), 'revision',
5008
Option('mail-to', type=str,
5009
help='Instead of printing the directive, email to this address.'),
5010
Option('message', type=str, short_name='m',
5011
help='Message to use when committing this merge.')
5014
encoding_type = 'exact'
5016
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5017
sign=False, revision=None, mail_to=None, message=None):
5018
from bzrlib.revision import ensure_null, NULL_REVISION
5019
include_patch, include_bundle = {
5020
'plain': (False, False),
5021
'diff': (True, False),
5022
'bundle': (True, True),
5024
branch = Branch.open('.')
5025
stored_submit_branch = branch.get_submit_branch()
5026
if submit_branch is None:
5027
submit_branch = stored_submit_branch
5029
if stored_submit_branch is None:
5030
branch.set_submit_branch(submit_branch)
5031
if submit_branch is None:
5032
submit_branch = branch.get_parent()
5033
if submit_branch is None:
5034
raise errors.BzrCommandError('No submit branch specified or known')
5036
stored_public_branch = branch.get_public_branch()
5037
if public_branch is None:
5038
public_branch = stored_public_branch
5039
elif stored_public_branch is None:
5040
branch.set_public_branch(public_branch)
5041
if not include_bundle and public_branch is None:
5042
raise errors.BzrCommandError('No public branch specified or'
5044
base_revision_id = None
5045
if revision is not None:
5046
if len(revision) > 2:
5047
raise errors.BzrCommandError('bzr merge-directive takes '
5048
'at most two one revision identifiers')
5049
revision_id = revision[-1].as_revision_id(branch)
5050
if len(revision) == 2:
5051
base_revision_id = revision[0].as_revision_id(branch)
5053
revision_id = branch.last_revision()
5054
revision_id = ensure_null(revision_id)
5055
if revision_id == NULL_REVISION:
5056
raise errors.BzrCommandError('No revisions to bundle.')
5057
directive = merge_directive.MergeDirective2.from_objects(
5058
branch.repository, revision_id, time.time(),
5059
osutils.local_time_offset(), submit_branch,
5060
public_branch=public_branch, include_patch=include_patch,
5061
include_bundle=include_bundle, message=message,
5062
base_revision_id=base_revision_id)
5065
self.outf.write(directive.to_signed(branch))
5067
self.outf.writelines(directive.to_lines())
5069
message = directive.to_email(mail_to, branch, sign)
5070
s = SMTPConnection(branch.get_config())
5071
s.send_email(message)
5074
class cmd_send(Command):
5075
"""Mail or create a merge-directive for submitting changes.
5077
A merge directive provides many things needed for requesting merges:
5079
* A machine-readable description of the merge to perform
5081
* An optional patch that is a preview of the changes requested
5083
* An optional bundle of revision data, so that the changes can be applied
5084
directly from the merge directive, without retrieving data from a
5087
If --no-bundle is specified, then public_branch is needed (and must be
5088
up-to-date), so that the receiver can perform the merge using the
5089
public_branch. The public_branch is always included if known, so that
5090
people can check it later.
5092
The submit branch defaults to the parent, but can be overridden. Both
5093
submit branch and public branch will be remembered if supplied.
5095
If a public_branch is known for the submit_branch, that public submit
5096
branch is used in the merge instructions. This means that a local mirror
5097
can be used as your actual submit branch, once you have set public_branch
5100
Mail is sent using your preferred mail program. This should be transparent
5101
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5102
If the preferred client can't be found (or used), your editor will be used.
5104
To use a specific mail program, set the mail_client configuration option.
5105
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5106
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5107
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5108
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5111
If mail is being sent, a to address is required. This can be supplied
5112
either on the commandline, by setting the submit_to configuration
5113
option in the branch itself or the child_submit_to configuration option
5114
in the submit branch.
5116
Two formats are currently supported: "4" uses revision bundle format 4 and
5117
merge directive format 2. It is significantly faster and smaller than
5118
older formats. It is compatible with Bazaar 0.19 and later. It is the
5119
default. "0.9" uses revision bundle format 0.9 and merge directive
5120
format 1. It is compatible with Bazaar 0.12 - 0.18.
5122
The merge directives created by bzr send may be applied using bzr merge or
5123
bzr pull by specifying a file containing a merge directive as the location.
5126
encoding_type = 'exact'
5128
_see_also = ['merge', 'pull']
5130
takes_args = ['submit_branch?', 'public_branch?']
5134
help='Do not include a bundle in the merge directive.'),
5135
Option('no-patch', help='Do not include a preview patch in the merge'
5138
help='Remember submit and public branch.'),
5140
help='Branch to generate the submission from, '
5141
'rather than the one containing the working directory.',
5144
Option('output', short_name='o',
5145
help='Write merge directive to this file; '
5146
'use - for stdout.',
5149
help='Refuse to send if there are uncommitted changes in'
5150
' the working tree, --no-strict disables the check.'),
5151
Option('mail-to', help='Mail the request to this address.',
5155
Option('body', help='Body for the email.', type=unicode),
5156
RegistryOption('format',
5157
help='Use the specified output format.',
5158
lazy_registry=('bzrlib.send', 'format_registry')),
5161
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5162
no_patch=False, revision=None, remember=False, output=None,
5163
format=None, mail_to=None, message=None, body=None,
5164
strict=None, **kwargs):
5165
from bzrlib.send import send
5166
return send(submit_branch, revision, public_branch, remember,
5167
format, no_bundle, no_patch, output,
5168
kwargs.get('from', '.'), mail_to, message, body,
5173
class cmd_bundle_revisions(cmd_send):
5174
"""Create a merge-directive for submitting changes.
5176
A merge directive provides many things needed for requesting merges:
5178
* A machine-readable description of the merge to perform
5180
* An optional patch that is a preview of the changes requested
5182
* An optional bundle of revision data, so that the changes can be applied
5183
directly from the merge directive, without retrieving data from a
5186
If --no-bundle is specified, then public_branch is needed (and must be
5187
up-to-date), so that the receiver can perform the merge using the
5188
public_branch. The public_branch is always included if known, so that
5189
people can check it later.
5191
The submit branch defaults to the parent, but can be overridden. Both
5192
submit branch and public branch will be remembered if supplied.
5194
If a public_branch is known for the submit_branch, that public submit
5195
branch is used in the merge instructions. This means that a local mirror
5196
can be used as your actual submit branch, once you have set public_branch
5199
Two formats are currently supported: "4" uses revision bundle format 4 and
5200
merge directive format 2. It is significantly faster and smaller than
5201
older formats. It is compatible with Bazaar 0.19 and later. It is the
5202
default. "0.9" uses revision bundle format 0.9 and merge directive
5203
format 1. It is compatible with Bazaar 0.12 - 0.18.
5208
help='Do not include a bundle in the merge directive.'),
5209
Option('no-patch', help='Do not include a preview patch in the merge'
5212
help='Remember submit and public branch.'),
5214
help='Branch to generate the submission from, '
5215
'rather than the one containing the working directory.',
5218
Option('output', short_name='o', help='Write directive to this file.',
5221
help='Refuse to bundle revisions if there are uncommitted'
5222
' changes in the working tree, --no-strict disables the check.'),
5224
RegistryOption('format',
5225
help='Use the specified output format.',
5226
lazy_registry=('bzrlib.send', 'format_registry')),
5228
aliases = ['bundle']
5230
_see_also = ['send', 'merge']
5234
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5235
no_patch=False, revision=None, remember=False, output=None,
5236
format=None, strict=None, **kwargs):
5239
from bzrlib.send import send
5240
return send(submit_branch, revision, public_branch, remember,
5241
format, no_bundle, no_patch, output,
5242
kwargs.get('from', '.'), None, None, None,
5243
self.outf, strict=strict)
5246
class cmd_tag(Command):
5247
"""Create, remove or modify a tag naming a revision.
5249
Tags give human-meaningful names to revisions. Commands that take a -r
5250
(--revision) option can be given -rtag:X, where X is any previously
5253
Tags are stored in the branch. Tags are copied from one branch to another
5254
along when you branch, push, pull or merge.
5256
It is an error to give a tag name that already exists unless you pass
5257
--force, in which case the tag is moved to point to the new revision.
5259
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5260
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5263
_see_also = ['commit', 'tags']
5264
takes_args = ['tag_name']
5267
help='Delete this tag rather than placing it.',
5270
help='Branch in which to place the tag.',
5275
help='Replace existing tags.',
5280
def run(self, tag_name,
5286
branch, relpath = Branch.open_containing(directory)
5290
branch.tags.delete_tag(tag_name)
5291
self.outf.write('Deleted tag %s.\n' % tag_name)
5294
if len(revision) != 1:
5295
raise errors.BzrCommandError(
5296
"Tags can only be placed on a single revision, "
5298
revision_id = revision[0].as_revision_id(branch)
5300
revision_id = branch.last_revision()
5301
if (not force) and branch.tags.has_tag(tag_name):
5302
raise errors.TagAlreadyExists(tag_name)
5303
branch.tags.set_tag(tag_name, revision_id)
5304
self.outf.write('Created tag %s.\n' % tag_name)
5309
class cmd_tags(Command):
5312
This command shows a table of tag names and the revisions they reference.
5318
help='Branch whose tags should be displayed.',
5322
RegistryOption.from_kwargs('sort',
5323
'Sort tags by different criteria.', title='Sorting',
5324
alpha='Sort tags lexicographically (default).',
5325
time='Sort tags chronologically.',
5338
branch, relpath = Branch.open_containing(directory)
5340
tags = branch.tags.get_tag_dict().items()
5347
graph = branch.repository.get_graph()
5348
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5349
revid1, revid2 = rev1.rev_id, rev2.rev_id
5350
# only show revisions between revid1 and revid2 (inclusive)
5351
tags = [(tag, revid) for tag, revid in tags if
5352
graph.is_between(revid, revid1, revid2)]
5355
elif sort == 'time':
5357
for tag, revid in tags:
5359
revobj = branch.repository.get_revision(revid)
5360
except errors.NoSuchRevision:
5361
timestamp = sys.maxint # place them at the end
5363
timestamp = revobj.timestamp
5364
timestamps[revid] = timestamp
5365
tags.sort(key=lambda x: timestamps[x[1]])
5367
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5368
for index, (tag, revid) in enumerate(tags):
5370
revno = branch.revision_id_to_dotted_revno(revid)
5371
if isinstance(revno, tuple):
5372
revno = '.'.join(map(str, revno))
5373
except errors.NoSuchRevision:
5374
# Bad tag data/merges can lead to tagged revisions
5375
# which are not in this branch. Fail gracefully ...
5377
tags[index] = (tag, revno)
5380
for tag, revspec in tags:
5381
self.outf.write('%-20s %s\n' % (tag, revspec))
5384
class cmd_reconfigure(Command):
5385
"""Reconfigure the type of a bzr directory.
5387
A target configuration must be specified.
5389
For checkouts, the bind-to location will be auto-detected if not specified.
5390
The order of preference is
5391
1. For a lightweight checkout, the current bound location.
5392
2. For branches that used to be checkouts, the previously-bound location.
5393
3. The push location.
5394
4. The parent location.
5395
If none of these is available, --bind-to must be specified.
5398
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5399
takes_args = ['location?']
5401
RegistryOption.from_kwargs(
5403
title='Target type',
5404
help='The type to reconfigure the directory to.',
5405
value_switches=True, enum_switch=False,
5406
branch='Reconfigure to be an unbound branch with no working tree.',
5407
tree='Reconfigure to be an unbound branch with a working tree.',
5408
checkout='Reconfigure to be a bound branch with a working tree.',
5409
lightweight_checkout='Reconfigure to be a lightweight'
5410
' checkout (with no local history).',
5411
standalone='Reconfigure to be a standalone branch '
5412
'(i.e. stop using shared repository).',
5413
use_shared='Reconfigure to use a shared repository.',
5414
with_trees='Reconfigure repository to create '
5415
'working trees on branches by default.',
5416
with_no_trees='Reconfigure repository to not create '
5417
'working trees on branches by default.'
5419
Option('bind-to', help='Branch to bind checkout to.', type=str),
5421
help='Perform reconfiguration even if local changes'
5423
Option('stacked-on',
5424
help='Reconfigure a branch to be stacked on another branch.',
5428
help='Reconfigure a branch to be unstacked. This '
5429
'may require copying substantial data into it.',
5433
def run(self, location=None, target_type=None, bind_to=None, force=False,
5436
directory = bzrdir.BzrDir.open(location)
5437
if stacked_on and unstacked:
5438
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5439
elif stacked_on is not None:
5440
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5442
reconfigure.ReconfigureUnstacked().apply(directory)
5443
# At the moment you can use --stacked-on and a different
5444
# reconfiguration shape at the same time; there seems no good reason
5446
if target_type is None:
5447
if stacked_on or unstacked:
5450
raise errors.BzrCommandError('No target configuration '
5452
elif target_type == 'branch':
5453
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5454
elif target_type == 'tree':
5455
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5456
elif target_type == 'checkout':
5457
reconfiguration = reconfigure.Reconfigure.to_checkout(
5459
elif target_type == 'lightweight-checkout':
5460
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5462
elif target_type == 'use-shared':
5463
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5464
elif target_type == 'standalone':
5465
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5466
elif target_type == 'with-trees':
5467
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5469
elif target_type == 'with-no-trees':
5470
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5472
reconfiguration.apply(force)
5475
class cmd_switch(Command):
5476
"""Set the branch of a checkout and update.
5478
For lightweight checkouts, this changes the branch being referenced.
5479
For heavyweight checkouts, this checks that there are no local commits
5480
versus the current bound branch, then it makes the local branch a mirror
5481
of the new location and binds to it.
5483
In both cases, the working tree is updated and uncommitted changes
5484
are merged. The user can commit or revert these as they desire.
5486
Pending merges need to be committed or reverted before using switch.
5488
The path to the branch to switch to can be specified relative to the parent
5489
directory of the current branch. For example, if you are currently in a
5490
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5493
Bound branches use the nickname of its master branch unless it is set
5494
locally, in which case switching will update the local nickname to be
5498
takes_args = ['to_location']
5499
takes_options = [Option('force',
5500
help='Switch even if local commits will be lost.'),
5501
Option('create-branch', short_name='b',
5502
help='Create the target branch from this one before'
5503
' switching to it.'),
5506
def run(self, to_location, force=False, create_branch=False):
5507
from bzrlib import switch
5509
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5511
branch = control_dir.open_branch()
5512
had_explicit_nick = branch.get_config().has_explicit_nickname()
5513
except errors.NotBranchError:
5515
had_explicit_nick = False
5518
raise errors.BzrCommandError('cannot create branch without'
5520
to_location = directory_service.directories.dereference(
5522
if '/' not in to_location and '\\' not in to_location:
5523
# This path is meant to be relative to the existing branch
5524
this_url = self._get_branch_location(control_dir)
5525
to_location = urlutils.join(this_url, '..', to_location)
5526
to_branch = branch.bzrdir.sprout(to_location,
5527
possible_transports=[branch.bzrdir.root_transport],
5528
source_branch=branch).open_branch()
5530
# from_branch = control_dir.open_branch()
5531
# except errors.NotBranchError:
5532
# raise BzrCommandError('Cannot create a branch from this'
5533
# ' location when we cannot open this branch')
5534
# from_branch.bzrdir.sprout(
5538
to_branch = Branch.open(to_location)
5539
except errors.NotBranchError:
5540
this_url = self._get_branch_location(control_dir)
5541
to_branch = Branch.open(
5542
urlutils.join(this_url, '..', to_location))
5543
switch.switch(control_dir, to_branch, force)
5544
if had_explicit_nick:
5545
branch = control_dir.open_branch() #get the new branch!
5546
branch.nick = to_branch.nick
5547
note('Switched to branch: %s',
5548
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5550
def _get_branch_location(self, control_dir):
5551
"""Return location of branch for this control dir."""
5553
this_branch = control_dir.open_branch()
5554
# This may be a heavy checkout, where we want the master branch
5555
master_location = this_branch.get_bound_location()
5556
if master_location is not None:
5557
return master_location
5558
# If not, use a local sibling
5559
return this_branch.base
5560
except errors.NotBranchError:
5561
format = control_dir.find_branch_format()
5562
if getattr(format, 'get_reference', None) is not None:
5563
return format.get_reference(control_dir)
5565
return control_dir.root_transport.base
5568
class cmd_view(Command):
5569
"""Manage filtered views.
5571
Views provide a mask over the tree so that users can focus on
5572
a subset of a tree when doing their work. After creating a view,
5573
commands that support a list of files - status, diff, commit, etc -
5574
effectively have that list of files implicitly given each time.
5575
An explicit list of files can still be given but those files
5576
must be within the current view.
5578
In most cases, a view has a short life-span: it is created to make
5579
a selected change and is deleted once that change is committed.
5580
At other times, you may wish to create one or more named views
5581
and switch between them.
5583
To disable the current view without deleting it, you can switch to
5584
the pseudo view called ``off``. This can be useful when you need
5585
to see the whole tree for an operation or two (e.g. merge) but
5586
want to switch back to your view after that.
5589
To define the current view::
5591
bzr view file1 dir1 ...
5593
To list the current view::
5597
To delete the current view::
5601
To disable the current view without deleting it::
5603
bzr view --switch off
5605
To define a named view and switch to it::
5607
bzr view --name view-name file1 dir1 ...
5609
To list a named view::
5611
bzr view --name view-name
5613
To delete a named view::
5615
bzr view --name view-name --delete
5617
To switch to a named view::
5619
bzr view --switch view-name
5621
To list all views defined::
5625
To delete all views::
5627
bzr view --delete --all
5631
takes_args = ['file*']
5634
help='Apply list or delete action to all views.',
5637
help='Delete the view.',
5640
help='Name of the view to define, list or delete.',
5644
help='Name of the view to switch to.',
5649
def run(self, file_list,
5655
tree, file_list = tree_files(file_list, apply_view=False)
5656
current_view, view_dict = tree.views.get_view_info()
5661
raise errors.BzrCommandError(
5662
"Both --delete and a file list specified")
5664
raise errors.BzrCommandError(
5665
"Both --delete and --switch specified")
5667
tree.views.set_view_info(None, {})
5668
self.outf.write("Deleted all views.\n")
5670
raise errors.BzrCommandError("No current view to delete")
5672
tree.views.delete_view(name)
5673
self.outf.write("Deleted '%s' view.\n" % name)
5676
raise errors.BzrCommandError(
5677
"Both --switch and a file list specified")
5679
raise errors.BzrCommandError(
5680
"Both --switch and --all specified")
5681
elif switch == 'off':
5682
if current_view is None:
5683
raise errors.BzrCommandError("No current view to disable")
5684
tree.views.set_view_info(None, view_dict)
5685
self.outf.write("Disabled '%s' view.\n" % (current_view))
5687
tree.views.set_view_info(switch, view_dict)
5688
view_str = views.view_display_str(tree.views.lookup_view())
5689
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5692
self.outf.write('Views defined:\n')
5693
for view in sorted(view_dict):
5694
if view == current_view:
5698
view_str = views.view_display_str(view_dict[view])
5699
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5701
self.outf.write('No views defined.\n')
5704
# No name given and no current view set
5707
raise errors.BzrCommandError(
5708
"Cannot change the 'off' pseudo view")
5709
tree.views.set_view(name, sorted(file_list))
5710
view_str = views.view_display_str(tree.views.lookup_view())
5711
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5715
# No name given and no current view set
5716
self.outf.write('No current view.\n')
5718
view_str = views.view_display_str(tree.views.lookup_view(name))
5719
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5722
class cmd_hooks(Command):
5728
for hook_key in sorted(hooks.known_hooks.keys()):
5729
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5730
self.outf.write("%s:\n" % type(some_hooks).__name__)
5731
for hook_name, hook_point in sorted(some_hooks.items()):
5732
self.outf.write(" %s:\n" % (hook_name,))
5733
found_hooks = list(hook_point)
5735
for hook in found_hooks:
5736
self.outf.write(" %s\n" %
5737
(some_hooks.get_hook_name(hook),))
5739
self.outf.write(" <no hooks installed>\n")
5742
class cmd_shelve(Command):
5743
"""Temporarily set aside some changes from the current tree.
5745
Shelve allows you to temporarily put changes you've made "on the shelf",
5746
ie. out of the way, until a later time when you can bring them back from
5747
the shelf with the 'unshelve' command. The changes are stored alongside
5748
your working tree, and so they aren't propagated along with your branch nor
5749
will they survive its deletion.
5751
If shelve --list is specified, previously-shelved changes are listed.
5753
Shelve is intended to help separate several sets of changes that have
5754
been inappropriately mingled. If you just want to get rid of all changes
5755
and you don't need to restore them later, use revert. If you want to
5756
shelve all text changes at once, use shelve --all.
5758
If filenames are specified, only the changes to those files will be
5759
shelved. Other files will be left untouched.
5761
If a revision is specified, changes since that revision will be shelved.
5763
You can put multiple items on the shelf, and by default, 'unshelve' will
5764
restore the most recently shelved changes.
5767
takes_args = ['file*']
5771
Option('all', help='Shelve all changes.'),
5773
RegistryOption('writer', 'Method to use for writing diffs.',
5774
bzrlib.option.diff_writer_registry,
5775
value_switches=True, enum_switch=False),
5777
Option('list', help='List shelved changes.'),
5779
help='Destroy removed changes instead of shelving them.'),
5781
_see_also = ['unshelve']
5783
def run(self, revision=None, all=False, file_list=None, message=None,
5784
writer=None, list=False, destroy=False):
5786
return self.run_for_list()
5787
from bzrlib.shelf_ui import Shelver
5789
writer = bzrlib.option.diff_writer_registry.get()
5791
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5792
file_list, message, destroy=destroy)
5797
except errors.UserAbort:
5800
def run_for_list(self):
5801
tree = WorkingTree.open_containing('.')[0]
5804
manager = tree.get_shelf_manager()
5805
shelves = manager.active_shelves()
5806
if len(shelves) == 0:
5807
note('No shelved changes.')
5809
for shelf_id in reversed(shelves):
5810
message = manager.get_metadata(shelf_id).get('message')
5812
message = '<no message>'
5813
self.outf.write('%3d: %s\n' % (shelf_id, message))
5819
class cmd_unshelve(Command):
5820
"""Restore shelved changes.
5822
By default, the most recently shelved changes are restored. However if you
5823
specify a shelf by id those changes will be restored instead. This works
5824
best when the changes don't depend on each other.
5827
takes_args = ['shelf_id?']
5829
RegistryOption.from_kwargs(
5830
'action', help="The action to perform.",
5831
enum_switch=False, value_switches=True,
5832
apply="Apply changes and remove from the shelf.",
5833
dry_run="Show changes, but do not apply or remove them.",
5834
delete_only="Delete changes without applying them.",
5835
keep="Apply changes but don't delete them.",
5838
_see_also = ['shelve']
5840
def run(self, shelf_id=None, action='apply'):
5841
from bzrlib.shelf_ui import Unshelver
5842
unshelver = Unshelver.from_args(shelf_id, action)
5846
unshelver.tree.unlock()
5849
class cmd_clean_tree(Command):
5850
"""Remove unwanted files from working tree.
5852
By default, only unknown files, not ignored files, are deleted. Versioned
5853
files are never deleted.
5855
Another class is 'detritus', which includes files emitted by bzr during
5856
normal operations and selftests. (The value of these files decreases with
5859
If no options are specified, unknown files are deleted. Otherwise, option
5860
flags are respected, and may be combined.
5862
To check what clean-tree will do, use --dry-run.
5864
takes_options = [Option('ignored', help='Delete all ignored files.'),
5865
Option('detritus', help='Delete conflict files, merge'
5866
' backups, and failed selftest dirs.'),
5868
help='Delete files unknown to bzr (default).'),
5869
Option('dry-run', help='Show files to delete instead of'
5871
Option('force', help='Do not prompt before deleting.')]
5872
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5874
from bzrlib.clean_tree import clean_tree
5875
if not (unknown or ignored or detritus):
5879
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5880
dry_run=dry_run, no_prompt=force)
5883
class cmd_reference(Command):
5884
"""list, view and set branch locations for nested trees.
5886
If no arguments are provided, lists the branch locations for nested trees.
5887
If one argument is provided, display the branch location for that tree.
5888
If two arguments are provided, set the branch location for that tree.
5893
takes_args = ['path?', 'location?']
5895
def run(self, path=None, location=None):
5897
if path is not None:
5899
tree, branch, relpath =(
5900
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5901
if path is not None:
5904
tree = branch.basis_tree()
5906
info = branch._get_all_reference_info().iteritems()
5907
self._display_reference_info(tree, branch, info)
5909
file_id = tree.path2id(path)
5911
raise errors.NotVersionedError(path)
5912
if location is None:
5913
info = [(file_id, branch.get_reference_info(file_id))]
5914
self._display_reference_info(tree, branch, info)
5916
branch.set_reference_info(file_id, path, location)
5918
def _display_reference_info(self, tree, branch, info):
5920
for file_id, (path, location) in info:
5922
path = tree.id2path(file_id)
5923
except errors.NoSuchId:
5925
ref_list.append((path, location))
5926
for path, location in sorted(ref_list):
5927
self.outf.write('%s %s\n' % (path, location))
5930
# these get imported and then picked up by the scan for cmd_*
5931
# TODO: Some more consistent way to split command definitions across files;
5932
# we do need to load at least some information about them to know of
5933
# aliases. ideally we would avoid loading the implementation until the
5934
# details were needed.
5935
from bzrlib.cmd_version_info import cmd_version_info
5936
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5937
from bzrlib.bundle.commands import (
5940
from bzrlib.foreign import cmd_dpush
5941
from bzrlib.sign_my_commits import cmd_sign_my_commits
5942
from bzrlib.weave_commands import cmd_versionedfile_list, \
5943
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
