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,
54
from bzrlib.branch import Branch
55
from bzrlib.conflicts import ConflictList
56
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
57
from bzrlib.smtp_connection import SMTPConnection
58
from bzrlib.workingtree import WorkingTree
61
from bzrlib.commands import Command, display_command
62
from bzrlib.option import (
69
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
72
def tree_files(file_list, default_branch=u'.', canonicalize=True,
75
return internal_tree_files(file_list, default_branch, canonicalize,
77
except errors.FileInWrongBranch, e:
78
raise errors.BzrCommandError("%s is not in the same branch as %s" %
79
(e.path, file_list[0]))
82
def tree_files_for_add(file_list):
84
Return a tree and list of absolute paths from a file list.
86
Similar to tree_files, but add handles files a bit differently, so it a
87
custom implementation. In particular, MutableTreeTree.smart_add expects
88
absolute paths, which it immediately converts to relative paths.
90
# FIXME Would be nice to just return the relative paths like
91
# internal_tree_files does, but there are a large number of unit tests
92
# that assume the current interface to mutabletree.smart_add
94
tree, relpath = WorkingTree.open_containing(file_list[0])
95
if tree.supports_views():
96
view_files = tree.views.lookup_view()
98
for filename in file_list:
99
if not osutils.is_inside_any(view_files, filename):
100
raise errors.FileOutsideView(filename, view_files)
101
file_list = file_list[:]
102
file_list[0] = tree.abspath(relpath)
104
tree = WorkingTree.open_containing(u'.')[0]
105
if tree.supports_views():
106
view_files = tree.views.lookup_view()
108
file_list = view_files
109
view_str = views.view_display_str(view_files)
110
note("Ignoring files outside view. View is %s" % view_str)
111
return tree, file_list
114
def _get_one_revision(command_name, revisions):
115
if revisions is None:
117
if len(revisions) != 1:
118
raise errors.BzrCommandError(
119
'bzr %s --revision takes exactly one revision identifier' % (
124
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
125
"""Get a revision tree. Not suitable for commands that change the tree.
127
Specifically, the basis tree in dirstate trees is coupled to the dirstate
128
and doing a commit/uncommit/pull will at best fail due to changing the
131
If tree is passed in, it should be already locked, for lifetime management
132
of the trees internal cached state.
136
if revisions is None:
138
rev_tree = tree.basis_tree()
140
rev_tree = branch.basis_tree()
142
revision = _get_one_revision(command_name, revisions)
143
rev_tree = revision.as_tree(branch)
147
# XXX: Bad function name; should possibly also be a class method of
148
# WorkingTree rather than a function.
149
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
151
"""Convert command-line paths to a WorkingTree and relative paths.
153
This is typically used for command-line processors that take one or
154
more filenames, and infer the workingtree that contains them.
156
The filenames given are not required to exist.
158
:param file_list: Filenames to convert.
160
:param default_branch: Fallback tree path to use if file_list is empty or
163
:param apply_view: if True and a view is set, apply it or check that
164
specified files are within it
166
:return: workingtree, [relative_paths]
168
if file_list is None or len(file_list) == 0:
169
tree = WorkingTree.open_containing(default_branch)[0]
170
if tree.supports_views() and apply_view:
171
view_files = tree.views.lookup_view()
173
file_list = view_files
174
view_str = views.view_display_str(view_files)
175
note("Ignoring files outside view. View is %s" % view_str)
176
return tree, file_list
177
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
178
return tree, safe_relpath_files(tree, file_list, canonicalize,
179
apply_view=apply_view)
182
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
183
"""Convert file_list into a list of relpaths in tree.
185
:param tree: A tree to operate on.
186
:param file_list: A list of user provided paths or None.
187
:param apply_view: if True and a view is set, apply it or check that
188
specified files are within it
189
:return: A list of relative paths.
190
:raises errors.PathNotChild: When a provided path is in a different tree
193
if file_list is None:
195
if tree.supports_views() and apply_view:
196
view_files = tree.views.lookup_view()
200
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
201
# doesn't - fix that up here before we enter the loop.
203
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
206
for filename in file_list:
208
relpath = fixer(osutils.dereference_path(filename))
209
if view_files and not osutils.is_inside_any(view_files, relpath):
210
raise errors.FileOutsideView(filename, view_files)
211
new_list.append(relpath)
212
except errors.PathNotChild:
213
raise errors.FileInWrongBranch(tree.branch, filename)
217
def _get_view_info_for_change_reporter(tree):
218
"""Get the view information from a tree for change reporting."""
221
current_view = tree.views.get_view_info()[0]
222
if current_view is not None:
223
view_info = (current_view, tree.views.lookup_view())
224
except errors.ViewsNotSupported:
229
# TODO: Make sure no commands unconditionally use the working directory as a
230
# branch. If a filename argument is used, the first of them should be used to
231
# specify the branch. (Perhaps this can be factored out into some kind of
232
# Argument class, representing a file in a branch, where the first occurrence
235
class cmd_status(Command):
236
"""Display status summary.
238
This reports on versioned and unknown files, reporting them
239
grouped by state. Possible states are:
242
Versioned in the working copy but not in the previous revision.
245
Versioned in the previous revision but removed or deleted
249
Path of this file changed from the previous revision;
250
the text may also have changed. This includes files whose
251
parent directory was renamed.
254
Text has changed since the previous revision.
257
File kind has been changed (e.g. from file to directory).
260
Not versioned and not matching an ignore pattern.
262
Additionally for directories, symlinks and files with an executable
263
bit, Bazaar indicates their type using a trailing character: '/', '@'
266
To see ignored files use 'bzr ignored'. For details on the
267
changes to file texts, use 'bzr diff'.
269
Note that --short or -S gives status flags for each item, similar
270
to Subversion's status command. To get output similar to svn -q,
273
If no arguments are specified, the status of the entire working
274
directory is shown. Otherwise, only the status of the specified
275
files or directories is reported. If a directory is given, status
276
is reported for everything inside that directory.
278
Before merges are committed, the pending merge tip revisions are
279
shown. To see all pending merge revisions, use the -v option.
280
To skip the display of pending merge information altogether, use
281
the no-pending option or specify a file/directory.
283
If a revision argument is given, the status is calculated against
284
that revision, or between two revisions if two are provided.
287
# TODO: --no-recurse, --recurse options
289
takes_args = ['file*']
290
takes_options = ['show-ids', 'revision', 'change', 'verbose',
291
Option('short', help='Use short status indicators.',
293
Option('versioned', help='Only show versioned files.',
295
Option('no-pending', help='Don\'t show pending merges.',
298
aliases = ['st', 'stat']
300
encoding_type = 'replace'
301
_see_also = ['diff', 'revert', 'status-flags']
304
def run(self, show_ids=False, file_list=None, revision=None, short=False,
305
versioned=False, no_pending=False, verbose=False):
306
from bzrlib.status import show_tree_status
308
if revision and len(revision) > 2:
309
raise errors.BzrCommandError('bzr status --revision takes exactly'
310
' one or two revision specifiers')
312
tree, relfile_list = tree_files(file_list)
313
# Avoid asking for specific files when that is not needed.
314
if relfile_list == ['']:
316
# Don't disable pending merges for full trees other than '.'.
317
if file_list == ['.']:
319
# A specific path within a tree was given.
320
elif relfile_list is not None:
322
show_tree_status(tree, show_ids=show_ids,
323
specific_files=relfile_list, revision=revision,
324
to_file=self.outf, short=short, versioned=versioned,
325
show_pending=(not no_pending), verbose=verbose)
328
class cmd_cat_revision(Command):
329
"""Write out metadata for a revision.
331
The revision to print can either be specified by a specific
332
revision identifier, or you can use --revision.
336
takes_args = ['revision_id?']
337
takes_options = ['revision']
338
# cat-revision is more for frontends so should be exact
342
def run(self, revision_id=None, revision=None):
343
if revision_id is not None and revision is not None:
344
raise errors.BzrCommandError('You can only supply one of'
345
' revision_id or --revision')
346
if revision_id is None and revision is None:
347
raise errors.BzrCommandError('You must supply either'
348
' --revision or a revision_id')
349
b = WorkingTree.open_containing(u'.')[0].branch
351
# TODO: jam 20060112 should cat-revision always output utf-8?
352
if revision_id is not None:
353
revision_id = osutils.safe_revision_id(revision_id, warn=False)
355
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
356
except errors.NoSuchRevision:
357
msg = "The repository %s contains no revision %s." % (b.repository.base,
359
raise errors.BzrCommandError(msg)
360
elif revision is not None:
363
raise errors.BzrCommandError('You cannot specify a NULL'
365
rev_id = rev.as_revision_id(b)
366
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
369
class cmd_dump_btree(Command):
370
"""Dump the contents of a btree index file to stdout.
372
PATH is a btree index file, it can be any URL. This includes things like
373
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
375
By default, the tuples stored in the index file will be displayed. With
376
--raw, we will uncompress the pages, but otherwise display the raw bytes
380
# TODO: Do we want to dump the internal nodes as well?
381
# TODO: It would be nice to be able to dump the un-parsed information,
382
# rather than only going through iter_all_entries. However, this is
383
# good enough for a start
385
encoding_type = 'exact'
386
takes_args = ['path']
387
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
388
' rather than the parsed tuples.'),
391
def run(self, path, raw=False):
392
dirname, basename = osutils.split(path)
393
t = transport.get_transport(dirname)
395
self._dump_raw_bytes(t, basename)
397
self._dump_entries(t, basename)
399
def _get_index_and_bytes(self, trans, basename):
400
"""Create a BTreeGraphIndex and raw bytes."""
401
bt = btree_index.BTreeGraphIndex(trans, basename, None)
402
bytes = trans.get_bytes(basename)
403
bt._file = cStringIO.StringIO(bytes)
404
bt._size = len(bytes)
407
def _dump_raw_bytes(self, trans, basename):
410
# We need to parse at least the root node.
411
# This is because the first page of every row starts with an
412
# uncompressed header.
413
bt, bytes = self._get_index_and_bytes(trans, basename)
414
for page_idx, page_start in enumerate(xrange(0, len(bytes),
415
btree_index._PAGE_SIZE)):
416
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
417
page_bytes = bytes[page_start:page_end]
419
self.outf.write('Root node:\n')
420
header_end, data = bt._parse_header_from_bytes(page_bytes)
421
self.outf.write(page_bytes[:header_end])
423
self.outf.write('\nPage %d\n' % (page_idx,))
424
decomp_bytes = zlib.decompress(page_bytes)
425
self.outf.write(decomp_bytes)
426
self.outf.write('\n')
428
def _dump_entries(self, trans, basename):
430
st = trans.stat(basename)
431
except errors.TransportNotPossible:
432
# We can't stat, so we'll fake it because we have to do the 'get()'
434
bt, _ = self._get_index_and_bytes(trans, basename)
436
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
437
for node in bt.iter_all_entries():
438
# Node is made up of:
439
# (index, key, value, [references])
440
refs_as_tuples = static_tuple.as_tuples(node[3])
441
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
442
self.outf.write('%s\n' % (as_tuple,))
445
class cmd_remove_tree(Command):
446
"""Remove the working tree from a given branch/checkout.
448
Since a lightweight checkout is little more than a working tree
449
this will refuse to run against one.
451
To re-create the working tree, use "bzr checkout".
453
_see_also = ['checkout', 'working-trees']
454
takes_args = ['location?']
457
help='Remove the working tree even if it has '
458
'uncommitted changes.'),
461
def run(self, location='.', force=False):
462
d = bzrdir.BzrDir.open(location)
465
working = d.open_workingtree()
466
except errors.NoWorkingTree:
467
raise errors.BzrCommandError("No working tree to remove")
468
except errors.NotLocalUrl:
469
raise errors.BzrCommandError("You cannot remove the working tree"
472
if (working.has_changes()):
473
raise errors.UncommittedChanges(working)
475
working_path = working.bzrdir.root_transport.base
476
branch_path = working.branch.bzrdir.root_transport.base
477
if working_path != branch_path:
478
raise errors.BzrCommandError("You cannot remove the working tree"
479
" from a lightweight checkout")
481
d.destroy_workingtree()
484
class cmd_revno(Command):
485
"""Show current revision number.
487
This is equal to the number of revisions on this branch.
491
takes_args = ['location?']
493
Option('tree', help='Show revno of working tree'),
497
def run(self, tree=False, location=u'.'):
500
wt = WorkingTree.open_containing(location)[0]
502
except (errors.NoWorkingTree, errors.NotLocalUrl):
503
raise errors.NoWorkingTree(location)
505
revid = wt.last_revision()
507
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
508
except errors.NoSuchRevision:
510
revno = ".".join(str(n) for n in revno_t)
514
b = Branch.open_containing(location)[0]
521
self.outf.write(str(revno) + '\n')
524
class cmd_revision_info(Command):
525
"""Show revision number and revision id for a given revision identifier.
528
takes_args = ['revision_info*']
532
help='Branch to examine, '
533
'rather than the one containing the working directory.',
537
Option('tree', help='Show revno of working tree'),
541
def run(self, revision=None, directory=u'.', tree=False,
542
revision_info_list=[]):
545
wt = WorkingTree.open_containing(directory)[0]
548
except (errors.NoWorkingTree, errors.NotLocalUrl):
550
b = Branch.open_containing(directory)[0]
554
if revision is not None:
555
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
556
if revision_info_list is not None:
557
for rev_str in revision_info_list:
558
rev_spec = RevisionSpec.from_string(rev_str)
559
revision_ids.append(rev_spec.as_revision_id(b))
560
# No arguments supplied, default to the last revision
561
if len(revision_ids) == 0:
564
raise errors.NoWorkingTree(directory)
565
revision_ids.append(wt.last_revision())
567
revision_ids.append(b.last_revision())
571
for revision_id in revision_ids:
573
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
574
revno = '.'.join(str(i) for i in dotted_revno)
575
except errors.NoSuchRevision:
577
maxlen = max(maxlen, len(revno))
578
revinfos.append([revno, revision_id])
586
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
589
class cmd_add(Command):
590
"""Add specified files or directories.
592
In non-recursive mode, all the named items are added, regardless
593
of whether they were previously ignored. A warning is given if
594
any of the named files are already versioned.
596
In recursive mode (the default), files are treated the same way
597
but the behaviour for directories is different. Directories that
598
are already versioned do not give a warning. All directories,
599
whether already versioned or not, are searched for files or
600
subdirectories that are neither versioned or ignored, and these
601
are added. This search proceeds recursively into versioned
602
directories. If no names are given '.' is assumed.
604
Therefore simply saying 'bzr add' will version all files that
605
are currently unknown.
607
Adding a file whose parent directory is not versioned will
608
implicitly add the parent, and so on up to the root. This means
609
you should never need to explicitly add a directory, they'll just
610
get added when you add a file in the directory.
612
--dry-run will show which files would be added, but not actually
615
--file-ids-from will try to use the file ids from the supplied path.
616
It looks up ids trying to find a matching parent directory with the
617
same filename, and then by pure path. This option is rarely needed
618
but can be useful when adding the same logical file into two
619
branches that will be merged later (without showing the two different
620
adds as a conflict). It is also useful when merging another project
621
into a subdirectory of this one.
623
Any files matching patterns in the ignore list will not be added
624
unless they are explicitly mentioned.
626
takes_args = ['file*']
629
help="Don't recursively add the contents of directories."),
631
help="Show what would be done, but don't actually do anything."),
633
Option('file-ids-from',
635
help='Lookup file ids from this tree.'),
637
encoding_type = 'replace'
638
_see_also = ['remove', 'ignore']
640
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
645
if file_ids_from is not None:
647
base_tree, base_path = WorkingTree.open_containing(
649
except errors.NoWorkingTree:
650
base_branch, base_path = Branch.open_containing(
652
base_tree = base_branch.basis_tree()
654
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
655
to_file=self.outf, should_print=(not is_quiet()))
657
action = bzrlib.add.AddAction(to_file=self.outf,
658
should_print=(not is_quiet()))
661
base_tree.lock_read()
663
tree, file_list = tree_files_for_add(file_list)
664
added, ignored = tree.smart_add(file_list, not
665
no_recurse, action=action, save=not dry_run)
667
if base_tree is not None:
671
for glob in sorted(ignored.keys()):
672
for path in ignored[glob]:
673
self.outf.write("ignored %s matching \"%s\"\n"
677
class cmd_mkdir(Command):
678
"""Create a new versioned directory.
680
This is equivalent to creating the directory and then adding it.
683
takes_args = ['dir+']
684
encoding_type = 'replace'
686
def run(self, dir_list):
689
wt, dd = WorkingTree.open_containing(d)
691
self.outf.write('added %s\n' % d)
694
class cmd_relpath(Command):
695
"""Show path of a file relative to root"""
697
takes_args = ['filename']
701
def run(self, filename):
702
# TODO: jam 20050106 Can relpath return a munged path if
703
# sys.stdout encoding cannot represent it?
704
tree, relpath = WorkingTree.open_containing(filename)
705
self.outf.write(relpath)
706
self.outf.write('\n')
709
class cmd_inventory(Command):
710
"""Show inventory of the current working copy or a revision.
712
It is possible to limit the output to a particular entry
713
type using the --kind option. For example: --kind file.
715
It is also possible to restrict the list of files to a specific
716
set. For example: bzr inventory --show-ids this/file
725
help='List entries of a particular kind: file, directory, symlink.',
728
takes_args = ['file*']
731
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
732
if kind and kind not in ['file', 'directory', 'symlink']:
733
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
735
revision = _get_one_revision('inventory', revision)
736
work_tree, file_list = tree_files(file_list)
737
work_tree.lock_read()
739
if revision is not None:
740
tree = revision.as_tree(work_tree.branch)
742
extra_trees = [work_tree]
748
if file_list is not None:
749
file_ids = tree.paths2ids(file_list, trees=extra_trees,
750
require_versioned=True)
751
# find_ids_across_trees may include some paths that don't
753
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
754
for file_id in file_ids if file_id in tree)
756
entries = tree.inventory.entries()
759
if tree is not work_tree:
762
for path, entry in entries:
763
if kind and kind != entry.kind:
766
self.outf.write('%-50s %s\n' % (path, entry.file_id))
768
self.outf.write(path)
769
self.outf.write('\n')
772
class cmd_mv(Command):
773
"""Move or rename a file.
776
bzr mv OLDNAME NEWNAME
778
bzr mv SOURCE... DESTINATION
780
If the last argument is a versioned directory, all the other names
781
are moved into it. Otherwise, there must be exactly two arguments
782
and the file is changed to a new name.
784
If OLDNAME does not exist on the filesystem but is versioned and
785
NEWNAME does exist on the filesystem but is not versioned, mv
786
assumes that the file has been manually moved and only updates
787
its internal inventory to reflect that change.
788
The same is valid when moving many SOURCE files to a DESTINATION.
790
Files cannot be moved between branches.
793
takes_args = ['names*']
794
takes_options = [Option("after", help="Move only the bzr identifier"
795
" of the file, because the file has already been moved."),
796
Option('auto', help='Automatically guess renames.'),
797
Option('dry-run', help='Avoid making changes when guessing renames.'),
799
aliases = ['move', 'rename']
800
encoding_type = 'replace'
802
def run(self, names_list, after=False, auto=False, dry_run=False):
804
return self.run_auto(names_list, after, dry_run)
806
raise errors.BzrCommandError('--dry-run requires --auto.')
807
if names_list is None:
809
if len(names_list) < 2:
810
raise errors.BzrCommandError("missing file argument")
811
tree, rel_names = tree_files(names_list, canonicalize=False)
812
tree.lock_tree_write()
814
self._run(tree, names_list, rel_names, after)
818
def run_auto(self, names_list, after, dry_run):
819
if names_list is not None and len(names_list) > 1:
820
raise errors.BzrCommandError('Only one path may be specified to'
823
raise errors.BzrCommandError('--after cannot be specified with'
825
work_tree, file_list = tree_files(names_list, default_branch='.')
826
work_tree.lock_tree_write()
828
rename_map.RenameMap.guess_renames(work_tree, dry_run)
832
def _run(self, tree, names_list, rel_names, after):
833
into_existing = osutils.isdir(names_list[-1])
834
if into_existing and len(names_list) == 2:
836
# a. case-insensitive filesystem and change case of dir
837
# b. move directory after the fact (if the source used to be
838
# a directory, but now doesn't exist in the working tree
839
# and the target is an existing directory, just rename it)
840
if (not tree.case_sensitive
841
and rel_names[0].lower() == rel_names[1].lower()):
842
into_existing = False
845
# 'fix' the case of a potential 'from'
846
from_id = tree.path2id(
847
tree.get_canonical_inventory_path(rel_names[0]))
848
if (not osutils.lexists(names_list[0]) and
849
from_id and inv.get_file_kind(from_id) == "directory"):
850
into_existing = False
853
# move into existing directory
854
# All entries reference existing inventory items, so fix them up
855
# for cicp file-systems.
856
rel_names = tree.get_canonical_inventory_paths(rel_names)
857
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
859
self.outf.write("%s => %s\n" % (src, dest))
861
if len(names_list) != 2:
862
raise errors.BzrCommandError('to mv multiple files the'
863
' destination must be a versioned'
866
# for cicp file-systems: the src references an existing inventory
868
src = tree.get_canonical_inventory_path(rel_names[0])
869
# Find the canonical version of the destination: In all cases, the
870
# parent of the target must be in the inventory, so we fetch the
871
# canonical version from there (we do not always *use* the
872
# canonicalized tail portion - we may be attempting to rename the
874
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
875
dest_parent = osutils.dirname(canon_dest)
876
spec_tail = osutils.basename(rel_names[1])
877
# For a CICP file-system, we need to avoid creating 2 inventory
878
# entries that differ only by case. So regardless of the case
879
# we *want* to use (ie, specified by the user or the file-system),
880
# we must always choose to use the case of any existing inventory
881
# items. The only exception to this is when we are attempting a
882
# case-only rename (ie, canonical versions of src and dest are
884
dest_id = tree.path2id(canon_dest)
885
if dest_id is None or tree.path2id(src) == dest_id:
886
# No existing item we care about, so work out what case we
887
# are actually going to use.
889
# If 'after' is specified, the tail must refer to a file on disk.
891
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
893
# pathjoin with an empty tail adds a slash, which breaks
895
dest_parent_fq = tree.basedir
897
dest_tail = osutils.canonical_relpath(
899
osutils.pathjoin(dest_parent_fq, spec_tail))
901
# not 'after', so case as specified is used
902
dest_tail = spec_tail
904
# Use the existing item so 'mv' fails with AlreadyVersioned.
905
dest_tail = os.path.basename(canon_dest)
906
dest = osutils.pathjoin(dest_parent, dest_tail)
907
mutter("attempting to move %s => %s", src, dest)
908
tree.rename_one(src, dest, after=after)
910
self.outf.write("%s => %s\n" % (src, dest))
913
class cmd_pull(Command):
914
"""Turn this branch into a mirror of another branch.
916
By default, this command only works on branches that have not diverged.
917
Branches are considered diverged if the destination branch's most recent
918
commit is one that has not been merged (directly or indirectly) into the
921
If branches have diverged, you can use 'bzr merge' to integrate the changes
922
from one into the other. Once one branch has merged, the other should
923
be able to pull it again.
925
If you want to replace your local changes and just want your branch to
926
match the remote one, use pull --overwrite. This will work even if the two
927
branches have diverged.
929
If there is no default location set, the first pull will set it. After
930
that, you can omit the location to use the default. To change the
931
default, use --remember. The value will only be saved if the remote
932
location can be accessed.
934
Note: The location can be specified either in the form of a branch,
935
or in the form of a path to a file containing a merge directive generated
939
_see_also = ['push', 'update', 'status-flags', 'send']
940
takes_options = ['remember', 'overwrite', 'revision',
941
custom_help('verbose',
942
help='Show logs of pulled revisions.'),
944
help='Branch to pull into, '
945
'rather than the one containing the working directory.',
950
help="Perform a local pull in a bound "
951
"branch. Local pulls are not applied to "
955
takes_args = ['location?']
956
encoding_type = 'replace'
958
def run(self, location=None, remember=False, overwrite=False,
959
revision=None, verbose=False,
960
directory=None, local=False):
961
# FIXME: too much stuff is in the command class
964
if directory is None:
967
tree_to = WorkingTree.open_containing(directory)[0]
968
branch_to = tree_to.branch
969
except errors.NoWorkingTree:
971
branch_to = Branch.open_containing(directory)[0]
973
if local and not branch_to.get_bound_location():
974
raise errors.LocalRequiresBoundBranch()
976
possible_transports = []
977
if location is not None:
979
mergeable = bundle.read_mergeable_from_url(location,
980
possible_transports=possible_transports)
981
except errors.NotABundle:
984
stored_loc = branch_to.get_parent()
986
if stored_loc is None:
987
raise errors.BzrCommandError("No pull location known or"
990
display_url = urlutils.unescape_for_display(stored_loc,
993
self.outf.write("Using saved parent location: %s\n" % display_url)
994
location = stored_loc
996
revision = _get_one_revision('pull', revision)
997
if mergeable is not None:
998
if revision is not None:
999
raise errors.BzrCommandError(
1000
'Cannot use -r with merge directives or bundles')
1001
mergeable.install_revisions(branch_to.repository)
1002
base_revision_id, revision_id, verified = \
1003
mergeable.get_merge_request(branch_to.repository)
1004
branch_from = branch_to
1006
branch_from = Branch.open(location,
1007
possible_transports=possible_transports)
1009
if branch_to.get_parent() is None or remember:
1010
branch_to.set_parent(branch_from.base)
1012
if branch_from is not branch_to:
1013
branch_from.lock_read()
1015
if revision is not None:
1016
revision_id = revision.as_revision_id(branch_from)
1018
branch_to.lock_write()
1020
if tree_to is not None:
1021
view_info = _get_view_info_for_change_reporter(tree_to)
1022
change_reporter = delta._ChangeReporter(
1023
unversioned_filter=tree_to.is_ignored,
1024
view_info=view_info)
1025
result = tree_to.pull(
1026
branch_from, overwrite, revision_id, change_reporter,
1027
possible_transports=possible_transports, local=local)
1029
result = branch_to.pull(
1030
branch_from, overwrite, revision_id, local=local)
1032
result.report(self.outf)
1033
if verbose and result.old_revid != result.new_revid:
1034
log.show_branch_change(
1035
branch_to, self.outf, result.old_revno,
1040
if branch_from is not branch_to:
1041
branch_from.unlock()
1044
class cmd_push(Command):
1045
"""Update a mirror of this branch.
1047
The target branch will not have its working tree populated because this
1048
is both expensive, and is not supported on remote file systems.
1050
Some smart servers or protocols *may* put the working tree in place in
1053
This command only works on branches that have not diverged. Branches are
1054
considered diverged if the destination branch's most recent commit is one
1055
that has not been merged (directly or indirectly) by the source branch.
1057
If branches have diverged, you can use 'bzr push --overwrite' to replace
1058
the other branch completely, discarding its unmerged changes.
1060
If you want to ensure you have the different changes in the other branch,
1061
do a merge (see bzr help merge) from the other branch, and commit that.
1062
After that you will be able to do a push without '--overwrite'.
1064
If there is no default push location set, the first push will set it.
1065
After that, you can omit the location to use the default. To change the
1066
default, use --remember. The value will only be saved if the remote
1067
location can be accessed.
1070
_see_also = ['pull', 'update', 'working-trees']
1071
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1072
Option('create-prefix',
1073
help='Create the path leading up to the branch '
1074
'if it does not already exist.'),
1076
help='Branch to push from, '
1077
'rather than the one containing the working directory.',
1081
Option('use-existing-dir',
1082
help='By default push will fail if the target'
1083
' directory exists, but does not already'
1084
' have a control directory. This flag will'
1085
' allow push to proceed.'),
1087
help='Create a stacked branch that references the public location '
1088
'of the parent branch.'),
1089
Option('stacked-on',
1090
help='Create a stacked branch that refers to another branch '
1091
'for the commit history. Only the work not present in the '
1092
'referenced branch is included in the branch created.',
1095
help='Refuse to push if there are uncommitted changes in'
1096
' the working tree, --no-strict disables the check.'),
1098
takes_args = ['location?']
1099
encoding_type = 'replace'
1101
def run(self, location=None, remember=False, overwrite=False,
1102
create_prefix=False, verbose=False, revision=None,
1103
use_existing_dir=False, directory=None, stacked_on=None,
1104
stacked=False, strict=None):
1105
from bzrlib.push import _show_push_branch
1107
if directory is None:
1109
# Get the source branch
1111
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1113
strict = br_from.get_config().get_user_option_as_bool('push_strict')
1114
if strict is None: strict = True # default value
1115
# Get the tip's revision_id
1116
revision = _get_one_revision('push', revision)
1117
if revision is not None:
1118
revision_id = revision.in_history(br_from).rev_id
1121
if strict and tree is not None and revision_id is None:
1122
if (tree.has_changes()):
1123
raise errors.UncommittedChanges(
1124
tree, more='Use --no-strict to force the push.')
1125
if tree.last_revision() != tree.branch.last_revision():
1126
# The tree has lost sync with its branch, there is little
1127
# chance that the user is aware of it but he can still force
1128
# the push with --no-strict
1129
raise errors.OutOfDateTree(
1130
tree, more='Use --no-strict to force the push.')
1132
# Get the stacked_on branch, if any
1133
if stacked_on is not None:
1134
stacked_on = urlutils.normalize_url(stacked_on)
1136
parent_url = br_from.get_parent()
1138
parent = Branch.open(parent_url)
1139
stacked_on = parent.get_public_branch()
1141
# I considered excluding non-http url's here, thus forcing
1142
# 'public' branches only, but that only works for some
1143
# users, so it's best to just depend on the user spotting an
1144
# error by the feedback given to them. RBC 20080227.
1145
stacked_on = parent_url
1147
raise errors.BzrCommandError(
1148
"Could not determine branch to refer to.")
1150
# Get the destination location
1151
if location is None:
1152
stored_loc = br_from.get_push_location()
1153
if stored_loc is None:
1154
raise errors.BzrCommandError(
1155
"No push location known or specified.")
1157
display_url = urlutils.unescape_for_display(stored_loc,
1159
self.outf.write("Using saved push location: %s\n" % display_url)
1160
location = stored_loc
1162
_show_push_branch(br_from, revision_id, location, self.outf,
1163
verbose=verbose, overwrite=overwrite, remember=remember,
1164
stacked_on=stacked_on, create_prefix=create_prefix,
1165
use_existing_dir=use_existing_dir)
1168
class cmd_branch(Command):
1169
"""Create a new branch that is a copy of an existing branch.
1171
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1172
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1173
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1174
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1175
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1178
To retrieve the branch as of a particular revision, supply the --revision
1179
parameter, as in "branch foo/bar -r 5".
1182
_see_also = ['checkout']
1183
takes_args = ['from_location', 'to_location?']
1184
takes_options = ['revision', Option('hardlink',
1185
help='Hard-link working tree files where possible.'),
1187
help="Create a branch without a working-tree."),
1189
help="Switch the checkout in the current directory "
1190
"to the new branch."),
1192
help='Create a stacked branch referring to the source branch. '
1193
'The new branch will depend on the availability of the source '
1194
'branch for all operations.'),
1195
Option('standalone',
1196
help='Do not use a shared repository, even if available.'),
1197
Option('use-existing-dir',
1198
help='By default branch will fail if the target'
1199
' directory exists, but does not already'
1200
' have a control directory. This flag will'
1201
' allow branch to proceed.'),
1203
aliases = ['get', 'clone']
1205
def run(self, from_location, to_location=None, revision=None,
1206
hardlink=False, stacked=False, standalone=False, no_tree=False,
1207
use_existing_dir=False, switch=False):
1208
from bzrlib import switch as _mod_switch
1209
from bzrlib.tag import _merge_tags_if_possible
1210
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1212
revision = _get_one_revision('branch', revision)
1215
if revision is not None:
1216
revision_id = revision.as_revision_id(br_from)
1218
# FIXME - wt.last_revision, fallback to branch, fall back to
1219
# None or perhaps NULL_REVISION to mean copy nothing
1221
revision_id = br_from.last_revision()
1222
if to_location is None:
1223
to_location = urlutils.derive_to_location(from_location)
1224
to_transport = transport.get_transport(to_location)
1226
to_transport.mkdir('.')
1227
except errors.FileExists:
1228
if not use_existing_dir:
1229
raise errors.BzrCommandError('Target directory "%s" '
1230
'already exists.' % to_location)
1233
bzrdir.BzrDir.open_from_transport(to_transport)
1234
except errors.NotBranchError:
1237
raise errors.AlreadyBranchError(to_location)
1238
except errors.NoSuchFile:
1239
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1242
# preserve whatever source format we have.
1243
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1244
possible_transports=[to_transport],
1245
accelerator_tree=accelerator_tree,
1246
hardlink=hardlink, stacked=stacked,
1247
force_new_repo=standalone,
1248
create_tree_if_local=not no_tree,
1249
source_branch=br_from)
1250
branch = dir.open_branch()
1251
except errors.NoSuchRevision:
1252
to_transport.delete_tree('.')
1253
msg = "The branch %s has no revision %s." % (from_location,
1255
raise errors.BzrCommandError(msg)
1256
_merge_tags_if_possible(br_from, branch)
1257
# If the source branch is stacked, the new branch may
1258
# be stacked whether we asked for that explicitly or not.
1259
# We therefore need a try/except here and not just 'if stacked:'
1261
note('Created new stacked branch referring to %s.' %
1262
branch.get_stacked_on_url())
1263
except (errors.NotStacked, errors.UnstackableBranchFormat,
1264
errors.UnstackableRepositoryFormat), e:
1265
note('Branched %d revision(s).' % branch.revno())
1267
# Switch to the new branch
1268
wt, _ = WorkingTree.open_containing('.')
1269
_mod_switch.switch(wt.bzrdir, branch)
1270
note('Switched to branch: %s',
1271
urlutils.unescape_for_display(branch.base, 'utf-8'))
1276
class cmd_checkout(Command):
1277
"""Create a new checkout of an existing branch.
1279
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1280
the branch found in '.'. This is useful if you have removed the working tree
1281
or if it was never created - i.e. if you pushed the branch to its current
1282
location using SFTP.
1284
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1285
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1286
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1287
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1288
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1291
To retrieve the branch as of a particular revision, supply the --revision
1292
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1293
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1297
_see_also = ['checkouts', 'branch']
1298
takes_args = ['branch_location?', 'to_location?']
1299
takes_options = ['revision',
1300
Option('lightweight',
1301
help="Perform a lightweight checkout. Lightweight "
1302
"checkouts depend on access to the branch for "
1303
"every operation. Normal checkouts can perform "
1304
"common operations like diff and status without "
1305
"such access, and also support local commits."
1307
Option('files-from', type=str,
1308
help="Get file contents from this tree."),
1310
help='Hard-link working tree files where possible.'
1315
def run(self, branch_location=None, to_location=None, revision=None,
1316
lightweight=False, files_from=None, hardlink=False):
1317
if branch_location is None:
1318
branch_location = osutils.getcwd()
1319
to_location = branch_location
1320
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1322
revision = _get_one_revision('checkout', revision)
1323
if files_from is not None:
1324
accelerator_tree = WorkingTree.open(files_from)
1325
if revision is not None:
1326
revision_id = revision.as_revision_id(source)
1329
if to_location is None:
1330
to_location = urlutils.derive_to_location(branch_location)
1331
# if the source and to_location are the same,
1332
# and there is no working tree,
1333
# then reconstitute a branch
1334
if (osutils.abspath(to_location) ==
1335
osutils.abspath(branch_location)):
1337
source.bzrdir.open_workingtree()
1338
except errors.NoWorkingTree:
1339
source.bzrdir.create_workingtree(revision_id)
1341
source.create_checkout(to_location, revision_id, lightweight,
1342
accelerator_tree, hardlink)
1345
class cmd_renames(Command):
1346
"""Show list of renamed files.
1348
# TODO: Option to show renames between two historical versions.
1350
# TODO: Only show renames under dir, rather than in the whole branch.
1351
_see_also = ['status']
1352
takes_args = ['dir?']
1355
def run(self, dir=u'.'):
1356
tree = WorkingTree.open_containing(dir)[0]
1359
new_inv = tree.inventory
1360
old_tree = tree.basis_tree()
1361
old_tree.lock_read()
1363
old_inv = old_tree.inventory
1365
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1366
for f, paths, c, v, p, n, k, e in iterator:
1367
if paths[0] == paths[1]:
1371
renames.append(paths)
1373
for old_name, new_name in renames:
1374
self.outf.write("%s => %s\n" % (old_name, new_name))
1381
class cmd_update(Command):
1382
"""Update a tree to have the latest code committed to its branch.
1384
This will perform a merge into the working tree, and may generate
1385
conflicts. If you have any local changes, you will still
1386
need to commit them after the update for the update to be complete.
1388
If you want to discard your local changes, you can just do a
1389
'bzr revert' instead of 'bzr commit' after the update.
1392
_see_also = ['pull', 'working-trees', 'status-flags']
1393
takes_args = ['dir?']
1396
def run(self, dir='.'):
1397
tree = WorkingTree.open_containing(dir)[0]
1398
possible_transports = []
1399
master = tree.branch.get_master_branch(
1400
possible_transports=possible_transports)
1401
if master is not None:
1404
tree.lock_tree_write()
1406
existing_pending_merges = tree.get_parent_ids()[1:]
1407
last_rev = _mod_revision.ensure_null(tree.last_revision())
1408
if last_rev == _mod_revision.ensure_null(
1409
tree.branch.last_revision()):
1410
# may be up to date, check master too.
1411
if master is None or last_rev == _mod_revision.ensure_null(
1412
master.last_revision()):
1413
revno = tree.branch.revision_id_to_revno(last_rev)
1414
note("Tree is up to date at revision %d." % (revno,))
1416
view_info = _get_view_info_for_change_reporter(tree)
1417
conflicts = tree.update(
1418
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1419
view_info=view_info), possible_transports=possible_transports)
1420
revno = tree.branch.revision_id_to_revno(
1421
_mod_revision.ensure_null(tree.last_revision()))
1422
note('Updated to revision %d.' % (revno,))
1423
if tree.get_parent_ids()[1:] != existing_pending_merges:
1424
note('Your local commits will now show as pending merges with '
1425
"'bzr status', and can be committed with 'bzr commit'.")
1434
class cmd_info(Command):
1435
"""Show information about a working tree, branch or repository.
1437
This command will show all known locations and formats associated to the
1438
tree, branch or repository.
1440
In verbose mode, statistical information is included with each report.
1441
To see extended statistic information, use a verbosity level of 2 or
1442
higher by specifying the verbose option multiple times, e.g. -vv.
1444
Branches and working trees will also report any missing revisions.
1448
Display information on the format and related locations:
1452
Display the above together with extended format information and
1453
basic statistics (like the number of files in the working tree and
1454
number of revisions in the branch and repository):
1458
Display the above together with number of committers to the branch:
1462
_see_also = ['revno', 'working-trees', 'repositories']
1463
takes_args = ['location?']
1464
takes_options = ['verbose']
1465
encoding_type = 'replace'
1468
def run(self, location=None, verbose=False):
1470
noise_level = get_verbosity_level()
1473
from bzrlib.info import show_bzrdir_info
1474
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1475
verbose=noise_level, outfile=self.outf)
1478
class cmd_remove(Command):
1479
"""Remove files or directories.
1481
This makes bzr stop tracking changes to the specified files. bzr will delete
1482
them if they can easily be recovered using revert. If no options or
1483
parameters are given bzr will scan for files that are being tracked by bzr
1484
but missing in your tree and stop tracking them for you.
1486
takes_args = ['file*']
1487
takes_options = ['verbose',
1488
Option('new', help='Only remove files that have never been committed.'),
1489
RegistryOption.from_kwargs('file-deletion-strategy',
1490
'The file deletion mode to be used.',
1491
title='Deletion Strategy', value_switches=True, enum_switch=False,
1492
safe='Only delete files if they can be'
1493
' safely recovered (default).',
1494
keep='Delete from bzr but leave the working copy.',
1495
force='Delete all the specified files, even if they can not be '
1496
'recovered and even if they are non-empty directories.')]
1497
aliases = ['rm', 'del']
1498
encoding_type = 'replace'
1500
def run(self, file_list, verbose=False, new=False,
1501
file_deletion_strategy='safe'):
1502
tree, file_list = tree_files(file_list)
1504
if file_list is not None:
1505
file_list = [f for f in file_list]
1509
# Heuristics should probably all move into tree.remove_smart or
1512
added = tree.changes_from(tree.basis_tree(),
1513
specific_files=file_list).added
1514
file_list = sorted([f[0] for f in added], reverse=True)
1515
if len(file_list) == 0:
1516
raise errors.BzrCommandError('No matching files.')
1517
elif file_list is None:
1518
# missing files show up in iter_changes(basis) as
1519
# versioned-with-no-kind.
1521
for change in tree.iter_changes(tree.basis_tree()):
1522
# Find paths in the working tree that have no kind:
1523
if change[1][1] is not None and change[6][1] is None:
1524
missing.append(change[1][1])
1525
file_list = sorted(missing, reverse=True)
1526
file_deletion_strategy = 'keep'
1527
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1528
keep_files=file_deletion_strategy=='keep',
1529
force=file_deletion_strategy=='force')
1534
class cmd_file_id(Command):
1535
"""Print file_id of a particular file or directory.
1537
The file_id is assigned when the file is first added and remains the
1538
same through all revisions where the file exists, even when it is
1543
_see_also = ['inventory', 'ls']
1544
takes_args = ['filename']
1547
def run(self, filename):
1548
tree, relpath = WorkingTree.open_containing(filename)
1549
i = tree.path2id(relpath)
1551
raise errors.NotVersionedError(filename)
1553
self.outf.write(i + '\n')
1556
class cmd_file_path(Command):
1557
"""Print path of file_ids to a file or directory.
1559
This prints one line for each directory down to the target,
1560
starting at the branch root.
1564
takes_args = ['filename']
1567
def run(self, filename):
1568
tree, relpath = WorkingTree.open_containing(filename)
1569
fid = tree.path2id(relpath)
1571
raise errors.NotVersionedError(filename)
1572
segments = osutils.splitpath(relpath)
1573
for pos in range(1, len(segments) + 1):
1574
path = osutils.joinpath(segments[:pos])
1575
self.outf.write("%s\n" % tree.path2id(path))
1578
class cmd_reconcile(Command):
1579
"""Reconcile bzr metadata in a branch.
1581
This can correct data mismatches that may have been caused by
1582
previous ghost operations or bzr upgrades. You should only
1583
need to run this command if 'bzr check' or a bzr developer
1584
advises you to run it.
1586
If a second branch is provided, cross-branch reconciliation is
1587
also attempted, which will check that data like the tree root
1588
id which was not present in very early bzr versions is represented
1589
correctly in both branches.
1591
At the same time it is run it may recompress data resulting in
1592
a potential saving in disk space or performance gain.
1594
The branch *MUST* be on a listable system such as local disk or sftp.
1597
_see_also = ['check']
1598
takes_args = ['branch?']
1600
def run(self, branch="."):
1601
from bzrlib.reconcile import reconcile
1602
dir = bzrdir.BzrDir.open(branch)
1606
class cmd_revision_history(Command):
1607
"""Display the list of revision ids on a branch."""
1610
takes_args = ['location?']
1615
def run(self, location="."):
1616
branch = Branch.open_containing(location)[0]
1617
for revid in branch.revision_history():
1618
self.outf.write(revid)
1619
self.outf.write('\n')
1622
class cmd_ancestry(Command):
1623
"""List all revisions merged into this branch."""
1625
_see_also = ['log', 'revision-history']
1626
takes_args = ['location?']
1631
def run(self, location="."):
1633
wt = WorkingTree.open_containing(location)[0]
1634
except errors.NoWorkingTree:
1635
b = Branch.open(location)
1636
last_revision = b.last_revision()
1639
last_revision = wt.last_revision()
1641
revision_ids = b.repository.get_ancestry(last_revision)
1643
for revision_id in revision_ids:
1644
self.outf.write(revision_id + '\n')
1647
class cmd_init(Command):
1648
"""Make a directory into a versioned branch.
1650
Use this to create an empty branch, or before importing an
1653
If there is a repository in a parent directory of the location, then
1654
the history of the branch will be stored in the repository. Otherwise
1655
init creates a standalone branch which carries its own history
1656
in the .bzr directory.
1658
If there is already a branch at the location but it has no working tree,
1659
the tree can be populated with 'bzr checkout'.
1661
Recipe for importing a tree of files::
1667
bzr commit -m "imported project"
1670
_see_also = ['init-repository', 'branch', 'checkout']
1671
takes_args = ['location?']
1673
Option('create-prefix',
1674
help='Create the path leading up to the branch '
1675
'if it does not already exist.'),
1676
RegistryOption('format',
1677
help='Specify a format for this branch. '
1678
'See "help formats".',
1679
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1680
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1681
value_switches=True,
1682
title="Branch format",
1684
Option('append-revisions-only',
1685
help='Never change revnos or the existing log.'
1686
' Append revisions to it only.')
1688
def run(self, location=None, format=None, append_revisions_only=False,
1689
create_prefix=False):
1691
format = bzrdir.format_registry.make_bzrdir('default')
1692
if location is None:
1695
to_transport = transport.get_transport(location)
1697
# The path has to exist to initialize a
1698
# branch inside of it.
1699
# Just using os.mkdir, since I don't
1700
# believe that we want to create a bunch of
1701
# locations if the user supplies an extended path
1703
to_transport.ensure_base()
1704
except errors.NoSuchFile:
1705
if not create_prefix:
1706
raise errors.BzrCommandError("Parent directory of %s"
1708
"\nYou may supply --create-prefix to create all"
1709
" leading parent directories."
1711
to_transport.create_prefix()
1714
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1715
except errors.NotBranchError:
1716
# really a NotBzrDir error...
1717
create_branch = bzrdir.BzrDir.create_branch_convenience
1718
branch = create_branch(to_transport.base, format=format,
1719
possible_transports=[to_transport])
1720
a_bzrdir = branch.bzrdir
1722
from bzrlib.transport.local import LocalTransport
1723
if a_bzrdir.has_branch():
1724
if (isinstance(to_transport, LocalTransport)
1725
and not a_bzrdir.has_workingtree()):
1726
raise errors.BranchExistsWithoutWorkingTree(location)
1727
raise errors.AlreadyBranchError(location)
1728
branch = a_bzrdir.create_branch()
1729
a_bzrdir.create_workingtree()
1730
if append_revisions_only:
1732
branch.set_append_revisions_only(True)
1733
except errors.UpgradeRequired:
1734
raise errors.BzrCommandError('This branch format cannot be set'
1735
' to append-revisions-only. Try --default.')
1737
from bzrlib.info import describe_layout, describe_format
1739
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1740
except (errors.NoWorkingTree, errors.NotLocalUrl):
1742
repository = branch.repository
1743
layout = describe_layout(repository, branch, tree).lower()
1744
format = describe_format(a_bzrdir, repository, branch, tree)
1745
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1746
if repository.is_shared():
1747
#XXX: maybe this can be refactored into transport.path_or_url()
1748
url = repository.bzrdir.root_transport.external_url()
1750
url = urlutils.local_path_from_url(url)
1751
except errors.InvalidURL:
1753
self.outf.write("Using shared repository: %s\n" % url)
1756
class cmd_init_repository(Command):
1757
"""Create a shared repository for branches to share storage space.
1759
New branches created under the repository directory will store their
1760
revisions in the repository, not in the branch directory. For branches
1761
with shared history, this reduces the amount of storage needed and
1762
speeds up the creation of new branches.
1764
If the --no-trees option is given then the branches in the repository
1765
will not have working trees by default. They will still exist as
1766
directories on disk, but they will not have separate copies of the
1767
files at a certain revision. This can be useful for repositories that
1768
store branches which are interacted with through checkouts or remote
1769
branches, such as on a server.
1772
Create a shared repository holding just branches::
1774
bzr init-repo --no-trees repo
1777
Make a lightweight checkout elsewhere::
1779
bzr checkout --lightweight repo/trunk trunk-checkout
1784
_see_also = ['init', 'branch', 'checkout', 'repositories']
1785
takes_args = ["location"]
1786
takes_options = [RegistryOption('format',
1787
help='Specify a format for this repository. See'
1788
' "bzr help formats" for details.',
1789
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1790
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1791
value_switches=True, title='Repository format'),
1793
help='Branches in the repository will default to'
1794
' not having a working tree.'),
1796
aliases = ["init-repo"]
1798
def run(self, location, format=None, no_trees=False):
1800
format = bzrdir.format_registry.make_bzrdir('default')
1802
if location is None:
1805
to_transport = transport.get_transport(location)
1806
to_transport.ensure_base()
1808
newdir = format.initialize_on_transport(to_transport)
1809
repo = newdir.create_repository(shared=True)
1810
repo.set_make_working_trees(not no_trees)
1812
from bzrlib.info import show_bzrdir_info
1813
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1816
class cmd_diff(Command):
1817
"""Show differences in the working tree, between revisions or branches.
1819
If no arguments are given, all changes for the current tree are listed.
1820
If files are given, only the changes in those files are listed.
1821
Remote and multiple branches can be compared by using the --old and
1822
--new options. If not provided, the default for both is derived from
1823
the first argument, if any, or the current tree if no arguments are
1826
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1827
produces patches suitable for "patch -p1".
1831
2 - unrepresentable changes
1836
Shows the difference in the working tree versus the last commit::
1840
Difference between the working tree and revision 1::
1844
Difference between revision 3 and revision 1::
1848
Difference between revision 3 and revision 1 for branch xxx::
1852
To see the changes introduced in revision X::
1856
Note that in the case of a merge, the -c option shows the changes
1857
compared to the left hand parent. To see the changes against
1858
another parent, use::
1860
bzr diff -r<chosen_parent>..X
1862
The changes introduced by revision 2 (equivalent to -r1..2)::
1866
Show just the differences for file NEWS::
1870
Show the differences in working tree xxx for file NEWS::
1874
Show the differences from branch xxx to this working tree:
1878
Show the differences between two branches for file NEWS::
1880
bzr diff --old xxx --new yyy NEWS
1882
Same as 'bzr diff' but prefix paths with old/ and new/::
1884
bzr diff --prefix old/:new/
1886
_see_also = ['status']
1887
takes_args = ['file*']
1889
Option('diff-options', type=str,
1890
help='Pass these options to the external diff program.'),
1891
Option('prefix', type=str,
1893
help='Set prefixes added to old and new filenames, as '
1894
'two values separated by a colon. (eg "old/:new/").'),
1896
help='Branch/tree to compare from.',
1900
help='Branch/tree to compare to.',
1906
help='Use this command to compare files.',
1910
aliases = ['di', 'dif']
1911
encoding_type = 'exact'
1914
def run(self, revision=None, file_list=None, diff_options=None,
1915
prefix=None, old=None, new=None, using=None):
1916
from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
1918
if (prefix is None) or (prefix == '0'):
1926
old_label, new_label = prefix.split(":")
1928
raise errors.BzrCommandError(
1929
'--prefix expects two values separated by a colon'
1930
' (eg "old/:new/")')
1932
if revision and len(revision) > 2:
1933
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1934
' one or two revision specifiers')
1936
(old_tree, new_tree,
1937
old_branch, new_branch,
1938
specific_files, extra_trees) = get_trees_and_branches_to_diff(
1939
file_list, revision, old, new, apply_view=True)
1940
return show_diff_trees(old_tree, new_tree, sys.stdout,
1941
specific_files=specific_files,
1942
external_diff_options=diff_options,
1943
old_label=old_label, new_label=new_label,
1944
extra_trees=extra_trees, using=using)
1947
class cmd_deleted(Command):
1948
"""List files deleted in the working tree.
1950
# TODO: Show files deleted since a previous revision, or
1951
# between two revisions.
1952
# TODO: Much more efficient way to do this: read in new
1953
# directories with readdir, rather than stating each one. Same
1954
# level of effort but possibly much less IO. (Or possibly not,
1955
# if the directories are very large...)
1956
_see_also = ['status', 'ls']
1957
takes_options = ['show-ids']
1960
def run(self, show_ids=False):
1961
tree = WorkingTree.open_containing(u'.')[0]
1964
old = tree.basis_tree()
1967
for path, ie in old.inventory.iter_entries():
1968
if not tree.has_id(ie.file_id):
1969
self.outf.write(path)
1971
self.outf.write(' ')
1972
self.outf.write(ie.file_id)
1973
self.outf.write('\n')
1980
class cmd_modified(Command):
1981
"""List files modified in working tree.
1985
_see_also = ['status', 'ls']
1988
help='Write an ascii NUL (\\0) separator '
1989
'between files rather than a newline.')
1993
def run(self, null=False):
1994
tree = WorkingTree.open_containing(u'.')[0]
1995
td = tree.changes_from(tree.basis_tree())
1996
for path, id, kind, text_modified, meta_modified in td.modified:
1998
self.outf.write(path + '\0')
2000
self.outf.write(osutils.quotefn(path) + '\n')
2003
class cmd_added(Command):
2004
"""List files added in working tree.
2008
_see_also = ['status', 'ls']
2011
help='Write an ascii NUL (\\0) separator '
2012
'between files rather than a newline.')
2016
def run(self, null=False):
2017
wt = WorkingTree.open_containing(u'.')[0]
2020
basis = wt.basis_tree()
2023
basis_inv = basis.inventory
2026
if file_id in basis_inv:
2028
if inv.is_root(file_id) and len(basis_inv) == 0:
2030
path = inv.id2path(file_id)
2031
if not os.access(osutils.abspath(path), os.F_OK):
2034
self.outf.write(path + '\0')
2036
self.outf.write(osutils.quotefn(path) + '\n')
2043
class cmd_root(Command):
2044
"""Show the tree root directory.
2046
The root is the nearest enclosing directory with a .bzr control
2049
takes_args = ['filename?']
2051
def run(self, filename=None):
2052
"""Print the branch root."""
2053
tree = WorkingTree.open_containing(filename)[0]
2054
self.outf.write(tree.basedir + '\n')
2057
def _parse_limit(limitstring):
2059
return int(limitstring)
2061
msg = "The limit argument must be an integer."
2062
raise errors.BzrCommandError(msg)
2065
def _parse_levels(s):
2069
msg = "The levels argument must be an integer."
2070
raise errors.BzrCommandError(msg)
2073
class cmd_log(Command):
2074
"""Show historical log for a branch or subset of a branch.
2076
log is bzr's default tool for exploring the history of a branch.
2077
The branch to use is taken from the first parameter. If no parameters
2078
are given, the branch containing the working directory is logged.
2079
Here are some simple examples::
2081
bzr log log the current branch
2082
bzr log foo.py log a file in its branch
2083
bzr log http://server/branch log a branch on a server
2085
The filtering, ordering and information shown for each revision can
2086
be controlled as explained below. By default, all revisions are
2087
shown sorted (topologically) so that newer revisions appear before
2088
older ones and descendants always appear before ancestors. If displayed,
2089
merged revisions are shown indented under the revision in which they
2094
The log format controls how information about each revision is
2095
displayed. The standard log formats are called ``long``, ``short``
2096
and ``line``. The default is long. See ``bzr help log-formats``
2097
for more details on log formats.
2099
The following options can be used to control what information is
2102
-l N display a maximum of N revisions
2103
-n N display N levels of revisions (0 for all, 1 for collapsed)
2104
-v display a status summary (delta) for each revision
2105
-p display a diff (patch) for each revision
2106
--show-ids display revision-ids (and file-ids), not just revnos
2108
Note that the default number of levels to display is a function of the
2109
log format. If the -n option is not used, the standard log formats show
2110
just the top level (mainline).
2112
Status summaries are shown using status flags like A, M, etc. To see
2113
the changes explained using words like ``added`` and ``modified``
2114
instead, use the -vv option.
2118
To display revisions from oldest to newest, use the --forward option.
2119
In most cases, using this option will have little impact on the total
2120
time taken to produce a log, though --forward does not incrementally
2121
display revisions like --reverse does when it can.
2123
:Revision filtering:
2125
The -r option can be used to specify what revision or range of revisions
2126
to filter against. The various forms are shown below::
2128
-rX display revision X
2129
-rX.. display revision X and later
2130
-r..Y display up to and including revision Y
2131
-rX..Y display from X to Y inclusive
2133
See ``bzr help revisionspec`` for details on how to specify X and Y.
2134
Some common examples are given below::
2136
-r-1 show just the tip
2137
-r-10.. show the last 10 mainline revisions
2138
-rsubmit:.. show what's new on this branch
2139
-rancestor:path.. show changes since the common ancestor of this
2140
branch and the one at location path
2141
-rdate:yesterday.. show changes since yesterday
2143
When logging a range of revisions using -rX..Y, log starts at
2144
revision Y and searches back in history through the primary
2145
("left-hand") parents until it finds X. When logging just the
2146
top level (using -n1), an error is reported if X is not found
2147
along the way. If multi-level logging is used (-n0), X may be
2148
a nested merge revision and the log will be truncated accordingly.
2152
If parameters are given and the first one is not a branch, the log
2153
will be filtered to show only those revisions that changed the
2154
nominated files or directories.
2156
Filenames are interpreted within their historical context. To log a
2157
deleted file, specify a revision range so that the file existed at
2158
the end or start of the range.
2160
Historical context is also important when interpreting pathnames of
2161
renamed files/directories. Consider the following example:
2163
* revision 1: add tutorial.txt
2164
* revision 2: modify tutorial.txt
2165
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2169
* ``bzr log guide.txt`` will log the file added in revision 1
2171
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2173
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2174
the original file in revision 2.
2176
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2177
was no file called guide.txt in revision 2.
2179
Renames are always followed by log. By design, there is no need to
2180
explicitly ask for this (and no way to stop logging a file back
2181
until it was last renamed).
2185
The --message option can be used for finding revisions that match a
2186
regular expression in a commit message.
2190
GUI tools and IDEs are often better at exploring history than command
2191
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2192
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2193
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2195
Web interfaces are often better at exploring history than command line
2196
tools, particularly for branches on servers. You may prefer Loggerhead
2197
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2199
You may find it useful to add the aliases below to ``bazaar.conf``::
2203
top = log -l10 --line
2206
``bzr tip`` will then show the latest revision while ``bzr top``
2207
will show the last 10 mainline revisions. To see the details of a
2208
particular revision X, ``bzr show -rX``.
2210
If you are interested in looking deeper into a particular merge X,
2211
use ``bzr log -n0 -rX``.
2213
``bzr log -v`` on a branch with lots of history is currently
2214
very slow. A fix for this issue is currently under development.
2215
With or without that fix, it is recommended that a revision range
2216
be given when using the -v option.
2218
bzr has a generic full-text matching plugin, bzr-search, that can be
2219
used to find revisions matching user names, commit messages, etc.
2220
Among other features, this plugin can find all revisions containing
2221
a list of words but not others.
2223
When exploring non-mainline history on large projects with deep
2224
history, the performance of log can be greatly improved by installing
2225
the historycache plugin. This plugin buffers historical information
2226
trading disk space for faster speed.
2228
takes_args = ['file*']
2229
_see_also = ['log-formats', 'revisionspec']
2232
help='Show from oldest to newest.'),
2234
custom_help('verbose',
2235
help='Show files changed in each revision.'),
2239
type=bzrlib.option._parse_revision_str,
2241
help='Show just the specified revision.'
2242
' See also "help revisionspec".'),
2246
help='Number of levels to display - 0 for all, 1 for flat.',
2248
type=_parse_levels),
2251
help='Show revisions whose message matches this '
2252
'regular expression.',
2256
help='Limit the output to the first N revisions.',
2261
help='Show changes made in each revision as a patch.'),
2262
Option('include-merges',
2263
help='Show merged revisions like --levels 0 does.'),
2265
encoding_type = 'replace'
2268
def run(self, file_list=None, timezone='original',
2279
include_merges=False):
2280
from bzrlib.log import (
2282
make_log_request_dict,
2283
_get_info_for_log_files,
2285
direction = (forward and 'forward') or 'reverse'
2290
raise errors.BzrCommandError(
2291
'--levels and --include-merges are mutually exclusive')
2293
if change is not None:
2295
raise errors.RangeInChangeOption()
2296
if revision is not None:
2297
raise errors.BzrCommandError(
2298
'--revision and --change are mutually exclusive')
2303
filter_by_dir = False
2307
# find the file ids to log and check for directory filtering
2308
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2309
revision, file_list)
2310
for relpath, file_id, kind in file_info_list:
2312
raise errors.BzrCommandError(
2313
"Path unknown at end or start of revision range: %s" %
2315
# If the relpath is the top of the tree, we log everything
2320
file_ids.append(file_id)
2321
filter_by_dir = filter_by_dir or (
2322
kind in ['directory', 'tree-reference'])
2325
# FIXME ? log the current subdir only RBC 20060203
2326
if revision is not None \
2327
and len(revision) > 0 and revision[0].get_branch():
2328
location = revision[0].get_branch()
2331
dir, relpath = bzrdir.BzrDir.open_containing(location)
2332
b = dir.open_branch()
2334
rev1, rev2 = _get_revision_range(revision, b, self.name())
2336
# Decide on the type of delta & diff filtering to use
2337
# TODO: add an --all-files option to make this configurable & consistent
2345
diff_type = 'partial'
2349
# Build the log formatter
2350
if log_format is None:
2351
log_format = log.log_formatter_registry.get_default(b)
2352
lf = log_format(show_ids=show_ids, to_file=self.outf,
2353
show_timezone=timezone,
2354
delta_format=get_verbosity_level(),
2356
show_advice=levels is None)
2358
# Choose the algorithm for doing the logging. It's annoying
2359
# having multiple code paths like this but necessary until
2360
# the underlying repository format is faster at generating
2361
# deltas or can provide everything we need from the indices.
2362
# The default algorithm - match-using-deltas - works for
2363
# multiple files and directories and is faster for small
2364
# amounts of history (200 revisions say). However, it's too
2365
# slow for logging a single file in a repository with deep
2366
# history, i.e. > 10K revisions. In the spirit of "do no
2367
# evil when adding features", we continue to use the
2368
# original algorithm - per-file-graph - for the "single
2369
# file that isn't a directory without showing a delta" case.
2370
partial_history = revision and b.repository._format.supports_chks
2371
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2372
or delta_type or partial_history)
2374
# Build the LogRequest and execute it
2375
if len(file_ids) == 0:
2377
rqst = make_log_request_dict(
2378
direction=direction, specific_fileids=file_ids,
2379
start_revision=rev1, end_revision=rev2, limit=limit,
2380
message_search=message, delta_type=delta_type,
2381
diff_type=diff_type, _match_using_deltas=match_using_deltas)
2382
Logger(b, rqst).show(lf)
2388
def _get_revision_range(revisionspec_list, branch, command_name):
2389
"""Take the input of a revision option and turn it into a revision range.
2391
It returns RevisionInfo objects which can be used to obtain the rev_id's
2392
of the desired revisions. It does some user input validations.
2394
if revisionspec_list is None:
2397
elif len(revisionspec_list) == 1:
2398
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2399
elif len(revisionspec_list) == 2:
2400
start_spec = revisionspec_list[0]
2401
end_spec = revisionspec_list[1]
2402
if end_spec.get_branch() != start_spec.get_branch():
2403
# b is taken from revision[0].get_branch(), and
2404
# show_log will use its revision_history. Having
2405
# different branches will lead to weird behaviors.
2406
raise errors.BzrCommandError(
2407
"bzr %s doesn't accept two revisions in different"
2408
" branches." % command_name)
2409
rev1 = start_spec.in_history(branch)
2410
# Avoid loading all of history when we know a missing
2411
# end of range means the last revision ...
2412
if end_spec.spec is None:
2413
last_revno, last_revision_id = branch.last_revision_info()
2414
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2416
rev2 = end_spec.in_history(branch)
2418
raise errors.BzrCommandError(
2419
'bzr %s --revision takes one or two values.' % command_name)
2423
def _revision_range_to_revid_range(revision_range):
2426
if revision_range[0] is not None:
2427
rev_id1 = revision_range[0].rev_id
2428
if revision_range[1] is not None:
2429
rev_id2 = revision_range[1].rev_id
2430
return rev_id1, rev_id2
2432
def get_log_format(long=False, short=False, line=False, default='long'):
2433
log_format = default
2437
log_format = 'short'
2443
class cmd_touching_revisions(Command):
2444
"""Return revision-ids which affected a particular file.
2446
A more user-friendly interface is "bzr log FILE".
2450
takes_args = ["filename"]
2453
def run(self, filename):
2454
tree, relpath = WorkingTree.open_containing(filename)
2455
file_id = tree.path2id(relpath)
2459
touching_revs = log.find_touching_revisions(b, file_id)
2460
for revno, revision_id, what in touching_revs:
2461
self.outf.write("%6d %s\n" % (revno, what))
2466
class cmd_ls(Command):
2467
"""List files in a tree.
2470
_see_also = ['status', 'cat']
2471
takes_args = ['path?']
2475
Option('recursive', short_name='R',
2476
help='Recurse into subdirectories.'),
2478
help='Print paths relative to the root of the branch.'),
2479
Option('unknown', help='Print unknown files.'),
2480
Option('versioned', help='Print versioned files.',
2482
Option('ignored', help='Print ignored files.'),
2484
help='Write an ascii NUL (\\0) separator '
2485
'between files rather than a newline.'),
2487
help='List entries of a particular kind: file, directory, symlink.',
2492
def run(self, revision=None, verbose=False,
2493
recursive=False, from_root=False,
2494
unknown=False, versioned=False, ignored=False,
2495
null=False, kind=None, show_ids=False, path=None):
2497
if kind and kind not in ('file', 'directory', 'symlink'):
2498
raise errors.BzrCommandError('invalid kind specified')
2500
if verbose and null:
2501
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2502
all = not (unknown or versioned or ignored)
2504
selection = {'I':ignored, '?':unknown, 'V':versioned}
2510
raise errors.BzrCommandError('cannot specify both --from-root'
2513
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2516
# Calculate the prefix to use
2520
prefix = relpath + '/'
2521
elif fs_path != '.' and not fs_path.endswith('/'):
2522
prefix = fs_path + '/'
2524
if revision is not None or tree is None:
2525
tree = _get_one_revision_tree('ls', revision, branch=branch)
2528
if isinstance(tree, WorkingTree) and tree.supports_views():
2529
view_files = tree.views.lookup_view()
2532
view_str = views.view_display_str(view_files)
2533
note("Ignoring files outside view. View is %s" % view_str)
2537
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2538
from_dir=relpath, recursive=recursive):
2539
# Apply additional masking
2540
if not all and not selection[fc]:
2542
if kind is not None and fkind != kind:
2547
fullpath = osutils.pathjoin(relpath, fp)
2550
views.check_path_in_view(tree, fullpath)
2551
except errors.FileOutsideView:
2556
fp = osutils.pathjoin(prefix, fp)
2557
kindch = entry.kind_character()
2558
outstring = fp + kindch
2559
ui.ui_factory.clear_term()
2561
outstring = '%-8s %s' % (fc, outstring)
2562
if show_ids and fid is not None:
2563
outstring = "%-50s %s" % (outstring, fid)
2564
self.outf.write(outstring + '\n')
2566
self.outf.write(fp + '\0')
2569
self.outf.write(fid)
2570
self.outf.write('\0')
2578
self.outf.write('%-50s %s\n' % (outstring, my_id))
2580
self.outf.write(outstring + '\n')
2585
class cmd_unknowns(Command):
2586
"""List unknown files.
2594
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2595
self.outf.write(osutils.quotefn(f) + '\n')
2598
class cmd_ignore(Command):
2599
"""Ignore specified files or patterns.
2601
See ``bzr help patterns`` for details on the syntax of patterns.
2603
If a .bzrignore file does not exist, the ignore command
2604
will create one and add the specified files or patterns to the newly
2605
created file. The ignore command will also automatically add the
2606
.bzrignore file to be versioned. Creating a .bzrignore file without
2607
the use of the ignore command will require an explicit add command.
2609
To remove patterns from the ignore list, edit the .bzrignore file.
2610
After adding, editing or deleting that file either indirectly by
2611
using this command or directly by using an editor, be sure to commit
2614
Note: ignore patterns containing shell wildcards must be quoted from
2618
Ignore the top level Makefile::
2620
bzr ignore ./Makefile
2622
Ignore class files in all directories::
2624
bzr ignore "*.class"
2626
Ignore .o files under the lib directory::
2628
bzr ignore "lib/**/*.o"
2630
Ignore .o files under the lib directory::
2632
bzr ignore "RE:lib/.*\.o"
2634
Ignore everything but the "debian" toplevel directory::
2636
bzr ignore "RE:(?!debian/).*"
2639
_see_also = ['status', 'ignored', 'patterns']
2640
takes_args = ['name_pattern*']
2642
Option('old-default-rules',
2643
help='Write out the ignore rules bzr < 0.9 always used.')
2646
def run(self, name_pattern_list=None, old_default_rules=None):
2647
from bzrlib import ignores
2648
if old_default_rules is not None:
2649
# dump the rules and exit
2650
for pattern in ignores.OLD_DEFAULTS:
2653
if not name_pattern_list:
2654
raise errors.BzrCommandError("ignore requires at least one "
2655
"NAME_PATTERN or --old-default-rules")
2656
name_pattern_list = [globbing.normalize_pattern(p)
2657
for p in name_pattern_list]
2658
for name_pattern in name_pattern_list:
2659
if (name_pattern[0] == '/' or
2660
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2661
raise errors.BzrCommandError(
2662
"NAME_PATTERN should not be an absolute path")
2663
tree, relpath = WorkingTree.open_containing(u'.')
2664
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2665
ignored = globbing.Globster(name_pattern_list)
2668
for entry in tree.list_files():
2672
if ignored.match(filename):
2673
matches.append(filename.encode('utf-8'))
2675
if len(matches) > 0:
2676
print "Warning: the following files are version controlled and" \
2677
" match your ignore pattern:\n%s" \
2678
"\nThese files will continue to be version controlled" \
2679
" unless you 'bzr remove' them." % ("\n".join(matches),)
2682
class cmd_ignored(Command):
2683
"""List ignored files and the patterns that matched them.
2685
List all the ignored files and the ignore pattern that caused the file to
2688
Alternatively, to list just the files::
2693
encoding_type = 'replace'
2694
_see_also = ['ignore', 'ls']
2698
tree = WorkingTree.open_containing(u'.')[0]
2701
for path, file_class, kind, file_id, entry in tree.list_files():
2702
if file_class != 'I':
2704
## XXX: Slightly inefficient since this was already calculated
2705
pat = tree.is_ignored(path)
2706
self.outf.write('%-50s %s\n' % (path, pat))
2711
class cmd_lookup_revision(Command):
2712
"""Lookup the revision-id from a revision-number
2715
bzr lookup-revision 33
2718
takes_args = ['revno']
2721
def run(self, revno):
2725
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2727
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2730
class cmd_export(Command):
2731
"""Export current or past revision to a destination directory or archive.
2733
If no revision is specified this exports the last committed revision.
2735
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2736
given, try to find the format with the extension. If no extension
2737
is found exports to a directory (equivalent to --format=dir).
2739
If root is supplied, it will be used as the root directory inside
2740
container formats (tar, zip, etc). If it is not supplied it will default
2741
to the exported filename. The root option has no effect for 'dir' format.
2743
If branch is omitted then the branch containing the current working
2744
directory will be used.
2746
Note: Export of tree with non-ASCII filenames to zip is not supported.
2748
================= =========================
2749
Supported formats Autodetected by extension
2750
================= =========================
2753
tbz2 .tar.bz2, .tbz2
2756
================= =========================
2758
takes_args = ['dest', 'branch_or_subdir?']
2761
help="Type of file to export to.",
2764
Option('filters', help='Apply content filters to export the '
2765
'convenient form.'),
2768
help="Name of the root directory inside the exported file."),
2770
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2771
root=None, filters=False):
2772
from bzrlib.export import export
2774
if branch_or_subdir is None:
2775
tree = WorkingTree.open_containing(u'.')[0]
2779
b, subdir = Branch.open_containing(branch_or_subdir)
2782
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2784
export(rev_tree, dest, format, root, subdir, filtered=filters)
2785
except errors.NoSuchExportFormat, e:
2786
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2789
class cmd_cat(Command):
2790
"""Write the contents of a file as of a given revision to standard output.
2792
If no revision is nominated, the last revision is used.
2794
Note: Take care to redirect standard output when using this command on a
2800
Option('name-from-revision', help='The path name in the old tree.'),
2801
Option('filters', help='Apply content filters to display the '
2802
'convenience form.'),
2805
takes_args = ['filename']
2806
encoding_type = 'exact'
2809
def run(self, filename, revision=None, name_from_revision=False,
2811
if revision is not None and len(revision) != 1:
2812
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2813
" one revision specifier")
2814
tree, branch, relpath = \
2815
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2818
return self._run(tree, branch, relpath, filename, revision,
2819
name_from_revision, filters)
2823
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2826
tree = b.basis_tree()
2827
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2829
old_file_id = rev_tree.path2id(relpath)
2831
if name_from_revision:
2832
# Try in revision if requested
2833
if old_file_id is None:
2834
raise errors.BzrCommandError(
2835
"%r is not present in revision %s" % (
2836
filename, rev_tree.get_revision_id()))
2838
content = rev_tree.get_file_text(old_file_id)
2840
cur_file_id = tree.path2id(relpath)
2842
if cur_file_id is not None:
2843
# Then try with the actual file id
2845
content = rev_tree.get_file_text(cur_file_id)
2847
except errors.NoSuchId:
2848
# The actual file id didn't exist at that time
2850
if not found and old_file_id is not None:
2851
# Finally try with the old file id
2852
content = rev_tree.get_file_text(old_file_id)
2855
# Can't be found anywhere
2856
raise errors.BzrCommandError(
2857
"%r is not present in revision %s" % (
2858
filename, rev_tree.get_revision_id()))
2860
from bzrlib.filters import (
2861
ContentFilterContext,
2862
filtered_output_bytes,
2864
filters = rev_tree._content_filter_stack(relpath)
2865
chunks = content.splitlines(True)
2866
content = filtered_output_bytes(chunks, filters,
2867
ContentFilterContext(relpath, rev_tree))
2868
self.outf.writelines(content)
2870
self.outf.write(content)
2873
class cmd_local_time_offset(Command):
2874
"""Show the offset in seconds from GMT to local time."""
2878
print osutils.local_time_offset()
2882
class cmd_commit(Command):
2883
"""Commit changes into a new revision.
2885
An explanatory message needs to be given for each commit. This is
2886
often done by using the --message option (getting the message from the
2887
command line) or by using the --file option (getting the message from
2888
a file). If neither of these options is given, an editor is opened for
2889
the user to enter the message. To see the changed files in the
2890
boilerplate text loaded into the editor, use the --show-diff option.
2892
By default, the entire tree is committed and the person doing the
2893
commit is assumed to be the author. These defaults can be overridden
2898
If selected files are specified, only changes to those files are
2899
committed. If a directory is specified then the directory and
2900
everything within it is committed.
2902
When excludes are given, they take precedence over selected files.
2903
For example, to commit only changes within foo, but not changes
2906
bzr commit foo -x foo/bar
2908
A selective commit after a merge is not yet supported.
2912
If the author of the change is not the same person as the committer,
2913
you can specify the author's name using the --author option. The
2914
name should be in the same format as a committer-id, e.g.
2915
"John Doe <jdoe@example.com>". If there is more than one author of
2916
the change you can specify the option multiple times, once for each
2921
A common mistake is to forget to add a new file or directory before
2922
running the commit command. The --strict option checks for unknown
2923
files and aborts the commit if any are found. More advanced pre-commit
2924
checks can be implemented by defining hooks. See ``bzr help hooks``
2929
If you accidentially commit the wrong changes or make a spelling
2930
mistake in the commit message say, you can use the uncommit command
2931
to undo it. See ``bzr help uncommit`` for details.
2933
Hooks can also be configured to run after a commit. This allows you
2934
to trigger updates to external systems like bug trackers. The --fixes
2935
option can be used to record the association between a revision and
2936
one or more bugs. See ``bzr help bugs`` for details.
2938
A selective commit may fail in some cases where the committed
2939
tree would be invalid. Consider::
2944
bzr commit foo -m "committing foo"
2945
bzr mv foo/bar foo/baz
2948
bzr commit foo/bar -m "committing bar but not baz"
2950
In the example above, the last commit will fail by design. This gives
2951
the user the opportunity to decide whether they want to commit the
2952
rename at the same time, separately first, or not at all. (As a general
2953
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2955
# TODO: Run hooks on tree to-be-committed, and after commit.
2957
# TODO: Strict commit that fails if there are deleted files.
2958
# (what does "deleted files" mean ??)
2960
# TODO: Give better message for -s, --summary, used by tla people
2962
# XXX: verbose currently does nothing
2964
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
2965
takes_args = ['selected*']
2967
ListOption('exclude', type=str, short_name='x',
2968
help="Do not consider changes made to a given path."),
2969
Option('message', type=unicode,
2971
help="Description of the new revision."),
2974
help='Commit even if nothing has changed.'),
2975
Option('file', type=str,
2978
help='Take commit message from this file.'),
2980
help="Refuse to commit if there are unknown "
2981
"files in the working tree."),
2982
Option('commit-time', type=str,
2983
help="Manually set a commit time using commit date "
2984
"format, e.g. '2009-10-10 08:00:00 +0100'."),
2985
ListOption('fixes', type=str,
2986
help="Mark a bug as being fixed by this revision "
2987
"(see \"bzr help bugs\")."),
2988
ListOption('author', type=unicode,
2989
help="Set the author's name, if it's different "
2990
"from the committer."),
2992
help="Perform a local commit in a bound "
2993
"branch. Local commits are not pushed to "
2994
"the master branch until a normal commit "
2998
help='When no message is supplied, show the diff along'
2999
' with the status summary in the message editor.'),
3001
aliases = ['ci', 'checkin']
3003
def _iter_bug_fix_urls(self, fixes, branch):
3004
# Configure the properties for bug fixing attributes.
3005
for fixed_bug in fixes:
3006
tokens = fixed_bug.split(':')
3007
if len(tokens) != 2:
3008
raise errors.BzrCommandError(
3009
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3010
"See \"bzr help bugs\" for more information on this "
3011
"feature.\nCommit refused." % fixed_bug)
3012
tag, bug_id = tokens
3014
yield bugtracker.get_bug_url(tag, branch, bug_id)
3015
except errors.UnknownBugTrackerAbbreviation:
3016
raise errors.BzrCommandError(
3017
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3018
except errors.MalformedBugIdentifier, e:
3019
raise errors.BzrCommandError(
3020
"%s\nCommit refused." % (str(e),))
3022
def run(self, message=None, file=None, verbose=False, selected_list=None,
3023
unchanged=False, strict=False, local=False, fixes=None,
3024
author=None, show_diff=False, exclude=None, commit_time=None):
3025
from bzrlib.errors import (
3030
from bzrlib.msgeditor import (
3031
edit_commit_message_encoded,
3032
generate_commit_message_template,
3033
make_commit_message_template_encoded
3036
commit_stamp = offset = None
3037
if commit_time is not None:
3039
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3040
except ValueError, e:
3041
raise errors.BzrCommandError(
3042
"Could not parse --commit-time: " + str(e))
3044
# TODO: Need a blackbox test for invoking the external editor; may be
3045
# slightly problematic to run this cross-platform.
3047
# TODO: do more checks that the commit will succeed before
3048
# spending the user's valuable time typing a commit message.
3052
tree, selected_list = tree_files(selected_list)
3053
if selected_list == ['']:
3054
# workaround - commit of root of tree should be exactly the same
3055
# as just default commit in that tree, and succeed even though
3056
# selected-file merge commit is not done yet
3061
bug_property = bugtracker.encode_fixes_bug_urls(
3062
self._iter_bug_fix_urls(fixes, tree.branch))
3064
properties['bugs'] = bug_property
3066
if local and not tree.branch.get_bound_location():
3067
raise errors.LocalRequiresBoundBranch()
3069
if message is not None:
3070
if osutils.lexists(message):
3071
warning_msg = ("The commit message is a file"
3072
" name: \"%(filename)s\".\n"
3073
"(use --file \"%(filename)s\" to take commit message from"
3074
" that file)" % { 'filename': message })
3075
ui.ui_factory.show_warning(warning_msg)
3077
def get_message(commit_obj):
3078
"""Callback to get commit message"""
3079
my_message = message
3080
if my_message is not None and '\r' in my_message:
3081
my_message = my_message.replace('\r\n', '\n')
3082
my_message = my_message.replace('\r', '\n')
3083
if my_message is None and not file:
3084
t = make_commit_message_template_encoded(tree,
3085
selected_list, diff=show_diff,
3086
output_encoding=osutils.get_user_encoding())
3087
start_message = generate_commit_message_template(commit_obj)
3088
my_message = edit_commit_message_encoded(t,
3089
start_message=start_message)
3090
if my_message is None:
3091
raise errors.BzrCommandError("please specify a commit"
3092
" message with either --message or --file")
3093
elif my_message and file:
3094
raise errors.BzrCommandError(
3095
"please specify either --message or --file")
3097
my_message = codecs.open(file, 'rt',
3098
osutils.get_user_encoding()).read()
3099
if my_message == "":
3100
raise errors.BzrCommandError("empty commit message specified")
3103
# The API permits a commit with a filter of [] to mean 'select nothing'
3104
# but the command line should not do that.
3105
if not selected_list:
3106
selected_list = None
3108
tree.commit(message_callback=get_message,
3109
specific_files=selected_list,
3110
allow_pointless=unchanged, strict=strict, local=local,
3111
reporter=None, verbose=verbose, revprops=properties,
3112
authors=author, timestamp=commit_stamp,
3114
exclude=safe_relpath_files(tree, exclude))
3115
except PointlessCommit:
3116
# FIXME: This should really happen before the file is read in;
3117
# perhaps prepare the commit; get the message; then actually commit
3118
raise errors.BzrCommandError("No changes to commit."
3119
" Use --unchanged to commit anyhow.")
3120
except ConflictsInTree:
3121
raise errors.BzrCommandError('Conflicts detected in working '
3122
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3124
except StrictCommitFailed:
3125
raise errors.BzrCommandError("Commit refused because there are"
3126
" unknown files in the working tree.")
3127
except errors.BoundBranchOutOfDate, e:
3128
raise errors.BzrCommandError(str(e) + "\n"
3129
'To commit to master branch, run update and then commit.\n'
3130
'You can also pass --local to commit to continue working '
3134
class cmd_check(Command):
3135
"""Validate working tree structure, branch consistency and repository history.
3137
This command checks various invariants about branch and repository storage
3138
to detect data corruption or bzr bugs.
3140
The working tree and branch checks will only give output if a problem is
3141
detected. The output fields of the repository check are:
3144
This is just the number of revisions checked. It doesn't
3148
This is just the number of versionedfiles checked. It
3149
doesn't indicate a problem.
3151
unreferenced ancestors
3152
Texts that are ancestors of other texts, but
3153
are not properly referenced by the revision ancestry. This is a
3154
subtle problem that Bazaar can work around.
3157
This is the total number of unique file contents
3158
seen in the checked revisions. It does not indicate a problem.
3161
This is the total number of repeated texts seen
3162
in the checked revisions. Texts can be repeated when their file
3163
entries are modified, but the file contents are not. It does not
3166
If no restrictions are specified, all Bazaar data that is found at the given
3167
location will be checked.
3171
Check the tree and branch at 'foo'::
3173
bzr check --tree --branch foo
3175
Check only the repository at 'bar'::
3177
bzr check --repo bar
3179
Check everything at 'baz'::
3184
_see_also = ['reconcile']
3185
takes_args = ['path?']
3186
takes_options = ['verbose',
3187
Option('branch', help="Check the branch related to the"
3188
" current directory."),
3189
Option('repo', help="Check the repository related to the"
3190
" current directory."),
3191
Option('tree', help="Check the working tree related to"
3192
" the current directory.")]
3194
def run(self, path=None, verbose=False, branch=False, repo=False,
3196
from bzrlib.check import check_dwim
3199
if not branch and not repo and not tree:
3200
branch = repo = tree = True
3201
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3204
class cmd_upgrade(Command):
3205
"""Upgrade branch storage to current format.
3207
The check command or bzr developers may sometimes advise you to run
3208
this command. When the default format has changed you may also be warned
3209
during other operations to upgrade.
3212
_see_also = ['check']
3213
takes_args = ['url?']
3215
RegistryOption('format',
3216
help='Upgrade to a specific format. See "bzr help'
3217
' formats" for details.',
3218
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3219
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3220
value_switches=True, title='Branch format'),
3223
def run(self, url='.', format=None):
3224
from bzrlib.upgrade import upgrade
3225
upgrade(url, format)
3228
class cmd_whoami(Command):
3229
"""Show or set bzr user id.
3232
Show the email of the current user::
3236
Set the current user::
3238
bzr whoami "Frank Chu <fchu@example.com>"
3240
takes_options = [ Option('email',
3241
help='Display email address only.'),
3243
help='Set identity for the current branch instead of '
3246
takes_args = ['name?']
3247
encoding_type = 'replace'
3250
def run(self, email=False, branch=False, name=None):
3252
# use branch if we're inside one; otherwise global config
3254
c = Branch.open_containing('.')[0].get_config()
3255
except errors.NotBranchError:
3256
c = config.GlobalConfig()
3258
self.outf.write(c.user_email() + '\n')
3260
self.outf.write(c.username() + '\n')
3263
# display a warning if an email address isn't included in the given name.
3265
config.extract_email_address(name)
3266
except errors.NoEmailInUsername, e:
3267
warning('"%s" does not seem to contain an email address. '
3268
'This is allowed, but not recommended.', name)
3270
# use global config unless --branch given
3272
c = Branch.open_containing('.')[0].get_config()
3274
c = config.GlobalConfig()
3275
c.set_user_option('email', name)
3278
class cmd_nick(Command):
3279
"""Print or set the branch nickname.
3281
If unset, the tree root directory name is used as the nickname.
3282
To print the current nickname, execute with no argument.
3284
Bound branches use the nickname of its master branch unless it is set
3288
_see_also = ['info']
3289
takes_args = ['nickname?']
3290
def run(self, nickname=None):
3291
branch = Branch.open_containing(u'.')[0]
3292
if nickname is None:
3293
self.printme(branch)
3295
branch.nick = nickname
3298
def printme(self, branch):
3302
class cmd_alias(Command):
3303
"""Set/unset and display aliases.
3306
Show the current aliases::
3310
Show the alias specified for 'll'::
3314
Set an alias for 'll'::
3316
bzr alias ll="log --line -r-10..-1"
3318
To remove an alias for 'll'::
3320
bzr alias --remove ll
3323
takes_args = ['name?']
3325
Option('remove', help='Remove the alias.'),
3328
def run(self, name=None, remove=False):
3330
self.remove_alias(name)
3332
self.print_aliases()
3334
equal_pos = name.find('=')
3336
self.print_alias(name)
3338
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3340
def remove_alias(self, alias_name):
3341
if alias_name is None:
3342
raise errors.BzrCommandError(
3343
'bzr alias --remove expects an alias to remove.')
3344
# If alias is not found, print something like:
3345
# unalias: foo: not found
3346
c = config.GlobalConfig()
3347
c.unset_alias(alias_name)
3350
def print_aliases(self):
3351
"""Print out the defined aliases in a similar format to bash."""
3352
aliases = config.GlobalConfig().get_aliases()
3353
for key, value in sorted(aliases.iteritems()):
3354
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3357
def print_alias(self, alias_name):
3358
from bzrlib.commands import get_alias
3359
alias = get_alias(alias_name)
3361
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3364
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3366
def set_alias(self, alias_name, alias_command):
3367
"""Save the alias in the global config."""
3368
c = config.GlobalConfig()
3369
c.set_alias(alias_name, alias_command)
3372
class cmd_selftest(Command):
3373
"""Run internal test suite.
3375
If arguments are given, they are regular expressions that say which tests
3376
should run. Tests matching any expression are run, and other tests are
3379
Alternatively if --first is given, matching tests are run first and then
3380
all other tests are run. This is useful if you have been working in a
3381
particular area, but want to make sure nothing else was broken.
3383
If --exclude is given, tests that match that regular expression are
3384
excluded, regardless of whether they match --first or not.
3386
To help catch accidential dependencies between tests, the --randomize
3387
option is useful. In most cases, the argument used is the word 'now'.
3388
Note that the seed used for the random number generator is displayed
3389
when this option is used. The seed can be explicitly passed as the
3390
argument to this option if required. This enables reproduction of the
3391
actual ordering used if and when an order sensitive problem is encountered.
3393
If --list-only is given, the tests that would be run are listed. This is
3394
useful when combined with --first, --exclude and/or --randomize to
3395
understand their impact. The test harness reports "Listed nn tests in ..."
3396
instead of "Ran nn tests in ..." when list mode is enabled.
3398
If the global option '--no-plugins' is given, plugins are not loaded
3399
before running the selftests. This has two effects: features provided or
3400
modified by plugins will not be tested, and tests provided by plugins will
3403
Tests that need working space on disk use a common temporary directory,
3404
typically inside $TMPDIR or /tmp.
3406
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3407
into a pdb postmortem session.
3410
Run only tests relating to 'ignore'::
3414
Disable plugins and list tests as they're run::
3416
bzr --no-plugins selftest -v
3418
# NB: this is used from the class without creating an instance, which is
3419
# why it does not have a self parameter.
3420
def get_transport_type(typestring):
3421
"""Parse and return a transport specifier."""
3422
if typestring == "sftp":
3423
from bzrlib.transport.sftp import SFTPAbsoluteServer
3424
return SFTPAbsoluteServer
3425
if typestring == "memory":
3426
from bzrlib.transport.memory import MemoryServer
3428
if typestring == "fakenfs":
3429
from bzrlib.transport.fakenfs import FakeNFSServer
3430
return FakeNFSServer
3431
msg = "No known transport type %s. Supported types are: sftp\n" %\
3433
raise errors.BzrCommandError(msg)
3436
takes_args = ['testspecs*']
3437
takes_options = ['verbose',
3439
help='Stop when one test fails.',
3443
help='Use a different transport by default '
3444
'throughout the test suite.',
3445
type=get_transport_type),
3447
help='Run the benchmarks rather than selftests.'),
3448
Option('lsprof-timed',
3449
help='Generate lsprof output for benchmarked'
3450
' sections of code.'),
3451
Option('lsprof-tests',
3452
help='Generate lsprof output for each test.'),
3453
Option('cache-dir', type=str,
3454
help='Cache intermediate benchmark output in this '
3457
help='Run all tests, but run specified tests first.',
3461
help='List the tests instead of running them.'),
3462
RegistryOption('parallel',
3463
help="Run the test suite in parallel.",
3464
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3465
value_switches=False,
3467
Option('randomize', type=str, argname="SEED",
3468
help='Randomize the order of tests using the given'
3469
' seed or "now" for the current time.'),
3470
Option('exclude', type=str, argname="PATTERN",
3472
help='Exclude tests that match this regular'
3475
help='Output test progress via subunit.'),
3476
Option('strict', help='Fail on missing dependencies or '
3478
Option('load-list', type=str, argname='TESTLISTFILE',
3479
help='Load a test id list from a text file.'),
3480
ListOption('debugflag', type=str, short_name='E',
3481
help='Turn on a selftest debug flag.'),
3482
ListOption('starting-with', type=str, argname='TESTID',
3483
param_name='starting_with', short_name='s',
3485
'Load only the tests starting with TESTID.'),
3487
encoding_type = 'replace'
3490
Command.__init__(self)
3491
self.additional_selftest_args = {}
3493
def run(self, testspecs_list=None, verbose=False, one=False,
3494
transport=None, benchmark=None,
3495
lsprof_timed=None, cache_dir=None,
3496
first=False, list_only=False,
3497
randomize=None, exclude=None, strict=False,
3498
load_list=None, debugflag=None, starting_with=None, subunit=False,
3499
parallel=None, lsprof_tests=False):
3500
from bzrlib.tests import selftest
3501
import bzrlib.benchmarks as benchmarks
3502
from bzrlib.benchmarks import tree_creator
3504
# Make deprecation warnings visible, unless -Werror is set
3505
symbol_versioning.activate_deprecation_warnings(override=False)
3507
if cache_dir is not None:
3508
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3509
if testspecs_list is not None:
3510
pattern = '|'.join(testspecs_list)
3515
from bzrlib.tests import SubUnitBzrRunner
3517
raise errors.BzrCommandError("subunit not available. subunit "
3518
"needs to be installed to use --subunit.")
3519
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3521
self.additional_selftest_args.setdefault(
3522
'suite_decorators', []).append(parallel)
3524
test_suite_factory = benchmarks.test_suite
3525
# Unless user explicitly asks for quiet, be verbose in benchmarks
3526
verbose = not is_quiet()
3527
# TODO: should possibly lock the history file...
3528
benchfile = open(".perf_history", "at", buffering=1)
3530
test_suite_factory = None
3533
selftest_kwargs = {"verbose": verbose,
3535
"stop_on_failure": one,
3536
"transport": transport,
3537
"test_suite_factory": test_suite_factory,
3538
"lsprof_timed": lsprof_timed,
3539
"lsprof_tests": lsprof_tests,
3540
"bench_history": benchfile,
3541
"matching_tests_first": first,
3542
"list_only": list_only,
3543
"random_seed": randomize,
3544
"exclude_pattern": exclude,
3546
"load_list": load_list,
3547
"debug_flags": debugflag,
3548
"starting_with": starting_with
3550
selftest_kwargs.update(self.additional_selftest_args)
3551
result = selftest(**selftest_kwargs)
3553
if benchfile is not None:
3555
return int(not result)
3558
class cmd_version(Command):
3559
"""Show version of bzr."""
3561
encoding_type = 'replace'
3563
Option("short", help="Print just the version number."),
3567
def run(self, short=False):
3568
from bzrlib.version import show_version
3570
self.outf.write(bzrlib.version_string + '\n')
3572
show_version(to_file=self.outf)
3575
class cmd_rocks(Command):
3576
"""Statement of optimism."""
3582
print "It sure does!"
3585
class cmd_find_merge_base(Command):
3586
"""Find and print a base revision for merging two branches."""
3587
# TODO: Options to specify revisions on either side, as if
3588
# merging only part of the history.
3589
takes_args = ['branch', 'other']
3593
def run(self, branch, other):
3594
from bzrlib.revision import ensure_null
3596
branch1 = Branch.open_containing(branch)[0]
3597
branch2 = Branch.open_containing(other)[0]
3602
last1 = ensure_null(branch1.last_revision())
3603
last2 = ensure_null(branch2.last_revision())
3605
graph = branch1.repository.get_graph(branch2.repository)
3606
base_rev_id = graph.find_unique_lca(last1, last2)
3608
print 'merge base is revision %s' % base_rev_id
3615
class cmd_merge(Command):
3616
"""Perform a three-way merge.
3618
The source of the merge can be specified either in the form of a branch,
3619
or in the form of a path to a file containing a merge directive generated
3620
with bzr send. If neither is specified, the default is the upstream branch
3621
or the branch most recently merged using --remember.
3623
When merging a branch, by default the tip will be merged. To pick a different
3624
revision, pass --revision. If you specify two values, the first will be used as
3625
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3626
available revisions, like this is commonly referred to as "cherrypicking".
3628
Revision numbers are always relative to the branch being merged.
3630
By default, bzr will try to merge in all new work from the other
3631
branch, automatically determining an appropriate base. If this
3632
fails, you may need to give an explicit base.
3634
Merge will do its best to combine the changes in two branches, but there
3635
are some kinds of problems only a human can fix. When it encounters those,
3636
it will mark a conflict. A conflict means that you need to fix something,
3637
before you should commit.
3639
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3641
If there is no default branch set, the first merge will set it. After
3642
that, you can omit the branch to use the default. To change the
3643
default, use --remember. The value will only be saved if the remote
3644
location can be accessed.
3646
The results of the merge are placed into the destination working
3647
directory, where they can be reviewed (with bzr diff), tested, and then
3648
committed to record the result of the merge.
3650
merge refuses to run if there are any uncommitted changes, unless
3653
To select only some changes to merge, use "merge -i", which will prompt
3654
you to apply each diff hunk and file change, similar to "shelve".
3657
To merge the latest revision from bzr.dev::
3659
bzr merge ../bzr.dev
3661
To merge changes up to and including revision 82 from bzr.dev::
3663
bzr merge -r 82 ../bzr.dev
3665
To merge the changes introduced by 82, without previous changes::
3667
bzr merge -r 81..82 ../bzr.dev
3669
To apply a merge directive contained in /tmp/merge::
3671
bzr merge /tmp/merge
3674
encoding_type = 'exact'
3675
_see_also = ['update', 'remerge', 'status-flags', 'send']
3676
takes_args = ['location?']
3681
help='Merge even if the destination tree has uncommitted changes.'),
3685
Option('show-base', help="Show base revision text in "
3687
Option('uncommitted', help='Apply uncommitted changes'
3688
' from a working copy, instead of branch changes.'),
3689
Option('pull', help='If the destination is already'
3690
' completely merged into the source, pull from the'
3691
' source rather than merging. When this happens,'
3692
' you do not need to commit the result.'),
3694
help='Branch to merge into, '
3695
'rather than the one containing the working directory.',
3699
Option('preview', help='Instead of merging, show a diff of the'
3701
Option('interactive', help='Select changes interactively.',
3705
def run(self, location=None, revision=None, force=False,
3706
merge_type=None, show_base=False, reprocess=None, remember=False,
3707
uncommitted=False, pull=False,
3712
if merge_type is None:
3713
merge_type = _mod_merge.Merge3Merger
3715
if directory is None: directory = u'.'
3716
possible_transports = []
3718
allow_pending = True
3719
verified = 'inapplicable'
3720
tree = WorkingTree.open_containing(directory)[0]
3723
basis_tree = tree.revision_tree(tree.last_revision())
3724
except errors.NoSuchRevision:
3725
basis_tree = tree.basis_tree()
3727
# die as quickly as possible if there are uncommitted changes
3729
if tree.has_changes():
3730
raise errors.UncommittedChanges(tree)
3732
view_info = _get_view_info_for_change_reporter(tree)
3733
change_reporter = delta._ChangeReporter(
3734
unversioned_filter=tree.is_ignored, view_info=view_info)
3737
pb = ui.ui_factory.nested_progress_bar()
3738
cleanups.append(pb.finished)
3740
cleanups.append(tree.unlock)
3741
if location is not None:
3743
mergeable = bundle.read_mergeable_from_url(location,
3744
possible_transports=possible_transports)
3745
except errors.NotABundle:
3749
raise errors.BzrCommandError('Cannot use --uncommitted'
3750
' with bundles or merge directives.')
3752
if revision is not None:
3753
raise errors.BzrCommandError(
3754
'Cannot use -r with merge directives or bundles')
3755
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3758
if merger is None and uncommitted:
3759
if revision is not None and len(revision) > 0:
3760
raise errors.BzrCommandError('Cannot use --uncommitted and'
3761
' --revision at the same time.')
3762
merger = self.get_merger_from_uncommitted(tree, location, pb,
3764
allow_pending = False
3767
merger, allow_pending = self._get_merger_from_branch(tree,
3768
location, revision, remember, possible_transports, pb)
3770
merger.merge_type = merge_type
3771
merger.reprocess = reprocess
3772
merger.show_base = show_base
3773
self.sanity_check_merger(merger)
3774
if (merger.base_rev_id == merger.other_rev_id and
3775
merger.other_rev_id is not None):
3776
note('Nothing to do.')
3779
if merger.interesting_files is not None:
3780
raise errors.BzrCommandError('Cannot pull individual files')
3781
if (merger.base_rev_id == tree.last_revision()):
3782
result = tree.pull(merger.other_branch, False,
3783
merger.other_rev_id)
3784
result.report(self.outf)
3786
if merger.this_basis is None:
3787
raise errors.BzrCommandError(
3788
"This branch has no commits."
3789
" (perhaps you would prefer 'bzr pull')")
3791
return self._do_preview(merger, cleanups)
3793
return self._do_interactive(merger, cleanups)
3795
return self._do_merge(merger, change_reporter, allow_pending,
3798
for cleanup in reversed(cleanups):
3801
def _get_preview(self, merger, cleanups):
3802
tree_merger = merger.make_merger()
3803
tt = tree_merger.make_preview_transform()
3804
cleanups.append(tt.finalize)
3805
result_tree = tt.get_preview_tree()
3808
def _do_preview(self, merger, cleanups):
3809
from bzrlib.diff import show_diff_trees
3810
result_tree = self._get_preview(merger, cleanups)
3811
show_diff_trees(merger.this_tree, result_tree, self.outf,
3812
old_label='', new_label='')
3814
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3815
merger.change_reporter = change_reporter
3816
conflict_count = merger.do_merge()
3818
merger.set_pending()
3819
if verified == 'failed':
3820
warning('Preview patch does not match changes')
3821
if conflict_count != 0:
3826
def _do_interactive(self, merger, cleanups):
3827
"""Perform an interactive merge.
3829
This works by generating a preview tree of the merge, then using
3830
Shelver to selectively remove the differences between the working tree
3831
and the preview tree.
3833
from bzrlib import shelf_ui
3834
result_tree = self._get_preview(merger, cleanups)
3835
writer = bzrlib.option.diff_writer_registry.get()
3836
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3837
reporter=shelf_ui.ApplyReporter(),
3838
diff_writer=writer(sys.stdout))
3841
def sanity_check_merger(self, merger):
3842
if (merger.show_base and
3843
not merger.merge_type is _mod_merge.Merge3Merger):
3844
raise errors.BzrCommandError("Show-base is not supported for this"
3845
" merge type. %s" % merger.merge_type)
3846
if merger.reprocess is None:
3847
if merger.show_base:
3848
merger.reprocess = False
3850
# Use reprocess if the merger supports it
3851
merger.reprocess = merger.merge_type.supports_reprocess
3852
if merger.reprocess and not merger.merge_type.supports_reprocess:
3853
raise errors.BzrCommandError("Conflict reduction is not supported"
3854
" for merge type %s." %
3856
if merger.reprocess and merger.show_base:
3857
raise errors.BzrCommandError("Cannot do conflict reduction and"
3860
def _get_merger_from_branch(self, tree, location, revision, remember,
3861
possible_transports, pb):
3862
"""Produce a merger from a location, assuming it refers to a branch."""
3863
from bzrlib.tag import _merge_tags_if_possible
3864
# find the branch locations
3865
other_loc, user_location = self._select_branch_location(tree, location,
3867
if revision is not None and len(revision) == 2:
3868
base_loc, _unused = self._select_branch_location(tree,
3869
location, revision, 0)
3871
base_loc = other_loc
3873
other_branch, other_path = Branch.open_containing(other_loc,
3874
possible_transports)
3875
if base_loc == other_loc:
3876
base_branch = other_branch
3878
base_branch, base_path = Branch.open_containing(base_loc,
3879
possible_transports)
3880
# Find the revision ids
3881
other_revision_id = None
3882
base_revision_id = None
3883
if revision is not None:
3884
if len(revision) >= 1:
3885
other_revision_id = revision[-1].as_revision_id(other_branch)
3886
if len(revision) == 2:
3887
base_revision_id = revision[0].as_revision_id(base_branch)
3888
if other_revision_id is None:
3889
other_revision_id = _mod_revision.ensure_null(
3890
other_branch.last_revision())
3891
# Remember where we merge from
3892
if ((remember or tree.branch.get_submit_branch() is None) and
3893
user_location is not None):
3894
tree.branch.set_submit_branch(other_branch.base)
3895
_merge_tags_if_possible(other_branch, tree.branch)
3896
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3897
other_revision_id, base_revision_id, other_branch, base_branch)
3898
if other_path != '':
3899
allow_pending = False
3900
merger.interesting_files = [other_path]
3902
allow_pending = True
3903
return merger, allow_pending
3905
def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3906
"""Get a merger for uncommitted changes.
3908
:param tree: The tree the merger should apply to.
3909
:param location: The location containing uncommitted changes.
3910
:param pb: The progress bar to use for showing progress.
3911
:param cleanups: A list of operations to perform to clean up the
3912
temporary directories, unfinalized objects, etc.
3914
location = self._select_branch_location(tree, location)[0]
3915
other_tree, other_path = WorkingTree.open_containing(location)
3916
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3917
if other_path != '':
3918
merger.interesting_files = [other_path]
3921
def _select_branch_location(self, tree, user_location, revision=None,
3923
"""Select a branch location, according to possible inputs.
3925
If provided, branches from ``revision`` are preferred. (Both
3926
``revision`` and ``index`` must be supplied.)
3928
Otherwise, the ``location`` parameter is used. If it is None, then the
3929
``submit`` or ``parent`` location is used, and a note is printed.
3931
:param tree: The working tree to select a branch for merging into
3932
:param location: The location entered by the user
3933
:param revision: The revision parameter to the command
3934
:param index: The index to use for the revision parameter. Negative
3935
indices are permitted.
3936
:return: (selected_location, user_location). The default location
3937
will be the user-entered location.
3939
if (revision is not None and index is not None
3940
and revision[index] is not None):
3941
branch = revision[index].get_branch()
3942
if branch is not None:
3943
return branch, branch
3944
if user_location is None:
3945
location = self._get_remembered(tree, 'Merging from')
3947
location = user_location
3948
return location, user_location
3950
def _get_remembered(self, tree, verb_string):
3951
"""Use tree.branch's parent if none was supplied.
3953
Report if the remembered location was used.
3955
stored_location = tree.branch.get_submit_branch()
3956
stored_location_type = "submit"
3957
if stored_location is None:
3958
stored_location = tree.branch.get_parent()
3959
stored_location_type = "parent"
3960
mutter("%s", stored_location)
3961
if stored_location is None:
3962
raise errors.BzrCommandError("No location specified or remembered")
3963
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3964
note(u"%s remembered %s location %s", verb_string,
3965
stored_location_type, display_url)
3966
return stored_location
3969
class cmd_remerge(Command):
3972
Use this if you want to try a different merge technique while resolving
3973
conflicts. Some merge techniques are better than others, and remerge
3974
lets you try different ones on different files.
3976
The options for remerge have the same meaning and defaults as the ones for
3977
merge. The difference is that remerge can (only) be run when there is a
3978
pending merge, and it lets you specify particular files.
3981
Re-do the merge of all conflicted files, and show the base text in
3982
conflict regions, in addition to the usual THIS and OTHER texts::
3984
bzr remerge --show-base
3986
Re-do the merge of "foobar", using the weave merge algorithm, with
3987
additional processing to reduce the size of conflict regions::
3989
bzr remerge --merge-type weave --reprocess foobar
3991
takes_args = ['file*']
3996
help="Show base revision text in conflicts."),
3999
def run(self, file_list=None, merge_type=None, show_base=False,
4001
if merge_type is None:
4002
merge_type = _mod_merge.Merge3Merger
4003
tree, file_list = tree_files(file_list)
4006
parents = tree.get_parent_ids()
4007
if len(parents) != 2:
4008
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4009
" merges. Not cherrypicking or"
4011
repository = tree.branch.repository
4012
interesting_ids = None
4014
conflicts = tree.conflicts()
4015
if file_list is not None:
4016
interesting_ids = set()
4017
for filename in file_list:
4018
file_id = tree.path2id(filename)
4020
raise errors.NotVersionedError(filename)
4021
interesting_ids.add(file_id)
4022
if tree.kind(file_id) != "directory":
4025
for name, ie in tree.inventory.iter_entries(file_id):
4026
interesting_ids.add(ie.file_id)
4027
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4029
# Remerge only supports resolving contents conflicts
4030
allowed_conflicts = ('text conflict', 'contents conflict')
4031
restore_files = [c.path for c in conflicts
4032
if c.typestring in allowed_conflicts]
4033
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4034
tree.set_conflicts(ConflictList(new_conflicts))
4035
if file_list is not None:
4036
restore_files = file_list
4037
for filename in restore_files:
4039
restore(tree.abspath(filename))
4040
except errors.NotConflicted:
4042
# Disable pending merges, because the file texts we are remerging
4043
# have not had those merges performed. If we use the wrong parents
4044
# list, we imply that the working tree text has seen and rejected
4045
# all the changes from the other tree, when in fact those changes
4046
# have not yet been seen.
4047
pb = ui.ui_factory.nested_progress_bar()
4048
tree.set_parent_ids(parents[:1])
4050
merger = _mod_merge.Merger.from_revision_ids(pb,
4052
merger.interesting_ids = interesting_ids
4053
merger.merge_type = merge_type
4054
merger.show_base = show_base
4055
merger.reprocess = reprocess
4056
conflicts = merger.do_merge()
4058
tree.set_parent_ids(parents)
4068
class cmd_revert(Command):
4069
"""Revert files to a previous revision.
4071
Giving a list of files will revert only those files. Otherwise, all files
4072
will be reverted. If the revision is not specified with '--revision', the
4073
last committed revision is used.
4075
To remove only some changes, without reverting to a prior version, use
4076
merge instead. For example, "merge . --revision -2..-3" will remove the
4077
changes introduced by -2, without affecting the changes introduced by -1.
4078
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4080
By default, any files that have been manually changed will be backed up
4081
first. (Files changed only by merge are not backed up.) Backup files have
4082
'.~#~' appended to their name, where # is a number.
4084
When you provide files, you can use their current pathname or the pathname
4085
from the target revision. So you can use revert to "undelete" a file by
4086
name. If you name a directory, all the contents of that directory will be
4089
If you have newly added files since the target revision, they will be
4090
removed. If the files to be removed have been changed, backups will be
4091
created as above. Directories containing unknown files will not be
4094
The working tree contains a list of pending merged revisions, which will
4095
be included as parents in the next commit. Normally, revert clears that
4096
list as well as reverting the files. If any files are specified, revert
4097
leaves the pending merge list alone and reverts only the files. Use "bzr
4098
revert ." in the tree root to revert all files but keep the merge record,
4099
and "bzr revert --forget-merges" to clear the pending merge list without
4100
reverting any files.
4102
Using "bzr revert --forget-merges", it is possible to apply the changes
4103
from an arbitrary merge as a single revision. To do this, perform the
4104
merge as desired. Then doing revert with the "--forget-merges" option will
4105
keep the content of the tree as it was, but it will clear the list of
4106
pending merges. The next commit will then contain all of the changes that
4107
would have been in the merge, but without any mention of the other parent
4108
revisions. Because this technique forgets where these changes originated,
4109
it may cause additional conflicts on later merges involving the source and
4113
_see_also = ['cat', 'export']
4116
Option('no-backup', "Do not save backups of reverted files."),
4117
Option('forget-merges',
4118
'Remove pending merge marker, without changing any files.'),
4120
takes_args = ['file*']
4122
def run(self, revision=None, no_backup=False, file_list=None,
4123
forget_merges=None):
4124
tree, file_list = tree_files(file_list)
4128
tree.set_parent_ids(tree.get_parent_ids()[:1])
4130
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4135
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4136
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4137
pb = ui.ui_factory.nested_progress_bar()
4139
tree.revert(file_list, rev_tree, not no_backup, pb,
4140
report_changes=True)
4145
class cmd_assert_fail(Command):
4146
"""Test reporting of assertion failures"""
4147
# intended just for use in testing
4152
raise AssertionError("always fails")
4155
class cmd_help(Command):
4156
"""Show help on a command or other topic.
4159
_see_also = ['topics']
4161
Option('long', 'Show help on all commands.'),
4163
takes_args = ['topic?']
4164
aliases = ['?', '--help', '-?', '-h']
4167
def run(self, topic=None, long=False):
4169
if topic is None and long:
4171
bzrlib.help.help(topic)
4174
class cmd_shell_complete(Command):
4175
"""Show appropriate completions for context.
4177
For a list of all available commands, say 'bzr shell-complete'.
4179
takes_args = ['context?']
4184
def run(self, context=None):
4185
import shellcomplete
4186
shellcomplete.shellcomplete(context)
4189
class cmd_missing(Command):
4190
"""Show unmerged/unpulled revisions between two branches.
4192
OTHER_BRANCH may be local or remote.
4194
To filter on a range of revisions, you can use the command -r begin..end
4195
-r revision requests a specific revision, -r ..end or -r begin.. are
4199
1 - some missing revisions
4200
0 - no missing revisions
4204
Determine the missing revisions between this and the branch at the
4205
remembered pull location::
4209
Determine the missing revisions between this and another branch::
4211
bzr missing http://server/branch
4213
Determine the missing revisions up to a specific revision on the other
4216
bzr missing -r ..-10
4218
Determine the missing revisions up to a specific revision on this
4221
bzr missing --my-revision ..-10
4224
_see_also = ['merge', 'pull']
4225
takes_args = ['other_branch?']
4227
Option('reverse', 'Reverse the order of revisions.'),
4229
'Display changes in the local branch only.'),
4230
Option('this' , 'Same as --mine-only.'),
4231
Option('theirs-only',
4232
'Display changes in the remote branch only.'),
4233
Option('other', 'Same as --theirs-only.'),
4237
custom_help('revision',
4238
help='Filter on other branch revisions (inclusive). '
4239
'See "help revisionspec" for details.'),
4240
Option('my-revision',
4241
type=_parse_revision_str,
4242
help='Filter on local branch revisions (inclusive). '
4243
'See "help revisionspec" for details.'),
4244
Option('include-merges',
4245
'Show all revisions in addition to the mainline ones.'),
4247
encoding_type = 'replace'
4250
def run(self, other_branch=None, reverse=False, mine_only=False,
4252
log_format=None, long=False, short=False, line=False,
4253
show_ids=False, verbose=False, this=False, other=False,
4254
include_merges=False, revision=None, my_revision=None):
4255
from bzrlib.missing import find_unmerged, iter_log_revisions
4264
# TODO: We should probably check that we don't have mine-only and
4265
# theirs-only set, but it gets complicated because we also have
4266
# this and other which could be used.
4273
local_branch = Branch.open_containing(u".")[0]
4274
parent = local_branch.get_parent()
4275
if other_branch is None:
4276
other_branch = parent
4277
if other_branch is None:
4278
raise errors.BzrCommandError("No peer location known"
4280
display_url = urlutils.unescape_for_display(parent,
4282
message("Using saved parent location: "
4283
+ display_url + "\n")
4285
remote_branch = Branch.open(other_branch)
4286
if remote_branch.base == local_branch.base:
4287
remote_branch = local_branch
4289
local_revid_range = _revision_range_to_revid_range(
4290
_get_revision_range(my_revision, local_branch,
4293
remote_revid_range = _revision_range_to_revid_range(
4294
_get_revision_range(revision,
4295
remote_branch, self.name()))
4297
local_branch.lock_read()
4299
remote_branch.lock_read()
4301
local_extra, remote_extra = find_unmerged(
4302
local_branch, remote_branch, restrict,
4303
backward=not reverse,
4304
include_merges=include_merges,
4305
local_revid_range=local_revid_range,
4306
remote_revid_range=remote_revid_range)
4308
if log_format is None:
4309
registry = log.log_formatter_registry
4310
log_format = registry.get_default(local_branch)
4311
lf = log_format(to_file=self.outf,
4313
show_timezone='original')
4316
if local_extra and not theirs_only:
4317
message("You have %d extra revision(s):\n" %
4319
for revision in iter_log_revisions(local_extra,
4320
local_branch.repository,
4322
lf.log_revision(revision)
4323
printed_local = True
4326
printed_local = False
4328
if remote_extra and not mine_only:
4329
if printed_local is True:
4331
message("You are missing %d revision(s):\n" %
4333
for revision in iter_log_revisions(remote_extra,
4334
remote_branch.repository,
4336
lf.log_revision(revision)
4339
if mine_only and not local_extra:
4340
# We checked local, and found nothing extra
4341
message('This branch is up to date.\n')
4342
elif theirs_only and not remote_extra:
4343
# We checked remote, and found nothing extra
4344
message('Other branch is up to date.\n')
4345
elif not (mine_only or theirs_only or local_extra or
4347
# We checked both branches, and neither one had extra
4349
message("Branches are up to date.\n")
4351
remote_branch.unlock()
4353
local_branch.unlock()
4354
if not status_code and parent is None and other_branch is not None:
4355
local_branch.lock_write()
4357
# handle race conditions - a parent might be set while we run.
4358
if local_branch.get_parent() is None:
4359
local_branch.set_parent(remote_branch.base)
4361
local_branch.unlock()
4365
class cmd_pack(Command):
4366
"""Compress the data within a repository."""
4368
_see_also = ['repositories']
4369
takes_args = ['branch_or_repo?']
4371
def run(self, branch_or_repo='.'):
4372
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4374
branch = dir.open_branch()
4375
repository = branch.repository
4376
except errors.NotBranchError:
4377
repository = dir.open_repository()
4381
class cmd_plugins(Command):
4382
"""List the installed plugins.
4384
This command displays the list of installed plugins including
4385
version of plugin and a short description of each.
4387
--verbose shows the path where each plugin is located.
4389
A plugin is an external component for Bazaar that extends the
4390
revision control system, by adding or replacing code in Bazaar.
4391
Plugins can do a variety of things, including overriding commands,
4392
adding new commands, providing additional network transports and
4393
customizing log output.
4395
See the Bazaar web site, http://bazaar-vcs.org, for further
4396
information on plugins including where to find them and how to
4397
install them. Instructions are also provided there on how to
4398
write new plugins using the Python programming language.
4400
takes_options = ['verbose']
4403
def run(self, verbose=False):
4404
import bzrlib.plugin
4405
from inspect import getdoc
4407
for name, plugin in bzrlib.plugin.plugins().items():
4408
version = plugin.__version__
4409
if version == 'unknown':
4411
name_ver = '%s %s' % (name, version)
4412
d = getdoc(plugin.module)
4414
doc = d.split('\n')[0]
4416
doc = '(no description)'
4417
result.append((name_ver, doc, plugin.path()))
4418
for name_ver, doc, path in sorted(result):
4426
class cmd_testament(Command):
4427
"""Show testament (signing-form) of a revision."""
4430
Option('long', help='Produce long-format testament.'),
4432
help='Produce a strict-format testament.')]
4433
takes_args = ['branch?']
4435
def run(self, branch=u'.', revision=None, long=False, strict=False):
4436
from bzrlib.testament import Testament, StrictTestament
4438
testament_class = StrictTestament
4440
testament_class = Testament
4442
b = Branch.open_containing(branch)[0]
4444
b = Branch.open(branch)
4447
if revision is None:
4448
rev_id = b.last_revision()
4450
rev_id = revision[0].as_revision_id(b)
4451
t = testament_class.from_revision(b.repository, rev_id)
4453
sys.stdout.writelines(t.as_text_lines())
4455
sys.stdout.write(t.as_short_text())
4460
class cmd_annotate(Command):
4461
"""Show the origin of each line in a file.
4463
This prints out the given file with an annotation on the left side
4464
indicating which revision, author and date introduced the change.
4466
If the origin is the same for a run of consecutive lines, it is
4467
shown only at the top, unless the --all option is given.
4469
# TODO: annotate directories; showing when each file was last changed
4470
# TODO: if the working copy is modified, show annotations on that
4471
# with new uncommitted lines marked
4472
aliases = ['ann', 'blame', 'praise']
4473
takes_args = ['filename']
4474
takes_options = [Option('all', help='Show annotations on all lines.'),
4475
Option('long', help='Show commit date in annotations.'),
4479
encoding_type = 'exact'
4482
def run(self, filename, all=False, long=False, revision=None,
4484
from bzrlib.annotate import annotate_file, annotate_file_tree
4485
wt, branch, relpath = \
4486
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4492
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4494
file_id = wt.path2id(relpath)
4496
file_id = tree.path2id(relpath)
4498
raise errors.NotVersionedError(filename)
4499
file_version = tree.inventory[file_id].revision
4500
if wt is not None and revision is None:
4501
# If there is a tree and we're not annotating historical
4502
# versions, annotate the working tree's content.
4503
annotate_file_tree(wt, file_id, self.outf, long, all,
4506
annotate_file(branch, file_version, file_id, long, all, self.outf,
4515
class cmd_re_sign(Command):
4516
"""Create a digital signature for an existing revision."""
4517
# TODO be able to replace existing ones.
4519
hidden = True # is this right ?
4520
takes_args = ['revision_id*']
4521
takes_options = ['revision']
4523
def run(self, revision_id_list=None, revision=None):
4524
if revision_id_list is not None and revision is not None:
4525
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4526
if revision_id_list is None and revision is None:
4527
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4528
b = WorkingTree.open_containing(u'.')[0].branch
4531
return self._run(b, revision_id_list, revision)
4535
def _run(self, b, revision_id_list, revision):
4536
import bzrlib.gpg as gpg
4537
gpg_strategy = gpg.GPGStrategy(b.get_config())
4538
if revision_id_list is not None:
4539
b.repository.start_write_group()
4541
for revision_id in revision_id_list:
4542
b.repository.sign_revision(revision_id, gpg_strategy)
4544
b.repository.abort_write_group()
4547
b.repository.commit_write_group()
4548
elif revision is not None:
4549
if len(revision) == 1:
4550
revno, rev_id = revision[0].in_history(b)
4551
b.repository.start_write_group()
4553
b.repository.sign_revision(rev_id, gpg_strategy)
4555
b.repository.abort_write_group()
4558
b.repository.commit_write_group()
4559
elif len(revision) == 2:
4560
# are they both on rh- if so we can walk between them
4561
# might be nice to have a range helper for arbitrary
4562
# revision paths. hmm.
4563
from_revno, from_revid = revision[0].in_history(b)
4564
to_revno, to_revid = revision[1].in_history(b)
4565
if to_revid is None:
4566
to_revno = b.revno()
4567
if from_revno is None or to_revno is None:
4568
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4569
b.repository.start_write_group()
4571
for revno in range(from_revno, to_revno + 1):
4572
b.repository.sign_revision(b.get_rev_id(revno),
4575
b.repository.abort_write_group()
4578
b.repository.commit_write_group()
4580
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4583
class cmd_bind(Command):
4584
"""Convert the current branch into a checkout of the supplied branch.
4586
Once converted into a checkout, commits must succeed on the master branch
4587
before they will be applied to the local branch.
4589
Bound branches use the nickname of its master branch unless it is set
4590
locally, in which case binding will update the local nickname to be
4594
_see_also = ['checkouts', 'unbind']
4595
takes_args = ['location?']
4598
def run(self, location=None):
4599
b, relpath = Branch.open_containing(u'.')
4600
if location is None:
4602
location = b.get_old_bound_location()
4603
except errors.UpgradeRequired:
4604
raise errors.BzrCommandError('No location supplied. '
4605
'This format does not remember old locations.')
4607
if location is None:
4608
raise errors.BzrCommandError('No location supplied and no '
4609
'previous location known')
4610
b_other = Branch.open(location)
4613
except errors.DivergedBranches:
4614
raise errors.BzrCommandError('These branches have diverged.'
4615
' Try merging, and then bind again.')
4616
if b.get_config().has_explicit_nickname():
4617
b.nick = b_other.nick
4620
class cmd_unbind(Command):
4621
"""Convert the current checkout into a regular branch.
4623
After unbinding, the local branch is considered independent and subsequent
4624
commits will be local only.
4627
_see_also = ['checkouts', 'bind']
4632
b, relpath = Branch.open_containing(u'.')
4634
raise errors.BzrCommandError('Local branch is not bound')
4637
class cmd_uncommit(Command):
4638
"""Remove the last committed revision.
4640
--verbose will print out what is being removed.
4641
--dry-run will go through all the motions, but not actually
4644
If --revision is specified, uncommit revisions to leave the branch at the
4645
specified revision. For example, "bzr uncommit -r 15" will leave the
4646
branch at revision 15.
4648
Uncommit leaves the working tree ready for a new commit. The only change
4649
it may make is to restore any pending merges that were present before
4653
# TODO: jam 20060108 Add an option to allow uncommit to remove
4654
# unreferenced information in 'branch-as-repository' branches.
4655
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4656
# information in shared branches as well.
4657
_see_also = ['commit']
4658
takes_options = ['verbose', 'revision',
4659
Option('dry-run', help='Don\'t actually make changes.'),
4660
Option('force', help='Say yes to all questions.'),
4662
help="Only remove the commits from the local branch"
4663
" when in a checkout."
4666
takes_args = ['location?']
4668
encoding_type = 'replace'
4670
def run(self, location=None,
4671
dry_run=False, verbose=False,
4672
revision=None, force=False, local=False):
4673
if location is None:
4675
control, relpath = bzrdir.BzrDir.open_containing(location)
4677
tree = control.open_workingtree()
4679
except (errors.NoWorkingTree, errors.NotLocalUrl):
4681
b = control.open_branch()
4683
if tree is not None:
4688
return self._run(b, tree, dry_run, verbose, revision, force,
4691
if tree is not None:
4696
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4697
from bzrlib.log import log_formatter, show_log
4698
from bzrlib.uncommit import uncommit
4700
last_revno, last_rev_id = b.last_revision_info()
4703
if revision is None:
4705
rev_id = last_rev_id
4707
# 'bzr uncommit -r 10' actually means uncommit
4708
# so that the final tree is at revno 10.
4709
# but bzrlib.uncommit.uncommit() actually uncommits
4710
# the revisions that are supplied.
4711
# So we need to offset it by one
4712
revno = revision[0].in_history(b).revno + 1
4713
if revno <= last_revno:
4714
rev_id = b.get_rev_id(revno)
4716
if rev_id is None or _mod_revision.is_null(rev_id):
4717
self.outf.write('No revisions to uncommit.\n')
4720
lf = log_formatter('short',
4722
show_timezone='original')
4727
direction='forward',
4728
start_revision=revno,
4729
end_revision=last_revno)
4732
print 'Dry-run, pretending to remove the above revisions.'
4734
val = raw_input('Press <enter> to continue')
4736
print 'The above revision(s) will be removed.'
4738
val = raw_input('Are you sure [y/N]? ')
4739
if val.lower() not in ('y', 'yes'):
4743
mutter('Uncommitting from {%s} to {%s}',
4744
last_rev_id, rev_id)
4745
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4746
revno=revno, local=local)
4747
note('You can restore the old tip by running:\n'
4748
' bzr pull . -r revid:%s', last_rev_id)
4751
class cmd_break_lock(Command):
4752
"""Break a dead lock on a repository, branch or working directory.
4754
CAUTION: Locks should only be broken when you are sure that the process
4755
holding the lock has been stopped.
4757
You can get information on what locks are open via the 'bzr info' command.
4762
takes_args = ['location?']
4764
def run(self, location=None, show=False):
4765
if location is None:
4767
control, relpath = bzrdir.BzrDir.open_containing(location)
4769
control.break_lock()
4770
except NotImplementedError:
4774
class cmd_wait_until_signalled(Command):
4775
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4777
This just prints a line to signal when it is ready, then blocks on stdin.
4783
sys.stdout.write("running\n")
4785
sys.stdin.readline()
4788
class cmd_serve(Command):
4789
"""Run the bzr server."""
4791
aliases = ['server']
4795
help='Serve on stdin/out for use from inetd or sshd.'),
4796
RegistryOption('protocol',
4797
help="Protocol to serve.",
4798
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4799
value_switches=True),
4801
help='Listen for connections on nominated port of the form '
4802
'[hostname:]portnumber. Passing 0 as the port number will '
4803
'result in a dynamically allocated port. The default port '
4804
'depends on the protocol.',
4807
help='Serve contents of this directory.',
4809
Option('allow-writes',
4810
help='By default the server is a readonly server. Supplying '
4811
'--allow-writes enables write access to the contents of '
4812
'the served directory and below. Note that ``bzr serve`` '
4813
'does not perform authentication, so unless some form of '
4814
'external authentication is arranged supplying this '
4815
'option leads to global uncontrolled write access to your '
4820
def get_host_and_port(self, port):
4821
"""Return the host and port to run the smart server on.
4823
If 'port' is None, None will be returned for the host and port.
4825
If 'port' has a colon in it, the string before the colon will be
4826
interpreted as the host.
4828
:param port: A string of the port to run the server on.
4829
:return: A tuple of (host, port), where 'host' is a host name or IP,
4830
and port is an integer TCP/IP port.
4833
if port is not None:
4835
host, port = port.split(':')
4839
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4841
from bzrlib.transport import get_transport, transport_server_registry
4842
if directory is None:
4843
directory = os.getcwd()
4844
if protocol is None:
4845
protocol = transport_server_registry.get()
4846
host, port = self.get_host_and_port(port)
4847
url = urlutils.local_path_to_url(directory)
4848
if not allow_writes:
4849
url = 'readonly+' + url
4850
transport = get_transport(url)
4851
protocol(transport, host, port, inet)
4854
class cmd_join(Command):
4855
"""Combine a tree into its containing tree.
4857
This command requires the target tree to be in a rich-root format.
4859
The TREE argument should be an independent tree, inside another tree, but
4860
not part of it. (Such trees can be produced by "bzr split", but also by
4861
running "bzr branch" with the target inside a tree.)
4863
The result is a combined tree, with the subtree no longer an independant
4864
part. This is marked as a merge of the subtree into the containing tree,
4865
and all history is preserved.
4868
_see_also = ['split']
4869
takes_args = ['tree']
4871
Option('reference', help='Join by reference.', hidden=True),
4874
def run(self, tree, reference=False):
4875
sub_tree = WorkingTree.open(tree)
4876
parent_dir = osutils.dirname(sub_tree.basedir)
4877
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4878
repo = containing_tree.branch.repository
4879
if not repo.supports_rich_root():
4880
raise errors.BzrCommandError(
4881
"Can't join trees because %s doesn't support rich root data.\n"
4882
"You can use bzr upgrade on the repository."
4886
containing_tree.add_reference(sub_tree)
4887
except errors.BadReferenceTarget, e:
4888
# XXX: Would be better to just raise a nicely printable
4889
# exception from the real origin. Also below. mbp 20070306
4890
raise errors.BzrCommandError("Cannot join %s. %s" %
4894
containing_tree.subsume(sub_tree)
4895
except errors.BadSubsumeSource, e:
4896
raise errors.BzrCommandError("Cannot join %s. %s" %
4900
class cmd_split(Command):
4901
"""Split a subdirectory of a tree into a separate tree.
4903
This command will produce a target tree in a format that supports
4904
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4905
converted into earlier formats like 'dirstate-tags'.
4907
The TREE argument should be a subdirectory of a working tree. That
4908
subdirectory will be converted into an independent tree, with its own
4909
branch. Commits in the top-level tree will not apply to the new subtree.
4912
_see_also = ['join']
4913
takes_args = ['tree']
4915
def run(self, tree):
4916
containing_tree, subdir = WorkingTree.open_containing(tree)
4917
sub_id = containing_tree.path2id(subdir)
4919
raise errors.NotVersionedError(subdir)
4921
containing_tree.extract(sub_id)
4922
except errors.RootNotRich:
4923
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4926
class cmd_merge_directive(Command):
4927
"""Generate a merge directive for auto-merge tools.
4929
A directive requests a merge to be performed, and also provides all the
4930
information necessary to do so. This means it must either include a
4931
revision bundle, or the location of a branch containing the desired
4934
A submit branch (the location to merge into) must be supplied the first
4935
time the command is issued. After it has been supplied once, it will
4936
be remembered as the default.
4938
A public branch is optional if a revision bundle is supplied, but required
4939
if --diff or --plain is specified. It will be remembered as the default
4940
after the first use.
4943
takes_args = ['submit_branch?', 'public_branch?']
4947
_see_also = ['send']
4950
RegistryOption.from_kwargs('patch-type',
4951
'The type of patch to include in the directive.',
4953
value_switches=True,
4955
bundle='Bazaar revision bundle (default).',
4956
diff='Normal unified diff.',
4957
plain='No patch, just directive.'),
4958
Option('sign', help='GPG-sign the directive.'), 'revision',
4959
Option('mail-to', type=str,
4960
help='Instead of printing the directive, email to this address.'),
4961
Option('message', type=str, short_name='m',
4962
help='Message to use when committing this merge.')
4965
encoding_type = 'exact'
4967
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4968
sign=False, revision=None, mail_to=None, message=None):
4969
from bzrlib.revision import ensure_null, NULL_REVISION
4970
include_patch, include_bundle = {
4971
'plain': (False, False),
4972
'diff': (True, False),
4973
'bundle': (True, True),
4975
branch = Branch.open('.')
4976
stored_submit_branch = branch.get_submit_branch()
4977
if submit_branch is None:
4978
submit_branch = stored_submit_branch
4980
if stored_submit_branch is None:
4981
branch.set_submit_branch(submit_branch)
4982
if submit_branch is None:
4983
submit_branch = branch.get_parent()
4984
if submit_branch is None:
4985
raise errors.BzrCommandError('No submit branch specified or known')
4987
stored_public_branch = branch.get_public_branch()
4988
if public_branch is None:
4989
public_branch = stored_public_branch
4990
elif stored_public_branch is None:
4991
branch.set_public_branch(public_branch)
4992
if not include_bundle and public_branch is None:
4993
raise errors.BzrCommandError('No public branch specified or'
4995
base_revision_id = None
4996
if revision is not None:
4997
if len(revision) > 2:
4998
raise errors.BzrCommandError('bzr merge-directive takes '
4999
'at most two one revision identifiers')
5000
revision_id = revision[-1].as_revision_id(branch)
5001
if len(revision) == 2:
5002
base_revision_id = revision[0].as_revision_id(branch)
5004
revision_id = branch.last_revision()
5005
revision_id = ensure_null(revision_id)
5006
if revision_id == NULL_REVISION:
5007
raise errors.BzrCommandError('No revisions to bundle.')
5008
directive = merge_directive.MergeDirective2.from_objects(
5009
branch.repository, revision_id, time.time(),
5010
osutils.local_time_offset(), submit_branch,
5011
public_branch=public_branch, include_patch=include_patch,
5012
include_bundle=include_bundle, message=message,
5013
base_revision_id=base_revision_id)
5016
self.outf.write(directive.to_signed(branch))
5018
self.outf.writelines(directive.to_lines())
5020
message = directive.to_email(mail_to, branch, sign)
5021
s = SMTPConnection(branch.get_config())
5022
s.send_email(message)
5025
class cmd_send(Command):
5026
"""Mail or create a merge-directive for submitting changes.
5028
A merge directive provides many things needed for requesting merges:
5030
* A machine-readable description of the merge to perform
5032
* An optional patch that is a preview of the changes requested
5034
* An optional bundle of revision data, so that the changes can be applied
5035
directly from the merge directive, without retrieving data from a
5038
If --no-bundle is specified, then public_branch is needed (and must be
5039
up-to-date), so that the receiver can perform the merge using the
5040
public_branch. The public_branch is always included if known, so that
5041
people can check it later.
5043
The submit branch defaults to the parent, but can be overridden. Both
5044
submit branch and public branch will be remembered if supplied.
5046
If a public_branch is known for the submit_branch, that public submit
5047
branch is used in the merge instructions. This means that a local mirror
5048
can be used as your actual submit branch, once you have set public_branch
5051
Mail is sent using your preferred mail program. This should be transparent
5052
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5053
If the preferred client can't be found (or used), your editor will be used.
5055
To use a specific mail program, set the mail_client configuration option.
5056
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5057
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5058
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5059
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5062
If mail is being sent, a to address is required. This can be supplied
5063
either on the commandline, by setting the submit_to configuration
5064
option in the branch itself or the child_submit_to configuration option
5065
in the submit branch.
5067
Two formats are currently supported: "4" uses revision bundle format 4 and
5068
merge directive format 2. It is significantly faster and smaller than
5069
older formats. It is compatible with Bazaar 0.19 and later. It is the
5070
default. "0.9" uses revision bundle format 0.9 and merge directive
5071
format 1. It is compatible with Bazaar 0.12 - 0.18.
5073
The merge directives created by bzr send may be applied using bzr merge or
5074
bzr pull by specifying a file containing a merge directive as the location.
5077
encoding_type = 'exact'
5079
_see_also = ['merge', 'pull']
5081
takes_args = ['submit_branch?', 'public_branch?']
5085
help='Do not include a bundle in the merge directive.'),
5086
Option('no-patch', help='Do not include a preview patch in the merge'
5089
help='Remember submit and public branch.'),
5091
help='Branch to generate the submission from, '
5092
'rather than the one containing the working directory.',
5095
Option('output', short_name='o',
5096
help='Write merge directive to this file; '
5097
'use - for stdout.',
5100
help='Refuse to send if there are uncommitted changes in'
5101
' the working tree, --no-strict disables the check.'),
5102
Option('mail-to', help='Mail the request to this address.',
5106
Option('body', help='Body for the email.', type=unicode),
5107
RegistryOption('format',
5108
help='Use the specified output format.',
5109
lazy_registry=('bzrlib.send', 'format_registry')),
5112
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5113
no_patch=False, revision=None, remember=False, output=None,
5114
format=None, mail_to=None, message=None, body=None,
5115
strict=None, **kwargs):
5116
from bzrlib.send import send
5117
return send(submit_branch, revision, public_branch, remember,
5118
format, no_bundle, no_patch, output,
5119
kwargs.get('from', '.'), mail_to, message, body,
5124
class cmd_bundle_revisions(cmd_send):
5125
"""Create a merge-directive for submitting changes.
5127
A merge directive provides many things needed for requesting merges:
5129
* A machine-readable description of the merge to perform
5131
* An optional patch that is a preview of the changes requested
5133
* An optional bundle of revision data, so that the changes can be applied
5134
directly from the merge directive, without retrieving data from a
5137
If --no-bundle is specified, then public_branch is needed (and must be
5138
up-to-date), so that the receiver can perform the merge using the
5139
public_branch. The public_branch is always included if known, so that
5140
people can check it later.
5142
The submit branch defaults to the parent, but can be overridden. Both
5143
submit branch and public branch will be remembered if supplied.
5145
If a public_branch is known for the submit_branch, that public submit
5146
branch is used in the merge instructions. This means that a local mirror
5147
can be used as your actual submit branch, once you have set public_branch
5150
Two formats are currently supported: "4" uses revision bundle format 4 and
5151
merge directive format 2. It is significantly faster and smaller than
5152
older formats. It is compatible with Bazaar 0.19 and later. It is the
5153
default. "0.9" uses revision bundle format 0.9 and merge directive
5154
format 1. It is compatible with Bazaar 0.12 - 0.18.
5159
help='Do not include a bundle in the merge directive.'),
5160
Option('no-patch', help='Do not include a preview patch in the merge'
5163
help='Remember submit and public branch.'),
5165
help='Branch to generate the submission from, '
5166
'rather than the one containing the working directory.',
5169
Option('output', short_name='o', help='Write directive to this file.',
5172
help='Refuse to bundle revisions if there are uncommitted'
5173
' changes in the working tree, --no-strict disables the check.'),
5175
RegistryOption('format',
5176
help='Use the specified output format.',
5177
lazy_registry=('bzrlib.send', 'format_registry')),
5179
aliases = ['bundle']
5181
_see_also = ['send', 'merge']
5185
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5186
no_patch=False, revision=None, remember=False, output=None,
5187
format=None, strict=None, **kwargs):
5190
from bzrlib.send import send
5191
return send(submit_branch, revision, public_branch, remember,
5192
format, no_bundle, no_patch, output,
5193
kwargs.get('from', '.'), None, None, None,
5194
self.outf, strict=strict)
5197
class cmd_tag(Command):
5198
"""Create, remove or modify a tag naming a revision.
5200
Tags give human-meaningful names to revisions. Commands that take a -r
5201
(--revision) option can be given -rtag:X, where X is any previously
5204
Tags are stored in the branch. Tags are copied from one branch to another
5205
along when you branch, push, pull or merge.
5207
It is an error to give a tag name that already exists unless you pass
5208
--force, in which case the tag is moved to point to the new revision.
5210
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5211
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5214
_see_also = ['commit', 'tags']
5215
takes_args = ['tag_name']
5218
help='Delete this tag rather than placing it.',
5221
help='Branch in which to place the tag.',
5226
help='Replace existing tags.',
5231
def run(self, tag_name,
5237
branch, relpath = Branch.open_containing(directory)
5241
branch.tags.delete_tag(tag_name)
5242
self.outf.write('Deleted tag %s.\n' % tag_name)
5245
if len(revision) != 1:
5246
raise errors.BzrCommandError(
5247
"Tags can only be placed on a single revision, "
5249
revision_id = revision[0].as_revision_id(branch)
5251
revision_id = branch.last_revision()
5252
if (not force) and branch.tags.has_tag(tag_name):
5253
raise errors.TagAlreadyExists(tag_name)
5254
branch.tags.set_tag(tag_name, revision_id)
5255
self.outf.write('Created tag %s.\n' % tag_name)
5260
class cmd_tags(Command):
5263
This command shows a table of tag names and the revisions they reference.
5269
help='Branch whose tags should be displayed.',
5273
RegistryOption.from_kwargs('sort',
5274
'Sort tags by different criteria.', title='Sorting',
5275
alpha='Sort tags lexicographically (default).',
5276
time='Sort tags chronologically.',
5289
branch, relpath = Branch.open_containing(directory)
5291
tags = branch.tags.get_tag_dict().items()
5298
graph = branch.repository.get_graph()
5299
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5300
revid1, revid2 = rev1.rev_id, rev2.rev_id
5301
# only show revisions between revid1 and revid2 (inclusive)
5302
tags = [(tag, revid) for tag, revid in tags if
5303
graph.is_between(revid, revid1, revid2)]
5306
elif sort == 'time':
5308
for tag, revid in tags:
5310
revobj = branch.repository.get_revision(revid)
5311
except errors.NoSuchRevision:
5312
timestamp = sys.maxint # place them at the end
5314
timestamp = revobj.timestamp
5315
timestamps[revid] = timestamp
5316
tags.sort(key=lambda x: timestamps[x[1]])
5318
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5319
for index, (tag, revid) in enumerate(tags):
5321
revno = branch.revision_id_to_dotted_revno(revid)
5322
if isinstance(revno, tuple):
5323
revno = '.'.join(map(str, revno))
5324
except errors.NoSuchRevision:
5325
# Bad tag data/merges can lead to tagged revisions
5326
# which are not in this branch. Fail gracefully ...
5328
tags[index] = (tag, revno)
5331
for tag, revspec in tags:
5332
self.outf.write('%-20s %s\n' % (tag, revspec))
5335
class cmd_reconfigure(Command):
5336
"""Reconfigure the type of a bzr directory.
5338
A target configuration must be specified.
5340
For checkouts, the bind-to location will be auto-detected if not specified.
5341
The order of preference is
5342
1. For a lightweight checkout, the current bound location.
5343
2. For branches that used to be checkouts, the previously-bound location.
5344
3. The push location.
5345
4. The parent location.
5346
If none of these is available, --bind-to must be specified.
5349
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5350
takes_args = ['location?']
5352
RegistryOption.from_kwargs(
5354
title='Target type',
5355
help='The type to reconfigure the directory to.',
5356
value_switches=True, enum_switch=False,
5357
branch='Reconfigure to be an unbound branch with no working tree.',
5358
tree='Reconfigure to be an unbound branch with a working tree.',
5359
checkout='Reconfigure to be a bound branch with a working tree.',
5360
lightweight_checkout='Reconfigure to be a lightweight'
5361
' checkout (with no local history).',
5362
standalone='Reconfigure to be a standalone branch '
5363
'(i.e. stop using shared repository).',
5364
use_shared='Reconfigure to use a shared repository.',
5365
with_trees='Reconfigure repository to create '
5366
'working trees on branches by default.',
5367
with_no_trees='Reconfigure repository to not create '
5368
'working trees on branches by default.'
5370
Option('bind-to', help='Branch to bind checkout to.', type=str),
5372
help='Perform reconfiguration even if local changes'
5374
Option('stacked-on',
5375
help='Reconfigure a branch to be stacked on another branch.',
5379
help='Reconfigure a branch to be unstacked. This '
5380
'may require copying substantial data into it.',
5384
def run(self, location=None, target_type=None, bind_to=None, force=False,
5387
directory = bzrdir.BzrDir.open(location)
5388
if stacked_on and unstacked:
5389
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5390
elif stacked_on is not None:
5391
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5393
reconfigure.ReconfigureUnstacked().apply(directory)
5394
# At the moment you can use --stacked-on and a different
5395
# reconfiguration shape at the same time; there seems no good reason
5397
if target_type is None:
5398
if stacked_on or unstacked:
5401
raise errors.BzrCommandError('No target configuration '
5403
elif target_type == 'branch':
5404
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5405
elif target_type == 'tree':
5406
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5407
elif target_type == 'checkout':
5408
reconfiguration = reconfigure.Reconfigure.to_checkout(
5410
elif target_type == 'lightweight-checkout':
5411
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5413
elif target_type == 'use-shared':
5414
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5415
elif target_type == 'standalone':
5416
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5417
elif target_type == 'with-trees':
5418
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5420
elif target_type == 'with-no-trees':
5421
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5423
reconfiguration.apply(force)
5426
class cmd_switch(Command):
5427
"""Set the branch of a checkout and update.
5429
For lightweight checkouts, this changes the branch being referenced.
5430
For heavyweight checkouts, this checks that there are no local commits
5431
versus the current bound branch, then it makes the local branch a mirror
5432
of the new location and binds to it.
5434
In both cases, the working tree is updated and uncommitted changes
5435
are merged. The user can commit or revert these as they desire.
5437
Pending merges need to be committed or reverted before using switch.
5439
The path to the branch to switch to can be specified relative to the parent
5440
directory of the current branch. For example, if you are currently in a
5441
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5444
Bound branches use the nickname of its master branch unless it is set
5445
locally, in which case switching will update the local nickname to be
5449
takes_args = ['to_location']
5450
takes_options = [Option('force',
5451
help='Switch even if local commits will be lost.'),
5452
Option('create-branch', short_name='b',
5453
help='Create the target branch from this one before'
5454
' switching to it.'),
5457
def run(self, to_location, force=False, create_branch=False):
5458
from bzrlib import switch
5460
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5462
branch = control_dir.open_branch()
5463
had_explicit_nick = branch.get_config().has_explicit_nickname()
5464
except errors.NotBranchError:
5466
had_explicit_nick = False
5469
raise errors.BzrCommandError('cannot create branch without'
5471
if '/' not in to_location and '\\' not in to_location:
5472
# This path is meant to be relative to the existing branch
5473
this_url = self._get_branch_location(control_dir)
5474
to_location = urlutils.join(this_url, '..', to_location)
5475
to_branch = branch.bzrdir.sprout(to_location,
5476
possible_transports=[branch.bzrdir.root_transport],
5477
source_branch=branch).open_branch()
5479
# from_branch = control_dir.open_branch()
5480
# except errors.NotBranchError:
5481
# raise BzrCommandError('Cannot create a branch from this'
5482
# ' location when we cannot open this branch')
5483
# from_branch.bzrdir.sprout(
5487
to_branch = Branch.open(to_location)
5488
except errors.NotBranchError:
5489
this_url = self._get_branch_location(control_dir)
5490
to_branch = Branch.open(
5491
urlutils.join(this_url, '..', to_location))
5492
switch.switch(control_dir, to_branch, force)
5493
if had_explicit_nick:
5494
branch = control_dir.open_branch() #get the new branch!
5495
branch.nick = to_branch.nick
5496
note('Switched to branch: %s',
5497
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5499
def _get_branch_location(self, control_dir):
5500
"""Return location of branch for this control dir."""
5502
this_branch = control_dir.open_branch()
5503
# This may be a heavy checkout, where we want the master branch
5504
master_location = this_branch.get_bound_location()
5505
if master_location is not None:
5506
return master_location
5507
# If not, use a local sibling
5508
return this_branch.base
5509
except errors.NotBranchError:
5510
format = control_dir.find_branch_format()
5511
if getattr(format, 'get_reference', None) is not None:
5512
return format.get_reference(control_dir)
5514
return control_dir.root_transport.base
5517
class cmd_view(Command):
5518
"""Manage filtered views.
5520
Views provide a mask over the tree so that users can focus on
5521
a subset of a tree when doing their work. After creating a view,
5522
commands that support a list of files - status, diff, commit, etc -
5523
effectively have that list of files implicitly given each time.
5524
An explicit list of files can still be given but those files
5525
must be within the current view.
5527
In most cases, a view has a short life-span: it is created to make
5528
a selected change and is deleted once that change is committed.
5529
At other times, you may wish to create one or more named views
5530
and switch between them.
5532
To disable the current view without deleting it, you can switch to
5533
the pseudo view called ``off``. This can be useful when you need
5534
to see the whole tree for an operation or two (e.g. merge) but
5535
want to switch back to your view after that.
5538
To define the current view::
5540
bzr view file1 dir1 ...
5542
To list the current view::
5546
To delete the current view::
5550
To disable the current view without deleting it::
5552
bzr view --switch off
5554
To define a named view and switch to it::
5556
bzr view --name view-name file1 dir1 ...
5558
To list a named view::
5560
bzr view --name view-name
5562
To delete a named view::
5564
bzr view --name view-name --delete
5566
To switch to a named view::
5568
bzr view --switch view-name
5570
To list all views defined::
5574
To delete all views::
5576
bzr view --delete --all
5580
takes_args = ['file*']
5583
help='Apply list or delete action to all views.',
5586
help='Delete the view.',
5589
help='Name of the view to define, list or delete.',
5593
help='Name of the view to switch to.',
5598
def run(self, file_list,
5604
tree, file_list = tree_files(file_list, apply_view=False)
5605
current_view, view_dict = tree.views.get_view_info()
5610
raise errors.BzrCommandError(
5611
"Both --delete and a file list specified")
5613
raise errors.BzrCommandError(
5614
"Both --delete and --switch specified")
5616
tree.views.set_view_info(None, {})
5617
self.outf.write("Deleted all views.\n")
5619
raise errors.BzrCommandError("No current view to delete")
5621
tree.views.delete_view(name)
5622
self.outf.write("Deleted '%s' view.\n" % name)
5625
raise errors.BzrCommandError(
5626
"Both --switch and a file list specified")
5628
raise errors.BzrCommandError(
5629
"Both --switch and --all specified")
5630
elif switch == 'off':
5631
if current_view is None:
5632
raise errors.BzrCommandError("No current view to disable")
5633
tree.views.set_view_info(None, view_dict)
5634
self.outf.write("Disabled '%s' view.\n" % (current_view))
5636
tree.views.set_view_info(switch, view_dict)
5637
view_str = views.view_display_str(tree.views.lookup_view())
5638
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5641
self.outf.write('Views defined:\n')
5642
for view in sorted(view_dict):
5643
if view == current_view:
5647
view_str = views.view_display_str(view_dict[view])
5648
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5650
self.outf.write('No views defined.\n')
5653
# No name given and no current view set
5656
raise errors.BzrCommandError(
5657
"Cannot change the 'off' pseudo view")
5658
tree.views.set_view(name, sorted(file_list))
5659
view_str = views.view_display_str(tree.views.lookup_view())
5660
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5664
# No name given and no current view set
5665
self.outf.write('No current view.\n')
5667
view_str = views.view_display_str(tree.views.lookup_view(name))
5668
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5671
class cmd_hooks(Command):
5677
for hook_key in sorted(hooks.known_hooks.keys()):
5678
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5679
self.outf.write("%s:\n" % type(some_hooks).__name__)
5680
for hook_name, hook_point in sorted(some_hooks.items()):
5681
self.outf.write(" %s:\n" % (hook_name,))
5682
found_hooks = list(hook_point)
5684
for hook in found_hooks:
5685
self.outf.write(" %s\n" %
5686
(some_hooks.get_hook_name(hook),))
5688
self.outf.write(" <no hooks installed>\n")
5691
class cmd_shelve(Command):
5692
"""Temporarily set aside some changes from the current tree.
5694
Shelve allows you to temporarily put changes you've made "on the shelf",
5695
ie. out of the way, until a later time when you can bring them back from
5696
the shelf with the 'unshelve' command. The changes are stored alongside
5697
your working tree, and so they aren't propagated along with your branch nor
5698
will they survive its deletion.
5700
If shelve --list is specified, previously-shelved changes are listed.
5702
Shelve is intended to help separate several sets of changes that have
5703
been inappropriately mingled. If you just want to get rid of all changes
5704
and you don't need to restore them later, use revert. If you want to
5705
shelve all text changes at once, use shelve --all.
5707
If filenames are specified, only the changes to those files will be
5708
shelved. Other files will be left untouched.
5710
If a revision is specified, changes since that revision will be shelved.
5712
You can put multiple items on the shelf, and by default, 'unshelve' will
5713
restore the most recently shelved changes.
5716
takes_args = ['file*']
5720
Option('all', help='Shelve all changes.'),
5722
RegistryOption('writer', 'Method to use for writing diffs.',
5723
bzrlib.option.diff_writer_registry,
5724
value_switches=True, enum_switch=False),
5726
Option('list', help='List shelved changes.'),
5728
help='Destroy removed changes instead of shelving them.'),
5730
_see_also = ['unshelve']
5732
def run(self, revision=None, all=False, file_list=None, message=None,
5733
writer=None, list=False, destroy=False):
5735
return self.run_for_list()
5736
from bzrlib.shelf_ui import Shelver
5738
writer = bzrlib.option.diff_writer_registry.get()
5740
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5741
file_list, message, destroy=destroy)
5746
except errors.UserAbort:
5749
def run_for_list(self):
5750
tree = WorkingTree.open_containing('.')[0]
5753
manager = tree.get_shelf_manager()
5754
shelves = manager.active_shelves()
5755
if len(shelves) == 0:
5756
note('No shelved changes.')
5758
for shelf_id in reversed(shelves):
5759
message = manager.get_metadata(shelf_id).get('message')
5761
message = '<no message>'
5762
self.outf.write('%3d: %s\n' % (shelf_id, message))
5768
class cmd_unshelve(Command):
5769
"""Restore shelved changes.
5771
By default, the most recently shelved changes are restored. However if you
5772
specify a shelf by id those changes will be restored instead. This works
5773
best when the changes don't depend on each other.
5776
takes_args = ['shelf_id?']
5778
RegistryOption.from_kwargs(
5779
'action', help="The action to perform.",
5780
enum_switch=False, value_switches=True,
5781
apply="Apply changes and remove from the shelf.",
5782
dry_run="Show changes, but do not apply or remove them.",
5783
delete_only="Delete changes without applying them."
5786
_see_also = ['shelve']
5788
def run(self, shelf_id=None, action='apply'):
5789
from bzrlib.shelf_ui import Unshelver
5790
unshelver = Unshelver.from_args(shelf_id, action)
5794
unshelver.tree.unlock()
5797
class cmd_clean_tree(Command):
5798
"""Remove unwanted files from working tree.
5800
By default, only unknown files, not ignored files, are deleted. Versioned
5801
files are never deleted.
5803
Another class is 'detritus', which includes files emitted by bzr during
5804
normal operations and selftests. (The value of these files decreases with
5807
If no options are specified, unknown files are deleted. Otherwise, option
5808
flags are respected, and may be combined.
5810
To check what clean-tree will do, use --dry-run.
5812
takes_options = [Option('ignored', help='Delete all ignored files.'),
5813
Option('detritus', help='Delete conflict files, merge'
5814
' backups, and failed selftest dirs.'),
5816
help='Delete files unknown to bzr (default).'),
5817
Option('dry-run', help='Show files to delete instead of'
5819
Option('force', help='Do not prompt before deleting.')]
5820
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5822
from bzrlib.clean_tree import clean_tree
5823
if not (unknown or ignored or detritus):
5827
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5828
dry_run=dry_run, no_prompt=force)
5831
class cmd_reference(Command):
5832
"""list, view and set branch locations for nested trees.
5834
If no arguments are provided, lists the branch locations for nested trees.
5835
If one argument is provided, display the branch location for that tree.
5836
If two arguments are provided, set the branch location for that tree.
5841
takes_args = ['path?', 'location?']
5843
def run(self, path=None, location=None):
5845
if path is not None:
5847
tree, branch, relpath =(
5848
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5849
if path is not None:
5852
tree = branch.basis_tree()
5854
info = branch._get_all_reference_info().iteritems()
5855
self._display_reference_info(tree, branch, info)
5857
file_id = tree.path2id(path)
5859
raise errors.NotVersionedError(path)
5860
if location is None:
5861
info = [(file_id, branch.get_reference_info(file_id))]
5862
self._display_reference_info(tree, branch, info)
5864
branch.set_reference_info(file_id, path, location)
5866
def _display_reference_info(self, tree, branch, info):
5868
for file_id, (path, location) in info:
5870
path = tree.id2path(file_id)
5871
except errors.NoSuchId:
5873
ref_list.append((path, location))
5874
for path, location in sorted(ref_list):
5875
self.outf.write('%s %s\n' % (path, location))
5878
# these get imported and then picked up by the scan for cmd_*
5879
# TODO: Some more consistent way to split command definitions across files;
5880
# we do need to load at least some information about them to know of
5881
# aliases. ideally we would avoid loading the implementation until the
5882
# details were needed.
5883
from bzrlib.cmd_version_info import cmd_version_info
5884
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5885
from bzrlib.bundle.commands import (
5888
from bzrlib.foreign import cmd_dpush
5889
from bzrlib.sign_my_commits import cmd_sign_my_commits
5890
from bzrlib.weave_commands import cmd_versionedfile_list, \
5891
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
