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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
43
revision as _mod_revision,
51
from bzrlib.branch import Branch
52
from bzrlib.conflicts import ConflictList
53
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
54
from bzrlib.smtp_connection import SMTPConnection
55
from bzrlib.workingtree import WorkingTree
58
from bzrlib.commands import Command, display_command
59
from bzrlib.option import (
66
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
69
def tree_files(file_list, default_branch=u'.', canonicalize=True,
72
return internal_tree_files(file_list, default_branch, canonicalize,
74
except errors.FileInWrongBranch, e:
75
raise errors.BzrCommandError("%s is not in the same branch as %s" %
76
(e.path, file_list[0]))
79
def tree_files_for_add(file_list):
80
"""Add handles files a bit differently so it a custom implementation."""
82
tree = WorkingTree.open_containing(file_list[0])[0]
83
if tree.supports_views():
84
view_files = tree.views.lookup_view()
85
for filename in file_list:
86
if not osutils.is_inside_any(view_files, filename):
87
raise errors.FileOutsideView(filename, view_files)
89
tree = WorkingTree.open_containing(u'.')[0]
90
if tree.supports_views():
91
view_files = tree.views.lookup_view()
93
file_list = view_files
94
view_str = views.view_display_str(view_files)
95
note("ignoring files outside view: %s" % view_str)
96
return tree, file_list
99
def _get_one_revision(command_name, revisions):
100
if revisions is None:
102
if len(revisions) != 1:
103
raise errors.BzrCommandError(
104
'bzr %s --revision takes exactly one revision identifier' % (
109
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
112
if revisions is None:
114
rev_tree = tree.basis_tree()
116
rev_tree = branch.basis_tree()
118
revision = _get_one_revision(command_name, revisions)
119
rev_tree = revision.as_tree(branch)
123
# XXX: Bad function name; should possibly also be a class method of
124
# WorkingTree rather than a function.
125
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
127
"""Convert command-line paths to a WorkingTree and relative paths.
129
This is typically used for command-line processors that take one or
130
more filenames, and infer the workingtree that contains them.
132
The filenames given are not required to exist.
134
:param file_list: Filenames to convert.
136
:param default_branch: Fallback tree path to use if file_list is empty or
139
:param apply_view: if True and a view is set, apply it or check that
140
specified files are within it
142
:return: workingtree, [relative_paths]
144
if file_list is None or len(file_list) == 0:
145
tree = WorkingTree.open_containing(default_branch)[0]
146
if tree.supports_views() and apply_view:
147
view_files = tree.views.lookup_view()
149
file_list = view_files
150
view_str = views.view_display_str(view_files)
151
note("ignoring files outside view: %s" % view_str)
152
return tree, file_list
153
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
154
return tree, safe_relpath_files(tree, file_list, canonicalize,
155
apply_view=apply_view)
158
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
159
"""Convert file_list into a list of relpaths in tree.
161
:param tree: A tree to operate on.
162
:param file_list: A list of user provided paths or None.
163
:param apply_view: if True and a view is set, apply it or check that
164
specified files are within it
165
:return: A list of relative paths.
166
:raises errors.PathNotChild: When a provided path is in a different tree
169
if file_list is None:
171
if tree.supports_views() and apply_view:
172
view_files = tree.views.lookup_view()
176
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
177
# doesn't - fix that up here before we enter the loop.
179
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
182
for filename in file_list:
184
relpath = fixer(osutils.dereference_path(filename))
185
if view_files and not osutils.is_inside_any(view_files, relpath):
186
raise errors.FileOutsideView(filename, view_files)
187
new_list.append(relpath)
188
except errors.PathNotChild:
189
raise errors.FileInWrongBranch(tree.branch, filename)
193
def _get_view_info_for_change_reporter(tree):
194
"""Get the view information from a tree for change reporting."""
197
current_view = tree.views.get_view_info()[0]
198
if current_view is not None:
199
view_info = (current_view, tree.views.lookup_view())
200
except errors.ViewsNotSupported:
205
# TODO: Make sure no commands unconditionally use the working directory as a
206
# branch. If a filename argument is used, the first of them should be used to
207
# specify the branch. (Perhaps this can be factored out into some kind of
208
# Argument class, representing a file in a branch, where the first occurrence
211
class cmd_status(Command):
212
"""Display status summary.
214
This reports on versioned and unknown files, reporting them
215
grouped by state. Possible states are:
218
Versioned in the working copy but not in the previous revision.
221
Versioned in the previous revision but removed or deleted
225
Path of this file changed from the previous revision;
226
the text may also have changed. This includes files whose
227
parent directory was renamed.
230
Text has changed since the previous revision.
233
File kind has been changed (e.g. from file to directory).
236
Not versioned and not matching an ignore pattern.
238
To see ignored files use 'bzr ignored'. For details on the
239
changes to file texts, use 'bzr diff'.
241
Note that --short or -S gives status flags for each item, similar
242
to Subversion's status command. To get output similar to svn -q,
245
If no arguments are specified, the status of the entire working
246
directory is shown. Otherwise, only the status of the specified
247
files or directories is reported. If a directory is given, status
248
is reported for everything inside that directory.
250
Before merges are committed, the pending merge tip revisions are
251
shown. To see all pending merge revisions, use the -v option.
252
To skip the display of pending merge information altogether, use
253
the no-pending option or specify a file/directory.
255
If a revision argument is given, the status is calculated against
256
that revision, or between two revisions if two are provided.
259
# TODO: --no-recurse, --recurse options
261
takes_args = ['file*']
262
takes_options = ['show-ids', 'revision', 'change', 'verbose',
263
Option('short', help='Use short status indicators.',
265
Option('versioned', help='Only show versioned files.',
267
Option('no-pending', help='Don\'t show pending merges.',
270
aliases = ['st', 'stat']
272
encoding_type = 'replace'
273
_see_also = ['diff', 'revert', 'status-flags']
276
def run(self, show_ids=False, file_list=None, revision=None, short=False,
277
versioned=False, no_pending=False, verbose=False):
278
from bzrlib.status import show_tree_status
280
if revision and len(revision) > 2:
281
raise errors.BzrCommandError('bzr status --revision takes exactly'
282
' one or two revision specifiers')
284
tree, relfile_list = tree_files(file_list)
285
# Avoid asking for specific files when that is not needed.
286
if relfile_list == ['']:
288
# Don't disable pending merges for full trees other than '.'.
289
if file_list == ['.']:
291
# A specific path within a tree was given.
292
elif relfile_list is not None:
294
show_tree_status(tree, show_ids=show_ids,
295
specific_files=relfile_list, revision=revision,
296
to_file=self.outf, short=short, versioned=versioned,
297
show_pending=(not no_pending), verbose=verbose)
300
class cmd_cat_revision(Command):
301
"""Write out metadata for a revision.
303
The revision to print can either be specified by a specific
304
revision identifier, or you can use --revision.
308
takes_args = ['revision_id?']
309
takes_options = ['revision']
310
# cat-revision is more for frontends so should be exact
314
def run(self, revision_id=None, revision=None):
315
if revision_id is not None and revision is not None:
316
raise errors.BzrCommandError('You can only supply one of'
317
' revision_id or --revision')
318
if revision_id is None and revision is None:
319
raise errors.BzrCommandError('You must supply either'
320
' --revision or a revision_id')
321
b = WorkingTree.open_containing(u'.')[0].branch
323
# TODO: jam 20060112 should cat-revision always output utf-8?
324
if revision_id is not None:
325
revision_id = osutils.safe_revision_id(revision_id, warn=False)
327
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
328
except errors.NoSuchRevision:
329
msg = "The repository %s contains no revision %s." % (b.repository.base,
331
raise errors.BzrCommandError(msg)
332
elif revision is not None:
335
raise errors.BzrCommandError('You cannot specify a NULL'
337
rev_id = rev.as_revision_id(b)
338
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
341
class cmd_dump_btree(Command):
342
"""Dump the contents of a btree index file to stdout.
344
PATH is a btree index file, it can be any URL. This includes things like
345
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
347
By default, the tuples stored in the index file will be displayed. With
348
--raw, we will uncompress the pages, but otherwise display the raw bytes
352
# TODO: Do we want to dump the internal nodes as well?
353
# TODO: It would be nice to be able to dump the un-parsed information,
354
# rather than only going through iter_all_entries. However, this is
355
# good enough for a start
357
encoding_type = 'exact'
358
takes_args = ['path']
359
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
360
' rather than the parsed tuples.'),
363
def run(self, path, raw=False):
364
dirname, basename = osutils.split(path)
365
t = transport.get_transport(dirname)
367
self._dump_raw_bytes(t, basename)
369
self._dump_entries(t, basename)
371
def _get_index_and_bytes(self, trans, basename):
372
"""Create a BTreeGraphIndex and raw bytes."""
373
bt = btree_index.BTreeGraphIndex(trans, basename, None)
374
bytes = trans.get_bytes(basename)
375
bt._file = cStringIO.StringIO(bytes)
376
bt._size = len(bytes)
379
def _dump_raw_bytes(self, trans, basename):
382
# We need to parse at least the root node.
383
# This is because the first page of every row starts with an
384
# uncompressed header.
385
bt, bytes = self._get_index_and_bytes(trans, basename)
386
for page_idx, page_start in enumerate(xrange(0, len(bytes),
387
btree_index._PAGE_SIZE)):
388
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
389
page_bytes = bytes[page_start:page_end]
391
self.outf.write('Root node:\n')
392
header_end, data = bt._parse_header_from_bytes(page_bytes)
393
self.outf.write(page_bytes[:header_end])
395
self.outf.write('\nPage %d\n' % (page_idx,))
396
decomp_bytes = zlib.decompress(page_bytes)
397
self.outf.write(decomp_bytes)
398
self.outf.write('\n')
400
def _dump_entries(self, trans, basename):
402
st = trans.stat(basename)
403
except errors.TransportNotPossible:
404
# We can't stat, so we'll fake it because we have to do the 'get()'
406
bt, _ = self._get_index_and_bytes(trans, basename)
408
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
409
for node in bt.iter_all_entries():
410
# Node is made up of:
411
# (index, key, value, [references])
412
self.outf.write('%s\n' % (node[1:],))
415
class cmd_remove_tree(Command):
416
"""Remove the working tree from a given branch/checkout.
418
Since a lightweight checkout is little more than a working tree
419
this will refuse to run against one.
421
To re-create the working tree, use "bzr checkout".
423
_see_also = ['checkout', 'working-trees']
424
takes_args = ['location?']
427
help='Remove the working tree even if it has '
428
'uncommitted changes.'),
431
def run(self, location='.', force=False):
432
d = bzrdir.BzrDir.open(location)
435
working = d.open_workingtree()
436
except errors.NoWorkingTree:
437
raise errors.BzrCommandError("No working tree to remove")
438
except errors.NotLocalUrl:
439
raise errors.BzrCommandError("You cannot remove the working tree of a "
442
changes = working.changes_from(working.basis_tree())
443
if changes.has_changed():
444
raise errors.UncommittedChanges(working)
446
working_path = working.bzrdir.root_transport.base
447
branch_path = working.branch.bzrdir.root_transport.base
448
if working_path != branch_path:
449
raise errors.BzrCommandError("You cannot remove the working tree from "
450
"a lightweight checkout")
452
d.destroy_workingtree()
455
class cmd_revno(Command):
456
"""Show current revision number.
458
This is equal to the number of revisions on this branch.
462
takes_args = ['location?']
465
def run(self, location=u'.'):
466
self.outf.write(str(Branch.open_containing(location)[0].revno()))
467
self.outf.write('\n')
470
class cmd_revision_info(Command):
471
"""Show revision number and revision id for a given revision identifier.
474
takes_args = ['revision_info*']
478
help='Branch to examine, '
479
'rather than the one containing the working directory.',
486
def run(self, revision=None, directory=u'.', revision_info_list=[]):
489
if revision is not None:
490
revs.extend(revision)
491
if revision_info_list is not None:
492
for rev in revision_info_list:
493
revs.append(RevisionSpec.from_string(rev))
495
b = Branch.open_containing(directory)[0]
498
revs.append(RevisionSpec.from_string('-1'))
501
revision_id = rev.as_revision_id(b)
503
revno = '%4d' % (b.revision_id_to_revno(revision_id))
504
except errors.NoSuchRevision:
505
dotted_map = b.get_revision_id_to_revno_map()
506
revno = '.'.join(str(i) for i in dotted_map[revision_id])
507
print '%s %s' % (revno, revision_id)
510
class cmd_add(Command):
511
"""Add specified files or directories.
513
In non-recursive mode, all the named items are added, regardless
514
of whether they were previously ignored. A warning is given if
515
any of the named files are already versioned.
517
In recursive mode (the default), files are treated the same way
518
but the behaviour for directories is different. Directories that
519
are already versioned do not give a warning. All directories,
520
whether already versioned or not, are searched for files or
521
subdirectories that are neither versioned or ignored, and these
522
are added. This search proceeds recursively into versioned
523
directories. If no names are given '.' is assumed.
525
Therefore simply saying 'bzr add' will version all files that
526
are currently unknown.
528
Adding a file whose parent directory is not versioned will
529
implicitly add the parent, and so on up to the root. This means
530
you should never need to explicitly add a directory, they'll just
531
get added when you add a file in the directory.
533
--dry-run will show which files would be added, but not actually
536
--file-ids-from will try to use the file ids from the supplied path.
537
It looks up ids trying to find a matching parent directory with the
538
same filename, and then by pure path. This option is rarely needed
539
but can be useful when adding the same logical file into two
540
branches that will be merged later (without showing the two different
541
adds as a conflict). It is also useful when merging another project
542
into a subdirectory of this one.
544
takes_args = ['file*']
547
help="Don't recursively add the contents of directories."),
549
help="Show what would be done, but don't actually do anything."),
551
Option('file-ids-from',
553
help='Lookup file ids from this tree.'),
555
encoding_type = 'replace'
556
_see_also = ['remove']
558
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
563
if file_ids_from is not None:
565
base_tree, base_path = WorkingTree.open_containing(
567
except errors.NoWorkingTree:
568
base_branch, base_path = Branch.open_containing(
570
base_tree = base_branch.basis_tree()
572
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
573
to_file=self.outf, should_print=(not is_quiet()))
575
action = bzrlib.add.AddAction(to_file=self.outf,
576
should_print=(not is_quiet()))
579
base_tree.lock_read()
581
file_list = self._maybe_expand_globs(file_list)
582
tree, file_list = tree_files_for_add(file_list)
583
added, ignored = tree.smart_add(file_list, not
584
no_recurse, action=action, save=not dry_run)
586
if base_tree is not None:
588
if not is_quiet() and len(added) > 0:
589
self.outf.write('add completed\n')
592
for glob in sorted(ignored.keys()):
593
for path in ignored[glob]:
594
self.outf.write("ignored %s matching \"%s\"\n"
598
for glob, paths in ignored.items():
599
match_len += len(paths)
600
self.outf.write("ignored %d file(s).\n" % match_len)
601
self.outf.write("If you wish to add some of these files,"
602
" please add them by name.\n")
605
class cmd_mkdir(Command):
606
"""Create a new versioned directory.
608
This is equivalent to creating the directory and then adding it.
611
takes_args = ['dir+']
612
encoding_type = 'replace'
614
def run(self, dir_list):
617
wt, dd = WorkingTree.open_containing(d)
619
self.outf.write('added %s\n' % d)
622
class cmd_relpath(Command):
623
"""Show path of a file relative to root"""
625
takes_args = ['filename']
629
def run(self, filename):
630
# TODO: jam 20050106 Can relpath return a munged path if
631
# sys.stdout encoding cannot represent it?
632
tree, relpath = WorkingTree.open_containing(filename)
633
self.outf.write(relpath)
634
self.outf.write('\n')
637
class cmd_inventory(Command):
638
"""Show inventory of the current working copy or a revision.
640
It is possible to limit the output to a particular entry
641
type using the --kind option. For example: --kind file.
643
It is also possible to restrict the list of files to a specific
644
set. For example: bzr inventory --show-ids this/file
653
help='List entries of a particular kind: file, directory, symlink.',
656
takes_args = ['file*']
659
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
660
if kind and kind not in ['file', 'directory', 'symlink']:
661
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
663
revision = _get_one_revision('inventory', revision)
664
work_tree, file_list = tree_files(file_list)
665
work_tree.lock_read()
667
if revision is not None:
668
tree = revision.as_tree(work_tree.branch)
670
extra_trees = [work_tree]
676
if file_list is not None:
677
file_ids = tree.paths2ids(file_list, trees=extra_trees,
678
require_versioned=True)
679
# find_ids_across_trees may include some paths that don't
681
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
682
for file_id in file_ids if file_id in tree)
684
entries = tree.inventory.entries()
687
if tree is not work_tree:
690
for path, entry in entries:
691
if kind and kind != entry.kind:
694
self.outf.write('%-50s %s\n' % (path, entry.file_id))
696
self.outf.write(path)
697
self.outf.write('\n')
700
class cmd_mv(Command):
701
"""Move or rename a file.
704
bzr mv OLDNAME NEWNAME
706
bzr mv SOURCE... DESTINATION
708
If the last argument is a versioned directory, all the other names
709
are moved into it. Otherwise, there must be exactly two arguments
710
and the file is changed to a new name.
712
If OLDNAME does not exist on the filesystem but is versioned and
713
NEWNAME does exist on the filesystem but is not versioned, mv
714
assumes that the file has been manually moved and only updates
715
its internal inventory to reflect that change.
716
The same is valid when moving many SOURCE files to a DESTINATION.
718
Files cannot be moved between branches.
721
takes_args = ['names*']
722
takes_options = [Option("after", help="Move only the bzr identifier"
723
" of the file, because the file has already been moved."),
725
aliases = ['move', 'rename']
726
encoding_type = 'replace'
728
def run(self, names_list, after=False):
729
if names_list is None:
732
if len(names_list) < 2:
733
raise errors.BzrCommandError("missing file argument")
734
tree, rel_names = tree_files(names_list, canonicalize=False)
737
self._run(tree, names_list, rel_names, after)
741
def _run(self, tree, names_list, rel_names, after):
742
into_existing = osutils.isdir(names_list[-1])
743
if into_existing and len(names_list) == 2:
745
# a. case-insensitive filesystem and change case of dir
746
# b. move directory after the fact (if the source used to be
747
# a directory, but now doesn't exist in the working tree
748
# and the target is an existing directory, just rename it)
749
if (not tree.case_sensitive
750
and rel_names[0].lower() == rel_names[1].lower()):
751
into_existing = False
754
# 'fix' the case of a potential 'from'
755
from_id = tree.path2id(
756
tree.get_canonical_inventory_path(rel_names[0]))
757
if (not osutils.lexists(names_list[0]) and
758
from_id and inv.get_file_kind(from_id) == "directory"):
759
into_existing = False
762
# move into existing directory
763
# All entries reference existing inventory items, so fix them up
764
# for cicp file-systems.
765
rel_names = tree.get_canonical_inventory_paths(rel_names)
766
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
767
self.outf.write("%s => %s\n" % pair)
769
if len(names_list) != 2:
770
raise errors.BzrCommandError('to mv multiple files the'
771
' destination must be a versioned'
774
# for cicp file-systems: the src references an existing inventory
776
src = tree.get_canonical_inventory_path(rel_names[0])
777
# Find the canonical version of the destination: In all cases, the
778
# parent of the target must be in the inventory, so we fetch the
779
# canonical version from there (we do not always *use* the
780
# canonicalized tail portion - we may be attempting to rename the
782
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
783
dest_parent = osutils.dirname(canon_dest)
784
spec_tail = osutils.basename(rel_names[1])
785
# For a CICP file-system, we need to avoid creating 2 inventory
786
# entries that differ only by case. So regardless of the case
787
# we *want* to use (ie, specified by the user or the file-system),
788
# we must always choose to use the case of any existing inventory
789
# items. The only exception to this is when we are attempting a
790
# case-only rename (ie, canonical versions of src and dest are
792
dest_id = tree.path2id(canon_dest)
793
if dest_id is None or tree.path2id(src) == dest_id:
794
# No existing item we care about, so work out what case we
795
# are actually going to use.
797
# If 'after' is specified, the tail must refer to a file on disk.
799
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
801
# pathjoin with an empty tail adds a slash, which breaks
803
dest_parent_fq = tree.basedir
805
dest_tail = osutils.canonical_relpath(
807
osutils.pathjoin(dest_parent_fq, spec_tail))
809
# not 'after', so case as specified is used
810
dest_tail = spec_tail
812
# Use the existing item so 'mv' fails with AlreadyVersioned.
813
dest_tail = os.path.basename(canon_dest)
814
dest = osutils.pathjoin(dest_parent, dest_tail)
815
mutter("attempting to move %s => %s", src, dest)
816
tree.rename_one(src, dest, after=after)
817
self.outf.write("%s => %s\n" % (src, dest))
820
class cmd_pull(Command):
821
"""Turn this branch into a mirror of another branch.
823
This command only works on branches that have not diverged. Branches are
824
considered diverged if the destination branch's most recent commit is one
825
that has not been merged (directly or indirectly) into the parent.
827
If branches have diverged, you can use 'bzr merge' to integrate the changes
828
from one into the other. Once one branch has merged, the other should
829
be able to pull it again.
831
If you want to forget your local changes and just update your branch to
832
match the remote one, use pull --overwrite.
834
If there is no default location set, the first pull will set it. After
835
that, you can omit the location to use the default. To change the
836
default, use --remember. The value will only be saved if the remote
837
location can be accessed.
839
Note: The location can be specified either in the form of a branch,
840
or in the form of a path to a file containing a merge directive generated
844
_see_also = ['push', 'update', 'status-flags']
845
takes_options = ['remember', 'overwrite', 'revision',
846
custom_help('verbose',
847
help='Show logs of pulled revisions.'),
849
help='Branch to pull into, '
850
'rather than the one containing the working directory.',
855
takes_args = ['location?']
856
encoding_type = 'replace'
858
def run(self, location=None, remember=False, overwrite=False,
859
revision=None, verbose=False,
861
# FIXME: too much stuff is in the command class
864
if directory is None:
867
tree_to = WorkingTree.open_containing(directory)[0]
868
branch_to = tree_to.branch
869
except errors.NoWorkingTree:
871
branch_to = Branch.open_containing(directory)[0]
873
possible_transports = []
874
if location is not None:
876
mergeable = bundle.read_mergeable_from_url(location,
877
possible_transports=possible_transports)
878
except errors.NotABundle:
881
stored_loc = branch_to.get_parent()
883
if stored_loc is None:
884
raise errors.BzrCommandError("No pull location known or"
887
display_url = urlutils.unescape_for_display(stored_loc,
890
self.outf.write("Using saved parent location: %s\n" % display_url)
891
location = stored_loc
893
revision = _get_one_revision('pull', revision)
894
if mergeable is not None:
895
if revision is not None:
896
raise errors.BzrCommandError(
897
'Cannot use -r with merge directives or bundles')
898
mergeable.install_revisions(branch_to.repository)
899
base_revision_id, revision_id, verified = \
900
mergeable.get_merge_request(branch_to.repository)
901
branch_from = branch_to
903
branch_from = Branch.open(location,
904
possible_transports=possible_transports)
906
if branch_to.get_parent() is None or remember:
907
branch_to.set_parent(branch_from.base)
909
if revision is not None:
910
revision_id = revision.as_revision_id(branch_from)
912
branch_to.lock_write()
914
if tree_to is not None:
915
view_info = _get_view_info_for_change_reporter(tree_to)
916
change_reporter = delta._ChangeReporter(
917
unversioned_filter=tree_to.is_ignored, view_info=view_info)
918
result = tree_to.pull(branch_from, overwrite, revision_id,
920
possible_transports=possible_transports)
922
result = branch_to.pull(branch_from, overwrite, revision_id)
924
result.report(self.outf)
925
if verbose and result.old_revid != result.new_revid:
926
log.show_branch_change(branch_to, self.outf, result.old_revno,
932
class cmd_push(Command):
933
"""Update a mirror of this branch.
935
The target branch will not have its working tree populated because this
936
is both expensive, and is not supported on remote file systems.
938
Some smart servers or protocols *may* put the working tree in place in
941
This command only works on branches that have not diverged. Branches are
942
considered diverged if the destination branch's most recent commit is one
943
that has not been merged (directly or indirectly) by the source branch.
945
If branches have diverged, you can use 'bzr push --overwrite' to replace
946
the other branch completely, discarding its unmerged changes.
948
If you want to ensure you have the different changes in the other branch,
949
do a merge (see bzr help merge) from the other branch, and commit that.
950
After that you will be able to do a push without '--overwrite'.
952
If there is no default push location set, the first push will set it.
953
After that, you can omit the location to use the default. To change the
954
default, use --remember. The value will only be saved if the remote
955
location can be accessed.
958
_see_also = ['pull', 'update', 'working-trees']
959
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
960
Option('create-prefix',
961
help='Create the path leading up to the branch '
962
'if it does not already exist.'),
964
help='Branch to push from, '
965
'rather than the one containing the working directory.',
969
Option('use-existing-dir',
970
help='By default push will fail if the target'
971
' directory exists, but does not already'
972
' have a control directory. This flag will'
973
' allow push to proceed.'),
975
help='Create a stacked branch that references the public location '
976
'of the parent branch.'),
978
help='Create a stacked branch that refers to another branch '
979
'for the commit history. Only the work not present in the '
980
'referenced branch is included in the branch created.',
983
takes_args = ['location?']
984
encoding_type = 'replace'
986
def run(self, location=None, remember=False, overwrite=False,
987
create_prefix=False, verbose=False, revision=None,
988
use_existing_dir=False, directory=None, stacked_on=None,
990
from bzrlib.push import _show_push_branch
992
# Get the source branch and revision_id
993
if directory is None:
995
br_from = Branch.open_containing(directory)[0]
996
revision = _get_one_revision('push', revision)
997
if revision is not None:
998
revision_id = revision.in_history(br_from).rev_id
1000
revision_id = br_from.last_revision()
1002
# Get the stacked_on branch, if any
1003
if stacked_on is not None:
1004
stacked_on = urlutils.normalize_url(stacked_on)
1006
parent_url = br_from.get_parent()
1008
parent = Branch.open(parent_url)
1009
stacked_on = parent.get_public_branch()
1011
# I considered excluding non-http url's here, thus forcing
1012
# 'public' branches only, but that only works for some
1013
# users, so it's best to just depend on the user spotting an
1014
# error by the feedback given to them. RBC 20080227.
1015
stacked_on = parent_url
1017
raise errors.BzrCommandError(
1018
"Could not determine branch to refer to.")
1020
# Get the destination location
1021
if location is None:
1022
stored_loc = br_from.get_push_location()
1023
if stored_loc is None:
1024
raise errors.BzrCommandError(
1025
"No push location known or specified.")
1027
display_url = urlutils.unescape_for_display(stored_loc,
1029
self.outf.write("Using saved push location: %s\n" % display_url)
1030
location = stored_loc
1032
_show_push_branch(br_from, revision_id, location, self.outf,
1033
verbose=verbose, overwrite=overwrite, remember=remember,
1034
stacked_on=stacked_on, create_prefix=create_prefix,
1035
use_existing_dir=use_existing_dir)
1038
class cmd_branch(Command):
1039
"""Create a new copy of a branch.
1041
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1042
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1043
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1044
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1045
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1048
To retrieve the branch as of a particular revision, supply the --revision
1049
parameter, as in "branch foo/bar -r 5".
1052
_see_also = ['checkout']
1053
takes_args = ['from_location', 'to_location?']
1054
takes_options = ['revision', Option('hardlink',
1055
help='Hard-link working tree files where possible.'),
1057
help="Create a branch without a working-tree."),
1059
help='Create a stacked branch referring to the source branch. '
1060
'The new branch will depend on the availability of the source '
1061
'branch for all operations.'),
1062
Option('standalone',
1063
help='Do not use a shared repository, even if available.'),
1065
aliases = ['get', 'clone']
1067
def run(self, from_location, to_location=None, revision=None,
1068
hardlink=False, stacked=False, standalone=False, no_tree=False):
1069
from bzrlib.tag import _merge_tags_if_possible
1071
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1073
revision = _get_one_revision('branch', revision)
1076
if revision is not None:
1077
revision_id = revision.as_revision_id(br_from)
1079
# FIXME - wt.last_revision, fallback to branch, fall back to
1080
# None or perhaps NULL_REVISION to mean copy nothing
1082
revision_id = br_from.last_revision()
1083
if to_location is None:
1084
to_location = urlutils.derive_to_location(from_location)
1085
to_transport = transport.get_transport(to_location)
1087
to_transport.mkdir('.')
1088
except errors.FileExists:
1089
raise errors.BzrCommandError('Target directory "%s" already'
1090
' exists.' % to_location)
1091
except errors.NoSuchFile:
1092
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1095
# preserve whatever source format we have.
1096
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1097
possible_transports=[to_transport],
1098
accelerator_tree=accelerator_tree,
1099
hardlink=hardlink, stacked=stacked,
1100
force_new_repo=standalone,
1101
create_tree_if_local=not no_tree,
1102
source_branch=br_from)
1103
branch = dir.open_branch()
1104
except errors.NoSuchRevision:
1105
to_transport.delete_tree('.')
1106
msg = "The branch %s has no revision %s." % (from_location,
1108
raise errors.BzrCommandError(msg)
1109
_merge_tags_if_possible(br_from, branch)
1110
# If the source branch is stacked, the new branch may
1111
# be stacked whether we asked for that explicitly or not.
1112
# We therefore need a try/except here and not just 'if stacked:'
1114
note('Created new stacked branch referring to %s.' %
1115
branch.get_stacked_on_url())
1116
except (errors.NotStacked, errors.UnstackableBranchFormat,
1117
errors.UnstackableRepositoryFormat), e:
1118
note('Branched %d revision(s).' % branch.revno())
1123
class cmd_checkout(Command):
1124
"""Create a new checkout of an existing branch.
1126
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1127
the branch found in '.'. This is useful if you have removed the working tree
1128
or if it was never created - i.e. if you pushed the branch to its current
1129
location using SFTP.
1131
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1132
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1133
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1134
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1135
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1138
To retrieve the branch as of a particular revision, supply the --revision
1139
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1140
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1144
_see_also = ['checkouts', 'branch']
1145
takes_args = ['branch_location?', 'to_location?']
1146
takes_options = ['revision',
1147
Option('lightweight',
1148
help="Perform a lightweight checkout. Lightweight "
1149
"checkouts depend on access to the branch for "
1150
"every operation. Normal checkouts can perform "
1151
"common operations like diff and status without "
1152
"such access, and also support local commits."
1154
Option('files-from', type=str,
1155
help="Get file contents from this tree."),
1157
help='Hard-link working tree files where possible.'
1162
def run(self, branch_location=None, to_location=None, revision=None,
1163
lightweight=False, files_from=None, hardlink=False):
1164
if branch_location is None:
1165
branch_location = osutils.getcwd()
1166
to_location = branch_location
1167
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1169
revision = _get_one_revision('checkout', revision)
1170
if files_from is not None:
1171
accelerator_tree = WorkingTree.open(files_from)
1172
if revision is not None:
1173
revision_id = revision.as_revision_id(source)
1176
if to_location is None:
1177
to_location = urlutils.derive_to_location(branch_location)
1178
# if the source and to_location are the same,
1179
# and there is no working tree,
1180
# then reconstitute a branch
1181
if (osutils.abspath(to_location) ==
1182
osutils.abspath(branch_location)):
1184
source.bzrdir.open_workingtree()
1185
except errors.NoWorkingTree:
1186
source.bzrdir.create_workingtree(revision_id)
1188
source.create_checkout(to_location, revision_id, lightweight,
1189
accelerator_tree, hardlink)
1192
class cmd_renames(Command):
1193
"""Show list of renamed files.
1195
# TODO: Option to show renames between two historical versions.
1197
# TODO: Only show renames under dir, rather than in the whole branch.
1198
_see_also = ['status']
1199
takes_args = ['dir?']
1202
def run(self, dir=u'.'):
1203
tree = WorkingTree.open_containing(dir)[0]
1206
new_inv = tree.inventory
1207
old_tree = tree.basis_tree()
1208
old_tree.lock_read()
1210
old_inv = old_tree.inventory
1212
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1213
for f, paths, c, v, p, n, k, e in iterator:
1214
if paths[0] == paths[1]:
1218
renames.append(paths)
1220
for old_name, new_name in renames:
1221
self.outf.write("%s => %s\n" % (old_name, new_name))
1228
class cmd_update(Command):
1229
"""Update a tree to have the latest code committed to its branch.
1231
This will perform a merge into the working tree, and may generate
1232
conflicts. If you have any local changes, you will still
1233
need to commit them after the update for the update to be complete.
1235
If you want to discard your local changes, you can just do a
1236
'bzr revert' instead of 'bzr commit' after the update.
1239
_see_also = ['pull', 'working-trees', 'status-flags']
1240
takes_args = ['dir?']
1243
def run(self, dir='.'):
1244
tree = WorkingTree.open_containing(dir)[0]
1245
possible_transports = []
1246
master = tree.branch.get_master_branch(
1247
possible_transports=possible_transports)
1248
if master is not None:
1251
tree.lock_tree_write()
1253
existing_pending_merges = tree.get_parent_ids()[1:]
1254
last_rev = _mod_revision.ensure_null(tree.last_revision())
1255
if last_rev == _mod_revision.ensure_null(
1256
tree.branch.last_revision()):
1257
# may be up to date, check master too.
1258
if master is None or last_rev == _mod_revision.ensure_null(
1259
master.last_revision()):
1260
revno = tree.branch.revision_id_to_revno(last_rev)
1261
note("Tree is up to date at revision %d." % (revno,))
1263
view_info = _get_view_info_for_change_reporter(tree)
1264
conflicts = tree.update(
1265
delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1266
view_info=view_info), possible_transports=possible_transports)
1267
revno = tree.branch.revision_id_to_revno(
1268
_mod_revision.ensure_null(tree.last_revision()))
1269
note('Updated to revision %d.' % (revno,))
1270
if tree.get_parent_ids()[1:] != existing_pending_merges:
1271
note('Your local commits will now show as pending merges with '
1272
"'bzr status', and can be committed with 'bzr commit'.")
1281
class cmd_info(Command):
1282
"""Show information about a working tree, branch or repository.
1284
This command will show all known locations and formats associated to the
1285
tree, branch or repository.
1287
In verbose mode, statistical information is included with each report.
1288
To see extended statistic information, use a verbosity level of 2 or
1289
higher by specifying the verbose option multiple times, e.g. -vv.
1291
Branches and working trees will also report any missing revisions.
1295
Display information on the format and related locations:
1299
Display the above together with extended format information and
1300
basic statistics (like the number of files in the working tree and
1301
number of revisions in the branch and repository):
1305
Display the above together with number of committers to the branch:
1309
_see_also = ['revno', 'working-trees', 'repositories']
1310
takes_args = ['location?']
1311
takes_options = ['verbose']
1312
encoding_type = 'replace'
1315
def run(self, location=None, verbose=False):
1317
noise_level = get_verbosity_level()
1320
from bzrlib.info import show_bzrdir_info
1321
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1322
verbose=noise_level, outfile=self.outf)
1325
class cmd_remove(Command):
1326
"""Remove files or directories.
1328
This makes bzr stop tracking changes to the specified files. bzr will delete
1329
them if they can easily be recovered using revert. If no options or
1330
parameters are given bzr will scan for files that are being tracked by bzr
1331
but missing in your tree and stop tracking them for you.
1333
takes_args = ['file*']
1334
takes_options = ['verbose',
1335
Option('new', help='Only remove files that have never been committed.'),
1336
RegistryOption.from_kwargs('file-deletion-strategy',
1337
'The file deletion mode to be used.',
1338
title='Deletion Strategy', value_switches=True, enum_switch=False,
1339
safe='Only delete files if they can be'
1340
' safely recovered (default).',
1341
keep="Don't delete any files.",
1342
force='Delete all the specified files, even if they can not be '
1343
'recovered and even if they are non-empty directories.')]
1344
aliases = ['rm', 'del']
1345
encoding_type = 'replace'
1347
def run(self, file_list, verbose=False, new=False,
1348
file_deletion_strategy='safe'):
1349
tree, file_list = tree_files(file_list)
1351
if file_list is not None:
1352
file_list = [f for f in file_list]
1356
# Heuristics should probably all move into tree.remove_smart or
1359
added = tree.changes_from(tree.basis_tree(),
1360
specific_files=file_list).added
1361
file_list = sorted([f[0] for f in added], reverse=True)
1362
if len(file_list) == 0:
1363
raise errors.BzrCommandError('No matching files.')
1364
elif file_list is None:
1365
# missing files show up in iter_changes(basis) as
1366
# versioned-with-no-kind.
1368
for change in tree.iter_changes(tree.basis_tree()):
1369
# Find paths in the working tree that have no kind:
1370
if change[1][1] is not None and change[6][1] is None:
1371
missing.append(change[1][1])
1372
file_list = sorted(missing, reverse=True)
1373
file_deletion_strategy = 'keep'
1374
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1375
keep_files=file_deletion_strategy=='keep',
1376
force=file_deletion_strategy=='force')
1381
class cmd_file_id(Command):
1382
"""Print file_id of a particular file or directory.
1384
The file_id is assigned when the file is first added and remains the
1385
same through all revisions where the file exists, even when it is
1390
_see_also = ['inventory', 'ls']
1391
takes_args = ['filename']
1394
def run(self, filename):
1395
tree, relpath = WorkingTree.open_containing(filename)
1396
i = tree.path2id(relpath)
1398
raise errors.NotVersionedError(filename)
1400
self.outf.write(i + '\n')
1403
class cmd_file_path(Command):
1404
"""Print path of file_ids to a file or directory.
1406
This prints one line for each directory down to the target,
1407
starting at the branch root.
1411
takes_args = ['filename']
1414
def run(self, filename):
1415
tree, relpath = WorkingTree.open_containing(filename)
1416
fid = tree.path2id(relpath)
1418
raise errors.NotVersionedError(filename)
1419
segments = osutils.splitpath(relpath)
1420
for pos in range(1, len(segments) + 1):
1421
path = osutils.joinpath(segments[:pos])
1422
self.outf.write("%s\n" % tree.path2id(path))
1425
class cmd_reconcile(Command):
1426
"""Reconcile bzr metadata in a branch.
1428
This can correct data mismatches that may have been caused by
1429
previous ghost operations or bzr upgrades. You should only
1430
need to run this command if 'bzr check' or a bzr developer
1431
advises you to run it.
1433
If a second branch is provided, cross-branch reconciliation is
1434
also attempted, which will check that data like the tree root
1435
id which was not present in very early bzr versions is represented
1436
correctly in both branches.
1438
At the same time it is run it may recompress data resulting in
1439
a potential saving in disk space or performance gain.
1441
The branch *MUST* be on a listable system such as local disk or sftp.
1444
_see_also = ['check']
1445
takes_args = ['branch?']
1447
def run(self, branch="."):
1448
from bzrlib.reconcile import reconcile
1449
dir = bzrdir.BzrDir.open(branch)
1453
class cmd_revision_history(Command):
1454
"""Display the list of revision ids on a branch."""
1457
takes_args = ['location?']
1462
def run(self, location="."):
1463
branch = Branch.open_containing(location)[0]
1464
for revid in branch.revision_history():
1465
self.outf.write(revid)
1466
self.outf.write('\n')
1469
class cmd_ancestry(Command):
1470
"""List all revisions merged into this branch."""
1472
_see_also = ['log', 'revision-history']
1473
takes_args = ['location?']
1478
def run(self, location="."):
1480
wt = WorkingTree.open_containing(location)[0]
1481
except errors.NoWorkingTree:
1482
b = Branch.open(location)
1483
last_revision = b.last_revision()
1486
last_revision = wt.last_revision()
1488
revision_ids = b.repository.get_ancestry(last_revision)
1490
for revision_id in revision_ids:
1491
self.outf.write(revision_id + '\n')
1494
class cmd_init(Command):
1495
"""Make a directory into a versioned branch.
1497
Use this to create an empty branch, or before importing an
1500
If there is a repository in a parent directory of the location, then
1501
the history of the branch will be stored in the repository. Otherwise
1502
init creates a standalone branch which carries its own history
1503
in the .bzr directory.
1505
If there is already a branch at the location but it has no working tree,
1506
the tree can be populated with 'bzr checkout'.
1508
Recipe for importing a tree of files::
1514
bzr commit -m "imported project"
1517
_see_also = ['init-repository', 'branch', 'checkout']
1518
takes_args = ['location?']
1520
Option('create-prefix',
1521
help='Create the path leading up to the branch '
1522
'if it does not already exist.'),
1523
RegistryOption('format',
1524
help='Specify a format for this branch. '
1525
'See "help formats".',
1526
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1527
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1528
value_switches=True,
1529
title="Branch Format",
1531
Option('append-revisions-only',
1532
help='Never change revnos or the existing log.'
1533
' Append revisions to it only.')
1535
def run(self, location=None, format=None, append_revisions_only=False,
1536
create_prefix=False):
1538
format = bzrdir.format_registry.make_bzrdir('default')
1539
if location is None:
1542
to_transport = transport.get_transport(location)
1544
# The path has to exist to initialize a
1545
# branch inside of it.
1546
# Just using os.mkdir, since I don't
1547
# believe that we want to create a bunch of
1548
# locations if the user supplies an extended path
1550
to_transport.ensure_base()
1551
except errors.NoSuchFile:
1552
if not create_prefix:
1553
raise errors.BzrCommandError("Parent directory of %s"
1555
"\nYou may supply --create-prefix to create all"
1556
" leading parent directories."
1558
_create_prefix(to_transport)
1561
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1562
except errors.NotBranchError:
1563
# really a NotBzrDir error...
1564
create_branch = bzrdir.BzrDir.create_branch_convenience
1565
branch = create_branch(to_transport.base, format=format,
1566
possible_transports=[to_transport])
1567
a_bzrdir = branch.bzrdir
1569
from bzrlib.transport.local import LocalTransport
1570
if a_bzrdir.has_branch():
1571
if (isinstance(to_transport, LocalTransport)
1572
and not a_bzrdir.has_workingtree()):
1573
raise errors.BranchExistsWithoutWorkingTree(location)
1574
raise errors.AlreadyBranchError(location)
1575
branch = a_bzrdir.create_branch()
1576
a_bzrdir.create_workingtree()
1577
if append_revisions_only:
1579
branch.set_append_revisions_only(True)
1580
except errors.UpgradeRequired:
1581
raise errors.BzrCommandError('This branch format cannot be set'
1582
' to append-revisions-only. Try --experimental-branch6')
1584
from bzrlib.info import describe_layout, describe_format
1586
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1587
except (errors.NoWorkingTree, errors.NotLocalUrl):
1589
repository = branch.repository
1590
layout = describe_layout(repository, branch, tree).lower()
1591
format = describe_format(a_bzrdir, repository, branch, tree)
1592
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1593
if repository.is_shared():
1594
#XXX: maybe this can be refactored into transport.path_or_url()
1595
url = repository.bzrdir.root_transport.external_url()
1597
url = urlutils.local_path_from_url(url)
1598
except errors.InvalidURL:
1600
self.outf.write("Using shared repository: %s\n" % url)
1603
class cmd_init_repository(Command):
1604
"""Create a shared repository to hold branches.
1606
New branches created under the repository directory will store their
1607
revisions in the repository, not in the branch directory.
1609
If the --no-trees option is used then the branches in the repository
1610
will not have working trees by default.
1613
Create a shared repositories holding just branches::
1615
bzr init-repo --no-trees repo
1618
Make a lightweight checkout elsewhere::
1620
bzr checkout --lightweight repo/trunk trunk-checkout
1625
_see_also = ['init', 'branch', 'checkout', 'repositories']
1626
takes_args = ["location"]
1627
takes_options = [RegistryOption('format',
1628
help='Specify a format for this repository. See'
1629
' "bzr help formats" for details.',
1630
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1631
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1632
value_switches=True, title='Repository format'),
1634
help='Branches in the repository will default to'
1635
' not having a working tree.'),
1637
aliases = ["init-repo"]
1639
def run(self, location, format=None, no_trees=False):
1641
format = bzrdir.format_registry.make_bzrdir('default')
1643
if location is None:
1646
to_transport = transport.get_transport(location)
1647
to_transport.ensure_base()
1649
newdir = format.initialize_on_transport(to_transport)
1650
repo = newdir.create_repository(shared=True)
1651
repo.set_make_working_trees(not no_trees)
1653
from bzrlib.info import show_bzrdir_info
1654
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1657
class cmd_diff(Command):
1658
"""Show differences in the working tree, between revisions or branches.
1660
If no arguments are given, all changes for the current tree are listed.
1661
If files are given, only the changes in those files are listed.
1662
Remote and multiple branches can be compared by using the --old and
1663
--new options. If not provided, the default for both is derived from
1664
the first argument, if any, or the current tree if no arguments are
1667
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1668
produces patches suitable for "patch -p1".
1672
2 - unrepresentable changes
1677
Shows the difference in the working tree versus the last commit::
1681
Difference between the working tree and revision 1::
1685
Difference between revision 2 and revision 1::
1689
Difference between revision 2 and revision 1 for branch xxx::
1693
Show just the differences for file NEWS::
1697
Show the differences in working tree xxx for file NEWS::
1701
Show the differences from branch xxx to this working tree:
1705
Show the differences between two branches for file NEWS::
1707
bzr diff --old xxx --new yyy NEWS
1709
Same as 'bzr diff' but prefix paths with old/ and new/::
1711
bzr diff --prefix old/:new/
1713
_see_also = ['status']
1714
takes_args = ['file*']
1716
Option('diff-options', type=str,
1717
help='Pass these options to the external diff program.'),
1718
Option('prefix', type=str,
1720
help='Set prefixes added to old and new filenames, as '
1721
'two values separated by a colon. (eg "old/:new/").'),
1723
help='Branch/tree to compare from.',
1727
help='Branch/tree to compare to.',
1733
help='Use this command to compare files.',
1737
aliases = ['di', 'dif']
1738
encoding_type = 'exact'
1741
def run(self, revision=None, file_list=None, diff_options=None,
1742
prefix=None, old=None, new=None, using=None):
1743
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1745
if (prefix is None) or (prefix == '0'):
1753
old_label, new_label = prefix.split(":")
1755
raise errors.BzrCommandError(
1756
'--prefix expects two values separated by a colon'
1757
' (eg "old/:new/")')
1759
if revision and len(revision) > 2:
1760
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1761
' one or two revision specifiers')
1763
old_tree, new_tree, specific_files, extra_trees = \
1764
_get_trees_to_diff(file_list, revision, old, new,
1766
return show_diff_trees(old_tree, new_tree, sys.stdout,
1767
specific_files=specific_files,
1768
external_diff_options=diff_options,
1769
old_label=old_label, new_label=new_label,
1770
extra_trees=extra_trees, using=using)
1773
class cmd_deleted(Command):
1774
"""List files deleted in the working tree.
1776
# TODO: Show files deleted since a previous revision, or
1777
# between two revisions.
1778
# TODO: Much more efficient way to do this: read in new
1779
# directories with readdir, rather than stating each one. Same
1780
# level of effort but possibly much less IO. (Or possibly not,
1781
# if the directories are very large...)
1782
_see_also = ['status', 'ls']
1783
takes_options = ['show-ids']
1786
def run(self, show_ids=False):
1787
tree = WorkingTree.open_containing(u'.')[0]
1790
old = tree.basis_tree()
1793
for path, ie in old.inventory.iter_entries():
1794
if not tree.has_id(ie.file_id):
1795
self.outf.write(path)
1797
self.outf.write(' ')
1798
self.outf.write(ie.file_id)
1799
self.outf.write('\n')
1806
class cmd_modified(Command):
1807
"""List files modified in working tree.
1811
_see_also = ['status', 'ls']
1814
help='Write an ascii NUL (\\0) separator '
1815
'between files rather than a newline.')
1819
def run(self, null=False):
1820
tree = WorkingTree.open_containing(u'.')[0]
1821
td = tree.changes_from(tree.basis_tree())
1822
for path, id, kind, text_modified, meta_modified in td.modified:
1824
self.outf.write(path + '\0')
1826
self.outf.write(osutils.quotefn(path) + '\n')
1829
class cmd_added(Command):
1830
"""List files added in working tree.
1834
_see_also = ['status', 'ls']
1837
help='Write an ascii NUL (\\0) separator '
1838
'between files rather than a newline.')
1842
def run(self, null=False):
1843
wt = WorkingTree.open_containing(u'.')[0]
1846
basis = wt.basis_tree()
1849
basis_inv = basis.inventory
1852
if file_id in basis_inv:
1854
if inv.is_root(file_id) and len(basis_inv) == 0:
1856
path = inv.id2path(file_id)
1857
if not os.access(osutils.abspath(path), os.F_OK):
1860
self.outf.write(path + '\0')
1862
self.outf.write(osutils.quotefn(path) + '\n')
1869
class cmd_root(Command):
1870
"""Show the tree root directory.
1872
The root is the nearest enclosing directory with a .bzr control
1875
takes_args = ['filename?']
1877
def run(self, filename=None):
1878
"""Print the branch root."""
1879
tree = WorkingTree.open_containing(filename)[0]
1880
self.outf.write(tree.basedir + '\n')
1883
def _parse_limit(limitstring):
1885
return int(limitstring)
1887
msg = "The limit argument must be an integer."
1888
raise errors.BzrCommandError(msg)
1891
def _parse_levels(s):
1895
msg = "The levels argument must be an integer."
1896
raise errors.BzrCommandError(msg)
1899
class cmd_log(Command):
1900
"""Show historical log for a branch or subset of a branch.
1902
log is bzr's default tool for exploring the history of a branch.
1903
The branch to use is taken from the first parameter. If no parameters
1904
are given, the branch containing the working directory is logged.
1905
Here are some simple examples::
1907
bzr log log the current branch
1908
bzr log foo.py log a file in its branch
1909
bzr log http://server/branch log a branch on a server
1911
The filtering, ordering and information shown for each revision can
1912
be controlled as explained below. By default, all revisions are
1913
shown sorted (topologically) so that newer revisions appear before
1914
older ones and descendants always appear before ancestors. If displayed,
1915
merged revisions are shown indented under the revision in which they
1920
The log format controls how information about each revision is
1921
displayed. The standard log formats are called ``long``, ``short``
1922
and ``line``. The default is long. See ``bzr help log-formats``
1923
for more details on log formats.
1925
The following options can be used to control what information is
1928
-l N display a maximum of N revisions
1929
-n N display N levels of revisions (0 for all, 1 for collapsed)
1930
-v display a status summary (delta) for each revision
1931
-p display a diff (patch) for each revision
1932
--show-ids display revision-ids (and file-ids), not just revnos
1934
Note that the default number of levels to display is a function of the
1935
log format. If the -n option is not used, ``short`` and ``line`` show
1936
just the top level (mainline) while ``long`` shows all levels of merged
1939
Status summaries are shown using status flags like A, M, etc. To see
1940
the changes explained using words like ``added`` and ``modified``
1941
instead, use the -vv option.
1945
To display revisions from oldest to newest, use the --forward option.
1946
In most cases, using this option will have little impact on the total
1947
time taken to produce a log, though --forward does not incrementally
1948
display revisions like --reverse does when it can.
1950
:Revision filtering:
1952
The -r option can be used to specify what revision or range of revisions
1953
to filter against. The various forms are shown below::
1955
-rX display revision X
1956
-rX.. display revision X and later
1957
-r..Y display up to and including revision Y
1958
-rX..Y display from X to Y inclusive
1960
See ``bzr help revisionspec`` for details on how to specify X and Y.
1961
Some common examples are given below::
1963
-r-1 show just the tip
1964
-r-10.. show the last 10 mainline revisions
1965
-rsubmit:.. show what's new on this branch
1966
-rancestor:path.. show changes since the common ancestor of this
1967
branch and the one at location path
1968
-rdate:yesterday.. show changes since yesterday
1970
When logging a range of revisions using -rX..Y, log starts at
1971
revision Y and searches back in history through the primary
1972
("left-hand") parents until it finds X. When logging just the
1973
top level (using -n1), an error is reported if X is not found
1974
along the way. If multi-level logging is used (-n0), X may be
1975
a nested merge revision and the log will be truncated accordingly.
1979
If a parameter is given and it's not a branch, the log will be filtered
1980
to show only those revisions that changed the nominated file or
1983
Filenames are interpreted within their historical context. To log a
1984
deleted file, specify a revision range so that the file existed at
1985
the end or start of the range.
1987
Historical context is also important when interpreting pathnames of
1988
renamed files/directories. Consider the following example:
1990
* revision 1: add tutorial.txt
1991
* revision 2: modify tutorial.txt
1992
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
1996
* ``bzr log guide.txt`` will log the file added in revision 1
1998
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2000
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2001
the original file in revision 2.
2003
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2004
was no file called guide.txt in revision 2.
2006
Renames are always followed by log. By design, there is no need to
2007
explicitly ask for this (and no way to stop logging a file back
2008
until it was last renamed).
2010
Note: If the path is a directory, only revisions that directly changed
2011
that directory object are currently shown. This is considered a bug.
2012
(Support for filtering against multiple files and for files within a
2013
directory is under development.)
2017
The --message option can be used for finding revisions that match a
2018
regular expression in a commit message.
2022
GUI tools and IDEs are often better at exploring history than command
2023
line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2024
respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2025
http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2027
Web interfaces are often better at exploring history than command line
2028
tools, particularly for branches on servers. You may prefer Loggerhead
2029
or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2031
You may find it useful to add the aliases below to ``bazaar.conf``::
2035
top = log -r-10.. --short --forward
2036
show = log -v -p -n1 --long
2038
``bzr tip`` will then show the latest revision while ``bzr top``
2039
will show the last 10 mainline revisions. To see the details of a
2040
particular revision X, ``bzr show -rX``.
2042
As many GUI tools and Web interfaces do, you may prefer viewing
2043
history collapsed initially. If you are interested in looking deeper
2044
into a particular merge X, use ``bzr log -n0 -rX``. If you like
2045
working this way, you may wish to either:
2047
* change your default log format to short (or line)
2048
* add this alias: log = log -n1
2050
``bzr log -v`` on a branch with lots of history is currently
2051
very slow. A fix for this issue is currently under development.
2052
With or without that fix, it is recommended that a revision range
2053
be given when using the -v option.
2055
bzr has a generic full-text matching plugin, bzr-search, that can be
2056
used to find revisions matching user names, commit messages, etc.
2057
Among other features, this plugin can find all revisions containing
2058
a list of words but not others.
2060
When exploring non-mainline history on large projects with deep
2061
history, the performance of log can be greatly improved by installing
2062
the revnocache plugin. This plugin buffers historical information
2063
trading disk space for faster speed.
2065
takes_args = ['location?']
2066
_see_also = ['log-formats', 'revisionspec']
2069
help='Show from oldest to newest.'),
2071
custom_help('verbose',
2072
help='Show files changed in each revision.'),
2076
type=bzrlib.option._parse_revision_str,
2078
help='Show just the specified revision.'
2079
' See also "help revisionspec".'),
2083
help='Number of levels to display - 0 for all, 1 for flat.',
2085
type=_parse_levels),
2088
help='Show revisions whose message matches this '
2089
'regular expression.',
2093
help='Limit the output to the first N revisions.',
2098
help='Show changes made in each revision as a patch.'),
2100
encoding_type = 'replace'
2103
def run(self, location=None, timezone='original',
2114
from bzrlib.log import show_log, _get_fileid_to_log
2115
direction = (forward and 'forward') or 'reverse'
2117
if change is not None:
2119
raise errors.RangeInChangeOption()
2120
if revision is not None:
2121
raise errors.BzrCommandError(
2122
'--revision and --change are mutually exclusive')
2129
# find the file id to log:
2131
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
2134
file_id = _get_fileid_to_log(revision, tree, b, fp)
2136
raise errors.BzrCommandError(
2137
"Path unknown at end or start of revision range: %s" %
2141
# FIXME ? log the current subdir only RBC 20060203
2142
if revision is not None \
2143
and len(revision) > 0 and revision[0].get_branch():
2144
location = revision[0].get_branch()
2147
dir, relpath = bzrdir.BzrDir.open_containing(location)
2148
b = dir.open_branch()
2152
rev1, rev2 = _get_revision_range(revision, b, self.name())
2153
if log_format is None:
2154
log_format = log.log_formatter_registry.get_default(b)
2156
lf = log_format(show_ids=show_ids, to_file=self.outf,
2157
show_timezone=timezone,
2158
delta_format=get_verbosity_level(),
2165
direction=direction,
2166
start_revision=rev1,
2170
show_diff=show_diff)
2175
def _get_revision_range(revisionspec_list, branch, command_name):
2176
"""Take the input of a revision option and turn it into a revision range.
2178
It returns RevisionInfo objects which can be used to obtain the rev_id's
2179
of the desired revisons. It does some user input validations.
2181
if revisionspec_list is None:
2184
elif len(revisionspec_list) == 1:
2185
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2186
elif len(revisionspec_list) == 2:
2187
start_spec = revisionspec_list[0]
2188
end_spec = revisionspec_list[1]
2189
if end_spec.get_branch() != start_spec.get_branch():
2190
# b is taken from revision[0].get_branch(), and
2191
# show_log will use its revision_history. Having
2192
# different branches will lead to weird behaviors.
2193
raise errors.BzrCommandError(
2194
"bzr %s doesn't accept two revisions in different"
2195
" branches." % command_name)
2196
rev1 = start_spec.in_history(branch)
2197
# Avoid loading all of history when we know a missing
2198
# end of range means the last revision ...
2199
if end_spec.spec is None:
2200
last_revno, last_revision_id = branch.last_revision_info()
2201
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2203
rev2 = end_spec.in_history(branch)
2205
raise errors.BzrCommandError(
2206
'bzr %s --revision takes one or two values.' % command_name)
2210
def _revision_range_to_revid_range(revision_range):
2213
if revision_range[0] is not None:
2214
rev_id1 = revision_range[0].rev_id
2215
if revision_range[1] is not None:
2216
rev_id2 = revision_range[1].rev_id
2217
return rev_id1, rev_id2
2219
def get_log_format(long=False, short=False, line=False, default='long'):
2220
log_format = default
2224
log_format = 'short'
2230
class cmd_touching_revisions(Command):
2231
"""Return revision-ids which affected a particular file.
2233
A more user-friendly interface is "bzr log FILE".
2237
takes_args = ["filename"]
2240
def run(self, filename):
2241
tree, relpath = WorkingTree.open_containing(filename)
2243
file_id = tree.path2id(relpath)
2244
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2245
self.outf.write("%6d %s\n" % (revno, what))
2248
class cmd_ls(Command):
2249
"""List files in a tree.
2252
_see_also = ['status', 'cat']
2253
takes_args = ['path?']
2254
# TODO: Take a revision or remote path and list that tree instead.
2258
Option('non-recursive',
2259
help='Don\'t recurse into subdirectories.'),
2261
help='Print paths relative to the root of the branch.'),
2262
Option('unknown', help='Print unknown files.'),
2263
Option('versioned', help='Print versioned files.',
2265
Option('ignored', help='Print ignored files.'),
2267
help='Write an ascii NUL (\\0) separator '
2268
'between files rather than a newline.'),
2270
help='List entries of a particular kind: file, directory, symlink.',
2275
def run(self, revision=None, verbose=False,
2276
non_recursive=False, from_root=False,
2277
unknown=False, versioned=False, ignored=False,
2278
null=False, kind=None, show_ids=False, path=None):
2280
if kind and kind not in ('file', 'directory', 'symlink'):
2281
raise errors.BzrCommandError('invalid kind specified')
2283
if verbose and null:
2284
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2285
all = not (unknown or versioned or ignored)
2287
selection = {'I':ignored, '?':unknown, 'V':versioned}
2294
raise errors.BzrCommandError('cannot specify both --from-root'
2298
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2304
if revision is not None or tree is None:
2305
tree = _get_one_revision_tree('ls', revision, branch=branch)
2309
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
2310
if fp.startswith(relpath):
2311
fp = osutils.pathjoin(prefix, fp[len(relpath):])
2312
if non_recursive and '/' in fp:
2314
if not all and not selection[fc]:
2316
if kind is not None and fkind != kind:
2318
kindch = entry.kind_character()
2319
outstring = fp + kindch
2321
outstring = '%-8s %s' % (fc, outstring)
2322
if show_ids and fid is not None:
2323
outstring = "%-50s %s" % (outstring, fid)
2324
self.outf.write(outstring + '\n')
2326
self.outf.write(fp + '\0')
2329
self.outf.write(fid)
2330
self.outf.write('\0')
2338
self.outf.write('%-50s %s\n' % (outstring, my_id))
2340
self.outf.write(outstring + '\n')
2345
class cmd_unknowns(Command):
2346
"""List unknown files.
2354
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2355
self.outf.write(osutils.quotefn(f) + '\n')
2358
class cmd_ignore(Command):
2359
"""Ignore specified files or patterns.
2361
See ``bzr help patterns`` for details on the syntax of patterns.
2363
To remove patterns from the ignore list, edit the .bzrignore file.
2364
After adding, editing or deleting that file either indirectly by
2365
using this command or directly by using an editor, be sure to commit
2368
Note: ignore patterns containing shell wildcards must be quoted from
2372
Ignore the top level Makefile::
2374
bzr ignore ./Makefile
2376
Ignore class files in all directories::
2378
bzr ignore "*.class"
2380
Ignore .o files under the lib directory::
2382
bzr ignore "lib/**/*.o"
2384
Ignore .o files under the lib directory::
2386
bzr ignore "RE:lib/.*\.o"
2388
Ignore everything but the "debian" toplevel directory::
2390
bzr ignore "RE:(?!debian/).*"
2393
_see_also = ['status', 'ignored', 'patterns']
2394
takes_args = ['name_pattern*']
2396
Option('old-default-rules',
2397
help='Write out the ignore rules bzr < 0.9 always used.')
2400
def run(self, name_pattern_list=None, old_default_rules=None):
2401
from bzrlib import ignores
2402
if old_default_rules is not None:
2403
# dump the rules and exit
2404
for pattern in ignores.OLD_DEFAULTS:
2407
if not name_pattern_list:
2408
raise errors.BzrCommandError("ignore requires at least one "
2409
"NAME_PATTERN or --old-default-rules")
2410
name_pattern_list = [globbing.normalize_pattern(p)
2411
for p in name_pattern_list]
2412
for name_pattern in name_pattern_list:
2413
if (name_pattern[0] == '/' or
2414
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2415
raise errors.BzrCommandError(
2416
"NAME_PATTERN should not be an absolute path")
2417
tree, relpath = WorkingTree.open_containing(u'.')
2418
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2419
ignored = globbing.Globster(name_pattern_list)
2422
for entry in tree.list_files():
2426
if ignored.match(filename):
2427
matches.append(filename.encode('utf-8'))
2429
if len(matches) > 0:
2430
print "Warning: the following files are version controlled and" \
2431
" match your ignore pattern:\n%s" % ("\n".join(matches),)
2434
class cmd_ignored(Command):
2435
"""List ignored files and the patterns that matched them.
2437
List all the ignored files and the ignore pattern that caused the file to
2440
Alternatively, to list just the files::
2445
encoding_type = 'replace'
2446
_see_also = ['ignore', 'ls']
2450
tree = WorkingTree.open_containing(u'.')[0]
2453
for path, file_class, kind, file_id, entry in tree.list_files():
2454
if file_class != 'I':
2456
## XXX: Slightly inefficient since this was already calculated
2457
pat = tree.is_ignored(path)
2458
self.outf.write('%-50s %s\n' % (path, pat))
2463
class cmd_lookup_revision(Command):
2464
"""Lookup the revision-id from a revision-number
2467
bzr lookup-revision 33
2470
takes_args = ['revno']
2473
def run(self, revno):
2477
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2479
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2482
class cmd_export(Command):
2483
"""Export current or past revision to a destination directory or archive.
2485
If no revision is specified this exports the last committed revision.
2487
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2488
given, try to find the format with the extension. If no extension
2489
is found exports to a directory (equivalent to --format=dir).
2491
If root is supplied, it will be used as the root directory inside
2492
container formats (tar, zip, etc). If it is not supplied it will default
2493
to the exported filename. The root option has no effect for 'dir' format.
2495
If branch is omitted then the branch containing the current working
2496
directory will be used.
2498
Note: Export of tree with non-ASCII filenames to zip is not supported.
2500
================= =========================
2501
Supported formats Autodetected by extension
2502
================= =========================
2505
tbz2 .tar.bz2, .tbz2
2508
================= =========================
2510
takes_args = ['dest', 'branch_or_subdir?']
2513
help="Type of file to export to.",
2518
help="Name of the root directory inside the exported file."),
2520
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2522
from bzrlib.export import export
2524
if branch_or_subdir is None:
2525
tree = WorkingTree.open_containing(u'.')[0]
2529
b, subdir = Branch.open_containing(branch_or_subdir)
2532
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2534
export(rev_tree, dest, format, root, subdir)
2535
except errors.NoSuchExportFormat, e:
2536
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2539
class cmd_cat(Command):
2540
"""Write the contents of a file as of a given revision to standard output.
2542
If no revision is nominated, the last revision is used.
2544
Note: Take care to redirect standard output when using this command on a
2550
Option('name-from-revision', help='The path name in the old tree.'),
2553
takes_args = ['filename']
2554
encoding_type = 'exact'
2557
def run(self, filename, revision=None, name_from_revision=False):
2558
if revision is not None and len(revision) != 1:
2559
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2560
" one revision specifier")
2561
tree, branch, relpath = \
2562
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2565
return self._run(tree, branch, relpath, filename, revision,
2570
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2572
tree = b.basis_tree()
2573
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2575
cur_file_id = tree.path2id(relpath)
2576
old_file_id = rev_tree.path2id(relpath)
2578
if name_from_revision:
2579
if old_file_id is None:
2580
raise errors.BzrCommandError(
2581
"%r is not present in revision %s" % (
2582
filename, rev_tree.get_revision_id()))
2584
content = rev_tree.get_file_text(old_file_id)
2585
elif cur_file_id is not None:
2586
content = rev_tree.get_file_text(cur_file_id)
2587
elif old_file_id is not None:
2588
content = rev_tree.get_file_text(old_file_id)
2590
raise errors.BzrCommandError(
2591
"%r is not present in revision %s" % (
2592
filename, rev_tree.get_revision_id()))
2593
self.outf.write(content)
2596
class cmd_local_time_offset(Command):
2597
"""Show the offset in seconds from GMT to local time."""
2601
print osutils.local_time_offset()
2605
class cmd_commit(Command):
2606
"""Commit changes into a new revision.
2608
If no arguments are given, the entire tree is committed.
2610
If selected files are specified, only changes to those files are
2611
committed. If a directory is specified then the directory and everything
2612
within it is committed.
2614
When excludes are given, they take precedence over selected files.
2615
For example, too commit only changes within foo, but not changes within
2618
bzr commit foo -x foo/bar
2620
If author of the change is not the same person as the committer, you can
2621
specify the author's name using the --author option. The name should be
2622
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2624
A selected-file commit may fail in some cases where the committed
2625
tree would be invalid. Consider::
2630
bzr commit foo -m "committing foo"
2631
bzr mv foo/bar foo/baz
2634
bzr commit foo/bar -m "committing bar but not baz"
2636
In the example above, the last commit will fail by design. This gives
2637
the user the opportunity to decide whether they want to commit the
2638
rename at the same time, separately first, or not at all. (As a general
2639
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2641
Note: A selected-file commit after a merge is not yet supported.
2643
# TODO: Run hooks on tree to-be-committed, and after commit.
2645
# TODO: Strict commit that fails if there are deleted files.
2646
# (what does "deleted files" mean ??)
2648
# TODO: Give better message for -s, --summary, used by tla people
2650
# XXX: verbose currently does nothing
2652
_see_also = ['bugs', 'uncommit']
2653
takes_args = ['selected*']
2655
ListOption('exclude', type=str, short_name='x',
2656
help="Do not consider changes made to a given path."),
2657
Option('message', type=unicode,
2659
help="Description of the new revision."),
2662
help='Commit even if nothing has changed.'),
2663
Option('file', type=str,
2666
help='Take commit message from this file.'),
2668
help="Refuse to commit if there are unknown "
2669
"files in the working tree."),
2670
ListOption('fixes', type=str,
2671
help="Mark a bug as being fixed by this revision."),
2672
Option('author', type=unicode,
2673
help="Set the author's name, if it's different "
2674
"from the committer."),
2676
help="Perform a local commit in a bound "
2677
"branch. Local commits are not pushed to "
2678
"the master branch until a normal commit "
2682
help='When no message is supplied, show the diff along'
2683
' with the status summary in the message editor.'),
2685
aliases = ['ci', 'checkin']
2687
def _get_bug_fix_properties(self, fixes, branch):
2689
# Configure the properties for bug fixing attributes.
2690
for fixed_bug in fixes:
2691
tokens = fixed_bug.split(':')
2692
if len(tokens) != 2:
2693
raise errors.BzrCommandError(
2694
"Invalid bug %s. Must be in the form of 'tag:id'. "
2695
"Commit refused." % fixed_bug)
2696
tag, bug_id = tokens
2698
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2699
except errors.UnknownBugTrackerAbbreviation:
2700
raise errors.BzrCommandError(
2701
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2702
except errors.MalformedBugIdentifier:
2703
raise errors.BzrCommandError(
2704
"Invalid bug identifier for %s. Commit refused."
2706
properties.append('%s fixed' % bug_url)
2707
return '\n'.join(properties)
2709
def run(self, message=None, file=None, verbose=False, selected_list=None,
2710
unchanged=False, strict=False, local=False, fixes=None,
2711
author=None, show_diff=False, exclude=None):
2712
from bzrlib.errors import (
2717
from bzrlib.msgeditor import (
2718
edit_commit_message_encoded,
2719
generate_commit_message_template,
2720
make_commit_message_template_encoded
2723
# TODO: Need a blackbox test for invoking the external editor; may be
2724
# slightly problematic to run this cross-platform.
2726
# TODO: do more checks that the commit will succeed before
2727
# spending the user's valuable time typing a commit message.
2731
tree, selected_list = tree_files(selected_list)
2732
if selected_list == ['']:
2733
# workaround - commit of root of tree should be exactly the same
2734
# as just default commit in that tree, and succeed even though
2735
# selected-file merge commit is not done yet
2740
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2742
properties['bugs'] = bug_property
2744
if local and not tree.branch.get_bound_location():
2745
raise errors.LocalRequiresBoundBranch()
2747
def get_message(commit_obj):
2748
"""Callback to get commit message"""
2749
my_message = message
2750
if my_message is None and not file:
2751
t = make_commit_message_template_encoded(tree,
2752
selected_list, diff=show_diff,
2753
output_encoding=osutils.get_user_encoding())
2754
start_message = generate_commit_message_template(commit_obj)
2755
my_message = edit_commit_message_encoded(t,
2756
start_message=start_message)
2757
if my_message is None:
2758
raise errors.BzrCommandError("please specify a commit"
2759
" message with either --message or --file")
2760
elif my_message and file:
2761
raise errors.BzrCommandError(
2762
"please specify either --message or --file")
2764
my_message = codecs.open(file, 'rt',
2765
osutils.get_user_encoding()).read()
2766
if my_message == "":
2767
raise errors.BzrCommandError("empty commit message specified")
2771
tree.commit(message_callback=get_message,
2772
specific_files=selected_list,
2773
allow_pointless=unchanged, strict=strict, local=local,
2774
reporter=None, verbose=verbose, revprops=properties,
2776
exclude=safe_relpath_files(tree, exclude))
2777
except PointlessCommit:
2778
# FIXME: This should really happen before the file is read in;
2779
# perhaps prepare the commit; get the message; then actually commit
2780
raise errors.BzrCommandError("no changes to commit."
2781
" use --unchanged to commit anyhow")
2782
except ConflictsInTree:
2783
raise errors.BzrCommandError('Conflicts detected in working '
2784
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2786
except StrictCommitFailed:
2787
raise errors.BzrCommandError("Commit refused because there are"
2788
" unknown files in the working tree.")
2789
except errors.BoundBranchOutOfDate, e:
2790
raise errors.BzrCommandError(str(e) + "\n"
2791
'To commit to master branch, run update and then commit.\n'
2792
'You can also pass --local to commit to continue working '
2796
class cmd_check(Command):
2797
"""Validate working tree structure, branch consistency and repository history.
2799
This command checks various invariants about branch and repository storage
2800
to detect data corruption or bzr bugs.
2802
The working tree and branch checks will only give output if a problem is
2803
detected. The output fields of the repository check are:
2805
revisions: This is just the number of revisions checked. It doesn't
2807
versionedfiles: This is just the number of versionedfiles checked. It
2808
doesn't indicate a problem.
2809
unreferenced ancestors: Texts that are ancestors of other texts, but
2810
are not properly referenced by the revision ancestry. This is a
2811
subtle problem that Bazaar can work around.
2812
unique file texts: This is the total number of unique file contents
2813
seen in the checked revisions. It does not indicate a problem.
2814
repeated file texts: This is the total number of repeated texts seen
2815
in the checked revisions. Texts can be repeated when their file
2816
entries are modified, but the file contents are not. It does not
2819
If no restrictions are specified, all Bazaar data that is found at the given
2820
location will be checked.
2824
Check the tree and branch at 'foo'::
2826
bzr check --tree --branch foo
2828
Check only the repository at 'bar'::
2830
bzr check --repo bar
2832
Check everything at 'baz'::
2837
_see_also = ['reconcile']
2838
takes_args = ['path?']
2839
takes_options = ['verbose',
2840
Option('branch', help="Check the branch related to the"
2841
" current directory."),
2842
Option('repo', help="Check the repository related to the"
2843
" current directory."),
2844
Option('tree', help="Check the working tree related to"
2845
" the current directory.")]
2847
def run(self, path=None, verbose=False, branch=False, repo=False,
2849
from bzrlib.check import check_dwim
2852
if not branch and not repo and not tree:
2853
branch = repo = tree = True
2854
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2857
class cmd_upgrade(Command):
2858
"""Upgrade branch storage to current format.
2860
The check command or bzr developers may sometimes advise you to run
2861
this command. When the default format has changed you may also be warned
2862
during other operations to upgrade.
2865
_see_also = ['check']
2866
takes_args = ['url?']
2868
RegistryOption('format',
2869
help='Upgrade to a specific format. See "bzr help'
2870
' formats" for details.',
2871
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
2872
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
2873
value_switches=True, title='Branch format'),
2876
def run(self, url='.', format=None):
2877
from bzrlib.upgrade import upgrade
2879
format = bzrdir.format_registry.make_bzrdir('default')
2880
upgrade(url, format)
2883
class cmd_whoami(Command):
2884
"""Show or set bzr user id.
2887
Show the email of the current user::
2891
Set the current user::
2893
bzr whoami "Frank Chu <fchu@example.com>"
2895
takes_options = [ Option('email',
2896
help='Display email address only.'),
2898
help='Set identity for the current branch instead of '
2901
takes_args = ['name?']
2902
encoding_type = 'replace'
2905
def run(self, email=False, branch=False, name=None):
2907
# use branch if we're inside one; otherwise global config
2909
c = Branch.open_containing('.')[0].get_config()
2910
except errors.NotBranchError:
2911
c = config.GlobalConfig()
2913
self.outf.write(c.user_email() + '\n')
2915
self.outf.write(c.username() + '\n')
2918
# display a warning if an email address isn't included in the given name.
2920
config.extract_email_address(name)
2921
except errors.NoEmailInUsername, e:
2922
warning('"%s" does not seem to contain an email address. '
2923
'This is allowed, but not recommended.', name)
2925
# use global config unless --branch given
2927
c = Branch.open_containing('.')[0].get_config()
2929
c = config.GlobalConfig()
2930
c.set_user_option('email', name)
2933
class cmd_nick(Command):
2934
"""Print or set the branch nickname.
2936
If unset, the tree root directory name is used as the nickname.
2937
To print the current nickname, execute with no argument.
2939
Bound branches use the nickname of its master branch unless it is set
2943
_see_also = ['info']
2944
takes_args = ['nickname?']
2945
def run(self, nickname=None):
2946
branch = Branch.open_containing(u'.')[0]
2947
if nickname is None:
2948
self.printme(branch)
2950
branch.nick = nickname
2953
def printme(self, branch):
2957
class cmd_alias(Command):
2958
"""Set/unset and display aliases.
2961
Show the current aliases::
2965
Show the alias specified for 'll'::
2969
Set an alias for 'll'::
2971
bzr alias ll="log --line -r-10..-1"
2973
To remove an alias for 'll'::
2975
bzr alias --remove ll
2978
takes_args = ['name?']
2980
Option('remove', help='Remove the alias.'),
2983
def run(self, name=None, remove=False):
2985
self.remove_alias(name)
2987
self.print_aliases()
2989
equal_pos = name.find('=')
2991
self.print_alias(name)
2993
self.set_alias(name[:equal_pos], name[equal_pos+1:])
2995
def remove_alias(self, alias_name):
2996
if alias_name is None:
2997
raise errors.BzrCommandError(
2998
'bzr alias --remove expects an alias to remove.')
2999
# If alias is not found, print something like:
3000
# unalias: foo: not found
3001
c = config.GlobalConfig()
3002
c.unset_alias(alias_name)
3005
def print_aliases(self):
3006
"""Print out the defined aliases in a similar format to bash."""
3007
aliases = config.GlobalConfig().get_aliases()
3008
for key, value in sorted(aliases.iteritems()):
3009
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3012
def print_alias(self, alias_name):
3013
from bzrlib.commands import get_alias
3014
alias = get_alias(alias_name)
3016
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3019
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3021
def set_alias(self, alias_name, alias_command):
3022
"""Save the alias in the global config."""
3023
c = config.GlobalConfig()
3024
c.set_alias(alias_name, alias_command)
3027
class cmd_selftest(Command):
3028
"""Run internal test suite.
3030
If arguments are given, they are regular expressions that say which tests
3031
should run. Tests matching any expression are run, and other tests are
3034
Alternatively if --first is given, matching tests are run first and then
3035
all other tests are run. This is useful if you have been working in a
3036
particular area, but want to make sure nothing else was broken.
3038
If --exclude is given, tests that match that regular expression are
3039
excluded, regardless of whether they match --first or not.
3041
To help catch accidential dependencies between tests, the --randomize
3042
option is useful. In most cases, the argument used is the word 'now'.
3043
Note that the seed used for the random number generator is displayed
3044
when this option is used. The seed can be explicitly passed as the
3045
argument to this option if required. This enables reproduction of the
3046
actual ordering used if and when an order sensitive problem is encountered.
3048
If --list-only is given, the tests that would be run are listed. This is
3049
useful when combined with --first, --exclude and/or --randomize to
3050
understand their impact. The test harness reports "Listed nn tests in ..."
3051
instead of "Ran nn tests in ..." when list mode is enabled.
3053
If the global option '--no-plugins' is given, plugins are not loaded
3054
before running the selftests. This has two effects: features provided or
3055
modified by plugins will not be tested, and tests provided by plugins will
3058
Tests that need working space on disk use a common temporary directory,
3059
typically inside $TMPDIR or /tmp.
3062
Run only tests relating to 'ignore'::
3066
Disable plugins and list tests as they're run::
3068
bzr --no-plugins selftest -v
3070
# NB: this is used from the class without creating an instance, which is
3071
# why it does not have a self parameter.
3072
def get_transport_type(typestring):
3073
"""Parse and return a transport specifier."""
3074
if typestring == "sftp":
3075
from bzrlib.transport.sftp import SFTPAbsoluteServer
3076
return SFTPAbsoluteServer
3077
if typestring == "memory":
3078
from bzrlib.transport.memory import MemoryServer
3080
if typestring == "fakenfs":
3081
from bzrlib.transport.fakenfs import FakeNFSServer
3082
return FakeNFSServer
3083
msg = "No known transport type %s. Supported types are: sftp\n" %\
3085
raise errors.BzrCommandError(msg)
3088
takes_args = ['testspecs*']
3089
takes_options = ['verbose',
3091
help='Stop when one test fails.',
3095
help='Use a different transport by default '
3096
'throughout the test suite.',
3097
type=get_transport_type),
3099
help='Run the benchmarks rather than selftests.'),
3100
Option('lsprof-timed',
3101
help='Generate lsprof output for benchmarked'
3102
' sections of code.'),
3103
Option('cache-dir', type=str,
3104
help='Cache intermediate benchmark output in this '
3107
help='Run all tests, but run specified tests first.',
3111
help='List the tests instead of running them.'),
3112
Option('randomize', type=str, argname="SEED",
3113
help='Randomize the order of tests using the given'
3114
' seed or "now" for the current time.'),
3115
Option('exclude', type=str, argname="PATTERN",
3117
help='Exclude tests that match this regular'
3119
Option('strict', help='Fail on missing dependencies or '
3121
Option('load-list', type=str, argname='TESTLISTFILE',
3122
help='Load a test id list from a text file.'),
3123
ListOption('debugflag', type=str, short_name='E',
3124
help='Turn on a selftest debug flag.'),
3125
ListOption('starting-with', type=str, argname='TESTID',
3126
param_name='starting_with', short_name='s',
3128
'Load only the tests starting with TESTID.'),
3130
encoding_type = 'replace'
3133
Command.__init__(self)
3134
self.additional_selftest_args = {}
3136
def run(self, testspecs_list=None, verbose=False, one=False,
3137
transport=None, benchmark=None,
3138
lsprof_timed=None, cache_dir=None,
3139
first=False, list_only=False,
3140
randomize=None, exclude=None, strict=False,
3141
load_list=None, debugflag=None, starting_with=None):
3142
from bzrlib.tests import selftest
3143
import bzrlib.benchmarks as benchmarks
3144
from bzrlib.benchmarks import tree_creator
3146
# Make deprecation warnings visible, unless -Werror is set
3147
symbol_versioning.activate_deprecation_warnings(override=False)
3149
if cache_dir is not None:
3150
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3152
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
3153
print ' %s (%s python%s)' % (
3155
bzrlib.version_string,
3156
bzrlib._format_version_tuple(sys.version_info),
3159
if testspecs_list is not None:
3160
pattern = '|'.join(testspecs_list)
3164
test_suite_factory = benchmarks.test_suite
3165
# Unless user explicitly asks for quiet, be verbose in benchmarks
3166
verbose = not is_quiet()
3167
# TODO: should possibly lock the history file...
3168
benchfile = open(".perf_history", "at", buffering=1)
3170
test_suite_factory = None
3173
selftest_kwargs = {"verbose": verbose,
3175
"stop_on_failure": one,
3176
"transport": transport,
3177
"test_suite_factory": test_suite_factory,
3178
"lsprof_timed": lsprof_timed,
3179
"bench_history": benchfile,
3180
"matching_tests_first": first,
3181
"list_only": list_only,
3182
"random_seed": randomize,
3183
"exclude_pattern": exclude,
3185
"load_list": load_list,
3186
"debug_flags": debugflag,
3187
"starting_with": starting_with
3189
selftest_kwargs.update(self.additional_selftest_args)
3190
result = selftest(**selftest_kwargs)
3192
if benchfile is not None:
3195
note('tests passed')
3197
note('tests failed')
3198
return int(not result)
3201
class cmd_version(Command):
3202
"""Show version of bzr."""
3204
encoding_type = 'replace'
3206
Option("short", help="Print just the version number."),
3210
def run(self, short=False):
3211
from bzrlib.version import show_version
3213
self.outf.write(bzrlib.version_string + '\n')
3215
show_version(to_file=self.outf)
3218
class cmd_rocks(Command):
3219
"""Statement of optimism."""
3225
print "It sure does!"
3228
class cmd_find_merge_base(Command):
3229
"""Find and print a base revision for merging two branches."""
3230
# TODO: Options to specify revisions on either side, as if
3231
# merging only part of the history.
3232
takes_args = ['branch', 'other']
3236
def run(self, branch, other):
3237
from bzrlib.revision import ensure_null
3239
branch1 = Branch.open_containing(branch)[0]
3240
branch2 = Branch.open_containing(other)[0]
3245
last1 = ensure_null(branch1.last_revision())
3246
last2 = ensure_null(branch2.last_revision())
3248
graph = branch1.repository.get_graph(branch2.repository)
3249
base_rev_id = graph.find_unique_lca(last1, last2)
3251
print 'merge base is revision %s' % base_rev_id
3258
class cmd_merge(Command):
3259
"""Perform a three-way merge.
3261
The source of the merge can be specified either in the form of a branch,
3262
or in the form of a path to a file containing a merge directive generated
3263
with bzr send. If neither is specified, the default is the upstream branch
3264
or the branch most recently merged using --remember.
3266
When merging a branch, by default the tip will be merged. To pick a different
3267
revision, pass --revision. If you specify two values, the first will be used as
3268
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3269
available revisions, like this is commonly referred to as "cherrypicking".
3271
Revision numbers are always relative to the branch being merged.
3273
By default, bzr will try to merge in all new work from the other
3274
branch, automatically determining an appropriate base. If this
3275
fails, you may need to give an explicit base.
3277
Merge will do its best to combine the changes in two branches, but there
3278
are some kinds of problems only a human can fix. When it encounters those,
3279
it will mark a conflict. A conflict means that you need to fix something,
3280
before you should commit.
3282
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3284
If there is no default branch set, the first merge will set it. After
3285
that, you can omit the branch to use the default. To change the
3286
default, use --remember. The value will only be saved if the remote
3287
location can be accessed.
3289
The results of the merge are placed into the destination working
3290
directory, where they can be reviewed (with bzr diff), tested, and then
3291
committed to record the result of the merge.
3293
merge refuses to run if there are any uncommitted changes, unless
3297
To merge the latest revision from bzr.dev::
3299
bzr merge ../bzr.dev
3301
To merge changes up to and including revision 82 from bzr.dev::
3303
bzr merge -r 82 ../bzr.dev
3305
To merge the changes introduced by 82, without previous changes::
3307
bzr merge -r 81..82 ../bzr.dev
3309
To apply a merge directive contained in in /tmp/merge:
3311
bzr merge /tmp/merge
3314
encoding_type = 'exact'
3315
_see_also = ['update', 'remerge', 'status-flags']
3316
takes_args = ['location?']
3321
help='Merge even if the destination tree has uncommitted changes.'),
3325
Option('show-base', help="Show base revision text in "
3327
Option('uncommitted', help='Apply uncommitted changes'
3328
' from a working copy, instead of branch changes.'),
3329
Option('pull', help='If the destination is already'
3330
' completely merged into the source, pull from the'
3331
' source rather than merging. When this happens,'
3332
' you do not need to commit the result.'),
3334
help='Branch to merge into, '
3335
'rather than the one containing the working directory.',
3339
Option('preview', help='Instead of merging, show a diff of the merge.')
3342
def run(self, location=None, revision=None, force=False,
3343
merge_type=None, show_base=False, reprocess=None, remember=False,
3344
uncommitted=False, pull=False,
3348
if merge_type is None:
3349
merge_type = _mod_merge.Merge3Merger
3351
if directory is None: directory = u'.'
3352
possible_transports = []
3354
allow_pending = True
3355
verified = 'inapplicable'
3356
tree = WorkingTree.open_containing(directory)[0]
3357
view_info = _get_view_info_for_change_reporter(tree)
3358
change_reporter = delta._ChangeReporter(
3359
unversioned_filter=tree.is_ignored, view_info=view_info)
3362
pb = ui.ui_factory.nested_progress_bar()
3363
cleanups.append(pb.finished)
3365
cleanups.append(tree.unlock)
3366
if location is not None:
3368
mergeable = bundle.read_mergeable_from_url(location,
3369
possible_transports=possible_transports)
3370
except errors.NotABundle:
3374
raise errors.BzrCommandError('Cannot use --uncommitted'
3375
' with bundles or merge directives.')
3377
if revision is not None:
3378
raise errors.BzrCommandError(
3379
'Cannot use -r with merge directives or bundles')
3380
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3383
if merger is None and uncommitted:
3384
if revision is not None and len(revision) > 0:
3385
raise errors.BzrCommandError('Cannot use --uncommitted and'
3386
' --revision at the same time.')
3387
location = self._select_branch_location(tree, location)[0]
3388
other_tree, other_path = WorkingTree.open_containing(location)
3389
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
3391
allow_pending = False
3392
if other_path != '':
3393
merger.interesting_files = [other_path]
3396
merger, allow_pending = self._get_merger_from_branch(tree,
3397
location, revision, remember, possible_transports, pb)
3399
merger.merge_type = merge_type
3400
merger.reprocess = reprocess
3401
merger.show_base = show_base
3402
self.sanity_check_merger(merger)
3403
if (merger.base_rev_id == merger.other_rev_id and
3404
merger.other_rev_id is not None):
3405
note('Nothing to do.')
3408
if merger.interesting_files is not None:
3409
raise errors.BzrCommandError('Cannot pull individual files')
3410
if (merger.base_rev_id == tree.last_revision()):
3411
result = tree.pull(merger.other_branch, False,
3412
merger.other_rev_id)
3413
result.report(self.outf)
3415
merger.check_basis(not force)
3417
return self._do_preview(merger)
3419
return self._do_merge(merger, change_reporter, allow_pending,
3422
for cleanup in reversed(cleanups):
3425
def _do_preview(self, merger):
3426
from bzrlib.diff import show_diff_trees
3427
tree_merger = merger.make_merger()
3428
tt = tree_merger.make_preview_transform()
3430
result_tree = tt.get_preview_tree()
3431
show_diff_trees(merger.this_tree, result_tree, self.outf,
3432
old_label='', new_label='')
3436
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3437
merger.change_reporter = change_reporter
3438
conflict_count = merger.do_merge()
3440
merger.set_pending()
3441
if verified == 'failed':
3442
warning('Preview patch does not match changes')
3443
if conflict_count != 0:
3448
def sanity_check_merger(self, merger):
3449
if (merger.show_base and
3450
not merger.merge_type is _mod_merge.Merge3Merger):
3451
raise errors.BzrCommandError("Show-base is not supported for this"
3452
" merge type. %s" % merger.merge_type)
3453
if merger.reprocess is None:
3454
if merger.show_base:
3455
merger.reprocess = False
3457
# Use reprocess if the merger supports it
3458
merger.reprocess = merger.merge_type.supports_reprocess
3459
if merger.reprocess and not merger.merge_type.supports_reprocess:
3460
raise errors.BzrCommandError("Conflict reduction is not supported"
3461
" for merge type %s." %
3463
if merger.reprocess and merger.show_base:
3464
raise errors.BzrCommandError("Cannot do conflict reduction and"
3467
def _get_merger_from_branch(self, tree, location, revision, remember,
3468
possible_transports, pb):
3469
"""Produce a merger from a location, assuming it refers to a branch."""
3470
from bzrlib.tag import _merge_tags_if_possible
3471
# find the branch locations
3472
other_loc, user_location = self._select_branch_location(tree, location,
3474
if revision is not None and len(revision) == 2:
3475
base_loc, _unused = self._select_branch_location(tree,
3476
location, revision, 0)
3478
base_loc = other_loc
3480
other_branch, other_path = Branch.open_containing(other_loc,
3481
possible_transports)
3482
if base_loc == other_loc:
3483
base_branch = other_branch
3485
base_branch, base_path = Branch.open_containing(base_loc,
3486
possible_transports)
3487
# Find the revision ids
3488
if revision is None or len(revision) < 1 or revision[-1] is None:
3489
other_revision_id = _mod_revision.ensure_null(
3490
other_branch.last_revision())
3492
other_revision_id = revision[-1].as_revision_id(other_branch)
3493
if (revision is not None and len(revision) == 2
3494
and revision[0] is not None):
3495
base_revision_id = revision[0].as_revision_id(base_branch)
3497
base_revision_id = None
3498
# Remember where we merge from
3499
if ((remember or tree.branch.get_submit_branch() is None) and
3500
user_location is not None):
3501
tree.branch.set_submit_branch(other_branch.base)
3502
_merge_tags_if_possible(other_branch, tree.branch)
3503
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3504
other_revision_id, base_revision_id, other_branch, base_branch)
3505
if other_path != '':
3506
allow_pending = False
3507
merger.interesting_files = [other_path]
3509
allow_pending = True
3510
return merger, allow_pending
3512
def _select_branch_location(self, tree, user_location, revision=None,
3514
"""Select a branch location, according to possible inputs.
3516
If provided, branches from ``revision`` are preferred. (Both
3517
``revision`` and ``index`` must be supplied.)
3519
Otherwise, the ``location`` parameter is used. If it is None, then the
3520
``submit`` or ``parent`` location is used, and a note is printed.
3522
:param tree: The working tree to select a branch for merging into
3523
:param location: The location entered by the user
3524
:param revision: The revision parameter to the command
3525
:param index: The index to use for the revision parameter. Negative
3526
indices are permitted.
3527
:return: (selected_location, user_location). The default location
3528
will be the user-entered location.
3530
if (revision is not None and index is not None
3531
and revision[index] is not None):
3532
branch = revision[index].get_branch()
3533
if branch is not None:
3534
return branch, branch
3535
if user_location is None:
3536
location = self._get_remembered(tree, 'Merging from')
3538
location = user_location
3539
return location, user_location
3541
def _get_remembered(self, tree, verb_string):
3542
"""Use tree.branch's parent if none was supplied.
3544
Report if the remembered location was used.
3546
stored_location = tree.branch.get_submit_branch()
3547
stored_location_type = "submit"
3548
if stored_location is None:
3549
stored_location = tree.branch.get_parent()
3550
stored_location_type = "parent"
3551
mutter("%s", stored_location)
3552
if stored_location is None:
3553
raise errors.BzrCommandError("No location specified or remembered")
3554
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3555
note(u"%s remembered %s location %s", verb_string,
3556
stored_location_type, display_url)
3557
return stored_location
3560
class cmd_remerge(Command):
3563
Use this if you want to try a different merge technique while resolving
3564
conflicts. Some merge techniques are better than others, and remerge
3565
lets you try different ones on different files.
3567
The options for remerge have the same meaning and defaults as the ones for
3568
merge. The difference is that remerge can (only) be run when there is a
3569
pending merge, and it lets you specify particular files.
3572
Re-do the merge of all conflicted files, and show the base text in
3573
conflict regions, in addition to the usual THIS and OTHER texts::
3575
bzr remerge --show-base
3577
Re-do the merge of "foobar", using the weave merge algorithm, with
3578
additional processing to reduce the size of conflict regions::
3580
bzr remerge --merge-type weave --reprocess foobar
3582
takes_args = ['file*']
3587
help="Show base revision text in conflicts."),
3590
def run(self, file_list=None, merge_type=None, show_base=False,
3592
if merge_type is None:
3593
merge_type = _mod_merge.Merge3Merger
3594
tree, file_list = tree_files(file_list)
3597
parents = tree.get_parent_ids()
3598
if len(parents) != 2:
3599
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3600
" merges. Not cherrypicking or"
3602
repository = tree.branch.repository
3603
interesting_ids = None
3605
conflicts = tree.conflicts()
3606
if file_list is not None:
3607
interesting_ids = set()
3608
for filename in file_list:
3609
file_id = tree.path2id(filename)
3611
raise errors.NotVersionedError(filename)
3612
interesting_ids.add(file_id)
3613
if tree.kind(file_id) != "directory":
3616
for name, ie in tree.inventory.iter_entries(file_id):
3617
interesting_ids.add(ie.file_id)
3618
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3620
# Remerge only supports resolving contents conflicts
3621
allowed_conflicts = ('text conflict', 'contents conflict')
3622
restore_files = [c.path for c in conflicts
3623
if c.typestring in allowed_conflicts]
3624
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3625
tree.set_conflicts(ConflictList(new_conflicts))
3626
if file_list is not None:
3627
restore_files = file_list
3628
for filename in restore_files:
3630
restore(tree.abspath(filename))
3631
except errors.NotConflicted:
3633
# Disable pending merges, because the file texts we are remerging
3634
# have not had those merges performed. If we use the wrong parents
3635
# list, we imply that the working tree text has seen and rejected
3636
# all the changes from the other tree, when in fact those changes
3637
# have not yet been seen.
3638
pb = ui.ui_factory.nested_progress_bar()
3639
tree.set_parent_ids(parents[:1])
3641
merger = _mod_merge.Merger.from_revision_ids(pb,
3643
merger.interesting_ids = interesting_ids
3644
merger.merge_type = merge_type
3645
merger.show_base = show_base
3646
merger.reprocess = reprocess
3647
conflicts = merger.do_merge()
3649
tree.set_parent_ids(parents)
3659
class cmd_revert(Command):
3660
"""Revert files to a previous revision.
3662
Giving a list of files will revert only those files. Otherwise, all files
3663
will be reverted. If the revision is not specified with '--revision', the
3664
last committed revision is used.
3666
To remove only some changes, without reverting to a prior version, use
3667
merge instead. For example, "merge . --revision -2..-3" will remove the
3668
changes introduced by -2, without affecting the changes introduced by -1.
3669
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3671
By default, any files that have been manually changed will be backed up
3672
first. (Files changed only by merge are not backed up.) Backup files have
3673
'.~#~' appended to their name, where # is a number.
3675
When you provide files, you can use their current pathname or the pathname
3676
from the target revision. So you can use revert to "undelete" a file by
3677
name. If you name a directory, all the contents of that directory will be
3680
Any files that have been newly added since that revision will be deleted,
3681
with a backup kept if appropriate. Directories containing unknown files
3682
will not be deleted.
3684
The working tree contains a list of pending merged revisions, which will
3685
be included as parents in the next commit. Normally, revert clears that
3686
list as well as reverting the files. If any files are specified, revert
3687
leaves the pending merge list alone and reverts only the files. Use "bzr
3688
revert ." in the tree root to revert all files but keep the merge record,
3689
and "bzr revert --forget-merges" to clear the pending merge list without
3690
reverting any files.
3693
_see_also = ['cat', 'export']
3696
Option('no-backup', "Do not save backups of reverted files."),
3697
Option('forget-merges',
3698
'Remove pending merge marker, without changing any files.'),
3700
takes_args = ['file*']
3702
def run(self, revision=None, no_backup=False, file_list=None,
3703
forget_merges=None):
3704
tree, file_list = tree_files(file_list)
3708
tree.set_parent_ids(tree.get_parent_ids()[:1])
3710
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3715
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3716
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3717
pb = ui.ui_factory.nested_progress_bar()
3719
tree.revert(file_list, rev_tree, not no_backup, pb,
3720
report_changes=True)
3725
class cmd_assert_fail(Command):
3726
"""Test reporting of assertion failures"""
3727
# intended just for use in testing
3732
raise AssertionError("always fails")
3735
class cmd_help(Command):
3736
"""Show help on a command or other topic.
3739
_see_also = ['topics']
3741
Option('long', 'Show help on all commands.'),
3743
takes_args = ['topic?']
3744
aliases = ['?', '--help', '-?', '-h']
3747
def run(self, topic=None, long=False):
3749
if topic is None and long:
3751
bzrlib.help.help(topic)
3754
class cmd_shell_complete(Command):
3755
"""Show appropriate completions for context.
3757
For a list of all available commands, say 'bzr shell-complete'.
3759
takes_args = ['context?']
3764
def run(self, context=None):
3765
import shellcomplete
3766
shellcomplete.shellcomplete(context)
3769
class cmd_missing(Command):
3770
"""Show unmerged/unpulled revisions between two branches.
3772
OTHER_BRANCH may be local or remote.
3774
To filter on a range of revirions, you can use the command -r begin..end
3775
-r revision requests a specific revision, -r ..end or -r begin.. are
3780
Determine the missing revisions between this and the branch at the
3781
remembered pull location::
3785
Determine the missing revisions between this and another branch::
3787
bzr missing http://server/branch
3789
Determine the missing revisions up to a specific revision on the other
3792
bzr missing -r ..-10
3794
Determine the missing revisions up to a specific revision on this
3797
bzr missing --my-revision ..-10
3800
_see_also = ['merge', 'pull']
3801
takes_args = ['other_branch?']
3803
Option('reverse', 'Reverse the order of revisions.'),
3805
'Display changes in the local branch only.'),
3806
Option('this' , 'Same as --mine-only.'),
3807
Option('theirs-only',
3808
'Display changes in the remote branch only.'),
3809
Option('other', 'Same as --theirs-only.'),
3813
custom_help('revision',
3814
help='Filter on other branch revisions (inclusive). '
3815
'See "help revisionspec" for details.'),
3816
Option('my-revision',
3817
type=_parse_revision_str,
3818
help='Filter on local branch revisions (inclusive). '
3819
'See "help revisionspec" for details.'),
3820
Option('include-merges', 'Show merged revisions.'),
3822
encoding_type = 'replace'
3825
def run(self, other_branch=None, reverse=False, mine_only=False,
3827
log_format=None, long=False, short=False, line=False,
3828
show_ids=False, verbose=False, this=False, other=False,
3829
include_merges=False, revision=None, my_revision=None):
3830
from bzrlib.missing import find_unmerged, iter_log_revisions
3839
# TODO: We should probably check that we don't have mine-only and
3840
# theirs-only set, but it gets complicated because we also have
3841
# this and other which could be used.
3848
local_branch = Branch.open_containing(u".")[0]
3849
parent = local_branch.get_parent()
3850
if other_branch is None:
3851
other_branch = parent
3852
if other_branch is None:
3853
raise errors.BzrCommandError("No peer location known"
3855
display_url = urlutils.unescape_for_display(parent,
3857
message("Using saved parent location: "
3858
+ display_url + "\n")
3860
remote_branch = Branch.open(other_branch)
3861
if remote_branch.base == local_branch.base:
3862
remote_branch = local_branch
3864
local_revid_range = _revision_range_to_revid_range(
3865
_get_revision_range(my_revision, local_branch,
3868
remote_revid_range = _revision_range_to_revid_range(
3869
_get_revision_range(revision,
3870
remote_branch, self.name()))
3872
local_branch.lock_read()
3874
remote_branch.lock_read()
3876
local_extra, remote_extra = find_unmerged(
3877
local_branch, remote_branch, restrict,
3878
backward=not reverse,
3879
include_merges=include_merges,
3880
local_revid_range=local_revid_range,
3881
remote_revid_range=remote_revid_range)
3883
if log_format is None:
3884
registry = log.log_formatter_registry
3885
log_format = registry.get_default(local_branch)
3886
lf = log_format(to_file=self.outf,
3888
show_timezone='original')
3891
if local_extra and not theirs_only:
3892
message("You have %d extra revision(s):\n" %
3894
for revision in iter_log_revisions(local_extra,
3895
local_branch.repository,
3897
lf.log_revision(revision)
3898
printed_local = True
3901
printed_local = False
3903
if remote_extra and not mine_only:
3904
if printed_local is True:
3906
message("You are missing %d revision(s):\n" %
3908
for revision in iter_log_revisions(remote_extra,
3909
remote_branch.repository,
3911
lf.log_revision(revision)
3914
if mine_only and not local_extra:
3915
# We checked local, and found nothing extra
3916
message('This branch is up to date.\n')
3917
elif theirs_only and not remote_extra:
3918
# We checked remote, and found nothing extra
3919
message('Other branch is up to date.\n')
3920
elif not (mine_only or theirs_only or local_extra or
3922
# We checked both branches, and neither one had extra
3924
message("Branches are up to date.\n")
3926
remote_branch.unlock()
3928
local_branch.unlock()
3929
if not status_code and parent is None and other_branch is not None:
3930
local_branch.lock_write()
3932
# handle race conditions - a parent might be set while we run.
3933
if local_branch.get_parent() is None:
3934
local_branch.set_parent(remote_branch.base)
3936
local_branch.unlock()
3940
class cmd_pack(Command):
3941
"""Compress the data within a repository."""
3943
_see_also = ['repositories']
3944
takes_args = ['branch_or_repo?']
3946
def run(self, branch_or_repo='.'):
3947
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3949
branch = dir.open_branch()
3950
repository = branch.repository
3951
except errors.NotBranchError:
3952
repository = dir.open_repository()
3956
class cmd_plugins(Command):
3957
"""List the installed plugins.
3959
This command displays the list of installed plugins including
3960
version of plugin and a short description of each.
3962
--verbose shows the path where each plugin is located.
3964
A plugin is an external component for Bazaar that extends the
3965
revision control system, by adding or replacing code in Bazaar.
3966
Plugins can do a variety of things, including overriding commands,
3967
adding new commands, providing additional network transports and
3968
customizing log output.
3970
See the Bazaar web site, http://bazaar-vcs.org, for further
3971
information on plugins including where to find them and how to
3972
install them. Instructions are also provided there on how to
3973
write new plugins using the Python programming language.
3975
takes_options = ['verbose']
3978
def run(self, verbose=False):
3979
import bzrlib.plugin
3980
from inspect import getdoc
3982
for name, plugin in bzrlib.plugin.plugins().items():
3983
version = plugin.__version__
3984
if version == 'unknown':
3986
name_ver = '%s %s' % (name, version)
3987
d = getdoc(plugin.module)
3989
doc = d.split('\n')[0]
3991
doc = '(no description)'
3992
result.append((name_ver, doc, plugin.path()))
3993
for name_ver, doc, path in sorted(result):
4001
class cmd_testament(Command):
4002
"""Show testament (signing-form) of a revision."""
4005
Option('long', help='Produce long-format testament.'),
4007
help='Produce a strict-format testament.')]
4008
takes_args = ['branch?']
4010
def run(self, branch=u'.', revision=None, long=False, strict=False):
4011
from bzrlib.testament import Testament, StrictTestament
4013
testament_class = StrictTestament
4015
testament_class = Testament
4017
b = Branch.open_containing(branch)[0]
4019
b = Branch.open(branch)
4022
if revision is None:
4023
rev_id = b.last_revision()
4025
rev_id = revision[0].as_revision_id(b)
4026
t = testament_class.from_revision(b.repository, rev_id)
4028
sys.stdout.writelines(t.as_text_lines())
4030
sys.stdout.write(t.as_short_text())
4035
class cmd_annotate(Command):
4036
"""Show the origin of each line in a file.
4038
This prints out the given file with an annotation on the left side
4039
indicating which revision, author and date introduced the change.
4041
If the origin is the same for a run of consecutive lines, it is
4042
shown only at the top, unless the --all option is given.
4044
# TODO: annotate directories; showing when each file was last changed
4045
# TODO: if the working copy is modified, show annotations on that
4046
# with new uncommitted lines marked
4047
aliases = ['ann', 'blame', 'praise']
4048
takes_args = ['filename']
4049
takes_options = [Option('all', help='Show annotations on all lines.'),
4050
Option('long', help='Show commit date in annotations.'),
4054
encoding_type = 'exact'
4057
def run(self, filename, all=False, long=False, revision=None,
4059
from bzrlib.annotate import annotate_file, annotate_file_tree
4060
wt, branch, relpath = \
4061
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4067
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4069
file_id = wt.path2id(relpath)
4071
file_id = tree.path2id(relpath)
4073
raise errors.NotVersionedError(filename)
4074
file_version = tree.inventory[file_id].revision
4075
if wt is not None and revision is None:
4076
# If there is a tree and we're not annotating historical
4077
# versions, annotate the working tree's content.
4078
annotate_file_tree(wt, file_id, self.outf, long, all,
4081
annotate_file(branch, file_version, file_id, long, all, self.outf,
4090
class cmd_re_sign(Command):
4091
"""Create a digital signature for an existing revision."""
4092
# TODO be able to replace existing ones.
4094
hidden = True # is this right ?
4095
takes_args = ['revision_id*']
4096
takes_options = ['revision']
4098
def run(self, revision_id_list=None, revision=None):
4099
if revision_id_list is not None and revision is not None:
4100
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4101
if revision_id_list is None and revision is None:
4102
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4103
b = WorkingTree.open_containing(u'.')[0].branch
4106
return self._run(b, revision_id_list, revision)
4110
def _run(self, b, revision_id_list, revision):
4111
import bzrlib.gpg as gpg
4112
gpg_strategy = gpg.GPGStrategy(b.get_config())
4113
if revision_id_list is not None:
4114
b.repository.start_write_group()
4116
for revision_id in revision_id_list:
4117
b.repository.sign_revision(revision_id, gpg_strategy)
4119
b.repository.abort_write_group()
4122
b.repository.commit_write_group()
4123
elif revision is not None:
4124
if len(revision) == 1:
4125
revno, rev_id = revision[0].in_history(b)
4126
b.repository.start_write_group()
4128
b.repository.sign_revision(rev_id, gpg_strategy)
4130
b.repository.abort_write_group()
4133
b.repository.commit_write_group()
4134
elif len(revision) == 2:
4135
# are they both on rh- if so we can walk between them
4136
# might be nice to have a range helper for arbitrary
4137
# revision paths. hmm.
4138
from_revno, from_revid = revision[0].in_history(b)
4139
to_revno, to_revid = revision[1].in_history(b)
4140
if to_revid is None:
4141
to_revno = b.revno()
4142
if from_revno is None or to_revno is None:
4143
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4144
b.repository.start_write_group()
4146
for revno in range(from_revno, to_revno + 1):
4147
b.repository.sign_revision(b.get_rev_id(revno),
4150
b.repository.abort_write_group()
4153
b.repository.commit_write_group()
4155
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4158
class cmd_bind(Command):
4159
"""Convert the current branch into a checkout of the supplied branch.
4161
Once converted into a checkout, commits must succeed on the master branch
4162
before they will be applied to the local branch.
4164
Bound branches use the nickname of its master branch unless it is set
4165
locally, in which case binding will update the the local nickname to be
4169
_see_also = ['checkouts', 'unbind']
4170
takes_args = ['location?']
4173
def run(self, location=None):
4174
b, relpath = Branch.open_containing(u'.')
4175
if location is None:
4177
location = b.get_old_bound_location()
4178
except errors.UpgradeRequired:
4179
raise errors.BzrCommandError('No location supplied. '
4180
'This format does not remember old locations.')
4182
if location is None:
4183
raise errors.BzrCommandError('No location supplied and no '
4184
'previous location known')
4185
b_other = Branch.open(location)
4188
except errors.DivergedBranches:
4189
raise errors.BzrCommandError('These branches have diverged.'
4190
' Try merging, and then bind again.')
4191
if b.get_config().has_explicit_nickname():
4192
b.nick = b_other.nick
4195
class cmd_unbind(Command):
4196
"""Convert the current checkout into a regular branch.
4198
After unbinding, the local branch is considered independent and subsequent
4199
commits will be local only.
4202
_see_also = ['checkouts', 'bind']
4207
b, relpath = Branch.open_containing(u'.')
4209
raise errors.BzrCommandError('Local branch is not bound')
4212
class cmd_uncommit(Command):
4213
"""Remove the last committed revision.
4215
--verbose will print out what is being removed.
4216
--dry-run will go through all the motions, but not actually
4219
If --revision is specified, uncommit revisions to leave the branch at the
4220
specified revision. For example, "bzr uncommit -r 15" will leave the
4221
branch at revision 15.
4223
Uncommit leaves the working tree ready for a new commit. The only change
4224
it may make is to restore any pending merges that were present before
4228
# TODO: jam 20060108 Add an option to allow uncommit to remove
4229
# unreferenced information in 'branch-as-repository' branches.
4230
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4231
# information in shared branches as well.
4232
_see_also = ['commit']
4233
takes_options = ['verbose', 'revision',
4234
Option('dry-run', help='Don\'t actually make changes.'),
4235
Option('force', help='Say yes to all questions.'),
4237
help="Only remove the commits from the local branch"
4238
" when in a checkout."
4241
takes_args = ['location?']
4243
encoding_type = 'replace'
4245
def run(self, location=None,
4246
dry_run=False, verbose=False,
4247
revision=None, force=False, local=False):
4248
if location is None:
4250
control, relpath = bzrdir.BzrDir.open_containing(location)
4252
tree = control.open_workingtree()
4254
except (errors.NoWorkingTree, errors.NotLocalUrl):
4256
b = control.open_branch()
4258
if tree is not None:
4263
return self._run(b, tree, dry_run, verbose, revision, force,
4266
if tree is not None:
4271
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4272
from bzrlib.log import log_formatter, show_log
4273
from bzrlib.uncommit import uncommit
4275
last_revno, last_rev_id = b.last_revision_info()
4278
if revision is None:
4280
rev_id = last_rev_id
4282
# 'bzr uncommit -r 10' actually means uncommit
4283
# so that the final tree is at revno 10.
4284
# but bzrlib.uncommit.uncommit() actually uncommits
4285
# the revisions that are supplied.
4286
# So we need to offset it by one
4287
revno = revision[0].in_history(b).revno + 1
4288
if revno <= last_revno:
4289
rev_id = b.get_rev_id(revno)
4291
if rev_id is None or _mod_revision.is_null(rev_id):
4292
self.outf.write('No revisions to uncommit.\n')
4295
lf = log_formatter('short',
4297
show_timezone='original')
4302
direction='forward',
4303
start_revision=revno,
4304
end_revision=last_revno)
4307
print 'Dry-run, pretending to remove the above revisions.'
4309
val = raw_input('Press <enter> to continue')
4311
print 'The above revision(s) will be removed.'
4313
val = raw_input('Are you sure [y/N]? ')
4314
if val.lower() not in ('y', 'yes'):
4318
mutter('Uncommitting from {%s} to {%s}',
4319
last_rev_id, rev_id)
4320
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4321
revno=revno, local=local)
4322
note('You can restore the old tip by running:\n'
4323
' bzr pull . -r revid:%s', last_rev_id)
4326
class cmd_break_lock(Command):
4327
"""Break a dead lock on a repository, branch or working directory.
4329
CAUTION: Locks should only be broken when you are sure that the process
4330
holding the lock has been stopped.
4332
You can get information on what locks are open via the 'bzr info' command.
4337
takes_args = ['location?']
4339
def run(self, location=None, show=False):
4340
if location is None:
4342
control, relpath = bzrdir.BzrDir.open_containing(location)
4344
control.break_lock()
4345
except NotImplementedError:
4349
class cmd_wait_until_signalled(Command):
4350
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4352
This just prints a line to signal when it is ready, then blocks on stdin.
4358
sys.stdout.write("running\n")
4360
sys.stdin.readline()
4363
class cmd_serve(Command):
4364
"""Run the bzr server."""
4366
aliases = ['server']
4370
help='Serve on stdin/out for use from inetd or sshd.'),
4372
help='Listen for connections on nominated port of the form '
4373
'[hostname:]portnumber. Passing 0 as the port number will '
4374
'result in a dynamically allocated port. The default port is '
4378
help='Serve contents of this directory.',
4380
Option('allow-writes',
4381
help='By default the server is a readonly server. Supplying '
4382
'--allow-writes enables write access to the contents of '
4383
'the served directory and below.'
4387
def run_smart_server(self, smart_server):
4388
"""Run 'smart_server' forever, with no UI output at all."""
4389
# For the duration of this server, no UI output is permitted. note
4390
# that this may cause problems with blackbox tests. This should be
4391
# changed with care though, as we dont want to use bandwidth sending
4392
# progress over stderr to smart server clients!
4393
from bzrlib import lockdir
4394
old_factory = ui.ui_factory
4395
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
4397
ui.ui_factory = ui.SilentUIFactory()
4398
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
4399
smart_server.serve()
4401
ui.ui_factory = old_factory
4402
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
4404
def get_host_and_port(self, port):
4405
"""Return the host and port to run the smart server on.
4407
If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
4408
and port (`medium.BZR_DEFAULT_PORT`) will be used.
4410
If 'port' has a colon in it, the string before the colon will be
4411
interpreted as the host.
4413
:param port: A string of the port to run the server on.
4414
:return: A tuple of (host, port), where 'host' is a host name or IP,
4415
and port is an integer TCP/IP port.
4417
from bzrlib.smart import medium
4418
host = medium.BZR_DEFAULT_INTERFACE
4420
port = medium.BZR_DEFAULT_PORT
4423
host, port = port.split(':')
4427
def get_smart_server(self, transport, inet, port):
4428
"""Construct a smart server.
4430
:param transport: The base transport from which branches will be
4432
:param inet: If True, serve over stdin and stdout. Used for running
4434
:param port: The port to listen on. By default, it's `
4435
medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
4437
:return: A smart server.
4439
from bzrlib.smart import medium, server
4441
smart_server = medium.SmartServerPipeStreamMedium(
4442
sys.stdin, sys.stdout, transport)
4444
host, port = self.get_host_and_port(port)
4445
smart_server = server.SmartTCPServer(
4446
transport, host=host, port=port)
4447
note('listening on port: %s' % smart_server.port)
4450
def run(self, port=None, inet=False, directory=None, allow_writes=False):
4451
from bzrlib.transport import get_transport
4452
from bzrlib.transport.chroot import ChrootServer
4453
if directory is None:
4454
directory = os.getcwd()
4455
url = urlutils.local_path_to_url(directory)
4456
if not allow_writes:
4457
url = 'readonly+' + url
4458
chroot_server = ChrootServer(get_transport(url))
4459
chroot_server.setUp()
4460
t = get_transport(chroot_server.get_url())
4461
smart_server = self.get_smart_server(t, inet, port)
4462
self.run_smart_server(smart_server)
4465
class cmd_join(Command):
4466
"""Combine a subtree into its containing tree.
4468
This command is for experimental use only. It requires the target tree
4469
to be in dirstate-with-subtree format, which cannot be converted into
4472
The TREE argument should be an independent tree, inside another tree, but
4473
not part of it. (Such trees can be produced by "bzr split", but also by
4474
running "bzr branch" with the target inside a tree.)
4476
The result is a combined tree, with the subtree no longer an independant
4477
part. This is marked as a merge of the subtree into the containing tree,
4478
and all history is preserved.
4480
If --reference is specified, the subtree retains its independence. It can
4481
be branched by itself, and can be part of multiple projects at the same
4482
time. But operations performed in the containing tree, such as commit
4483
and merge, will recurse into the subtree.
4486
_see_also = ['split']
4487
takes_args = ['tree']
4489
Option('reference', help='Join by reference.'),
4493
def run(self, tree, reference=False):
4494
sub_tree = WorkingTree.open(tree)
4495
parent_dir = osutils.dirname(sub_tree.basedir)
4496
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4497
repo = containing_tree.branch.repository
4498
if not repo.supports_rich_root():
4499
raise errors.BzrCommandError(
4500
"Can't join trees because %s doesn't support rich root data.\n"
4501
"You can use bzr upgrade on the repository."
4505
containing_tree.add_reference(sub_tree)
4506
except errors.BadReferenceTarget, e:
4507
# XXX: Would be better to just raise a nicely printable
4508
# exception from the real origin. Also below. mbp 20070306
4509
raise errors.BzrCommandError("Cannot join %s. %s" %
4513
containing_tree.subsume(sub_tree)
4514
except errors.BadSubsumeSource, e:
4515
raise errors.BzrCommandError("Cannot join %s. %s" %
4519
class cmd_split(Command):
4520
"""Split a subdirectory of a tree into a separate tree.
4522
This command will produce a target tree in a format that supports
4523
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4524
converted into earlier formats like 'dirstate-tags'.
4526
The TREE argument should be a subdirectory of a working tree. That
4527
subdirectory will be converted into an independent tree, with its own
4528
branch. Commits in the top-level tree will not apply to the new subtree.
4531
# join is not un-hidden yet
4532
#_see_also = ['join']
4533
takes_args = ['tree']
4535
def run(self, tree):
4536
containing_tree, subdir = WorkingTree.open_containing(tree)
4537
sub_id = containing_tree.path2id(subdir)
4539
raise errors.NotVersionedError(subdir)
4541
containing_tree.extract(sub_id)
4542
except errors.RootNotRich:
4543
raise errors.UpgradeRequired(containing_tree.branch.base)
4546
class cmd_merge_directive(Command):
4547
"""Generate a merge directive for auto-merge tools.
4549
A directive requests a merge to be performed, and also provides all the
4550
information necessary to do so. This means it must either include a
4551
revision bundle, or the location of a branch containing the desired
4554
A submit branch (the location to merge into) must be supplied the first
4555
time the command is issued. After it has been supplied once, it will
4556
be remembered as the default.
4558
A public branch is optional if a revision bundle is supplied, but required
4559
if --diff or --plain is specified. It will be remembered as the default
4560
after the first use.
4563
takes_args = ['submit_branch?', 'public_branch?']
4567
_see_also = ['send']
4570
RegistryOption.from_kwargs('patch-type',
4571
'The type of patch to include in the directive.',
4573
value_switches=True,
4575
bundle='Bazaar revision bundle (default).',
4576
diff='Normal unified diff.',
4577
plain='No patch, just directive.'),
4578
Option('sign', help='GPG-sign the directive.'), 'revision',
4579
Option('mail-to', type=str,
4580
help='Instead of printing the directive, email to this address.'),
4581
Option('message', type=str, short_name='m',
4582
help='Message to use when committing this merge.')
4585
encoding_type = 'exact'
4587
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4588
sign=False, revision=None, mail_to=None, message=None):
4589
from bzrlib.revision import ensure_null, NULL_REVISION
4590
include_patch, include_bundle = {
4591
'plain': (False, False),
4592
'diff': (True, False),
4593
'bundle': (True, True),
4595
branch = Branch.open('.')
4596
stored_submit_branch = branch.get_submit_branch()
4597
if submit_branch is None:
4598
submit_branch = stored_submit_branch
4600
if stored_submit_branch is None:
4601
branch.set_submit_branch(submit_branch)
4602
if submit_branch is None:
4603
submit_branch = branch.get_parent()
4604
if submit_branch is None:
4605
raise errors.BzrCommandError('No submit branch specified or known')
4607
stored_public_branch = branch.get_public_branch()
4608
if public_branch is None:
4609
public_branch = stored_public_branch
4610
elif stored_public_branch is None:
4611
branch.set_public_branch(public_branch)
4612
if not include_bundle and public_branch is None:
4613
raise errors.BzrCommandError('No public branch specified or'
4615
base_revision_id = None
4616
if revision is not None:
4617
if len(revision) > 2:
4618
raise errors.BzrCommandError('bzr merge-directive takes '
4619
'at most two one revision identifiers')
4620
revision_id = revision[-1].as_revision_id(branch)
4621
if len(revision) == 2:
4622
base_revision_id = revision[0].as_revision_id(branch)
4624
revision_id = branch.last_revision()
4625
revision_id = ensure_null(revision_id)
4626
if revision_id == NULL_REVISION:
4627
raise errors.BzrCommandError('No revisions to bundle.')
4628
directive = merge_directive.MergeDirective2.from_objects(
4629
branch.repository, revision_id, time.time(),
4630
osutils.local_time_offset(), submit_branch,
4631
public_branch=public_branch, include_patch=include_patch,
4632
include_bundle=include_bundle, message=message,
4633
base_revision_id=base_revision_id)
4636
self.outf.write(directive.to_signed(branch))
4638
self.outf.writelines(directive.to_lines())
4640
message = directive.to_email(mail_to, branch, sign)
4641
s = SMTPConnection(branch.get_config())
4642
s.send_email(message)
4645
class cmd_send(Command):
4646
"""Mail or create a merge-directive for submitting changes.
4648
A merge directive provides many things needed for requesting merges:
4650
* A machine-readable description of the merge to perform
4652
* An optional patch that is a preview of the changes requested
4654
* An optional bundle of revision data, so that the changes can be applied
4655
directly from the merge directive, without retrieving data from a
4658
If --no-bundle is specified, then public_branch is needed (and must be
4659
up-to-date), so that the receiver can perform the merge using the
4660
public_branch. The public_branch is always included if known, so that
4661
people can check it later.
4663
The submit branch defaults to the parent, but can be overridden. Both
4664
submit branch and public branch will be remembered if supplied.
4666
If a public_branch is known for the submit_branch, that public submit
4667
branch is used in the merge instructions. This means that a local mirror
4668
can be used as your actual submit branch, once you have set public_branch
4671
Mail is sent using your preferred mail program. This should be transparent
4672
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4673
If the preferred client can't be found (or used), your editor will be used.
4675
To use a specific mail program, set the mail_client configuration option.
4676
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4677
specific clients are "claws", "evolution", "kmail", "mutt", and
4678
"thunderbird"; generic options are "default", "editor", "emacsclient",
4679
"mapi", and "xdg-email". Plugins may also add supported clients.
4681
If mail is being sent, a to address is required. This can be supplied
4682
either on the commandline, by setting the submit_to configuration
4683
option in the branch itself or the child_submit_to configuration option
4684
in the submit branch.
4686
Two formats are currently supported: "4" uses revision bundle format 4 and
4687
merge directive format 2. It is significantly faster and smaller than
4688
older formats. It is compatible with Bazaar 0.19 and later. It is the
4689
default. "0.9" uses revision bundle format 0.9 and merge directive
4690
format 1. It is compatible with Bazaar 0.12 - 0.18.
4692
Merge directives are applied using the merge command or the pull command.
4695
encoding_type = 'exact'
4697
_see_also = ['merge', 'pull']
4699
takes_args = ['submit_branch?', 'public_branch?']
4703
help='Do not include a bundle in the merge directive.'),
4704
Option('no-patch', help='Do not include a preview patch in the merge'
4707
help='Remember submit and public branch.'),
4709
help='Branch to generate the submission from, '
4710
'rather than the one containing the working directory.',
4713
Option('output', short_name='o',
4714
help='Write merge directive to this file; '
4715
'use - for stdout.',
4717
Option('mail-to', help='Mail the request to this address.',
4721
RegistryOption.from_kwargs('format',
4722
'Use the specified output format.',
4723
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4724
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4727
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4728
no_patch=False, revision=None, remember=False, output=None,
4729
format='4', mail_to=None, message=None, **kwargs):
4730
return self._run(submit_branch, revision, public_branch, remember,
4731
format, no_bundle, no_patch, output,
4732
kwargs.get('from', '.'), mail_to, message)
4734
def _run(self, submit_branch, revision, public_branch, remember, format,
4735
no_bundle, no_patch, output, from_, mail_to, message):
4736
from bzrlib.revision import NULL_REVISION
4737
branch = Branch.open_containing(from_)[0]
4739
outfile = cStringIO.StringIO()
4743
outfile = open(output, 'wb')
4744
# we may need to write data into branch's repository to calculate
4749
config = branch.get_config()
4751
mail_to = config.get_user_option('submit_to')
4752
mail_client = config.get_mail_client()
4753
if remember and submit_branch is None:
4754
raise errors.BzrCommandError(
4755
'--remember requires a branch to be specified.')
4756
stored_submit_branch = branch.get_submit_branch()
4757
remembered_submit_branch = None
4758
if submit_branch is None:
4759
submit_branch = stored_submit_branch
4760
remembered_submit_branch = "submit"
4762
if stored_submit_branch is None or remember:
4763
branch.set_submit_branch(submit_branch)
4764
if submit_branch is None:
4765
submit_branch = branch.get_parent()
4766
remembered_submit_branch = "parent"
4767
if submit_branch is None:
4768
raise errors.BzrCommandError('No submit branch known or'
4770
if remembered_submit_branch is not None:
4771
note('Using saved %s location "%s" to determine what '
4772
'changes to submit.', remembered_submit_branch,
4776
submit_config = Branch.open(submit_branch).get_config()
4777
mail_to = submit_config.get_user_option("child_submit_to")
4779
stored_public_branch = branch.get_public_branch()
4780
if public_branch is None:
4781
public_branch = stored_public_branch
4782
elif stored_public_branch is None or remember:
4783
branch.set_public_branch(public_branch)
4784
if no_bundle and public_branch is None:
4785
raise errors.BzrCommandError('No public branch specified or'
4787
base_revision_id = None
4789
if revision is not None:
4790
if len(revision) > 2:
4791
raise errors.BzrCommandError('bzr send takes '
4792
'at most two one revision identifiers')
4793
revision_id = revision[-1].as_revision_id(branch)
4794
if len(revision) == 2:
4795
base_revision_id = revision[0].as_revision_id(branch)
4796
if revision_id is None:
4797
revision_id = branch.last_revision()
4798
if revision_id == NULL_REVISION:
4799
raise errors.BzrCommandError('No revisions to submit.')
4801
directive = merge_directive.MergeDirective2.from_objects(
4802
branch.repository, revision_id, time.time(),
4803
osutils.local_time_offset(), submit_branch,
4804
public_branch=public_branch, include_patch=not no_patch,
4805
include_bundle=not no_bundle, message=message,
4806
base_revision_id=base_revision_id)
4807
elif format == '0.9':
4810
patch_type = 'bundle'
4812
raise errors.BzrCommandError('Format 0.9 does not'
4813
' permit bundle with no patch')
4819
directive = merge_directive.MergeDirective.from_objects(
4820
branch.repository, revision_id, time.time(),
4821
osutils.local_time_offset(), submit_branch,
4822
public_branch=public_branch, patch_type=patch_type,
4825
outfile.writelines(directive.to_lines())
4827
subject = '[MERGE] '
4828
if message is not None:
4831
revision = branch.repository.get_revision(revision_id)
4832
subject += revision.get_summary()
4833
basename = directive.get_disk_name(branch)
4834
mail_client.compose_merge_request(mail_to, subject,
4835
outfile.getvalue(), basename)
4842
class cmd_bundle_revisions(cmd_send):
4844
"""Create a merge-directive for submitting changes.
4846
A merge directive provides many things needed for requesting merges:
4848
* A machine-readable description of the merge to perform
4850
* An optional patch that is a preview of the changes requested
4852
* An optional bundle of revision data, so that the changes can be applied
4853
directly from the merge directive, without retrieving data from a
4856
If --no-bundle is specified, then public_branch is needed (and must be
4857
up-to-date), so that the receiver can perform the merge using the
4858
public_branch. The public_branch is always included if known, so that
4859
people can check it later.
4861
The submit branch defaults to the parent, but can be overridden. Both
4862
submit branch and public branch will be remembered if supplied.
4864
If a public_branch is known for the submit_branch, that public submit
4865
branch is used in the merge instructions. This means that a local mirror
4866
can be used as your actual submit branch, once you have set public_branch
4869
Two formats are currently supported: "4" uses revision bundle format 4 and
4870
merge directive format 2. It is significantly faster and smaller than
4871
older formats. It is compatible with Bazaar 0.19 and later. It is the
4872
default. "0.9" uses revision bundle format 0.9 and merge directive
4873
format 1. It is compatible with Bazaar 0.12 - 0.18.
4878
help='Do not include a bundle in the merge directive.'),
4879
Option('no-patch', help='Do not include a preview patch in the merge'
4882
help='Remember submit and public branch.'),
4884
help='Branch to generate the submission from, '
4885
'rather than the one containing the working directory.',
4888
Option('output', short_name='o', help='Write directive to this file.',
4891
RegistryOption.from_kwargs('format',
4892
'Use the specified output format.',
4893
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4894
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4896
aliases = ['bundle']
4898
_see_also = ['send', 'merge']
4902
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4903
no_patch=False, revision=None, remember=False, output=None,
4904
format='4', **kwargs):
4907
return self._run(submit_branch, revision, public_branch, remember,
4908
format, no_bundle, no_patch, output,
4909
kwargs.get('from', '.'), None, None)
4912
class cmd_tag(Command):
4913
"""Create, remove or modify a tag naming a revision.
4915
Tags give human-meaningful names to revisions. Commands that take a -r
4916
(--revision) option can be given -rtag:X, where X is any previously
4919
Tags are stored in the branch. Tags are copied from one branch to another
4920
along when you branch, push, pull or merge.
4922
It is an error to give a tag name that already exists unless you pass
4923
--force, in which case the tag is moved to point to the new revision.
4925
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4926
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4929
_see_also = ['commit', 'tags']
4930
takes_args = ['tag_name']
4933
help='Delete this tag rather than placing it.',
4936
help='Branch in which to place the tag.',
4941
help='Replace existing tags.',
4946
def run(self, tag_name,
4952
branch, relpath = Branch.open_containing(directory)
4956
branch.tags.delete_tag(tag_name)
4957
self.outf.write('Deleted tag %s.\n' % tag_name)
4960
if len(revision) != 1:
4961
raise errors.BzrCommandError(
4962
"Tags can only be placed on a single revision, "
4964
revision_id = revision[0].as_revision_id(branch)
4966
revision_id = branch.last_revision()
4967
if (not force) and branch.tags.has_tag(tag_name):
4968
raise errors.TagAlreadyExists(tag_name)
4969
branch.tags.set_tag(tag_name, revision_id)
4970
self.outf.write('Created tag %s.\n' % tag_name)
4975
class cmd_tags(Command):
4978
This command shows a table of tag names and the revisions they reference.
4984
help='Branch whose tags should be displayed.',
4988
RegistryOption.from_kwargs('sort',
4989
'Sort tags by different criteria.', title='Sorting',
4990
alpha='Sort tags lexicographically (default).',
4991
time='Sort tags chronologically.',
5004
branch, relpath = Branch.open_containing(directory)
5006
tags = branch.tags.get_tag_dict().items()
5013
graph = branch.repository.get_graph()
5014
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5015
revid1, revid2 = rev1.rev_id, rev2.rev_id
5016
# only show revisions between revid1 and revid2 (inclusive)
5017
tags = [(tag, revid) for tag, revid in tags if
5018
graph.is_between(revid, revid1, revid2)]
5023
elif sort == 'time':
5025
for tag, revid in tags:
5027
revobj = branch.repository.get_revision(revid)
5028
except errors.NoSuchRevision:
5029
timestamp = sys.maxint # place them at the end
5031
timestamp = revobj.timestamp
5032
timestamps[revid] = timestamp
5033
tags.sort(key=lambda x: timestamps[x[1]])
5035
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5036
revno_map = branch.get_revision_id_to_revno_map()
5037
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
5038
for tag, revid in tags ]
5039
for tag, revspec in tags:
5040
self.outf.write('%-20s %s\n' % (tag, revspec))
5043
class cmd_reconfigure(Command):
5044
"""Reconfigure the type of a bzr directory.
5046
A target configuration must be specified.
5048
For checkouts, the bind-to location will be auto-detected if not specified.
5049
The order of preference is
5050
1. For a lightweight checkout, the current bound location.
5051
2. For branches that used to be checkouts, the previously-bound location.
5052
3. The push location.
5053
4. The parent location.
5054
If none of these is available, --bind-to must be specified.
5057
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5058
takes_args = ['location?']
5060
RegistryOption.from_kwargs(
5062
title='Target type',
5063
help='The type to reconfigure the directory to.',
5064
value_switches=True, enum_switch=False,
5065
branch='Reconfigure to be an unbound branch with no working tree.',
5066
tree='Reconfigure to be an unbound branch with a working tree.',
5067
checkout='Reconfigure to be a bound branch with a working tree.',
5068
lightweight_checkout='Reconfigure to be a lightweight'
5069
' checkout (with no local history).',
5070
standalone='Reconfigure to be a standalone branch '
5071
'(i.e. stop using shared repository).',
5072
use_shared='Reconfigure to use a shared repository.',
5073
with_trees='Reconfigure repository to create '
5074
'working trees on branches by default.',
5075
with_no_trees='Reconfigure repository to not create '
5076
'working trees on branches by default.'
5078
Option('bind-to', help='Branch to bind checkout to.', type=str),
5080
help='Perform reconfiguration even if local changes'
5084
def run(self, location=None, target_type=None, bind_to=None, force=False):
5085
directory = bzrdir.BzrDir.open(location)
5086
if target_type is None:
5087
raise errors.BzrCommandError('No target configuration specified')
5088
elif target_type == 'branch':
5089
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5090
elif target_type == 'tree':
5091
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5092
elif target_type == 'checkout':
5093
reconfiguration = reconfigure.Reconfigure.to_checkout(
5095
elif target_type == 'lightweight-checkout':
5096
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5098
elif target_type == 'use-shared':
5099
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5100
elif target_type == 'standalone':
5101
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5102
elif target_type == 'with-trees':
5103
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5105
elif target_type == 'with-no-trees':
5106
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5108
reconfiguration.apply(force)
5111
class cmd_switch(Command):
5112
"""Set the branch of a checkout and update.
5114
For lightweight checkouts, this changes the branch being referenced.
5115
For heavyweight checkouts, this checks that there are no local commits
5116
versus the current bound branch, then it makes the local branch a mirror
5117
of the new location and binds to it.
5119
In both cases, the working tree is updated and uncommitted changes
5120
are merged. The user can commit or revert these as they desire.
5122
Pending merges need to be committed or reverted before using switch.
5124
The path to the branch to switch to can be specified relative to the parent
5125
directory of the current branch. For example, if you are currently in a
5126
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5129
Bound branches use the nickname of its master branch unless it is set
5130
locally, in which case switching will update the the local nickname to be
5134
takes_args = ['to_location']
5135
takes_options = [Option('force',
5136
help='Switch even if local commits will be lost.')
5139
def run(self, to_location, force=False):
5140
from bzrlib import switch
5142
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5143
branch = control_dir.open_branch()
5145
to_branch = Branch.open(to_location)
5146
except errors.NotBranchError:
5147
this_branch = control_dir.open_branch()
5148
# This may be a heavy checkout, where we want the master branch
5149
this_url = this_branch.get_bound_location()
5150
# If not, use a local sibling
5151
if this_url is None:
5152
this_url = this_branch.base
5153
to_branch = Branch.open(
5154
urlutils.join(this_url, '..', to_location))
5155
switch.switch(control_dir, to_branch, force)
5156
if branch.get_config().has_explicit_nickname():
5157
branch = control_dir.open_branch() #get the new branch!
5158
branch.nick = to_branch.nick
5159
note('Switched to branch: %s',
5160
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5163
class cmd_view(Command):
5164
"""Manage filtered views.
5166
Views provide a mask over the tree so that users can focus on
5167
a subset of a tree when doing their work. After creating a view,
5168
commands that support a list of files - status, diff, commit, etc -
5169
effectively have that list of files implicitly given each time.
5170
An explicit list of files can still be given but those files
5171
must be within the current view.
5173
In most cases, a view has a short life-span: it is created to make
5174
a selected change and is deleted once that change is committed.
5175
At other times, you may wish to create one or more named views
5176
and switch between them.
5178
To disable the current view without deleting it, you can switch to
5179
the pseudo view called ``off``. This can be useful when you need
5180
to see the whole tree for an operation or two (e.g. merge) but
5181
want to switch back to your view after that.
5184
To define the current view::
5186
bzr view file1 dir1 ...
5188
To list the current view::
5192
To delete the current view::
5196
To disable the current view without deleting it::
5198
bzr view --switch off
5200
To define a named view and switch to it::
5202
bzr view --name view-name file1 dir1 ...
5204
To list a named view::
5206
bzr view --name view-name
5208
To delete a named view::
5210
bzr view --name view-name --delete
5212
To switch to a named view::
5214
bzr view --switch view-name
5216
To list all views defined::
5220
To delete all views::
5222
bzr view --delete --all
5226
takes_args = ['file*']
5229
help='Apply list or delete action to all views.',
5232
help='Delete the view.',
5235
help='Name of the view to define, list or delete.',
5239
help='Name of the view to switch to.',
5244
def run(self, file_list,
5250
tree, file_list = tree_files(file_list, apply_view=False)
5251
current_view, view_dict = tree.views.get_view_info()
5256
raise errors.BzrCommandError(
5257
"Both --delete and a file list specified")
5259
raise errors.BzrCommandError(
5260
"Both --delete and --switch specified")
5262
tree.views.set_view_info(None, {})
5263
self.outf.write("Deleted all views.\n")
5265
raise errors.BzrCommandError("No current view to delete")
5267
tree.views.delete_view(name)
5268
self.outf.write("Deleted '%s' view.\n" % name)
5271
raise errors.BzrCommandError(
5272
"Both --switch and a file list specified")
5274
raise errors.BzrCommandError(
5275
"Both --switch and --all specified")
5276
elif switch == 'off':
5277
if current_view is None:
5278
raise errors.BzrCommandError("No current view to disable")
5279
tree.views.set_view_info(None, view_dict)
5280
self.outf.write("Disabled '%s' view.\n" % (current_view))
5282
tree.views.set_view_info(switch, view_dict)
5283
view_str = views.view_display_str(tree.views.lookup_view())
5284
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5287
self.outf.write('Views defined:\n')
5288
for view in sorted(view_dict):
5289
if view == current_view:
5293
view_str = views.view_display_str(view_dict[view])
5294
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5296
self.outf.write('No views defined.\n')
5299
# No name given and no current view set
5302
raise errors.BzrCommandError(
5303
"Cannot change the 'off' pseudo view")
5304
tree.views.set_view(name, sorted(file_list))
5305
view_str = views.view_display_str(tree.views.lookup_view())
5306
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5310
# No name given and no current view set
5311
self.outf.write('No current view.\n')
5313
view_str = views.view_display_str(tree.views.lookup_view(name))
5314
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5317
class cmd_hooks(Command):
5318
"""Show a branch's currently registered hooks.
5322
takes_args = ['path?']
5324
def run(self, path=None):
5327
branch_hooks = Branch.open(path).hooks
5328
for hook_type in branch_hooks:
5329
hooks = branch_hooks[hook_type]
5330
self.outf.write("%s:\n" % (hook_type,))
5333
self.outf.write(" %s\n" %
5334
(branch_hooks.get_hook_name(hook),))
5336
self.outf.write(" <no hooks installed>\n")
5339
class cmd_shelve(Command):
5340
"""Temporarily set aside some changes from the current tree.
5342
Shelve allows you to temporarily put changes you've made "on the shelf",
5343
ie. out of the way, until a later time when you can bring them back from
5344
the shelf with the 'unshelve' command. The changes are stored alongside
5345
your working tree, and so they aren't propagated along with your branch nor
5346
will they survive its deletion.
5348
If shelve --list is specified, previously-shelved changes are listed.
5350
Shelve is intended to help separate several sets of changes that have
5351
been inappropriately mingled. If you just want to get rid of all changes
5352
and you don't need to restore them later, use revert. If you want to
5353
shelve all text changes at once, use shelve --all.
5355
If filenames are specified, only the changes to those files will be
5356
shelved. Other files will be left untouched.
5358
If a revision is specified, changes since that revision will be shelved.
5360
You can put multiple items on the shelf, and by default, 'unshelve' will
5361
restore the most recently shelved changes.
5364
takes_args = ['file*']
5368
Option('all', help='Shelve all changes.'),
5370
RegistryOption('writer', 'Method to use for writing diffs.',
5371
bzrlib.option.diff_writer_registry,
5372
value_switches=True, enum_switch=False),
5374
Option('list', help='List shelved changes.'),
5376
_see_also = ['unshelve']
5378
def run(self, revision=None, all=False, file_list=None, message=None,
5379
writer=None, list=False):
5381
return self.run_for_list()
5382
from bzrlib.shelf_ui import Shelver
5384
writer = bzrlib.option.diff_writer_registry.get()
5386
Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5388
except errors.UserAbort:
5391
def run_for_list(self):
5392
tree = WorkingTree.open_containing('.')[0]
5395
manager = tree.get_shelf_manager()
5396
shelves = manager.active_shelves()
5397
if len(shelves) == 0:
5398
note('No shelved changes.')
5400
for shelf_id in reversed(shelves):
5401
message = manager.get_metadata(shelf_id).get('message')
5403
message = '<no message>'
5404
self.outf.write('%3d: %s\n' % (shelf_id, message))
5410
class cmd_unshelve(Command):
5411
"""Restore shelved changes.
5413
By default, the most recently shelved changes are restored. However if you
5414
specify a shelf by id those changes will be restored instead. This works
5415
best when the changes don't depend on each other.
5418
takes_args = ['shelf_id?']
5420
RegistryOption.from_kwargs(
5421
'action', help="The action to perform.",
5422
enum_switch=False, value_switches=True,
5423
apply="Apply changes and remove from the shelf.",
5424
dry_run="Show changes, but do not apply or remove them.",
5425
delete_only="Delete changes without applying them."
5428
_see_also = ['shelve']
5430
def run(self, shelf_id=None, action='apply'):
5431
from bzrlib.shelf_ui import Unshelver
5432
Unshelver.from_args(shelf_id, action).run()
5435
def _create_prefix(cur_transport):
5436
needed = [cur_transport]
5437
# Recurse upwards until we can create a directory successfully
5439
new_transport = cur_transport.clone('..')
5440
if new_transport.base == cur_transport.base:
5441
raise errors.BzrCommandError(
5442
"Failed to create path prefix for %s."
5443
% cur_transport.base)
5445
new_transport.mkdir('.')
5446
except errors.NoSuchFile:
5447
needed.append(new_transport)
5448
cur_transport = new_transport
5451
# Now we only need to create child directories
5453
cur_transport = needed.pop()
5454
cur_transport.ensure_base()
5457
# these get imported and then picked up by the scan for cmd_*
5458
# TODO: Some more consistent way to split command definitions across files;
5459
# we do need to load at least some information about them to know of
5460
# aliases. ideally we would avoid loading the implementation until the
5461
# details were needed.
5462
from bzrlib.cmd_version_info import cmd_version_info
5463
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5464
from bzrlib.bundle.commands import (
5467
from bzrlib.sign_my_commits import cmd_sign_my_commits
5468
from bzrlib.weave_commands import cmd_versionedfile_list, \
5469
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
