1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
45
revision as _mod_revision,
53
from bzrlib.branch import Branch
54
from bzrlib.conflicts import ConflictList
55
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
56
from bzrlib.smtp_connection import SMTPConnection
57
from bzrlib.workingtree import WorkingTree
60
from bzrlib.commands import Command, display_command
61
from bzrlib.option import (
68
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
71
def tree_files(file_list, default_branch=u'.', canonicalize=True,
74
return internal_tree_files(file_list, default_branch, canonicalize,
76
except errors.FileInWrongBranch, e:
77
raise errors.BzrCommandError("%s is not in the same branch as %s" %
78
(e.path, file_list[0]))
81
def tree_files_for_add(file_list):
83
Return a tree and list of absolute paths from a file list.
85
Similar to tree_files, but add handles files a bit differently, so it a
86
custom implementation. In particular, MutableTreeTree.smart_add expects
87
absolute paths, which it immediately converts to relative paths.
89
# FIXME Would be nice to just return the relative paths like
90
# internal_tree_files does, but there are a large number of unit tests
91
# that assume the current interface to mutabletree.smart_add
93
tree, relpath = WorkingTree.open_containing(file_list[0])
94
if tree.supports_views():
95
view_files = tree.views.lookup_view()
97
for filename in file_list:
98
if not osutils.is_inside_any(view_files, filename):
99
raise errors.FileOutsideView(filename, view_files)
100
file_list = file_list[:]
101
file_list[0] = tree.abspath(relpath)
103
tree = WorkingTree.open_containing(u'.')[0]
104
if tree.supports_views():
105
view_files = tree.views.lookup_view()
107
file_list = view_files
108
view_str = views.view_display_str(view_files)
109
note("Ignoring files outside view. View is %s" % view_str)
110
return tree, file_list
113
def _get_one_revision(command_name, revisions):
114
if revisions is None:
116
if len(revisions) != 1:
117
raise errors.BzrCommandError(
118
'bzr %s --revision takes exactly one revision identifier' % (
123
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
124
"""Get a revision tree. Not suitable for commands that change the tree.
126
Specifically, the basis tree in dirstate trees is coupled to the dirstate
127
and doing a commit/uncommit/pull will at best fail due to changing the
130
If tree is passed in, it should be already locked, for lifetime management
131
of the trees internal cached state.
135
if revisions is None:
137
rev_tree = tree.basis_tree()
139
rev_tree = branch.basis_tree()
141
revision = _get_one_revision(command_name, revisions)
142
rev_tree = revision.as_tree(branch)
146
# XXX: Bad function name; should possibly also be a class method of
147
# WorkingTree rather than a function.
148
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
150
"""Convert command-line paths to a WorkingTree and relative paths.
152
This is typically used for command-line processors that take one or
153
more filenames, and infer the workingtree that contains them.
155
The filenames given are not required to exist.
157
:param file_list: Filenames to convert.
159
:param default_branch: Fallback tree path to use if file_list is empty or
162
:param apply_view: if True and a view is set, apply it or check that
163
specified files are within it
165
:return: workingtree, [relative_paths]
167
if file_list is None or len(file_list) == 0:
168
tree = WorkingTree.open_containing(default_branch)[0]
169
if tree.supports_views() and apply_view:
170
view_files = tree.views.lookup_view()
172
file_list = view_files
173
view_str = views.view_display_str(view_files)
174
note("Ignoring files outside view. View is %s" % view_str)
175
return tree, file_list
176
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
177
return tree, safe_relpath_files(tree, file_list, canonicalize,
178
apply_view=apply_view)
181
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
182
"""Convert file_list into a list of relpaths in tree.
184
:param tree: A tree to operate on.
185
:param file_list: A list of user provided paths or None.
186
:param apply_view: if True and a view is set, apply it or check that
187
specified files are within it
188
:return: A list of relative paths.
189
:raises errors.PathNotChild: When a provided path is in a different tree
192
if file_list is None:
194
if tree.supports_views() and apply_view:
195
view_files = tree.views.lookup_view()
199
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
200
# doesn't - fix that up here before we enter the loop.
202
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
205
for filename in file_list:
207
relpath = fixer(osutils.dereference_path(filename))
208
if view_files and not osutils.is_inside_any(view_files, relpath):
209
raise errors.FileOutsideView(filename, view_files)
210
new_list.append(relpath)
211
except errors.PathNotChild:
212
raise errors.FileInWrongBranch(tree.branch, filename)
216
def _get_view_info_for_change_reporter(tree):
217
"""Get the view information from a tree for change reporting."""
220
current_view = tree.views.get_view_info()[0]
221
if current_view is not None:
222
view_info = (current_view, tree.views.lookup_view())
223
except errors.ViewsNotSupported:
228
# TODO: Make sure no commands unconditionally use the working directory as a
229
# branch. If a filename argument is used, the first of them should be used to
230
# specify the branch. (Perhaps this can be factored out into some kind of
231
# Argument class, representing a file in a branch, where the first occurrence
234
class cmd_status(Command):
235
"""Display status summary.
237
This reports on versioned and unknown files, reporting them
238
grouped by state. Possible states are:
241
Versioned in the working copy but not in the previous revision.
244
Versioned in the previous revision but removed or deleted
248
Path of this file changed from the previous revision;
249
the text may also have changed. This includes files whose
250
parent directory was renamed.
253
Text has changed since the previous revision.
256
File kind has been changed (e.g. from file to directory).
259
Not versioned and not matching an ignore pattern.
261
To see ignored files use 'bzr ignored'. For details on the
262
changes to file texts, use 'bzr diff'.
264
Note that --short or -S gives status flags for each item, similar
265
to Subversion's status command. To get output similar to svn -q,
268
If no arguments are specified, the status of the entire working
269
directory is shown. Otherwise, only the status of the specified
270
files or directories is reported. If a directory is given, status
271
is reported for everything inside that directory.
273
Before merges are committed, the pending merge tip revisions are
274
shown. To see all pending merge revisions, use the -v option.
275
To skip the display of pending merge information altogether, use
276
the no-pending option or specify a file/directory.
278
If a revision argument is given, the status is calculated against
279
that revision, or between two revisions if two are provided.
282
# TODO: --no-recurse, --recurse options
284
takes_args = ['file*']
285
takes_options = ['show-ids', 'revision', 'change', 'verbose',
286
Option('short', help='Use short status indicators.',
288
Option('versioned', help='Only show versioned files.',
290
Option('no-pending', help='Don\'t show pending merges.',
293
aliases = ['st', 'stat']
295
encoding_type = 'replace'
296
_see_also = ['diff', 'revert', 'status-flags']
299
def run(self, show_ids=False, file_list=None, revision=None, short=False,
300
versioned=False, no_pending=False, verbose=False):
301
from bzrlib.status import show_tree_status
303
if revision and len(revision) > 2:
304
raise errors.BzrCommandError('bzr status --revision takes exactly'
305
' one or two revision specifiers')
307
tree, relfile_list = tree_files(file_list)
308
# Avoid asking for specific files when that is not needed.
309
if relfile_list == ['']:
311
# Don't disable pending merges for full trees other than '.'.
312
if file_list == ['.']:
314
# A specific path within a tree was given.
315
elif relfile_list is not None:
317
show_tree_status(tree, show_ids=show_ids,
318
specific_files=relfile_list, revision=revision,
319
to_file=self.outf, short=short, versioned=versioned,
320
show_pending=(not no_pending), verbose=verbose)
323
class cmd_cat_revision(Command):
324
"""Write out metadata for a revision.
326
The revision to print can either be specified by a specific
327
revision identifier, or you can use --revision.
331
takes_args = ['revision_id?']
332
takes_options = ['revision']
333
# cat-revision is more for frontends so should be exact
337
def run(self, revision_id=None, revision=None):
338
if revision_id is not None and revision is not None:
339
raise errors.BzrCommandError('You can only supply one of'
340
' revision_id or --revision')
341
if revision_id is None and revision is None:
342
raise errors.BzrCommandError('You must supply either'
343
' --revision or a revision_id')
344
b = WorkingTree.open_containing(u'.')[0].branch
346
# TODO: jam 20060112 should cat-revision always output utf-8?
347
if revision_id is not None:
348
revision_id = osutils.safe_revision_id(revision_id, warn=False)
350
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
351
except errors.NoSuchRevision:
352
msg = "The repository %s contains no revision %s." % (b.repository.base,
354
raise errors.BzrCommandError(msg)
355
elif revision is not None:
358
raise errors.BzrCommandError('You cannot specify a NULL'
360
rev_id = rev.as_revision_id(b)
361
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
364
class cmd_dump_btree(Command):
365
"""Dump the contents of a btree index file to stdout.
367
PATH is a btree index file, it can be any URL. This includes things like
368
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
370
By default, the tuples stored in the index file will be displayed. With
371
--raw, we will uncompress the pages, but otherwise display the raw bytes
375
# TODO: Do we want to dump the internal nodes as well?
376
# TODO: It would be nice to be able to dump the un-parsed information,
377
# rather than only going through iter_all_entries. However, this is
378
# good enough for a start
380
encoding_type = 'exact'
381
takes_args = ['path']
382
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
383
' rather than the parsed tuples.'),
386
def run(self, path, raw=False):
387
dirname, basename = osutils.split(path)
388
t = transport.get_transport(dirname)
390
self._dump_raw_bytes(t, basename)
392
self._dump_entries(t, basename)
394
def _get_index_and_bytes(self, trans, basename):
395
"""Create a BTreeGraphIndex and raw bytes."""
396
bt = btree_index.BTreeGraphIndex(trans, basename, None)
397
bytes = trans.get_bytes(basename)
398
bt._file = cStringIO.StringIO(bytes)
399
bt._size = len(bytes)
402
def _dump_raw_bytes(self, trans, basename):
405
# We need to parse at least the root node.
406
# This is because the first page of every row starts with an
407
# uncompressed header.
408
bt, bytes = self._get_index_and_bytes(trans, basename)
409
for page_idx, page_start in enumerate(xrange(0, len(bytes),
410
btree_index._PAGE_SIZE)):
411
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
412
page_bytes = bytes[page_start:page_end]
414
self.outf.write('Root node:\n')
415
header_end, data = bt._parse_header_from_bytes(page_bytes)
416
self.outf.write(page_bytes[:header_end])
418
self.outf.write('\nPage %d\n' % (page_idx,))
419
decomp_bytes = zlib.decompress(page_bytes)
420
self.outf.write(decomp_bytes)
421
self.outf.write('\n')
423
def _dump_entries(self, trans, basename):
425
st = trans.stat(basename)
426
except errors.TransportNotPossible:
427
# We can't stat, so we'll fake it because we have to do the 'get()'
429
bt, _ = self._get_index_and_bytes(trans, basename)
431
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
432
for node in bt.iter_all_entries():
433
# Node is made up of:
434
# (index, key, value, [references])
435
refs_as_tuples = tuple([tuple([tuple(ref) for ref in ref_list])
436
for ref_list in node[3]])
437
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
438
self.outf.write('%s\n' % (as_tuple,))
441
class cmd_remove_tree(Command):
442
"""Remove the working tree from a given branch/checkout.
444
Since a lightweight checkout is little more than a working tree
445
this will refuse to run against one.
447
To re-create the working tree, use "bzr checkout".
449
_see_also = ['checkout', 'working-trees']
450
takes_args = ['location?']
453
help='Remove the working tree even if it has '
454
'uncommitted changes.'),
457
def run(self, location='.', force=False):
458
d = bzrdir.BzrDir.open(location)
461
working = d.open_workingtree()
462
except errors.NoWorkingTree:
463
raise errors.BzrCommandError("No working tree to remove")
464
except errors.NotLocalUrl:
465
raise errors.BzrCommandError("You cannot remove the working tree"
468
if (working.has_changes()):
469
raise errors.UncommittedChanges(working)
471
working_path = working.bzrdir.root_transport.base
472
branch_path = working.branch.bzrdir.root_transport.base
473
if working_path != branch_path:
474
raise errors.BzrCommandError("You cannot remove the working tree"
475
" from a lightweight checkout")
477
d.destroy_workingtree()
480
class cmd_revno(Command):
481
"""Show current revision number.
483
This is equal to the number of revisions on this branch.
487
takes_args = ['location?']
489
Option('tree', help='Show revno of working tree'),
493
def run(self, tree=False, location=u'.'):
496
wt = WorkingTree.open_containing(location)[0]
498
except (errors.NoWorkingTree, errors.NotLocalUrl):
499
raise errors.NoWorkingTree(location)
501
revid = wt.last_revision()
503
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
504
except errors.NoSuchRevision:
506
revno = ".".join(str(n) for n in revno_t)
510
b = Branch.open_containing(location)[0]
517
self.outf.write(str(revno) + '\n')
520
class cmd_revision_info(Command):
521
"""Show revision number and revision id for a given revision identifier.
524
takes_args = ['revision_info*']
528
help='Branch to examine, '
529
'rather than the one containing the working directory.',
533
Option('tree', help='Show revno of working tree'),
537
def run(self, revision=None, directory=u'.', tree=False,
538
revision_info_list=[]):
541
wt = WorkingTree.open_containing(directory)[0]
544
except (errors.NoWorkingTree, errors.NotLocalUrl):
546
b = Branch.open_containing(directory)[0]
550
if revision is not None:
551
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
552
if revision_info_list is not None:
553
for rev_str in revision_info_list:
554
rev_spec = RevisionSpec.from_string(rev_str)
555
revision_ids.append(rev_spec.as_revision_id(b))
556
# No arguments supplied, default to the last revision
557
if len(revision_ids) == 0:
560
raise errors.NoWorkingTree(directory)
561
revision_ids.append(wt.last_revision())
563
revision_ids.append(b.last_revision())
567
for revision_id in revision_ids:
569
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
570
revno = '.'.join(str(i) for i in dotted_revno)
571
except errors.NoSuchRevision:
573
maxlen = max(maxlen, len(revno))
574
revinfos.append([revno, revision_id])
582
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
585
class cmd_add(Command):
586
"""Add specified files or directories.
588
In non-recursive mode, all the named items are added, regardless
589
of whether they were previously ignored. A warning is given if
590
any of the named files are already versioned.
592
In recursive mode (the default), files are treated the same way
593
but the behaviour for directories is different. Directories that
594
are already versioned do not give a warning. All directories,
595
whether already versioned or not, are searched for files or
596
subdirectories that are neither versioned or ignored, and these
597
are added. This search proceeds recursively into versioned
598
directories. If no names are given '.' is assumed.
600
Therefore simply saying 'bzr add' will version all files that
601
are currently unknown.
603
Adding a file whose parent directory is not versioned will
604
implicitly add the parent, and so on up to the root. This means
605
you should never need to explicitly add a directory, they'll just
606
get added when you add a file in the directory.
608
--dry-run will show which files would be added, but not actually
611
--file-ids-from will try to use the file ids from the supplied path.
612
It looks up ids trying to find a matching parent directory with the
613
same filename, and then by pure path. This option is rarely needed
614
but can be useful when adding the same logical file into two
615
branches that will be merged later (without showing the two different
616
adds as a conflict). It is also useful when merging another project
617
into a subdirectory of this one.
619
Any files matching patterns in the ignore list will not be added
620
unless they are explicitly mentioned.
622
takes_args = ['file*']
625
help="Don't recursively add the contents of directories."),
627
help="Show what would be done, but don't actually do anything."),
629
Option('file-ids-from',
631
help='Lookup file ids from this tree.'),
633
encoding_type = 'replace'
634
_see_also = ['remove', 'ignore']
636
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
641
if file_ids_from is not None:
643
base_tree, base_path = WorkingTree.open_containing(
645
except errors.NoWorkingTree:
646
base_branch, base_path = Branch.open_containing(
648
base_tree = base_branch.basis_tree()
650
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
651
to_file=self.outf, should_print=(not is_quiet()))
653
action = bzrlib.add.AddAction(to_file=self.outf,
654
should_print=(not is_quiet()))
657
base_tree.lock_read()
659
tree, file_list = tree_files_for_add(file_list)
660
added, ignored = tree.smart_add(file_list, not
661
no_recurse, action=action, save=not dry_run)
663
if base_tree is not None:
667
for glob in sorted(ignored.keys()):
668
for path in ignored[glob]:
669
self.outf.write("ignored %s matching \"%s\"\n"
673
class cmd_mkdir(Command):
674
"""Create a new versioned directory.
676
This is equivalent to creating the directory and then adding it.
679
takes_args = ['dir+']
680
encoding_type = 'replace'
682
def run(self, dir_list):
685
wt, dd = WorkingTree.open_containing(d)
687
self.outf.write('added %s\n' % d)
690
class cmd_relpath(Command):
691
"""Show path of a file relative to root"""
693
takes_args = ['filename']
697
def run(self, filename):
698
# TODO: jam 20050106 Can relpath return a munged path if
699
# sys.stdout encoding cannot represent it?
700
tree, relpath = WorkingTree.open_containing(filename)
701
self.outf.write(relpath)
702
self.outf.write('\n')
705
class cmd_inventory(Command):
706
"""Show inventory of the current working copy or a revision.
708
It is possible to limit the output to a particular entry
709
type using the --kind option. For example: --kind file.
711
It is also possible to restrict the list of files to a specific
712
set. For example: bzr inventory --show-ids this/file
721
help='List entries of a particular kind: file, directory, symlink.',
724
takes_args = ['file*']
727
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
728
if kind and kind not in ['file', 'directory', 'symlink']:
729
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
731
revision = _get_one_revision('inventory', revision)
732
work_tree, file_list = tree_files(file_list)
733
work_tree.lock_read()
735
if revision is not None:
736
tree = revision.as_tree(work_tree.branch)
738
extra_trees = [work_tree]
744
if file_list is not None:
745
file_ids = tree.paths2ids(file_list, trees=extra_trees,
746
require_versioned=True)
747
# find_ids_across_trees may include some paths that don't
749
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
750
for file_id in file_ids if file_id in tree)
752
entries = tree.inventory.entries()
755
if tree is not work_tree:
758
for path, entry in entries:
759
if kind and kind != entry.kind:
762
self.outf.write('%-50s %s\n' % (path, entry.file_id))
764
self.outf.write(path)
765
self.outf.write('\n')
768
class cmd_mv(Command):
769
"""Move or rename a file.
772
bzr mv OLDNAME NEWNAME
774
bzr mv SOURCE... DESTINATION
776
If the last argument is a versioned directory, all the other names
777
are moved into it. Otherwise, there must be exactly two arguments
778
and the file is changed to a new name.
780
If OLDNAME does not exist on the filesystem but is versioned and
781
NEWNAME does exist on the filesystem but is not versioned, mv
782
assumes that the file has been manually moved and only updates
783
its internal inventory to reflect that change.
784
The same is valid when moving many SOURCE files to a DESTINATION.
786
Files cannot be moved between branches.
789
takes_args = ['names*']
790
takes_options = [Option("after", help="Move only the bzr identifier"
791
" of the file, because the file has already been moved."),
792
Option('auto', help='Automatically guess renames.'),
793
Option('dry-run', help='Avoid making changes when guessing renames.'),
795
aliases = ['move', 'rename']
796
encoding_type = 'replace'
798
def run(self, names_list, after=False, auto=False, dry_run=False):
800
return self.run_auto(names_list, after, dry_run)
802
raise errors.BzrCommandError('--dry-run requires --auto.')
803
if names_list is None:
805
if len(names_list) < 2:
806
raise errors.BzrCommandError("missing file argument")
807
tree, rel_names = tree_files(names_list, canonicalize=False)
808
tree.lock_tree_write()
810
self._run(tree, names_list, rel_names, after)
814
def run_auto(self, names_list, after, dry_run):
815
if names_list is not None and len(names_list) > 1:
816
raise errors.BzrCommandError('Only one path may be specified to'
819
raise errors.BzrCommandError('--after cannot be specified with'
821
work_tree, file_list = tree_files(names_list, default_branch='.')
822
work_tree.lock_tree_write()
824
rename_map.RenameMap.guess_renames(work_tree, dry_run)
828
def _run(self, tree, names_list, rel_names, after):
829
into_existing = osutils.isdir(names_list[-1])
830
if into_existing and len(names_list) == 2:
832
# a. case-insensitive filesystem and change case of dir
833
# b. move directory after the fact (if the source used to be
834
# a directory, but now doesn't exist in the working tree
835
# and the target is an existing directory, just rename it)
836
if (not tree.case_sensitive
837
and rel_names[0].lower() == rel_names[1].lower()):
838
into_existing = False
841
# 'fix' the case of a potential 'from'
842
from_id = tree.path2id(
843
tree.get_canonical_inventory_path(rel_names[0]))
844
if (not osutils.lexists(names_list[0]) and
845
from_id and inv.get_file_kind(from_id) == "directory"):
846
into_existing = False
849
# move into existing directory
850
# All entries reference existing inventory items, so fix them up
851
# for cicp file-systems.
852
rel_names = tree.get_canonical_inventory_paths(rel_names)
853
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
855
self.outf.write("%s => %s\n" % (src, dest))
857
if len(names_list) != 2:
858
raise errors.BzrCommandError('to mv multiple files the'
859
' destination must be a versioned'
862
# for cicp file-systems: the src references an existing inventory
864
src = tree.get_canonical_inventory_path(rel_names[0])
865
# Find the canonical version of the destination: In all cases, the
866
# parent of the target must be in the inventory, so we fetch the
867
# canonical version from there (we do not always *use* the
868
# canonicalized tail portion - we may be attempting to rename the
870
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
871
dest_parent = osutils.dirname(canon_dest)
872
spec_tail = osutils.basename(rel_names[1])
873
# For a CICP file-system, we need to avoid creating 2 inventory
874
# entries that differ only by case. So regardless of the case
875
# we *want* to use (ie, specified by the user or the file-system),
876
# we must always choose to use the case of any existing inventory
877
# items. The only exception to this is when we are attempting a
878
# case-only rename (ie, canonical versions of src and dest are
880
dest_id = tree.path2id(canon_dest)
881
if dest_id is None or tree.path2id(src) == dest_id:
882
# No existing item we care about, so work out what case we
883
# are actually going to use.
885
# If 'after' is specified, the tail must refer to a file on disk.
887
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
889
# pathjoin with an empty tail adds a slash, which breaks
891
dest_parent_fq = tree.basedir
893
dest_tail = osutils.canonical_relpath(
895
osutils.pathjoin(dest_parent_fq, spec_tail))
897
# not 'after', so case as specified is used
898
dest_tail = spec_tail
900
# Use the existing item so 'mv' fails with AlreadyVersioned.
901
dest_tail = os.path.basename(canon_dest)
902
dest = osutils.pathjoin(dest_parent, dest_tail)
903
mutter("attempting to move %s => %s", src, dest)
904
tree.rename_one(src, dest, after=after)
906
self.outf.write("%s => %s\n" % (src, dest))
909
class cmd_pull(Command):
910
"""Turn this branch into a mirror of another branch.
912
This command only works on branches that have not diverged. Branches are
913
considered diverged if the destination branch's most recent commit is one
914
that has not been merged (directly or indirectly) into the parent.
916
If branches have diverged, you can use 'bzr merge' to integrate the changes
917
from one into the other. Once one branch has merged, the other should
918
be able to pull it again.
920
If you want to forget your local changes and just update your branch to
921
match the remote one, use pull --overwrite.
923
If there is no default location set, the first pull will set it. After
924
that, you can omit the location to use the default. To change the
925
default, use --remember. The value will only be saved if the remote
926
location can be accessed.
928
Note: The location can be specified either in the form of a branch,
929
or in the form of a path to a file containing a merge directive generated
933
_see_also = ['push', 'update', 'status-flags', 'send']
934
takes_options = ['remember', 'overwrite', 'revision',
935
custom_help('verbose',
936
help='Show logs of pulled revisions.'),
938
help='Branch to pull into, '
939
'rather than the one containing the working directory.',
944
help="Perform a local pull in a bound "
945
"branch. Local pulls are not applied to "
949
takes_args = ['location?']
950
encoding_type = 'replace'
952
def run(self, location=None, remember=False, overwrite=False,
953
revision=None, verbose=False,
954
directory=None, local=False):
955
# FIXME: too much stuff is in the command class
958
if directory is None:
961
tree_to = WorkingTree.open_containing(directory)[0]
962
branch_to = tree_to.branch
963
except errors.NoWorkingTree:
965
branch_to = Branch.open_containing(directory)[0]
967
if local and not branch_to.get_bound_location():
968
raise errors.LocalRequiresBoundBranch()
970
possible_transports = []
971
if location is not None:
973
mergeable = bundle.read_mergeable_from_url(location,
974
possible_transports=possible_transports)
975
except errors.NotABundle:
978
stored_loc = branch_to.get_parent()
980
if stored_loc is None:
981
raise errors.BzrCommandError("No pull location known or"
984
display_url = urlutils.unescape_for_display(stored_loc,
987
self.outf.write("Using saved parent location: %s\n" % display_url)
988
location = stored_loc
990
revision = _get_one_revision('pull', revision)
991
if mergeable is not None:
992
if revision is not None:
993
raise errors.BzrCommandError(
994
'Cannot use -r with merge directives or bundles')
995
mergeable.install_revisions(branch_to.repository)
996
base_revision_id, revision_id, verified = \
997
mergeable.get_merge_request(branch_to.repository)
998
branch_from = branch_to
1000
branch_from = Branch.open(location,
1001
possible_transports=possible_transports)
1003
if branch_to.get_parent() is None or remember:
1004
branch_to.set_parent(branch_from.base)
1006
if branch_from is not branch_to:
1007
branch_from.lock_read()
1009
if revision is not None:
1010
revision_id = revision.as_revision_id(branch_from)
1012
branch_to.lock_write()
1014
if tree_to is not None:
1015
view_info = _get_view_info_for_change_reporter(tree_to)
1016
change_reporter = delta._ChangeReporter(
1017
unversioned_filter=tree_to.is_ignored,
1018
view_info=view_info)
1019
result = tree_to.pull(
1020
branch_from, overwrite, revision_id, change_reporter,
1021
possible_transports=possible_transports, local=local)
1023
result = branch_to.pull(
1024
branch_from, overwrite, revision_id, local=local)
1026
result.report(self.outf)
1027
if verbose and result.old_revid != result.new_revid:
1028
log.show_branch_change(
1029
branch_to, self.outf, result.old_revno,
1034
if branch_from is not branch_to:
1035
branch_from.unlock()
1038
class cmd_push(Command):
1039
"""Update a mirror of this branch.
1041
The target branch will not have its working tree populated because this
1042
is both expensive, and is not supported on remote file systems.
1044
Some smart servers or protocols *may* put the working tree in place in
1047
This command only works on branches that have not diverged. Branches are
1048
considered diverged if the destination branch's most recent commit is one
1049
that has not been merged (directly or indirectly) by the source branch.
1051
If branches have diverged, you can use 'bzr push --overwrite' to replace
1052
the other branch completely, discarding its unmerged changes.
1054
If you want to ensure you have the different changes in the other branch,
1055
do a merge (see bzr help merge) from the other branch, and commit that.
1056
After that you will be able to do a push without '--overwrite'.
1058
If there is no default push location set, the first push will set it.
1059
After that, you can omit the location to use the default. To change the
1060
default, use --remember. The value will only be saved if the remote
1061
location can be accessed.
1064
_see_also = ['pull', 'update', 'working-trees']
1065
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1066
Option('create-prefix',
1067
help='Create the path leading up to the branch '
1068
'if it does not already exist.'),
1070
help='Branch to push from, '
1071
'rather than the one containing the working directory.',
1075
Option('use-existing-dir',
1076
help='By default push will fail if the target'
1077
' directory exists, but does not already'
1078
' have a control directory. This flag will'
1079
' allow push to proceed.'),
1081
help='Create a stacked branch that references the public location '
1082
'of the parent branch.'),
1083
Option('stacked-on',
1084
help='Create a stacked branch that refers to another branch '
1085
'for the commit history. Only the work not present in the '
1086
'referenced branch is included in the branch created.',
1089
help='Refuse to push if there are uncommitted changes in'
1090
' the working tree, --no-strict disables the check.'),
1092
takes_args = ['location?']
1093
encoding_type = 'replace'
1095
def run(self, location=None, remember=False, overwrite=False,
1096
create_prefix=False, verbose=False, revision=None,
1097
use_existing_dir=False, directory=None, stacked_on=None,
1098
stacked=False, strict=None):
1099
from bzrlib.push import _show_push_branch
1101
if directory is None:
1103
# Get the source branch
1105
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1107
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1108
if strict is None: strict = True # default value
1109
# Get the tip's revision_id
1110
revision = _get_one_revision('push', revision)
1111
if revision is not None:
1112
revision_id = revision.in_history(br_from).rev_id
1115
if strict and tree is not None and revision_id is None:
1116
if (tree.has_changes()):
1117
raise errors.UncommittedChanges(
1118
tree, more='Use --no-strict to force the push.')
1119
if tree.last_revision() != tree.branch.last_revision():
1120
# The tree has lost sync with its branch, there is little
1121
# chance that the user is aware of it but he can still force
1122
# the push with --no-strict
1123
raise errors.OutOfDateTree(
1124
tree, more='Use --no-strict to force the push.')
1126
# Get the stacked_on branch, if any
1127
if stacked_on is not None:
1128
stacked_on = urlutils.normalize_url(stacked_on)
1130
parent_url = br_from.get_parent()
1132
parent = Branch.open(parent_url)
1133
stacked_on = parent.get_public_branch()
1135
# I considered excluding non-http url's here, thus forcing
1136
# 'public' branches only, but that only works for some
1137
# users, so it's best to just depend on the user spotting an
1138
# error by the feedback given to them. RBC 20080227.
1139
stacked_on = parent_url
1141
raise errors.BzrCommandError(
1142
"Could not determine branch to refer to.")
1144
# Get the destination location
1145
if location is None:
1146
stored_loc = br_from.get_push_location()
1147
if stored_loc is None:
1148
raise errors.BzrCommandError(
1149
"No push location known or specified.")
1151
display_url = urlutils.unescape_for_display(stored_loc,
1153
self.outf.write("Using saved push location: %s\n" % display_url)
1154
location = stored_loc
1156
_show_push_branch(br_from, revision_id, location, self.outf,
1157
verbose=verbose, overwrite=overwrite, remember=remember,
1158
stacked_on=stacked_on, create_prefix=create_prefix,
1159
use_existing_dir=use_existing_dir)
1162
class cmd_branch(Command):
1163
"""Create a new branch that is a copy of an existing branch.
1165
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1166
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1167
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1168
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1169
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1172
To retrieve the branch as of a particular revision, supply the --revision
1173
parameter, as in "branch foo/bar -r 5".
1176
_see_also = ['checkout']
1177
takes_args = ['from_location', 'to_location?']
1178
takes_options = ['revision', Option('hardlink',
1179
help='Hard-link working tree files where possible.'),
1181
help="Create a branch without a working-tree."),
1183
help="Switch the checkout in the current directory "
1184
"to the new branch."),
1186
help='Create a stacked branch referring to the source branch. '
1187
'The new branch will depend on the availability of the source '
1188
'branch for all operations.'),
1189
Option('standalone',
1190
help='Do not use a shared repository, even if available.'),
1191
Option('use-existing-dir',
1192
help='By default branch will fail if the target'
1193
' directory exists, but does not already'
1194
' have a control directory. This flag will'
1195
' allow branch to proceed.'),
1197
aliases = ['get', 'clone']
1199
def run(self, from_location, to_location=None, revision=None,
1200
hardlink=False, stacked=False, standalone=False, no_tree=False,
1201
use_existing_dir=False, switch=False):
1202
from bzrlib import switch as _mod_switch
1203
from bzrlib.tag import _merge_tags_if_possible
1204
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1206
revision = _get_one_revision('branch', revision)
1209
if revision is not None:
1210
revision_id = revision.as_revision_id(br_from)
1212
# FIXME - wt.last_revision, fallback to branch, fall back to
1213
# None or perhaps NULL_REVISION to mean copy nothing
1215
revision_id = br_from.last_revision()
1216
if to_location is None:
1217
to_location = urlutils.derive_to_location(from_location)
1218
to_transport = transport.get_transport(to_location)
1220
to_transport.mkdir('.')
1221
except errors.FileExists:
1222
if not use_existing_dir:
1223
raise errors.BzrCommandError('Target directory "%s" '
1224
'already exists.' % to_location)
1227
bzrdir.BzrDir.open_from_transport(to_transport)
1228
except errors.NotBranchError:
1231
raise errors.AlreadyBranchError(to_location)
1232
except errors.NoSuchFile:
1233
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1236
# preserve whatever source format we have.
1237
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1238
possible_transports=[to_transport],
1239
accelerator_tree=accelerator_tree,
1240
hardlink=hardlink, stacked=stacked,
1241
force_new_repo=standalone,
1242
create_tree_if_local=not no_tree,
1243
source_branch=br_from)
1244
branch = dir.open_branch()
1245
except errors.NoSuchRevision:
1246
to_transport.delete_tree('.')
1247
msg = "The branch %s has no revision %s." % (from_location,
1249
raise errors.BzrCommandError(msg)
1250
_merge_tags_if_possible(br_from, branch)
1251
# If the source branch is stacked, the new branch may
1252
# be stacked whether we asked for that explicitly or not.
1253
# We therefore need a try/except here and not just 'if stacked:'
1255
note('Created new stacked branch referring to %s.' %
1256
branch.get_stacked_on_url())
1257
except (errors.NotStacked, errors.UnstackableBranchFormat,
1258
errors.UnstackableRepositoryFormat), e:
1259
note('Branched %d revision(s).' % branch.revno())
1261
# Switch to the new branch
1262
wt, _ = WorkingTree.open_containing('.')
1263
_mod_switch.switch(wt.bzrdir, branch)
1264
note('Switched to branch: %s',
1265
urlutils.unescape_for_display(branch.base, 'utf-8'))
1270
class cmd_checkout(Command):
1271
"""Create a new checkout of an existing branch.
1273
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1274
the branch found in '.'. This is useful if you have removed the working tree
1275
or if it was never created - i.e. if you pushed the branch to its current
1276
location using SFTP.
1278
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1279
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1280
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1281
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1282
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1285
To retrieve the branch as of a particular revision, supply the --revision
1286
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1287
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1291
_see_also = ['checkouts', 'branch']
1292
takes_args = ['branch_location?', 'to_location?']
1293
takes_options = ['revision',
1294
Option('lightweight',
1295
help="Perform a lightweight checkout. Lightweight "
1296
"checkouts depend on access to the branch for "
1297
"every operation. Normal checkouts can perform "
1298
"common operations like diff and status without "
1299
"such access, and also support local commits."
1301
Option('files-from', type=str,
1302
help="Get file contents from this tree."),
1304
help='Hard-link working tree files where possible.'
1309
def run(self, branch_location=None, to_location=None, revision=None,
1310
lightweight=False, files_from=None, hardlink=False):
1311
if branch_location is None:
1312
branch_location = osutils.getcwd()
1313
to_location = branch_location
1314
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1316
revision = _get_one_revision('checkout', revision)
1317
if files_from is not None:
1318
accelerator_tree = WorkingTree.open(files_from)
1319
if revision is not None:
1320
revision_id = revision.as_revision_id(source)
1323
if to_location is None:
1324
to_location = urlutils.derive_to_location(branch_location)
1325
# if the source and to_location are the same,
1326
# and there is no working tree,
1327
# then reconstitute a branch
1328
if (osutils.abspath(to_location) ==
1329
osutils.abspath(branch_location)):
1331
source.bzrdir.open_workingtree()
1332
except errors.NoWorkingTree:
1333
source.bzrdir.create_workingtree(revision_id)
1335
source.create_checkout(to_location, revision_id, lightweight,
1336
accelerator_tree, hardlink)
1339
class cmd_renames(Command):
1340
"""Show list of renamed files.
1342
# TODO: Option to show renames between two historical versions.
1344
# TODO: Only show renames under dir, rather than in the whole branch.
1345
_see_also = ['status']
1346
takes_args = ['dir?']
1349
def run(self, dir=u'.'):
1350
tree = WorkingTree.open_containing(dir)[0]
1353
new_inv = tree.inventory
1354
old_tree = tree.basis_tree()
1355
old_tree.lock_read()
1357
old_inv = old_tree.inventory
1359
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1360
for f, paths, c, v, p, n, k, e in iterator:
1361
if paths[0] == paths[1]:
1365
renames.append(paths)
1367
for old_name, new_name in renames:
1368
self.outf.write("%s => %s\n" % (old_name, new_name))
1375
class cmd_update(Command):
1376
"""Update a tree to have the latest code committed to its branch.
1378
This will perform a merge into the working tree, and may generate
1379
conflicts. If you have any local changes, you will still
1380
need to commit them after the update for the update to be complete.
1382
If you want to discard your local changes, you can just do a
1383
'bzr revert' instead of 'bzr commit' after the update.
1386
_see_also = ['pull', 'working-trees', 'status-flags']
1387
takes_args = ['dir?']
1390
def run(self, dir='.'):
1391
tree = WorkingTree.open_containing(dir)[0]
1392
possible_transports = []
1393
master = tree.branch.get_master_branch(
1394
possible_transports=possible_transports)
1395
if master is not None:
1398
tree.lock_tree_write()
1400
existing_pending_merges = tree.get_parent_ids()[1:]
1401
last_rev = _mod_revision.ensure_null(tree.last_revision())
1402
if last_rev == _mod_revision.ensure_null(
1403
tree.branch.last_revision()):
1404
# may be up to date, check master too.
1405
if master is None or last_rev == _mod_revision.ensure_null(
1406
master.last_revision()):
1407
revno = tree.branch.revision_id_to_revno(last_rev)
1408
note("Tree is up to date at revision %d." % (revno,))
1410
view_info = _get_view_info_for_change_reporter(tree)
1411
conflicts = tree.update(
1412
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1413
view_info=view_info), possible_transports=possible_transports)
1414
revno = tree.branch.revision_id_to_revno(
1415
_mod_revision.ensure_null(tree.last_revision()))
1416
note('Updated to revision %d.' % (revno,))
1417
if tree.get_parent_ids()[1:] != existing_pending_merges:
1418
note('Your local commits will now show as pending merges with '
1419
"'bzr status', and can be committed with 'bzr commit'.")
1428
class cmd_info(Command):
1429
"""Show information about a working tree, branch or repository.
1431
This command will show all known locations and formats associated to the
1432
tree, branch or repository.
1434
In verbose mode, statistical information is included with each report.
1435
To see extended statistic information, use a verbosity level of 2 or
1436
higher by specifying the verbose option multiple times, e.g. -vv.
1438
Branches and working trees will also report any missing revisions.
1442
Display information on the format and related locations:
1446
Display the above together with extended format information and
1447
basic statistics (like the number of files in the working tree and
1448
number of revisions in the branch and repository):
1452
Display the above together with number of committers to the branch:
1456
_see_also = ['revno', 'working-trees', 'repositories']
1457
takes_args = ['location?']
1458
takes_options = ['verbose']
1459
encoding_type = 'replace'
1462
def run(self, location=None, verbose=False):
1464
noise_level = get_verbosity_level()
1467
from bzrlib.info import show_bzrdir_info
1468
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1469
verbose=noise_level, outfile=self.outf)
1472
class cmd_remove(Command):
1473
"""Remove files or directories.
1475
This makes bzr stop tracking changes to the specified files. bzr will delete
1476
them if they can easily be recovered using revert. If no options or
1477
parameters are given bzr will scan for files that are being tracked by bzr
1478
but missing in your tree and stop tracking them for you.
1480
takes_args = ['file*']
1481
takes_options = ['verbose',
1482
Option('new', help='Only remove files that have never been committed.'),
1483
RegistryOption.from_kwargs('file-deletion-strategy',
1484
'The file deletion mode to be used.',
1485
title='Deletion Strategy', value_switches=True, enum_switch=False,
1486
safe='Only delete files if they can be'
1487
' safely recovered (default).',
1488
keep='Delete from bzr but leave the working copy.',
1489
force='Delete all the specified files, even if they can not be '
1490
'recovered and even if they are non-empty directories.')]
1491
aliases = ['rm', 'del']
1492
encoding_type = 'replace'
1494
def run(self, file_list, verbose=False, new=False,
1495
file_deletion_strategy='safe'):
1496
tree, file_list = tree_files(file_list)
1498
if file_list is not None:
1499
file_list = [f for f in file_list]
1503
# Heuristics should probably all move into tree.remove_smart or
1506
added = tree.changes_from(tree.basis_tree(),
1507
specific_files=file_list).added
1508
file_list = sorted([f[0] for f in added], reverse=True)
1509
if len(file_list) == 0:
1510
raise errors.BzrCommandError('No matching files.')
1511
elif file_list is None:
1512
# missing files show up in iter_changes(basis) as
1513
# versioned-with-no-kind.
1515
for change in tree.iter_changes(tree.basis_tree()):
1516
# Find paths in the working tree that have no kind:
1517
if change[1][1] is not None and change[6][1] is None:
1518
missing.append(change[1][1])
1519
file_list = sorted(missing, reverse=True)
1520
file_deletion_strategy = 'keep'
1521
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1522
keep_files=file_deletion_strategy=='keep',
1523
force=file_deletion_strategy=='force')
1528
class cmd_file_id(Command):
1529
"""Print file_id of a particular file or directory.
1531
The file_id is assigned when the file is first added and remains the
1532
same through all revisions where the file exists, even when it is
1537
_see_also = ['inventory', 'ls']
1538
takes_args = ['filename']
1541
def run(self, filename):
1542
tree, relpath = WorkingTree.open_containing(filename)
1543
i = tree.path2id(relpath)
1545
raise errors.NotVersionedError(filename)
1547
self.outf.write(i + '\n')
1550
class cmd_file_path(Command):
1551
"""Print path of file_ids to a file or directory.
1553
This prints one line for each directory down to the target,
1554
starting at the branch root.
1558
takes_args = ['filename']
1561
def run(self, filename):
1562
tree, relpath = WorkingTree.open_containing(filename)
1563
fid = tree.path2id(relpath)
1565
raise errors.NotVersionedError(filename)
1566
segments = osutils.splitpath(relpath)
1567
for pos in range(1, len(segments) + 1):
1568
path = osutils.joinpath(segments[:pos])
1569
self.outf.write("%s\n" % tree.path2id(path))
1572
class cmd_reconcile(Command):
1573
"""Reconcile bzr metadata in a branch.
1575
This can correct data mismatches that may have been caused by
1576
previous ghost operations or bzr upgrades. You should only
1577
need to run this command if 'bzr check' or a bzr developer
1578
advises you to run it.
1580
If a second branch is provided, cross-branch reconciliation is
1581
also attempted, which will check that data like the tree root
1582
id which was not present in very early bzr versions is represented
1583
correctly in both branches.
1585
At the same time it is run it may recompress data resulting in
1586
a potential saving in disk space or performance gain.
1588
The branch *MUST* be on a listable system such as local disk or sftp.
1591
_see_also = ['check']
1592
takes_args = ['branch?']
1594
def run(self, branch="."):
1595
from bzrlib.reconcile import reconcile
1596
dir = bzrdir.BzrDir.open(branch)
1600
class cmd_revision_history(Command):
1601
"""Display the list of revision ids on a branch."""
1604
takes_args = ['location?']
1609
def run(self, location="."):
1610
branch = Branch.open_containing(location)[0]
1611
for revid in branch.revision_history():
1612
self.outf.write(revid)
1613
self.outf.write('\n')
1616
class cmd_ancestry(Command):
1617
"""List all revisions merged into this branch."""
1619
_see_also = ['log', 'revision-history']
1620
takes_args = ['location?']
1625
def run(self, location="."):
1627
wt = WorkingTree.open_containing(location)[0]
1628
except errors.NoWorkingTree:
1629
b = Branch.open(location)
1630
last_revision = b.last_revision()
1633
last_revision = wt.last_revision()
1635
revision_ids = b.repository.get_ancestry(last_revision)
1637
for revision_id in revision_ids:
1638
self.outf.write(revision_id + '\n')
1641
class cmd_init(Command):
1642
"""Make a directory into a versioned branch.
1644
Use this to create an empty branch, or before importing an
1647
If there is a repository in a parent directory of the location, then
1648
the history of the branch will be stored in the repository. Otherwise
1649
init creates a standalone branch which carries its own history
1650
in the .bzr directory.
1652
If there is already a branch at the location but it has no working tree,
1653
the tree can be populated with 'bzr checkout'.
1655
Recipe for importing a tree of files::
1661
bzr commit -m "imported project"
1664
_see_also = ['init-repository', 'branch', 'checkout']
1665
takes_args = ['location?']
1667
Option('create-prefix',
1668
help='Create the path leading up to the branch '
1669
'if it does not already exist.'),
1670
RegistryOption('format',
1671
help='Specify a format for this branch. '
1672
'See "help formats".',
1673
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1674
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1675
value_switches=True,
1676
title="Branch format",
1678
Option('append-revisions-only',
1679
help='Never change revnos or the existing log.'
1680
' Append revisions to it only.')
1682
def run(self, location=None, format=None, append_revisions_only=False,
1683
create_prefix=False):
1685
format = bzrdir.format_registry.make_bzrdir('default')
1686
if location is None:
1689
to_transport = transport.get_transport(location)
1691
# The path has to exist to initialize a
1692
# branch inside of it.
1693
# Just using os.mkdir, since I don't
1694
# believe that we want to create a bunch of
1695
# locations if the user supplies an extended path
1697
to_transport.ensure_base()
1698
except errors.NoSuchFile:
1699
if not create_prefix:
1700
raise errors.BzrCommandError("Parent directory of %s"
1702
"\nYou may supply --create-prefix to create all"
1703
" leading parent directories."
1705
to_transport.create_prefix()
1708
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1709
except errors.NotBranchError:
1710
# really a NotBzrDir error...
1711
create_branch = bzrdir.BzrDir.create_branch_convenience
1712
branch = create_branch(to_transport.base, format=format,
1713
possible_transports=[to_transport])
1714
a_bzrdir = branch.bzrdir
1716
from bzrlib.transport.local import LocalTransport
1717
if a_bzrdir.has_branch():
1718
if (isinstance(to_transport, LocalTransport)
1719
and not a_bzrdir.has_workingtree()):
1720
raise errors.BranchExistsWithoutWorkingTree(location)
1721
raise errors.AlreadyBranchError(location)
1722
branch = a_bzrdir.create_branch()
1723
a_bzrdir.create_workingtree()
1724
if append_revisions_only:
1726
branch.set_append_revisions_only(True)
1727
except errors.UpgradeRequired:
1728
raise errors.BzrCommandError('This branch format cannot be set'
1729
' to append-revisions-only. Try --default.')
1731
from bzrlib.info import describe_layout, describe_format
1733
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1734
except (errors.NoWorkingTree, errors.NotLocalUrl):
1736
repository = branch.repository
1737
layout = describe_layout(repository, branch, tree).lower()
1738
format = describe_format(a_bzrdir, repository, branch, tree)
1739
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1740
if repository.is_shared():
1741
#XXX: maybe this can be refactored into transport.path_or_url()
1742
url = repository.bzrdir.root_transport.external_url()
1744
url = urlutils.local_path_from_url(url)
1745
except errors.InvalidURL:
1747
self.outf.write("Using shared repository: %s\n" % url)
1750
class cmd_init_repository(Command):
1751
"""Create a shared repository to hold branches.
1753
New branches created under the repository directory will store their
1754
revisions in the repository, not in the branch directory.
1756
If the --no-trees option is used then the branches in the repository
1757
will not have working trees by default.
1760
Create a shared repositories holding just branches::
1762
bzr init-repo --no-trees repo
1765
Make a lightweight checkout elsewhere::
1767
bzr checkout --lightweight repo/trunk trunk-checkout
1772
_see_also = ['init', 'branch', 'checkout', 'repositories']
1773
takes_args = ["location"]
1774
takes_options = [RegistryOption('format',
1775
help='Specify a format for this repository. See'
1776
' "bzr help formats" for details.',
1777
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1778
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1779
value_switches=True, title='Repository format'),
1781
help='Branches in the repository will default to'
1782
' not having a working tree.'),
1784
aliases = ["init-repo"]
1786
def run(self, location, format=None, no_trees=False):
1788
format = bzrdir.format_registry.make_bzrdir('default')
1790
if location is None:
1793
to_transport = transport.get_transport(location)
1794
to_transport.ensure_base()
1796
newdir = format.initialize_on_transport(to_transport)
1797
repo = newdir.create_repository(shared=True)
1798
repo.set_make_working_trees(not no_trees)
1800
from bzrlib.info import show_bzrdir_info
1801
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1804
class cmd_diff(Command):
1805
"""Show differences in the working tree, between revisions or branches.
1807
If no arguments are given, all changes for the current tree are listed.
1808
If files are given, only the changes in those files are listed.
1809
Remote and multiple branches can be compared by using the --old and
1810
--new options. If not provided, the default for both is derived from
1811
the first argument, if any, or the current tree if no arguments are
1814
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1815
produces patches suitable for "patch -p1".
1819
2 - unrepresentable changes
1824
Shows the difference in the working tree versus the last commit::
1828
Difference between the working tree and revision 1::
1832
Difference between revision 3 and revision 1::
1836
Difference between revision 3 and revision 1 for branch xxx::
1840
To see the changes introduced in revision X::
1844
Note that in the case of a merge, the -c option shows the changes
1845
compared to the left hand parent. To see the changes against
1846
another parent, use::
1848
bzr diff -r<chosen_parent>..X
1850
The changes introduced by revision 2 (equivalent to -r1..2)::
1854
Show just the differences for file NEWS::
1858
Show the differences in working tree xxx for file NEWS::
1862
Show the differences from branch xxx to this working tree:
1866
Show the differences between two branches for file NEWS::
1868
bzr diff --old xxx --new yyy NEWS
1870
Same as 'bzr diff' but prefix paths with old/ and new/::
1872
bzr diff --prefix old/:new/
1874
_see_also = ['status']
1875
takes_args = ['file*']
1877
Option('diff-options', type=str,
1878
help='Pass these options to the external diff program.'),
1879
Option('prefix', type=str,
1881
help='Set prefixes added to old and new filenames, as '
1882
'two values separated by a colon. (eg "old/:new/").'),
1884
help='Branch/tree to compare from.',
1888
help='Branch/tree to compare to.',
1894
help='Use this command to compare files.',
1898
aliases = ['di', 'dif']
1899
encoding_type = 'exact'
1902
def run(self, revision=None, file_list=None, diff_options=None,
1903
prefix=None, old=None, new=None, using=None):
1904
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1906
if (prefix is None) or (prefix == '0'):
1914
old_label, new_label = prefix.split(":")
1916
raise errors.BzrCommandError(
1917
'--prefix expects two values separated by a colon'
1918
' (eg "old/:new/")')
1920
if revision and len(revision) > 2:
1921
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1922
' one or two revision specifiers')
1924
(old_tree, new_tree,
1925
old_branch, new_branch,
1926
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1927
file_list, revision, old, new, apply_view=True)
1928
return show_diff_trees(old_tree, new_tree, sys.stdout,
1929
specific_files=specific_files,
1930
external_diff_options=diff_options,
1931
old_label=old_label, new_label=new_label,
1932
extra_trees=extra_trees, using=using)
1935
class cmd_deleted(Command):
1936
"""List files deleted in the working tree.
1938
# TODO: Show files deleted since a previous revision, or
1939
# between two revisions.
1940
# TODO: Much more efficient way to do this: read in new
1941
# directories with readdir, rather than stating each one. Same
1942
# level of effort but possibly much less IO. (Or possibly not,
1943
# if the directories are very large...)
1944
_see_also = ['status', 'ls']
1945
takes_options = ['show-ids']
1948
def run(self, show_ids=False):
1949
tree = WorkingTree.open_containing(u'.')[0]
1952
old = tree.basis_tree()
1955
for path, ie in old.inventory.iter_entries():
1956
if not tree.has_id(ie.file_id):
1957
self.outf.write(path)
1959
self.outf.write(' ')
1960
self.outf.write(ie.file_id)
1961
self.outf.write('\n')
1968
class cmd_modified(Command):
1969
"""List files modified in working tree.
1973
_see_also = ['status', 'ls']
1976
help='Write an ascii NUL (\\0) separator '
1977
'between files rather than a newline.')
1981
def run(self, null=False):
1982
tree = WorkingTree.open_containing(u'.')[0]
1983
td = tree.changes_from(tree.basis_tree())
1984
for path, id, kind, text_modified, meta_modified in td.modified:
1986
self.outf.write(path + '\0')
1988
self.outf.write(osutils.quotefn(path) + '\n')
1991
class cmd_added(Command):
1992
"""List files added in working tree.
1996
_see_also = ['status', 'ls']
1999
help='Write an ascii NUL (\\0) separator '
2000
'between files rather than a newline.')
2004
def run(self, null=False):
2005
wt = WorkingTree.open_containing(u'.')[0]
2008
basis = wt.basis_tree()
2011
basis_inv = basis.inventory
2014
if file_id in basis_inv:
2016
if inv.is_root(file_id) and len(basis_inv) == 0:
2018
path = inv.id2path(file_id)
2019
if not os.access(osutils.abspath(path), os.F_OK):
2022
self.outf.write(path + '\0')
2024
self.outf.write(osutils.quotefn(path) + '\n')
2031
class cmd_root(Command):
2032
"""Show the tree root directory.
2034
The root is the nearest enclosing directory with a .bzr control
2037
takes_args = ['filename?']
2039
def run(self, filename=None):
2040
"""Print the branch root."""
2041
tree = WorkingTree.open_containing(filename)[0]
2042
self.outf.write(tree.basedir + '\n')
2045
def _parse_limit(limitstring):
2047
return int(limitstring)
2049
msg = "The limit argument must be an integer."
2050
raise errors.BzrCommandError(msg)
2053
def _parse_levels(s):
2057
msg = "The levels argument must be an integer."
2058
raise errors.BzrCommandError(msg)
2061
class cmd_log(Command):
2062
"""Show historical log for a branch or subset of a branch.
2064
log is bzr's default tool for exploring the history of a branch.
2065
The branch to use is taken from the first parameter. If no parameters
2066
are given, the branch containing the working directory is logged.
2067
Here are some simple examples::
2069
bzr log log the current branch
2070
bzr log foo.py log a file in its branch
2071
bzr log http://server/branch log a branch on a server
2073
The filtering, ordering and information shown for each revision can
2074
be controlled as explained below. By default, all revisions are
2075
shown sorted (topologically) so that newer revisions appear before
2076
older ones and descendants always appear before ancestors. If displayed,
2077
merged revisions are shown indented under the revision in which they
2082
The log format controls how information about each revision is
2083
displayed. The standard log formats are called ``long``, ``short``
2084
and ``line``. The default is long. See ``bzr help log-formats``
2085
for more details on log formats.
2087
The following options can be used to control what information is
2090
-l N display a maximum of N revisions
2091
-n N display N levels of revisions (0 for all, 1 for collapsed)
2092
-v display a status summary (delta) for each revision
2093
-p display a diff (patch) for each revision
2094
--show-ids display revision-ids (and file-ids), not just revnos
2096
Note that the default number of levels to display is a function of the
2097
log format. If the -n option is not used, the standard log formats show
2098
just the top level (mainline).
2100
Status summaries are shown using status flags like A, M, etc. To see
2101
the changes explained using words like ``added`` and ``modified``
2102
instead, use the -vv option.
2106
To display revisions from oldest to newest, use the --forward option.
2107
In most cases, using this option will have little impact on the total
2108
time taken to produce a log, though --forward does not incrementally
2109
display revisions like --reverse does when it can.
2111
:Revision filtering:
2113
The -r option can be used to specify what revision or range of revisions
2114
to filter against. The various forms are shown below::
2116
-rX display revision X
2117
-rX.. display revision X and later
2118
-r..Y display up to and including revision Y
2119
-rX..Y display from X to Y inclusive
2121
See ``bzr help revisionspec`` for details on how to specify X and Y.
2122
Some common examples are given below::
2124
-r-1 show just the tip
2125
-r-10.. show the last 10 mainline revisions
2126
-rsubmit:.. show what's new on this branch
2127
-rancestor:path.. show changes since the common ancestor of this
2128
branch and the one at location path
2129
-rdate:yesterday.. show changes since yesterday
2131
When logging a range of revisions using -rX..Y, log starts at
2132
revision Y and searches back in history through the primary
2133
("left-hand") parents until it finds X. When logging just the
2134
top level (using -n1), an error is reported if X is not found
2135
along the way. If multi-level logging is used (-n0), X may be
2136
a nested merge revision and the log will be truncated accordingly.
2140
If parameters are given and the first one is not a branch, the log
2141
will be filtered to show only those revisions that changed the
2142
nominated files or directories.
2144
Filenames are interpreted within their historical context. To log a
2145
deleted file, specify a revision range so that the file existed at
2146
the end or start of the range.
2148
Historical context is also important when interpreting pathnames of
2149
renamed files/directories. Consider the following example:
2151
* revision 1: add tutorial.txt
2152
* revision 2: modify tutorial.txt
2153
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2157
* ``bzr log guide.txt`` will log the file added in revision 1
2159
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2161
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2162
the original file in revision 2.
2164
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2165
was no file called guide.txt in revision 2.
2167
Renames are always followed by log. By design, there is no need to
2168
explicitly ask for this (and no way to stop logging a file back
2169
until it was last renamed).
2173
The --message option can be used for finding revisions that match a
2174
regular expression in a commit message.
2178
GUI tools and IDEs are often better at exploring history than command
2179
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2180
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2181
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2183
Web interfaces are often better at exploring history than command line
2184
tools, particularly for branches on servers. You may prefer Loggerhead
2185
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2187
You may find it useful to add the aliases below to ``bazaar.conf``::
2191
top = log -l10 --line
2194
``bzr tip`` will then show the latest revision while ``bzr top``
2195
will show the last 10 mainline revisions. To see the details of a
2196
particular revision X, ``bzr show -rX``.
2198
If you are interested in looking deeper into a particular merge X,
2199
use ``bzr log -n0 -rX``.
2201
``bzr log -v`` on a branch with lots of history is currently
2202
very slow. A fix for this issue is currently under development.
2203
With or without that fix, it is recommended that a revision range
2204
be given when using the -v option.
2206
bzr has a generic full-text matching plugin, bzr-search, that can be
2207
used to find revisions matching user names, commit messages, etc.
2208
Among other features, this plugin can find all revisions containing
2209
a list of words but not others.
2211
When exploring non-mainline history on large projects with deep
2212
history, the performance of log can be greatly improved by installing
2213
the historycache plugin. This plugin buffers historical information
2214
trading disk space for faster speed.
2216
takes_args = ['file*']
2217
_see_also = ['log-formats', 'revisionspec']
2220
help='Show from oldest to newest.'),
2222
custom_help('verbose',
2223
help='Show files changed in each revision.'),
2227
type=bzrlib.option._parse_revision_str,
2229
help='Show just the specified revision.'
2230
' See also "help revisionspec".'),
2234
help='Number of levels to display - 0 for all, 1 for flat.',
2236
type=_parse_levels),
2239
help='Show revisions whose message matches this '
2240
'regular expression.',
2244
help='Limit the output to the first N revisions.',
2249
help='Show changes made in each revision as a patch.'),
2250
Option('include-merges',
2251
help='Show merged revisions like --levels 0 does.'),
2253
encoding_type = 'replace'
2256
def run(self, file_list=None, timezone='original',
2267
include_merges=False):
2268
from bzrlib.log import (
2270
make_log_request_dict,
2271
_get_info_for_log_files,
2273
direction = (forward and 'forward') or 'reverse'
2278
raise errors.BzrCommandError(
2279
'--levels and --include-merges are mutually exclusive')
2281
if change is not None:
2283
raise errors.RangeInChangeOption()
2284
if revision is not None:
2285
raise errors.BzrCommandError(
2286
'--revision and --change are mutually exclusive')
2291
filter_by_dir = False
2295
# find the file ids to log and check for directory filtering
2296
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2297
revision, file_list)
2298
for relpath, file_id, kind in file_info_list:
2300
raise errors.BzrCommandError(
2301
"Path unknown at end or start of revision range: %s" %
2303
# If the relpath is the top of the tree, we log everything
2308
file_ids.append(file_id)
2309
filter_by_dir = filter_by_dir or (
2310
kind in ['directory', 'tree-reference'])
2313
# FIXME ? log the current subdir only RBC 20060203
2314
if revision is not None \
2315
and len(revision) > 0 and revision[0].get_branch():
2316
location = revision[0].get_branch()
2319
dir, relpath = bzrdir.BzrDir.open_containing(location)
2320
b = dir.open_branch()
2322
rev1, rev2 = _get_revision_range(revision, b, self.name())
2324
# Decide on the type of delta & diff filtering to use
2325
# TODO: add an --all-files option to make this configurable & consistent
2333
diff_type = 'partial'
2337
# Build the log formatter
2338
if log_format is None:
2339
log_format = log.log_formatter_registry.get_default(b)
2340
lf = log_format(show_ids=show_ids, to_file=self.outf,
2341
show_timezone=timezone,
2342
delta_format=get_verbosity_level(),
2344
show_advice=levels is None)
2346
# Choose the algorithm for doing the logging. It's annoying
2347
# having multiple code paths like this but necessary until
2348
# the underlying repository format is faster at generating
2349
# deltas or can provide everything we need from the indices.
2350
# The default algorithm - match-using-deltas - works for
2351
# multiple files and directories and is faster for small
2352
# amounts of history (200 revisions say). However, it's too
2353
# slow for logging a single file in a repository with deep
2354
# history, i.e. > 10K revisions. In the spirit of "do no
2355
# evil when adding features", we continue to use the
2356
# original algorithm - per-file-graph - for the "single
2357
# file that isn't a directory without showing a delta" case.
2358
partial_history = revision and b.repository._format.supports_chks
2359
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2360
or delta_type or partial_history)
2362
# Build the LogRequest and execute it
2363
if len(file_ids) == 0:
2365
rqst = make_log_request_dict(
2366
direction=direction, specific_fileids=file_ids,
2367
start_revision=rev1, end_revision=rev2, limit=limit,
2368
message_search=message, delta_type=delta_type,
2369
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2370
Logger(b, rqst).show(lf)
2376
def _get_revision_range(revisionspec_list, branch, command_name):
2377
"""Take the input of a revision option and turn it into a revision range.
2379
It returns RevisionInfo objects which can be used to obtain the rev_id's
2380
of the desired revisions. It does some user input validations.
2382
if revisionspec_list is None:
2385
elif len(revisionspec_list) == 1:
2386
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2387
elif len(revisionspec_list) == 2:
2388
start_spec = revisionspec_list[0]
2389
end_spec = revisionspec_list[1]
2390
if end_spec.get_branch() != start_spec.get_branch():
2391
# b is taken from revision[0].get_branch(), and
2392
# show_log will use its revision_history. Having
2393
# different branches will lead to weird behaviors.
2394
raise errors.BzrCommandError(
2395
"bzr %s doesn't accept two revisions in different"
2396
" branches." % command_name)
2397
rev1 = start_spec.in_history(branch)
2398
# Avoid loading all of history when we know a missing
2399
# end of range means the last revision ...
2400
if end_spec.spec is None:
2401
last_revno, last_revision_id = branch.last_revision_info()
2402
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2404
rev2 = end_spec.in_history(branch)
2406
raise errors.BzrCommandError(
2407
'bzr %s --revision takes one or two values.' % command_name)
2411
def _revision_range_to_revid_range(revision_range):
2414
if revision_range[0] is not None:
2415
rev_id1 = revision_range[0].rev_id
2416
if revision_range[1] is not None:
2417
rev_id2 = revision_range[1].rev_id
2418
return rev_id1, rev_id2
2420
def get_log_format(long=False, short=False, line=False, default='long'):
2421
log_format = default
2425
log_format = 'short'
2431
class cmd_touching_revisions(Command):
2432
"""Return revision-ids which affected a particular file.
2434
A more user-friendly interface is "bzr log FILE".
2438
takes_args = ["filename"]
2441
def run(self, filename):
2442
tree, relpath = WorkingTree.open_containing(filename)
2443
file_id = tree.path2id(relpath)
2447
touching_revs = log.find_touching_revisions(b, file_id)
2448
for revno, revision_id, what in touching_revs:
2449
self.outf.write("%6d %s\n" % (revno, what))
2454
class cmd_ls(Command):
2455
"""List files in a tree.
2458
_see_also = ['status', 'cat']
2459
takes_args = ['path?']
2463
Option('recursive', short_name='R',
2464
help='Recurse into subdirectories.'),
2466
help='Print paths relative to the root of the branch.'),
2467
Option('unknown', help='Print unknown files.'),
2468
Option('versioned', help='Print versioned files.',
2470
Option('ignored', help='Print ignored files.'),
2472
help='Write an ascii NUL (\\0) separator '
2473
'between files rather than a newline.'),
2475
help='List entries of a particular kind: file, directory, symlink.',
2480
def run(self, revision=None, verbose=False,
2481
recursive=False, from_root=False,
2482
unknown=False, versioned=False, ignored=False,
2483
null=False, kind=None, show_ids=False, path=None):
2485
if kind and kind not in ('file', 'directory', 'symlink'):
2486
raise errors.BzrCommandError('invalid kind specified')
2488
if verbose and null:
2489
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2490
all = not (unknown or versioned or ignored)
2492
selection = {'I':ignored, '?':unknown, 'V':versioned}
2498
raise errors.BzrCommandError('cannot specify both --from-root'
2501
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2504
# Calculate the prefix to use
2508
prefix = relpath + '/'
2509
elif fs_path != '.':
2510
prefix = fs_path + '/'
2512
if revision is not None or tree is None:
2513
tree = _get_one_revision_tree('ls', revision, branch=branch)
2516
if isinstance(tree, WorkingTree) and tree.supports_views():
2517
view_files = tree.views.lookup_view()
2520
view_str = views.view_display_str(view_files)
2521
note("Ignoring files outside view. View is %s" % view_str)
2525
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2526
from_dir=relpath, recursive=recursive):
2527
# Apply additional masking
2528
if not all and not selection[fc]:
2530
if kind is not None and fkind != kind:
2535
fullpath = osutils.pathjoin(relpath, fp)
2538
views.check_path_in_view(tree, fullpath)
2539
except errors.FileOutsideView:
2544
fp = osutils.pathjoin(prefix, fp)
2545
kindch = entry.kind_character()
2546
outstring = fp + kindch
2547
ui.ui_factory.clear_term()
2549
outstring = '%-8s %s' % (fc, outstring)
2550
if show_ids and fid is not None:
2551
outstring = "%-50s %s" % (outstring, fid)
2552
self.outf.write(outstring + '\n')
2554
self.outf.write(fp + '\0')
2557
self.outf.write(fid)
2558
self.outf.write('\0')
2566
self.outf.write('%-50s %s\n' % (outstring, my_id))
2568
self.outf.write(outstring + '\n')
2573
class cmd_unknowns(Command):
2574
"""List unknown files.
2582
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2583
self.outf.write(osutils.quotefn(f) + '\n')
2586
class cmd_ignore(Command):
2587
"""Ignore specified files or patterns.
2589
See ``bzr help patterns`` for details on the syntax of patterns.
2591
If a .bzrignore file does not exist, the ignore command
2592
will create one and add the specified files or patterns to the newly
2593
created file. The ignore command will also automatically add the
2594
.bzrignore file to be versioned. Creating a .bzrignore file without
2595
the use of the ignore command will require an explicit add command.
2597
To remove patterns from the ignore list, edit the .bzrignore file.
2598
After adding, editing or deleting that file either indirectly by
2599
using this command or directly by using an editor, be sure to commit
2602
Note: ignore patterns containing shell wildcards must be quoted from
2606
Ignore the top level Makefile::
2608
bzr ignore ./Makefile
2610
Ignore class files in all directories::
2612
bzr ignore "*.class"
2614
Ignore .o files under the lib directory::
2616
bzr ignore "lib/**/*.o"
2618
Ignore .o files under the lib directory::
2620
bzr ignore "RE:lib/.*\.o"
2622
Ignore everything but the "debian" toplevel directory::
2624
bzr ignore "RE:(?!debian/).*"
2627
_see_also = ['status', 'ignored', 'patterns']
2628
takes_args = ['name_pattern*']
2630
Option('old-default-rules',
2631
help='Write out the ignore rules bzr < 0.9 always used.')
2634
def run(self, name_pattern_list=None, old_default_rules=None):
2635
from bzrlib import ignores
2636
if old_default_rules is not None:
2637
# dump the rules and exit
2638
for pattern in ignores.OLD_DEFAULTS:
2641
if not name_pattern_list:
2642
raise errors.BzrCommandError("ignore requires at least one "
2643
"NAME_PATTERN or --old-default-rules")
2644
name_pattern_list = [globbing.normalize_pattern(p)
2645
for p in name_pattern_list]
2646
for name_pattern in name_pattern_list:
2647
if (name_pattern[0] == '/' or
2648
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2649
raise errors.BzrCommandError(
2650
"NAME_PATTERN should not be an absolute path")
2651
tree, relpath = WorkingTree.open_containing(u'.')
2652
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2653
ignored = globbing.Globster(name_pattern_list)
2656
for entry in tree.list_files():
2660
if ignored.match(filename):
2661
matches.append(filename.encode('utf-8'))
2663
if len(matches) > 0:
2664
print "Warning: the following files are version controlled and" \
2665
" match your ignore pattern:\n%s" \
2666
"\nThese files will continue to be version controlled" \
2667
" unless you 'bzr remove' them." % ("\n".join(matches),)
2670
class cmd_ignored(Command):
2671
"""List ignored files and the patterns that matched them.
2673
List all the ignored files and the ignore pattern that caused the file to
2676
Alternatively, to list just the files::
2681
encoding_type = 'replace'
2682
_see_also = ['ignore', 'ls']
2686
tree = WorkingTree.open_containing(u'.')[0]
2689
for path, file_class, kind, file_id, entry in tree.list_files():
2690
if file_class != 'I':
2692
## XXX: Slightly inefficient since this was already calculated
2693
pat = tree.is_ignored(path)
2694
self.outf.write('%-50s %s\n' % (path, pat))
2699
class cmd_lookup_revision(Command):
2700
"""Lookup the revision-id from a revision-number
2703
bzr lookup-revision 33
2706
takes_args = ['revno']
2709
def run(self, revno):
2713
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2715
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2718
class cmd_export(Command):
2719
"""Export current or past revision to a destination directory or archive.
2721
If no revision is specified this exports the last committed revision.
2723
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2724
given, try to find the format with the extension. If no extension
2725
is found exports to a directory (equivalent to --format=dir).
2727
If root is supplied, it will be used as the root directory inside
2728
container formats (tar, zip, etc). If it is not supplied it will default
2729
to the exported filename. The root option has no effect for 'dir' format.
2731
If branch is omitted then the branch containing the current working
2732
directory will be used.
2734
Note: Export of tree with non-ASCII filenames to zip is not supported.
2736
================= =========================
2737
Supported formats Autodetected by extension
2738
================= =========================
2741
tbz2 .tar.bz2, .tbz2
2744
================= =========================
2746
takes_args = ['dest', 'branch_or_subdir?']
2749
help="Type of file to export to.",
2752
Option('filters', help='Apply content filters to export the '
2753
'convenient form.'),
2756
help="Name of the root directory inside the exported file."),
2758
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2759
root=None, filters=False):
2760
from bzrlib.export import export
2762
if branch_or_subdir is None:
2763
tree = WorkingTree.open_containing(u'.')[0]
2767
b, subdir = Branch.open_containing(branch_or_subdir)
2770
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2772
export(rev_tree, dest, format, root, subdir, filtered=filters)
2773
except errors.NoSuchExportFormat, e:
2774
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2777
class cmd_cat(Command):
2778
"""Write the contents of a file as of a given revision to standard output.
2780
If no revision is nominated, the last revision is used.
2782
Note: Take care to redirect standard output when using this command on a
2788
Option('name-from-revision', help='The path name in the old tree.'),
2789
Option('filters', help='Apply content filters to display the '
2790
'convenience form.'),
2793
takes_args = ['filename']
2794
encoding_type = 'exact'
2797
def run(self, filename, revision=None, name_from_revision=False,
2799
if revision is not None and len(revision) != 1:
2800
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2801
" one revision specifier")
2802
tree, branch, relpath = \
2803
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2806
return self._run(tree, branch, relpath, filename, revision,
2807
name_from_revision, filters)
2811
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2814
tree = b.basis_tree()
2815
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2817
old_file_id = rev_tree.path2id(relpath)
2819
if name_from_revision:
2820
# Try in revision if requested
2821
if old_file_id is None:
2822
raise errors.BzrCommandError(
2823
"%r is not present in revision %s" % (
2824
filename, rev_tree.get_revision_id()))
2826
content = rev_tree.get_file_text(old_file_id)
2828
cur_file_id = tree.path2id(relpath)
2830
if cur_file_id is not None:
2831
# Then try with the actual file id
2833
content = rev_tree.get_file_text(cur_file_id)
2835
except errors.NoSuchId:
2836
# The actual file id didn't exist at that time
2838
if not found and old_file_id is not None:
2839
# Finally try with the old file id
2840
content = rev_tree.get_file_text(old_file_id)
2843
# Can't be found anywhere
2844
raise errors.BzrCommandError(
2845
"%r is not present in revision %s" % (
2846
filename, rev_tree.get_revision_id()))
2848
from bzrlib.filters import (
2849
ContentFilterContext,
2850
filtered_output_bytes,
2852
filters = rev_tree._content_filter_stack(relpath)
2853
chunks = content.splitlines(True)
2854
content = filtered_output_bytes(chunks, filters,
2855
ContentFilterContext(relpath, rev_tree))
2856
self.outf.writelines(content)
2858
self.outf.write(content)
2861
class cmd_local_time_offset(Command):
2862
"""Show the offset in seconds from GMT to local time."""
2866
print osutils.local_time_offset()
2870
class cmd_commit(Command):
2871
"""Commit changes into a new revision.
2873
An explanatory message needs to be given for each commit. This is
2874
often done by using the --message option (getting the message from the
2875
command line) or by using the --file option (getting the message from
2876
a file). If neither of these options is given, an editor is opened for
2877
the user to enter the message. To see the changed files in the
2878
boilerplate text loaded into the editor, use the --show-diff option.
2880
By default, the entire tree is committed and the person doing the
2881
commit is assumed to be the author. These defaults can be overridden
2886
If selected files are specified, only changes to those files are
2887
committed. If a directory is specified then the directory and
2888
everything within it is committed.
2890
When excludes are given, they take precedence over selected files.
2891
For example, to commit only changes within foo, but not changes
2894
bzr commit foo -x foo/bar
2896
A selective commit after a merge is not yet supported.
2900
If the author of the change is not the same person as the committer,
2901
you can specify the author's name using the --author option. The
2902
name should be in the same format as a committer-id, e.g.
2903
"John Doe <jdoe@example.com>". If there is more than one author of
2904
the change you can specify the option multiple times, once for each
2909
A common mistake is to forget to add a new file or directory before
2910
running the commit command. The --strict option checks for unknown
2911
files and aborts the commit if any are found. More advanced pre-commit
2912
checks can be implemented by defining hooks. See ``bzr help hooks``
2917
If you accidentially commit the wrong changes or make a spelling
2918
mistake in the commit message say, you can use the uncommit command
2919
to undo it. See ``bzr help uncommit`` for details.
2921
Hooks can also be configured to run after a commit. This allows you
2922
to trigger updates to external systems like bug trackers. The --fixes
2923
option can be used to record the association between a revision and
2924
one or more bugs. See ``bzr help bugs`` for details.
2926
A selective commit may fail in some cases where the committed
2927
tree would be invalid. Consider::
2932
bzr commit foo -m "committing foo"
2933
bzr mv foo/bar foo/baz
2936
bzr commit foo/bar -m "committing bar but not baz"
2938
In the example above, the last commit will fail by design. This gives
2939
the user the opportunity to decide whether they want to commit the
2940
rename at the same time, separately first, or not at all. (As a general
2941
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2943
# TODO: Run hooks on tree to-be-committed, and after commit.
2945
# TODO: Strict commit that fails if there are deleted files.
2946
# (what does "deleted files" mean ??)
2948
# TODO: Give better message for -s, --summary, used by tla people
2950
# XXX: verbose currently does nothing
2952
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2953
takes_args = ['selected*']
2955
ListOption('exclude', type=str, short_name='x',
2956
help="Do not consider changes made to a given path."),
2957
Option('message', type=unicode,
2959
help="Description of the new revision."),
2962
help='Commit even if nothing has changed.'),
2963
Option('file', type=str,
2966
help='Take commit message from this file.'),
2968
help="Refuse to commit if there are unknown "
2969
"files in the working tree."),
2970
Option('commit-time', type=str,
2971
help="Manually set a commit time using commit date "
2972
"format, e.g. '2009-10-10 08:00:00 +0100'."),
2973
ListOption('fixes', type=str,
2974
help="Mark a bug as being fixed by this revision "
2975
"(see \"bzr help bugs\")."),
2976
ListOption('author', type=unicode,
2977
help="Set the author's name, if it's different "
2978
"from the committer."),
2980
help="Perform a local commit in a bound "
2981
"branch. Local commits are not pushed to "
2982
"the master branch until a normal commit "
2986
help='When no message is supplied, show the diff along'
2987
' with the status summary in the message editor.'),
2989
aliases = ['ci', 'checkin']
2991
def _iter_bug_fix_urls(self, fixes, branch):
2992
# Configure the properties for bug fixing attributes.
2993
for fixed_bug in fixes:
2994
tokens = fixed_bug.split(':')
2995
if len(tokens) != 2:
2996
raise errors.BzrCommandError(
2997
"Invalid bug %s. Must be in the form of 'tracker:id'. "
2998
"See \"bzr help bugs\" for more information on this "
2999
"feature.\nCommit refused." % fixed_bug)
3000
tag, bug_id = tokens
3002
yield bugtracker.get_bug_url(tag, branch, bug_id)
3003
except errors.UnknownBugTrackerAbbreviation:
3004
raise errors.BzrCommandError(
3005
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3006
except errors.MalformedBugIdentifier, e:
3007
raise errors.BzrCommandError(
3008
"%s\nCommit refused." % (str(e),))
3010
def run(self, message=None, file=None, verbose=False, selected_list=None,
3011
unchanged=False, strict=False, local=False, fixes=None,
3012
author=None, show_diff=False, exclude=None, commit_time=None):
3013
from bzrlib.errors import (
3018
from bzrlib.msgeditor import (
3019
edit_commit_message_encoded,
3020
generate_commit_message_template,
3021
make_commit_message_template_encoded
3024
commit_stamp = offset = None
3025
if commit_time is not None:
3027
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3028
except ValueError, e:
3029
raise errors.BzrCommandError(
3030
"Could not parse --commit-time: " + str(e))
3032
# TODO: Need a blackbox test for invoking the external editor; may be
3033
# slightly problematic to run this cross-platform.
3035
# TODO: do more checks that the commit will succeed before
3036
# spending the user's valuable time typing a commit message.
3040
tree, selected_list = tree_files(selected_list)
3041
if selected_list == ['']:
3042
# workaround - commit of root of tree should be exactly the same
3043
# as just default commit in that tree, and succeed even though
3044
# selected-file merge commit is not done yet
3049
bug_property = bugtracker.encode_fixes_bug_urls(
3050
self._iter_bug_fix_urls(fixes, tree.branch))
3052
properties['bugs'] = bug_property
3054
if local and not tree.branch.get_bound_location():
3055
raise errors.LocalRequiresBoundBranch()
3057
def get_message(commit_obj):
3058
"""Callback to get commit message"""
3059
my_message = message
3060
if my_message is not None and '\r' in my_message:
3061
my_message = my_message.replace('\r\n', '\n')
3062
my_message = my_message.replace('\r', '\n')
3063
if my_message is None and not file:
3064
t = make_commit_message_template_encoded(tree,
3065
selected_list, diff=show_diff,
3066
output_encoding=osutils.get_user_encoding())
3067
start_message = generate_commit_message_template(commit_obj)
3068
my_message = edit_commit_message_encoded(t,
3069
start_message=start_message)
3070
if my_message is None:
3071
raise errors.BzrCommandError("please specify a commit"
3072
" message with either --message or --file")
3073
elif my_message and file:
3074
raise errors.BzrCommandError(
3075
"please specify either --message or --file")
3077
my_message = codecs.open(file, 'rt',
3078
osutils.get_user_encoding()).read()
3079
if my_message == "":
3080
raise errors.BzrCommandError("empty commit message specified")
3083
# The API permits a commit with a filter of [] to mean 'select nothing'
3084
# but the command line should not do that.
3085
if not selected_list:
3086
selected_list = None
3088
tree.commit(message_callback=get_message,
3089
specific_files=selected_list,
3090
allow_pointless=unchanged, strict=strict, local=local,
3091
reporter=None, verbose=verbose, revprops=properties,
3092
authors=author, timestamp=commit_stamp,
3094
exclude=safe_relpath_files(tree, exclude))
3095
except PointlessCommit:
3096
# FIXME: This should really happen before the file is read in;
3097
# perhaps prepare the commit; get the message; then actually commit
3098
raise errors.BzrCommandError("No changes to commit."
3099
" Use --unchanged to commit anyhow.")
3100
except ConflictsInTree:
3101
raise errors.BzrCommandError('Conflicts detected in working '
3102
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3104
except StrictCommitFailed:
3105
raise errors.BzrCommandError("Commit refused because there are"
3106
" unknown files in the working tree.")
3107
except errors.BoundBranchOutOfDate, e:
3108
raise errors.BzrCommandError(str(e) + "\n"
3109
'To commit to master branch, run update and then commit.\n'
3110
'You can also pass --local to commit to continue working '
3114
class cmd_check(Command):
3115
"""Validate working tree structure, branch consistency and repository history.
3117
This command checks various invariants about branch and repository storage
3118
to detect data corruption or bzr bugs.
3120
The working tree and branch checks will only give output if a problem is
3121
detected. The output fields of the repository check are:
3124
This is just the number of revisions checked. It doesn't
3128
This is just the number of versionedfiles checked. It
3129
doesn't indicate a problem.
3131
unreferenced ancestors
3132
Texts that are ancestors of other texts, but
3133
are not properly referenced by the revision ancestry. This is a
3134
subtle problem that Bazaar can work around.
3137
This is the total number of unique file contents
3138
seen in the checked revisions. It does not indicate a problem.
3141
This is the total number of repeated texts seen
3142
in the checked revisions. Texts can be repeated when their file
3143
entries are modified, but the file contents are not. It does not
3146
If no restrictions are specified, all Bazaar data that is found at the given
3147
location will be checked.
3151
Check the tree and branch at 'foo'::
3153
bzr check --tree --branch foo
3155
Check only the repository at 'bar'::
3157
bzr check --repo bar
3159
Check everything at 'baz'::
3164
_see_also = ['reconcile']
3165
takes_args = ['path?']
3166
takes_options = ['verbose',
3167
Option('branch', help="Check the branch related to the"
3168
" current directory."),
3169
Option('repo', help="Check the repository related to the"
3170
" current directory."),
3171
Option('tree', help="Check the working tree related to"
3172
" the current directory.")]
3174
def run(self, path=None, verbose=False, branch=False, repo=False,
3176
from bzrlib.check import check_dwim
3179
if not branch and not repo and not tree:
3180
branch = repo = tree = True
3181
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3184
class cmd_upgrade(Command):
3185
"""Upgrade branch storage to current format.
3187
The check command or bzr developers may sometimes advise you to run
3188
this command. When the default format has changed you may also be warned
3189
during other operations to upgrade.
3192
_see_also = ['check']
3193
takes_args = ['url?']
3195
RegistryOption('format',
3196
help='Upgrade to a specific format. See "bzr help'
3197
' formats" for details.',
3198
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3199
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3200
value_switches=True, title='Branch format'),
3203
def run(self, url='.', format=None):
3204
from bzrlib.upgrade import upgrade
3205
upgrade(url, format)
3208
class cmd_whoami(Command):
3209
"""Show or set bzr user id.
3212
Show the email of the current user::
3216
Set the current user::
3218
bzr whoami "Frank Chu <fchu@example.com>"
3220
takes_options = [ Option('email',
3221
help='Display email address only.'),
3223
help='Set identity for the current branch instead of '
3226
takes_args = ['name?']
3227
encoding_type = 'replace'
3230
def run(self, email=False, branch=False, name=None):
3232
# use branch if we're inside one; otherwise global config
3234
c = Branch.open_containing('.')[0].get_config()
3235
except errors.NotBranchError:
3236
c = config.GlobalConfig()
3238
self.outf.write(c.user_email() + '\n')
3240
self.outf.write(c.username() + '\n')
3243
# display a warning if an email address isn't included in the given name.
3245
config.extract_email_address(name)
3246
except errors.NoEmailInUsername, e:
3247
warning('"%s" does not seem to contain an email address. '
3248
'This is allowed, but not recommended.', name)
3250
# use global config unless --branch given
3252
c = Branch.open_containing('.')[0].get_config()
3254
c = config.GlobalConfig()
3255
c.set_user_option('email', name)
3258
class cmd_nick(Command):
3259
"""Print or set the branch nickname.
3261
If unset, the tree root directory name is used as the nickname.
3262
To print the current nickname, execute with no argument.
3264
Bound branches use the nickname of its master branch unless it is set
3268
_see_also = ['info']
3269
takes_args = ['nickname?']
3270
def run(self, nickname=None):
3271
branch = Branch.open_containing(u'.')[0]
3272
if nickname is None:
3273
self.printme(branch)
3275
branch.nick = nickname
3278
def printme(self, branch):
3282
class cmd_alias(Command):
3283
"""Set/unset and display aliases.
3286
Show the current aliases::
3290
Show the alias specified for 'll'::
3294
Set an alias for 'll'::
3296
bzr alias ll="log --line -r-10..-1"
3298
To remove an alias for 'll'::
3300
bzr alias --remove ll
3303
takes_args = ['name?']
3305
Option('remove', help='Remove the alias.'),
3308
def run(self, name=None, remove=False):
3310
self.remove_alias(name)
3312
self.print_aliases()
3314
equal_pos = name.find('=')
3316
self.print_alias(name)
3318
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3320
def remove_alias(self, alias_name):
3321
if alias_name is None:
3322
raise errors.BzrCommandError(
3323
'bzr alias --remove expects an alias to remove.')
3324
# If alias is not found, print something like:
3325
# unalias: foo: not found
3326
c = config.GlobalConfig()
3327
c.unset_alias(alias_name)
3330
def print_aliases(self):
3331
"""Print out the defined aliases in a similar format to bash."""
3332
aliases = config.GlobalConfig().get_aliases()
3333
for key, value in sorted(aliases.iteritems()):
3334
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3337
def print_alias(self, alias_name):
3338
from bzrlib.commands import get_alias
3339
alias = get_alias(alias_name)
3341
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3344
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3346
def set_alias(self, alias_name, alias_command):
3347
"""Save the alias in the global config."""
3348
c = config.GlobalConfig()
3349
c.set_alias(alias_name, alias_command)
3352
class cmd_selftest(Command):
3353
"""Run internal test suite.
3355
If arguments are given, they are regular expressions that say which tests
3356
should run. Tests matching any expression are run, and other tests are
3359
Alternatively if --first is given, matching tests are run first and then
3360
all other tests are run. This is useful if you have been working in a
3361
particular area, but want to make sure nothing else was broken.
3363
If --exclude is given, tests that match that regular expression are
3364
excluded, regardless of whether they match --first or not.
3366
To help catch accidential dependencies between tests, the --randomize
3367
option is useful. In most cases, the argument used is the word 'now'.
3368
Note that the seed used for the random number generator is displayed
3369
when this option is used. The seed can be explicitly passed as the
3370
argument to this option if required. This enables reproduction of the
3371
actual ordering used if and when an order sensitive problem is encountered.
3373
If --list-only is given, the tests that would be run are listed. This is
3374
useful when combined with --first, --exclude and/or --randomize to
3375
understand their impact. The test harness reports "Listed nn tests in ..."
3376
instead of "Ran nn tests in ..." when list mode is enabled.
3378
If the global option '--no-plugins' is given, plugins are not loaded
3379
before running the selftests. This has two effects: features provided or
3380
modified by plugins will not be tested, and tests provided by plugins will
3383
Tests that need working space on disk use a common temporary directory,
3384
typically inside $TMPDIR or /tmp.
3386
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3387
into a pdb postmortem session.
3390
Run only tests relating to 'ignore'::
3394
Disable plugins and list tests as they're run::
3396
bzr --no-plugins selftest -v
3398
# NB: this is used from the class without creating an instance, which is
3399
# why it does not have a self parameter.
3400
def get_transport_type(typestring):
3401
"""Parse and return a transport specifier."""
3402
if typestring == "sftp":
3403
from bzrlib.transport.sftp import SFTPAbsoluteServer
3404
return SFTPAbsoluteServer
3405
if typestring == "memory":
3406
from bzrlib.transport.memory import MemoryServer
3408
if typestring == "fakenfs":
3409
from bzrlib.transport.fakenfs import FakeNFSServer
3410
return FakeNFSServer
3411
msg = "No known transport type %s. Supported types are: sftp\n" %\
3413
raise errors.BzrCommandError(msg)
3416
takes_args = ['testspecs*']
3417
takes_options = ['verbose',
3419
help='Stop when one test fails.',
3423
help='Use a different transport by default '
3424
'throughout the test suite.',
3425
type=get_transport_type),
3427
help='Run the benchmarks rather than selftests.'),
3428
Option('lsprof-timed',
3429
help='Generate lsprof output for benchmarked'
3430
' sections of code.'),
3431
Option('lsprof-tests',
3432
help='Generate lsprof output for each test.'),
3433
Option('cache-dir', type=str,
3434
help='Cache intermediate benchmark output in this '
3437
help='Run all tests, but run specified tests first.',
3441
help='List the tests instead of running them.'),
3442
RegistryOption('parallel',
3443
help="Run the test suite in parallel.",
3444
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3445
value_switches=False,
3447
Option('randomize', type=str, argname="SEED",
3448
help='Randomize the order of tests using the given'
3449
' seed or "now" for the current time.'),
3450
Option('exclude', type=str, argname="PATTERN",
3452
help='Exclude tests that match this regular'
3455
help='Output test progress via subunit.'),
3456
Option('strict', help='Fail on missing dependencies or '
3458
Option('load-list', type=str, argname='TESTLISTFILE',
3459
help='Load a test id list from a text file.'),
3460
ListOption('debugflag', type=str, short_name='E',
3461
help='Turn on a selftest debug flag.'),
3462
ListOption('starting-with', type=str, argname='TESTID',
3463
param_name='starting_with', short_name='s',
3465
'Load only the tests starting with TESTID.'),
3467
encoding_type = 'replace'
3470
Command.__init__(self)
3471
self.additional_selftest_args = {}
3473
def run(self, testspecs_list=None, verbose=False, one=False,
3474
transport=None, benchmark=None,
3475
lsprof_timed=None, cache_dir=None,
3476
first=False, list_only=False,
3477
randomize=None, exclude=None, strict=False,
3478
load_list=None, debugflag=None, starting_with=None, subunit=False,
3479
parallel=None, lsprof_tests=False):
3480
from bzrlib.tests import selftest
3481
import bzrlib.benchmarks as benchmarks
3482
from bzrlib.benchmarks import tree_creator
3484
# Make deprecation warnings visible, unless -Werror is set
3485
symbol_versioning.activate_deprecation_warnings(override=False)
3487
if cache_dir is not None:
3488
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3489
if testspecs_list is not None:
3490
pattern = '|'.join(testspecs_list)
3495
from bzrlib.tests import SubUnitBzrRunner
3497
raise errors.BzrCommandError("subunit not available. subunit "
3498
"needs to be installed to use --subunit.")
3499
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3501
self.additional_selftest_args.setdefault(
3502
'suite_decorators', []).append(parallel)
3504
test_suite_factory = benchmarks.test_suite
3505
# Unless user explicitly asks for quiet, be verbose in benchmarks
3506
verbose = not is_quiet()
3507
# TODO: should possibly lock the history file...
3508
benchfile = open(".perf_history", "at", buffering=1)
3510
test_suite_factory = None
3513
selftest_kwargs = {"verbose": verbose,
3515
"stop_on_failure": one,
3516
"transport": transport,
3517
"test_suite_factory": test_suite_factory,
3518
"lsprof_timed": lsprof_timed,
3519
"lsprof_tests": lsprof_tests,
3520
"bench_history": benchfile,
3521
"matching_tests_first": first,
3522
"list_only": list_only,
3523
"random_seed": randomize,
3524
"exclude_pattern": exclude,
3526
"load_list": load_list,
3527
"debug_flags": debugflag,
3528
"starting_with": starting_with
3530
selftest_kwargs.update(self.additional_selftest_args)
3531
result = selftest(**selftest_kwargs)
3533
if benchfile is not None:
3535
return int(not result)
3538
class cmd_version(Command):
3539
"""Show version of bzr."""
3541
encoding_type = 'replace'
3543
Option("short", help="Print just the version number."),
3547
def run(self, short=False):
3548
from bzrlib.version import show_version
3550
self.outf.write(bzrlib.version_string + '\n')
3552
show_version(to_file=self.outf)
3555
class cmd_rocks(Command):
3556
"""Statement of optimism."""
3562
print "It sure does!"
3565
class cmd_find_merge_base(Command):
3566
"""Find and print a base revision for merging two branches."""
3567
# TODO: Options to specify revisions on either side, as if
3568
# merging only part of the history.
3569
takes_args = ['branch', 'other']
3573
def run(self, branch, other):
3574
from bzrlib.revision import ensure_null
3576
branch1 = Branch.open_containing(branch)[0]
3577
branch2 = Branch.open_containing(other)[0]
3582
last1 = ensure_null(branch1.last_revision())
3583
last2 = ensure_null(branch2.last_revision())
3585
graph = branch1.repository.get_graph(branch2.repository)
3586
base_rev_id = graph.find_unique_lca(last1, last2)
3588
print 'merge base is revision %s' % base_rev_id
3595
class cmd_merge(Command):
3596
"""Perform a three-way merge.
3598
The source of the merge can be specified either in the form of a branch,
3599
or in the form of a path to a file containing a merge directive generated
3600
with bzr send. If neither is specified, the default is the upstream branch
3601
or the branch most recently merged using --remember.
3603
When merging a branch, by default the tip will be merged. To pick a different
3604
revision, pass --revision. If you specify two values, the first will be used as
3605
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3606
available revisions, like this is commonly referred to as "cherrypicking".
3608
Revision numbers are always relative to the branch being merged.
3610
By default, bzr will try to merge in all new work from the other
3611
branch, automatically determining an appropriate base. If this
3612
fails, you may need to give an explicit base.
3614
Merge will do its best to combine the changes in two branches, but there
3615
are some kinds of problems only a human can fix. When it encounters those,
3616
it will mark a conflict. A conflict means that you need to fix something,
3617
before you should commit.
3619
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3621
If there is no default branch set, the first merge will set it. After
3622
that, you can omit the branch to use the default. To change the
3623
default, use --remember. The value will only be saved if the remote
3624
location can be accessed.
3626
The results of the merge are placed into the destination working
3627
directory, where they can be reviewed (with bzr diff), tested, and then
3628
committed to record the result of the merge.
3630
merge refuses to run if there are any uncommitted changes, unless
3633
To select only some changes to merge, use "merge -i", which will prompt
3634
you to apply each diff hunk and file change, similar to "shelve".
3637
To merge the latest revision from bzr.dev::
3639
bzr merge ../bzr.dev
3641
To merge changes up to and including revision 82 from bzr.dev::
3643
bzr merge -r 82 ../bzr.dev
3645
To merge the changes introduced by 82, without previous changes::
3647
bzr merge -r 81..82 ../bzr.dev
3649
To apply a merge directive contained in /tmp/merge::
3651
bzr merge /tmp/merge
3654
encoding_type = 'exact'
3655
_see_also = ['update', 'remerge', 'status-flags', 'send']
3656
takes_args = ['location?']
3661
help='Merge even if the destination tree has uncommitted changes.'),
3665
Option('show-base', help="Show base revision text in "
3667
Option('uncommitted', help='Apply uncommitted changes'
3668
' from a working copy, instead of branch changes.'),
3669
Option('pull', help='If the destination is already'
3670
' completely merged into the source, pull from the'
3671
' source rather than merging. When this happens,'
3672
' you do not need to commit the result.'),
3674
help='Branch to merge into, '
3675
'rather than the one containing the working directory.',
3679
Option('preview', help='Instead of merging, show a diff of the'
3681
Option('interactive', help='Select changes interactively.',
3685
def run(self, location=None, revision=None, force=False,
3686
merge_type=None, show_base=False, reprocess=None, remember=False,
3687
uncommitted=False, pull=False,
3692
if merge_type is None:
3693
merge_type = _mod_merge.Merge3Merger
3695
if directory is None: directory = u'.'
3696
possible_transports = []
3698
allow_pending = True
3699
verified = 'inapplicable'
3700
tree = WorkingTree.open_containing(directory)[0]
3703
basis_tree = tree.revision_tree(tree.last_revision())
3704
except errors.NoSuchRevision:
3705
basis_tree = tree.basis_tree()
3707
# die as quickly as possible if there are uncommitted changes
3709
if tree.has_changes():
3710
raise errors.UncommittedChanges(tree)
3712
view_info = _get_view_info_for_change_reporter(tree)
3713
change_reporter = delta._ChangeReporter(
3714
unversioned_filter=tree.is_ignored, view_info=view_info)
3717
pb = ui.ui_factory.nested_progress_bar()
3718
cleanups.append(pb.finished)
3720
cleanups.append(tree.unlock)
3721
if location is not None:
3723
mergeable = bundle.read_mergeable_from_url(location,
3724
possible_transports=possible_transports)
3725
except errors.NotABundle:
3729
raise errors.BzrCommandError('Cannot use --uncommitted'
3730
' with bundles or merge directives.')
3732
if revision is not None:
3733
raise errors.BzrCommandError(
3734
'Cannot use -r with merge directives or bundles')
3735
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3738
if merger is None and uncommitted:
3739
if revision is not None and len(revision) > 0:
3740
raise errors.BzrCommandError('Cannot use --uncommitted and'
3741
' --revision at the same time.')
3742
merger = self.get_merger_from_uncommitted(tree, location, pb,
3744
allow_pending = False
3747
merger, allow_pending = self._get_merger_from_branch(tree,
3748
location, revision, remember, possible_transports, pb)
3750
merger.merge_type = merge_type
3751
merger.reprocess = reprocess
3752
merger.show_base = show_base
3753
self.sanity_check_merger(merger)
3754
if (merger.base_rev_id == merger.other_rev_id and
3755
merger.other_rev_id is not None):
3756
note('Nothing to do.')
3759
if merger.interesting_files is not None:
3760
raise errors.BzrCommandError('Cannot pull individual files')
3761
if (merger.base_rev_id == tree.last_revision()):
3762
result = tree.pull(merger.other_branch, False,
3763
merger.other_rev_id)
3764
result.report(self.outf)
3766
if merger.this_basis is None:
3767
raise errors.BzrCommandError(
3768
"This branch has no commits."
3769
" (perhaps you would prefer 'bzr pull')")
3771
return self._do_preview(merger, cleanups)
3773
return self._do_interactive(merger, cleanups)
3775
return self._do_merge(merger, change_reporter, allow_pending,
3778
for cleanup in reversed(cleanups):
3781
def _get_preview(self, merger, cleanups):
3782
tree_merger = merger.make_merger()
3783
tt = tree_merger.make_preview_transform()
3784
cleanups.append(tt.finalize)
3785
result_tree = tt.get_preview_tree()
3788
def _do_preview(self, merger, cleanups):
3789
from bzrlib.diff import show_diff_trees
3790
result_tree = self._get_preview(merger, cleanups)
3791
show_diff_trees(merger.this_tree, result_tree, self.outf,
3792
old_label='', new_label='')
3794
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3795
merger.change_reporter = change_reporter
3796
conflict_count = merger.do_merge()
3798
merger.set_pending()
3799
if verified == 'failed':
3800
warning('Preview patch does not match changes')
3801
if conflict_count != 0:
3806
def _do_interactive(self, merger, cleanups):
3807
"""Perform an interactive merge.
3809
This works by generating a preview tree of the merge, then using
3810
Shelver to selectively remove the differences between the working tree
3811
and the preview tree.
3813
from bzrlib import shelf_ui
3814
result_tree = self._get_preview(merger, cleanups)
3815
writer = bzrlib.option.diff_writer_registry.get()
3816
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3817
reporter=shelf_ui.ApplyReporter(),
3818
diff_writer=writer(sys.stdout))
3821
def sanity_check_merger(self, merger):
3822
if (merger.show_base and
3823
not merger.merge_type is _mod_merge.Merge3Merger):
3824
raise errors.BzrCommandError("Show-base is not supported for this"
3825
" merge type. %s" % merger.merge_type)
3826
if merger.reprocess is None:
3827
if merger.show_base:
3828
merger.reprocess = False
3830
# Use reprocess if the merger supports it
3831
merger.reprocess = merger.merge_type.supports_reprocess
3832
if merger.reprocess and not merger.merge_type.supports_reprocess:
3833
raise errors.BzrCommandError("Conflict reduction is not supported"
3834
" for merge type %s." %
3836
if merger.reprocess and merger.show_base:
3837
raise errors.BzrCommandError("Cannot do conflict reduction and"
3840
def _get_merger_from_branch(self, tree, location, revision, remember,
3841
possible_transports, pb):
3842
"""Produce a merger from a location, assuming it refers to a branch."""
3843
from bzrlib.tag import _merge_tags_if_possible
3844
# find the branch locations
3845
other_loc, user_location = self._select_branch_location(tree, location,
3847
if revision is not None and len(revision) == 2:
3848
base_loc, _unused = self._select_branch_location(tree,
3849
location, revision, 0)
3851
base_loc = other_loc
3853
other_branch, other_path = Branch.open_containing(other_loc,
3854
possible_transports)
3855
if base_loc == other_loc:
3856
base_branch = other_branch
3858
base_branch, base_path = Branch.open_containing(base_loc,
3859
possible_transports)
3860
# Find the revision ids
3861
other_revision_id = None
3862
base_revision_id = None
3863
if revision is not None:
3864
if len(revision) >= 1:
3865
other_revision_id = revision[-1].as_revision_id(other_branch)
3866
if len(revision) == 2:
3867
base_revision_id = revision[0].as_revision_id(base_branch)
3868
if other_revision_id is None:
3869
other_revision_id = _mod_revision.ensure_null(
3870
other_branch.last_revision())
3871
# Remember where we merge from
3872
if ((remember or tree.branch.get_submit_branch() is None) and
3873
user_location is not None):
3874
tree.branch.set_submit_branch(other_branch.base)
3875
_merge_tags_if_possible(other_branch, tree.branch)
3876
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3877
other_revision_id, base_revision_id, other_branch, base_branch)
3878
if other_path != '':
3879
allow_pending = False
3880
merger.interesting_files = [other_path]
3882
allow_pending = True
3883
return merger, allow_pending
3885
def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3886
"""Get a merger for uncommitted changes.
3888
:param tree: The tree the merger should apply to.
3889
:param location: The location containing uncommitted changes.
3890
:param pb: The progress bar to use for showing progress.
3891
:param cleanups: A list of operations to perform to clean up the
3892
temporary directories, unfinalized objects, etc.
3894
location = self._select_branch_location(tree, location)[0]
3895
other_tree, other_path = WorkingTree.open_containing(location)
3896
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3897
if other_path != '':
3898
merger.interesting_files = [other_path]
3901
def _select_branch_location(self, tree, user_location, revision=None,
3903
"""Select a branch location, according to possible inputs.
3905
If provided, branches from ``revision`` are preferred. (Both
3906
``revision`` and ``index`` must be supplied.)
3908
Otherwise, the ``location`` parameter is used. If it is None, then the
3909
``submit`` or ``parent`` location is used, and a note is printed.
3911
:param tree: The working tree to select a branch for merging into
3912
:param location: The location entered by the user
3913
:param revision: The revision parameter to the command
3914
:param index: The index to use for the revision parameter. Negative
3915
indices are permitted.
3916
:return: (selected_location, user_location). The default location
3917
will be the user-entered location.
3919
if (revision is not None and index is not None
3920
and revision[index] is not None):
3921
branch = revision[index].get_branch()
3922
if branch is not None:
3923
return branch, branch
3924
if user_location is None:
3925
location = self._get_remembered(tree, 'Merging from')
3927
location = user_location
3928
return location, user_location
3930
def _get_remembered(self, tree, verb_string):
3931
"""Use tree.branch's parent if none was supplied.
3933
Report if the remembered location was used.
3935
stored_location = tree.branch.get_submit_branch()
3936
stored_location_type = "submit"
3937
if stored_location is None:
3938
stored_location = tree.branch.get_parent()
3939
stored_location_type = "parent"
3940
mutter("%s", stored_location)
3941
if stored_location is None:
3942
raise errors.BzrCommandError("No location specified or remembered")
3943
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3944
note(u"%s remembered %s location %s", verb_string,
3945
stored_location_type, display_url)
3946
return stored_location
3949
class cmd_remerge(Command):
3952
Use this if you want to try a different merge technique while resolving
3953
conflicts. Some merge techniques are better than others, and remerge
3954
lets you try different ones on different files.
3956
The options for remerge have the same meaning and defaults as the ones for
3957
merge. The difference is that remerge can (only) be run when there is a
3958
pending merge, and it lets you specify particular files.
3961
Re-do the merge of all conflicted files, and show the base text in
3962
conflict regions, in addition to the usual THIS and OTHER texts::
3964
bzr remerge --show-base
3966
Re-do the merge of "foobar", using the weave merge algorithm, with
3967
additional processing to reduce the size of conflict regions::
3969
bzr remerge --merge-type weave --reprocess foobar
3971
takes_args = ['file*']
3976
help="Show base revision text in conflicts."),
3979
def run(self, file_list=None, merge_type=None, show_base=False,
3981
if merge_type is None:
3982
merge_type = _mod_merge.Merge3Merger
3983
tree, file_list = tree_files(file_list)
3986
parents = tree.get_parent_ids()
3987
if len(parents) != 2:
3988
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3989
" merges. Not cherrypicking or"
3991
repository = tree.branch.repository
3992
interesting_ids = None
3994
conflicts = tree.conflicts()
3995
if file_list is not None:
3996
interesting_ids = set()
3997
for filename in file_list:
3998
file_id = tree.path2id(filename)
4000
raise errors.NotVersionedError(filename)
4001
interesting_ids.add(file_id)
4002
if tree.kind(file_id) != "directory":
4005
for name, ie in tree.inventory.iter_entries(file_id):
4006
interesting_ids.add(ie.file_id)
4007
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4009
# Remerge only supports resolving contents conflicts
4010
allowed_conflicts = ('text conflict', 'contents conflict')
4011
restore_files = [c.path for c in conflicts
4012
if c.typestring in allowed_conflicts]
4013
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4014
tree.set_conflicts(ConflictList(new_conflicts))
4015
if file_list is not None:
4016
restore_files = file_list
4017
for filename in restore_files:
4019
restore(tree.abspath(filename))
4020
except errors.NotConflicted:
4022
# Disable pending merges, because the file texts we are remerging
4023
# have not had those merges performed. If we use the wrong parents
4024
# list, we imply that the working tree text has seen and rejected
4025
# all the changes from the other tree, when in fact those changes
4026
# have not yet been seen.
4027
pb = ui.ui_factory.nested_progress_bar()
4028
tree.set_parent_ids(parents[:1])
4030
merger = _mod_merge.Merger.from_revision_ids(pb,
4032
merger.interesting_ids = interesting_ids
4033
merger.merge_type = merge_type
4034
merger.show_base = show_base
4035
merger.reprocess = reprocess
4036
conflicts = merger.do_merge()
4038
tree.set_parent_ids(parents)
4048
class cmd_revert(Command):
4049
"""Revert files to a previous revision.
4051
Giving a list of files will revert only those files. Otherwise, all files
4052
will be reverted. If the revision is not specified with '--revision', the
4053
last committed revision is used.
4055
To remove only some changes, without reverting to a prior version, use
4056
merge instead. For example, "merge . --revision -2..-3" will remove the
4057
changes introduced by -2, without affecting the changes introduced by -1.
4058
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4060
By default, any files that have been manually changed will be backed up
4061
first. (Files changed only by merge are not backed up.) Backup files have
4062
'.~#~' appended to their name, where # is a number.
4064
When you provide files, you can use their current pathname or the pathname
4065
from the target revision. So you can use revert to "undelete" a file by
4066
name. If you name a directory, all the contents of that directory will be
4069
If you have newly added files since the target revision, they will be
4070
removed. If the files to be removed have been changed, backups will be
4071
created as above. Directories containing unknown files will not be
4074
The working tree contains a list of pending merged revisions, which will
4075
be included as parents in the next commit. Normally, revert clears that
4076
list as well as reverting the files. If any files are specified, revert
4077
leaves the pending merge list alone and reverts only the files. Use "bzr
4078
revert ." in the tree root to revert all files but keep the merge record,
4079
and "bzr revert --forget-merges" to clear the pending merge list without
4080
reverting any files.
4083
_see_also = ['cat', 'export']
4086
Option('no-backup', "Do not save backups of reverted files."),
4087
Option('forget-merges',
4088
'Remove pending merge marker, without changing any files.'),
4090
takes_args = ['file*']
4092
def run(self, revision=None, no_backup=False, file_list=None,
4093
forget_merges=None):
4094
tree, file_list = tree_files(file_list)
4098
tree.set_parent_ids(tree.get_parent_ids()[:1])
4100
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4105
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4106
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4107
pb = ui.ui_factory.nested_progress_bar()
4109
tree.revert(file_list, rev_tree, not no_backup, pb,
4110
report_changes=True)
4115
class cmd_assert_fail(Command):
4116
"""Test reporting of assertion failures"""
4117
# intended just for use in testing
4122
raise AssertionError("always fails")
4125
class cmd_help(Command):
4126
"""Show help on a command or other topic.
4129
_see_also = ['topics']
4131
Option('long', 'Show help on all commands.'),
4133
takes_args = ['topic?']
4134
aliases = ['?', '--help', '-?', '-h']
4137
def run(self, topic=None, long=False):
4139
if topic is None and long:
4141
bzrlib.help.help(topic)
4144
class cmd_shell_complete(Command):
4145
"""Show appropriate completions for context.
4147
For a list of all available commands, say 'bzr shell-complete'.
4149
takes_args = ['context?']
4154
def run(self, context=None):
4155
import shellcomplete
4156
shellcomplete.shellcomplete(context)
4159
class cmd_missing(Command):
4160
"""Show unmerged/unpulled revisions between two branches.
4162
OTHER_BRANCH may be local or remote.
4164
To filter on a range of revisions, you can use the command -r begin..end
4165
-r revision requests a specific revision, -r ..end or -r begin.. are
4170
Determine the missing revisions between this and the branch at the
4171
remembered pull location::
4175
Determine the missing revisions between this and another branch::
4177
bzr missing http://server/branch
4179
Determine the missing revisions up to a specific revision on the other
4182
bzr missing -r ..-10
4184
Determine the missing revisions up to a specific revision on this
4187
bzr missing --my-revision ..-10
4190
_see_also = ['merge', 'pull']
4191
takes_args = ['other_branch?']
4193
Option('reverse', 'Reverse the order of revisions.'),
4195
'Display changes in the local branch only.'),
4196
Option('this' , 'Same as --mine-only.'),
4197
Option('theirs-only',
4198
'Display changes in the remote branch only.'),
4199
Option('other', 'Same as --theirs-only.'),
4203
custom_help('revision',
4204
help='Filter on other branch revisions (inclusive). '
4205
'See "help revisionspec" for details.'),
4206
Option('my-revision',
4207
type=_parse_revision_str,
4208
help='Filter on local branch revisions (inclusive). '
4209
'See "help revisionspec" for details.'),
4210
Option('include-merges',
4211
'Show all revisions in addition to the mainline ones.'),
4213
encoding_type = 'replace'
4216
def run(self, other_branch=None, reverse=False, mine_only=False,
4218
log_format=None, long=False, short=False, line=False,
4219
show_ids=False, verbose=False, this=False, other=False,
4220
include_merges=False, revision=None, my_revision=None):
4221
from bzrlib.missing import find_unmerged, iter_log_revisions
4230
# TODO: We should probably check that we don't have mine-only and
4231
# theirs-only set, but it gets complicated because we also have
4232
# this and other which could be used.
4239
local_branch = Branch.open_containing(u".")[0]
4240
parent = local_branch.get_parent()
4241
if other_branch is None:
4242
other_branch = parent
4243
if other_branch is None:
4244
raise errors.BzrCommandError("No peer location known"
4246
display_url = urlutils.unescape_for_display(parent,
4248
message("Using saved parent location: "
4249
+ display_url + "\n")
4251
remote_branch = Branch.open(other_branch)
4252
if remote_branch.base == local_branch.base:
4253
remote_branch = local_branch
4255
local_revid_range = _revision_range_to_revid_range(
4256
_get_revision_range(my_revision, local_branch,
4259
remote_revid_range = _revision_range_to_revid_range(
4260
_get_revision_range(revision,
4261
remote_branch, self.name()))
4263
local_branch.lock_read()
4265
remote_branch.lock_read()
4267
local_extra, remote_extra = find_unmerged(
4268
local_branch, remote_branch, restrict,
4269
backward=not reverse,
4270
include_merges=include_merges,
4271
local_revid_range=local_revid_range,
4272
remote_revid_range=remote_revid_range)
4274
if log_format is None:
4275
registry = log.log_formatter_registry
4276
log_format = registry.get_default(local_branch)
4277
lf = log_format(to_file=self.outf,
4279
show_timezone='original')
4282
if local_extra and not theirs_only:
4283
message("You have %d extra revision(s):\n" %
4285
for revision in iter_log_revisions(local_extra,
4286
local_branch.repository,
4288
lf.log_revision(revision)
4289
printed_local = True
4292
printed_local = False
4294
if remote_extra and not mine_only:
4295
if printed_local is True:
4297
message("You are missing %d revision(s):\n" %
4299
for revision in iter_log_revisions(remote_extra,
4300
remote_branch.repository,
4302
lf.log_revision(revision)
4305
if mine_only and not local_extra:
4306
# We checked local, and found nothing extra
4307
message('This branch is up to date.\n')
4308
elif theirs_only and not remote_extra:
4309
# We checked remote, and found nothing extra
4310
message('Other branch is up to date.\n')
4311
elif not (mine_only or theirs_only or local_extra or
4313
# We checked both branches, and neither one had extra
4315
message("Branches are up to date.\n")
4317
remote_branch.unlock()
4319
local_branch.unlock()
4320
if not status_code and parent is None and other_branch is not None:
4321
local_branch.lock_write()
4323
# handle race conditions - a parent might be set while we run.
4324
if local_branch.get_parent() is None:
4325
local_branch.set_parent(remote_branch.base)
4327
local_branch.unlock()
4331
class cmd_pack(Command):
4332
"""Compress the data within a repository."""
4334
_see_also = ['repositories']
4335
takes_args = ['branch_or_repo?']
4337
def run(self, branch_or_repo='.'):
4338
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4340
branch = dir.open_branch()
4341
repository = branch.repository
4342
except errors.NotBranchError:
4343
repository = dir.open_repository()
4347
class cmd_plugins(Command):
4348
"""List the installed plugins.
4350
This command displays the list of installed plugins including
4351
version of plugin and a short description of each.
4353
--verbose shows the path where each plugin is located.
4355
A plugin is an external component for Bazaar that extends the
4356
revision control system, by adding or replacing code in Bazaar.
4357
Plugins can do a variety of things, including overriding commands,
4358
adding new commands, providing additional network transports and
4359
customizing log output.
4361
See the Bazaar web site, http://bazaar-vcs.org, for further
4362
information on plugins including where to find them and how to
4363
install them. Instructions are also provided there on how to
4364
write new plugins using the Python programming language.
4366
takes_options = ['verbose']
4369
def run(self, verbose=False):
4370
import bzrlib.plugin
4371
from inspect import getdoc
4373
for name, plugin in bzrlib.plugin.plugins().items():
4374
version = plugin.__version__
4375
if version == 'unknown':
4377
name_ver = '%s %s' % (name, version)
4378
d = getdoc(plugin.module)
4380
doc = d.split('\n')[0]
4382
doc = '(no description)'
4383
result.append((name_ver, doc, plugin.path()))
4384
for name_ver, doc, path in sorted(result):
4392
class cmd_testament(Command):
4393
"""Show testament (signing-form) of a revision."""
4396
Option('long', help='Produce long-format testament.'),
4398
help='Produce a strict-format testament.')]
4399
takes_args = ['branch?']
4401
def run(self, branch=u'.', revision=None, long=False, strict=False):
4402
from bzrlib.testament import Testament, StrictTestament
4404
testament_class = StrictTestament
4406
testament_class = Testament
4408
b = Branch.open_containing(branch)[0]
4410
b = Branch.open(branch)
4413
if revision is None:
4414
rev_id = b.last_revision()
4416
rev_id = revision[0].as_revision_id(b)
4417
t = testament_class.from_revision(b.repository, rev_id)
4419
sys.stdout.writelines(t.as_text_lines())
4421
sys.stdout.write(t.as_short_text())
4426
class cmd_annotate(Command):
4427
"""Show the origin of each line in a file.
4429
This prints out the given file with an annotation on the left side
4430
indicating which revision, author and date introduced the change.
4432
If the origin is the same for a run of consecutive lines, it is
4433
shown only at the top, unless the --all option is given.
4435
# TODO: annotate directories; showing when each file was last changed
4436
# TODO: if the working copy is modified, show annotations on that
4437
# with new uncommitted lines marked
4438
aliases = ['ann', 'blame', 'praise']
4439
takes_args = ['filename']
4440
takes_options = [Option('all', help='Show annotations on all lines.'),
4441
Option('long', help='Show commit date in annotations.'),
4445
encoding_type = 'exact'
4448
def run(self, filename, all=False, long=False, revision=None,
4450
from bzrlib.annotate import annotate_file, annotate_file_tree
4451
wt, branch, relpath = \
4452
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4458
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4460
file_id = wt.path2id(relpath)
4462
file_id = tree.path2id(relpath)
4464
raise errors.NotVersionedError(filename)
4465
file_version = tree.inventory[file_id].revision
4466
if wt is not None and revision is None:
4467
# If there is a tree and we're not annotating historical
4468
# versions, annotate the working tree's content.
4469
annotate_file_tree(wt, file_id, self.outf, long, all,
4472
annotate_file(branch, file_version, file_id, long, all, self.outf,
4481
class cmd_re_sign(Command):
4482
"""Create a digital signature for an existing revision."""
4483
# TODO be able to replace existing ones.
4485
hidden = True # is this right ?
4486
takes_args = ['revision_id*']
4487
takes_options = ['revision']
4489
def run(self, revision_id_list=None, revision=None):
4490
if revision_id_list is not None and revision is not None:
4491
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4492
if revision_id_list is None and revision is None:
4493
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4494
b = WorkingTree.open_containing(u'.')[0].branch
4497
return self._run(b, revision_id_list, revision)
4501
def _run(self, b, revision_id_list, revision):
4502
import bzrlib.gpg as gpg
4503
gpg_strategy = gpg.GPGStrategy(b.get_config())
4504
if revision_id_list is not None:
4505
b.repository.start_write_group()
4507
for revision_id in revision_id_list:
4508
b.repository.sign_revision(revision_id, gpg_strategy)
4510
b.repository.abort_write_group()
4513
b.repository.commit_write_group()
4514
elif revision is not None:
4515
if len(revision) == 1:
4516
revno, rev_id = revision[0].in_history(b)
4517
b.repository.start_write_group()
4519
b.repository.sign_revision(rev_id, gpg_strategy)
4521
b.repository.abort_write_group()
4524
b.repository.commit_write_group()
4525
elif len(revision) == 2:
4526
# are they both on rh- if so we can walk between them
4527
# might be nice to have a range helper for arbitrary
4528
# revision paths. hmm.
4529
from_revno, from_revid = revision[0].in_history(b)
4530
to_revno, to_revid = revision[1].in_history(b)
4531
if to_revid is None:
4532
to_revno = b.revno()
4533
if from_revno is None or to_revno is None:
4534
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4535
b.repository.start_write_group()
4537
for revno in range(from_revno, to_revno + 1):
4538
b.repository.sign_revision(b.get_rev_id(revno),
4541
b.repository.abort_write_group()
4544
b.repository.commit_write_group()
4546
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4549
class cmd_bind(Command):
4550
"""Convert the current branch into a checkout of the supplied branch.
4552
Once converted into a checkout, commits must succeed on the master branch
4553
before they will be applied to the local branch.
4555
Bound branches use the nickname of its master branch unless it is set
4556
locally, in which case binding will update the local nickname to be
4560
_see_also = ['checkouts', 'unbind']
4561
takes_args = ['location?']
4564
def run(self, location=None):
4565
b, relpath = Branch.open_containing(u'.')
4566
if location is None:
4568
location = b.get_old_bound_location()
4569
except errors.UpgradeRequired:
4570
raise errors.BzrCommandError('No location supplied. '
4571
'This format does not remember old locations.')
4573
if location is None:
4574
raise errors.BzrCommandError('No location supplied and no '
4575
'previous location known')
4576
b_other = Branch.open(location)
4579
except errors.DivergedBranches:
4580
raise errors.BzrCommandError('These branches have diverged.'
4581
' Try merging, and then bind again.')
4582
if b.get_config().has_explicit_nickname():
4583
b.nick = b_other.nick
4586
class cmd_unbind(Command):
4587
"""Convert the current checkout into a regular branch.
4589
After unbinding, the local branch is considered independent and subsequent
4590
commits will be local only.
4593
_see_also = ['checkouts', 'bind']
4598
b, relpath = Branch.open_containing(u'.')
4600
raise errors.BzrCommandError('Local branch is not bound')
4603
class cmd_uncommit(Command):
4604
"""Remove the last committed revision.
4606
--verbose will print out what is being removed.
4607
--dry-run will go through all the motions, but not actually
4610
If --revision is specified, uncommit revisions to leave the branch at the
4611
specified revision. For example, "bzr uncommit -r 15" will leave the
4612
branch at revision 15.
4614
Uncommit leaves the working tree ready for a new commit. The only change
4615
it may make is to restore any pending merges that were present before
4619
# TODO: jam 20060108 Add an option to allow uncommit to remove
4620
# unreferenced information in 'branch-as-repository' branches.
4621
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4622
# information in shared branches as well.
4623
_see_also = ['commit']
4624
takes_options = ['verbose', 'revision',
4625
Option('dry-run', help='Don\'t actually make changes.'),
4626
Option('force', help='Say yes to all questions.'),
4628
help="Only remove the commits from the local branch"
4629
" when in a checkout."
4632
takes_args = ['location?']
4634
encoding_type = 'replace'
4636
def run(self, location=None,
4637
dry_run=False, verbose=False,
4638
revision=None, force=False, local=False):
4639
if location is None:
4641
control, relpath = bzrdir.BzrDir.open_containing(location)
4643
tree = control.open_workingtree()
4645
except (errors.NoWorkingTree, errors.NotLocalUrl):
4647
b = control.open_branch()
4649
if tree is not None:
4654
return self._run(b, tree, dry_run, verbose, revision, force,
4657
if tree is not None:
4662
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4663
from bzrlib.log import log_formatter, show_log
4664
from bzrlib.uncommit import uncommit
4666
last_revno, last_rev_id = b.last_revision_info()
4669
if revision is None:
4671
rev_id = last_rev_id
4673
# 'bzr uncommit -r 10' actually means uncommit
4674
# so that the final tree is at revno 10.
4675
# but bzrlib.uncommit.uncommit() actually uncommits
4676
# the revisions that are supplied.
4677
# So we need to offset it by one
4678
revno = revision[0].in_history(b).revno + 1
4679
if revno <= last_revno:
4680
rev_id = b.get_rev_id(revno)
4682
if rev_id is None or _mod_revision.is_null(rev_id):
4683
self.outf.write('No revisions to uncommit.\n')
4686
lf = log_formatter('short',
4688
show_timezone='original')
4693
direction='forward',
4694
start_revision=revno,
4695
end_revision=last_revno)
4698
print 'Dry-run, pretending to remove the above revisions.'
4700
val = raw_input('Press <enter> to continue')
4702
print 'The above revision(s) will be removed.'
4704
val = raw_input('Are you sure [y/N]? ')
4705
if val.lower() not in ('y', 'yes'):
4709
mutter('Uncommitting from {%s} to {%s}',
4710
last_rev_id, rev_id)
4711
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4712
revno=revno, local=local)
4713
note('You can restore the old tip by running:\n'
4714
' bzr pull . -r revid:%s', last_rev_id)
4717
class cmd_break_lock(Command):
4718
"""Break a dead lock on a repository, branch or working directory.
4720
CAUTION: Locks should only be broken when you are sure that the process
4721
holding the lock has been stopped.
4723
You can get information on what locks are open via the 'bzr info' command.
4728
takes_args = ['location?']
4730
def run(self, location=None, show=False):
4731
if location is None:
4733
control, relpath = bzrdir.BzrDir.open_containing(location)
4735
control.break_lock()
4736
except NotImplementedError:
4740
class cmd_wait_until_signalled(Command):
4741
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4743
This just prints a line to signal when it is ready, then blocks on stdin.
4749
sys.stdout.write("running\n")
4751
sys.stdin.readline()
4754
class cmd_serve(Command):
4755
"""Run the bzr server."""
4757
aliases = ['server']
4761
help='Serve on stdin/out for use from inetd or sshd.'),
4762
RegistryOption('protocol',
4763
help="Protocol to serve.",
4764
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4765
value_switches=True),
4767
help='Listen for connections on nominated port of the form '
4768
'[hostname:]portnumber. Passing 0 as the port number will '
4769
'result in a dynamically allocated port. The default port '
4770
'depends on the protocol.',
4773
help='Serve contents of this directory.',
4775
Option('allow-writes',
4776
help='By default the server is a readonly server. Supplying '
4777
'--allow-writes enables write access to the contents of '
4778
'the served directory and below. Note that ``bzr serve`` '
4779
'does not perform authentication, so unless some form of '
4780
'external authentication is arranged supplying this '
4781
'option leads to global uncontrolled write access to your '
4786
def get_host_and_port(self, port):
4787
"""Return the host and port to run the smart server on.
4789
If 'port' is None, None will be returned for the host and port.
4791
If 'port' has a colon in it, the string before the colon will be
4792
interpreted as the host.
4794
:param port: A string of the port to run the server on.
4795
:return: A tuple of (host, port), where 'host' is a host name or IP,
4796
and port is an integer TCP/IP port.
4799
if port is not None:
4801
host, port = port.split(':')
4805
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4807
from bzrlib.transport import get_transport, transport_server_registry
4808
if directory is None:
4809
directory = os.getcwd()
4810
if protocol is None:
4811
protocol = transport_server_registry.get()
4812
host, port = self.get_host_and_port(port)
4813
url = urlutils.local_path_to_url(directory)
4814
if not allow_writes:
4815
url = 'readonly+' + url
4816
transport = get_transport(url)
4817
protocol(transport, host, port, inet)
4820
class cmd_join(Command):
4821
"""Combine a tree into its containing tree.
4823
This command requires the target tree to be in a rich-root format.
4825
The TREE argument should be an independent tree, inside another tree, but
4826
not part of it. (Such trees can be produced by "bzr split", but also by
4827
running "bzr branch" with the target inside a tree.)
4829
The result is a combined tree, with the subtree no longer an independant
4830
part. This is marked as a merge of the subtree into the containing tree,
4831
and all history is preserved.
4834
_see_also = ['split']
4835
takes_args = ['tree']
4837
Option('reference', help='Join by reference.', hidden=True),
4840
def run(self, tree, reference=False):
4841
sub_tree = WorkingTree.open(tree)
4842
parent_dir = osutils.dirname(sub_tree.basedir)
4843
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4844
repo = containing_tree.branch.repository
4845
if not repo.supports_rich_root():
4846
raise errors.BzrCommandError(
4847
"Can't join trees because %s doesn't support rich root data.\n"
4848
"You can use bzr upgrade on the repository."
4852
containing_tree.add_reference(sub_tree)
4853
except errors.BadReferenceTarget, e:
4854
# XXX: Would be better to just raise a nicely printable
4855
# exception from the real origin. Also below. mbp 20070306
4856
raise errors.BzrCommandError("Cannot join %s. %s" %
4860
containing_tree.subsume(sub_tree)
4861
except errors.BadSubsumeSource, e:
4862
raise errors.BzrCommandError("Cannot join %s. %s" %
4866
class cmd_split(Command):
4867
"""Split a subdirectory of a tree into a separate tree.
4869
This command will produce a target tree in a format that supports
4870
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4871
converted into earlier formats like 'dirstate-tags'.
4873
The TREE argument should be a subdirectory of a working tree. That
4874
subdirectory will be converted into an independent tree, with its own
4875
branch. Commits in the top-level tree will not apply to the new subtree.
4878
_see_also = ['join']
4879
takes_args = ['tree']
4881
def run(self, tree):
4882
containing_tree, subdir = WorkingTree.open_containing(tree)
4883
sub_id = containing_tree.path2id(subdir)
4885
raise errors.NotVersionedError(subdir)
4887
containing_tree.extract(sub_id)
4888
except errors.RootNotRich:
4889
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4892
class cmd_merge_directive(Command):
4893
"""Generate a merge directive for auto-merge tools.
4895
A directive requests a merge to be performed, and also provides all the
4896
information necessary to do so. This means it must either include a
4897
revision bundle, or the location of a branch containing the desired
4900
A submit branch (the location to merge into) must be supplied the first
4901
time the command is issued. After it has been supplied once, it will
4902
be remembered as the default.
4904
A public branch is optional if a revision bundle is supplied, but required
4905
if --diff or --plain is specified. It will be remembered as the default
4906
after the first use.
4909
takes_args = ['submit_branch?', 'public_branch?']
4913
_see_also = ['send']
4916
RegistryOption.from_kwargs('patch-type',
4917
'The type of patch to include in the directive.',
4919
value_switches=True,
4921
bundle='Bazaar revision bundle (default).',
4922
diff='Normal unified diff.',
4923
plain='No patch, just directive.'),
4924
Option('sign', help='GPG-sign the directive.'), 'revision',
4925
Option('mail-to', type=str,
4926
help='Instead of printing the directive, email to this address.'),
4927
Option('message', type=str, short_name='m',
4928
help='Message to use when committing this merge.')
4931
encoding_type = 'exact'
4933
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4934
sign=False, revision=None, mail_to=None, message=None):
4935
from bzrlib.revision import ensure_null, NULL_REVISION
4936
include_patch, include_bundle = {
4937
'plain': (False, False),
4938
'diff': (True, False),
4939
'bundle': (True, True),
4941
branch = Branch.open('.')
4942
stored_submit_branch = branch.get_submit_branch()
4943
if submit_branch is None:
4944
submit_branch = stored_submit_branch
4946
if stored_submit_branch is None:
4947
branch.set_submit_branch(submit_branch)
4948
if submit_branch is None:
4949
submit_branch = branch.get_parent()
4950
if submit_branch is None:
4951
raise errors.BzrCommandError('No submit branch specified or known')
4953
stored_public_branch = branch.get_public_branch()
4954
if public_branch is None:
4955
public_branch = stored_public_branch
4956
elif stored_public_branch is None:
4957
branch.set_public_branch(public_branch)
4958
if not include_bundle and public_branch is None:
4959
raise errors.BzrCommandError('No public branch specified or'
4961
base_revision_id = None
4962
if revision is not None:
4963
if len(revision) > 2:
4964
raise errors.BzrCommandError('bzr merge-directive takes '
4965
'at most two one revision identifiers')
4966
revision_id = revision[-1].as_revision_id(branch)
4967
if len(revision) == 2:
4968
base_revision_id = revision[0].as_revision_id(branch)
4970
revision_id = branch.last_revision()
4971
revision_id = ensure_null(revision_id)
4972
if revision_id == NULL_REVISION:
4973
raise errors.BzrCommandError('No revisions to bundle.')
4974
directive = merge_directive.MergeDirective2.from_objects(
4975
branch.repository, revision_id, time.time(),
4976
osutils.local_time_offset(), submit_branch,
4977
public_branch=public_branch, include_patch=include_patch,
4978
include_bundle=include_bundle, message=message,
4979
base_revision_id=base_revision_id)
4982
self.outf.write(directive.to_signed(branch))
4984
self.outf.writelines(directive.to_lines())
4986
message = directive.to_email(mail_to, branch, sign)
4987
s = SMTPConnection(branch.get_config())
4988
s.send_email(message)
4991
class cmd_send(Command):
4992
"""Mail or create a merge-directive for submitting changes.
4994
A merge directive provides many things needed for requesting merges:
4996
* A machine-readable description of the merge to perform
4998
* An optional patch that is a preview of the changes requested
5000
* An optional bundle of revision data, so that the changes can be applied
5001
directly from the merge directive, without retrieving data from a
5004
If --no-bundle is specified, then public_branch is needed (and must be
5005
up-to-date), so that the receiver can perform the merge using the
5006
public_branch. The public_branch is always included if known, so that
5007
people can check it later.
5009
The submit branch defaults to the parent, but can be overridden. Both
5010
submit branch and public branch will be remembered if supplied.
5012
If a public_branch is known for the submit_branch, that public submit
5013
branch is used in the merge instructions. This means that a local mirror
5014
can be used as your actual submit branch, once you have set public_branch
5017
Mail is sent using your preferred mail program. This should be transparent
5018
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5019
If the preferred client can't be found (or used), your editor will be used.
5021
To use a specific mail program, set the mail_client configuration option.
5022
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5023
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5024
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5025
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5028
If mail is being sent, a to address is required. This can be supplied
5029
either on the commandline, by setting the submit_to configuration
5030
option in the branch itself or the child_submit_to configuration option
5031
in the submit branch.
5033
Two formats are currently supported: "4" uses revision bundle format 4 and
5034
merge directive format 2. It is significantly faster and smaller than
5035
older formats. It is compatible with Bazaar 0.19 and later. It is the
5036
default. "0.9" uses revision bundle format 0.9 and merge directive
5037
format 1. It is compatible with Bazaar 0.12 - 0.18.
5039
The merge directives created by bzr send may be applied using bzr merge or
5040
bzr pull by specifying a file containing a merge directive as the location.
5043
encoding_type = 'exact'
5045
_see_also = ['merge', 'pull']
5047
takes_args = ['submit_branch?', 'public_branch?']
5051
help='Do not include a bundle in the merge directive.'),
5052
Option('no-patch', help='Do not include a preview patch in the merge'
5055
help='Remember submit and public branch.'),
5057
help='Branch to generate the submission from, '
5058
'rather than the one containing the working directory.',
5061
Option('output', short_name='o',
5062
help='Write merge directive to this file; '
5063
'use - for stdout.',
5066
help='Refuse to send if there are uncommitted changes in'
5067
' the working tree, --no-strict disables the check.'),
5068
Option('mail-to', help='Mail the request to this address.',
5072
Option('body', help='Body for the email.', type=unicode),
5073
RegistryOption('format',
5074
help='Use the specified output format.',
5075
lazy_registry=('bzrlib.send', 'format_registry')),
5078
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5079
no_patch=False, revision=None, remember=False, output=None,
5080
format=None, mail_to=None, message=None, body=None,
5081
strict=None, **kwargs):
5082
from bzrlib.send import send
5083
return send(submit_branch, revision, public_branch, remember,
5084
format, no_bundle, no_patch, output,
5085
kwargs.get('from', '.'), mail_to, message, body,
5090
class cmd_bundle_revisions(cmd_send):
5091
"""Create a merge-directive for submitting changes.
5093
A merge directive provides many things needed for requesting merges:
5095
* A machine-readable description of the merge to perform
5097
* An optional patch that is a preview of the changes requested
5099
* An optional bundle of revision data, so that the changes can be applied
5100
directly from the merge directive, without retrieving data from a
5103
If --no-bundle is specified, then public_branch is needed (and must be
5104
up-to-date), so that the receiver can perform the merge using the
5105
public_branch. The public_branch is always included if known, so that
5106
people can check it later.
5108
The submit branch defaults to the parent, but can be overridden. Both
5109
submit branch and public branch will be remembered if supplied.
5111
If a public_branch is known for the submit_branch, that public submit
5112
branch is used in the merge instructions. This means that a local mirror
5113
can be used as your actual submit branch, once you have set public_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.
5125
help='Do not include a bundle in the merge directive.'),
5126
Option('no-patch', help='Do not include a preview patch in the merge'
5129
help='Remember submit and public branch.'),
5131
help='Branch to generate the submission from, '
5132
'rather than the one containing the working directory.',
5135
Option('output', short_name='o', help='Write directive to this file.',
5138
help='Refuse to bundle revisions if there are uncommitted'
5139
' changes in the working tree, --no-strict disables the check.'),
5141
RegistryOption('format',
5142
help='Use the specified output format.',
5143
lazy_registry=('bzrlib.send', 'format_registry')),
5145
aliases = ['bundle']
5147
_see_also = ['send', 'merge']
5151
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5152
no_patch=False, revision=None, remember=False, output=None,
5153
format=None, strict=None, **kwargs):
5156
from bzrlib.send import send
5157
return send(submit_branch, revision, public_branch, remember,
5158
format, no_bundle, no_patch, output,
5159
kwargs.get('from', '.'), None, None, None,
5160
self.outf, strict=strict)
5163
class cmd_tag(Command):
5164
"""Create, remove or modify a tag naming a revision.
5166
Tags give human-meaningful names to revisions. Commands that take a -r
5167
(--revision) option can be given -rtag:X, where X is any previously
5170
Tags are stored in the branch. Tags are copied from one branch to another
5171
along when you branch, push, pull or merge.
5173
It is an error to give a tag name that already exists unless you pass
5174
--force, in which case the tag is moved to point to the new revision.
5176
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5177
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5180
_see_also = ['commit', 'tags']
5181
takes_args = ['tag_name']
5184
help='Delete this tag rather than placing it.',
5187
help='Branch in which to place the tag.',
5192
help='Replace existing tags.',
5197
def run(self, tag_name,
5203
branch, relpath = Branch.open_containing(directory)
5207
branch.tags.delete_tag(tag_name)
5208
self.outf.write('Deleted tag %s.\n' % tag_name)
5211
if len(revision) != 1:
5212
raise errors.BzrCommandError(
5213
"Tags can only be placed on a single revision, "
5215
revision_id = revision[0].as_revision_id(branch)
5217
revision_id = branch.last_revision()
5218
if (not force) and branch.tags.has_tag(tag_name):
5219
raise errors.TagAlreadyExists(tag_name)
5220
branch.tags.set_tag(tag_name, revision_id)
5221
self.outf.write('Created tag %s.\n' % tag_name)
5226
class cmd_tags(Command):
5229
This command shows a table of tag names and the revisions they reference.
5235
help='Branch whose tags should be displayed.',
5239
RegistryOption.from_kwargs('sort',
5240
'Sort tags by different criteria.', title='Sorting',
5241
alpha='Sort tags lexicographically (default).',
5242
time='Sort tags chronologically.',
5255
branch, relpath = Branch.open_containing(directory)
5257
tags = branch.tags.get_tag_dict().items()
5264
graph = branch.repository.get_graph()
5265
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5266
revid1, revid2 = rev1.rev_id, rev2.rev_id
5267
# only show revisions between revid1 and revid2 (inclusive)
5268
tags = [(tag, revid) for tag, revid in tags if
5269
graph.is_between(revid, revid1, revid2)]
5272
elif sort == 'time':
5274
for tag, revid in tags:
5276
revobj = branch.repository.get_revision(revid)
5277
except errors.NoSuchRevision:
5278
timestamp = sys.maxint # place them at the end
5280
timestamp = revobj.timestamp
5281
timestamps[revid] = timestamp
5282
tags.sort(key=lambda x: timestamps[x[1]])
5284
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5285
for index, (tag, revid) in enumerate(tags):
5287
revno = branch.revision_id_to_dotted_revno(revid)
5288
if isinstance(revno, tuple):
5289
revno = '.'.join(map(str, revno))
5290
except errors.NoSuchRevision:
5291
# Bad tag data/merges can lead to tagged revisions
5292
# which are not in this branch. Fail gracefully ...
5294
tags[index] = (tag, revno)
5297
for tag, revspec in tags:
5298
self.outf.write('%-20s %s\n' % (tag, revspec))
5301
class cmd_reconfigure(Command):
5302
"""Reconfigure the type of a bzr directory.
5304
A target configuration must be specified.
5306
For checkouts, the bind-to location will be auto-detected if not specified.
5307
The order of preference is
5308
1. For a lightweight checkout, the current bound location.
5309
2. For branches that used to be checkouts, the previously-bound location.
5310
3. The push location.
5311
4. The parent location.
5312
If none of these is available, --bind-to must be specified.
5315
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5316
takes_args = ['location?']
5318
RegistryOption.from_kwargs(
5320
title='Target type',
5321
help='The type to reconfigure the directory to.',
5322
value_switches=True, enum_switch=False,
5323
branch='Reconfigure to be an unbound branch with no working tree.',
5324
tree='Reconfigure to be an unbound branch with a working tree.',
5325
checkout='Reconfigure to be a bound branch with a working tree.',
5326
lightweight_checkout='Reconfigure to be a lightweight'
5327
' checkout (with no local history).',
5328
standalone='Reconfigure to be a standalone branch '
5329
'(i.e. stop using shared repository).',
5330
use_shared='Reconfigure to use a shared repository.',
5331
with_trees='Reconfigure repository to create '
5332
'working trees on branches by default.',
5333
with_no_trees='Reconfigure repository to not create '
5334
'working trees on branches by default.'
5336
Option('bind-to', help='Branch to bind checkout to.', type=str),
5338
help='Perform reconfiguration even if local changes'
5340
Option('stacked-on',
5341
help='Reconfigure a branch to be stacked on another branch.',
5345
help='Reconfigure a branch to be unstacked. This '
5346
'may require copying substantial data into it.',
5350
def run(self, location=None, target_type=None, bind_to=None, force=False,
5353
directory = bzrdir.BzrDir.open(location)
5354
if stacked_on and unstacked:
5355
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5356
elif stacked_on is not None:
5357
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5359
reconfigure.ReconfigureUnstacked().apply(directory)
5360
# At the moment you can use --stacked-on and a different
5361
# reconfiguration shape at the same time; there seems no good reason
5363
if target_type is None:
5364
if stacked_on or unstacked:
5367
raise errors.BzrCommandError('No target configuration '
5369
elif target_type == 'branch':
5370
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5371
elif target_type == 'tree':
5372
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5373
elif target_type == 'checkout':
5374
reconfiguration = reconfigure.Reconfigure.to_checkout(
5376
elif target_type == 'lightweight-checkout':
5377
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5379
elif target_type == 'use-shared':
5380
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5381
elif target_type == 'standalone':
5382
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5383
elif target_type == 'with-trees':
5384
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5386
elif target_type == 'with-no-trees':
5387
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5389
reconfiguration.apply(force)
5392
class cmd_switch(Command):
5393
"""Set the branch of a checkout and update.
5395
For lightweight checkouts, this changes the branch being referenced.
5396
For heavyweight checkouts, this checks that there are no local commits
5397
versus the current bound branch, then it makes the local branch a mirror
5398
of the new location and binds to it.
5400
In both cases, the working tree is updated and uncommitted changes
5401
are merged. The user can commit or revert these as they desire.
5403
Pending merges need to be committed or reverted before using switch.
5405
The path to the branch to switch to can be specified relative to the parent
5406
directory of the current branch. For example, if you are currently in a
5407
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5410
Bound branches use the nickname of its master branch unless it is set
5411
locally, in which case switching will update the local nickname to be
5415
takes_args = ['to_location']
5416
takes_options = [Option('force',
5417
help='Switch even if local commits will be lost.'),
5418
Option('create-branch', short_name='b',
5419
help='Create the target branch from this one before'
5420
' switching to it.'),
5423
def run(self, to_location, force=False, create_branch=False):
5424
from bzrlib import switch
5426
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5428
branch = control_dir.open_branch()
5429
had_explicit_nick = branch.get_config().has_explicit_nickname()
5430
except errors.NotBranchError:
5432
had_explicit_nick = False
5435
raise errors.BzrCommandError('cannot create branch without'
5437
if '/' not in to_location and '\\' not in to_location:
5438
# This path is meant to be relative to the existing branch
5439
this_url = self._get_branch_location(control_dir)
5440
to_location = urlutils.join(this_url, '..', to_location)
5441
to_branch = branch.bzrdir.sprout(to_location,
5442
possible_transports=[branch.bzrdir.root_transport],
5443
source_branch=branch).open_branch()
5445
# from_branch = control_dir.open_branch()
5446
# except errors.NotBranchError:
5447
# raise BzrCommandError('Cannot create a branch from this'
5448
# ' location when we cannot open this branch')
5449
# from_branch.bzrdir.sprout(
5453
to_branch = Branch.open(to_location)
5454
except errors.NotBranchError:
5455
this_url = self._get_branch_location(control_dir)
5456
to_branch = Branch.open(
5457
urlutils.join(this_url, '..', to_location))
5458
switch.switch(control_dir, to_branch, force)
5459
if had_explicit_nick:
5460
branch = control_dir.open_branch() #get the new branch!
5461
branch.nick = to_branch.nick
5462
note('Switched to branch: %s',
5463
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5465
def _get_branch_location(self, control_dir):
5466
"""Return location of branch for this control dir."""
5468
this_branch = control_dir.open_branch()
5469
# This may be a heavy checkout, where we want the master branch
5470
master_location = this_branch.get_bound_location()
5471
if master_location is not None:
5472
return master_location
5473
# If not, use a local sibling
5474
return this_branch.base
5475
except errors.NotBranchError:
5476
format = control_dir.find_branch_format()
5477
if getattr(format, 'get_reference', None) is not None:
5478
return format.get_reference(control_dir)
5480
return control_dir.root_transport.base
5483
class cmd_view(Command):
5484
"""Manage filtered views.
5486
Views provide a mask over the tree so that users can focus on
5487
a subset of a tree when doing their work. After creating a view,
5488
commands that support a list of files - status, diff, commit, etc -
5489
effectively have that list of files implicitly given each time.
5490
An explicit list of files can still be given but those files
5491
must be within the current view.
5493
In most cases, a view has a short life-span: it is created to make
5494
a selected change and is deleted once that change is committed.
5495
At other times, you may wish to create one or more named views
5496
and switch between them.
5498
To disable the current view without deleting it, you can switch to
5499
the pseudo view called ``off``. This can be useful when you need
5500
to see the whole tree for an operation or two (e.g. merge) but
5501
want to switch back to your view after that.
5504
To define the current view::
5506
bzr view file1 dir1 ...
5508
To list the current view::
5512
To delete the current view::
5516
To disable the current view without deleting it::
5518
bzr view --switch off
5520
To define a named view and switch to it::
5522
bzr view --name view-name file1 dir1 ...
5524
To list a named view::
5526
bzr view --name view-name
5528
To delete a named view::
5530
bzr view --name view-name --delete
5532
To switch to a named view::
5534
bzr view --switch view-name
5536
To list all views defined::
5540
To delete all views::
5542
bzr view --delete --all
5546
takes_args = ['file*']
5549
help='Apply list or delete action to all views.',
5552
help='Delete the view.',
5555
help='Name of the view to define, list or delete.',
5559
help='Name of the view to switch to.',
5564
def run(self, file_list,
5570
tree, file_list = tree_files(file_list, apply_view=False)
5571
current_view, view_dict = tree.views.get_view_info()
5576
raise errors.BzrCommandError(
5577
"Both --delete and a file list specified")
5579
raise errors.BzrCommandError(
5580
"Both --delete and --switch specified")
5582
tree.views.set_view_info(None, {})
5583
self.outf.write("Deleted all views.\n")
5585
raise errors.BzrCommandError("No current view to delete")
5587
tree.views.delete_view(name)
5588
self.outf.write("Deleted '%s' view.\n" % name)
5591
raise errors.BzrCommandError(
5592
"Both --switch and a file list specified")
5594
raise errors.BzrCommandError(
5595
"Both --switch and --all specified")
5596
elif switch == 'off':
5597
if current_view is None:
5598
raise errors.BzrCommandError("No current view to disable")
5599
tree.views.set_view_info(None, view_dict)
5600
self.outf.write("Disabled '%s' view.\n" % (current_view))
5602
tree.views.set_view_info(switch, view_dict)
5603
view_str = views.view_display_str(tree.views.lookup_view())
5604
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5607
self.outf.write('Views defined:\n')
5608
for view in sorted(view_dict):
5609
if view == current_view:
5613
view_str = views.view_display_str(view_dict[view])
5614
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5616
self.outf.write('No views defined.\n')
5619
# No name given and no current view set
5622
raise errors.BzrCommandError(
5623
"Cannot change the 'off' pseudo view")
5624
tree.views.set_view(name, sorted(file_list))
5625
view_str = views.view_display_str(tree.views.lookup_view())
5626
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5630
# No name given and no current view set
5631
self.outf.write('No current view.\n')
5633
view_str = views.view_display_str(tree.views.lookup_view(name))
5634
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5637
class cmd_hooks(Command):
5643
for hook_key in sorted(hooks.known_hooks.keys()):
5644
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5645
self.outf.write("%s:\n" % type(some_hooks).__name__)
5646
for hook_name, hook_point in sorted(some_hooks.items()):
5647
self.outf.write(" %s:\n" % (hook_name,))
5648
found_hooks = list(hook_point)
5650
for hook in found_hooks:
5651
self.outf.write(" %s\n" %
5652
(some_hooks.get_hook_name(hook),))
5654
self.outf.write(" <no hooks installed>\n")
5657
class cmd_shelve(Command):
5658
"""Temporarily set aside some changes from the current tree.
5660
Shelve allows you to temporarily put changes you've made "on the shelf",
5661
ie. out of the way, until a later time when you can bring them back from
5662
the shelf with the 'unshelve' command. The changes are stored alongside
5663
your working tree, and so they aren't propagated along with your branch nor
5664
will they survive its deletion.
5666
If shelve --list is specified, previously-shelved changes are listed.
5668
Shelve is intended to help separate several sets of changes that have
5669
been inappropriately mingled. If you just want to get rid of all changes
5670
and you don't need to restore them later, use revert. If you want to
5671
shelve all text changes at once, use shelve --all.
5673
If filenames are specified, only the changes to those files will be
5674
shelved. Other files will be left untouched.
5676
If a revision is specified, changes since that revision will be shelved.
5678
You can put multiple items on the shelf, and by default, 'unshelve' will
5679
restore the most recently shelved changes.
5682
takes_args = ['file*']
5686
Option('all', help='Shelve all changes.'),
5688
RegistryOption('writer', 'Method to use for writing diffs.',
5689
bzrlib.option.diff_writer_registry,
5690
value_switches=True, enum_switch=False),
5692
Option('list', help='List shelved changes.'),
5694
help='Destroy removed changes instead of shelving them.'),
5696
_see_also = ['unshelve']
5698
def run(self, revision=None, all=False, file_list=None, message=None,
5699
writer=None, list=False, destroy=False):
5701
return self.run_for_list()
5702
from bzrlib.shelf_ui import Shelver
5704
writer = bzrlib.option.diff_writer_registry.get()
5706
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5707
file_list, message, destroy=destroy)
5712
except errors.UserAbort:
5715
def run_for_list(self):
5716
tree = WorkingTree.open_containing('.')[0]
5719
manager = tree.get_shelf_manager()
5720
shelves = manager.active_shelves()
5721
if len(shelves) == 0:
5722
note('No shelved changes.')
5724
for shelf_id in reversed(shelves):
5725
message = manager.get_metadata(shelf_id).get('message')
5727
message = '<no message>'
5728
self.outf.write('%3d: %s\n' % (shelf_id, message))
5734
class cmd_unshelve(Command):
5735
"""Restore shelved changes.
5737
By default, the most recently shelved changes are restored. However if you
5738
specify a shelf by id those changes will be restored instead. This works
5739
best when the changes don't depend on each other.
5742
takes_args = ['shelf_id?']
5744
RegistryOption.from_kwargs(
5745
'action', help="The action to perform.",
5746
enum_switch=False, value_switches=True,
5747
apply="Apply changes and remove from the shelf.",
5748
dry_run="Show changes, but do not apply or remove them.",
5749
delete_only="Delete changes without applying them."
5752
_see_also = ['shelve']
5754
def run(self, shelf_id=None, action='apply'):
5755
from bzrlib.shelf_ui import Unshelver
5756
unshelver = Unshelver.from_args(shelf_id, action)
5760
unshelver.tree.unlock()
5763
class cmd_clean_tree(Command):
5764
"""Remove unwanted files from working tree.
5766
By default, only unknown files, not ignored files, are deleted. Versioned
5767
files are never deleted.
5769
Another class is 'detritus', which includes files emitted by bzr during
5770
normal operations and selftests. (The value of these files decreases with
5773
If no options are specified, unknown files are deleted. Otherwise, option
5774
flags are respected, and may be combined.
5776
To check what clean-tree will do, use --dry-run.
5778
takes_options = [Option('ignored', help='Delete all ignored files.'),
5779
Option('detritus', help='Delete conflict files, merge'
5780
' backups, and failed selftest dirs.'),
5782
help='Delete files unknown to bzr (default).'),
5783
Option('dry-run', help='Show files to delete instead of'
5785
Option('force', help='Do not prompt before deleting.')]
5786
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5788
from bzrlib.clean_tree import clean_tree
5789
if not (unknown or ignored or detritus):
5793
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5794
dry_run=dry_run, no_prompt=force)
5797
class cmd_reference(Command):
5798
"""list, view and set branch locations for nested trees.
5800
If no arguments are provided, lists the branch locations for nested trees.
5801
If one argument is provided, display the branch location for that tree.
5802
If two arguments are provided, set the branch location for that tree.
5807
takes_args = ['path?', 'location?']
5809
def run(self, path=None, location=None):
5811
if path is not None:
5813
tree, branch, relpath =(
5814
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5815
if path is not None:
5818
tree = branch.basis_tree()
5820
info = branch._get_all_reference_info().iteritems()
5821
self._display_reference_info(tree, branch, info)
5823
file_id = tree.path2id(path)
5825
raise errors.NotVersionedError(path)
5826
if location is None:
5827
info = [(file_id, branch.get_reference_info(file_id))]
5828
self._display_reference_info(tree, branch, info)
5830
branch.set_reference_info(file_id, path, location)
5832
def _display_reference_info(self, tree, branch, info):
5834
for file_id, (path, location) in info:
5836
path = tree.id2path(file_id)
5837
except errors.NoSuchId:
5839
ref_list.append((path, location))
5840
for path, location in sorted(ref_list):
5841
self.outf.write('%s %s\n' % (path, location))
5844
# these get imported and then picked up by the scan for cmd_*
5845
# TODO: Some more consistent way to split command definitions across files;
5846
# we do need to load at least some information about them to know of
5847
# aliases. ideally we would avoid loading the implementation until the
5848
# details were needed.
5849
from bzrlib.cmd_version_info import cmd_version_info
5850
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5851
from bzrlib.bundle.commands import (
5854
from bzrlib.foreign import cmd_dpush
5855
from bzrlib.sign_my_commits import cmd_sign_my_commits
5856
from bzrlib.weave_commands import cmd_versionedfile_list, \
5857
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
