1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
35
config as _mod_config,
45
revision as _mod_revision,
54
from bzrlib.branch import Branch
55
from bzrlib.conflicts import ConflictList
56
from bzrlib.transport import memory
57
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
58
from bzrlib.smtp_connection import SMTPConnection
59
from bzrlib.workingtree import WorkingTree
62
from bzrlib.commands import (
64
builtin_command_registry,
67
from bzrlib.option import (
74
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
80
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
81
def tree_files(file_list, default_branch=u'.', canonicalize=True,
83
return internal_tree_files(file_list, default_branch, canonicalize,
87
def tree_files_for_add(file_list):
89
Return a tree and list of absolute paths from a file list.
91
Similar to tree_files, but add handles files a bit differently, so it a
92
custom implementation. In particular, MutableTreeTree.smart_add expects
93
absolute paths, which it immediately converts to relative paths.
95
# FIXME Would be nice to just return the relative paths like
96
# internal_tree_files does, but there are a large number of unit tests
97
# that assume the current interface to mutabletree.smart_add
99
tree, relpath = WorkingTree.open_containing(file_list[0])
100
if tree.supports_views():
101
view_files = tree.views.lookup_view()
103
for filename in file_list:
104
if not osutils.is_inside_any(view_files, filename):
105
raise errors.FileOutsideView(filename, view_files)
106
file_list = file_list[:]
107
file_list[0] = tree.abspath(relpath)
109
tree = WorkingTree.open_containing(u'.')[0]
110
if tree.supports_views():
111
view_files = tree.views.lookup_view()
113
file_list = view_files
114
view_str = views.view_display_str(view_files)
115
note("Ignoring files outside view. View is %s" % view_str)
116
return tree, file_list
119
def _get_one_revision(command_name, revisions):
120
if revisions is None:
122
if len(revisions) != 1:
123
raise errors.BzrCommandError(
124
'bzr %s --revision takes exactly one revision identifier' % (
129
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
130
"""Get a revision tree. Not suitable for commands that change the tree.
132
Specifically, the basis tree in dirstate trees is coupled to the dirstate
133
and doing a commit/uncommit/pull will at best fail due to changing the
136
If tree is passed in, it should be already locked, for lifetime management
137
of the trees internal cached state.
141
if revisions is None:
143
rev_tree = tree.basis_tree()
145
rev_tree = branch.basis_tree()
147
revision = _get_one_revision(command_name, revisions)
148
rev_tree = revision.as_tree(branch)
152
# XXX: Bad function name; should possibly also be a class method of
153
# WorkingTree rather than a function.
154
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
155
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
157
"""Convert command-line paths to a WorkingTree and relative paths.
159
Deprecated: use WorkingTree.open_containing_paths instead.
161
This is typically used for command-line processors that take one or
162
more filenames, and infer the workingtree that contains them.
164
The filenames given are not required to exist.
166
:param file_list: Filenames to convert.
168
:param default_branch: Fallback tree path to use if file_list is empty or
171
:param apply_view: if True and a view is set, apply it or check that
172
specified files are within it
174
:return: workingtree, [relative_paths]
176
return WorkingTree.open_containing_paths(
177
file_list, default_directory='.',
182
def _get_view_info_for_change_reporter(tree):
183
"""Get the view information from a tree for change reporting."""
186
current_view = tree.views.get_view_info()[0]
187
if current_view is not None:
188
view_info = (current_view, tree.views.lookup_view())
189
except errors.ViewsNotSupported:
194
def _open_directory_or_containing_tree_or_branch(filename, directory):
195
"""Open the tree or branch containing the specified file, unless
196
the --directory option is used to specify a different branch."""
197
if directory is not None:
198
return (None, Branch.open(directory), filename)
199
return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
202
# TODO: Make sure no commands unconditionally use the working directory as a
203
# branch. If a filename argument is used, the first of them should be used to
204
# specify the branch. (Perhaps this can be factored out into some kind of
205
# Argument class, representing a file in a branch, where the first occurrence
208
class cmd_status(Command):
209
__doc__ = """Display status summary.
211
This reports on versioned and unknown files, reporting them
212
grouped by state. Possible states are:
215
Versioned in the working copy but not in the previous revision.
218
Versioned in the previous revision but removed or deleted
222
Path of this file changed from the previous revision;
223
the text may also have changed. This includes files whose
224
parent directory was renamed.
227
Text has changed since the previous revision.
230
File kind has been changed (e.g. from file to directory).
233
Not versioned and not matching an ignore pattern.
235
Additionally for directories, symlinks and files with a changed
236
executable bit, Bazaar indicates their type using a trailing
237
character: '/', '@' or '*' respectively. These decorations can be
238
disabled using the '--no-classify' option.
240
To see ignored files use 'bzr ignored'. For details on the
241
changes to file texts, use 'bzr diff'.
243
Note that --short or -S gives status flags for each item, similar
244
to Subversion's status command. To get output similar to svn -q,
247
If no arguments are specified, the status of the entire working
248
directory is shown. Otherwise, only the status of the specified
249
files or directories is reported. If a directory is given, status
250
is reported for everything inside that directory.
252
Before merges are committed, the pending merge tip revisions are
253
shown. To see all pending merge revisions, use the -v option.
254
To skip the display of pending merge information altogether, use
255
the no-pending option or specify a file/directory.
257
To compare the working directory to a specific revision, pass a
258
single revision to the revision argument.
260
To see which files have changed in a specific revision, or between
261
two revisions, pass a revision range to the revision argument.
262
This will produce the same results as calling 'bzr diff --summarize'.
265
# TODO: --no-recurse, --recurse options
267
takes_args = ['file*']
268
takes_options = ['show-ids', 'revision', 'change', 'verbose',
269
Option('short', help='Use short status indicators.',
271
Option('versioned', help='Only show versioned files.',
273
Option('no-pending', help='Don\'t show pending merges.',
275
Option('no-classify',
276
help='Do not mark object type using indicator.',
279
aliases = ['st', 'stat']
281
encoding_type = 'replace'
282
_see_also = ['diff', 'revert', 'status-flags']
285
def run(self, show_ids=False, file_list=None, revision=None, short=False,
286
versioned=False, no_pending=False, verbose=False,
288
from bzrlib.status import show_tree_status
290
if revision and len(revision) > 2:
291
raise errors.BzrCommandError('bzr status --revision takes exactly'
292
' one or two revision specifiers')
294
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
295
# Avoid asking for specific files when that is not needed.
296
if relfile_list == ['']:
298
# Don't disable pending merges for full trees other than '.'.
299
if file_list == ['.']:
301
# A specific path within a tree was given.
302
elif relfile_list is not None:
304
show_tree_status(tree, show_ids=show_ids,
305
specific_files=relfile_list, revision=revision,
306
to_file=self.outf, short=short, versioned=versioned,
307
show_pending=(not no_pending), verbose=verbose,
308
classify=not no_classify)
311
class cmd_cat_revision(Command):
312
__doc__ = """Write out metadata for a revision.
314
The revision to print can either be specified by a specific
315
revision identifier, or you can use --revision.
319
takes_args = ['revision_id?']
320
takes_options = ['directory', 'revision']
321
# cat-revision is more for frontends so should be exact
324
def print_revision(self, revisions, revid):
325
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
326
record = stream.next()
327
if record.storage_kind == 'absent':
328
raise errors.NoSuchRevision(revisions, revid)
329
revtext = record.get_bytes_as('fulltext')
330
self.outf.write(revtext.decode('utf-8'))
333
def run(self, revision_id=None, revision=None, directory=u'.'):
334
if revision_id is not None and revision is not None:
335
raise errors.BzrCommandError('You can only supply one of'
336
' revision_id or --revision')
337
if revision_id is None and revision is None:
338
raise errors.BzrCommandError('You must supply either'
339
' --revision or a revision_id')
341
b = bzrdir.BzrDir.open_containing_tree_or_branch(directory)[1]
343
revisions = b.repository.revisions
344
if revisions is None:
345
raise errors.BzrCommandError('Repository %r does not support '
346
'access to raw revision texts')
348
b.repository.lock_read()
350
# TODO: jam 20060112 should cat-revision always output utf-8?
351
if revision_id is not None:
352
revision_id = osutils.safe_revision_id(revision_id, warn=False)
354
self.print_revision(revisions, revision_id)
355
except errors.NoSuchRevision:
356
msg = "The repository %s contains no revision %s." % (
357
b.repository.base, revision_id)
358
raise errors.BzrCommandError(msg)
359
elif revision is not None:
362
raise errors.BzrCommandError(
363
'You cannot specify a NULL revision.')
364
rev_id = rev.as_revision_id(b)
365
self.print_revision(revisions, rev_id)
367
b.repository.unlock()
370
class cmd_dump_btree(Command):
371
__doc__ = """Dump the contents of a btree index file to stdout.
373
PATH is a btree index file, it can be any URL. This includes things like
374
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
376
By default, the tuples stored in the index file will be displayed. With
377
--raw, we will uncompress the pages, but otherwise display the raw bytes
381
# TODO: Do we want to dump the internal nodes as well?
382
# TODO: It would be nice to be able to dump the un-parsed information,
383
# rather than only going through iter_all_entries. However, this is
384
# good enough for a start
386
encoding_type = 'exact'
387
takes_args = ['path']
388
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
389
' rather than the parsed tuples.'),
392
def run(self, path, raw=False):
393
dirname, basename = osutils.split(path)
394
t = transport.get_transport(dirname)
396
self._dump_raw_bytes(t, basename)
398
self._dump_entries(t, basename)
400
def _get_index_and_bytes(self, trans, basename):
401
"""Create a BTreeGraphIndex and raw bytes."""
402
bt = btree_index.BTreeGraphIndex(trans, basename, None)
403
bytes = trans.get_bytes(basename)
404
bt._file = cStringIO.StringIO(bytes)
405
bt._size = len(bytes)
408
def _dump_raw_bytes(self, trans, basename):
411
# We need to parse at least the root node.
412
# This is because the first page of every row starts with an
413
# uncompressed header.
414
bt, bytes = self._get_index_and_bytes(trans, basename)
415
for page_idx, page_start in enumerate(xrange(0, len(bytes),
416
btree_index._PAGE_SIZE)):
417
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
418
page_bytes = bytes[page_start:page_end]
420
self.outf.write('Root node:\n')
421
header_end, data = bt._parse_header_from_bytes(page_bytes)
422
self.outf.write(page_bytes[:header_end])
424
self.outf.write('\nPage %d\n' % (page_idx,))
425
if len(page_bytes) == 0:
426
self.outf.write('(empty)\n');
428
decomp_bytes = zlib.decompress(page_bytes)
429
self.outf.write(decomp_bytes)
430
self.outf.write('\n')
432
def _dump_entries(self, trans, basename):
434
st = trans.stat(basename)
435
except errors.TransportNotPossible:
436
# We can't stat, so we'll fake it because we have to do the 'get()'
438
bt, _ = self._get_index_and_bytes(trans, basename)
440
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
441
for node in bt.iter_all_entries():
442
# Node is made up of:
443
# (index, key, value, [references])
447
refs_as_tuples = None
449
refs_as_tuples = static_tuple.as_tuples(refs)
450
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
451
self.outf.write('%s\n' % (as_tuple,))
454
class cmd_remove_tree(Command):
455
__doc__ = """Remove the working tree from a given branch/checkout.
457
Since a lightweight checkout is little more than a working tree
458
this will refuse to run against one.
460
To re-create the working tree, use "bzr checkout".
462
_see_also = ['checkout', 'working-trees']
463
takes_args = ['location*']
466
help='Remove the working tree even if it has '
467
'uncommitted or shelved changes.'),
470
def run(self, location_list, force=False):
471
if not location_list:
474
for location in location_list:
475
d = bzrdir.BzrDir.open(location)
478
working = d.open_workingtree()
479
except errors.NoWorkingTree:
480
raise errors.BzrCommandError("No working tree to remove")
481
except errors.NotLocalUrl:
482
raise errors.BzrCommandError("You cannot remove the working tree"
485
if (working.has_changes()):
486
raise errors.UncommittedChanges(working)
487
if working.get_shelf_manager().last_shelf() is not None:
488
raise errors.ShelvedChanges(working)
490
if working.user_url != working.branch.user_url:
491
raise errors.BzrCommandError("You cannot remove the working tree"
492
" from a lightweight checkout")
494
d.destroy_workingtree()
497
class cmd_repair_workingtree(Command):
498
__doc__ = """Reset the working tree state file.
500
This is not meant to be used normally, but more as a way to recover from
501
filesystem corruption, etc. This rebuilds the working inventory back to a
502
'known good' state. Any new modifications (adding a file, renaming, etc)
503
will be lost, though modified files will still be detected as such.
505
Most users will want something more like "bzr revert" or "bzr update"
506
unless the state file has become corrupted.
508
By default this attempts to recover the current state by looking at the
509
headers of the state file. If the state file is too corrupted to even do
510
that, you can supply --revision to force the state of the tree.
513
takes_options = ['revision', 'directory',
515
help='Reset the tree even if it doesn\'t appear to be'
520
def run(self, revision=None, directory='.', force=False):
521
tree, _ = WorkingTree.open_containing(directory)
522
self.add_cleanup(tree.lock_tree_write().unlock)
526
except errors.BzrError:
527
pass # There seems to be a real error here, so we'll reset
530
raise errors.BzrCommandError(
531
'The tree does not appear to be corrupt. You probably'
532
' want "bzr revert" instead. Use "--force" if you are'
533
' sure you want to reset the working tree.')
537
revision_ids = [r.as_revision_id(tree.branch) for r in revision]
539
tree.reset_state(revision_ids)
540
except errors.BzrError, e:
541
if revision_ids is None:
542
extra = (', the header appears corrupt, try passing -r -1'
543
' to set the state to the last commit')
546
raise errors.BzrCommandError('failed to reset the tree state'
550
class cmd_revno(Command):
551
__doc__ = """Show current revision number.
553
This is equal to the number of revisions on this branch.
557
takes_args = ['location?']
559
Option('tree', help='Show revno of working tree'),
563
def run(self, tree=False, location=u'.'):
566
wt = WorkingTree.open_containing(location)[0]
567
self.add_cleanup(wt.lock_read().unlock)
568
except (errors.NoWorkingTree, errors.NotLocalUrl):
569
raise errors.NoWorkingTree(location)
570
revid = wt.last_revision()
572
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
573
except errors.NoSuchRevision:
575
revno = ".".join(str(n) for n in revno_t)
577
b = Branch.open_containing(location)[0]
578
self.add_cleanup(b.lock_read().unlock)
581
self.outf.write(str(revno) + '\n')
584
class cmd_revision_info(Command):
585
__doc__ = """Show revision number and revision id for a given revision identifier.
588
takes_args = ['revision_info*']
591
custom_help('directory',
592
help='Branch to examine, '
593
'rather than the one containing the working directory.'),
594
Option('tree', help='Show revno of working tree'),
598
def run(self, revision=None, directory=u'.', tree=False,
599
revision_info_list=[]):
602
wt = WorkingTree.open_containing(directory)[0]
604
self.add_cleanup(wt.lock_read().unlock)
605
except (errors.NoWorkingTree, errors.NotLocalUrl):
607
b = Branch.open_containing(directory)[0]
608
self.add_cleanup(b.lock_read().unlock)
610
if revision is not None:
611
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
612
if revision_info_list is not None:
613
for rev_str in revision_info_list:
614
rev_spec = RevisionSpec.from_string(rev_str)
615
revision_ids.append(rev_spec.as_revision_id(b))
616
# No arguments supplied, default to the last revision
617
if len(revision_ids) == 0:
620
raise errors.NoWorkingTree(directory)
621
revision_ids.append(wt.last_revision())
623
revision_ids.append(b.last_revision())
627
for revision_id in revision_ids:
629
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
630
revno = '.'.join(str(i) for i in dotted_revno)
631
except errors.NoSuchRevision:
633
maxlen = max(maxlen, len(revno))
634
revinfos.append([revno, revision_id])
638
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
641
class cmd_add(Command):
642
__doc__ = """Add specified files or directories.
644
In non-recursive mode, all the named items are added, regardless
645
of whether they were previously ignored. A warning is given if
646
any of the named files are already versioned.
648
In recursive mode (the default), files are treated the same way
649
but the behaviour for directories is different. Directories that
650
are already versioned do not give a warning. All directories,
651
whether already versioned or not, are searched for files or
652
subdirectories that are neither versioned or ignored, and these
653
are added. This search proceeds recursively into versioned
654
directories. If no names are given '.' is assumed.
656
Therefore simply saying 'bzr add' will version all files that
657
are currently unknown.
659
Adding a file whose parent directory is not versioned will
660
implicitly add the parent, and so on up to the root. This means
661
you should never need to explicitly add a directory, they'll just
662
get added when you add a file in the directory.
664
--dry-run will show which files would be added, but not actually
667
--file-ids-from will try to use the file ids from the supplied path.
668
It looks up ids trying to find a matching parent directory with the
669
same filename, and then by pure path. This option is rarely needed
670
but can be useful when adding the same logical file into two
671
branches that will be merged later (without showing the two different
672
adds as a conflict). It is also useful when merging another project
673
into a subdirectory of this one.
675
Any files matching patterns in the ignore list will not be added
676
unless they are explicitly mentioned.
678
takes_args = ['file*']
681
help="Don't recursively add the contents of directories."),
683
help="Show what would be done, but don't actually do anything."),
685
Option('file-ids-from',
687
help='Lookup file ids from this tree.'),
689
encoding_type = 'replace'
690
_see_also = ['remove', 'ignore']
692
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
697
if file_ids_from is not None:
699
base_tree, base_path = WorkingTree.open_containing(
701
except errors.NoWorkingTree:
702
base_branch, base_path = Branch.open_containing(
704
base_tree = base_branch.basis_tree()
706
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
707
to_file=self.outf, should_print=(not is_quiet()))
709
action = bzrlib.add.AddAction(to_file=self.outf,
710
should_print=(not is_quiet()))
713
self.add_cleanup(base_tree.lock_read().unlock)
714
tree, file_list = tree_files_for_add(file_list)
715
added, ignored = tree.smart_add(file_list, not
716
no_recurse, action=action, save=not dry_run)
720
for glob in sorted(ignored.keys()):
721
for path in ignored[glob]:
722
self.outf.write("ignored %s matching \"%s\"\n"
726
class cmd_mkdir(Command):
727
__doc__ = """Create a new versioned directory.
729
This is equivalent to creating the directory and then adding it.
732
takes_args = ['dir+']
733
encoding_type = 'replace'
735
def run(self, dir_list):
737
wt, dd = WorkingTree.open_containing(d)
738
base = os.path.dirname(dd)
739
id = wt.path2id(base)
743
self.outf.write('added %s\n' % d)
745
raise errors.NotVersionedError(path=base)
748
class cmd_relpath(Command):
749
__doc__ = """Show path of a file relative to root"""
751
takes_args = ['filename']
755
def run(self, filename):
756
# TODO: jam 20050106 Can relpath return a munged path if
757
# sys.stdout encoding cannot represent it?
758
tree, relpath = WorkingTree.open_containing(filename)
759
self.outf.write(relpath)
760
self.outf.write('\n')
763
class cmd_inventory(Command):
764
__doc__ = """Show inventory of the current working copy or a revision.
766
It is possible to limit the output to a particular entry
767
type using the --kind option. For example: --kind file.
769
It is also possible to restrict the list of files to a specific
770
set. For example: bzr inventory --show-ids this/file
779
help='List entries of a particular kind: file, directory, symlink.',
782
takes_args = ['file*']
785
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
786
if kind and kind not in ['file', 'directory', 'symlink']:
787
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
789
revision = _get_one_revision('inventory', revision)
790
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
791
self.add_cleanup(work_tree.lock_read().unlock)
792
if revision is not None:
793
tree = revision.as_tree(work_tree.branch)
795
extra_trees = [work_tree]
796
self.add_cleanup(tree.lock_read().unlock)
801
if file_list is not None:
802
file_ids = tree.paths2ids(file_list, trees=extra_trees,
803
require_versioned=True)
804
# find_ids_across_trees may include some paths that don't
807
(tree.id2path(file_id), tree.inventory[file_id])
808
for file_id in file_ids if tree.has_id(file_id))
810
entries = tree.inventory.entries()
813
for path, entry in entries:
814
if kind and kind != entry.kind:
817
self.outf.write('%-50s %s\n' % (path, entry.file_id))
819
self.outf.write(path)
820
self.outf.write('\n')
823
class cmd_mv(Command):
824
__doc__ = """Move or rename a file.
827
bzr mv OLDNAME NEWNAME
829
bzr mv SOURCE... DESTINATION
831
If the last argument is a versioned directory, all the other names
832
are moved into it. Otherwise, there must be exactly two arguments
833
and the file is changed to a new name.
835
If OLDNAME does not exist on the filesystem but is versioned and
836
NEWNAME does exist on the filesystem but is not versioned, mv
837
assumes that the file has been manually moved and only updates
838
its internal inventory to reflect that change.
839
The same is valid when moving many SOURCE files to a DESTINATION.
841
Files cannot be moved between branches.
844
takes_args = ['names*']
845
takes_options = [Option("after", help="Move only the bzr identifier"
846
" of the file, because the file has already been moved."),
847
Option('auto', help='Automatically guess renames.'),
848
Option('dry-run', help='Avoid making changes when guessing renames.'),
850
aliases = ['move', 'rename']
851
encoding_type = 'replace'
853
def run(self, names_list, after=False, auto=False, dry_run=False):
855
return self.run_auto(names_list, after, dry_run)
857
raise errors.BzrCommandError('--dry-run requires --auto.')
858
if names_list is None:
860
if len(names_list) < 2:
861
raise errors.BzrCommandError("missing file argument")
862
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
863
self.add_cleanup(tree.lock_tree_write().unlock)
864
self._run(tree, names_list, rel_names, after)
866
def run_auto(self, names_list, after, dry_run):
867
if names_list is not None and len(names_list) > 1:
868
raise errors.BzrCommandError('Only one path may be specified to'
871
raise errors.BzrCommandError('--after cannot be specified with'
873
work_tree, file_list = WorkingTree.open_containing_paths(
874
names_list, default_directory='.')
875
self.add_cleanup(work_tree.lock_tree_write().unlock)
876
rename_map.RenameMap.guess_renames(work_tree, dry_run)
878
def _run(self, tree, names_list, rel_names, after):
879
into_existing = osutils.isdir(names_list[-1])
880
if into_existing and len(names_list) == 2:
882
# a. case-insensitive filesystem and change case of dir
883
# b. move directory after the fact (if the source used to be
884
# a directory, but now doesn't exist in the working tree
885
# and the target is an existing directory, just rename it)
886
if (not tree.case_sensitive
887
and rel_names[0].lower() == rel_names[1].lower()):
888
into_existing = False
891
# 'fix' the case of a potential 'from'
892
from_id = tree.path2id(
893
tree.get_canonical_inventory_path(rel_names[0]))
894
if (not osutils.lexists(names_list[0]) and
895
from_id and inv.get_file_kind(from_id) == "directory"):
896
into_existing = False
899
# move into existing directory
900
# All entries reference existing inventory items, so fix them up
901
# for cicp file-systems.
902
rel_names = tree.get_canonical_inventory_paths(rel_names)
903
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
905
self.outf.write("%s => %s\n" % (src, dest))
907
if len(names_list) != 2:
908
raise errors.BzrCommandError('to mv multiple files the'
909
' destination must be a versioned'
912
# for cicp file-systems: the src references an existing inventory
914
src = tree.get_canonical_inventory_path(rel_names[0])
915
# Find the canonical version of the destination: In all cases, the
916
# parent of the target must be in the inventory, so we fetch the
917
# canonical version from there (we do not always *use* the
918
# canonicalized tail portion - we may be attempting to rename the
920
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
921
dest_parent = osutils.dirname(canon_dest)
922
spec_tail = osutils.basename(rel_names[1])
923
# For a CICP file-system, we need to avoid creating 2 inventory
924
# entries that differ only by case. So regardless of the case
925
# we *want* to use (ie, specified by the user or the file-system),
926
# we must always choose to use the case of any existing inventory
927
# items. The only exception to this is when we are attempting a
928
# case-only rename (ie, canonical versions of src and dest are
930
dest_id = tree.path2id(canon_dest)
931
if dest_id is None or tree.path2id(src) == dest_id:
932
# No existing item we care about, so work out what case we
933
# are actually going to use.
935
# If 'after' is specified, the tail must refer to a file on disk.
937
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
939
# pathjoin with an empty tail adds a slash, which breaks
941
dest_parent_fq = tree.basedir
943
dest_tail = osutils.canonical_relpath(
945
osutils.pathjoin(dest_parent_fq, spec_tail))
947
# not 'after', so case as specified is used
948
dest_tail = spec_tail
950
# Use the existing item so 'mv' fails with AlreadyVersioned.
951
dest_tail = os.path.basename(canon_dest)
952
dest = osutils.pathjoin(dest_parent, dest_tail)
953
mutter("attempting to move %s => %s", src, dest)
954
tree.rename_one(src, dest, after=after)
956
self.outf.write("%s => %s\n" % (src, dest))
959
class cmd_pull(Command):
960
__doc__ = """Turn this branch into a mirror of another branch.
962
By default, this command only works on branches that have not diverged.
963
Branches are considered diverged if the destination branch's most recent
964
commit is one that has not been merged (directly or indirectly) into the
967
If branches have diverged, you can use 'bzr merge' to integrate the changes
968
from one into the other. Once one branch has merged, the other should
969
be able to pull it again.
971
If you want to replace your local changes and just want your branch to
972
match the remote one, use pull --overwrite. This will work even if the two
973
branches have diverged.
975
If there is no default location set, the first pull will set it (use
976
--no-remember to avoid settting it). After that, you can omit the
977
location to use the default. To change the default, use --remember. The
978
value will only be saved if the remote location can be accessed.
980
Note: The location can be specified either in the form of a branch,
981
or in the form of a path to a file containing a merge directive generated
985
_see_also = ['push', 'update', 'status-flags', 'send']
986
takes_options = ['remember', 'overwrite', 'revision',
987
custom_help('verbose',
988
help='Show logs of pulled revisions.'),
989
custom_help('directory',
990
help='Branch to pull into, '
991
'rather than the one containing the working directory.'),
993
help="Perform a local pull in a bound "
994
"branch. Local pulls are not applied to "
998
help="Show base revision text in conflicts.")
1000
takes_args = ['location?']
1001
encoding_type = 'replace'
1003
def run(self, location=None, remember=None, overwrite=False,
1004
revision=None, verbose=False,
1005
directory=None, local=False,
1007
# FIXME: too much stuff is in the command class
1010
if directory is None:
1013
tree_to = WorkingTree.open_containing(directory)[0]
1014
branch_to = tree_to.branch
1015
self.add_cleanup(tree_to.lock_write().unlock)
1016
except errors.NoWorkingTree:
1018
branch_to = Branch.open_containing(directory)[0]
1019
self.add_cleanup(branch_to.lock_write().unlock)
1021
if tree_to is None and show_base:
1022
raise errors.BzrCommandError("Need working tree for --show-base.")
1024
if local and not branch_to.get_bound_location():
1025
raise errors.LocalRequiresBoundBranch()
1027
possible_transports = []
1028
if location is not None:
1030
mergeable = bundle.read_mergeable_from_url(location,
1031
possible_transports=possible_transports)
1032
except errors.NotABundle:
1035
stored_loc = branch_to.get_parent()
1036
if location is None:
1037
if stored_loc is None:
1038
raise errors.BzrCommandError("No pull location known or"
1041
display_url = urlutils.unescape_for_display(stored_loc,
1044
self.outf.write("Using saved parent location: %s\n" % display_url)
1045
location = stored_loc
1047
revision = _get_one_revision('pull', revision)
1048
if mergeable is not None:
1049
if revision is not None:
1050
raise errors.BzrCommandError(
1051
'Cannot use -r with merge directives or bundles')
1052
mergeable.install_revisions(branch_to.repository)
1053
base_revision_id, revision_id, verified = \
1054
mergeable.get_merge_request(branch_to.repository)
1055
branch_from = branch_to
1057
branch_from = Branch.open(location,
1058
possible_transports=possible_transports)
1059
self.add_cleanup(branch_from.lock_read().unlock)
1060
# Remembers if asked explicitly or no previous location is set
1062
or (remember is None and branch_to.get_parent() is None)):
1063
branch_to.set_parent(branch_from.base)
1065
if revision is not None:
1066
revision_id = revision.as_revision_id(branch_from)
1068
if tree_to is not None:
1069
view_info = _get_view_info_for_change_reporter(tree_to)
1070
change_reporter = delta._ChangeReporter(
1071
unversioned_filter=tree_to.is_ignored,
1072
view_info=view_info)
1073
result = tree_to.pull(
1074
branch_from, overwrite, revision_id, change_reporter,
1075
possible_transports=possible_transports, local=local,
1076
show_base=show_base)
1078
result = branch_to.pull(
1079
branch_from, overwrite, revision_id, local=local)
1081
result.report(self.outf)
1082
if verbose and result.old_revid != result.new_revid:
1083
log.show_branch_change(
1084
branch_to, self.outf, result.old_revno,
1086
if getattr(result, 'tag_conflicts', None):
1092
class cmd_push(Command):
1093
__doc__ = """Update a mirror of this branch.
1095
The target branch will not have its working tree populated because this
1096
is both expensive, and is not supported on remote file systems.
1098
Some smart servers or protocols *may* put the working tree in place in
1101
This command only works on branches that have not diverged. Branches are
1102
considered diverged if the destination branch's most recent commit is one
1103
that has not been merged (directly or indirectly) by the source branch.
1105
If branches have diverged, you can use 'bzr push --overwrite' to replace
1106
the other branch completely, discarding its unmerged changes.
1108
If you want to ensure you have the different changes in the other branch,
1109
do a merge (see bzr help merge) from the other branch, and commit that.
1110
After that you will be able to do a push without '--overwrite'.
1112
If there is no default push location set, the first push will set it (use
1113
--no-remember to avoid settting it). After that, you can omit the
1114
location to use the default. To change the default, use --remember. The
1115
value will only be saved if the remote location can be accessed.
1118
_see_also = ['pull', 'update', 'working-trees']
1119
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1120
Option('create-prefix',
1121
help='Create the path leading up to the branch '
1122
'if it does not already exist.'),
1123
custom_help('directory',
1124
help='Branch to push from, '
1125
'rather than the one containing the working directory.'),
1126
Option('use-existing-dir',
1127
help='By default push will fail if the target'
1128
' directory exists, but does not already'
1129
' have a control directory. This flag will'
1130
' allow push to proceed.'),
1132
help='Create a stacked branch that references the public location '
1133
'of the parent branch.'),
1134
Option('stacked-on',
1135
help='Create a stacked branch that refers to another branch '
1136
'for the commit history. Only the work not present in the '
1137
'referenced branch is included in the branch created.',
1140
help='Refuse to push if there are uncommitted changes in'
1141
' the working tree, --no-strict disables the check.'),
1143
help="Don't populate the working tree, even for protocols"
1144
" that support it."),
1146
takes_args = ['location?']
1147
encoding_type = 'replace'
1149
def run(self, location=None, remember=None, overwrite=False,
1150
create_prefix=False, verbose=False, revision=None,
1151
use_existing_dir=False, directory=None, stacked_on=None,
1152
stacked=False, strict=None, no_tree=False):
1153
from bzrlib.push import _show_push_branch
1155
if directory is None:
1157
# Get the source branch
1159
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1160
# Get the tip's revision_id
1161
revision = _get_one_revision('push', revision)
1162
if revision is not None:
1163
revision_id = revision.in_history(br_from).rev_id
1166
if tree is not None and revision_id is None:
1167
tree.check_changed_or_out_of_date(
1168
strict, 'push_strict',
1169
more_error='Use --no-strict to force the push.',
1170
more_warning='Uncommitted changes will not be pushed.')
1171
# Get the stacked_on branch, if any
1172
if stacked_on is not None:
1173
stacked_on = urlutils.normalize_url(stacked_on)
1175
parent_url = br_from.get_parent()
1177
parent = Branch.open(parent_url)
1178
stacked_on = parent.get_public_branch()
1180
# I considered excluding non-http url's here, thus forcing
1181
# 'public' branches only, but that only works for some
1182
# users, so it's best to just depend on the user spotting an
1183
# error by the feedback given to them. RBC 20080227.
1184
stacked_on = parent_url
1186
raise errors.BzrCommandError(
1187
"Could not determine branch to refer to.")
1189
# Get the destination location
1190
if location is None:
1191
stored_loc = br_from.get_push_location()
1192
if stored_loc is None:
1193
raise errors.BzrCommandError(
1194
"No push location known or specified.")
1196
display_url = urlutils.unescape_for_display(stored_loc,
1198
self.outf.write("Using saved push location: %s\n" % display_url)
1199
location = stored_loc
1201
_show_push_branch(br_from, revision_id, location, self.outf,
1202
verbose=verbose, overwrite=overwrite, remember=remember,
1203
stacked_on=stacked_on, create_prefix=create_prefix,
1204
use_existing_dir=use_existing_dir, no_tree=no_tree)
1207
class cmd_branch(Command):
1208
__doc__ = """Create a new branch that is a copy of an existing branch.
1210
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1211
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1212
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1213
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1214
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1217
To retrieve the branch as of a particular revision, supply the --revision
1218
parameter, as in "branch foo/bar -r 5".
1220
The synonyms 'clone' and 'get' for this command are deprecated.
1223
_see_also = ['checkout']
1224
takes_args = ['from_location', 'to_location?']
1225
takes_options = ['revision',
1226
Option('hardlink', help='Hard-link working tree files where possible.'),
1227
Option('files-from', type=str,
1228
help="Get file contents from this tree."),
1230
help="Create a branch without a working-tree."),
1232
help="Switch the checkout in the current directory "
1233
"to the new branch."),
1235
help='Create a stacked branch referring to the source branch. '
1236
'The new branch will depend on the availability of the source '
1237
'branch for all operations.'),
1238
Option('standalone',
1239
help='Do not use a shared repository, even if available.'),
1240
Option('use-existing-dir',
1241
help='By default branch will fail if the target'
1242
' directory exists, but does not already'
1243
' have a control directory. This flag will'
1244
' allow branch to proceed.'),
1246
help="Bind new branch to from location."),
1248
aliases = ['get', 'clone']
1250
def run(self, from_location, to_location=None, revision=None,
1251
hardlink=False, stacked=False, standalone=False, no_tree=False,
1252
use_existing_dir=False, switch=False, bind=False,
1254
from bzrlib import switch as _mod_switch
1255
from bzrlib.tag import _merge_tags_if_possible
1256
if self.invoked_as in ['get', 'clone']:
1257
ui.ui_factory.show_user_warning(
1258
'deprecated_command',
1259
deprecated_name=self.invoked_as,
1260
recommended_name='branch',
1261
deprecated_in_version='2.4')
1262
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1264
if not (hardlink or files_from):
1265
# accelerator_tree is usually slower because you have to read N
1266
# files (no readahead, lots of seeks, etc), but allow the user to
1267
# explicitly request it
1268
accelerator_tree = None
1269
if files_from is not None and files_from != from_location:
1270
accelerator_tree = WorkingTree.open(files_from)
1271
revision = _get_one_revision('branch', revision)
1272
self.add_cleanup(br_from.lock_read().unlock)
1273
if revision is not None:
1274
revision_id = revision.as_revision_id(br_from)
1276
# FIXME - wt.last_revision, fallback to branch, fall back to
1277
# None or perhaps NULL_REVISION to mean copy nothing
1279
revision_id = br_from.last_revision()
1280
if to_location is None:
1281
to_location = urlutils.derive_to_location(from_location)
1282
to_transport = transport.get_transport(to_location)
1284
to_transport.mkdir('.')
1285
except errors.FileExists:
1286
if not use_existing_dir:
1287
raise errors.BzrCommandError('Target directory "%s" '
1288
'already exists.' % to_location)
1291
bzrdir.BzrDir.open_from_transport(to_transport)
1292
except errors.NotBranchError:
1295
raise errors.AlreadyBranchError(to_location)
1296
except errors.NoSuchFile:
1297
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1300
# preserve whatever source format we have.
1301
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1302
possible_transports=[to_transport],
1303
accelerator_tree=accelerator_tree,
1304
hardlink=hardlink, stacked=stacked,
1305
force_new_repo=standalone,
1306
create_tree_if_local=not no_tree,
1307
source_branch=br_from)
1308
branch = dir.open_branch()
1309
except errors.NoSuchRevision:
1310
to_transport.delete_tree('.')
1311
msg = "The branch %s has no revision %s." % (from_location,
1313
raise errors.BzrCommandError(msg)
1314
_merge_tags_if_possible(br_from, branch)
1315
# If the source branch is stacked, the new branch may
1316
# be stacked whether we asked for that explicitly or not.
1317
# We therefore need a try/except here and not just 'if stacked:'
1319
note('Created new stacked branch referring to %s.' %
1320
branch.get_stacked_on_url())
1321
except (errors.NotStacked, errors.UnstackableBranchFormat,
1322
errors.UnstackableRepositoryFormat), e:
1323
note('Branched %d revision(s).' % branch.revno())
1325
# Bind to the parent
1326
parent_branch = Branch.open(from_location)
1327
branch.bind(parent_branch)
1328
note('New branch bound to %s' % from_location)
1330
# Switch to the new branch
1331
wt, _ = WorkingTree.open_containing('.')
1332
_mod_switch.switch(wt.bzrdir, branch)
1333
note('Switched to branch: %s',
1334
urlutils.unescape_for_display(branch.base, 'utf-8'))
1337
class cmd_checkout(Command):
1338
__doc__ = """Create a new checkout of an existing branch.
1340
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1341
the branch found in '.'. This is useful if you have removed the working tree
1342
or if it was never created - i.e. if you pushed the branch to its current
1343
location using SFTP.
1345
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1346
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1347
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1348
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1349
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1352
To retrieve the branch as of a particular revision, supply the --revision
1353
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1354
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1358
_see_also = ['checkouts', 'branch']
1359
takes_args = ['branch_location?', 'to_location?']
1360
takes_options = ['revision',
1361
Option('lightweight',
1362
help="Perform a lightweight checkout. Lightweight "
1363
"checkouts depend on access to the branch for "
1364
"every operation. Normal checkouts can perform "
1365
"common operations like diff and status without "
1366
"such access, and also support local commits."
1368
Option('files-from', type=str,
1369
help="Get file contents from this tree."),
1371
help='Hard-link working tree files where possible.'
1376
def run(self, branch_location=None, to_location=None, revision=None,
1377
lightweight=False, files_from=None, hardlink=False):
1378
if branch_location is None:
1379
branch_location = osutils.getcwd()
1380
to_location = branch_location
1381
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1383
if not (hardlink or files_from):
1384
# accelerator_tree is usually slower because you have to read N
1385
# files (no readahead, lots of seeks, etc), but allow the user to
1386
# explicitly request it
1387
accelerator_tree = None
1388
revision = _get_one_revision('checkout', revision)
1389
if files_from is not None and files_from != branch_location:
1390
accelerator_tree = WorkingTree.open(files_from)
1391
if revision is not None:
1392
revision_id = revision.as_revision_id(source)
1395
if to_location is None:
1396
to_location = urlutils.derive_to_location(branch_location)
1397
# if the source and to_location are the same,
1398
# and there is no working tree,
1399
# then reconstitute a branch
1400
if (osutils.abspath(to_location) ==
1401
osutils.abspath(branch_location)):
1403
source.bzrdir.open_workingtree()
1404
except errors.NoWorkingTree:
1405
source.bzrdir.create_workingtree(revision_id)
1407
source.create_checkout(to_location, revision_id, lightweight,
1408
accelerator_tree, hardlink)
1411
class cmd_renames(Command):
1412
__doc__ = """Show list of renamed files.
1414
# TODO: Option to show renames between two historical versions.
1416
# TODO: Only show renames under dir, rather than in the whole branch.
1417
_see_also = ['status']
1418
takes_args = ['dir?']
1421
def run(self, dir=u'.'):
1422
tree = WorkingTree.open_containing(dir)[0]
1423
self.add_cleanup(tree.lock_read().unlock)
1424
new_inv = tree.inventory
1425
old_tree = tree.basis_tree()
1426
self.add_cleanup(old_tree.lock_read().unlock)
1427
old_inv = old_tree.inventory
1429
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1430
for f, paths, c, v, p, n, k, e in iterator:
1431
if paths[0] == paths[1]:
1435
renames.append(paths)
1437
for old_name, new_name in renames:
1438
self.outf.write("%s => %s\n" % (old_name, new_name))
1441
class cmd_update(Command):
1442
__doc__ = """Update a tree to have the latest code committed to its branch.
1444
This will perform a merge into the working tree, and may generate
1445
conflicts. If you have any local changes, you will still
1446
need to commit them after the update for the update to be complete.
1448
If you want to discard your local changes, you can just do a
1449
'bzr revert' instead of 'bzr commit' after the update.
1451
If you want to restore a file that has been removed locally, use
1452
'bzr revert' instead of 'bzr update'.
1454
If the tree's branch is bound to a master branch, it will also update
1455
the branch from the master.
1458
_see_also = ['pull', 'working-trees', 'status-flags']
1459
takes_args = ['dir?']
1460
takes_options = ['revision',
1462
help="Show base revision text in conflicts."),
1466
def run(self, dir='.', revision=None, show_base=None):
1467
if revision is not None and len(revision) != 1:
1468
raise errors.BzrCommandError(
1469
"bzr update --revision takes exactly one revision")
1470
tree = WorkingTree.open_containing(dir)[0]
1471
branch = tree.branch
1472
possible_transports = []
1473
master = branch.get_master_branch(
1474
possible_transports=possible_transports)
1475
if master is not None:
1476
branch_location = master.base
1479
branch_location = tree.branch.base
1480
tree.lock_tree_write()
1481
self.add_cleanup(tree.unlock)
1482
# get rid of the final '/' and be ready for display
1483
branch_location = urlutils.unescape_for_display(
1484
branch_location.rstrip('/'),
1486
existing_pending_merges = tree.get_parent_ids()[1:]
1490
# may need to fetch data into a heavyweight checkout
1491
# XXX: this may take some time, maybe we should display a
1493
old_tip = branch.update(possible_transports)
1494
if revision is not None:
1495
revision_id = revision[0].as_revision_id(branch)
1497
revision_id = branch.last_revision()
1498
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1499
revno = branch.revision_id_to_dotted_revno(revision_id)
1500
note("Tree is up to date at revision %s of branch %s" %
1501
('.'.join(map(str, revno)), branch_location))
1503
view_info = _get_view_info_for_change_reporter(tree)
1504
change_reporter = delta._ChangeReporter(
1505
unversioned_filter=tree.is_ignored,
1506
view_info=view_info)
1508
conflicts = tree.update(
1510
possible_transports=possible_transports,
1511
revision=revision_id,
1513
show_base=show_base)
1514
except errors.NoSuchRevision, e:
1515
raise errors.BzrCommandError(
1516
"branch has no revision %s\n"
1517
"bzr update --revision only works"
1518
" for a revision in the branch history"
1520
revno = tree.branch.revision_id_to_dotted_revno(
1521
_mod_revision.ensure_null(tree.last_revision()))
1522
note('Updated to revision %s of branch %s' %
1523
('.'.join(map(str, revno)), branch_location))
1524
parent_ids = tree.get_parent_ids()
1525
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1526
note('Your local commits will now show as pending merges with '
1527
"'bzr status', and can be committed with 'bzr commit'.")
1534
class cmd_info(Command):
1535
__doc__ = """Show information about a working tree, branch or repository.
1537
This command will show all known locations and formats associated to the
1538
tree, branch or repository.
1540
In verbose mode, statistical information is included with each report.
1541
To see extended statistic information, use a verbosity level of 2 or
1542
higher by specifying the verbose option multiple times, e.g. -vv.
1544
Branches and working trees will also report any missing revisions.
1548
Display information on the format and related locations:
1552
Display the above together with extended format information and
1553
basic statistics (like the number of files in the working tree and
1554
number of revisions in the branch and repository):
1558
Display the above together with number of committers to the branch:
1562
_see_also = ['revno', 'working-trees', 'repositories']
1563
takes_args = ['location?']
1564
takes_options = ['verbose']
1565
encoding_type = 'replace'
1568
def run(self, location=None, verbose=False):
1570
noise_level = get_verbosity_level()
1573
from bzrlib.info import show_bzrdir_info
1574
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1575
verbose=noise_level, outfile=self.outf)
1578
class cmd_remove(Command):
1579
__doc__ = """Remove files or directories.
1581
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1582
delete them if they can easily be recovered using revert otherwise they
1583
will be backed up (adding an extention of the form .~#~). If no options or
1584
parameters are given Bazaar will scan for files that are being tracked by
1585
Bazaar but missing in your tree and stop tracking them for you.
1587
takes_args = ['file*']
1588
takes_options = ['verbose',
1589
Option('new', help='Only remove files that have never been committed.'),
1590
RegistryOption.from_kwargs('file-deletion-strategy',
1591
'The file deletion mode to be used.',
1592
title='Deletion Strategy', value_switches=True, enum_switch=False,
1593
safe='Backup changed files (default).',
1594
keep='Delete from bzr but leave the working copy.',
1595
no_backup='Don\'t backup changed files.',
1596
force='Delete all the specified files, even if they can not be '
1597
'recovered and even if they are non-empty directories. '
1598
'(deprecated, use no-backup)')]
1599
aliases = ['rm', 'del']
1600
encoding_type = 'replace'
1602
def run(self, file_list, verbose=False, new=False,
1603
file_deletion_strategy='safe'):
1604
if file_deletion_strategy == 'force':
1605
note("(The --force option is deprecated, rather use --no-backup "
1607
file_deletion_strategy = 'no-backup'
1609
tree, file_list = WorkingTree.open_containing_paths(file_list)
1611
if file_list is not None:
1612
file_list = [f for f in file_list]
1614
self.add_cleanup(tree.lock_write().unlock)
1615
# Heuristics should probably all move into tree.remove_smart or
1618
added = tree.changes_from(tree.basis_tree(),
1619
specific_files=file_list).added
1620
file_list = sorted([f[0] for f in added], reverse=True)
1621
if len(file_list) == 0:
1622
raise errors.BzrCommandError('No matching files.')
1623
elif file_list is None:
1624
# missing files show up in iter_changes(basis) as
1625
# versioned-with-no-kind.
1627
for change in tree.iter_changes(tree.basis_tree()):
1628
# Find paths in the working tree that have no kind:
1629
if change[1][1] is not None and change[6][1] is None:
1630
missing.append(change[1][1])
1631
file_list = sorted(missing, reverse=True)
1632
file_deletion_strategy = 'keep'
1633
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1634
keep_files=file_deletion_strategy=='keep',
1635
force=(file_deletion_strategy=='no-backup'))
1638
class cmd_file_id(Command):
1639
__doc__ = """Print file_id of a particular file or directory.
1641
The file_id is assigned when the file is first added and remains the
1642
same through all revisions where the file exists, even when it is
1647
_see_also = ['inventory', 'ls']
1648
takes_args = ['filename']
1651
def run(self, filename):
1652
tree, relpath = WorkingTree.open_containing(filename)
1653
i = tree.path2id(relpath)
1655
raise errors.NotVersionedError(filename)
1657
self.outf.write(i + '\n')
1660
class cmd_file_path(Command):
1661
__doc__ = """Print path of file_ids to a file or directory.
1663
This prints one line for each directory down to the target,
1664
starting at the branch root.
1668
takes_args = ['filename']
1671
def run(self, filename):
1672
tree, relpath = WorkingTree.open_containing(filename)
1673
fid = tree.path2id(relpath)
1675
raise errors.NotVersionedError(filename)
1676
segments = osutils.splitpath(relpath)
1677
for pos in range(1, len(segments) + 1):
1678
path = osutils.joinpath(segments[:pos])
1679
self.outf.write("%s\n" % tree.path2id(path))
1682
class cmd_reconcile(Command):
1683
__doc__ = """Reconcile bzr metadata in a branch.
1685
This can correct data mismatches that may have been caused by
1686
previous ghost operations or bzr upgrades. You should only
1687
need to run this command if 'bzr check' or a bzr developer
1688
advises you to run it.
1690
If a second branch is provided, cross-branch reconciliation is
1691
also attempted, which will check that data like the tree root
1692
id which was not present in very early bzr versions is represented
1693
correctly in both branches.
1695
At the same time it is run it may recompress data resulting in
1696
a potential saving in disk space or performance gain.
1698
The branch *MUST* be on a listable system such as local disk or sftp.
1701
_see_also = ['check']
1702
takes_args = ['branch?']
1704
Option('canonicalize-chks',
1705
help='Make sure CHKs are in canonical form (repairs '
1710
def run(self, branch=".", canonicalize_chks=False):
1711
from bzrlib.reconcile import reconcile
1712
dir = bzrdir.BzrDir.open(branch)
1713
reconcile(dir, canonicalize_chks=canonicalize_chks)
1716
class cmd_revision_history(Command):
1717
__doc__ = """Display the list of revision ids on a branch."""
1720
takes_args = ['location?']
1725
def run(self, location="."):
1726
branch = Branch.open_containing(location)[0]
1727
for revid in branch.revision_history():
1728
self.outf.write(revid)
1729
self.outf.write('\n')
1732
class cmd_ancestry(Command):
1733
__doc__ = """List all revisions merged into this branch."""
1735
_see_also = ['log', 'revision-history']
1736
takes_args = ['location?']
1741
def run(self, location="."):
1743
wt = WorkingTree.open_containing(location)[0]
1744
except errors.NoWorkingTree:
1745
b = Branch.open(location)
1746
last_revision = b.last_revision()
1749
last_revision = wt.last_revision()
1751
self.add_cleanup(b.repository.lock_read().unlock)
1752
graph = b.repository.get_graph()
1753
revisions = [revid for revid, parents in
1754
graph.iter_ancestry([last_revision])]
1755
for revision_id in reversed(revisions):
1756
if _mod_revision.is_null(revision_id):
1758
self.outf.write(revision_id + '\n')
1761
class cmd_init(Command):
1762
__doc__ = """Make a directory into a versioned branch.
1764
Use this to create an empty branch, or before importing an
1767
If there is a repository in a parent directory of the location, then
1768
the history of the branch will be stored in the repository. Otherwise
1769
init creates a standalone branch which carries its own history
1770
in the .bzr directory.
1772
If there is already a branch at the location but it has no working tree,
1773
the tree can be populated with 'bzr checkout'.
1775
Recipe for importing a tree of files::
1781
bzr commit -m "imported project"
1784
_see_also = ['init-repository', 'branch', 'checkout']
1785
takes_args = ['location?']
1787
Option('create-prefix',
1788
help='Create the path leading up to the branch '
1789
'if it does not already exist.'),
1790
RegistryOption('format',
1791
help='Specify a format for this branch. '
1792
'See "help formats".',
1793
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1794
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1795
value_switches=True,
1796
title="Branch format",
1798
Option('append-revisions-only',
1799
help='Never change revnos or the existing log.'
1800
' Append revisions to it only.'),
1802
'Create a branch without a working tree.')
1804
def run(self, location=None, format=None, append_revisions_only=False,
1805
create_prefix=False, no_tree=False):
1807
format = bzrdir.format_registry.make_bzrdir('default')
1808
if location is None:
1811
to_transport = transport.get_transport(location)
1813
# The path has to exist to initialize a
1814
# branch inside of it.
1815
# Just using os.mkdir, since I don't
1816
# believe that we want to create a bunch of
1817
# locations if the user supplies an extended path
1819
to_transport.ensure_base()
1820
except errors.NoSuchFile:
1821
if not create_prefix:
1822
raise errors.BzrCommandError("Parent directory of %s"
1824
"\nYou may supply --create-prefix to create all"
1825
" leading parent directories."
1827
to_transport.create_prefix()
1830
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1831
except errors.NotBranchError:
1832
# really a NotBzrDir error...
1833
create_branch = bzrdir.BzrDir.create_branch_convenience
1835
force_new_tree = False
1837
force_new_tree = None
1838
branch = create_branch(to_transport.base, format=format,
1839
possible_transports=[to_transport],
1840
force_new_tree=force_new_tree)
1841
a_bzrdir = branch.bzrdir
1843
from bzrlib.transport.local import LocalTransport
1844
if a_bzrdir.has_branch():
1845
if (isinstance(to_transport, LocalTransport)
1846
and not a_bzrdir.has_workingtree()):
1847
raise errors.BranchExistsWithoutWorkingTree(location)
1848
raise errors.AlreadyBranchError(location)
1849
branch = a_bzrdir.create_branch()
1851
a_bzrdir.create_workingtree()
1852
if append_revisions_only:
1854
branch.set_append_revisions_only(True)
1855
except errors.UpgradeRequired:
1856
raise errors.BzrCommandError('This branch format cannot be set'
1857
' to append-revisions-only. Try --default.')
1859
from bzrlib.info import describe_layout, describe_format
1861
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1862
except (errors.NoWorkingTree, errors.NotLocalUrl):
1864
repository = branch.repository
1865
layout = describe_layout(repository, branch, tree).lower()
1866
format = describe_format(a_bzrdir, repository, branch, tree)
1867
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1868
if repository.is_shared():
1869
#XXX: maybe this can be refactored into transport.path_or_url()
1870
url = repository.bzrdir.root_transport.external_url()
1872
url = urlutils.local_path_from_url(url)
1873
except errors.InvalidURL:
1875
self.outf.write("Using shared repository: %s\n" % url)
1878
class cmd_init_repository(Command):
1879
__doc__ = """Create a shared repository for branches to share storage space.
1881
New branches created under the repository directory will store their
1882
revisions in the repository, not in the branch directory. For branches
1883
with shared history, this reduces the amount of storage needed and
1884
speeds up the creation of new branches.
1886
If the --no-trees option is given then the branches in the repository
1887
will not have working trees by default. They will still exist as
1888
directories on disk, but they will not have separate copies of the
1889
files at a certain revision. This can be useful for repositories that
1890
store branches which are interacted with through checkouts or remote
1891
branches, such as on a server.
1894
Create a shared repository holding just branches::
1896
bzr init-repo --no-trees repo
1899
Make a lightweight checkout elsewhere::
1901
bzr checkout --lightweight repo/trunk trunk-checkout
1906
_see_also = ['init', 'branch', 'checkout', 'repositories']
1907
takes_args = ["location"]
1908
takes_options = [RegistryOption('format',
1909
help='Specify a format for this repository. See'
1910
' "bzr help formats" for details.',
1911
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1912
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1913
value_switches=True, title='Repository format'),
1915
help='Branches in the repository will default to'
1916
' not having a working tree.'),
1918
aliases = ["init-repo"]
1920
def run(self, location, format=None, no_trees=False):
1922
format = bzrdir.format_registry.make_bzrdir('default')
1924
if location is None:
1927
to_transport = transport.get_transport(location)
1928
to_transport.ensure_base()
1930
newdir = format.initialize_on_transport(to_transport)
1931
repo = newdir.create_repository(shared=True)
1932
repo.set_make_working_trees(not no_trees)
1934
from bzrlib.info import show_bzrdir_info
1935
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1938
class cmd_diff(Command):
1939
__doc__ = """Show differences in the working tree, between revisions or branches.
1941
If no arguments are given, all changes for the current tree are listed.
1942
If files are given, only the changes in those files are listed.
1943
Remote and multiple branches can be compared by using the --old and
1944
--new options. If not provided, the default for both is derived from
1945
the first argument, if any, or the current tree if no arguments are
1948
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1949
produces patches suitable for "patch -p1".
1951
Note that when using the -r argument with a range of revisions, the
1952
differences are computed between the two specified revisions. That
1953
is, the command does not show the changes introduced by the first
1954
revision in the range. This differs from the interpretation of
1955
revision ranges used by "bzr log" which includes the first revision
1960
2 - unrepresentable changes
1965
Shows the difference in the working tree versus the last commit::
1969
Difference between the working tree and revision 1::
1973
Difference between revision 3 and revision 1::
1977
Difference between revision 3 and revision 1 for branch xxx::
1981
The changes introduced by revision 2 (equivalent to -r1..2)::
1985
To see the changes introduced by revision X::
1989
Note that in the case of a merge, the -c option shows the changes
1990
compared to the left hand parent. To see the changes against
1991
another parent, use::
1993
bzr diff -r<chosen_parent>..X
1995
The changes between the current revision and the previous revision
1996
(equivalent to -c-1 and -r-2..-1)
2000
Show just the differences for file NEWS::
2004
Show the differences in working tree xxx for file NEWS::
2008
Show the differences from branch xxx to this working tree:
2012
Show the differences between two branches for file NEWS::
2014
bzr diff --old xxx --new yyy NEWS
2016
Same as 'bzr diff' but prefix paths with old/ and new/::
2018
bzr diff --prefix old/:new/
2020
Show the differences using a custom diff program with options::
2022
bzr diff --using /usr/bin/diff --diff-options -wu
2024
_see_also = ['status']
2025
takes_args = ['file*']
2027
Option('diff-options', type=str,
2028
help='Pass these options to the external diff program.'),
2029
Option('prefix', type=str,
2031
help='Set prefixes added to old and new filenames, as '
2032
'two values separated by a colon. (eg "old/:new/").'),
2034
help='Branch/tree to compare from.',
2038
help='Branch/tree to compare to.',
2044
help='Use this command to compare files.',
2047
RegistryOption('format',
2049
help='Diff format to use.',
2050
lazy_registry=('bzrlib.diff', 'format_registry'),
2051
title='Diff format'),
2053
aliases = ['di', 'dif']
2054
encoding_type = 'exact'
2057
def run(self, revision=None, file_list=None, diff_options=None,
2058
prefix=None, old=None, new=None, using=None, format=None):
2059
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2062
if (prefix is None) or (prefix == '0'):
2070
old_label, new_label = prefix.split(":")
2072
raise errors.BzrCommandError(
2073
'--prefix expects two values separated by a colon'
2074
' (eg "old/:new/")')
2076
if revision and len(revision) > 2:
2077
raise errors.BzrCommandError('bzr diff --revision takes exactly'
2078
' one or two revision specifiers')
2080
if using is not None and format is not None:
2081
raise errors.BzrCommandError('--using and --format are mutually '
2084
(old_tree, new_tree,
2085
old_branch, new_branch,
2086
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2087
file_list, revision, old, new, self.add_cleanup, apply_view=True)
2088
# GNU diff on Windows uses ANSI encoding for filenames
2089
path_encoding = osutils.get_diff_header_encoding()
2090
return show_diff_trees(old_tree, new_tree, sys.stdout,
2091
specific_files=specific_files,
2092
external_diff_options=diff_options,
2093
old_label=old_label, new_label=new_label,
2094
extra_trees=extra_trees,
2095
path_encoding=path_encoding,
2100
class cmd_deleted(Command):
2101
__doc__ = """List files deleted in the working tree.
2103
# TODO: Show files deleted since a previous revision, or
2104
# between two revisions.
2105
# TODO: Much more efficient way to do this: read in new
2106
# directories with readdir, rather than stating each one. Same
2107
# level of effort but possibly much less IO. (Or possibly not,
2108
# if the directories are very large...)
2109
_see_also = ['status', 'ls']
2110
takes_options = ['directory', 'show-ids']
2113
def run(self, show_ids=False, directory=u'.'):
2114
tree = WorkingTree.open_containing(directory)[0]
2115
self.add_cleanup(tree.lock_read().unlock)
2116
old = tree.basis_tree()
2117
self.add_cleanup(old.lock_read().unlock)
2118
for path, ie in old.inventory.iter_entries():
2119
if not tree.has_id(ie.file_id):
2120
self.outf.write(path)
2122
self.outf.write(' ')
2123
self.outf.write(ie.file_id)
2124
self.outf.write('\n')
2127
class cmd_modified(Command):
2128
__doc__ = """List files modified in working tree.
2132
_see_also = ['status', 'ls']
2133
takes_options = ['directory', 'null']
2136
def run(self, null=False, directory=u'.'):
2137
tree = WorkingTree.open_containing(directory)[0]
2138
self.add_cleanup(tree.lock_read().unlock)
2139
td = tree.changes_from(tree.basis_tree())
2141
for path, id, kind, text_modified, meta_modified in td.modified:
2143
self.outf.write(path + '\0')
2145
self.outf.write(osutils.quotefn(path) + '\n')
2148
class cmd_added(Command):
2149
__doc__ = """List files added in working tree.
2153
_see_also = ['status', 'ls']
2154
takes_options = ['directory', 'null']
2157
def run(self, null=False, directory=u'.'):
2158
wt = WorkingTree.open_containing(directory)[0]
2159
self.add_cleanup(wt.lock_read().unlock)
2160
basis = wt.basis_tree()
2161
self.add_cleanup(basis.lock_read().unlock)
2162
basis_inv = basis.inventory
2165
if basis_inv.has_id(file_id):
2167
if inv.is_root(file_id) and len(basis_inv) == 0:
2169
path = inv.id2path(file_id)
2170
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2173
self.outf.write(path + '\0')
2175
self.outf.write(osutils.quotefn(path) + '\n')
2178
class cmd_root(Command):
2179
__doc__ = """Show the tree root directory.
2181
The root is the nearest enclosing directory with a .bzr control
2184
takes_args = ['filename?']
2186
def run(self, filename=None):
2187
"""Print the branch root."""
2188
tree = WorkingTree.open_containing(filename)[0]
2189
self.outf.write(tree.basedir + '\n')
2192
def _parse_limit(limitstring):
2194
return int(limitstring)
2196
msg = "The limit argument must be an integer."
2197
raise errors.BzrCommandError(msg)
2200
def _parse_levels(s):
2204
msg = "The levels argument must be an integer."
2205
raise errors.BzrCommandError(msg)
2208
class cmd_log(Command):
2209
__doc__ = """Show historical log for a branch or subset of a branch.
2211
log is bzr's default tool for exploring the history of a branch.
2212
The branch to use is taken from the first parameter. If no parameters
2213
are given, the branch containing the working directory is logged.
2214
Here are some simple examples::
2216
bzr log log the current branch
2217
bzr log foo.py log a file in its branch
2218
bzr log http://server/branch log a branch on a server
2220
The filtering, ordering and information shown for each revision can
2221
be controlled as explained below. By default, all revisions are
2222
shown sorted (topologically) so that newer revisions appear before
2223
older ones and descendants always appear before ancestors. If displayed,
2224
merged revisions are shown indented under the revision in which they
2229
The log format controls how information about each revision is
2230
displayed. The standard log formats are called ``long``, ``short``
2231
and ``line``. The default is long. See ``bzr help log-formats``
2232
for more details on log formats.
2234
The following options can be used to control what information is
2237
-l N display a maximum of N revisions
2238
-n N display N levels of revisions (0 for all, 1 for collapsed)
2239
-v display a status summary (delta) for each revision
2240
-p display a diff (patch) for each revision
2241
--show-ids display revision-ids (and file-ids), not just revnos
2243
Note that the default number of levels to display is a function of the
2244
log format. If the -n option is not used, the standard log formats show
2245
just the top level (mainline).
2247
Status summaries are shown using status flags like A, M, etc. To see
2248
the changes explained using words like ``added`` and ``modified``
2249
instead, use the -vv option.
2253
To display revisions from oldest to newest, use the --forward option.
2254
In most cases, using this option will have little impact on the total
2255
time taken to produce a log, though --forward does not incrementally
2256
display revisions like --reverse does when it can.
2258
:Revision filtering:
2260
The -r option can be used to specify what revision or range of revisions
2261
to filter against. The various forms are shown below::
2263
-rX display revision X
2264
-rX.. display revision X and later
2265
-r..Y display up to and including revision Y
2266
-rX..Y display from X to Y inclusive
2268
See ``bzr help revisionspec`` for details on how to specify X and Y.
2269
Some common examples are given below::
2271
-r-1 show just the tip
2272
-r-10.. show the last 10 mainline revisions
2273
-rsubmit:.. show what's new on this branch
2274
-rancestor:path.. show changes since the common ancestor of this
2275
branch and the one at location path
2276
-rdate:yesterday.. show changes since yesterday
2278
When logging a range of revisions using -rX..Y, log starts at
2279
revision Y and searches back in history through the primary
2280
("left-hand") parents until it finds X. When logging just the
2281
top level (using -n1), an error is reported if X is not found
2282
along the way. If multi-level logging is used (-n0), X may be
2283
a nested merge revision and the log will be truncated accordingly.
2287
If parameters are given and the first one is not a branch, the log
2288
will be filtered to show only those revisions that changed the
2289
nominated files or directories.
2291
Filenames are interpreted within their historical context. To log a
2292
deleted file, specify a revision range so that the file existed at
2293
the end or start of the range.
2295
Historical context is also important when interpreting pathnames of
2296
renamed files/directories. Consider the following example:
2298
* revision 1: add tutorial.txt
2299
* revision 2: modify tutorial.txt
2300
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2304
* ``bzr log guide.txt`` will log the file added in revision 1
2306
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2308
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2309
the original file in revision 2.
2311
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2312
was no file called guide.txt in revision 2.
2314
Renames are always followed by log. By design, there is no need to
2315
explicitly ask for this (and no way to stop logging a file back
2316
until it was last renamed).
2320
The --message option can be used for finding revisions that match a
2321
regular expression in a commit message.
2325
GUI tools and IDEs are often better at exploring history than command
2326
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2327
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2328
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2329
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2331
You may find it useful to add the aliases below to ``bazaar.conf``::
2335
top = log -l10 --line
2338
``bzr tip`` will then show the latest revision while ``bzr top``
2339
will show the last 10 mainline revisions. To see the details of a
2340
particular revision X, ``bzr show -rX``.
2342
If you are interested in looking deeper into a particular merge X,
2343
use ``bzr log -n0 -rX``.
2345
``bzr log -v`` on a branch with lots of history is currently
2346
very slow. A fix for this issue is currently under development.
2347
With or without that fix, it is recommended that a revision range
2348
be given when using the -v option.
2350
bzr has a generic full-text matching plugin, bzr-search, that can be
2351
used to find revisions matching user names, commit messages, etc.
2352
Among other features, this plugin can find all revisions containing
2353
a list of words but not others.
2355
When exploring non-mainline history on large projects with deep
2356
history, the performance of log can be greatly improved by installing
2357
the historycache plugin. This plugin buffers historical information
2358
trading disk space for faster speed.
2360
takes_args = ['file*']
2361
_see_also = ['log-formats', 'revisionspec']
2364
help='Show from oldest to newest.'),
2366
custom_help('verbose',
2367
help='Show files changed in each revision.'),
2371
type=bzrlib.option._parse_revision_str,
2373
help='Show just the specified revision.'
2374
' See also "help revisionspec".'),
2376
RegistryOption('authors',
2377
'What names to list as authors - first, all or committer.',
2379
lazy_registry=('bzrlib.log', 'author_list_registry'),
2383
help='Number of levels to display - 0 for all, 1 for flat.',
2385
type=_parse_levels),
2388
help='Show revisions whose message matches this '
2389
'regular expression.',
2393
help='Limit the output to the first N revisions.',
2398
help='Show changes made in each revision as a patch.'),
2399
Option('include-merges',
2400
help='Show merged revisions like --levels 0 does.'),
2401
Option('exclude-common-ancestry',
2402
help='Display only the revisions that are not part'
2403
' of both ancestries (require -rX..Y)'
2405
Option('signatures',
2406
help='Show digital signature validity'),
2408
encoding_type = 'replace'
2411
def run(self, file_list=None, timezone='original',
2422
include_merges=False,
2424
exclude_common_ancestry=False,
2427
from bzrlib.log import (
2429
make_log_request_dict,
2430
_get_info_for_log_files,
2432
direction = (forward and 'forward') or 'reverse'
2433
if (exclude_common_ancestry
2434
and (revision is None or len(revision) != 2)):
2435
raise errors.BzrCommandError(
2436
'--exclude-common-ancestry requires -r with two revisions')
2441
raise errors.BzrCommandError(
2442
'--levels and --include-merges are mutually exclusive')
2444
if change is not None:
2446
raise errors.RangeInChangeOption()
2447
if revision is not None:
2448
raise errors.BzrCommandError(
2449
'--revision and --change are mutually exclusive')
2454
filter_by_dir = False
2456
# find the file ids to log and check for directory filtering
2457
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2458
revision, file_list, self.add_cleanup)
2459
for relpath, file_id, kind in file_info_list:
2461
raise errors.BzrCommandError(
2462
"Path unknown at end or start of revision range: %s" %
2464
# If the relpath is the top of the tree, we log everything
2469
file_ids.append(file_id)
2470
filter_by_dir = filter_by_dir or (
2471
kind in ['directory', 'tree-reference'])
2474
# FIXME ? log the current subdir only RBC 20060203
2475
if revision is not None \
2476
and len(revision) > 0 and revision[0].get_branch():
2477
location = revision[0].get_branch()
2480
dir, relpath = bzrdir.BzrDir.open_containing(location)
2481
b = dir.open_branch()
2482
self.add_cleanup(b.lock_read().unlock)
2483
rev1, rev2 = _get_revision_range(revision, b, self.name())
2485
if b.get_config().validate_signatures_in_log():
2489
if not gpg.GPGStrategy.verify_signatures_available():
2490
raise errors.GpgmeNotInstalled(None)
2492
# Decide on the type of delta & diff filtering to use
2493
# TODO: add an --all-files option to make this configurable & consistent
2501
diff_type = 'partial'
2505
# Build the log formatter
2506
if log_format is None:
2507
log_format = log.log_formatter_registry.get_default(b)
2508
# Make a non-encoding output to include the diffs - bug 328007
2509
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2510
lf = log_format(show_ids=show_ids, to_file=self.outf,
2511
to_exact_file=unencoded_output,
2512
show_timezone=timezone,
2513
delta_format=get_verbosity_level(),
2515
show_advice=levels is None,
2516
author_list_handler=authors)
2518
# Choose the algorithm for doing the logging. It's annoying
2519
# having multiple code paths like this but necessary until
2520
# the underlying repository format is faster at generating
2521
# deltas or can provide everything we need from the indices.
2522
# The default algorithm - match-using-deltas - works for
2523
# multiple files and directories and is faster for small
2524
# amounts of history (200 revisions say). However, it's too
2525
# slow for logging a single file in a repository with deep
2526
# history, i.e. > 10K revisions. In the spirit of "do no
2527
# evil when adding features", we continue to use the
2528
# original algorithm - per-file-graph - for the "single
2529
# file that isn't a directory without showing a delta" case.
2530
partial_history = revision and b.repository._format.supports_chks
2531
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2532
or delta_type or partial_history)
2534
# Build the LogRequest and execute it
2535
if len(file_ids) == 0:
2537
rqst = make_log_request_dict(
2538
direction=direction, specific_fileids=file_ids,
2539
start_revision=rev1, end_revision=rev2, limit=limit,
2540
message_search=message, delta_type=delta_type,
2541
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2542
exclude_common_ancestry=exclude_common_ancestry,
2543
signature=signatures
2545
Logger(b, rqst).show(lf)
2548
def _get_revision_range(revisionspec_list, branch, command_name):
2549
"""Take the input of a revision option and turn it into a revision range.
2551
It returns RevisionInfo objects which can be used to obtain the rev_id's
2552
of the desired revisions. It does some user input validations.
2554
if revisionspec_list is None:
2557
elif len(revisionspec_list) == 1:
2558
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2559
elif len(revisionspec_list) == 2:
2560
start_spec = revisionspec_list[0]
2561
end_spec = revisionspec_list[1]
2562
if end_spec.get_branch() != start_spec.get_branch():
2563
# b is taken from revision[0].get_branch(), and
2564
# show_log will use its revision_history. Having
2565
# different branches will lead to weird behaviors.
2566
raise errors.BzrCommandError(
2567
"bzr %s doesn't accept two revisions in different"
2568
" branches." % command_name)
2569
if start_spec.spec is None:
2570
# Avoid loading all the history.
2571
rev1 = RevisionInfo(branch, None, None)
2573
rev1 = start_spec.in_history(branch)
2574
# Avoid loading all of history when we know a missing
2575
# end of range means the last revision ...
2576
if end_spec.spec is None:
2577
last_revno, last_revision_id = branch.last_revision_info()
2578
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2580
rev2 = end_spec.in_history(branch)
2582
raise errors.BzrCommandError(
2583
'bzr %s --revision takes one or two values.' % command_name)
2587
def _revision_range_to_revid_range(revision_range):
2590
if revision_range[0] is not None:
2591
rev_id1 = revision_range[0].rev_id
2592
if revision_range[1] is not None:
2593
rev_id2 = revision_range[1].rev_id
2594
return rev_id1, rev_id2
2596
def get_log_format(long=False, short=False, line=False, default='long'):
2597
log_format = default
2601
log_format = 'short'
2607
class cmd_touching_revisions(Command):
2608
__doc__ = """Return revision-ids which affected a particular file.
2610
A more user-friendly interface is "bzr log FILE".
2614
takes_args = ["filename"]
2617
def run(self, filename):
2618
tree, relpath = WorkingTree.open_containing(filename)
2619
file_id = tree.path2id(relpath)
2621
self.add_cleanup(b.lock_read().unlock)
2622
touching_revs = log.find_touching_revisions(b, file_id)
2623
for revno, revision_id, what in touching_revs:
2624
self.outf.write("%6d %s\n" % (revno, what))
2627
class cmd_ls(Command):
2628
__doc__ = """List files in a tree.
2631
_see_also = ['status', 'cat']
2632
takes_args = ['path?']
2636
Option('recursive', short_name='R',
2637
help='Recurse into subdirectories.'),
2639
help='Print paths relative to the root of the branch.'),
2640
Option('unknown', short_name='u',
2641
help='Print unknown files.'),
2642
Option('versioned', help='Print versioned files.',
2644
Option('ignored', short_name='i',
2645
help='Print ignored files.'),
2646
Option('kind', short_name='k',
2647
help='List entries of a particular kind: file, directory, symlink.',
2654
def run(self, revision=None, verbose=False,
2655
recursive=False, from_root=False,
2656
unknown=False, versioned=False, ignored=False,
2657
null=False, kind=None, show_ids=False, path=None, directory=None):
2659
if kind and kind not in ('file', 'directory', 'symlink'):
2660
raise errors.BzrCommandError('invalid kind specified')
2662
if verbose and null:
2663
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2664
all = not (unknown or versioned or ignored)
2666
selection = {'I':ignored, '?':unknown, 'V':versioned}
2672
raise errors.BzrCommandError('cannot specify both --from-root'
2675
tree, branch, relpath = \
2676
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2678
# Calculate the prefix to use
2682
prefix = relpath + '/'
2683
elif fs_path != '.' and not fs_path.endswith('/'):
2684
prefix = fs_path + '/'
2686
if revision is not None or tree is None:
2687
tree = _get_one_revision_tree('ls', revision, branch=branch)
2690
if isinstance(tree, WorkingTree) and tree.supports_views():
2691
view_files = tree.views.lookup_view()
2694
view_str = views.view_display_str(view_files)
2695
note("Ignoring files outside view. View is %s" % view_str)
2697
self.add_cleanup(tree.lock_read().unlock)
2698
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2699
from_dir=relpath, recursive=recursive):
2700
# Apply additional masking
2701
if not all and not selection[fc]:
2703
if kind is not None and fkind != kind:
2708
fullpath = osutils.pathjoin(relpath, fp)
2711
views.check_path_in_view(tree, fullpath)
2712
except errors.FileOutsideView:
2717
fp = osutils.pathjoin(prefix, fp)
2718
kindch = entry.kind_character()
2719
outstring = fp + kindch
2720
ui.ui_factory.clear_term()
2722
outstring = '%-8s %s' % (fc, outstring)
2723
if show_ids and fid is not None:
2724
outstring = "%-50s %s" % (outstring, fid)
2725
self.outf.write(outstring + '\n')
2727
self.outf.write(fp + '\0')
2730
self.outf.write(fid)
2731
self.outf.write('\0')
2739
self.outf.write('%-50s %s\n' % (outstring, my_id))
2741
self.outf.write(outstring + '\n')
2744
class cmd_unknowns(Command):
2745
__doc__ = """List unknown files.
2750
takes_options = ['directory']
2753
def run(self, directory=u'.'):
2754
for f in WorkingTree.open_containing(directory)[0].unknowns():
2755
self.outf.write(osutils.quotefn(f) + '\n')
2758
class cmd_ignore(Command):
2759
__doc__ = """Ignore specified files or patterns.
2761
See ``bzr help patterns`` for details on the syntax of patterns.
2763
If a .bzrignore file does not exist, the ignore command
2764
will create one and add the specified files or patterns to the newly
2765
created file. The ignore command will also automatically add the
2766
.bzrignore file to be versioned. Creating a .bzrignore file without
2767
the use of the ignore command will require an explicit add command.
2769
To remove patterns from the ignore list, edit the .bzrignore file.
2770
After adding, editing or deleting that file either indirectly by
2771
using this command or directly by using an editor, be sure to commit
2774
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2775
the global ignore file can be found in the application data directory as
2776
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2777
Global ignores are not touched by this command. The global ignore file
2778
can be edited directly using an editor.
2780
Patterns prefixed with '!' are exceptions to ignore patterns and take
2781
precedence over regular ignores. Such exceptions are used to specify
2782
files that should be versioned which would otherwise be ignored.
2784
Patterns prefixed with '!!' act as regular ignore patterns, but have
2785
precedence over the '!' exception patterns.
2789
* Ignore patterns containing shell wildcards must be quoted from
2792
* Ignore patterns starting with "#" act as comments in the ignore file.
2793
To ignore patterns that begin with that character, use the "RE:" prefix.
2796
Ignore the top level Makefile::
2798
bzr ignore ./Makefile
2800
Ignore .class files in all directories...::
2802
bzr ignore "*.class"
2804
...but do not ignore "special.class"::
2806
bzr ignore "!special.class"
2808
Ignore files whose name begins with the "#" character::
2812
Ignore .o files under the lib directory::
2814
bzr ignore "lib/**/*.o"
2816
Ignore .o files under the lib directory::
2818
bzr ignore "RE:lib/.*\.o"
2820
Ignore everything but the "debian" toplevel directory::
2822
bzr ignore "RE:(?!debian/).*"
2824
Ignore everything except the "local" toplevel directory,
2825
but always ignore autosave files ending in ~, even under local/::
2828
bzr ignore "!./local"
2832
_see_also = ['status', 'ignored', 'patterns']
2833
takes_args = ['name_pattern*']
2834
takes_options = ['directory',
2835
Option('default-rules',
2836
help='Display the default ignore rules that bzr uses.')
2839
def run(self, name_pattern_list=None, default_rules=None,
2841
from bzrlib import ignores
2842
if default_rules is not None:
2843
# dump the default rules and exit
2844
for pattern in ignores.USER_DEFAULTS:
2845
self.outf.write("%s\n" % pattern)
2847
if not name_pattern_list:
2848
raise errors.BzrCommandError("ignore requires at least one "
2849
"NAME_PATTERN or --default-rules.")
2850
name_pattern_list = [globbing.normalize_pattern(p)
2851
for p in name_pattern_list]
2853
for p in name_pattern_list:
2854
if not globbing.Globster.is_pattern_valid(p):
2855
bad_patterns += ('\n %s' % p)
2857
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2858
ui.ui_factory.show_error(msg)
2859
raise errors.InvalidPattern('')
2860
for name_pattern in name_pattern_list:
2861
if (name_pattern[0] == '/' or
2862
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2863
raise errors.BzrCommandError(
2864
"NAME_PATTERN should not be an absolute path")
2865
tree, relpath = WorkingTree.open_containing(directory)
2866
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2867
ignored = globbing.Globster(name_pattern_list)
2869
self.add_cleanup(tree.lock_read().unlock)
2870
for entry in tree.list_files():
2874
if ignored.match(filename):
2875
matches.append(filename)
2876
if len(matches) > 0:
2877
self.outf.write("Warning: the following files are version controlled and"
2878
" match your ignore pattern:\n%s"
2879
"\nThese files will continue to be version controlled"
2880
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2883
class cmd_ignored(Command):
2884
__doc__ = """List ignored files and the patterns that matched them.
2886
List all the ignored files and the ignore pattern that caused the file to
2889
Alternatively, to list just the files::
2894
encoding_type = 'replace'
2895
_see_also = ['ignore', 'ls']
2896
takes_options = ['directory']
2899
def run(self, directory=u'.'):
2900
tree = WorkingTree.open_containing(directory)[0]
2901
self.add_cleanup(tree.lock_read().unlock)
2902
for path, file_class, kind, file_id, entry in tree.list_files():
2903
if file_class != 'I':
2905
## XXX: Slightly inefficient since this was already calculated
2906
pat = tree.is_ignored(path)
2907
self.outf.write('%-50s %s\n' % (path, pat))
2910
class cmd_lookup_revision(Command):
2911
__doc__ = """Lookup the revision-id from a revision-number
2914
bzr lookup-revision 33
2917
takes_args = ['revno']
2918
takes_options = ['directory']
2921
def run(self, revno, directory=u'.'):
2925
raise errors.BzrCommandError("not a valid revision-number: %r"
2927
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2928
self.outf.write("%s\n" % revid)
2931
class cmd_export(Command):
2932
__doc__ = """Export current or past revision to a destination directory or archive.
2934
If no revision is specified this exports the last committed revision.
2936
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2937
given, try to find the format with the extension. If no extension
2938
is found exports to a directory (equivalent to --format=dir).
2940
If root is supplied, it will be used as the root directory inside
2941
container formats (tar, zip, etc). If it is not supplied it will default
2942
to the exported filename. The root option has no effect for 'dir' format.
2944
If branch is omitted then the branch containing the current working
2945
directory will be used.
2947
Note: Export of tree with non-ASCII filenames to zip is not supported.
2949
================= =========================
2950
Supported formats Autodetected by extension
2951
================= =========================
2954
tbz2 .tar.bz2, .tbz2
2957
================= =========================
2960
takes_args = ['dest', 'branch_or_subdir?']
2961
takes_options = ['directory',
2963
help="Type of file to export to.",
2966
Option('filters', help='Apply content filters to export the '
2967
'convenient form.'),
2970
help="Name of the root directory inside the exported file."),
2971
Option('per-file-timestamps',
2972
help='Set modification time of files to that of the last '
2973
'revision in which it was changed.'),
2975
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2976
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2977
from bzrlib.export import export
2979
if branch_or_subdir is None:
2980
tree = WorkingTree.open_containing(directory)[0]
2984
b, subdir = Branch.open_containing(branch_or_subdir)
2987
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2989
export(rev_tree, dest, format, root, subdir, filtered=filters,
2990
per_file_timestamps=per_file_timestamps)
2991
except errors.NoSuchExportFormat, e:
2992
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2995
class cmd_cat(Command):
2996
__doc__ = """Write the contents of a file as of a given revision to standard output.
2998
If no revision is nominated, the last revision is used.
3000
Note: Take care to redirect standard output when using this command on a
3005
takes_options = ['directory',
3006
Option('name-from-revision', help='The path name in the old tree.'),
3007
Option('filters', help='Apply content filters to display the '
3008
'convenience form.'),
3011
takes_args = ['filename']
3012
encoding_type = 'exact'
3015
def run(self, filename, revision=None, name_from_revision=False,
3016
filters=False, directory=None):
3017
if revision is not None and len(revision) != 1:
3018
raise errors.BzrCommandError("bzr cat --revision takes exactly"
3019
" one revision specifier")
3020
tree, branch, relpath = \
3021
_open_directory_or_containing_tree_or_branch(filename, directory)
3022
self.add_cleanup(branch.lock_read().unlock)
3023
return self._run(tree, branch, relpath, filename, revision,
3024
name_from_revision, filters)
3026
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3029
tree = b.basis_tree()
3030
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3031
self.add_cleanup(rev_tree.lock_read().unlock)
3033
old_file_id = rev_tree.path2id(relpath)
3035
if name_from_revision:
3036
# Try in revision if requested
3037
if old_file_id is None:
3038
raise errors.BzrCommandError(
3039
"%r is not present in revision %s" % (
3040
filename, rev_tree.get_revision_id()))
3042
content = rev_tree.get_file_text(old_file_id)
3044
cur_file_id = tree.path2id(relpath)
3046
if cur_file_id is not None:
3047
# Then try with the actual file id
3049
content = rev_tree.get_file_text(cur_file_id)
3051
except errors.NoSuchId:
3052
# The actual file id didn't exist at that time
3054
if not found and old_file_id is not None:
3055
# Finally try with the old file id
3056
content = rev_tree.get_file_text(old_file_id)
3059
# Can't be found anywhere
3060
raise errors.BzrCommandError(
3061
"%r is not present in revision %s" % (
3062
filename, rev_tree.get_revision_id()))
3064
from bzrlib.filters import (
3065
ContentFilterContext,
3066
filtered_output_bytes,
3068
filters = rev_tree._content_filter_stack(relpath)
3069
chunks = content.splitlines(True)
3070
content = filtered_output_bytes(chunks, filters,
3071
ContentFilterContext(relpath, rev_tree))
3073
self.outf.writelines(content)
3076
self.outf.write(content)
3079
class cmd_local_time_offset(Command):
3080
__doc__ = """Show the offset in seconds from GMT to local time."""
3084
self.outf.write("%s\n" % osutils.local_time_offset())
3088
class cmd_commit(Command):
3089
__doc__ = """Commit changes into a new revision.
3091
An explanatory message needs to be given for each commit. This is
3092
often done by using the --message option (getting the message from the
3093
command line) or by using the --file option (getting the message from
3094
a file). If neither of these options is given, an editor is opened for
3095
the user to enter the message. To see the changed files in the
3096
boilerplate text loaded into the editor, use the --show-diff option.
3098
By default, the entire tree is committed and the person doing the
3099
commit is assumed to be the author. These defaults can be overridden
3104
If selected files are specified, only changes to those files are
3105
committed. If a directory is specified then the directory and
3106
everything within it is committed.
3108
When excludes are given, they take precedence over selected files.
3109
For example, to commit only changes within foo, but not changes
3112
bzr commit foo -x foo/bar
3114
A selective commit after a merge is not yet supported.
3118
If the author of the change is not the same person as the committer,
3119
you can specify the author's name using the --author option. The
3120
name should be in the same format as a committer-id, e.g.
3121
"John Doe <jdoe@example.com>". If there is more than one author of
3122
the change you can specify the option multiple times, once for each
3127
A common mistake is to forget to add a new file or directory before
3128
running the commit command. The --strict option checks for unknown
3129
files and aborts the commit if any are found. More advanced pre-commit
3130
checks can be implemented by defining hooks. See ``bzr help hooks``
3135
If you accidentially commit the wrong changes or make a spelling
3136
mistake in the commit message say, you can use the uncommit command
3137
to undo it. See ``bzr help uncommit`` for details.
3139
Hooks can also be configured to run after a commit. This allows you
3140
to trigger updates to external systems like bug trackers. The --fixes
3141
option can be used to record the association between a revision and
3142
one or more bugs. See ``bzr help bugs`` for details.
3145
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3146
takes_args = ['selected*']
3148
ListOption('exclude', type=str, short_name='x',
3149
help="Do not consider changes made to a given path."),
3150
Option('message', type=unicode,
3152
help="Description of the new revision."),
3155
help='Commit even if nothing has changed.'),
3156
Option('file', type=str,
3159
help='Take commit message from this file.'),
3161
help="Refuse to commit if there are unknown "
3162
"files in the working tree."),
3163
Option('commit-time', type=str,
3164
help="Manually set a commit time using commit date "
3165
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3166
ListOption('fixes', type=str,
3167
help="Mark a bug as being fixed by this revision "
3168
"(see \"bzr help bugs\")."),
3169
ListOption('author', type=unicode,
3170
help="Set the author's name, if it's different "
3171
"from the committer."),
3173
help="Perform a local commit in a bound "
3174
"branch. Local commits are not pushed to "
3175
"the master branch until a normal commit "
3178
Option('show-diff', short_name='p',
3179
help='When no message is supplied, show the diff along'
3180
' with the status summary in the message editor.'),
3182
help='When committing to a foreign version control '
3183
'system do not push data that can not be natively '
3186
aliases = ['ci', 'checkin']
3188
def _iter_bug_fix_urls(self, fixes, branch):
3189
# Configure the properties for bug fixing attributes.
3190
for fixed_bug in fixes:
3191
tokens = fixed_bug.split(':')
3192
if len(tokens) != 2:
3193
raise errors.BzrCommandError(
3194
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3195
"See \"bzr help bugs\" for more information on this "
3196
"feature.\nCommit refused." % fixed_bug)
3197
tag, bug_id = tokens
3199
yield bugtracker.get_bug_url(tag, branch, bug_id)
3200
except errors.UnknownBugTrackerAbbreviation:
3201
raise errors.BzrCommandError(
3202
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3203
except errors.MalformedBugIdentifier, e:
3204
raise errors.BzrCommandError(
3205
"%s\nCommit refused." % (str(e),))
3207
def run(self, message=None, file=None, verbose=False, selected_list=None,
3208
unchanged=False, strict=False, local=False, fixes=None,
3209
author=None, show_diff=False, exclude=None, commit_time=None,
3211
from bzrlib.errors import (
3216
from bzrlib.msgeditor import (
3217
edit_commit_message_encoded,
3218
generate_commit_message_template,
3219
make_commit_message_template_encoded,
3223
commit_stamp = offset = None
3224
if commit_time is not None:
3226
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3227
except ValueError, e:
3228
raise errors.BzrCommandError(
3229
"Could not parse --commit-time: " + str(e))
3233
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3234
if selected_list == ['']:
3235
# workaround - commit of root of tree should be exactly the same
3236
# as just default commit in that tree, and succeed even though
3237
# selected-file merge commit is not done yet
3242
bug_property = bugtracker.encode_fixes_bug_urls(
3243
self._iter_bug_fix_urls(fixes, tree.branch))
3245
properties['bugs'] = bug_property
3247
if local and not tree.branch.get_bound_location():
3248
raise errors.LocalRequiresBoundBranch()
3250
if message is not None:
3252
file_exists = osutils.lexists(message)
3253
except UnicodeError:
3254
# The commit message contains unicode characters that can't be
3255
# represented in the filesystem encoding, so that can't be a
3260
'The commit message is a file name: "%(f)s".\n'
3261
'(use --file "%(f)s" to take commit message from that file)'
3263
ui.ui_factory.show_warning(warning_msg)
3265
message = message.replace('\r\n', '\n')
3266
message = message.replace('\r', '\n')
3268
raise errors.BzrCommandError(
3269
"please specify either --message or --file")
3271
def get_message(commit_obj):
3272
"""Callback to get commit message"""
3276
my_message = f.read().decode(osutils.get_user_encoding())
3279
elif message is not None:
3280
my_message = message
3282
# No message supplied: make one up.
3283
# text is the status of the tree
3284
text = make_commit_message_template_encoded(tree,
3285
selected_list, diff=show_diff,
3286
output_encoding=osutils.get_user_encoding())
3287
# start_message is the template generated from hooks
3288
# XXX: Warning - looks like hooks return unicode,
3289
# make_commit_message_template_encoded returns user encoding.
3290
# We probably want to be using edit_commit_message instead to
3292
my_message = set_commit_message(commit_obj)
3293
if my_message is None:
3294
start_message = generate_commit_message_template(commit_obj)
3295
my_message = edit_commit_message_encoded(text,
3296
start_message=start_message)
3297
if my_message is None:
3298
raise errors.BzrCommandError("please specify a commit"
3299
" message with either --message or --file")
3300
if my_message == "":
3301
raise errors.BzrCommandError("empty commit message specified")
3304
# The API permits a commit with a filter of [] to mean 'select nothing'
3305
# but the command line should not do that.
3306
if not selected_list:
3307
selected_list = None
3309
tree.commit(message_callback=get_message,
3310
specific_files=selected_list,
3311
allow_pointless=unchanged, strict=strict, local=local,
3312
reporter=None, verbose=verbose, revprops=properties,
3313
authors=author, timestamp=commit_stamp,
3315
exclude=tree.safe_relpath_files(exclude),
3317
except PointlessCommit:
3318
raise errors.BzrCommandError("No changes to commit."
3319
" Please 'bzr add' the files you want to commit, or use"
3320
" --unchanged to force an empty commit.")
3321
except ConflictsInTree:
3322
raise errors.BzrCommandError('Conflicts detected in working '
3323
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3325
except StrictCommitFailed:
3326
raise errors.BzrCommandError("Commit refused because there are"
3327
" unknown files in the working tree.")
3328
except errors.BoundBranchOutOfDate, e:
3329
e.extra_help = ("\n"
3330
'To commit to master branch, run update and then commit.\n'
3331
'You can also pass --local to commit to continue working '
3336
class cmd_check(Command):
3337
__doc__ = """Validate working tree structure, branch consistency and repository history.
3339
This command checks various invariants about branch and repository storage
3340
to detect data corruption or bzr bugs.
3342
The working tree and branch checks will only give output if a problem is
3343
detected. The output fields of the repository check are:
3346
This is just the number of revisions checked. It doesn't
3350
This is just the number of versionedfiles checked. It
3351
doesn't indicate a problem.
3353
unreferenced ancestors
3354
Texts that are ancestors of other texts, but
3355
are not properly referenced by the revision ancestry. This is a
3356
subtle problem that Bazaar can work around.
3359
This is the total number of unique file contents
3360
seen in the checked revisions. It does not indicate a problem.
3363
This is the total number of repeated texts seen
3364
in the checked revisions. Texts can be repeated when their file
3365
entries are modified, but the file contents are not. It does not
3368
If no restrictions are specified, all Bazaar data that is found at the given
3369
location will be checked.
3373
Check the tree and branch at 'foo'::
3375
bzr check --tree --branch foo
3377
Check only the repository at 'bar'::
3379
bzr check --repo bar
3381
Check everything at 'baz'::
3386
_see_also = ['reconcile']
3387
takes_args = ['path?']
3388
takes_options = ['verbose',
3389
Option('branch', help="Check the branch related to the"
3390
" current directory."),
3391
Option('repo', help="Check the repository related to the"
3392
" current directory."),
3393
Option('tree', help="Check the working tree related to"
3394
" the current directory.")]
3396
def run(self, path=None, verbose=False, branch=False, repo=False,
3398
from bzrlib.check import check_dwim
3401
if not branch and not repo and not tree:
3402
branch = repo = tree = True
3403
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3406
class cmd_upgrade(Command):
3407
__doc__ = """Upgrade a repository, branch or working tree to a newer format.
3409
When the default format has changed after a major new release of
3410
Bazaar, you may be informed during certain operations that you
3411
should upgrade. Upgrading to a newer format may improve performance
3412
or make new features available. It may however limit interoperability
3413
with older repositories or with older versions of Bazaar.
3415
If you wish to upgrade to a particular format rather than the
3416
current default, that can be specified using the --format option.
3417
As a consequence, you can use the upgrade command this way to
3418
"downgrade" to an earlier format, though some conversions are
3419
a one way process (e.g. changing from the 1.x default to the
3420
2.x default) so downgrading is not always possible.
3422
A backup.bzr.~#~ directory is created at the start of the conversion
3423
process (where # is a number). By default, this is left there on
3424
completion. If the conversion fails, delete the new .bzr directory
3425
and rename this one back in its place. Use the --clean option to ask
3426
for the backup.bzr directory to be removed on successful conversion.
3427
Alternatively, you can delete it by hand if everything looks good
3430
If the location given is a shared repository, dependent branches
3431
are also converted provided the repository converts successfully.
3432
If the conversion of a branch fails, remaining branches are still
3435
For more information on upgrades, see the Bazaar Upgrade Guide,
3436
http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3439
_see_also = ['check', 'reconcile', 'formats']
3440
takes_args = ['url?']
3442
RegistryOption('format',
3443
help='Upgrade to a specific format. See "bzr help'
3444
' formats" for details.',
3445
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3446
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3447
value_switches=True, title='Branch format'),
3449
help='Remove the backup.bzr directory if successful.'),
3451
help="Show what would be done, but don't actually do anything."),
3454
def run(self, url='.', format=None, clean=False, dry_run=False):
3455
from bzrlib.upgrade import upgrade
3456
exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3458
if len(exceptions) == 1:
3459
# Compatibility with historical behavior
3465
class cmd_whoami(Command):
3466
__doc__ = """Show or set bzr user id.
3469
Show the email of the current user::
3473
Set the current user::
3475
bzr whoami "Frank Chu <fchu@example.com>"
3477
takes_options = [ 'directory',
3479
help='Display email address only.'),
3481
help='Set identity for the current branch instead of '
3484
takes_args = ['name?']
3485
encoding_type = 'replace'
3488
def run(self, email=False, branch=False, name=None, directory=None):
3490
if directory is None:
3491
# use branch if we're inside one; otherwise global config
3493
c = Branch.open_containing(u'.')[0].get_config()
3494
except errors.NotBranchError:
3495
c = _mod_config.GlobalConfig()
3497
c = Branch.open(directory).get_config()
3499
self.outf.write(c.user_email() + '\n')
3501
self.outf.write(c.username() + '\n')
3505
raise errors.BzrCommandError("--email can only be used to display existing "
3508
# display a warning if an email address isn't included in the given name.
3510
_mod_config.extract_email_address(name)
3511
except errors.NoEmailInUsername, e:
3512
warning('"%s" does not seem to contain an email address. '
3513
'This is allowed, but not recommended.', name)
3515
# use global config unless --branch given
3517
if directory is None:
3518
c = Branch.open_containing(u'.')[0].get_config()
3520
c = Branch.open(directory).get_config()
3522
c = _mod_config.GlobalConfig()
3523
c.set_user_option('email', name)
3526
class cmd_nick(Command):
3527
__doc__ = """Print or set the branch nickname.
3529
If unset, the tree root directory name is used as the nickname.
3530
To print the current nickname, execute with no argument.
3532
Bound branches use the nickname of its master branch unless it is set
3536
_see_also = ['info']
3537
takes_args = ['nickname?']
3538
takes_options = ['directory']
3539
def run(self, nickname=None, directory=u'.'):
3540
branch = Branch.open_containing(directory)[0]
3541
if nickname is None:
3542
self.printme(branch)
3544
branch.nick = nickname
3547
def printme(self, branch):
3548
self.outf.write('%s\n' % branch.nick)
3551
class cmd_alias(Command):
3552
__doc__ = """Set/unset and display aliases.
3555
Show the current aliases::
3559
Show the alias specified for 'll'::
3563
Set an alias for 'll'::
3565
bzr alias ll="log --line -r-10..-1"
3567
To remove an alias for 'll'::
3569
bzr alias --remove ll
3572
takes_args = ['name?']
3574
Option('remove', help='Remove the alias.'),
3577
def run(self, name=None, remove=False):
3579
self.remove_alias(name)
3581
self.print_aliases()
3583
equal_pos = name.find('=')
3585
self.print_alias(name)
3587
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3589
def remove_alias(self, alias_name):
3590
if alias_name is None:
3591
raise errors.BzrCommandError(
3592
'bzr alias --remove expects an alias to remove.')
3593
# If alias is not found, print something like:
3594
# unalias: foo: not found
3595
c = _mod_config.GlobalConfig()
3596
c.unset_alias(alias_name)
3599
def print_aliases(self):
3600
"""Print out the defined aliases in a similar format to bash."""
3601
aliases = _mod_config.GlobalConfig().get_aliases()
3602
for key, value in sorted(aliases.iteritems()):
3603
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3606
def print_alias(self, alias_name):
3607
from bzrlib.commands import get_alias
3608
alias = get_alias(alias_name)
3610
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3613
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3615
def set_alias(self, alias_name, alias_command):
3616
"""Save the alias in the global config."""
3617
c = _mod_config.GlobalConfig()
3618
c.set_alias(alias_name, alias_command)
3621
class cmd_selftest(Command):
3622
__doc__ = """Run internal test suite.
3624
If arguments are given, they are regular expressions that say which tests
3625
should run. Tests matching any expression are run, and other tests are
3628
Alternatively if --first is given, matching tests are run first and then
3629
all other tests are run. This is useful if you have been working in a
3630
particular area, but want to make sure nothing else was broken.
3632
If --exclude is given, tests that match that regular expression are
3633
excluded, regardless of whether they match --first or not.
3635
To help catch accidential dependencies between tests, the --randomize
3636
option is useful. In most cases, the argument used is the word 'now'.
3637
Note that the seed used for the random number generator is displayed
3638
when this option is used. The seed can be explicitly passed as the
3639
argument to this option if required. This enables reproduction of the
3640
actual ordering used if and when an order sensitive problem is encountered.
3642
If --list-only is given, the tests that would be run are listed. This is
3643
useful when combined with --first, --exclude and/or --randomize to
3644
understand their impact. The test harness reports "Listed nn tests in ..."
3645
instead of "Ran nn tests in ..." when list mode is enabled.
3647
If the global option '--no-plugins' is given, plugins are not loaded
3648
before running the selftests. This has two effects: features provided or
3649
modified by plugins will not be tested, and tests provided by plugins will
3652
Tests that need working space on disk use a common temporary directory,
3653
typically inside $TMPDIR or /tmp.
3655
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3656
into a pdb postmortem session.
3658
The --coverage=DIRNAME global option produces a report with covered code
3662
Run only tests relating to 'ignore'::
3666
Disable plugins and list tests as they're run::
3668
bzr --no-plugins selftest -v
3670
# NB: this is used from the class without creating an instance, which is
3671
# why it does not have a self parameter.
3672
def get_transport_type(typestring):
3673
"""Parse and return a transport specifier."""
3674
if typestring == "sftp":
3675
from bzrlib.tests import stub_sftp
3676
return stub_sftp.SFTPAbsoluteServer
3677
elif typestring == "memory":
3678
from bzrlib.tests import test_server
3679
return memory.MemoryServer
3680
elif typestring == "fakenfs":
3681
from bzrlib.tests import test_server
3682
return test_server.FakeNFSServer
3683
msg = "No known transport type %s. Supported types are: sftp\n" %\
3685
raise errors.BzrCommandError(msg)
3688
takes_args = ['testspecs*']
3689
takes_options = ['verbose',
3691
help='Stop when one test fails.',
3695
help='Use a different transport by default '
3696
'throughout the test suite.',
3697
type=get_transport_type),
3699
help='Run the benchmarks rather than selftests.',
3701
Option('lsprof-timed',
3702
help='Generate lsprof output for benchmarked'
3703
' sections of code.'),
3704
Option('lsprof-tests',
3705
help='Generate lsprof output for each test.'),
3707
help='Run all tests, but run specified tests first.',
3711
help='List the tests instead of running them.'),
3712
RegistryOption('parallel',
3713
help="Run the test suite in parallel.",
3714
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3715
value_switches=False,
3717
Option('randomize', type=str, argname="SEED",
3718
help='Randomize the order of tests using the given'
3719
' seed or "now" for the current time.'),
3720
ListOption('exclude', type=str, argname="PATTERN",
3722
help='Exclude tests that match this regular'
3725
help='Output test progress via subunit.'),
3726
Option('strict', help='Fail on missing dependencies or '
3728
Option('load-list', type=str, argname='TESTLISTFILE',
3729
help='Load a test id list from a text file.'),
3730
ListOption('debugflag', type=str, short_name='E',
3731
help='Turn on a selftest debug flag.'),
3732
ListOption('starting-with', type=str, argname='TESTID',
3733
param_name='starting_with', short_name='s',
3735
'Load only the tests starting with TESTID.'),
3737
encoding_type = 'replace'
3740
Command.__init__(self)
3741
self.additional_selftest_args = {}
3743
def run(self, testspecs_list=None, verbose=False, one=False,
3744
transport=None, benchmark=None,
3746
first=False, list_only=False,
3747
randomize=None, exclude=None, strict=False,
3748
load_list=None, debugflag=None, starting_with=None, subunit=False,
3749
parallel=None, lsprof_tests=False):
3750
from bzrlib import tests
3752
if testspecs_list is not None:
3753
pattern = '|'.join(testspecs_list)
3758
from bzrlib.tests import SubUnitBzrRunner
3760
raise errors.BzrCommandError("subunit not available. subunit "
3761
"needs to be installed to use --subunit.")
3762
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3763
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3764
# stdout, which would corrupt the subunit stream.
3765
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3766
# following code can be deleted when it's sufficiently deployed
3767
# -- vila/mgz 20100514
3768
if (sys.platform == "win32"
3769
and getattr(sys.stdout, 'fileno', None) is not None):
3771
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3773
self.additional_selftest_args.setdefault(
3774
'suite_decorators', []).append(parallel)
3776
raise errors.BzrCommandError(
3777
"--benchmark is no longer supported from bzr 2.2; "
3778
"use bzr-usertest instead")
3779
test_suite_factory = None
3781
exclude_pattern = None
3783
exclude_pattern = '(' + '|'.join(exclude) + ')'
3784
selftest_kwargs = {"verbose": verbose,
3786
"stop_on_failure": one,
3787
"transport": transport,
3788
"test_suite_factory": test_suite_factory,
3789
"lsprof_timed": lsprof_timed,
3790
"lsprof_tests": lsprof_tests,
3791
"matching_tests_first": first,
3792
"list_only": list_only,
3793
"random_seed": randomize,
3794
"exclude_pattern": exclude_pattern,
3796
"load_list": load_list,
3797
"debug_flags": debugflag,
3798
"starting_with": starting_with
3800
selftest_kwargs.update(self.additional_selftest_args)
3802
# Make deprecation warnings visible, unless -Werror is set
3803
cleanup = symbol_versioning.activate_deprecation_warnings(
3806
result = tests.selftest(**selftest_kwargs)
3809
return int(not result)
3812
class cmd_version(Command):
3813
__doc__ = """Show version of bzr."""
3815
encoding_type = 'replace'
3817
Option("short", help="Print just the version number."),
3821
def run(self, short=False):
3822
from bzrlib.version import show_version
3824
self.outf.write(bzrlib.version_string + '\n')
3826
show_version(to_file=self.outf)
3829
class cmd_rocks(Command):
3830
__doc__ = """Statement of optimism."""
3836
self.outf.write("It sure does!\n")
3839
class cmd_find_merge_base(Command):
3840
__doc__ = """Find and print a base revision for merging two branches."""
3841
# TODO: Options to specify revisions on either side, as if
3842
# merging only part of the history.
3843
takes_args = ['branch', 'other']
3847
def run(self, branch, other):
3848
from bzrlib.revision import ensure_null
3850
branch1 = Branch.open_containing(branch)[0]
3851
branch2 = Branch.open_containing(other)[0]
3852
self.add_cleanup(branch1.lock_read().unlock)
3853
self.add_cleanup(branch2.lock_read().unlock)
3854
last1 = ensure_null(branch1.last_revision())
3855
last2 = ensure_null(branch2.last_revision())
3857
graph = branch1.repository.get_graph(branch2.repository)
3858
base_rev_id = graph.find_unique_lca(last1, last2)
3860
self.outf.write('merge base is revision %s\n' % base_rev_id)
3863
class cmd_merge(Command):
3864
__doc__ = """Perform a three-way merge.
3866
The source of the merge can be specified either in the form of a branch,
3867
or in the form of a path to a file containing a merge directive generated
3868
with bzr send. If neither is specified, the default is the upstream branch
3869
or the branch most recently merged using --remember. The source of the
3870
merge may also be specified in the form of a path to a file in another
3871
branch: in this case, only the modifications to that file are merged into
3872
the current working tree.
3874
When merging from a branch, by default bzr will try to merge in all new
3875
work from the other branch, automatically determining an appropriate base
3876
revision. If this fails, you may need to give an explicit base.
3878
To pick a different ending revision, pass "--revision OTHER". bzr will
3879
try to merge in all new work up to and including revision OTHER.
3881
If you specify two values, "--revision BASE..OTHER", only revisions BASE
3882
through OTHER, excluding BASE but including OTHER, will be merged. If this
3883
causes some revisions to be skipped, i.e. if the destination branch does
3884
not already contain revision BASE, such a merge is commonly referred to as
3885
a "cherrypick". Unlike a normal merge, Bazaar does not currently track
3886
cherrypicks. The changes look like a normal commit, and the history of the
3887
changes from the other branch is not stored in the commit.
3889
Revision numbers are always relative to the source branch.
3891
Merge will do its best to combine the changes in two branches, but there
3892
are some kinds of problems only a human can fix. When it encounters those,
3893
it will mark a conflict. A conflict means that you need to fix something,
3894
before you should commit.
3896
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3898
If there is no default branch set, the first merge will set it (use
3899
--no-remember to avoid settting it). After that, you can omit the branch
3900
to use the default. To change the default, use --remember. The value will
3901
only be saved if the remote location can be accessed.
3903
The results of the merge are placed into the destination working
3904
directory, where they can be reviewed (with bzr diff), tested, and then
3905
committed to record the result of the merge.
3907
merge refuses to run if there are any uncommitted changes, unless
3908
--force is given. If --force is given, then the changes from the source
3909
will be merged with the current working tree, including any uncommitted
3910
changes in the tree. The --force option can also be used to create a
3911
merge revision which has more than two parents.
3913
If one would like to merge changes from the working tree of the other
3914
branch without merging any committed revisions, the --uncommitted option
3917
To select only some changes to merge, use "merge -i", which will prompt
3918
you to apply each diff hunk and file change, similar to "shelve".
3921
To merge all new revisions from bzr.dev::
3923
bzr merge ../bzr.dev
3925
To merge changes up to and including revision 82 from bzr.dev::
3927
bzr merge -r 82 ../bzr.dev
3929
To merge the changes introduced by 82, without previous changes::
3931
bzr merge -r 81..82 ../bzr.dev
3933
To apply a merge directive contained in /tmp/merge::
3935
bzr merge /tmp/merge
3937
To create a merge revision with three parents from two branches
3938
feature1a and feature1b:
3940
bzr merge ../feature1a
3941
bzr merge ../feature1b --force
3942
bzr commit -m 'revision with three parents'
3945
encoding_type = 'exact'
3946
_see_also = ['update', 'remerge', 'status-flags', 'send']
3947
takes_args = ['location?']
3952
help='Merge even if the destination tree has uncommitted changes.'),
3956
Option('show-base', help="Show base revision text in "
3958
Option('uncommitted', help='Apply uncommitted changes'
3959
' from a working copy, instead of branch changes.'),
3960
Option('pull', help='If the destination is already'
3961
' completely merged into the source, pull from the'
3962
' source rather than merging. When this happens,'
3963
' you do not need to commit the result.'),
3964
custom_help('directory',
3965
help='Branch to merge into, '
3966
'rather than the one containing the working directory.'),
3967
Option('preview', help='Instead of merging, show a diff of the'
3969
Option('interactive', help='Select changes interactively.',
3973
def run(self, location=None, revision=None, force=False,
3974
merge_type=None, show_base=False, reprocess=None, remember=None,
3975
uncommitted=False, pull=False,
3980
if merge_type is None:
3981
merge_type = _mod_merge.Merge3Merger
3983
if directory is None: directory = u'.'
3984
possible_transports = []
3986
allow_pending = True
3987
verified = 'inapplicable'
3989
tree = WorkingTree.open_containing(directory)[0]
3990
if tree.branch.revno() == 0:
3991
raise errors.BzrCommandError('Merging into empty branches not currently supported, '
3992
'https://bugs.launchpad.net/bzr/+bug/308562')
3995
basis_tree = tree.revision_tree(tree.last_revision())
3996
except errors.NoSuchRevision:
3997
basis_tree = tree.basis_tree()
3999
# die as quickly as possible if there are uncommitted changes
4001
if tree.has_changes():
4002
raise errors.UncommittedChanges(tree)
4004
view_info = _get_view_info_for_change_reporter(tree)
4005
change_reporter = delta._ChangeReporter(
4006
unversioned_filter=tree.is_ignored, view_info=view_info)
4007
pb = ui.ui_factory.nested_progress_bar()
4008
self.add_cleanup(pb.finished)
4009
self.add_cleanup(tree.lock_write().unlock)
4010
if location is not None:
4012
mergeable = bundle.read_mergeable_from_url(location,
4013
possible_transports=possible_transports)
4014
except errors.NotABundle:
4018
raise errors.BzrCommandError('Cannot use --uncommitted'
4019
' with bundles or merge directives.')
4021
if revision is not None:
4022
raise errors.BzrCommandError(
4023
'Cannot use -r with merge directives or bundles')
4024
merger, verified = _mod_merge.Merger.from_mergeable(tree,
4027
if merger is None and uncommitted:
4028
if revision is not None and len(revision) > 0:
4029
raise errors.BzrCommandError('Cannot use --uncommitted and'
4030
' --revision at the same time.')
4031
merger = self.get_merger_from_uncommitted(tree, location, None)
4032
allow_pending = False
4035
merger, allow_pending = self._get_merger_from_branch(tree,
4036
location, revision, remember, possible_transports, None)
4038
merger.merge_type = merge_type
4039
merger.reprocess = reprocess
4040
merger.show_base = show_base
4041
self.sanity_check_merger(merger)
4042
if (merger.base_rev_id == merger.other_rev_id and
4043
merger.other_rev_id is not None):
4044
# check if location is a nonexistent file (and not a branch) to
4045
# disambiguate the 'Nothing to do'
4046
if merger.interesting_files:
4047
if not merger.other_tree.has_filename(
4048
merger.interesting_files[0]):
4049
note("merger: " + str(merger))
4050
raise errors.PathsDoNotExist([location])
4051
note('Nothing to do.')
4053
if pull and not preview:
4054
if merger.interesting_files is not None:
4055
raise errors.BzrCommandError('Cannot pull individual files')
4056
if (merger.base_rev_id == tree.last_revision()):
4057
result = tree.pull(merger.other_branch, False,
4058
merger.other_rev_id)
4059
result.report(self.outf)
4061
if merger.this_basis is None:
4062
raise errors.BzrCommandError(
4063
"This branch has no commits."
4064
" (perhaps you would prefer 'bzr pull')")
4066
return self._do_preview(merger)
4068
return self._do_interactive(merger)
4070
return self._do_merge(merger, change_reporter, allow_pending,
4073
def _get_preview(self, merger):
4074
tree_merger = merger.make_merger()
4075
tt = tree_merger.make_preview_transform()
4076
self.add_cleanup(tt.finalize)
4077
result_tree = tt.get_preview_tree()
4080
def _do_preview(self, merger):
4081
from bzrlib.diff import show_diff_trees
4082
result_tree = self._get_preview(merger)
4083
path_encoding = osutils.get_diff_header_encoding()
4084
show_diff_trees(merger.this_tree, result_tree, self.outf,
4085
old_label='', new_label='',
4086
path_encoding=path_encoding)
4088
def _do_merge(self, merger, change_reporter, allow_pending, verified):
4089
merger.change_reporter = change_reporter
4090
conflict_count = merger.do_merge()
4092
merger.set_pending()
4093
if verified == 'failed':
4094
warning('Preview patch does not match changes')
4095
if conflict_count != 0:
4100
def _do_interactive(self, merger):
4101
"""Perform an interactive merge.
4103
This works by generating a preview tree of the merge, then using
4104
Shelver to selectively remove the differences between the working tree
4105
and the preview tree.
4107
from bzrlib import shelf_ui
4108
result_tree = self._get_preview(merger)
4109
writer = bzrlib.option.diff_writer_registry.get()
4110
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4111
reporter=shelf_ui.ApplyReporter(),
4112
diff_writer=writer(sys.stdout))
4118
def sanity_check_merger(self, merger):
4119
if (merger.show_base and
4120
not merger.merge_type is _mod_merge.Merge3Merger):
4121
raise errors.BzrCommandError("Show-base is not supported for this"
4122
" merge type. %s" % merger.merge_type)
4123
if merger.reprocess is None:
4124
if merger.show_base:
4125
merger.reprocess = False
4127
# Use reprocess if the merger supports it
4128
merger.reprocess = merger.merge_type.supports_reprocess
4129
if merger.reprocess and not merger.merge_type.supports_reprocess:
4130
raise errors.BzrCommandError("Conflict reduction is not supported"
4131
" for merge type %s." %
4133
if merger.reprocess and merger.show_base:
4134
raise errors.BzrCommandError("Cannot do conflict reduction and"
4137
def _get_merger_from_branch(self, tree, location, revision, remember,
4138
possible_transports, pb):
4139
"""Produce a merger from a location, assuming it refers to a branch."""
4140
from bzrlib.tag import _merge_tags_if_possible
4141
# find the branch locations
4142
other_loc, user_location = self._select_branch_location(tree, location,
4144
if revision is not None and len(revision) == 2:
4145
base_loc, _unused = self._select_branch_location(tree,
4146
location, revision, 0)
4148
base_loc = other_loc
4150
other_branch, other_path = Branch.open_containing(other_loc,
4151
possible_transports)
4152
if base_loc == other_loc:
4153
base_branch = other_branch
4155
base_branch, base_path = Branch.open_containing(base_loc,
4156
possible_transports)
4157
# Find the revision ids
4158
other_revision_id = None
4159
base_revision_id = None
4160
if revision is not None:
4161
if len(revision) >= 1:
4162
other_revision_id = revision[-1].as_revision_id(other_branch)
4163
if len(revision) == 2:
4164
base_revision_id = revision[0].as_revision_id(base_branch)
4165
if other_revision_id is None:
4166
other_revision_id = _mod_revision.ensure_null(
4167
other_branch.last_revision())
4168
# Remember where we merge from. We need to remember if:
4169
# - user specify a location (and we don't merge from the parent
4171
# - user ask to remember or there is no previous location set to merge
4172
# from and user didn't ask to *not* remember
4173
if (user_location is not None
4175
or (remember is None
4176
and tree.branch.get_submit_branch() is None)))):
4177
tree.branch.set_submit_branch(other_branch.base)
4178
# Merge tags (but don't set them in the master branch yet, the user
4179
# might revert this merge). Commit will propagate them.
4180
_merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
4181
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4182
other_revision_id, base_revision_id, other_branch, base_branch)
4183
if other_path != '':
4184
allow_pending = False
4185
merger.interesting_files = [other_path]
4187
allow_pending = True
4188
return merger, allow_pending
4190
def get_merger_from_uncommitted(self, tree, location, pb):
4191
"""Get a merger for uncommitted changes.
4193
:param tree: The tree the merger should apply to.
4194
:param location: The location containing uncommitted changes.
4195
:param pb: The progress bar to use for showing progress.
4197
location = self._select_branch_location(tree, location)[0]
4198
other_tree, other_path = WorkingTree.open_containing(location)
4199
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4200
if other_path != '':
4201
merger.interesting_files = [other_path]
4204
def _select_branch_location(self, tree, user_location, revision=None,
4206
"""Select a branch location, according to possible inputs.
4208
If provided, branches from ``revision`` are preferred. (Both
4209
``revision`` and ``index`` must be supplied.)
4211
Otherwise, the ``location`` parameter is used. If it is None, then the
4212
``submit`` or ``parent`` location is used, and a note is printed.
4214
:param tree: The working tree to select a branch for merging into
4215
:param location: The location entered by the user
4216
:param revision: The revision parameter to the command
4217
:param index: The index to use for the revision parameter. Negative
4218
indices are permitted.
4219
:return: (selected_location, user_location). The default location
4220
will be the user-entered location.
4222
if (revision is not None and index is not None
4223
and revision[index] is not None):
4224
branch = revision[index].get_branch()
4225
if branch is not None:
4226
return branch, branch
4227
if user_location is None:
4228
location = self._get_remembered(tree, 'Merging from')
4230
location = user_location
4231
return location, user_location
4233
def _get_remembered(self, tree, verb_string):
4234
"""Use tree.branch's parent if none was supplied.
4236
Report if the remembered location was used.
4238
stored_location = tree.branch.get_submit_branch()
4239
stored_location_type = "submit"
4240
if stored_location is None:
4241
stored_location = tree.branch.get_parent()
4242
stored_location_type = "parent"
4243
mutter("%s", stored_location)
4244
if stored_location is None:
4245
raise errors.BzrCommandError("No location specified or remembered")
4246
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4247
note(u"%s remembered %s location %s", verb_string,
4248
stored_location_type, display_url)
4249
return stored_location
4252
class cmd_remerge(Command):
4253
__doc__ = """Redo a merge.
4255
Use this if you want to try a different merge technique while resolving
4256
conflicts. Some merge techniques are better than others, and remerge
4257
lets you try different ones on different files.
4259
The options for remerge have the same meaning and defaults as the ones for
4260
merge. The difference is that remerge can (only) be run when there is a
4261
pending merge, and it lets you specify particular files.
4264
Re-do the merge of all conflicted files, and show the base text in
4265
conflict regions, in addition to the usual THIS and OTHER texts::
4267
bzr remerge --show-base
4269
Re-do the merge of "foobar", using the weave merge algorithm, with
4270
additional processing to reduce the size of conflict regions::
4272
bzr remerge --merge-type weave --reprocess foobar
4274
takes_args = ['file*']
4279
help="Show base revision text in conflicts."),
4282
def run(self, file_list=None, merge_type=None, show_base=False,
4284
from bzrlib.conflicts import restore
4285
if merge_type is None:
4286
merge_type = _mod_merge.Merge3Merger
4287
tree, file_list = WorkingTree.open_containing_paths(file_list)
4288
self.add_cleanup(tree.lock_write().unlock)
4289
parents = tree.get_parent_ids()
4290
if len(parents) != 2:
4291
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4292
" merges. Not cherrypicking or"
4294
repository = tree.branch.repository
4295
interesting_ids = None
4297
conflicts = tree.conflicts()
4298
if file_list is not None:
4299
interesting_ids = set()
4300
for filename in file_list:
4301
file_id = tree.path2id(filename)
4303
raise errors.NotVersionedError(filename)
4304
interesting_ids.add(file_id)
4305
if tree.kind(file_id) != "directory":
4308
for name, ie in tree.inventory.iter_entries(file_id):
4309
interesting_ids.add(ie.file_id)
4310
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4312
# Remerge only supports resolving contents conflicts
4313
allowed_conflicts = ('text conflict', 'contents conflict')
4314
restore_files = [c.path for c in conflicts
4315
if c.typestring in allowed_conflicts]
4316
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4317
tree.set_conflicts(ConflictList(new_conflicts))
4318
if file_list is not None:
4319
restore_files = file_list
4320
for filename in restore_files:
4322
restore(tree.abspath(filename))
4323
except errors.NotConflicted:
4325
# Disable pending merges, because the file texts we are remerging
4326
# have not had those merges performed. If we use the wrong parents
4327
# list, we imply that the working tree text has seen and rejected
4328
# all the changes from the other tree, when in fact those changes
4329
# have not yet been seen.
4330
tree.set_parent_ids(parents[:1])
4332
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4333
merger.interesting_ids = interesting_ids
4334
merger.merge_type = merge_type
4335
merger.show_base = show_base
4336
merger.reprocess = reprocess
4337
conflicts = merger.do_merge()
4339
tree.set_parent_ids(parents)
4346
class cmd_revert(Command):
4347
__doc__ = """Revert files to a previous revision.
4349
Giving a list of files will revert only those files. Otherwise, all files
4350
will be reverted. If the revision is not specified with '--revision', the
4351
last committed revision is used.
4353
To remove only some changes, without reverting to a prior version, use
4354
merge instead. For example, "merge . -r -2..-3" (don't forget the ".")
4355
will remove the changes introduced by the second last commit (-2), without
4356
affecting the changes introduced by the last commit (-1). To remove
4357
certain changes on a hunk-by-hunk basis, see the shelve command.
4359
By default, any files that have been manually changed will be backed up
4360
first. (Files changed only by merge are not backed up.) Backup files have
4361
'.~#~' appended to their name, where # is a number.
4363
When you provide files, you can use their current pathname or the pathname
4364
from the target revision. So you can use revert to "undelete" a file by
4365
name. If you name a directory, all the contents of that directory will be
4368
If you have newly added files since the target revision, they will be
4369
removed. If the files to be removed have been changed, backups will be
4370
created as above. Directories containing unknown files will not be
4373
The working tree contains a list of revisions that have been merged but
4374
not yet committed. These revisions will be included as additional parents
4375
of the next commit. Normally, using revert clears that list as well as
4376
reverting the files. If any files are specified, revert leaves the list
4377
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4378
.`` in the tree root to revert all files but keep the recorded merges,
4379
and ``bzr revert --forget-merges`` to clear the pending merge list without
4380
reverting any files.
4382
Using "bzr revert --forget-merges", it is possible to apply all of the
4383
changes from a branch in a single revision. To do this, perform the merge
4384
as desired. Then doing revert with the "--forget-merges" option will keep
4385
the content of the tree as it was, but it will clear the list of pending
4386
merges. The next commit will then contain all of the changes that are
4387
present in the other branch, but without any other parent revisions.
4388
Because this technique forgets where these changes originated, it may
4389
cause additional conflicts on later merges involving the same source and
4393
_see_also = ['cat', 'export', 'merge', 'shelve']
4396
Option('no-backup', "Do not save backups of reverted files."),
4397
Option('forget-merges',
4398
'Remove pending merge marker, without changing any files.'),
4400
takes_args = ['file*']
4402
def run(self, revision=None, no_backup=False, file_list=None,
4403
forget_merges=None):
4404
tree, file_list = WorkingTree.open_containing_paths(file_list)
4405
self.add_cleanup(tree.lock_tree_write().unlock)
4407
tree.set_parent_ids(tree.get_parent_ids()[:1])
4409
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4412
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4413
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4414
tree.revert(file_list, rev_tree, not no_backup, None,
4415
report_changes=True)
4418
class cmd_assert_fail(Command):
4419
__doc__ = """Test reporting of assertion failures"""
4420
# intended just for use in testing
4425
raise AssertionError("always fails")
4428
class cmd_help(Command):
4429
__doc__ = """Show help on a command or other topic.
4432
_see_also = ['topics']
4434
Option('long', 'Show help on all commands.'),
4436
takes_args = ['topic?']
4437
aliases = ['?', '--help', '-?', '-h']
4440
def run(self, topic=None, long=False):
4442
if topic is None and long:
4444
bzrlib.help.help(topic)
4447
class cmd_shell_complete(Command):
4448
__doc__ = """Show appropriate completions for context.
4450
For a list of all available commands, say 'bzr shell-complete'.
4452
takes_args = ['context?']
4457
def run(self, context=None):
4458
import shellcomplete
4459
shellcomplete.shellcomplete(context)
4462
class cmd_missing(Command):
4463
__doc__ = """Show unmerged/unpulled revisions between two branches.
4465
OTHER_BRANCH may be local or remote.
4467
To filter on a range of revisions, you can use the command -r begin..end
4468
-r revision requests a specific revision, -r ..end or -r begin.. are
4472
1 - some missing revisions
4473
0 - no missing revisions
4477
Determine the missing revisions between this and the branch at the
4478
remembered pull location::
4482
Determine the missing revisions between this and another branch::
4484
bzr missing http://server/branch
4486
Determine the missing revisions up to a specific revision on the other
4489
bzr missing -r ..-10
4491
Determine the missing revisions up to a specific revision on this
4494
bzr missing --my-revision ..-10
4497
_see_also = ['merge', 'pull']
4498
takes_args = ['other_branch?']
4501
Option('reverse', 'Reverse the order of revisions.'),
4503
'Display changes in the local branch only.'),
4504
Option('this' , 'Same as --mine-only.'),
4505
Option('theirs-only',
4506
'Display changes in the remote branch only.'),
4507
Option('other', 'Same as --theirs-only.'),
4511
custom_help('revision',
4512
help='Filter on other branch revisions (inclusive). '
4513
'See "help revisionspec" for details.'),
4514
Option('my-revision',
4515
type=_parse_revision_str,
4516
help='Filter on local branch revisions (inclusive). '
4517
'See "help revisionspec" for details.'),
4518
Option('include-merges',
4519
'Show all revisions in addition to the mainline ones.'),
4521
encoding_type = 'replace'
4524
def run(self, other_branch=None, reverse=False, mine_only=False,
4526
log_format=None, long=False, short=False, line=False,
4527
show_ids=False, verbose=False, this=False, other=False,
4528
include_merges=False, revision=None, my_revision=None,
4530
from bzrlib.missing import find_unmerged, iter_log_revisions
4539
# TODO: We should probably check that we don't have mine-only and
4540
# theirs-only set, but it gets complicated because we also have
4541
# this and other which could be used.
4548
local_branch = Branch.open_containing(directory)[0]
4549
self.add_cleanup(local_branch.lock_read().unlock)
4551
parent = local_branch.get_parent()
4552
if other_branch is None:
4553
other_branch = parent
4554
if other_branch is None:
4555
raise errors.BzrCommandError("No peer location known"
4557
display_url = urlutils.unescape_for_display(parent,
4559
message("Using saved parent location: "
4560
+ display_url + "\n")
4562
remote_branch = Branch.open(other_branch)
4563
if remote_branch.base == local_branch.base:
4564
remote_branch = local_branch
4566
self.add_cleanup(remote_branch.lock_read().unlock)
4568
local_revid_range = _revision_range_to_revid_range(
4569
_get_revision_range(my_revision, local_branch,
4572
remote_revid_range = _revision_range_to_revid_range(
4573
_get_revision_range(revision,
4574
remote_branch, self.name()))
4576
local_extra, remote_extra = find_unmerged(
4577
local_branch, remote_branch, restrict,
4578
backward=not reverse,
4579
include_merges=include_merges,
4580
local_revid_range=local_revid_range,
4581
remote_revid_range=remote_revid_range)
4583
if log_format is None:
4584
registry = log.log_formatter_registry
4585
log_format = registry.get_default(local_branch)
4586
lf = log_format(to_file=self.outf,
4588
show_timezone='original')
4591
if local_extra and not theirs_only:
4592
message("You have %d extra revision(s):\n" %
4594
for revision in iter_log_revisions(local_extra,
4595
local_branch.repository,
4597
lf.log_revision(revision)
4598
printed_local = True
4601
printed_local = False
4603
if remote_extra and not mine_only:
4604
if printed_local is True:
4606
message("You are missing %d revision(s):\n" %
4608
for revision in iter_log_revisions(remote_extra,
4609
remote_branch.repository,
4611
lf.log_revision(revision)
4614
if mine_only and not local_extra:
4615
# We checked local, and found nothing extra
4616
message('This branch is up to date.\n')
4617
elif theirs_only and not remote_extra:
4618
# We checked remote, and found nothing extra
4619
message('Other branch is up to date.\n')
4620
elif not (mine_only or theirs_only or local_extra or
4622
# We checked both branches, and neither one had extra
4624
message("Branches are up to date.\n")
4626
if not status_code and parent is None and other_branch is not None:
4627
self.add_cleanup(local_branch.lock_write().unlock)
4628
# handle race conditions - a parent might be set while we run.
4629
if local_branch.get_parent() is None:
4630
local_branch.set_parent(remote_branch.base)
4634
class cmd_pack(Command):
4635
__doc__ = """Compress the data within a repository.
4637
This operation compresses the data within a bazaar repository. As
4638
bazaar supports automatic packing of repository, this operation is
4639
normally not required to be done manually.
4641
During the pack operation, bazaar takes a backup of existing repository
4642
data, i.e. pack files. This backup is eventually removed by bazaar
4643
automatically when it is safe to do so. To save disk space by removing
4644
the backed up pack files, the --clean-obsolete-packs option may be
4647
Warning: If you use --clean-obsolete-packs and your machine crashes
4648
during or immediately after repacking, you may be left with a state
4649
where the deletion has been written to disk but the new packs have not
4650
been. In this case the repository may be unusable.
4653
_see_also = ['repositories']
4654
takes_args = ['branch_or_repo?']
4656
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4659
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4660
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4662
branch = dir.open_branch()
4663
repository = branch.repository
4664
except errors.NotBranchError:
4665
repository = dir.open_repository()
4666
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4669
class cmd_plugins(Command):
4670
__doc__ = """List the installed plugins.
4672
This command displays the list of installed plugins including
4673
version of plugin and a short description of each.
4675
--verbose shows the path where each plugin is located.
4677
A plugin is an external component for Bazaar that extends the
4678
revision control system, by adding or replacing code in Bazaar.
4679
Plugins can do a variety of things, including overriding commands,
4680
adding new commands, providing additional network transports and
4681
customizing log output.
4683
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4684
for further information on plugins including where to find them and how to
4685
install them. Instructions are also provided there on how to write new
4686
plugins using the Python programming language.
4688
takes_options = ['verbose']
4691
def run(self, verbose=False):
4692
from bzrlib import plugin
4693
# Don't give writelines a generator as some codecs don't like that
4694
self.outf.writelines(
4695
list(plugin.describe_plugins(show_paths=verbose)))
4698
class cmd_testament(Command):
4699
__doc__ = """Show testament (signing-form) of a revision."""
4702
Option('long', help='Produce long-format testament.'),
4704
help='Produce a strict-format testament.')]
4705
takes_args = ['branch?']
4707
def run(self, branch=u'.', revision=None, long=False, strict=False):
4708
from bzrlib.testament import Testament, StrictTestament
4710
testament_class = StrictTestament
4712
testament_class = Testament
4714
b = Branch.open_containing(branch)[0]
4716
b = Branch.open(branch)
4717
self.add_cleanup(b.lock_read().unlock)
4718
if revision is None:
4719
rev_id = b.last_revision()
4721
rev_id = revision[0].as_revision_id(b)
4722
t = testament_class.from_revision(b.repository, rev_id)
4724
sys.stdout.writelines(t.as_text_lines())
4726
sys.stdout.write(t.as_short_text())
4729
class cmd_annotate(Command):
4730
__doc__ = """Show the origin of each line in a file.
4732
This prints out the given file with an annotation on the left side
4733
indicating which revision, author and date introduced the change.
4735
If the origin is the same for a run of consecutive lines, it is
4736
shown only at the top, unless the --all option is given.
4738
# TODO: annotate directories; showing when each file was last changed
4739
# TODO: if the working copy is modified, show annotations on that
4740
# with new uncommitted lines marked
4741
aliases = ['ann', 'blame', 'praise']
4742
takes_args = ['filename']
4743
takes_options = [Option('all', help='Show annotations on all lines.'),
4744
Option('long', help='Show commit date in annotations.'),
4749
encoding_type = 'exact'
4752
def run(self, filename, all=False, long=False, revision=None,
4753
show_ids=False, directory=None):
4754
from bzrlib.annotate import (
4757
wt, branch, relpath = \
4758
_open_directory_or_containing_tree_or_branch(filename, directory)
4760
self.add_cleanup(wt.lock_read().unlock)
4762
self.add_cleanup(branch.lock_read().unlock)
4763
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4764
self.add_cleanup(tree.lock_read().unlock)
4765
if wt is not None and revision is None:
4766
file_id = wt.path2id(relpath)
4768
file_id = tree.path2id(relpath)
4770
raise errors.NotVersionedError(filename)
4771
if wt is not None and revision is None:
4772
# If there is a tree and we're not annotating historical
4773
# versions, annotate the working tree's content.
4774
annotate_file_tree(wt, file_id, self.outf, long, all,
4777
annotate_file_tree(tree, file_id, self.outf, long, all,
4778
show_ids=show_ids, branch=branch)
4781
class cmd_re_sign(Command):
4782
__doc__ = """Create a digital signature for an existing revision."""
4783
# TODO be able to replace existing ones.
4785
hidden = True # is this right ?
4786
takes_args = ['revision_id*']
4787
takes_options = ['directory', 'revision']
4789
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4790
if revision_id_list is not None and revision is not None:
4791
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4792
if revision_id_list is None and revision is None:
4793
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4794
b = WorkingTree.open_containing(directory)[0].branch
4795
self.add_cleanup(b.lock_write().unlock)
4796
return self._run(b, revision_id_list, revision)
4798
def _run(self, b, revision_id_list, revision):
4799
import bzrlib.gpg as gpg
4800
gpg_strategy = gpg.GPGStrategy(b.get_config())
4801
if revision_id_list is not None:
4802
b.repository.start_write_group()
4804
for revision_id in revision_id_list:
4805
b.repository.sign_revision(revision_id, gpg_strategy)
4807
b.repository.abort_write_group()
4810
b.repository.commit_write_group()
4811
elif revision is not None:
4812
if len(revision) == 1:
4813
revno, rev_id = revision[0].in_history(b)
4814
b.repository.start_write_group()
4816
b.repository.sign_revision(rev_id, gpg_strategy)
4818
b.repository.abort_write_group()
4821
b.repository.commit_write_group()
4822
elif len(revision) == 2:
4823
# are they both on rh- if so we can walk between them
4824
# might be nice to have a range helper for arbitrary
4825
# revision paths. hmm.
4826
from_revno, from_revid = revision[0].in_history(b)
4827
to_revno, to_revid = revision[1].in_history(b)
4828
if to_revid is None:
4829
to_revno = b.revno()
4830
if from_revno is None or to_revno is None:
4831
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4832
b.repository.start_write_group()
4834
for revno in range(from_revno, to_revno + 1):
4835
b.repository.sign_revision(b.get_rev_id(revno),
4838
b.repository.abort_write_group()
4841
b.repository.commit_write_group()
4843
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4846
class cmd_bind(Command):
4847
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4848
If no branch is supplied, rebind to the last bound location.
4850
Once converted into a checkout, commits must succeed on the master branch
4851
before they will be applied to the local branch.
4853
Bound branches use the nickname of its master branch unless it is set
4854
locally, in which case binding will update the local nickname to be
4858
_see_also = ['checkouts', 'unbind']
4859
takes_args = ['location?']
4860
takes_options = ['directory']
4862
def run(self, location=None, directory=u'.'):
4863
b, relpath = Branch.open_containing(directory)
4864
if location is None:
4866
location = b.get_old_bound_location()
4867
except errors.UpgradeRequired:
4868
raise errors.BzrCommandError('No location supplied. '
4869
'This format does not remember old locations.')
4871
if location is None:
4872
if b.get_bound_location() is not None:
4873
raise errors.BzrCommandError('Branch is already bound')
4875
raise errors.BzrCommandError('No location supplied '
4876
'and no previous location known')
4877
b_other = Branch.open(location)
4880
except errors.DivergedBranches:
4881
raise errors.BzrCommandError('These branches have diverged.'
4882
' Try merging, and then bind again.')
4883
if b.get_config().has_explicit_nickname():
4884
b.nick = b_other.nick
4887
class cmd_unbind(Command):
4888
__doc__ = """Convert the current checkout into a regular branch.
4890
After unbinding, the local branch is considered independent and subsequent
4891
commits will be local only.
4894
_see_also = ['checkouts', 'bind']
4896
takes_options = ['directory']
4898
def run(self, directory=u'.'):
4899
b, relpath = Branch.open_containing(directory)
4901
raise errors.BzrCommandError('Local branch is not bound')
4904
class cmd_uncommit(Command):
4905
__doc__ = """Remove the last committed revision.
4907
--verbose will print out what is being removed.
4908
--dry-run will go through all the motions, but not actually
4911
If --revision is specified, uncommit revisions to leave the branch at the
4912
specified revision. For example, "bzr uncommit -r 15" will leave the
4913
branch at revision 15.
4915
Uncommit leaves the working tree ready for a new commit. The only change
4916
it may make is to restore any pending merges that were present before
4920
# TODO: jam 20060108 Add an option to allow uncommit to remove
4921
# unreferenced information in 'branch-as-repository' branches.
4922
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4923
# information in shared branches as well.
4924
_see_also = ['commit']
4925
takes_options = ['verbose', 'revision',
4926
Option('dry-run', help='Don\'t actually make changes.'),
4927
Option('force', help='Say yes to all questions.'),
4929
help="Only remove the commits from the local branch"
4930
" when in a checkout."
4933
takes_args = ['location?']
4935
encoding_type = 'replace'
4937
def run(self, location=None,
4938
dry_run=False, verbose=False,
4939
revision=None, force=False, local=False):
4940
if location is None:
4942
control, relpath = bzrdir.BzrDir.open_containing(location)
4944
tree = control.open_workingtree()
4946
except (errors.NoWorkingTree, errors.NotLocalUrl):
4948
b = control.open_branch()
4950
if tree is not None:
4951
self.add_cleanup(tree.lock_write().unlock)
4953
self.add_cleanup(b.lock_write().unlock)
4954
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4956
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4957
from bzrlib.log import log_formatter, show_log
4958
from bzrlib.uncommit import uncommit
4960
last_revno, last_rev_id = b.last_revision_info()
4963
if revision is None:
4965
rev_id = last_rev_id
4967
# 'bzr uncommit -r 10' actually means uncommit
4968
# so that the final tree is at revno 10.
4969
# but bzrlib.uncommit.uncommit() actually uncommits
4970
# the revisions that are supplied.
4971
# So we need to offset it by one
4972
revno = revision[0].in_history(b).revno + 1
4973
if revno <= last_revno:
4974
rev_id = b.get_rev_id(revno)
4976
if rev_id is None or _mod_revision.is_null(rev_id):
4977
self.outf.write('No revisions to uncommit.\n')
4980
lf = log_formatter('short',
4982
show_timezone='original')
4987
direction='forward',
4988
start_revision=revno,
4989
end_revision=last_revno)
4992
self.outf.write('Dry-run, pretending to remove'
4993
' the above revisions.\n')
4995
self.outf.write('The above revision(s) will be removed.\n')
4998
if not ui.ui_factory.confirm_action(
4999
u'Uncommit these revisions',
5000
'bzrlib.builtins.uncommit',
5002
self.outf.write('Canceled\n')
5005
mutter('Uncommitting from {%s} to {%s}',
5006
last_rev_id, rev_id)
5007
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5008
revno=revno, local=local)
5009
self.outf.write('You can restore the old tip by running:\n'
5010
' bzr pull . -r revid:%s\n' % last_rev_id)
5013
class cmd_break_lock(Command):
5014
__doc__ = """Break a dead lock.
5016
This command breaks a lock on a repository, branch, working directory or
5019
CAUTION: Locks should only be broken when you are sure that the process
5020
holding the lock has been stopped.
5022
You can get information on what locks are open via the 'bzr info
5023
[location]' command.
5027
bzr break-lock bzr+ssh://example.com/bzr/foo
5028
bzr break-lock --conf ~/.bazaar
5031
takes_args = ['location?']
5034
help='LOCATION is the directory where the config lock is.'),
5036
help='Do not ask for confirmation before breaking the lock.'),
5039
def run(self, location=None, config=False, force=False):
5040
if location is None:
5043
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5045
{'bzrlib.lockdir.break': True})
5047
conf = _mod_config.LockableConfig(file_name=location)
5050
control, relpath = bzrdir.BzrDir.open_containing(location)
5052
control.break_lock()
5053
except NotImplementedError:
5057
class cmd_wait_until_signalled(Command):
5058
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5060
This just prints a line to signal when it is ready, then blocks on stdin.
5066
sys.stdout.write("running\n")
5068
sys.stdin.readline()
5071
class cmd_serve(Command):
5072
__doc__ = """Run the bzr server."""
5074
aliases = ['server']
5078
help='Serve on stdin/out for use from inetd or sshd.'),
5079
RegistryOption('protocol',
5080
help="Protocol to serve.",
5081
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5082
value_switches=True),
5084
help='Listen for connections on nominated port of the form '
5085
'[hostname:]portnumber. Passing 0 as the port number will '
5086
'result in a dynamically allocated port. The default port '
5087
'depends on the protocol.',
5089
custom_help('directory',
5090
help='Serve contents of this directory.'),
5091
Option('allow-writes',
5092
help='By default the server is a readonly server. Supplying '
5093
'--allow-writes enables write access to the contents of '
5094
'the served directory and below. Note that ``bzr serve`` '
5095
'does not perform authentication, so unless some form of '
5096
'external authentication is arranged supplying this '
5097
'option leads to global uncontrolled write access to your '
5102
def get_host_and_port(self, port):
5103
"""Return the host and port to run the smart server on.
5105
If 'port' is None, None will be returned for the host and port.
5107
If 'port' has a colon in it, the string before the colon will be
5108
interpreted as the host.
5110
:param port: A string of the port to run the server on.
5111
:return: A tuple of (host, port), where 'host' is a host name or IP,
5112
and port is an integer TCP/IP port.
5115
if port is not None:
5117
host, port = port.split(':')
5121
def run(self, port=None, inet=False, directory=None, allow_writes=False,
5123
from bzrlib import transport
5124
if directory is None:
5125
directory = os.getcwd()
5126
if protocol is None:
5127
protocol = transport.transport_server_registry.get()
5128
host, port = self.get_host_and_port(port)
5129
url = urlutils.local_path_to_url(directory)
5130
if not allow_writes:
5131
url = 'readonly+' + url
5132
t = transport.get_transport(url)
5133
protocol(t, host, port, inet)
5136
class cmd_join(Command):
5137
__doc__ = """Combine a tree into its containing tree.
5139
This command requires the target tree to be in a rich-root format.
5141
The TREE argument should be an independent tree, inside another tree, but
5142
not part of it. (Such trees can be produced by "bzr split", but also by
5143
running "bzr branch" with the target inside a tree.)
5145
The result is a combined tree, with the subtree no longer an independent
5146
part. This is marked as a merge of the subtree into the containing tree,
5147
and all history is preserved.
5150
_see_also = ['split']
5151
takes_args = ['tree']
5153
Option('reference', help='Join by reference.', hidden=True),
5156
def run(self, tree, reference=False):
5157
sub_tree = WorkingTree.open(tree)
5158
parent_dir = osutils.dirname(sub_tree.basedir)
5159
containing_tree = WorkingTree.open_containing(parent_dir)[0]
5160
repo = containing_tree.branch.repository
5161
if not repo.supports_rich_root():
5162
raise errors.BzrCommandError(
5163
"Can't join trees because %s doesn't support rich root data.\n"
5164
"You can use bzr upgrade on the repository."
5168
containing_tree.add_reference(sub_tree)
5169
except errors.BadReferenceTarget, e:
5170
# XXX: Would be better to just raise a nicely printable
5171
# exception from the real origin. Also below. mbp 20070306
5172
raise errors.BzrCommandError("Cannot join %s. %s" %
5176
containing_tree.subsume(sub_tree)
5177
except errors.BadSubsumeSource, e:
5178
raise errors.BzrCommandError("Cannot join %s. %s" %
5182
class cmd_split(Command):
5183
__doc__ = """Split a subdirectory of a tree into a separate tree.
5185
This command will produce a target tree in a format that supports
5186
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5187
converted into earlier formats like 'dirstate-tags'.
5189
The TREE argument should be a subdirectory of a working tree. That
5190
subdirectory will be converted into an independent tree, with its own
5191
branch. Commits in the top-level tree will not apply to the new subtree.
5194
_see_also = ['join']
5195
takes_args = ['tree']
5197
def run(self, tree):
5198
containing_tree, subdir = WorkingTree.open_containing(tree)
5199
sub_id = containing_tree.path2id(subdir)
5201
raise errors.NotVersionedError(subdir)
5203
containing_tree.extract(sub_id)
5204
except errors.RootNotRich:
5205
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5208
class cmd_merge_directive(Command):
5209
__doc__ = """Generate a merge directive for auto-merge tools.
5211
A directive requests a merge to be performed, and also provides all the
5212
information necessary to do so. This means it must either include a
5213
revision bundle, or the location of a branch containing the desired
5216
A submit branch (the location to merge into) must be supplied the first
5217
time the command is issued. After it has been supplied once, it will
5218
be remembered as the default.
5220
A public branch is optional if a revision bundle is supplied, but required
5221
if --diff or --plain is specified. It will be remembered as the default
5222
after the first use.
5225
takes_args = ['submit_branch?', 'public_branch?']
5229
_see_also = ['send']
5233
RegistryOption.from_kwargs('patch-type',
5234
'The type of patch to include in the directive.',
5236
value_switches=True,
5238
bundle='Bazaar revision bundle (default).',
5239
diff='Normal unified diff.',
5240
plain='No patch, just directive.'),
5241
Option('sign', help='GPG-sign the directive.'), 'revision',
5242
Option('mail-to', type=str,
5243
help='Instead of printing the directive, email to this address.'),
5244
Option('message', type=str, short_name='m',
5245
help='Message to use when committing this merge.')
5248
encoding_type = 'exact'
5250
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5251
sign=False, revision=None, mail_to=None, message=None,
5253
from bzrlib.revision import ensure_null, NULL_REVISION
5254
include_patch, include_bundle = {
5255
'plain': (False, False),
5256
'diff': (True, False),
5257
'bundle': (True, True),
5259
branch = Branch.open(directory)
5260
stored_submit_branch = branch.get_submit_branch()
5261
if submit_branch is None:
5262
submit_branch = stored_submit_branch
5264
if stored_submit_branch is None:
5265
branch.set_submit_branch(submit_branch)
5266
if submit_branch is None:
5267
submit_branch = branch.get_parent()
5268
if submit_branch is None:
5269
raise errors.BzrCommandError('No submit branch specified or known')
5271
stored_public_branch = branch.get_public_branch()
5272
if public_branch is None:
5273
public_branch = stored_public_branch
5274
elif stored_public_branch is None:
5275
branch.set_public_branch(public_branch)
5276
if not include_bundle and public_branch is None:
5277
raise errors.BzrCommandError('No public branch specified or'
5279
base_revision_id = None
5280
if revision is not None:
5281
if len(revision) > 2:
5282
raise errors.BzrCommandError('bzr merge-directive takes '
5283
'at most two one revision identifiers')
5284
revision_id = revision[-1].as_revision_id(branch)
5285
if len(revision) == 2:
5286
base_revision_id = revision[0].as_revision_id(branch)
5288
revision_id = branch.last_revision()
5289
revision_id = ensure_null(revision_id)
5290
if revision_id == NULL_REVISION:
5291
raise errors.BzrCommandError('No revisions to bundle.')
5292
directive = merge_directive.MergeDirective2.from_objects(
5293
branch.repository, revision_id, time.time(),
5294
osutils.local_time_offset(), submit_branch,
5295
public_branch=public_branch, include_patch=include_patch,
5296
include_bundle=include_bundle, message=message,
5297
base_revision_id=base_revision_id)
5300
self.outf.write(directive.to_signed(branch))
5302
self.outf.writelines(directive.to_lines())
5304
message = directive.to_email(mail_to, branch, sign)
5305
s = SMTPConnection(branch.get_config())
5306
s.send_email(message)
5309
class cmd_send(Command):
5310
__doc__ = """Mail or create a merge-directive for submitting changes.
5312
A merge directive provides many things needed for requesting merges:
5314
* A machine-readable description of the merge to perform
5316
* An optional patch that is a preview of the changes requested
5318
* An optional bundle of revision data, so that the changes can be applied
5319
directly from the merge directive, without retrieving data from a
5322
`bzr send` creates a compact data set that, when applied using bzr
5323
merge, has the same effect as merging from the source branch.
5325
By default the merge directive is self-contained and can be applied to any
5326
branch containing submit_branch in its ancestory without needing access to
5329
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5330
revisions, but only a structured request to merge from the
5331
public_location. In that case the public_branch is needed and it must be
5332
up-to-date and accessible to the recipient. The public_branch is always
5333
included if known, so that people can check it later.
5335
The submit branch defaults to the parent of the source branch, but can be
5336
overridden. Both submit branch and public branch will be remembered in
5337
branch.conf the first time they are used for a particular branch. The
5338
source branch defaults to that containing the working directory, but can
5339
be changed using --from.
5341
Both the submit branch and the public branch follow the usual behavior with
5342
respect to --remember: If there is no default location set, the first send
5343
will set it (use --no-remember to avoid settting it). After that, you can
5344
omit the location to use the default. To change the default, use
5345
--remember. The value will only be saved if the location can be accessed.
5347
In order to calculate those changes, bzr must analyse the submit branch.
5348
Therefore it is most efficient for the submit branch to be a local mirror.
5349
If a public location is known for the submit_branch, that location is used
5350
in the merge directive.
5352
The default behaviour is to send the merge directive by mail, unless -o is
5353
given, in which case it is sent to a file.
5355
Mail is sent using your preferred mail program. This should be transparent
5356
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5357
If the preferred client can't be found (or used), your editor will be used.
5359
To use a specific mail program, set the mail_client configuration option.
5360
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5361
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5362
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5363
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5366
If mail is being sent, a to address is required. This can be supplied
5367
either on the commandline, by setting the submit_to configuration
5368
option in the branch itself or the child_submit_to configuration option
5369
in the submit branch.
5371
Two formats are currently supported: "4" uses revision bundle format 4 and
5372
merge directive format 2. It is significantly faster and smaller than
5373
older formats. It is compatible with Bazaar 0.19 and later. It is the
5374
default. "0.9" uses revision bundle format 0.9 and merge directive
5375
format 1. It is compatible with Bazaar 0.12 - 0.18.
5377
The merge directives created by bzr send may be applied using bzr merge or
5378
bzr pull by specifying a file containing a merge directive as the location.
5380
bzr send makes extensive use of public locations to map local locations into
5381
URLs that can be used by other people. See `bzr help configuration` to
5382
set them, and use `bzr info` to display them.
5385
encoding_type = 'exact'
5387
_see_also = ['merge', 'pull']
5389
takes_args = ['submit_branch?', 'public_branch?']
5393
help='Do not include a bundle in the merge directive.'),
5394
Option('no-patch', help='Do not include a preview patch in the merge'
5397
help='Remember submit and public branch.'),
5399
help='Branch to generate the submission from, '
5400
'rather than the one containing the working directory.',
5403
Option('output', short_name='o',
5404
help='Write merge directive to this file or directory; '
5405
'use - for stdout.',
5408
help='Refuse to send if there are uncommitted changes in'
5409
' the working tree, --no-strict disables the check.'),
5410
Option('mail-to', help='Mail the request to this address.',
5414
Option('body', help='Body for the email.', type=unicode),
5415
RegistryOption('format',
5416
help='Use the specified output format.',
5417
lazy_registry=('bzrlib.send', 'format_registry')),
5420
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5421
no_patch=False, revision=None, remember=None, output=None,
5422
format=None, mail_to=None, message=None, body=None,
5423
strict=None, **kwargs):
5424
from bzrlib.send import send
5425
return send(submit_branch, revision, public_branch, remember,
5426
format, no_bundle, no_patch, output,
5427
kwargs.get('from', '.'), mail_to, message, body,
5432
class cmd_bundle_revisions(cmd_send):
5433
__doc__ = """Create a merge-directive for submitting changes.
5435
A merge directive provides many things needed for requesting merges:
5437
* A machine-readable description of the merge to perform
5439
* An optional patch that is a preview of the changes requested
5441
* An optional bundle of revision data, so that the changes can be applied
5442
directly from the merge directive, without retrieving data from a
5445
If --no-bundle is specified, then public_branch is needed (and must be
5446
up-to-date), so that the receiver can perform the merge using the
5447
public_branch. The public_branch is always included if known, so that
5448
people can check it later.
5450
The submit branch defaults to the parent, but can be overridden. Both
5451
submit branch and public branch will be remembered if supplied.
5453
If a public_branch is known for the submit_branch, that public submit
5454
branch is used in the merge instructions. This means that a local mirror
5455
can be used as your actual submit branch, once you have set public_branch
5458
Two formats are currently supported: "4" uses revision bundle format 4 and
5459
merge directive format 2. It is significantly faster and smaller than
5460
older formats. It is compatible with Bazaar 0.19 and later. It is the
5461
default. "0.9" uses revision bundle format 0.9 and merge directive
5462
format 1. It is compatible with Bazaar 0.12 - 0.18.
5467
help='Do not include a bundle in the merge directive.'),
5468
Option('no-patch', help='Do not include a preview patch in the merge'
5471
help='Remember submit and public branch.'),
5473
help='Branch to generate the submission from, '
5474
'rather than the one containing the working directory.',
5477
Option('output', short_name='o', help='Write directive to this file.',
5480
help='Refuse to bundle revisions if there are uncommitted'
5481
' changes in the working tree, --no-strict disables the check.'),
5483
RegistryOption('format',
5484
help='Use the specified output format.',
5485
lazy_registry=('bzrlib.send', 'format_registry')),
5487
aliases = ['bundle']
5489
_see_also = ['send', 'merge']
5493
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5494
no_patch=False, revision=None, remember=False, output=None,
5495
format=None, strict=None, **kwargs):
5498
from bzrlib.send import send
5499
return send(submit_branch, revision, public_branch, remember,
5500
format, no_bundle, no_patch, output,
5501
kwargs.get('from', '.'), None, None, None,
5502
self.outf, strict=strict)
5505
class cmd_tag(Command):
5506
__doc__ = """Create, remove or modify a tag naming a revision.
5508
Tags give human-meaningful names to revisions. Commands that take a -r
5509
(--revision) option can be given -rtag:X, where X is any previously
5512
Tags are stored in the branch. Tags are copied from one branch to another
5513
along when you branch, push, pull or merge.
5515
It is an error to give a tag name that already exists unless you pass
5516
--force, in which case the tag is moved to point to the new revision.
5518
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5519
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5521
If no tag name is specified it will be determined through the
5522
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5523
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5527
_see_also = ['commit', 'tags']
5528
takes_args = ['tag_name?']
5531
help='Delete this tag rather than placing it.',
5533
custom_help('directory',
5534
help='Branch in which to place the tag.'),
5536
help='Replace existing tags.',
5541
def run(self, tag_name=None,
5547
branch, relpath = Branch.open_containing(directory)
5548
self.add_cleanup(branch.lock_write().unlock)
5550
if tag_name is None:
5551
raise errors.BzrCommandError("No tag specified to delete.")
5552
branch.tags.delete_tag(tag_name)
5553
note('Deleted tag %s.' % tag_name)
5556
if len(revision) != 1:
5557
raise errors.BzrCommandError(
5558
"Tags can only be placed on a single revision, "
5560
revision_id = revision[0].as_revision_id(branch)
5562
revision_id = branch.last_revision()
5563
if tag_name is None:
5564
tag_name = branch.automatic_tag_name(revision_id)
5565
if tag_name is None:
5566
raise errors.BzrCommandError(
5567
"Please specify a tag name.")
5568
if (not force) and branch.tags.has_tag(tag_name):
5569
raise errors.TagAlreadyExists(tag_name)
5570
branch.tags.set_tag(tag_name, revision_id)
5571
note('Created tag %s.' % tag_name)
5574
class cmd_tags(Command):
5575
__doc__ = """List tags.
5577
This command shows a table of tag names and the revisions they reference.
5582
custom_help('directory',
5583
help='Branch whose tags should be displayed.'),
5584
RegistryOption('sort',
5585
'Sort tags by different criteria.', title='Sorting',
5586
lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5593
def run(self, directory='.', sort=None, show_ids=False, revision=None):
5594
from bzrlib.tag import tag_sort_methods
5595
branch, relpath = Branch.open_containing(directory)
5597
tags = branch.tags.get_tag_dict().items()
5601
self.add_cleanup(branch.lock_read().unlock)
5603
graph = branch.repository.get_graph()
5604
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5605
revid1, revid2 = rev1.rev_id, rev2.rev_id
5606
# only show revisions between revid1 and revid2 (inclusive)
5607
tags = [(tag, revid) for tag, revid in tags if
5608
graph.is_between(revid, revid1, revid2)]
5610
sort = tag_sort_methods.get()
5613
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5614
for index, (tag, revid) in enumerate(tags):
5616
revno = branch.revision_id_to_dotted_revno(revid)
5617
if isinstance(revno, tuple):
5618
revno = '.'.join(map(str, revno))
5619
except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
5620
# Bad tag data/merges can lead to tagged revisions
5621
# which are not in this branch. Fail gracefully ...
5623
tags[index] = (tag, revno)
5625
for tag, revspec in tags:
5626
self.outf.write('%-20s %s\n' % (tag, revspec))
5629
class cmd_reconfigure(Command):
5630
__doc__ = """Reconfigure the type of a bzr directory.
5632
A target configuration must be specified.
5634
For checkouts, the bind-to location will be auto-detected if not specified.
5635
The order of preference is
5636
1. For a lightweight checkout, the current bound location.
5637
2. For branches that used to be checkouts, the previously-bound location.
5638
3. The push location.
5639
4. The parent location.
5640
If none of these is available, --bind-to must be specified.
5643
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5644
takes_args = ['location?']
5646
RegistryOption.from_kwargs(
5648
title='Target type',
5649
help='The type to reconfigure the directory to.',
5650
value_switches=True, enum_switch=False,
5651
branch='Reconfigure to be an unbound branch with no working tree.',
5652
tree='Reconfigure to be an unbound branch with a working tree.',
5653
checkout='Reconfigure to be a bound branch with a working tree.',
5654
lightweight_checkout='Reconfigure to be a lightweight'
5655
' checkout (with no local history).',
5656
standalone='Reconfigure to be a standalone branch '
5657
'(i.e. stop using shared repository).',
5658
use_shared='Reconfigure to use a shared repository.',
5659
with_trees='Reconfigure repository to create '
5660
'working trees on branches by default.',
5661
with_no_trees='Reconfigure repository to not create '
5662
'working trees on branches by default.'
5664
Option('bind-to', help='Branch to bind checkout to.', type=str),
5666
help='Perform reconfiguration even if local changes'
5668
Option('stacked-on',
5669
help='Reconfigure a branch to be stacked on another branch.',
5673
help='Reconfigure a branch to be unstacked. This '
5674
'may require copying substantial data into it.',
5678
def run(self, location=None, target_type=None, bind_to=None, force=False,
5681
directory = bzrdir.BzrDir.open(location)
5682
if stacked_on and unstacked:
5683
raise errors.BzrCommandError("Can't use both --stacked-on and --unstacked")
5684
elif stacked_on is not None:
5685
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5687
reconfigure.ReconfigureUnstacked().apply(directory)
5688
# At the moment you can use --stacked-on and a different
5689
# reconfiguration shape at the same time; there seems no good reason
5691
if target_type is None:
5692
if stacked_on or unstacked:
5695
raise errors.BzrCommandError('No target configuration '
5697
elif target_type == 'branch':
5698
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5699
elif target_type == 'tree':
5700
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5701
elif target_type == 'checkout':
5702
reconfiguration = reconfigure.Reconfigure.to_checkout(
5704
elif target_type == 'lightweight-checkout':
5705
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5707
elif target_type == 'use-shared':
5708
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5709
elif target_type == 'standalone':
5710
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5711
elif target_type == 'with-trees':
5712
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5714
elif target_type == 'with-no-trees':
5715
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5717
reconfiguration.apply(force)
5720
class cmd_switch(Command):
5721
__doc__ = """Set the branch of a checkout and update.
5723
For lightweight checkouts, this changes the branch being referenced.
5724
For heavyweight checkouts, this checks that there are no local commits
5725
versus the current bound branch, then it makes the local branch a mirror
5726
of the new location and binds to it.
5728
In both cases, the working tree is updated and uncommitted changes
5729
are merged. The user can commit or revert these as they desire.
5731
Pending merges need to be committed or reverted before using switch.
5733
The path to the branch to switch to can be specified relative to the parent
5734
directory of the current branch. For example, if you are currently in a
5735
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5738
Bound branches use the nickname of its master branch unless it is set
5739
locally, in which case switching will update the local nickname to be
5743
takes_args = ['to_location?']
5744
takes_options = ['directory',
5746
help='Switch even if local commits will be lost.'),
5748
Option('create-branch', short_name='b',
5749
help='Create the target branch from this one before'
5750
' switching to it.'),
5753
def run(self, to_location=None, force=False, create_branch=False,
5754
revision=None, directory=u'.'):
5755
from bzrlib import switch
5756
tree_location = directory
5757
revision = _get_one_revision('switch', revision)
5758
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5759
if to_location is None:
5760
if revision is None:
5761
raise errors.BzrCommandError('You must supply either a'
5762
' revision or a location')
5763
to_location = tree_location
5765
branch = control_dir.open_branch()
5766
had_explicit_nick = branch.get_config().has_explicit_nickname()
5767
except errors.NotBranchError:
5769
had_explicit_nick = False
5772
raise errors.BzrCommandError('cannot create branch without'
5774
to_location = directory_service.directories.dereference(
5776
if '/' not in to_location and '\\' not in to_location:
5777
# This path is meant to be relative to the existing branch
5778
this_url = self._get_branch_location(control_dir)
5779
to_location = urlutils.join(this_url, '..', to_location)
5780
to_branch = branch.bzrdir.sprout(to_location,
5781
possible_transports=[branch.bzrdir.root_transport],
5782
source_branch=branch).open_branch()
5785
to_branch = Branch.open(to_location)
5786
except errors.NotBranchError:
5787
this_url = self._get_branch_location(control_dir)
5788
to_branch = Branch.open(
5789
urlutils.join(this_url, '..', to_location))
5790
if revision is not None:
5791
revision = revision.as_revision_id(to_branch)
5792
switch.switch(control_dir, to_branch, force, revision_id=revision)
5793
if had_explicit_nick:
5794
branch = control_dir.open_branch() #get the new branch!
5795
branch.nick = to_branch.nick
5796
note('Switched to branch: %s',
5797
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5799
def _get_branch_location(self, control_dir):
5800
"""Return location of branch for this control dir."""
5802
this_branch = control_dir.open_branch()
5803
# This may be a heavy checkout, where we want the master branch
5804
master_location = this_branch.get_bound_location()
5805
if master_location is not None:
5806
return master_location
5807
# If not, use a local sibling
5808
return this_branch.base
5809
except errors.NotBranchError:
5810
format = control_dir.find_branch_format()
5811
if getattr(format, 'get_reference', None) is not None:
5812
return format.get_reference(control_dir)
5814
return control_dir.root_transport.base
5817
class cmd_view(Command):
5818
__doc__ = """Manage filtered views.
5820
Views provide a mask over the tree so that users can focus on
5821
a subset of a tree when doing their work. After creating a view,
5822
commands that support a list of files - status, diff, commit, etc -
5823
effectively have that list of files implicitly given each time.
5824
An explicit list of files can still be given but those files
5825
must be within the current view.
5827
In most cases, a view has a short life-span: it is created to make
5828
a selected change and is deleted once that change is committed.
5829
At other times, you may wish to create one or more named views
5830
and switch between them.
5832
To disable the current view without deleting it, you can switch to
5833
the pseudo view called ``off``. This can be useful when you need
5834
to see the whole tree for an operation or two (e.g. merge) but
5835
want to switch back to your view after that.
5838
To define the current view::
5840
bzr view file1 dir1 ...
5842
To list the current view::
5846
To delete the current view::
5850
To disable the current view without deleting it::
5852
bzr view --switch off
5854
To define a named view and switch to it::
5856
bzr view --name view-name file1 dir1 ...
5858
To list a named view::
5860
bzr view --name view-name
5862
To delete a named view::
5864
bzr view --name view-name --delete
5866
To switch to a named view::
5868
bzr view --switch view-name
5870
To list all views defined::
5874
To delete all views::
5876
bzr view --delete --all
5880
takes_args = ['file*']
5883
help='Apply list or delete action to all views.',
5886
help='Delete the view.',
5889
help='Name of the view to define, list or delete.',
5893
help='Name of the view to switch to.',
5898
def run(self, file_list,
5904
tree, file_list = WorkingTree.open_containing_paths(file_list,
5906
current_view, view_dict = tree.views.get_view_info()
5911
raise errors.BzrCommandError(
5912
"Both --delete and a file list specified")
5914
raise errors.BzrCommandError(
5915
"Both --delete and --switch specified")
5917
tree.views.set_view_info(None, {})
5918
self.outf.write("Deleted all views.\n")
5920
raise errors.BzrCommandError("No current view to delete")
5922
tree.views.delete_view(name)
5923
self.outf.write("Deleted '%s' view.\n" % name)
5926
raise errors.BzrCommandError(
5927
"Both --switch and a file list specified")
5929
raise errors.BzrCommandError(
5930
"Both --switch and --all specified")
5931
elif switch == 'off':
5932
if current_view is None:
5933
raise errors.BzrCommandError("No current view to disable")
5934
tree.views.set_view_info(None, view_dict)
5935
self.outf.write("Disabled '%s' view.\n" % (current_view))
5937
tree.views.set_view_info(switch, view_dict)
5938
view_str = views.view_display_str(tree.views.lookup_view())
5939
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5942
self.outf.write('Views defined:\n')
5943
for view in sorted(view_dict):
5944
if view == current_view:
5948
view_str = views.view_display_str(view_dict[view])
5949
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5951
self.outf.write('No views defined.\n')
5954
# No name given and no current view set
5957
raise errors.BzrCommandError(
5958
"Cannot change the 'off' pseudo view")
5959
tree.views.set_view(name, sorted(file_list))
5960
view_str = views.view_display_str(tree.views.lookup_view())
5961
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5965
# No name given and no current view set
5966
self.outf.write('No current view.\n')
5968
view_str = views.view_display_str(tree.views.lookup_view(name))
5969
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5972
class cmd_hooks(Command):
5973
__doc__ = """Show hooks."""
5978
for hook_key in sorted(hooks.known_hooks.keys()):
5979
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5980
self.outf.write("%s:\n" % type(some_hooks).__name__)
5981
for hook_name, hook_point in sorted(some_hooks.items()):
5982
self.outf.write(" %s:\n" % (hook_name,))
5983
found_hooks = list(hook_point)
5985
for hook in found_hooks:
5986
self.outf.write(" %s\n" %
5987
(some_hooks.get_hook_name(hook),))
5989
self.outf.write(" <no hooks installed>\n")
5992
class cmd_remove_branch(Command):
5993
__doc__ = """Remove a branch.
5995
This will remove the branch from the specified location but
5996
will keep any working tree or repository in place.
6000
Remove the branch at repo/trunk::
6002
bzr remove-branch repo/trunk
6006
takes_args = ["location?"]
6008
aliases = ["rmbranch"]
6010
def run(self, location=None):
6011
if location is None:
6013
branch = Branch.open_containing(location)[0]
6014
branch.bzrdir.destroy_branch()
6017
class cmd_shelve(Command):
6018
__doc__ = """Temporarily set aside some changes from the current tree.
6020
Shelve allows you to temporarily put changes you've made "on the shelf",
6021
ie. out of the way, until a later time when you can bring them back from
6022
the shelf with the 'unshelve' command. The changes are stored alongside
6023
your working tree, and so they aren't propagated along with your branch nor
6024
will they survive its deletion.
6026
If shelve --list is specified, previously-shelved changes are listed.
6028
Shelve is intended to help separate several sets of changes that have
6029
been inappropriately mingled. If you just want to get rid of all changes
6030
and you don't need to restore them later, use revert. If you want to
6031
shelve all text changes at once, use shelve --all.
6033
If filenames are specified, only the changes to those files will be
6034
shelved. Other files will be left untouched.
6036
If a revision is specified, changes since that revision will be shelved.
6038
You can put multiple items on the shelf, and by default, 'unshelve' will
6039
restore the most recently shelved changes.
6041
For complicated changes, it is possible to edit the changes in a separate
6042
editor program to decide what the file remaining in the working copy
6043
should look like. To do this, add the configuration option
6045
change_editor = PROGRAM @new_path @old_path
6047
where @new_path is replaced with the path of the new version of the
6048
file and @old_path is replaced with the path of the old version of
6049
the file. The PROGRAM should save the new file with the desired
6050
contents of the file in the working tree.
6054
takes_args = ['file*']
6059
Option('all', help='Shelve all changes.'),
6061
RegistryOption('writer', 'Method to use for writing diffs.',
6062
bzrlib.option.diff_writer_registry,
6063
value_switches=True, enum_switch=False),
6065
Option('list', help='List shelved changes.'),
6067
help='Destroy removed changes instead of shelving them.'),
6069
_see_also = ['unshelve', 'configuration']
6071
def run(self, revision=None, all=False, file_list=None, message=None,
6072
writer=None, list=False, destroy=False, directory=None):
6074
return self.run_for_list(directory=directory)
6075
from bzrlib.shelf_ui import Shelver
6077
writer = bzrlib.option.diff_writer_registry.get()
6079
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6080
file_list, message, destroy=destroy, directory=directory)
6085
except errors.UserAbort:
6088
def run_for_list(self, directory=None):
6089
if directory is None:
6091
tree = WorkingTree.open_containing(directory)[0]
6092
self.add_cleanup(tree.lock_read().unlock)
6093
manager = tree.get_shelf_manager()
6094
shelves = manager.active_shelves()
6095
if len(shelves) == 0:
6096
note('No shelved changes.')
6098
for shelf_id in reversed(shelves):
6099
message = manager.get_metadata(shelf_id).get('message')
6101
message = '<no message>'
6102
self.outf.write('%3d: %s\n' % (shelf_id, message))
6106
class cmd_unshelve(Command):
6107
__doc__ = """Restore shelved changes.
6109
By default, the most recently shelved changes are restored. However if you
6110
specify a shelf by id those changes will be restored instead. This works
6111
best when the changes don't depend on each other.
6114
takes_args = ['shelf_id?']
6117
RegistryOption.from_kwargs(
6118
'action', help="The action to perform.",
6119
enum_switch=False, value_switches=True,
6120
apply="Apply changes and remove from the shelf.",
6121
dry_run="Show changes, but do not apply or remove them.",
6122
preview="Instead of unshelving the changes, show the diff that "
6123
"would result from unshelving.",
6124
delete_only="Delete changes without applying them.",
6125
keep="Apply changes but don't delete them.",
6128
_see_also = ['shelve']
6130
def run(self, shelf_id=None, action='apply', directory=u'.'):
6131
from bzrlib.shelf_ui import Unshelver
6132
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6136
unshelver.tree.unlock()
6139
class cmd_clean_tree(Command):
6140
__doc__ = """Remove unwanted files from working tree.
6142
By default, only unknown files, not ignored files, are deleted. Versioned
6143
files are never deleted.
6145
Another class is 'detritus', which includes files emitted by bzr during
6146
normal operations and selftests. (The value of these files decreases with
6149
If no options are specified, unknown files are deleted. Otherwise, option
6150
flags are respected, and may be combined.
6152
To check what clean-tree will do, use --dry-run.
6154
takes_options = ['directory',
6155
Option('ignored', help='Delete all ignored files.'),
6156
Option('detritus', help='Delete conflict files, merge and revert'
6157
' backups, and failed selftest dirs.'),
6159
help='Delete files unknown to bzr (default).'),
6160
Option('dry-run', help='Show files to delete instead of'
6162
Option('force', help='Do not prompt before deleting.')]
6163
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6164
force=False, directory=u'.'):
6165
from bzrlib.clean_tree import clean_tree
6166
if not (unknown or ignored or detritus):
6170
clean_tree(directory, unknown=unknown, ignored=ignored,
6171
detritus=detritus, dry_run=dry_run, no_prompt=force)
6174
class cmd_reference(Command):
6175
__doc__ = """list, view and set branch locations for nested trees.
6177
If no arguments are provided, lists the branch locations for nested trees.
6178
If one argument is provided, display the branch location for that tree.
6179
If two arguments are provided, set the branch location for that tree.
6184
takes_args = ['path?', 'location?']
6186
def run(self, path=None, location=None):
6188
if path is not None:
6190
tree, branch, relpath =(
6191
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
6192
if path is not None:
6195
tree = branch.basis_tree()
6197
info = branch._get_all_reference_info().iteritems()
6198
self._display_reference_info(tree, branch, info)
6200
file_id = tree.path2id(path)
6202
raise errors.NotVersionedError(path)
6203
if location is None:
6204
info = [(file_id, branch.get_reference_info(file_id))]
6205
self._display_reference_info(tree, branch, info)
6207
branch.set_reference_info(file_id, path, location)
6209
def _display_reference_info(self, tree, branch, info):
6211
for file_id, (path, location) in info:
6213
path = tree.id2path(file_id)
6214
except errors.NoSuchId:
6216
ref_list.append((path, location))
6217
for path, location in sorted(ref_list):
6218
self.outf.write('%s %s\n' % (path, location))
6221
class cmd_export_pot(Command):
6222
__doc__ = """Export command helps and error messages in po format."""
6227
from bzrlib.export_pot import export_pot
6228
export_pot(self.outf)
6231
def _register_lazy_builtins():
6232
# register lazy builtins from other modules; called at startup and should
6233
# be only called once.
6234
for (name, aliases, module_name) in [
6235
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6236
('cmd_config', [], 'bzrlib.config'),
6237
('cmd_dpush', [], 'bzrlib.foreign'),
6238
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6239
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6240
('cmd_conflicts', [], 'bzrlib.conflicts'),
6241
('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6242
('cmd_verify_signatures', [],
6243
'bzrlib.commit_signature_commands'),
6244
('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6246
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
