1
# Copyright (C) 2004, 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
43
revision as _mod_revision,
50
from bzrlib.branch import Branch
51
from bzrlib.conflicts import ConflictList
52
from bzrlib.revisionspec import RevisionSpec
53
from bzrlib.smtp_connection import SMTPConnection
54
from bzrlib.workingtree import WorkingTree
57
from bzrlib.commands import Command, display_command
58
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
59
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
62
def tree_files(file_list, default_branch=u'.'):
64
return internal_tree_files(file_list, default_branch)
65
except errors.FileInWrongBranch, e:
66
raise errors.BzrCommandError("%s is not in the same branch as %s" %
67
(e.path, file_list[0]))
70
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
75
rev_tree = tree.basis_tree()
77
rev_tree = branch.basis_tree()
79
if len(revisions) != 1:
80
raise errors.BzrCommandError(
81
'bzr %s --revision takes exactly one revision identifier' % (
83
rev_tree = revisions[0].as_tree(branch)
87
# XXX: Bad function name; should possibly also be a class method of
88
# WorkingTree rather than a function.
89
def internal_tree_files(file_list, default_branch=u'.'):
90
"""Convert command-line paths to a WorkingTree and relative paths.
92
This is typically used for command-line processors that take one or
93
more filenames, and infer the workingtree that contains them.
95
The filenames given are not required to exist.
97
:param file_list: Filenames to convert.
99
:param default_branch: Fallback tree path to use if file_list is empty or
102
:return: workingtree, [relative_paths]
104
if file_list is None or len(file_list) == 0:
105
return WorkingTree.open_containing(default_branch)[0], file_list
106
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
107
return tree, safe_relpath_files(tree, file_list)
110
def safe_relpath_files(tree, file_list):
111
"""Convert file_list into a list of relpaths in tree.
113
:param tree: A tree to operate on.
114
:param file_list: A list of user provided paths or None.
115
:return: A list of relative paths.
116
:raises errors.PathNotChild: When a provided path is in a different tree
119
if file_list is None:
122
for filename in file_list:
124
new_list.append(tree.relpath(osutils.dereference_path(filename)))
125
except errors.PathNotChild:
126
raise errors.FileInWrongBranch(tree.branch, filename)
130
# TODO: Make sure no commands unconditionally use the working directory as a
131
# branch. If a filename argument is used, the first of them should be used to
132
# specify the branch. (Perhaps this can be factored out into some kind of
133
# Argument class, representing a file in a branch, where the first occurrence
136
class cmd_status(Command):
137
"""Display status summary.
139
This reports on versioned and unknown files, reporting them
140
grouped by state. Possible states are:
143
Versioned in the working copy but not in the previous revision.
146
Versioned in the previous revision but removed or deleted
150
Path of this file changed from the previous revision;
151
the text may also have changed. This includes files whose
152
parent directory was renamed.
155
Text has changed since the previous revision.
158
File kind has been changed (e.g. from file to directory).
161
Not versioned and not matching an ignore pattern.
163
To see ignored files use 'bzr ignored'. For details on the
164
changes to file texts, use 'bzr diff'.
166
Note that --short or -S gives status flags for each item, similar
167
to Subversion's status command. To get output similar to svn -q,
170
If no arguments are specified, the status of the entire working
171
directory is shown. Otherwise, only the status of the specified
172
files or directories is reported. If a directory is given, status
173
is reported for everything inside that directory.
175
If a revision argument is given, the status is calculated against
176
that revision, or between two revisions if two are provided.
179
# TODO: --no-recurse, --recurse options
181
takes_args = ['file*']
182
takes_options = ['show-ids', 'revision', 'change',
183
Option('short', help='Use short status indicators.',
185
Option('versioned', help='Only show versioned files.',
187
Option('no-pending', help='Don\'t show pending merges.',
190
aliases = ['st', 'stat']
192
encoding_type = 'replace'
193
_see_also = ['diff', 'revert', 'status-flags']
196
def run(self, show_ids=False, file_list=None, revision=None, short=False,
197
versioned=False, no_pending=False):
198
from bzrlib.status import show_tree_status
200
if revision and len(revision) > 2:
201
raise errors.BzrCommandError('bzr status --revision takes exactly'
202
' one or two revision specifiers')
204
tree, relfile_list = tree_files(file_list)
205
# Avoid asking for specific files when that is not needed.
206
if relfile_list == ['']:
208
# Don't disable pending merges for full trees other than '.'.
209
if file_list == ['.']:
211
# A specific path within a tree was given.
212
elif relfile_list is not None:
214
show_tree_status(tree, show_ids=show_ids,
215
specific_files=relfile_list, revision=revision,
216
to_file=self.outf, short=short, versioned=versioned,
217
show_pending=(not no_pending))
220
class cmd_cat_revision(Command):
221
"""Write out metadata for a revision.
223
The revision to print can either be specified by a specific
224
revision identifier, or you can use --revision.
228
takes_args = ['revision_id?']
229
takes_options = ['revision']
230
# cat-revision is more for frontends so should be exact
234
def run(self, revision_id=None, revision=None):
235
if revision_id is not None and revision is not None:
236
raise errors.BzrCommandError('You can only supply one of'
237
' revision_id or --revision')
238
if revision_id is None and revision is None:
239
raise errors.BzrCommandError('You must supply either'
240
' --revision or a revision_id')
241
b = WorkingTree.open_containing(u'.')[0].branch
243
# TODO: jam 20060112 should cat-revision always output utf-8?
244
if revision_id is not None:
245
revision_id = osutils.safe_revision_id(revision_id, warn=False)
247
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
248
except errors.NoSuchRevision:
249
msg = "The repository %s contains no revision %s." % (b.repository.base,
251
raise errors.BzrCommandError(msg)
252
elif revision is not None:
255
raise errors.BzrCommandError('You cannot specify a NULL'
257
rev_id = rev.as_revision_id(b)
258
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
261
class cmd_dump_btree(Command):
262
"""Dump the contents of a btree index file to stdout.
264
PATH is a btree index file, it can be any URL. This includes things like
265
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
267
By default, the tuples stored in the index file will be displayed. With
268
--raw, we will uncompress the pages, but otherwise display the raw bytes
272
# TODO: Do we want to dump the internal nodes as well?
273
# TODO: It would be nice to be able to dump the un-parsed information,
274
# rather than only going through iter_all_entries. However, this is
275
# good enough for a start
277
encoding_type = 'exact'
278
takes_args = ['path']
279
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
280
' rather than the parsed tuples.'),
283
def run(self, path, raw=False):
284
dirname, basename = osutils.split(path)
285
t = transport.get_transport(dirname)
287
self._dump_raw_bytes(t, basename)
289
self._dump_entries(t, basename)
291
def _get_index_and_bytes(self, trans, basename):
292
"""Create a BTreeGraphIndex and raw bytes."""
293
bt = btree_index.BTreeGraphIndex(trans, basename, None)
294
bytes = trans.get_bytes(basename)
295
bt._file = cStringIO.StringIO(bytes)
296
bt._size = len(bytes)
299
def _dump_raw_bytes(self, trans, basename):
302
# We need to parse at least the root node.
303
# This is because the first page of every row starts with an
304
# uncompressed header.
305
bt, bytes = self._get_index_and_bytes(trans, basename)
306
for page_idx, page_start in enumerate(xrange(0, len(bytes),
307
btree_index._PAGE_SIZE)):
308
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
309
page_bytes = bytes[page_start:page_end]
311
self.outf.write('Root node:\n')
312
header_end, data = bt._parse_header_from_bytes(page_bytes)
313
self.outf.write(page_bytes[:header_end])
315
self.outf.write('\nPage %d\n' % (page_idx,))
316
decomp_bytes = zlib.decompress(page_bytes)
317
self.outf.write(decomp_bytes)
318
self.outf.write('\n')
320
def _dump_entries(self, trans, basename):
322
st = trans.stat(basename)
323
except errors.TransportNotPossible:
324
# We can't stat, so we'll fake it because we have to do the 'get()'
326
bt, _ = self._get_index_and_bytes(trans, basename)
328
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
329
for node in bt.iter_all_entries():
330
# Node is made up of:
331
# (index, key, value, [references])
332
self.outf.write('%s\n' % (node[1:],))
335
class cmd_remove_tree(Command):
336
"""Remove the working tree from a given branch/checkout.
338
Since a lightweight checkout is little more than a working tree
339
this will refuse to run against one.
341
To re-create the working tree, use "bzr checkout".
343
_see_also = ['checkout', 'working-trees']
344
takes_args = ['location?']
347
help='Remove the working tree even if it has '
348
'uncommitted changes.'),
351
def run(self, location='.', force=False):
352
d = bzrdir.BzrDir.open(location)
355
working = d.open_workingtree()
356
except errors.NoWorkingTree:
357
raise errors.BzrCommandError("No working tree to remove")
358
except errors.NotLocalUrl:
359
raise errors.BzrCommandError("You cannot remove the working tree of a "
362
changes = working.changes_from(working.basis_tree())
363
if changes.has_changed():
364
raise errors.UncommittedChanges(working)
366
working_path = working.bzrdir.root_transport.base
367
branch_path = working.branch.bzrdir.root_transport.base
368
if working_path != branch_path:
369
raise errors.BzrCommandError("You cannot remove the working tree from "
370
"a lightweight checkout")
372
d.destroy_workingtree()
375
class cmd_revno(Command):
376
"""Show current revision number.
378
This is equal to the number of revisions on this branch.
382
takes_args = ['location?']
385
def run(self, location=u'.'):
386
self.outf.write(str(Branch.open_containing(location)[0].revno()))
387
self.outf.write('\n')
390
class cmd_revision_info(Command):
391
"""Show revision number and revision id for a given revision identifier.
394
takes_args = ['revision_info*']
398
help='Branch to examine, '
399
'rather than the one containing the working directory.',
406
def run(self, revision=None, directory=u'.', revision_info_list=[]):
409
if revision is not None:
410
revs.extend(revision)
411
if revision_info_list is not None:
412
for rev in revision_info_list:
413
revs.append(RevisionSpec.from_string(rev))
415
b = Branch.open_containing(directory)[0]
418
revs.append(RevisionSpec.from_string('-1'))
421
revision_id = rev.as_revision_id(b)
423
revno = '%4d' % (b.revision_id_to_revno(revision_id))
424
except errors.NoSuchRevision:
425
dotted_map = b.get_revision_id_to_revno_map()
426
revno = '.'.join(str(i) for i in dotted_map[revision_id])
427
print '%s %s' % (revno, revision_id)
430
class cmd_add(Command):
431
"""Add specified files or directories.
433
In non-recursive mode, all the named items are added, regardless
434
of whether they were previously ignored. A warning is given if
435
any of the named files are already versioned.
437
In recursive mode (the default), files are treated the same way
438
but the behaviour for directories is different. Directories that
439
are already versioned do not give a warning. All directories,
440
whether already versioned or not, are searched for files or
441
subdirectories that are neither versioned or ignored, and these
442
are added. This search proceeds recursively into versioned
443
directories. If no names are given '.' is assumed.
445
Therefore simply saying 'bzr add' will version all files that
446
are currently unknown.
448
Adding a file whose parent directory is not versioned will
449
implicitly add the parent, and so on up to the root. This means
450
you should never need to explicitly add a directory, they'll just
451
get added when you add a file in the directory.
453
--dry-run will show which files would be added, but not actually
456
--file-ids-from will try to use the file ids from the supplied path.
457
It looks up ids trying to find a matching parent directory with the
458
same filename, and then by pure path. This option is rarely needed
459
but can be useful when adding the same logical file into two
460
branches that will be merged later (without showing the two different
461
adds as a conflict). It is also useful when merging another project
462
into a subdirectory of this one.
464
takes_args = ['file*']
467
help="Don't recursively add the contents of directories."),
469
help="Show what would be done, but don't actually do anything."),
471
Option('file-ids-from',
473
help='Lookup file ids from this tree.'),
475
encoding_type = 'replace'
476
_see_also = ['remove']
478
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
483
if file_ids_from is not None:
485
base_tree, base_path = WorkingTree.open_containing(
487
except errors.NoWorkingTree:
488
base_branch, base_path = Branch.open_containing(
490
base_tree = base_branch.basis_tree()
492
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
493
to_file=self.outf, should_print=(not is_quiet()))
495
action = bzrlib.add.AddAction(to_file=self.outf,
496
should_print=(not is_quiet()))
499
base_tree.lock_read()
501
file_list = self._maybe_expand_globs(file_list)
503
tree = WorkingTree.open_containing(file_list[0])[0]
505
tree = WorkingTree.open_containing(u'.')[0]
506
added, ignored = tree.smart_add(file_list, not
507
no_recurse, action=action, save=not dry_run)
509
if base_tree is not None:
513
for glob in sorted(ignored.keys()):
514
for path in ignored[glob]:
515
self.outf.write("ignored %s matching \"%s\"\n"
519
for glob, paths in ignored.items():
520
match_len += len(paths)
521
self.outf.write("ignored %d file(s).\n" % match_len)
522
self.outf.write("If you wish to add some of these files,"
523
" please add them by name.\n")
526
class cmd_mkdir(Command):
527
"""Create a new versioned directory.
529
This is equivalent to creating the directory and then adding it.
532
takes_args = ['dir+']
533
encoding_type = 'replace'
535
def run(self, dir_list):
538
wt, dd = WorkingTree.open_containing(d)
540
self.outf.write('added %s\n' % d)
543
class cmd_relpath(Command):
544
"""Show path of a file relative to root"""
546
takes_args = ['filename']
550
def run(self, filename):
551
# TODO: jam 20050106 Can relpath return a munged path if
552
# sys.stdout encoding cannot represent it?
553
tree, relpath = WorkingTree.open_containing(filename)
554
self.outf.write(relpath)
555
self.outf.write('\n')
558
class cmd_inventory(Command):
559
"""Show inventory of the current working copy or a revision.
561
It is possible to limit the output to a particular entry
562
type using the --kind option. For example: --kind file.
564
It is also possible to restrict the list of files to a specific
565
set. For example: bzr inventory --show-ids this/file
574
help='List entries of a particular kind: file, directory, symlink.',
577
takes_args = ['file*']
580
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
581
if kind and kind not in ['file', 'directory', 'symlink']:
582
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
584
work_tree, file_list = tree_files(file_list)
585
work_tree.lock_read()
587
if revision is not None:
588
if len(revision) > 1:
589
raise errors.BzrCommandError(
590
'bzr inventory --revision takes exactly one revision'
592
tree = revision[0].as_tree(work_tree.branch)
594
extra_trees = [work_tree]
600
if file_list is not None:
601
file_ids = tree.paths2ids(file_list, trees=extra_trees,
602
require_versioned=True)
603
# find_ids_across_trees may include some paths that don't
605
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
606
for file_id in file_ids if file_id in tree)
608
entries = tree.inventory.entries()
611
if tree is not work_tree:
614
for path, entry in entries:
615
if kind and kind != entry.kind:
618
self.outf.write('%-50s %s\n' % (path, entry.file_id))
620
self.outf.write(path)
621
self.outf.write('\n')
624
class cmd_mv(Command):
625
"""Move or rename a file.
628
bzr mv OLDNAME NEWNAME
630
bzr mv SOURCE... DESTINATION
632
If the last argument is a versioned directory, all the other names
633
are moved into it. Otherwise, there must be exactly two arguments
634
and the file is changed to a new name.
636
If OLDNAME does not exist on the filesystem but is versioned and
637
NEWNAME does exist on the filesystem but is not versioned, mv
638
assumes that the file has been manually moved and only updates
639
its internal inventory to reflect that change.
640
The same is valid when moving many SOURCE files to a DESTINATION.
642
Files cannot be moved between branches.
645
takes_args = ['names*']
646
takes_options = [Option("after", help="Move only the bzr identifier"
647
" of the file, because the file has already been moved."),
649
aliases = ['move', 'rename']
650
encoding_type = 'replace'
652
def run(self, names_list, after=False):
653
if names_list is None:
656
if len(names_list) < 2:
657
raise errors.BzrCommandError("missing file argument")
658
tree, rel_names = tree_files(names_list)
661
self._run(tree, names_list, rel_names, after)
665
def _run(self, tree, names_list, rel_names, after):
666
into_existing = osutils.isdir(names_list[-1])
667
if into_existing and len(names_list) == 2:
669
# a. case-insensitive filesystem and change case of dir
670
# b. move directory after the fact (if the source used to be
671
# a directory, but now doesn't exist in the working tree
672
# and the target is an existing directory, just rename it)
673
if (not tree.case_sensitive
674
and rel_names[0].lower() == rel_names[1].lower()):
675
into_existing = False
678
from_id = tree.path2id(rel_names[0])
679
if (not osutils.lexists(names_list[0]) and
680
from_id and inv.get_file_kind(from_id) == "directory"):
681
into_existing = False
684
# move into existing directory
685
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
686
self.outf.write("%s => %s\n" % pair)
688
if len(names_list) != 2:
689
raise errors.BzrCommandError('to mv multiple files the'
690
' destination must be a versioned'
692
tree.rename_one(rel_names[0], rel_names[1], after=after)
693
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
696
class cmd_pull(Command):
697
"""Turn this branch into a mirror of another branch.
699
This command only works on branches that have not diverged. Branches are
700
considered diverged if the destination branch's most recent commit is one
701
that has not been merged (directly or indirectly) into the parent.
703
If branches have diverged, you can use 'bzr merge' to integrate the changes
704
from one into the other. Once one branch has merged, the other should
705
be able to pull it again.
707
If you want to forget your local changes and just update your branch to
708
match the remote one, use pull --overwrite.
710
If there is no default location set, the first pull will set it. After
711
that, you can omit the location to use the default. To change the
712
default, use --remember. The value will only be saved if the remote
713
location can be accessed.
715
Note: The location can be specified either in the form of a branch,
716
or in the form of a path to a file containing a merge directive generated
720
_see_also = ['push', 'update', 'status-flags']
721
takes_options = ['remember', 'overwrite', 'revision',
722
custom_help('verbose',
723
help='Show logs of pulled revisions.'),
725
help='Branch to pull into, '
726
'rather than the one containing the working directory.',
731
takes_args = ['location?']
732
encoding_type = 'replace'
734
def run(self, location=None, remember=False, overwrite=False,
735
revision=None, verbose=False,
737
# FIXME: too much stuff is in the command class
740
if directory is None:
743
tree_to = WorkingTree.open_containing(directory)[0]
744
branch_to = tree_to.branch
745
except errors.NoWorkingTree:
747
branch_to = Branch.open_containing(directory)[0]
749
possible_transports = []
750
if location is not None:
752
mergeable = bundle.read_mergeable_from_url(location,
753
possible_transports=possible_transports)
754
except errors.NotABundle:
757
stored_loc = branch_to.get_parent()
759
if stored_loc is None:
760
raise errors.BzrCommandError("No pull location known or"
763
display_url = urlutils.unescape_for_display(stored_loc,
766
self.outf.write("Using saved parent location: %s\n" % display_url)
767
location = stored_loc
769
if mergeable is not None:
770
if revision is not None:
771
raise errors.BzrCommandError(
772
'Cannot use -r with merge directives or bundles')
773
mergeable.install_revisions(branch_to.repository)
774
base_revision_id, revision_id, verified = \
775
mergeable.get_merge_request(branch_to.repository)
776
branch_from = branch_to
778
branch_from = Branch.open(location,
779
possible_transports=possible_transports)
781
if branch_to.get_parent() is None or remember:
782
branch_to.set_parent(branch_from.base)
784
if revision is not None:
785
if len(revision) == 1:
786
revision_id = revision[0].as_revision_id(branch_from)
788
raise errors.BzrCommandError(
789
'bzr pull --revision takes one value.')
791
branch_to.lock_write()
793
if tree_to is not None:
794
change_reporter = delta._ChangeReporter(
795
unversioned_filter=tree_to.is_ignored)
796
result = tree_to.pull(branch_from, overwrite, revision_id,
798
possible_transports=possible_transports)
800
result = branch_to.pull(branch_from, overwrite, revision_id)
802
result.report(self.outf)
803
if verbose and result.old_revid != result.new_revid:
805
branch_to.repository.iter_reverse_revision_history(
808
new_rh = branch_to.revision_history()
809
log_format = branch_to.get_config().log_format()
810
log.show_changed_revisions(branch_to, old_rh, new_rh,
812
log_format=log_format)
817
class cmd_push(Command):
818
"""Update a mirror of this branch.
820
The target branch will not have its working tree populated because this
821
is both expensive, and is not supported on remote file systems.
823
Some smart servers or protocols *may* put the working tree in place in
826
This command only works on branches that have not diverged. Branches are
827
considered diverged if the destination branch's most recent commit is one
828
that has not been merged (directly or indirectly) by the source branch.
830
If branches have diverged, you can use 'bzr push --overwrite' to replace
831
the other branch completely, discarding its unmerged changes.
833
If you want to ensure you have the different changes in the other branch,
834
do a merge (see bzr help merge) from the other branch, and commit that.
835
After that you will be able to do a push without '--overwrite'.
837
If there is no default push location set, the first push will set it.
838
After that, you can omit the location to use the default. To change the
839
default, use --remember. The value will only be saved if the remote
840
location can be accessed.
843
_see_also = ['pull', 'update', 'working-trees']
844
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
845
Option('create-prefix',
846
help='Create the path leading up to the branch '
847
'if it does not already exist.'),
849
help='Branch to push from, '
850
'rather than the one containing the working directory.',
854
Option('use-existing-dir',
855
help='By default push will fail if the target'
856
' directory exists, but does not already'
857
' have a control directory. This flag will'
858
' allow push to proceed.'),
860
help='Create a stacked branch that references the public location '
861
'of the parent branch.'),
863
help='Create a stacked branch that refers to another branch '
864
'for the commit history. Only the work not present in the '
865
'referenced branch is included in the branch created.',
868
takes_args = ['location?']
869
encoding_type = 'replace'
871
def run(self, location=None, remember=False, overwrite=False,
872
create_prefix=False, verbose=False, revision=None,
873
use_existing_dir=False, directory=None, stacked_on=None,
875
from bzrlib.push import _show_push_branch
877
# Get the source branch and revision_id
878
if directory is None:
880
br_from = Branch.open_containing(directory)[0]
881
if revision is not None:
882
if len(revision) == 1:
883
revision_id = revision[0].in_history(br_from).rev_id
885
raise errors.BzrCommandError(
886
'bzr push --revision takes one value.')
888
revision_id = br_from.last_revision()
890
# Get the stacked_on branch, if any
891
if stacked_on is not None:
892
stacked_on = urlutils.normalize_url(stacked_on)
894
parent_url = br_from.get_parent()
896
parent = Branch.open(parent_url)
897
stacked_on = parent.get_public_branch()
899
# I considered excluding non-http url's here, thus forcing
900
# 'public' branches only, but that only works for some
901
# users, so it's best to just depend on the user spotting an
902
# error by the feedback given to them. RBC 20080227.
903
stacked_on = parent_url
905
raise errors.BzrCommandError(
906
"Could not determine branch to refer to.")
908
# Get the destination location
910
stored_loc = br_from.get_push_location()
911
if stored_loc is None:
912
raise errors.BzrCommandError(
913
"No push location known or specified.")
915
display_url = urlutils.unescape_for_display(stored_loc,
917
self.outf.write("Using saved push location: %s\n" % display_url)
918
location = stored_loc
920
_show_push_branch(br_from, revision_id, location, self.outf,
921
verbose=verbose, overwrite=overwrite, remember=remember,
922
stacked_on=stacked_on, create_prefix=create_prefix,
923
use_existing_dir=use_existing_dir)
926
class cmd_branch(Command):
927
"""Create a new copy of a branch.
929
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
930
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
931
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
932
is derived from the FROM_LOCATION by stripping a leading scheme or drive
933
identifier, if any. For example, "branch lp:foo-bar" will attempt to
936
To retrieve the branch as of a particular revision, supply the --revision
937
parameter, as in "branch foo/bar -r 5".
940
_see_also = ['checkout']
941
takes_args = ['from_location', 'to_location?']
942
takes_options = ['revision', Option('hardlink',
943
help='Hard-link working tree files where possible.'),
945
help='Create a stacked branch referring to the source branch. '
946
'The new branch will depend on the availability of the source '
947
'branch for all operations.'),
949
help='Do not use a shared repository, even if available.'),
951
aliases = ['get', 'clone']
953
def run(self, from_location, to_location=None, revision=None,
954
hardlink=False, stacked=False, standalone=False):
955
from bzrlib.tag import _merge_tags_if_possible
958
elif len(revision) > 1:
959
raise errors.BzrCommandError(
960
'bzr branch --revision takes exactly 1 revision value')
962
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
966
if len(revision) == 1 and revision[0] is not None:
967
revision_id = revision[0].as_revision_id(br_from)
969
# FIXME - wt.last_revision, fallback to branch, fall back to
970
# None or perhaps NULL_REVISION to mean copy nothing
972
revision_id = br_from.last_revision()
973
if to_location is None:
974
to_location = urlutils.derive_to_location(from_location)
975
to_transport = transport.get_transport(to_location)
977
to_transport.mkdir('.')
978
except errors.FileExists:
979
raise errors.BzrCommandError('Target directory "%s" already'
980
' exists.' % to_location)
981
except errors.NoSuchFile:
982
raise errors.BzrCommandError('Parent of "%s" does not exist.'
985
# preserve whatever source format we have.
986
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
987
possible_transports=[to_transport],
988
accelerator_tree=accelerator_tree,
989
hardlink=hardlink, stacked=stacked,
990
force_new_repo=standalone,
991
source_branch=br_from)
992
branch = dir.open_branch()
993
except errors.NoSuchRevision:
994
to_transport.delete_tree('.')
995
msg = "The branch %s has no revision %s." % (from_location,
997
raise errors.BzrCommandError(msg)
998
_merge_tags_if_possible(br_from, branch)
999
# If the source branch is stacked, the new branch may
1000
# be stacked whether we asked for that explicitly or not.
1001
# We therefore need a try/except here and not just 'if stacked:'
1003
note('Created new stacked branch referring to %s.' %
1004
branch.get_stacked_on_url())
1005
except (errors.NotStacked, errors.UnstackableBranchFormat,
1006
errors.UnstackableRepositoryFormat), e:
1007
note('Branched %d revision(s).' % branch.revno())
1012
class cmd_checkout(Command):
1013
"""Create a new checkout of an existing branch.
1015
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1016
the branch found in '.'. This is useful if you have removed the working tree
1017
or if it was never created - i.e. if you pushed the branch to its current
1018
location using SFTP.
1020
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1021
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1022
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1023
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1024
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1027
To retrieve the branch as of a particular revision, supply the --revision
1028
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1029
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1033
_see_also = ['checkouts', 'branch']
1034
takes_args = ['branch_location?', 'to_location?']
1035
takes_options = ['revision',
1036
Option('lightweight',
1037
help="Perform a lightweight checkout. Lightweight "
1038
"checkouts depend on access to the branch for "
1039
"every operation. Normal checkouts can perform "
1040
"common operations like diff and status without "
1041
"such access, and also support local commits."
1043
Option('files-from', type=str,
1044
help="Get file contents from this tree."),
1046
help='Hard-link working tree files where possible.'
1051
def run(self, branch_location=None, to_location=None, revision=None,
1052
lightweight=False, files_from=None, hardlink=False):
1053
if revision is None:
1055
elif len(revision) > 1:
1056
raise errors.BzrCommandError(
1057
'bzr checkout --revision takes exactly 1 revision value')
1058
if branch_location is None:
1059
branch_location = osutils.getcwd()
1060
to_location = branch_location
1061
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1063
if files_from is not None:
1064
accelerator_tree = WorkingTree.open(files_from)
1065
if len(revision) == 1 and revision[0] is not None:
1066
revision_id = revision[0].as_revision_id(source)
1069
if to_location is None:
1070
to_location = urlutils.derive_to_location(branch_location)
1071
# if the source and to_location are the same,
1072
# and there is no working tree,
1073
# then reconstitute a branch
1074
if (osutils.abspath(to_location) ==
1075
osutils.abspath(branch_location)):
1077
source.bzrdir.open_workingtree()
1078
except errors.NoWorkingTree:
1079
source.bzrdir.create_workingtree(revision_id)
1081
source.create_checkout(to_location, revision_id, lightweight,
1082
accelerator_tree, hardlink)
1085
class cmd_renames(Command):
1086
"""Show list of renamed files.
1088
# TODO: Option to show renames between two historical versions.
1090
# TODO: Only show renames under dir, rather than in the whole branch.
1091
_see_also = ['status']
1092
takes_args = ['dir?']
1095
def run(self, dir=u'.'):
1096
tree = WorkingTree.open_containing(dir)[0]
1099
new_inv = tree.inventory
1100
old_tree = tree.basis_tree()
1101
old_tree.lock_read()
1103
old_inv = old_tree.inventory
1105
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1106
for f, paths, c, v, p, n, k, e in iterator:
1107
if paths[0] == paths[1]:
1111
renames.append(paths)
1113
for old_name, new_name in renames:
1114
self.outf.write("%s => %s\n" % (old_name, new_name))
1121
class cmd_update(Command):
1122
"""Update a tree to have the latest code committed to its branch.
1124
This will perform a merge into the working tree, and may generate
1125
conflicts. If you have any local changes, you will still
1126
need to commit them after the update for the update to be complete.
1128
If you want to discard your local changes, you can just do a
1129
'bzr revert' instead of 'bzr commit' after the update.
1132
_see_also = ['pull', 'working-trees', 'status-flags']
1133
takes_args = ['dir?']
1136
def run(self, dir='.'):
1137
tree = WorkingTree.open_containing(dir)[0]
1138
possible_transports = []
1139
master = tree.branch.get_master_branch(
1140
possible_transports=possible_transports)
1141
if master is not None:
1144
tree.lock_tree_write()
1146
existing_pending_merges = tree.get_parent_ids()[1:]
1147
last_rev = _mod_revision.ensure_null(tree.last_revision())
1148
if last_rev == _mod_revision.ensure_null(
1149
tree.branch.last_revision()):
1150
# may be up to date, check master too.
1151
if master is None or last_rev == _mod_revision.ensure_null(
1152
master.last_revision()):
1153
revno = tree.branch.revision_id_to_revno(last_rev)
1154
note("Tree is up to date at revision %d." % (revno,))
1156
conflicts = tree.update(
1157
delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1158
possible_transports=possible_transports)
1159
revno = tree.branch.revision_id_to_revno(
1160
_mod_revision.ensure_null(tree.last_revision()))
1161
note('Updated to revision %d.' % (revno,))
1162
if tree.get_parent_ids()[1:] != existing_pending_merges:
1163
note('Your local commits will now show as pending merges with '
1164
"'bzr status', and can be committed with 'bzr commit'.")
1173
class cmd_info(Command):
1174
"""Show information about a working tree, branch or repository.
1176
This command will show all known locations and formats associated to the
1177
tree, branch or repository. Statistical information is included with
1180
Branches and working trees will also report any missing revisions.
1182
_see_also = ['revno', 'working-trees', 'repositories']
1183
takes_args = ['location?']
1184
takes_options = ['verbose']
1185
encoding_type = 'replace'
1188
def run(self, location=None, verbose=False):
1193
from bzrlib.info import show_bzrdir_info
1194
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1195
verbose=noise_level, outfile=self.outf)
1198
class cmd_remove(Command):
1199
"""Remove files or directories.
1201
This makes bzr stop tracking changes to the specified files. bzr will delete
1202
them if they can easily be recovered using revert. If no options or
1203
parameters are given bzr will scan for files that are being tracked by bzr
1204
but missing in your tree and stop tracking them for you.
1206
takes_args = ['file*']
1207
takes_options = ['verbose',
1208
Option('new', help='Only remove files that have never been committed.'),
1209
RegistryOption.from_kwargs('file-deletion-strategy',
1210
'The file deletion mode to be used.',
1211
title='Deletion Strategy', value_switches=True, enum_switch=False,
1212
safe='Only delete files if they can be'
1213
' safely recovered (default).',
1214
keep="Don't delete any files.",
1215
force='Delete all the specified files, even if they can not be '
1216
'recovered and even if they are non-empty directories.')]
1217
aliases = ['rm', 'del']
1218
encoding_type = 'replace'
1220
def run(self, file_list, verbose=False, new=False,
1221
file_deletion_strategy='safe'):
1222
tree, file_list = tree_files(file_list)
1224
if file_list is not None:
1225
file_list = [f for f in file_list]
1229
# Heuristics should probably all move into tree.remove_smart or
1232
added = tree.changes_from(tree.basis_tree(),
1233
specific_files=file_list).added
1234
file_list = sorted([f[0] for f in added], reverse=True)
1235
if len(file_list) == 0:
1236
raise errors.BzrCommandError('No matching files.')
1237
elif file_list is None:
1238
# missing files show up in iter_changes(basis) as
1239
# versioned-with-no-kind.
1241
for change in tree.iter_changes(tree.basis_tree()):
1242
# Find paths in the working tree that have no kind:
1243
if change[1][1] is not None and change[6][1] is None:
1244
missing.append(change[1][1])
1245
file_list = sorted(missing, reverse=True)
1246
file_deletion_strategy = 'keep'
1247
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1248
keep_files=file_deletion_strategy=='keep',
1249
force=file_deletion_strategy=='force')
1254
class cmd_file_id(Command):
1255
"""Print file_id of a particular file or directory.
1257
The file_id is assigned when the file is first added and remains the
1258
same through all revisions where the file exists, even when it is
1263
_see_also = ['inventory', 'ls']
1264
takes_args = ['filename']
1267
def run(self, filename):
1268
tree, relpath = WorkingTree.open_containing(filename)
1269
i = tree.path2id(relpath)
1271
raise errors.NotVersionedError(filename)
1273
self.outf.write(i + '\n')
1276
class cmd_file_path(Command):
1277
"""Print path of file_ids to a file or directory.
1279
This prints one line for each directory down to the target,
1280
starting at the branch root.
1284
takes_args = ['filename']
1287
def run(self, filename):
1288
tree, relpath = WorkingTree.open_containing(filename)
1289
fid = tree.path2id(relpath)
1291
raise errors.NotVersionedError(filename)
1292
segments = osutils.splitpath(relpath)
1293
for pos in range(1, len(segments) + 1):
1294
path = osutils.joinpath(segments[:pos])
1295
self.outf.write("%s\n" % tree.path2id(path))
1298
class cmd_reconcile(Command):
1299
"""Reconcile bzr metadata in a branch.
1301
This can correct data mismatches that may have been caused by
1302
previous ghost operations or bzr upgrades. You should only
1303
need to run this command if 'bzr check' or a bzr developer
1304
advises you to run it.
1306
If a second branch is provided, cross-branch reconciliation is
1307
also attempted, which will check that data like the tree root
1308
id which was not present in very early bzr versions is represented
1309
correctly in both branches.
1311
At the same time it is run it may recompress data resulting in
1312
a potential saving in disk space or performance gain.
1314
The branch *MUST* be on a listable system such as local disk or sftp.
1317
_see_also = ['check']
1318
takes_args = ['branch?']
1320
def run(self, branch="."):
1321
from bzrlib.reconcile import reconcile
1322
dir = bzrdir.BzrDir.open(branch)
1326
class cmd_revision_history(Command):
1327
"""Display the list of revision ids on a branch."""
1330
takes_args = ['location?']
1335
def run(self, location="."):
1336
branch = Branch.open_containing(location)[0]
1337
for revid in branch.revision_history():
1338
self.outf.write(revid)
1339
self.outf.write('\n')
1342
class cmd_ancestry(Command):
1343
"""List all revisions merged into this branch."""
1345
_see_also = ['log', 'revision-history']
1346
takes_args = ['location?']
1351
def run(self, location="."):
1353
wt = WorkingTree.open_containing(location)[0]
1354
except errors.NoWorkingTree:
1355
b = Branch.open(location)
1356
last_revision = b.last_revision()
1359
last_revision = wt.last_revision()
1361
revision_ids = b.repository.get_ancestry(last_revision)
1363
for revision_id in revision_ids:
1364
self.outf.write(revision_id + '\n')
1367
class cmd_init(Command):
1368
"""Make a directory into a versioned branch.
1370
Use this to create an empty branch, or before importing an
1373
If there is a repository in a parent directory of the location, then
1374
the history of the branch will be stored in the repository. Otherwise
1375
init creates a standalone branch which carries its own history
1376
in the .bzr directory.
1378
If there is already a branch at the location but it has no working tree,
1379
the tree can be populated with 'bzr checkout'.
1381
Recipe for importing a tree of files::
1387
bzr commit -m "imported project"
1390
_see_also = ['init-repository', 'branch', 'checkout']
1391
takes_args = ['location?']
1393
Option('create-prefix',
1394
help='Create the path leading up to the branch '
1395
'if it does not already exist.'),
1396
RegistryOption('format',
1397
help='Specify a format for this branch. '
1398
'See "help formats".',
1399
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1400
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1401
value_switches=True,
1402
title="Branch Format",
1404
Option('append-revisions-only',
1405
help='Never change revnos or the existing log.'
1406
' Append revisions to it only.')
1408
def run(self, location=None, format=None, append_revisions_only=False,
1409
create_prefix=False):
1411
format = bzrdir.format_registry.make_bzrdir('default')
1412
if location is None:
1415
to_transport = transport.get_transport(location)
1417
# The path has to exist to initialize a
1418
# branch inside of it.
1419
# Just using os.mkdir, since I don't
1420
# believe that we want to create a bunch of
1421
# locations if the user supplies an extended path
1423
to_transport.ensure_base()
1424
except errors.NoSuchFile:
1425
if not create_prefix:
1426
raise errors.BzrCommandError("Parent directory of %s"
1428
"\nYou may supply --create-prefix to create all"
1429
" leading parent directories."
1431
_create_prefix(to_transport)
1434
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1435
except errors.NotBranchError:
1436
# really a NotBzrDir error...
1437
create_branch = bzrdir.BzrDir.create_branch_convenience
1438
branch = create_branch(to_transport.base, format=format,
1439
possible_transports=[to_transport])
1440
a_bzrdir = branch.bzrdir
1442
from bzrlib.transport.local import LocalTransport
1443
if a_bzrdir.has_branch():
1444
if (isinstance(to_transport, LocalTransport)
1445
and not a_bzrdir.has_workingtree()):
1446
raise errors.BranchExistsWithoutWorkingTree(location)
1447
raise errors.AlreadyBranchError(location)
1448
branch = a_bzrdir.create_branch()
1449
a_bzrdir.create_workingtree()
1450
if append_revisions_only:
1452
branch.set_append_revisions_only(True)
1453
except errors.UpgradeRequired:
1454
raise errors.BzrCommandError('This branch format cannot be set'
1455
' to append-revisions-only. Try --experimental-branch6')
1457
from bzrlib.info import show_bzrdir_info
1458
show_bzrdir_info(a_bzrdir, verbose=0, outfile=self.outf)
1461
class cmd_init_repository(Command):
1462
"""Create a shared repository to hold branches.
1464
New branches created under the repository directory will store their
1465
revisions in the repository, not in the branch directory.
1467
If the --no-trees option is used then the branches in the repository
1468
will not have working trees by default.
1471
Create a shared repositories holding just branches::
1473
bzr init-repo --no-trees repo
1476
Make a lightweight checkout elsewhere::
1478
bzr checkout --lightweight repo/trunk trunk-checkout
1483
_see_also = ['init', 'branch', 'checkout', 'repositories']
1484
takes_args = ["location"]
1485
takes_options = [RegistryOption('format',
1486
help='Specify a format for this repository. See'
1487
' "bzr help formats" for details.',
1488
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1489
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1490
value_switches=True, title='Repository format'),
1492
help='Branches in the repository will default to'
1493
' not having a working tree.'),
1495
aliases = ["init-repo"]
1497
def run(self, location, format=None, no_trees=False):
1499
format = bzrdir.format_registry.make_bzrdir('default')
1501
if location is None:
1504
to_transport = transport.get_transport(location)
1505
to_transport.ensure_base()
1507
newdir = format.initialize_on_transport(to_transport)
1508
repo = newdir.create_repository(shared=True)
1509
repo.set_make_working_trees(not no_trees)
1511
from bzrlib.info import show_bzrdir_info
1512
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1515
class cmd_diff(Command):
1516
"""Show differences in the working tree, between revisions or branches.
1518
If no arguments are given, all changes for the current tree are listed.
1519
If files are given, only the changes in those files are listed.
1520
Remote and multiple branches can be compared by using the --old and
1521
--new options. If not provided, the default for both is derived from
1522
the first argument, if any, or the current tree if no arguments are
1525
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1526
produces patches suitable for "patch -p1".
1530
2 - unrepresentable changes
1535
Shows the difference in the working tree versus the last commit::
1539
Difference between the working tree and revision 1::
1543
Difference between revision 2 and revision 1::
1547
Difference between revision 2 and revision 1 for branch xxx::
1551
Show just the differences for file NEWS::
1555
Show the differences in working tree xxx for file NEWS::
1559
Show the differences from branch xxx to this working tree:
1563
Show the differences between two branches for file NEWS::
1565
bzr diff --old xxx --new yyy NEWS
1567
Same as 'bzr diff' but prefix paths with old/ and new/::
1569
bzr diff --prefix old/:new/
1571
_see_also = ['status']
1572
takes_args = ['file*']
1574
Option('diff-options', type=str,
1575
help='Pass these options to the external diff program.'),
1576
Option('prefix', type=str,
1578
help='Set prefixes added to old and new filenames, as '
1579
'two values separated by a colon. (eg "old/:new/").'),
1581
help='Branch/tree to compare from.',
1585
help='Branch/tree to compare to.',
1591
help='Use this command to compare files.',
1595
aliases = ['di', 'dif']
1596
encoding_type = 'exact'
1599
def run(self, revision=None, file_list=None, diff_options=None,
1600
prefix=None, old=None, new=None, using=None):
1601
from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1603
if (prefix is None) or (prefix == '0'):
1611
old_label, new_label = prefix.split(":")
1613
raise errors.BzrCommandError(
1614
'--prefix expects two values separated by a colon'
1615
' (eg "old/:new/")')
1617
if revision and len(revision) > 2:
1618
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1619
' one or two revision specifiers')
1621
old_tree, new_tree, specific_files, extra_trees = \
1622
_get_trees_to_diff(file_list, revision, old, new)
1623
return show_diff_trees(old_tree, new_tree, sys.stdout,
1624
specific_files=specific_files,
1625
external_diff_options=diff_options,
1626
old_label=old_label, new_label=new_label,
1627
extra_trees=extra_trees, using=using)
1630
class cmd_deleted(Command):
1631
"""List files deleted in the working tree.
1633
# TODO: Show files deleted since a previous revision, or
1634
# between two revisions.
1635
# TODO: Much more efficient way to do this: read in new
1636
# directories with readdir, rather than stating each one. Same
1637
# level of effort but possibly much less IO. (Or possibly not,
1638
# if the directories are very large...)
1639
_see_also = ['status', 'ls']
1640
takes_options = ['show-ids']
1643
def run(self, show_ids=False):
1644
tree = WorkingTree.open_containing(u'.')[0]
1647
old = tree.basis_tree()
1650
for path, ie in old.inventory.iter_entries():
1651
if not tree.has_id(ie.file_id):
1652
self.outf.write(path)
1654
self.outf.write(' ')
1655
self.outf.write(ie.file_id)
1656
self.outf.write('\n')
1663
class cmd_modified(Command):
1664
"""List files modified in working tree.
1668
_see_also = ['status', 'ls']
1671
help='Write an ascii NUL (\\0) separator '
1672
'between files rather than a newline.')
1676
def run(self, null=False):
1677
tree = WorkingTree.open_containing(u'.')[0]
1678
td = tree.changes_from(tree.basis_tree())
1679
for path, id, kind, text_modified, meta_modified in td.modified:
1681
self.outf.write(path + '\0')
1683
self.outf.write(osutils.quotefn(path) + '\n')
1686
class cmd_added(Command):
1687
"""List files added in working tree.
1691
_see_also = ['status', 'ls']
1694
help='Write an ascii NUL (\\0) separator '
1695
'between files rather than a newline.')
1699
def run(self, null=False):
1700
wt = WorkingTree.open_containing(u'.')[0]
1703
basis = wt.basis_tree()
1706
basis_inv = basis.inventory
1709
if file_id in basis_inv:
1711
if inv.is_root(file_id) and len(basis_inv) == 0:
1713
path = inv.id2path(file_id)
1714
if not os.access(osutils.abspath(path), os.F_OK):
1717
self.outf.write(path + '\0')
1719
self.outf.write(osutils.quotefn(path) + '\n')
1726
class cmd_root(Command):
1727
"""Show the tree root directory.
1729
The root is the nearest enclosing directory with a .bzr control
1732
takes_args = ['filename?']
1734
def run(self, filename=None):
1735
"""Print the branch root."""
1736
tree = WorkingTree.open_containing(filename)[0]
1737
self.outf.write(tree.basedir + '\n')
1740
def _parse_limit(limitstring):
1742
return int(limitstring)
1744
msg = "The limit argument must be an integer."
1745
raise errors.BzrCommandError(msg)
1748
class cmd_log(Command):
1749
"""Show log of a branch, file, or directory.
1751
By default show the log of the branch containing the working directory.
1753
To request a range of logs, you can use the command -r begin..end
1754
-r revision requests a specific revision, -r ..end or -r begin.. are
1758
Log the current branch::
1766
Log the last 10 revisions of a branch::
1768
bzr log -r -10.. http://server/branch
1771
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1773
takes_args = ['location?']
1776
help='Show from oldest to newest.'),
1778
custom_help('verbose',
1779
help='Show files changed in each revision.'),
1783
type=bzrlib.option._parse_revision_str,
1785
help='Show just the specified revision.'
1786
' See also "help revisionspec".'),
1790
help='Show revisions whose message matches this '
1791
'regular expression.',
1795
help='Limit the output to the first N revisions.',
1799
encoding_type = 'replace'
1802
def run(self, location=None, timezone='original',
1811
from bzrlib.log import show_log
1812
direction = (forward and 'forward') or 'reverse'
1814
if change is not None:
1816
raise errors.RangeInChangeOption()
1817
if revision is not None:
1818
raise errors.BzrCommandError(
1819
'--revision and --change are mutually exclusive')
1826
# find the file id to log:
1828
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1832
tree = b.basis_tree()
1833
file_id = tree.path2id(fp)
1835
raise errors.BzrCommandError(
1836
"Path does not have any revision history: %s" %
1840
# FIXME ? log the current subdir only RBC 20060203
1841
if revision is not None \
1842
and len(revision) > 0 and revision[0].get_branch():
1843
location = revision[0].get_branch()
1846
dir, relpath = bzrdir.BzrDir.open_containing(location)
1847
b = dir.open_branch()
1851
if revision is None:
1854
elif len(revision) == 1:
1855
rev1 = rev2 = revision[0].in_history(b)
1856
elif len(revision) == 2:
1857
if revision[1].get_branch() != revision[0].get_branch():
1858
# b is taken from revision[0].get_branch(), and
1859
# show_log will use its revision_history. Having
1860
# different branches will lead to weird behaviors.
1861
raise errors.BzrCommandError(
1862
"Log doesn't accept two revisions in different"
1864
rev1 = revision[0].in_history(b)
1865
rev2 = revision[1].in_history(b)
1867
raise errors.BzrCommandError(
1868
'bzr log --revision takes one or two values.')
1870
if log_format is None:
1871
log_format = log.log_formatter_registry.get_default(b)
1873
lf = log_format(show_ids=show_ids, to_file=self.outf,
1874
show_timezone=timezone,
1875
delta_format=get_verbosity_level())
1881
direction=direction,
1882
start_revision=rev1,
1890
def get_log_format(long=False, short=False, line=False, default='long'):
1891
log_format = default
1895
log_format = 'short'
1901
class cmd_touching_revisions(Command):
1902
"""Return revision-ids which affected a particular file.
1904
A more user-friendly interface is "bzr log FILE".
1908
takes_args = ["filename"]
1911
def run(self, filename):
1912
tree, relpath = WorkingTree.open_containing(filename)
1914
file_id = tree.path2id(relpath)
1915
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1916
self.outf.write("%6d %s\n" % (revno, what))
1919
class cmd_ls(Command):
1920
"""List files in a tree.
1923
_see_also = ['status', 'cat']
1924
takes_args = ['path?']
1925
# TODO: Take a revision or remote path and list that tree instead.
1929
Option('non-recursive',
1930
help='Don\'t recurse into subdirectories.'),
1932
help='Print paths relative to the root of the branch.'),
1933
Option('unknown', help='Print unknown files.'),
1934
Option('versioned', help='Print versioned files.',
1936
Option('ignored', help='Print ignored files.'),
1938
help='Write an ascii NUL (\\0) separator '
1939
'between files rather than a newline.'),
1941
help='List entries of a particular kind: file, directory, symlink.',
1946
def run(self, revision=None, verbose=False,
1947
non_recursive=False, from_root=False,
1948
unknown=False, versioned=False, ignored=False,
1949
null=False, kind=None, show_ids=False, path=None):
1951
if kind and kind not in ('file', 'directory', 'symlink'):
1952
raise errors.BzrCommandError('invalid kind specified')
1954
if verbose and null:
1955
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1956
all = not (unknown or versioned or ignored)
1958
selection = {'I':ignored, '?':unknown, 'V':versioned}
1965
raise errors.BzrCommandError('cannot specify both --from-root'
1969
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1975
if revision is not None or tree is None:
1976
tree = _get_one_revision_tree('ls', revision, branch=branch)
1980
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1981
if fp.startswith(relpath):
1982
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1983
if non_recursive and '/' in fp:
1985
if not all and not selection[fc]:
1987
if kind is not None and fkind != kind:
1989
kindch = entry.kind_character()
1990
outstring = fp + kindch
1992
outstring = '%-8s %s' % (fc, outstring)
1993
if show_ids and fid is not None:
1994
outstring = "%-50s %s" % (outstring, fid)
1995
self.outf.write(outstring + '\n')
1997
self.outf.write(fp + '\0')
2000
self.outf.write(fid)
2001
self.outf.write('\0')
2009
self.outf.write('%-50s %s\n' % (outstring, my_id))
2011
self.outf.write(outstring + '\n')
2016
class cmd_unknowns(Command):
2017
"""List unknown files.
2025
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2026
self.outf.write(osutils.quotefn(f) + '\n')
2029
class cmd_ignore(Command):
2030
"""Ignore specified files or patterns.
2032
See ``bzr help patterns`` for details on the syntax of patterns.
2034
To remove patterns from the ignore list, edit the .bzrignore file.
2035
After adding, editing or deleting that file either indirectly by
2036
using this command or directly by using an editor, be sure to commit
2039
Note: ignore patterns containing shell wildcards must be quoted from
2043
Ignore the top level Makefile::
2045
bzr ignore ./Makefile
2047
Ignore class files in all directories::
2049
bzr ignore "*.class"
2051
Ignore .o files under the lib directory::
2053
bzr ignore "lib/**/*.o"
2055
Ignore .o files under the lib directory::
2057
bzr ignore "RE:lib/.*\.o"
2059
Ignore everything but the "debian" toplevel directory::
2061
bzr ignore "RE:(?!debian/).*"
2064
_see_also = ['status', 'ignored', 'patterns']
2065
takes_args = ['name_pattern*']
2067
Option('old-default-rules',
2068
help='Write out the ignore rules bzr < 0.9 always used.')
2071
def run(self, name_pattern_list=None, old_default_rules=None):
2072
from bzrlib import ignores
2073
if old_default_rules is not None:
2074
# dump the rules and exit
2075
for pattern in ignores.OLD_DEFAULTS:
2078
if not name_pattern_list:
2079
raise errors.BzrCommandError("ignore requires at least one "
2080
"NAME_PATTERN or --old-default-rules")
2081
name_pattern_list = [globbing.normalize_pattern(p)
2082
for p in name_pattern_list]
2083
for name_pattern in name_pattern_list:
2084
if (name_pattern[0] == '/' or
2085
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2086
raise errors.BzrCommandError(
2087
"NAME_PATTERN should not be an absolute path")
2088
tree, relpath = WorkingTree.open_containing(u'.')
2089
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2090
ignored = globbing.Globster(name_pattern_list)
2093
for entry in tree.list_files():
2097
if ignored.match(filename):
2098
matches.append(filename.encode('utf-8'))
2100
if len(matches) > 0:
2101
print "Warning: the following files are version controlled and" \
2102
" match your ignore pattern:\n%s" % ("\n".join(matches),)
2105
class cmd_ignored(Command):
2106
"""List ignored files and the patterns that matched them.
2108
List all the ignored files and the ignore pattern that caused the file to
2111
Alternatively, to list just the files::
2116
encoding_type = 'replace'
2117
_see_also = ['ignore', 'ls']
2121
tree = WorkingTree.open_containing(u'.')[0]
2124
for path, file_class, kind, file_id, entry in tree.list_files():
2125
if file_class != 'I':
2127
## XXX: Slightly inefficient since this was already calculated
2128
pat = tree.is_ignored(path)
2129
self.outf.write('%-50s %s\n' % (path, pat))
2134
class cmd_lookup_revision(Command):
2135
"""Lookup the revision-id from a revision-number
2138
bzr lookup-revision 33
2141
takes_args = ['revno']
2144
def run(self, revno):
2148
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2150
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2153
class cmd_export(Command):
2154
"""Export current or past revision to a destination directory or archive.
2156
If no revision is specified this exports the last committed revision.
2158
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2159
given, try to find the format with the extension. If no extension
2160
is found exports to a directory (equivalent to --format=dir).
2162
If root is supplied, it will be used as the root directory inside
2163
container formats (tar, zip, etc). If it is not supplied it will default
2164
to the exported filename. The root option has no effect for 'dir' format.
2166
If branch is omitted then the branch containing the current working
2167
directory will be used.
2169
Note: Export of tree with non-ASCII filenames to zip is not supported.
2171
================= =========================
2172
Supported formats Autodetected by extension
2173
================= =========================
2176
tbz2 .tar.bz2, .tbz2
2179
================= =========================
2181
takes_args = ['dest', 'branch_or_subdir?']
2184
help="Type of file to export to.",
2189
help="Name of the root directory inside the exported file."),
2191
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2193
from bzrlib.export import export
2195
if branch_or_subdir is None:
2196
tree = WorkingTree.open_containing(u'.')[0]
2200
b, subdir = Branch.open_containing(branch_or_subdir)
2203
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2205
export(rev_tree, dest, format, root, subdir)
2206
except errors.NoSuchExportFormat, e:
2207
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2210
class cmd_cat(Command):
2211
"""Write the contents of a file as of a given revision to standard output.
2213
If no revision is nominated, the last revision is used.
2215
Note: Take care to redirect standard output when using this command on a
2221
Option('name-from-revision', help='The path name in the old tree.'),
2224
takes_args = ['filename']
2225
encoding_type = 'exact'
2228
def run(self, filename, revision=None, name_from_revision=False):
2229
if revision is not None and len(revision) != 1:
2230
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2231
" one revision specifier")
2232
tree, branch, relpath = \
2233
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2236
return self._run(tree, branch, relpath, filename, revision,
2241
def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2243
tree = b.basis_tree()
2244
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2246
cur_file_id = tree.path2id(relpath)
2247
old_file_id = rev_tree.path2id(relpath)
2249
if name_from_revision:
2250
if old_file_id is None:
2251
raise errors.BzrCommandError(
2252
"%r is not present in revision %s" % (
2253
filename, rev_tree.get_revision_id()))
2255
content = rev_tree.get_file_text(old_file_id)
2256
elif cur_file_id is not None:
2257
content = rev_tree.get_file_text(cur_file_id)
2258
elif old_file_id is not None:
2259
content = rev_tree.get_file_text(old_file_id)
2261
raise errors.BzrCommandError(
2262
"%r is not present in revision %s" % (
2263
filename, rev_tree.get_revision_id()))
2264
self.outf.write(content)
2267
class cmd_local_time_offset(Command):
2268
"""Show the offset in seconds from GMT to local time."""
2272
print osutils.local_time_offset()
2276
class cmd_commit(Command):
2277
"""Commit changes into a new revision.
2279
If no arguments are given, the entire tree is committed.
2281
If selected files are specified, only changes to those files are
2282
committed. If a directory is specified then the directory and everything
2283
within it is committed.
2285
When excludes are given, they take precedence over selected files.
2286
For example, too commit only changes within foo, but not changes within
2289
bzr commit foo -x foo/bar
2291
If author of the change is not the same person as the committer, you can
2292
specify the author's name using the --author option. The name should be
2293
in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2295
A selected-file commit may fail in some cases where the committed
2296
tree would be invalid. Consider::
2301
bzr commit foo -m "committing foo"
2302
bzr mv foo/bar foo/baz
2305
bzr commit foo/bar -m "committing bar but not baz"
2307
In the example above, the last commit will fail by design. This gives
2308
the user the opportunity to decide whether they want to commit the
2309
rename at the same time, separately first, or not at all. (As a general
2310
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2312
Note: A selected-file commit after a merge is not yet supported.
2314
# TODO: Run hooks on tree to-be-committed, and after commit.
2316
# TODO: Strict commit that fails if there are deleted files.
2317
# (what does "deleted files" mean ??)
2319
# TODO: Give better message for -s, --summary, used by tla people
2321
# XXX: verbose currently does nothing
2323
_see_also = ['bugs', 'uncommit']
2324
takes_args = ['selected*']
2326
ListOption('exclude', type=str, short_name='x',
2327
help="Do not consider changes made to a given path."),
2328
Option('message', type=unicode,
2330
help="Description of the new revision."),
2333
help='Commit even if nothing has changed.'),
2334
Option('file', type=str,
2337
help='Take commit message from this file.'),
2339
help="Refuse to commit if there are unknown "
2340
"files in the working tree."),
2341
ListOption('fixes', type=str,
2342
help="Mark a bug as being fixed by this revision."),
2343
Option('author', type=unicode,
2344
help="Set the author's name, if it's different "
2345
"from the committer."),
2347
help="Perform a local commit in a bound "
2348
"branch. Local commits are not pushed to "
2349
"the master branch until a normal commit "
2353
help='When no message is supplied, show the diff along'
2354
' with the status summary in the message editor.'),
2356
aliases = ['ci', 'checkin']
2358
def _get_bug_fix_properties(self, fixes, branch):
2360
# Configure the properties for bug fixing attributes.
2361
for fixed_bug in fixes:
2362
tokens = fixed_bug.split(':')
2363
if len(tokens) != 2:
2364
raise errors.BzrCommandError(
2365
"Invalid bug %s. Must be in the form of 'tag:id'. "
2366
"Commit refused." % fixed_bug)
2367
tag, bug_id = tokens
2369
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2370
except errors.UnknownBugTrackerAbbreviation:
2371
raise errors.BzrCommandError(
2372
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2373
except errors.MalformedBugIdentifier:
2374
raise errors.BzrCommandError(
2375
"Invalid bug identifier for %s. Commit refused."
2377
properties.append('%s fixed' % bug_url)
2378
return '\n'.join(properties)
2380
def run(self, message=None, file=None, verbose=False, selected_list=None,
2381
unchanged=False, strict=False, local=False, fixes=None,
2382
author=None, show_diff=False, exclude=None):
2383
from bzrlib.errors import (
2388
from bzrlib.msgeditor import (
2389
edit_commit_message_encoded,
2390
generate_commit_message_template,
2391
make_commit_message_template_encoded
2394
# TODO: Need a blackbox test for invoking the external editor; may be
2395
# slightly problematic to run this cross-platform.
2397
# TODO: do more checks that the commit will succeed before
2398
# spending the user's valuable time typing a commit message.
2402
tree, selected_list = tree_files(selected_list)
2403
if selected_list == ['']:
2404
# workaround - commit of root of tree should be exactly the same
2405
# as just default commit in that tree, and succeed even though
2406
# selected-file merge commit is not done yet
2411
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2413
properties['bugs'] = bug_property
2415
if local and not tree.branch.get_bound_location():
2416
raise errors.LocalRequiresBoundBranch()
2418
def get_message(commit_obj):
2419
"""Callback to get commit message"""
2420
my_message = message
2421
if my_message is None and not file:
2422
t = make_commit_message_template_encoded(tree,
2423
selected_list, diff=show_diff,
2424
output_encoding=osutils.get_user_encoding())
2425
start_message = generate_commit_message_template(commit_obj)
2426
my_message = edit_commit_message_encoded(t,
2427
start_message=start_message)
2428
if my_message is None:
2429
raise errors.BzrCommandError("please specify a commit"
2430
" message with either --message or --file")
2431
elif my_message and file:
2432
raise errors.BzrCommandError(
2433
"please specify either --message or --file")
2435
my_message = codecs.open(file, 'rt',
2436
osutils.get_user_encoding()).read()
2437
if my_message == "":
2438
raise errors.BzrCommandError("empty commit message specified")
2442
tree.commit(message_callback=get_message,
2443
specific_files=selected_list,
2444
allow_pointless=unchanged, strict=strict, local=local,
2445
reporter=None, verbose=verbose, revprops=properties,
2447
exclude=safe_relpath_files(tree, exclude))
2448
except PointlessCommit:
2449
# FIXME: This should really happen before the file is read in;
2450
# perhaps prepare the commit; get the message; then actually commit
2451
raise errors.BzrCommandError("no changes to commit."
2452
" use --unchanged to commit anyhow")
2453
except ConflictsInTree:
2454
raise errors.BzrCommandError('Conflicts detected in working '
2455
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2457
except StrictCommitFailed:
2458
raise errors.BzrCommandError("Commit refused because there are"
2459
" unknown files in the working tree.")
2460
except errors.BoundBranchOutOfDate, e:
2461
raise errors.BzrCommandError(str(e) + "\n"
2462
'To commit to master branch, run update and then commit.\n'
2463
'You can also pass --local to commit to continue working '
2467
class cmd_check(Command):
2468
"""Validate working tree structure, branch consistency and repository history.
2470
This command checks various invariants about branch and repository storage
2471
to detect data corruption or bzr bugs.
2473
The working tree and branch checks will only give output if a problem is
2474
detected. The output fields of the repository check are:
2476
revisions: This is just the number of revisions checked. It doesn't
2478
versionedfiles: This is just the number of versionedfiles checked. It
2479
doesn't indicate a problem.
2480
unreferenced ancestors: Texts that are ancestors of other texts, but
2481
are not properly referenced by the revision ancestry. This is a
2482
subtle problem that Bazaar can work around.
2483
unique file texts: This is the total number of unique file contents
2484
seen in the checked revisions. It does not indicate a problem.
2485
repeated file texts: This is the total number of repeated texts seen
2486
in the checked revisions. Texts can be repeated when their file
2487
entries are modified, but the file contents are not. It does not
2490
If no restrictions are specified, all Bazaar data that is found at the given
2491
location will be checked.
2495
Check the tree and branch at 'foo'::
2497
bzr check --tree --branch foo
2499
Check only the repository at 'bar'::
2501
bzr check --repo bar
2503
Check everything at 'baz'::
2508
_see_also = ['reconcile']
2509
takes_args = ['path?']
2510
takes_options = ['verbose',
2511
Option('branch', help="Check the branch related to the"
2512
" current directory."),
2513
Option('repo', help="Check the repository related to the"
2514
" current directory."),
2515
Option('tree', help="Check the working tree related to"
2516
" the current directory.")]
2518
def run(self, path=None, verbose=False, branch=False, repo=False,
2520
from bzrlib.check import check_dwim
2523
if not branch and not repo and not tree:
2524
branch = repo = tree = True
2525
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
2528
class cmd_upgrade(Command):
2529
"""Upgrade branch storage to current format.
2531
The check command or bzr developers may sometimes advise you to run
2532
this command. When the default format has changed you may also be warned
2533
during other operations to upgrade.
2536
_see_also = ['check']
2537
takes_args = ['url?']
2539
RegistryOption('format',
2540
help='Upgrade to a specific format. See "bzr help'
2541
' formats" for details.',
2542
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
2543
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
2544
value_switches=True, title='Branch format'),
2547
def run(self, url='.', format=None):
2548
from bzrlib.upgrade import upgrade
2550
format = bzrdir.format_registry.make_bzrdir('default')
2551
upgrade(url, format)
2554
class cmd_whoami(Command):
2555
"""Show or set bzr user id.
2558
Show the email of the current user::
2562
Set the current user::
2564
bzr whoami "Frank Chu <fchu@example.com>"
2566
takes_options = [ Option('email',
2567
help='Display email address only.'),
2569
help='Set identity for the current branch instead of '
2572
takes_args = ['name?']
2573
encoding_type = 'replace'
2576
def run(self, email=False, branch=False, name=None):
2578
# use branch if we're inside one; otherwise global config
2580
c = Branch.open_containing('.')[0].get_config()
2581
except errors.NotBranchError:
2582
c = config.GlobalConfig()
2584
self.outf.write(c.user_email() + '\n')
2586
self.outf.write(c.username() + '\n')
2589
# display a warning if an email address isn't included in the given name.
2591
config.extract_email_address(name)
2592
except errors.NoEmailInUsername, e:
2593
warning('"%s" does not seem to contain an email address. '
2594
'This is allowed, but not recommended.', name)
2596
# use global config unless --branch given
2598
c = Branch.open_containing('.')[0].get_config()
2600
c = config.GlobalConfig()
2601
c.set_user_option('email', name)
2604
class cmd_nick(Command):
2605
"""Print or set the branch nickname.
2607
If unset, the tree root directory name is used as the nickname.
2608
To print the current nickname, execute with no argument.
2610
Bound branches use the nickname of its master branch unless it is set
2614
_see_also = ['info']
2615
takes_args = ['nickname?']
2616
def run(self, nickname=None):
2617
branch = Branch.open_containing(u'.')[0]
2618
if nickname is None:
2619
self.printme(branch)
2621
branch.nick = nickname
2624
def printme(self, branch):
2628
class cmd_alias(Command):
2629
"""Set/unset and display aliases.
2632
Show the current aliases::
2636
Show the alias specified for 'll'::
2640
Set an alias for 'll'::
2642
bzr alias ll="log --line -r-10..-1"
2644
To remove an alias for 'll'::
2646
bzr alias --remove ll
2649
takes_args = ['name?']
2651
Option('remove', help='Remove the alias.'),
2654
def run(self, name=None, remove=False):
2656
self.remove_alias(name)
2658
self.print_aliases()
2660
equal_pos = name.find('=')
2662
self.print_alias(name)
2664
self.set_alias(name[:equal_pos], name[equal_pos+1:])
2666
def remove_alias(self, alias_name):
2667
if alias_name is None:
2668
raise errors.BzrCommandError(
2669
'bzr alias --remove expects an alias to remove.')
2670
# If alias is not found, print something like:
2671
# unalias: foo: not found
2672
c = config.GlobalConfig()
2673
c.unset_alias(alias_name)
2676
def print_aliases(self):
2677
"""Print out the defined aliases in a similar format to bash."""
2678
aliases = config.GlobalConfig().get_aliases()
2679
for key, value in sorted(aliases.iteritems()):
2680
self.outf.write('bzr alias %s="%s"\n' % (key, value))
2683
def print_alias(self, alias_name):
2684
from bzrlib.commands import get_alias
2685
alias = get_alias(alias_name)
2687
self.outf.write("bzr alias: %s: not found\n" % alias_name)
2690
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
2692
def set_alias(self, alias_name, alias_command):
2693
"""Save the alias in the global config."""
2694
c = config.GlobalConfig()
2695
c.set_alias(alias_name, alias_command)
2698
class cmd_selftest(Command):
2699
"""Run internal test suite.
2701
If arguments are given, they are regular expressions that say which tests
2702
should run. Tests matching any expression are run, and other tests are
2705
Alternatively if --first is given, matching tests are run first and then
2706
all other tests are run. This is useful if you have been working in a
2707
particular area, but want to make sure nothing else was broken.
2709
If --exclude is given, tests that match that regular expression are
2710
excluded, regardless of whether they match --first or not.
2712
To help catch accidential dependencies between tests, the --randomize
2713
option is useful. In most cases, the argument used is the word 'now'.
2714
Note that the seed used for the random number generator is displayed
2715
when this option is used. The seed can be explicitly passed as the
2716
argument to this option if required. This enables reproduction of the
2717
actual ordering used if and when an order sensitive problem is encountered.
2719
If --list-only is given, the tests that would be run are listed. This is
2720
useful when combined with --first, --exclude and/or --randomize to
2721
understand their impact. The test harness reports "Listed nn tests in ..."
2722
instead of "Ran nn tests in ..." when list mode is enabled.
2724
If the global option '--no-plugins' is given, plugins are not loaded
2725
before running the selftests. This has two effects: features provided or
2726
modified by plugins will not be tested, and tests provided by plugins will
2729
Tests that need working space on disk use a common temporary directory,
2730
typically inside $TMPDIR or /tmp.
2733
Run only tests relating to 'ignore'::
2737
Disable plugins and list tests as they're run::
2739
bzr --no-plugins selftest -v
2741
# NB: this is used from the class without creating an instance, which is
2742
# why it does not have a self parameter.
2743
def get_transport_type(typestring):
2744
"""Parse and return a transport specifier."""
2745
if typestring == "sftp":
2746
from bzrlib.transport.sftp import SFTPAbsoluteServer
2747
return SFTPAbsoluteServer
2748
if typestring == "memory":
2749
from bzrlib.transport.memory import MemoryServer
2751
if typestring == "fakenfs":
2752
from bzrlib.transport.fakenfs import FakeNFSServer
2753
return FakeNFSServer
2754
msg = "No known transport type %s. Supported types are: sftp\n" %\
2756
raise errors.BzrCommandError(msg)
2759
takes_args = ['testspecs*']
2760
takes_options = ['verbose',
2762
help='Stop when one test fails.',
2766
help='Use a different transport by default '
2767
'throughout the test suite.',
2768
type=get_transport_type),
2770
help='Run the benchmarks rather than selftests.'),
2771
Option('lsprof-timed',
2772
help='Generate lsprof output for benchmarked'
2773
' sections of code.'),
2774
Option('cache-dir', type=str,
2775
help='Cache intermediate benchmark output in this '
2778
help='Run all tests, but run specified tests first.',
2782
help='List the tests instead of running them.'),
2783
Option('randomize', type=str, argname="SEED",
2784
help='Randomize the order of tests using the given'
2785
' seed or "now" for the current time.'),
2786
Option('exclude', type=str, argname="PATTERN",
2788
help='Exclude tests that match this regular'
2790
Option('strict', help='Fail on missing dependencies or '
2792
Option('load-list', type=str, argname='TESTLISTFILE',
2793
help='Load a test id list from a text file.'),
2794
ListOption('debugflag', type=str, short_name='E',
2795
help='Turn on a selftest debug flag.'),
2796
ListOption('starting-with', type=str, argname='TESTID',
2797
param_name='starting_with', short_name='s',
2799
'Load only the tests starting with TESTID.'),
2801
encoding_type = 'replace'
2803
def run(self, testspecs_list=None, verbose=False, one=False,
2804
transport=None, benchmark=None,
2805
lsprof_timed=None, cache_dir=None,
2806
first=False, list_only=False,
2807
randomize=None, exclude=None, strict=False,
2808
load_list=None, debugflag=None, starting_with=None):
2809
from bzrlib.tests import selftest
2810
import bzrlib.benchmarks as benchmarks
2811
from bzrlib.benchmarks import tree_creator
2813
# Make deprecation warnings visible, unless -Werror is set
2814
symbol_versioning.activate_deprecation_warnings(override=False)
2816
if cache_dir is not None:
2817
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2819
print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2820
print ' %s (%s python%s)' % (
2822
bzrlib.version_string,
2823
bzrlib._format_version_tuple(sys.version_info),
2826
if testspecs_list is not None:
2827
pattern = '|'.join(testspecs_list)
2831
test_suite_factory = benchmarks.test_suite
2832
# Unless user explicitly asks for quiet, be verbose in benchmarks
2833
verbose = not is_quiet()
2834
# TODO: should possibly lock the history file...
2835
benchfile = open(".perf_history", "at", buffering=1)
2837
test_suite_factory = None
2840
result = selftest(verbose=verbose,
2842
stop_on_failure=one,
2843
transport=transport,
2844
test_suite_factory=test_suite_factory,
2845
lsprof_timed=lsprof_timed,
2846
bench_history=benchfile,
2847
matching_tests_first=first,
2848
list_only=list_only,
2849
random_seed=randomize,
2850
exclude_pattern=exclude,
2852
load_list=load_list,
2853
debug_flags=debugflag,
2854
starting_with=starting_with,
2857
if benchfile is not None:
2860
note('tests passed')
2862
note('tests failed')
2863
return int(not result)
2866
class cmd_version(Command):
2867
"""Show version of bzr."""
2869
encoding_type = 'replace'
2871
Option("short", help="Print just the version number."),
2875
def run(self, short=False):
2876
from bzrlib.version import show_version
2878
self.outf.write(bzrlib.version_string + '\n')
2880
show_version(to_file=self.outf)
2883
class cmd_rocks(Command):
2884
"""Statement of optimism."""
2890
print "It sure does!"
2893
class cmd_find_merge_base(Command):
2894
"""Find and print a base revision for merging two branches."""
2895
# TODO: Options to specify revisions on either side, as if
2896
# merging only part of the history.
2897
takes_args = ['branch', 'other']
2901
def run(self, branch, other):
2902
from bzrlib.revision import ensure_null
2904
branch1 = Branch.open_containing(branch)[0]
2905
branch2 = Branch.open_containing(other)[0]
2910
last1 = ensure_null(branch1.last_revision())
2911
last2 = ensure_null(branch2.last_revision())
2913
graph = branch1.repository.get_graph(branch2.repository)
2914
base_rev_id = graph.find_unique_lca(last1, last2)
2916
print 'merge base is revision %s' % base_rev_id
2923
class cmd_merge(Command):
2924
"""Perform a three-way merge.
2926
The source of the merge can be specified either in the form of a branch,
2927
or in the form of a path to a file containing a merge directive generated
2928
with bzr send. If neither is specified, the default is the upstream branch
2929
or the branch most recently merged using --remember.
2931
When merging a branch, by default the tip will be merged. To pick a different
2932
revision, pass --revision. If you specify two values, the first will be used as
2933
BASE and the second one as OTHER. Merging individual revisions, or a subset of
2934
available revisions, like this is commonly referred to as "cherrypicking".
2936
Revision numbers are always relative to the branch being merged.
2938
By default, bzr will try to merge in all new work from the other
2939
branch, automatically determining an appropriate base. If this
2940
fails, you may need to give an explicit base.
2942
Merge will do its best to combine the changes in two branches, but there
2943
are some kinds of problems only a human can fix. When it encounters those,
2944
it will mark a conflict. A conflict means that you need to fix something,
2945
before you should commit.
2947
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2949
If there is no default branch set, the first merge will set it. After
2950
that, you can omit the branch to use the default. To change the
2951
default, use --remember. The value will only be saved if the remote
2952
location can be accessed.
2954
The results of the merge are placed into the destination working
2955
directory, where they can be reviewed (with bzr diff), tested, and then
2956
committed to record the result of the merge.
2958
merge refuses to run if there are any uncommitted changes, unless
2962
To merge the latest revision from bzr.dev::
2964
bzr merge ../bzr.dev
2966
To merge changes up to and including revision 82 from bzr.dev::
2968
bzr merge -r 82 ../bzr.dev
2970
To merge the changes introduced by 82, without previous changes::
2972
bzr merge -r 81..82 ../bzr.dev
2974
To apply a merge directive contained in in /tmp/merge:
2976
bzr merge /tmp/merge
2979
encoding_type = 'exact'
2980
_see_also = ['update', 'remerge', 'status-flags']
2981
takes_args = ['location?']
2986
help='Merge even if the destination tree has uncommitted changes.'),
2990
Option('show-base', help="Show base revision text in "
2992
Option('uncommitted', help='Apply uncommitted changes'
2993
' from a working copy, instead of branch changes.'),
2994
Option('pull', help='If the destination is already'
2995
' completely merged into the source, pull from the'
2996
' source rather than merging. When this happens,'
2997
' you do not need to commit the result.'),
2999
help='Branch to merge into, '
3000
'rather than the one containing the working directory.',
3004
Option('preview', help='Instead of merging, show a diff of the merge.')
3007
def run(self, location=None, revision=None, force=False,
3008
merge_type=None, show_base=False, reprocess=None, remember=False,
3009
uncommitted=False, pull=False,
3013
if merge_type is None:
3014
merge_type = _mod_merge.Merge3Merger
3016
if directory is None: directory = u'.'
3017
possible_transports = []
3019
allow_pending = True
3020
verified = 'inapplicable'
3021
tree = WorkingTree.open_containing(directory)[0]
3022
change_reporter = delta._ChangeReporter(
3023
unversioned_filter=tree.is_ignored)
3026
pb = ui.ui_factory.nested_progress_bar()
3027
cleanups.append(pb.finished)
3029
cleanups.append(tree.unlock)
3030
if location is not None:
3032
mergeable = bundle.read_mergeable_from_url(location,
3033
possible_transports=possible_transports)
3034
except errors.NotABundle:
3038
raise errors.BzrCommandError('Cannot use --uncommitted'
3039
' with bundles or merge directives.')
3041
if revision is not None:
3042
raise errors.BzrCommandError(
3043
'Cannot use -r with merge directives or bundles')
3044
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3047
if merger is None and uncommitted:
3048
if revision is not None and len(revision) > 0:
3049
raise errors.BzrCommandError('Cannot use --uncommitted and'
3050
' --revision at the same time.')
3051
location = self._select_branch_location(tree, location)[0]
3052
other_tree, other_path = WorkingTree.open_containing(location)
3053
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
3055
allow_pending = False
3056
if other_path != '':
3057
merger.interesting_files = [other_path]
3060
merger, allow_pending = self._get_merger_from_branch(tree,
3061
location, revision, remember, possible_transports, pb)
3063
merger.merge_type = merge_type
3064
merger.reprocess = reprocess
3065
merger.show_base = show_base
3066
self.sanity_check_merger(merger)
3067
if (merger.base_rev_id == merger.other_rev_id and
3068
merger.other_rev_id is not None):
3069
note('Nothing to do.')
3072
if merger.interesting_files is not None:
3073
raise errors.BzrCommandError('Cannot pull individual files')
3074
if (merger.base_rev_id == tree.last_revision()):
3075
result = tree.pull(merger.other_branch, False,
3076
merger.other_rev_id)
3077
result.report(self.outf)
3079
merger.check_basis(not force)
3081
return self._do_preview(merger)
3083
return self._do_merge(merger, change_reporter, allow_pending,
3086
for cleanup in reversed(cleanups):
3089
def _do_preview(self, merger):
3090
from bzrlib.diff import show_diff_trees
3091
tree_merger = merger.make_merger()
3092
tt = tree_merger.make_preview_transform()
3094
result_tree = tt.get_preview_tree()
3095
show_diff_trees(merger.this_tree, result_tree, self.outf,
3096
old_label='', new_label='')
3100
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3101
merger.change_reporter = change_reporter
3102
conflict_count = merger.do_merge()
3104
merger.set_pending()
3105
if verified == 'failed':
3106
warning('Preview patch does not match changes')
3107
if conflict_count != 0:
3112
def sanity_check_merger(self, merger):
3113
if (merger.show_base and
3114
not merger.merge_type is _mod_merge.Merge3Merger):
3115
raise errors.BzrCommandError("Show-base is not supported for this"
3116
" merge type. %s" % merger.merge_type)
3117
if merger.reprocess is None:
3118
if merger.show_base:
3119
merger.reprocess = False
3121
# Use reprocess if the merger supports it
3122
merger.reprocess = merger.merge_type.supports_reprocess
3123
if merger.reprocess and not merger.merge_type.supports_reprocess:
3124
raise errors.BzrCommandError("Conflict reduction is not supported"
3125
" for merge type %s." %
3127
if merger.reprocess and merger.show_base:
3128
raise errors.BzrCommandError("Cannot do conflict reduction and"
3131
def _get_merger_from_branch(self, tree, location, revision, remember,
3132
possible_transports, pb):
3133
"""Produce a merger from a location, assuming it refers to a branch."""
3134
from bzrlib.tag import _merge_tags_if_possible
3135
# find the branch locations
3136
other_loc, user_location = self._select_branch_location(tree, location,
3138
if revision is not None and len(revision) == 2:
3139
base_loc, _unused = self._select_branch_location(tree,
3140
location, revision, 0)
3142
base_loc = other_loc
3144
other_branch, other_path = Branch.open_containing(other_loc,
3145
possible_transports)
3146
if base_loc == other_loc:
3147
base_branch = other_branch
3149
base_branch, base_path = Branch.open_containing(base_loc,
3150
possible_transports)
3151
# Find the revision ids
3152
if revision is None or len(revision) < 1 or revision[-1] is None:
3153
other_revision_id = _mod_revision.ensure_null(
3154
other_branch.last_revision())
3156
other_revision_id = revision[-1].as_revision_id(other_branch)
3157
if (revision is not None and len(revision) == 2
3158
and revision[0] is not None):
3159
base_revision_id = revision[0].as_revision_id(base_branch)
3161
base_revision_id = None
3162
# Remember where we merge from
3163
if ((remember or tree.branch.get_submit_branch() is None) and
3164
user_location is not None):
3165
tree.branch.set_submit_branch(other_branch.base)
3166
_merge_tags_if_possible(other_branch, tree.branch)
3167
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3168
other_revision_id, base_revision_id, other_branch, base_branch)
3169
if other_path != '':
3170
allow_pending = False
3171
merger.interesting_files = [other_path]
3173
allow_pending = True
3174
return merger, allow_pending
3176
def _select_branch_location(self, tree, user_location, revision=None,
3178
"""Select a branch location, according to possible inputs.
3180
If provided, branches from ``revision`` are preferred. (Both
3181
``revision`` and ``index`` must be supplied.)
3183
Otherwise, the ``location`` parameter is used. If it is None, then the
3184
``submit`` or ``parent`` location is used, and a note is printed.
3186
:param tree: The working tree to select a branch for merging into
3187
:param location: The location entered by the user
3188
:param revision: The revision parameter to the command
3189
:param index: The index to use for the revision parameter. Negative
3190
indices are permitted.
3191
:return: (selected_location, user_location). The default location
3192
will be the user-entered location.
3194
if (revision is not None and index is not None
3195
and revision[index] is not None):
3196
branch = revision[index].get_branch()
3197
if branch is not None:
3198
return branch, branch
3199
if user_location is None:
3200
location = self._get_remembered(tree, 'Merging from')
3202
location = user_location
3203
return location, user_location
3205
def _get_remembered(self, tree, verb_string):
3206
"""Use tree.branch's parent if none was supplied.
3208
Report if the remembered location was used.
3210
stored_location = tree.branch.get_submit_branch()
3211
stored_location_type = "submit"
3212
if stored_location is None:
3213
stored_location = tree.branch.get_parent()
3214
stored_location_type = "parent"
3215
mutter("%s", stored_location)
3216
if stored_location is None:
3217
raise errors.BzrCommandError("No location specified or remembered")
3218
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3219
note(u"%s remembered %s location %s", verb_string,
3220
stored_location_type, display_url)
3221
return stored_location
3224
class cmd_remerge(Command):
3227
Use this if you want to try a different merge technique while resolving
3228
conflicts. Some merge techniques are better than others, and remerge
3229
lets you try different ones on different files.
3231
The options for remerge have the same meaning and defaults as the ones for
3232
merge. The difference is that remerge can (only) be run when there is a
3233
pending merge, and it lets you specify particular files.
3236
Re-do the merge of all conflicted files, and show the base text in
3237
conflict regions, in addition to the usual THIS and OTHER texts::
3239
bzr remerge --show-base
3241
Re-do the merge of "foobar", using the weave merge algorithm, with
3242
additional processing to reduce the size of conflict regions::
3244
bzr remerge --merge-type weave --reprocess foobar
3246
takes_args = ['file*']
3251
help="Show base revision text in conflicts."),
3254
def run(self, file_list=None, merge_type=None, show_base=False,
3256
if merge_type is None:
3257
merge_type = _mod_merge.Merge3Merger
3258
tree, file_list = tree_files(file_list)
3261
parents = tree.get_parent_ids()
3262
if len(parents) != 2:
3263
raise errors.BzrCommandError("Sorry, remerge only works after normal"
3264
" merges. Not cherrypicking or"
3266
repository = tree.branch.repository
3267
interesting_ids = None
3269
conflicts = tree.conflicts()
3270
if file_list is not None:
3271
interesting_ids = set()
3272
for filename in file_list:
3273
file_id = tree.path2id(filename)
3275
raise errors.NotVersionedError(filename)
3276
interesting_ids.add(file_id)
3277
if tree.kind(file_id) != "directory":
3280
for name, ie in tree.inventory.iter_entries(file_id):
3281
interesting_ids.add(ie.file_id)
3282
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3284
# Remerge only supports resolving contents conflicts
3285
allowed_conflicts = ('text conflict', 'contents conflict')
3286
restore_files = [c.path for c in conflicts
3287
if c.typestring in allowed_conflicts]
3288
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3289
tree.set_conflicts(ConflictList(new_conflicts))
3290
if file_list is not None:
3291
restore_files = file_list
3292
for filename in restore_files:
3294
restore(tree.abspath(filename))
3295
except errors.NotConflicted:
3297
# Disable pending merges, because the file texts we are remerging
3298
# have not had those merges performed. If we use the wrong parents
3299
# list, we imply that the working tree text has seen and rejected
3300
# all the changes from the other tree, when in fact those changes
3301
# have not yet been seen.
3302
pb = ui.ui_factory.nested_progress_bar()
3303
tree.set_parent_ids(parents[:1])
3305
merger = _mod_merge.Merger.from_revision_ids(pb,
3307
merger.interesting_ids = interesting_ids
3308
merger.merge_type = merge_type
3309
merger.show_base = show_base
3310
merger.reprocess = reprocess
3311
conflicts = merger.do_merge()
3313
tree.set_parent_ids(parents)
3323
class cmd_revert(Command):
3324
"""Revert files to a previous revision.
3326
Giving a list of files will revert only those files. Otherwise, all files
3327
will be reverted. If the revision is not specified with '--revision', the
3328
last committed revision is used.
3330
To remove only some changes, without reverting to a prior version, use
3331
merge instead. For example, "merge . --revision -2..-3" will remove the
3332
changes introduced by -2, without affecting the changes introduced by -1.
3333
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3335
By default, any files that have been manually changed will be backed up
3336
first. (Files changed only by merge are not backed up.) Backup files have
3337
'.~#~' appended to their name, where # is a number.
3339
When you provide files, you can use their current pathname or the pathname
3340
from the target revision. So you can use revert to "undelete" a file by
3341
name. If you name a directory, all the contents of that directory will be
3344
Any files that have been newly added since that revision will be deleted,
3345
with a backup kept if appropriate. Directories containing unknown files
3346
will not be deleted.
3348
The working tree contains a list of pending merged revisions, which will
3349
be included as parents in the next commit. Normally, revert clears that
3350
list as well as reverting the files. If any files are specified, revert
3351
leaves the pending merge list alone and reverts only the files. Use "bzr
3352
revert ." in the tree root to revert all files but keep the merge record,
3353
and "bzr revert --forget-merges" to clear the pending merge list without
3354
reverting any files.
3357
_see_also = ['cat', 'export']
3360
Option('no-backup', "Do not save backups of reverted files."),
3361
Option('forget-merges',
3362
'Remove pending merge marker, without changing any files.'),
3364
takes_args = ['file*']
3366
def run(self, revision=None, no_backup=False, file_list=None,
3367
forget_merges=None):
3368
tree, file_list = tree_files(file_list)
3372
tree.set_parent_ids(tree.get_parent_ids()[:1])
3374
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3379
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3380
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3381
pb = ui.ui_factory.nested_progress_bar()
3383
tree.revert(file_list, rev_tree, not no_backup, pb,
3384
report_changes=True)
3389
class cmd_assert_fail(Command):
3390
"""Test reporting of assertion failures"""
3391
# intended just for use in testing
3396
raise AssertionError("always fails")
3399
class cmd_help(Command):
3400
"""Show help on a command or other topic.
3403
_see_also = ['topics']
3405
Option('long', 'Show help on all commands.'),
3407
takes_args = ['topic?']
3408
aliases = ['?', '--help', '-?', '-h']
3411
def run(self, topic=None, long=False):
3413
if topic is None and long:
3415
bzrlib.help.help(topic)
3418
class cmd_shell_complete(Command):
3419
"""Show appropriate completions for context.
3421
For a list of all available commands, say 'bzr shell-complete'.
3423
takes_args = ['context?']
3428
def run(self, context=None):
3429
import shellcomplete
3430
shellcomplete.shellcomplete(context)
3433
class cmd_missing(Command):
3434
"""Show unmerged/unpulled revisions between two branches.
3436
OTHER_BRANCH may be local or remote.
3439
_see_also = ['merge', 'pull']
3440
takes_args = ['other_branch?']
3442
Option('reverse', 'Reverse the order of revisions.'),
3444
'Display changes in the local branch only.'),
3445
Option('this' , 'Same as --mine-only.'),
3446
Option('theirs-only',
3447
'Display changes in the remote branch only.'),
3448
Option('other', 'Same as --theirs-only.'),
3452
Option('include-merges', 'Show merged revisions.'),
3454
encoding_type = 'replace'
3457
def run(self, other_branch=None, reverse=False, mine_only=False,
3459
log_format=None, long=False, short=False, line=False,
3460
show_ids=False, verbose=False, this=False, other=False,
3461
include_merges=False):
3462
from bzrlib.missing import find_unmerged, iter_log_revisions
3471
# TODO: We should probably check that we don't have mine-only and
3472
# theirs-only set, but it gets complicated because we also have
3473
# this and other which could be used.
3480
local_branch = Branch.open_containing(u".")[0]
3481
parent = local_branch.get_parent()
3482
if other_branch is None:
3483
other_branch = parent
3484
if other_branch is None:
3485
raise errors.BzrCommandError("No peer location known"
3487
display_url = urlutils.unescape_for_display(parent,
3489
message("Using saved parent location: "
3490
+ display_url + "\n")
3492
remote_branch = Branch.open(other_branch)
3493
if remote_branch.base == local_branch.base:
3494
remote_branch = local_branch
3495
local_branch.lock_read()
3497
remote_branch.lock_read()
3499
local_extra, remote_extra = find_unmerged(
3500
local_branch, remote_branch, restrict,
3501
backward=not reverse,
3502
include_merges=include_merges)
3504
if log_format is None:
3505
registry = log.log_formatter_registry
3506
log_format = registry.get_default(local_branch)
3507
lf = log_format(to_file=self.outf,
3509
show_timezone='original')
3512
if local_extra and not theirs_only:
3513
message("You have %d extra revision(s):\n" %
3515
for revision in iter_log_revisions(local_extra,
3516
local_branch.repository,
3518
lf.log_revision(revision)
3519
printed_local = True
3522
printed_local = False
3524
if remote_extra and not mine_only:
3525
if printed_local is True:
3527
message("You are missing %d revision(s):\n" %
3529
for revision in iter_log_revisions(remote_extra,
3530
remote_branch.repository,
3532
lf.log_revision(revision)
3535
if mine_only and not local_extra:
3536
# We checked local, and found nothing extra
3537
message('This branch is up to date.\n')
3538
elif theirs_only and not remote_extra:
3539
# We checked remote, and found nothing extra
3540
message('Other branch is up to date.\n')
3541
elif not (mine_only or theirs_only or local_extra or
3543
# We checked both branches, and neither one had extra
3545
message("Branches are up to date.\n")
3547
remote_branch.unlock()
3549
local_branch.unlock()
3550
if not status_code and parent is None and other_branch is not None:
3551
local_branch.lock_write()
3553
# handle race conditions - a parent might be set while we run.
3554
if local_branch.get_parent() is None:
3555
local_branch.set_parent(remote_branch.base)
3557
local_branch.unlock()
3561
class cmd_pack(Command):
3562
"""Compress the data within a repository."""
3564
_see_also = ['repositories']
3565
takes_args = ['branch_or_repo?']
3567
def run(self, branch_or_repo='.'):
3568
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3570
branch = dir.open_branch()
3571
repository = branch.repository
3572
except errors.NotBranchError:
3573
repository = dir.open_repository()
3577
class cmd_plugins(Command):
3578
"""List the installed plugins.
3580
This command displays the list of installed plugins including
3581
version of plugin and a short description of each.
3583
--verbose shows the path where each plugin is located.
3585
A plugin is an external component for Bazaar that extends the
3586
revision control system, by adding or replacing code in Bazaar.
3587
Plugins can do a variety of things, including overriding commands,
3588
adding new commands, providing additional network transports and
3589
customizing log output.
3591
See the Bazaar web site, http://bazaar-vcs.org, for further
3592
information on plugins including where to find them and how to
3593
install them. Instructions are also provided there on how to
3594
write new plugins using the Python programming language.
3596
takes_options = ['verbose']
3599
def run(self, verbose=False):
3600
import bzrlib.plugin
3601
from inspect import getdoc
3603
for name, plugin in bzrlib.plugin.plugins().items():
3604
version = plugin.__version__
3605
if version == 'unknown':
3607
name_ver = '%s %s' % (name, version)
3608
d = getdoc(plugin.module)
3610
doc = d.split('\n')[0]
3612
doc = '(no description)'
3613
result.append((name_ver, doc, plugin.path()))
3614
for name_ver, doc, path in sorted(result):
3622
class cmd_testament(Command):
3623
"""Show testament (signing-form) of a revision."""
3626
Option('long', help='Produce long-format testament.'),
3628
help='Produce a strict-format testament.')]
3629
takes_args = ['branch?']
3631
def run(self, branch=u'.', revision=None, long=False, strict=False):
3632
from bzrlib.testament import Testament, StrictTestament
3634
testament_class = StrictTestament
3636
testament_class = Testament
3638
b = Branch.open_containing(branch)[0]
3640
b = Branch.open(branch)
3643
if revision is None:
3644
rev_id = b.last_revision()
3646
rev_id = revision[0].as_revision_id(b)
3647
t = testament_class.from_revision(b.repository, rev_id)
3649
sys.stdout.writelines(t.as_text_lines())
3651
sys.stdout.write(t.as_short_text())
3656
class cmd_annotate(Command):
3657
"""Show the origin of each line in a file.
3659
This prints out the given file with an annotation on the left side
3660
indicating which revision, author and date introduced the change.
3662
If the origin is the same for a run of consecutive lines, it is
3663
shown only at the top, unless the --all option is given.
3665
# TODO: annotate directories; showing when each file was last changed
3666
# TODO: if the working copy is modified, show annotations on that
3667
# with new uncommitted lines marked
3668
aliases = ['ann', 'blame', 'praise']
3669
takes_args = ['filename']
3670
takes_options = [Option('all', help='Show annotations on all lines.'),
3671
Option('long', help='Show commit date in annotations.'),
3675
encoding_type = 'exact'
3678
def run(self, filename, all=False, long=False, revision=None,
3680
from bzrlib.annotate import annotate_file, annotate_file_tree
3681
wt, branch, relpath = \
3682
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3688
tree = _get_one_revision_tree('annotate', revision, branch=branch)
3690
file_id = wt.path2id(relpath)
3692
file_id = tree.path2id(relpath)
3694
raise errors.NotVersionedError(filename)
3695
file_version = tree.inventory[file_id].revision
3696
if wt is not None and revision is None:
3697
# If there is a tree and we're not annotating historical
3698
# versions, annotate the working tree's content.
3699
annotate_file_tree(wt, file_id, self.outf, long, all,
3702
annotate_file(branch, file_version, file_id, long, all, self.outf,
3711
class cmd_re_sign(Command):
3712
"""Create a digital signature for an existing revision."""
3713
# TODO be able to replace existing ones.
3715
hidden = True # is this right ?
3716
takes_args = ['revision_id*']
3717
takes_options = ['revision']
3719
def run(self, revision_id_list=None, revision=None):
3720
if revision_id_list is not None and revision is not None:
3721
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3722
if revision_id_list is None and revision is None:
3723
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3724
b = WorkingTree.open_containing(u'.')[0].branch
3727
return self._run(b, revision_id_list, revision)
3731
def _run(self, b, revision_id_list, revision):
3732
import bzrlib.gpg as gpg
3733
gpg_strategy = gpg.GPGStrategy(b.get_config())
3734
if revision_id_list is not None:
3735
b.repository.start_write_group()
3737
for revision_id in revision_id_list:
3738
b.repository.sign_revision(revision_id, gpg_strategy)
3740
b.repository.abort_write_group()
3743
b.repository.commit_write_group()
3744
elif revision is not None:
3745
if len(revision) == 1:
3746
revno, rev_id = revision[0].in_history(b)
3747
b.repository.start_write_group()
3749
b.repository.sign_revision(rev_id, gpg_strategy)
3751
b.repository.abort_write_group()
3754
b.repository.commit_write_group()
3755
elif len(revision) == 2:
3756
# are they both on rh- if so we can walk between them
3757
# might be nice to have a range helper for arbitrary
3758
# revision paths. hmm.
3759
from_revno, from_revid = revision[0].in_history(b)
3760
to_revno, to_revid = revision[1].in_history(b)
3761
if to_revid is None:
3762
to_revno = b.revno()
3763
if from_revno is None or to_revno is None:
3764
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3765
b.repository.start_write_group()
3767
for revno in range(from_revno, to_revno + 1):
3768
b.repository.sign_revision(b.get_rev_id(revno),
3771
b.repository.abort_write_group()
3774
b.repository.commit_write_group()
3776
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3779
class cmd_bind(Command):
3780
"""Convert the current branch into a checkout of the supplied branch.
3782
Once converted into a checkout, commits must succeed on the master branch
3783
before they will be applied to the local branch.
3785
Bound branches use the nickname of its master branch unless it is set
3786
locally, in which case binding will update the the local nickname to be
3790
_see_also = ['checkouts', 'unbind']
3791
takes_args = ['location?']
3794
def run(self, location=None):
3795
b, relpath = Branch.open_containing(u'.')
3796
if location is None:
3798
location = b.get_old_bound_location()
3799
except errors.UpgradeRequired:
3800
raise errors.BzrCommandError('No location supplied. '
3801
'This format does not remember old locations.')
3803
if location is None:
3804
raise errors.BzrCommandError('No location supplied and no '
3805
'previous location known')
3806
b_other = Branch.open(location)
3809
except errors.DivergedBranches:
3810
raise errors.BzrCommandError('These branches have diverged.'
3811
' Try merging, and then bind again.')
3812
if b.get_config().has_explicit_nickname():
3813
b.nick = b_other.nick
3816
class cmd_unbind(Command):
3817
"""Convert the current checkout into a regular branch.
3819
After unbinding, the local branch is considered independent and subsequent
3820
commits will be local only.
3823
_see_also = ['checkouts', 'bind']
3828
b, relpath = Branch.open_containing(u'.')
3830
raise errors.BzrCommandError('Local branch is not bound')
3833
class cmd_uncommit(Command):
3834
"""Remove the last committed revision.
3836
--verbose will print out what is being removed.
3837
--dry-run will go through all the motions, but not actually
3840
If --revision is specified, uncommit revisions to leave the branch at the
3841
specified revision. For example, "bzr uncommit -r 15" will leave the
3842
branch at revision 15.
3844
Uncommit leaves the working tree ready for a new commit. The only change
3845
it may make is to restore any pending merges that were present before
3849
# TODO: jam 20060108 Add an option to allow uncommit to remove
3850
# unreferenced information in 'branch-as-repository' branches.
3851
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3852
# information in shared branches as well.
3853
_see_also = ['commit']
3854
takes_options = ['verbose', 'revision',
3855
Option('dry-run', help='Don\'t actually make changes.'),
3856
Option('force', help='Say yes to all questions.'),
3858
help="Only remove the commits from the local branch"
3859
" when in a checkout."
3862
takes_args = ['location?']
3864
encoding_type = 'replace'
3866
def run(self, location=None,
3867
dry_run=False, verbose=False,
3868
revision=None, force=False, local=False):
3869
if location is None:
3871
control, relpath = bzrdir.BzrDir.open_containing(location)
3873
tree = control.open_workingtree()
3875
except (errors.NoWorkingTree, errors.NotLocalUrl):
3877
b = control.open_branch()
3879
if tree is not None:
3884
return self._run(b, tree, dry_run, verbose, revision, force,
3887
if tree is not None:
3892
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3893
from bzrlib.log import log_formatter, show_log
3894
from bzrlib.uncommit import uncommit
3896
last_revno, last_rev_id = b.last_revision_info()
3899
if revision is None:
3901
rev_id = last_rev_id
3903
# 'bzr uncommit -r 10' actually means uncommit
3904
# so that the final tree is at revno 10.
3905
# but bzrlib.uncommit.uncommit() actually uncommits
3906
# the revisions that are supplied.
3907
# So we need to offset it by one
3908
revno = revision[0].in_history(b).revno + 1
3909
if revno <= last_revno:
3910
rev_id = b.get_rev_id(revno)
3912
if rev_id is None or _mod_revision.is_null(rev_id):
3913
self.outf.write('No revisions to uncommit.\n')
3916
lf = log_formatter('short',
3918
show_timezone='original')
3923
direction='forward',
3924
start_revision=revno,
3925
end_revision=last_revno)
3928
print 'Dry-run, pretending to remove the above revisions.'
3930
val = raw_input('Press <enter> to continue')
3932
print 'The above revision(s) will be removed.'
3934
val = raw_input('Are you sure [y/N]? ')
3935
if val.lower() not in ('y', 'yes'):
3939
mutter('Uncommitting from {%s} to {%s}',
3940
last_rev_id, rev_id)
3941
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3942
revno=revno, local=local)
3943
note('You can restore the old tip by running:\n'
3944
' bzr pull . -r revid:%s', last_rev_id)
3947
class cmd_break_lock(Command):
3948
"""Break a dead lock on a repository, branch or working directory.
3950
CAUTION: Locks should only be broken when you are sure that the process
3951
holding the lock has been stopped.
3953
You can get information on what locks are open via the 'bzr info' command.
3958
takes_args = ['location?']
3960
def run(self, location=None, show=False):
3961
if location is None:
3963
control, relpath = bzrdir.BzrDir.open_containing(location)
3965
control.break_lock()
3966
except NotImplementedError:
3970
class cmd_wait_until_signalled(Command):
3971
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3973
This just prints a line to signal when it is ready, then blocks on stdin.
3979
sys.stdout.write("running\n")
3981
sys.stdin.readline()
3984
class cmd_serve(Command):
3985
"""Run the bzr server."""
3987
aliases = ['server']
3991
help='Serve on stdin/out for use from inetd or sshd.'),
3993
help='Listen for connections on nominated port of the form '
3994
'[hostname:]portnumber. Passing 0 as the port number will '
3995
'result in a dynamically allocated port. The default port is '
3999
help='Serve contents of this directory.',
4001
Option('allow-writes',
4002
help='By default the server is a readonly server. Supplying '
4003
'--allow-writes enables write access to the contents of '
4004
'the served directory and below.'
4008
def run(self, port=None, inet=False, directory=None, allow_writes=False):
4009
from bzrlib import lockdir
4010
from bzrlib.smart import medium, server
4011
from bzrlib.transport import get_transport
4012
from bzrlib.transport.chroot import ChrootServer
4013
if directory is None:
4014
directory = os.getcwd()
4015
url = urlutils.local_path_to_url(directory)
4016
if not allow_writes:
4017
url = 'readonly+' + url
4018
chroot_server = ChrootServer(get_transport(url))
4019
chroot_server.setUp()
4020
t = get_transport(chroot_server.get_url())
4022
smart_server = medium.SmartServerPipeStreamMedium(
4023
sys.stdin, sys.stdout, t)
4025
host = medium.BZR_DEFAULT_INTERFACE
4027
port = medium.BZR_DEFAULT_PORT
4030
host, port = port.split(':')
4032
smart_server = server.SmartTCPServer(t, host=host, port=port)
4033
print 'listening on port: ', smart_server.port
4035
# for the duration of this server, no UI output is permitted.
4036
# note that this may cause problems with blackbox tests. This should
4037
# be changed with care though, as we dont want to use bandwidth sending
4038
# progress over stderr to smart server clients!
4039
old_factory = ui.ui_factory
4040
old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
4042
ui.ui_factory = ui.SilentUIFactory()
4043
lockdir._DEFAULT_TIMEOUT_SECONDS = 0
4044
smart_server.serve()
4046
ui.ui_factory = old_factory
4047
lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
4050
class cmd_join(Command):
4051
"""Combine a subtree into its containing tree.
4053
This command is for experimental use only. It requires the target tree
4054
to be in dirstate-with-subtree format, which cannot be converted into
4057
The TREE argument should be an independent tree, inside another tree, but
4058
not part of it. (Such trees can be produced by "bzr split", but also by
4059
running "bzr branch" with the target inside a tree.)
4061
The result is a combined tree, with the subtree no longer an independant
4062
part. This is marked as a merge of the subtree into the containing tree,
4063
and all history is preserved.
4065
If --reference is specified, the subtree retains its independence. It can
4066
be branched by itself, and can be part of multiple projects at the same
4067
time. But operations performed in the containing tree, such as commit
4068
and merge, will recurse into the subtree.
4071
_see_also = ['split']
4072
takes_args = ['tree']
4074
Option('reference', help='Join by reference.'),
4078
def run(self, tree, reference=False):
4079
sub_tree = WorkingTree.open(tree)
4080
parent_dir = osutils.dirname(sub_tree.basedir)
4081
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4082
repo = containing_tree.branch.repository
4083
if not repo.supports_rich_root():
4084
raise errors.BzrCommandError(
4085
"Can't join trees because %s doesn't support rich root data.\n"
4086
"You can use bzr upgrade on the repository."
4090
containing_tree.add_reference(sub_tree)
4091
except errors.BadReferenceTarget, e:
4092
# XXX: Would be better to just raise a nicely printable
4093
# exception from the real origin. Also below. mbp 20070306
4094
raise errors.BzrCommandError("Cannot join %s. %s" %
4098
containing_tree.subsume(sub_tree)
4099
except errors.BadSubsumeSource, e:
4100
raise errors.BzrCommandError("Cannot join %s. %s" %
4104
class cmd_split(Command):
4105
"""Split a subdirectory of a tree into a separate tree.
4107
This command will produce a target tree in a format that supports
4108
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4109
converted into earlier formats like 'dirstate-tags'.
4111
The TREE argument should be a subdirectory of a working tree. That
4112
subdirectory will be converted into an independent tree, with its own
4113
branch. Commits in the top-level tree will not apply to the new subtree.
4116
# join is not un-hidden yet
4117
#_see_also = ['join']
4118
takes_args = ['tree']
4120
def run(self, tree):
4121
containing_tree, subdir = WorkingTree.open_containing(tree)
4122
sub_id = containing_tree.path2id(subdir)
4124
raise errors.NotVersionedError(subdir)
4126
containing_tree.extract(sub_id)
4127
except errors.RootNotRich:
4128
raise errors.UpgradeRequired(containing_tree.branch.base)
4131
class cmd_merge_directive(Command):
4132
"""Generate a merge directive for auto-merge tools.
4134
A directive requests a merge to be performed, and also provides all the
4135
information necessary to do so. This means it must either include a
4136
revision bundle, or the location of a branch containing the desired
4139
A submit branch (the location to merge into) must be supplied the first
4140
time the command is issued. After it has been supplied once, it will
4141
be remembered as the default.
4143
A public branch is optional if a revision bundle is supplied, but required
4144
if --diff or --plain is specified. It will be remembered as the default
4145
after the first use.
4148
takes_args = ['submit_branch?', 'public_branch?']
4152
_see_also = ['send']
4155
RegistryOption.from_kwargs('patch-type',
4156
'The type of patch to include in the directive.',
4158
value_switches=True,
4160
bundle='Bazaar revision bundle (default).',
4161
diff='Normal unified diff.',
4162
plain='No patch, just directive.'),
4163
Option('sign', help='GPG-sign the directive.'), 'revision',
4164
Option('mail-to', type=str,
4165
help='Instead of printing the directive, email to this address.'),
4166
Option('message', type=str, short_name='m',
4167
help='Message to use when committing this merge.')
4170
encoding_type = 'exact'
4172
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4173
sign=False, revision=None, mail_to=None, message=None):
4174
from bzrlib.revision import ensure_null, NULL_REVISION
4175
include_patch, include_bundle = {
4176
'plain': (False, False),
4177
'diff': (True, False),
4178
'bundle': (True, True),
4180
branch = Branch.open('.')
4181
stored_submit_branch = branch.get_submit_branch()
4182
if submit_branch is None:
4183
submit_branch = stored_submit_branch
4185
if stored_submit_branch is None:
4186
branch.set_submit_branch(submit_branch)
4187
if submit_branch is None:
4188
submit_branch = branch.get_parent()
4189
if submit_branch is None:
4190
raise errors.BzrCommandError('No submit branch specified or known')
4192
stored_public_branch = branch.get_public_branch()
4193
if public_branch is None:
4194
public_branch = stored_public_branch
4195
elif stored_public_branch is None:
4196
branch.set_public_branch(public_branch)
4197
if not include_bundle and public_branch is None:
4198
raise errors.BzrCommandError('No public branch specified or'
4200
base_revision_id = None
4201
if revision is not None:
4202
if len(revision) > 2:
4203
raise errors.BzrCommandError('bzr merge-directive takes '
4204
'at most two one revision identifiers')
4205
revision_id = revision[-1].as_revision_id(branch)
4206
if len(revision) == 2:
4207
base_revision_id = revision[0].as_revision_id(branch)
4209
revision_id = branch.last_revision()
4210
revision_id = ensure_null(revision_id)
4211
if revision_id == NULL_REVISION:
4212
raise errors.BzrCommandError('No revisions to bundle.')
4213
directive = merge_directive.MergeDirective2.from_objects(
4214
branch.repository, revision_id, time.time(),
4215
osutils.local_time_offset(), submit_branch,
4216
public_branch=public_branch, include_patch=include_patch,
4217
include_bundle=include_bundle, message=message,
4218
base_revision_id=base_revision_id)
4221
self.outf.write(directive.to_signed(branch))
4223
self.outf.writelines(directive.to_lines())
4225
message = directive.to_email(mail_to, branch, sign)
4226
s = SMTPConnection(branch.get_config())
4227
s.send_email(message)
4230
class cmd_send(Command):
4231
"""Mail or create a merge-directive for submiting changes.
4233
A merge directive provides many things needed for requesting merges:
4235
* A machine-readable description of the merge to perform
4237
* An optional patch that is a preview of the changes requested
4239
* An optional bundle of revision data, so that the changes can be applied
4240
directly from the merge directive, without retrieving data from a
4243
If --no-bundle is specified, then public_branch is needed (and must be
4244
up-to-date), so that the receiver can perform the merge using the
4245
public_branch. The public_branch is always included if known, so that
4246
people can check it later.
4248
The submit branch defaults to the parent, but can be overridden. Both
4249
submit branch and public branch will be remembered if supplied.
4251
If a public_branch is known for the submit_branch, that public submit
4252
branch is used in the merge instructions. This means that a local mirror
4253
can be used as your actual submit branch, once you have set public_branch
4256
Mail is sent using your preferred mail program. This should be transparent
4257
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
4258
If the preferred client can't be found (or used), your editor will be used.
4260
To use a specific mail program, set the mail_client configuration option.
4261
(For Thunderbird 1.5, this works around some bugs.) Supported values for
4262
specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4263
generic options are "default", "editor", "emacsclient", "mapi", and
4264
"xdg-email". Plugins may also add supported clients.
4266
If mail is being sent, a to address is required. This can be supplied
4267
either on the commandline, by setting the submit_to configuration
4268
option in the branch itself or the child_submit_to configuration option
4269
in the submit branch.
4271
Two formats are currently supported: "4" uses revision bundle format 4 and
4272
merge directive format 2. It is significantly faster and smaller than
4273
older formats. It is compatible with Bazaar 0.19 and later. It is the
4274
default. "0.9" uses revision bundle format 0.9 and merge directive
4275
format 1. It is compatible with Bazaar 0.12 - 0.18.
4277
Merge directives are applied using the merge command or the pull command.
4280
encoding_type = 'exact'
4282
_see_also = ['merge', 'pull']
4284
takes_args = ['submit_branch?', 'public_branch?']
4288
help='Do not include a bundle in the merge directive.'),
4289
Option('no-patch', help='Do not include a preview patch in the merge'
4292
help='Remember submit and public branch.'),
4294
help='Branch to generate the submission from, '
4295
'rather than the one containing the working directory.',
4298
Option('output', short_name='o',
4299
help='Write merge directive to this file; '
4300
'use - for stdout.',
4302
Option('mail-to', help='Mail the request to this address.',
4306
RegistryOption.from_kwargs('format',
4307
'Use the specified output format.',
4308
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4309
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4312
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4313
no_patch=False, revision=None, remember=False, output=None,
4314
format='4', mail_to=None, message=None, **kwargs):
4315
return self._run(submit_branch, revision, public_branch, remember,
4316
format, no_bundle, no_patch, output,
4317
kwargs.get('from', '.'), mail_to, message)
4319
def _run(self, submit_branch, revision, public_branch, remember, format,
4320
no_bundle, no_patch, output, from_, mail_to, message):
4321
from bzrlib.revision import NULL_REVISION
4322
branch = Branch.open_containing(from_)[0]
4324
outfile = cStringIO.StringIO()
4328
outfile = open(output, 'wb')
4329
# we may need to write data into branch's repository to calculate
4334
config = branch.get_config()
4336
mail_to = config.get_user_option('submit_to')
4337
mail_client = config.get_mail_client()
4338
if remember and submit_branch is None:
4339
raise errors.BzrCommandError(
4340
'--remember requires a branch to be specified.')
4341
stored_submit_branch = branch.get_submit_branch()
4342
remembered_submit_branch = None
4343
if submit_branch is None:
4344
submit_branch = stored_submit_branch
4345
remembered_submit_branch = "submit"
4347
if stored_submit_branch is None or remember:
4348
branch.set_submit_branch(submit_branch)
4349
if submit_branch is None:
4350
submit_branch = branch.get_parent()
4351
remembered_submit_branch = "parent"
4352
if submit_branch is None:
4353
raise errors.BzrCommandError('No submit branch known or'
4355
if remembered_submit_branch is not None:
4356
note('Using saved %s location "%s" to determine what '
4357
'changes to submit.', remembered_submit_branch,
4361
submit_config = Branch.open(submit_branch).get_config()
4362
mail_to = submit_config.get_user_option("child_submit_to")
4364
stored_public_branch = branch.get_public_branch()
4365
if public_branch is None:
4366
public_branch = stored_public_branch
4367
elif stored_public_branch is None or remember:
4368
branch.set_public_branch(public_branch)
4369
if no_bundle and public_branch is None:
4370
raise errors.BzrCommandError('No public branch specified or'
4372
base_revision_id = None
4374
if revision is not None:
4375
if len(revision) > 2:
4376
raise errors.BzrCommandError('bzr send takes '
4377
'at most two one revision identifiers')
4378
revision_id = revision[-1].as_revision_id(branch)
4379
if len(revision) == 2:
4380
base_revision_id = revision[0].as_revision_id(branch)
4381
if revision_id is None:
4382
revision_id = branch.last_revision()
4383
if revision_id == NULL_REVISION:
4384
raise errors.BzrCommandError('No revisions to submit.')
4386
directive = merge_directive.MergeDirective2.from_objects(
4387
branch.repository, revision_id, time.time(),
4388
osutils.local_time_offset(), submit_branch,
4389
public_branch=public_branch, include_patch=not no_patch,
4390
include_bundle=not no_bundle, message=message,
4391
base_revision_id=base_revision_id)
4392
elif format == '0.9':
4395
patch_type = 'bundle'
4397
raise errors.BzrCommandError('Format 0.9 does not'
4398
' permit bundle with no patch')
4404
directive = merge_directive.MergeDirective.from_objects(
4405
branch.repository, revision_id, time.time(),
4406
osutils.local_time_offset(), submit_branch,
4407
public_branch=public_branch, patch_type=patch_type,
4410
outfile.writelines(directive.to_lines())
4412
subject = '[MERGE] '
4413
if message is not None:
4416
revision = branch.repository.get_revision(revision_id)
4417
subject += revision.get_summary()
4418
basename = directive.get_disk_name(branch)
4419
mail_client.compose_merge_request(mail_to, subject,
4420
outfile.getvalue(), basename)
4427
class cmd_bundle_revisions(cmd_send):
4429
"""Create a merge-directive for submiting changes.
4431
A merge directive provides many things needed for requesting merges:
4433
* A machine-readable description of the merge to perform
4435
* An optional patch that is a preview of the changes requested
4437
* An optional bundle of revision data, so that the changes can be applied
4438
directly from the merge directive, without retrieving data from a
4441
If --no-bundle is specified, then public_branch is needed (and must be
4442
up-to-date), so that the receiver can perform the merge using the
4443
public_branch. The public_branch is always included if known, so that
4444
people can check it later.
4446
The submit branch defaults to the parent, but can be overridden. Both
4447
submit branch and public branch will be remembered if supplied.
4449
If a public_branch is known for the submit_branch, that public submit
4450
branch is used in the merge instructions. This means that a local mirror
4451
can be used as your actual submit branch, once you have set public_branch
4454
Two formats are currently supported: "4" uses revision bundle format 4 and
4455
merge directive format 2. It is significantly faster and smaller than
4456
older formats. It is compatible with Bazaar 0.19 and later. It is the
4457
default. "0.9" uses revision bundle format 0.9 and merge directive
4458
format 1. It is compatible with Bazaar 0.12 - 0.18.
4463
help='Do not include a bundle in the merge directive.'),
4464
Option('no-patch', help='Do not include a preview patch in the merge'
4467
help='Remember submit and public branch.'),
4469
help='Branch to generate the submission from, '
4470
'rather than the one containing the working directory.',
4473
Option('output', short_name='o', help='Write directive to this file.',
4476
RegistryOption.from_kwargs('format',
4477
'Use the specified output format.',
4478
**{'4': 'Bundle format 4, Merge Directive 2 (default)',
4479
'0.9': 'Bundle format 0.9, Merge Directive 1',})
4481
aliases = ['bundle']
4483
_see_also = ['send', 'merge']
4487
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4488
no_patch=False, revision=None, remember=False, output=None,
4489
format='4', **kwargs):
4492
return self._run(submit_branch, revision, public_branch, remember,
4493
format, no_bundle, no_patch, output,
4494
kwargs.get('from', '.'), None, None)
4497
class cmd_tag(Command):
4498
"""Create, remove or modify a tag naming a revision.
4500
Tags give human-meaningful names to revisions. Commands that take a -r
4501
(--revision) option can be given -rtag:X, where X is any previously
4504
Tags are stored in the branch. Tags are copied from one branch to another
4505
along when you branch, push, pull or merge.
4507
It is an error to give a tag name that already exists unless you pass
4508
--force, in which case the tag is moved to point to the new revision.
4510
To rename a tag (change the name but keep it on the same revsion), run ``bzr
4511
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
4514
_see_also = ['commit', 'tags']
4515
takes_args = ['tag_name']
4518
help='Delete this tag rather than placing it.',
4521
help='Branch in which to place the tag.',
4526
help='Replace existing tags.',
4531
def run(self, tag_name,
4537
branch, relpath = Branch.open_containing(directory)
4541
branch.tags.delete_tag(tag_name)
4542
self.outf.write('Deleted tag %s.\n' % tag_name)
4545
if len(revision) != 1:
4546
raise errors.BzrCommandError(
4547
"Tags can only be placed on a single revision, "
4549
revision_id = revision[0].as_revision_id(branch)
4551
revision_id = branch.last_revision()
4552
if (not force) and branch.tags.has_tag(tag_name):
4553
raise errors.TagAlreadyExists(tag_name)
4554
branch.tags.set_tag(tag_name, revision_id)
4555
self.outf.write('Created tag %s.\n' % tag_name)
4560
class cmd_tags(Command):
4563
This command shows a table of tag names and the revisions they reference.
4569
help='Branch whose tags should be displayed.',
4573
RegistryOption.from_kwargs('sort',
4574
'Sort tags by different criteria.', title='Sorting',
4575
alpha='Sort tags lexicographically (default).',
4576
time='Sort tags chronologically.',
4587
branch, relpath = Branch.open_containing(directory)
4588
tags = branch.tags.get_tag_dict().items()
4593
elif sort == 'time':
4595
for tag, revid in tags:
4597
revobj = branch.repository.get_revision(revid)
4598
except errors.NoSuchRevision:
4599
timestamp = sys.maxint # place them at the end
4601
timestamp = revobj.timestamp
4602
timestamps[revid] = timestamp
4603
tags.sort(key=lambda x: timestamps[x[1]])
4605
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4606
revno_map = branch.get_revision_id_to_revno_map()
4607
tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4608
for tag, revid in tags ]
4609
for tag, revspec in tags:
4610
self.outf.write('%-20s %s\n' % (tag, revspec))
4613
class cmd_reconfigure(Command):
4614
"""Reconfigure the type of a bzr directory.
4616
A target configuration must be specified.
4618
For checkouts, the bind-to location will be auto-detected if not specified.
4619
The order of preference is
4620
1. For a lightweight checkout, the current bound location.
4621
2. For branches that used to be checkouts, the previously-bound location.
4622
3. The push location.
4623
4. The parent location.
4624
If none of these is available, --bind-to must be specified.
4627
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
4628
takes_args = ['location?']
4629
takes_options = [RegistryOption.from_kwargs('target_type',
4630
title='Target type',
4631
help='The type to reconfigure the directory to.',
4632
value_switches=True, enum_switch=False,
4633
branch='Reconfigure to be an unbound branch '
4634
'with no working tree.',
4635
tree='Reconfigure to be an unbound branch '
4636
'with a working tree.',
4637
checkout='Reconfigure to be a bound branch '
4638
'with a working tree.',
4639
lightweight_checkout='Reconfigure to be a lightweight'
4640
' checkout (with no local history).',
4641
standalone='Reconfigure to be a standalone branch '
4642
'(i.e. stop using shared repository).',
4643
use_shared='Reconfigure to use a shared repository.'),
4644
Option('bind-to', help='Branch to bind checkout to.',
4647
help='Perform reconfiguration even if local changes'
4651
def run(self, location=None, target_type=None, bind_to=None, force=False):
4652
directory = bzrdir.BzrDir.open(location)
4653
if target_type is None:
4654
raise errors.BzrCommandError('No target configuration specified')
4655
elif target_type == 'branch':
4656
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4657
elif target_type == 'tree':
4658
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4659
elif target_type == 'checkout':
4660
reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4662
elif target_type == 'lightweight-checkout':
4663
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4665
elif target_type == 'use-shared':
4666
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4667
elif target_type == 'standalone':
4668
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
4669
reconfiguration.apply(force)
4672
class cmd_switch(Command):
4673
"""Set the branch of a checkout and update.
4675
For lightweight checkouts, this changes the branch being referenced.
4676
For heavyweight checkouts, this checks that there are no local commits
4677
versus the current bound branch, then it makes the local branch a mirror
4678
of the new location and binds to it.
4680
In both cases, the working tree is updated and uncommitted changes
4681
are merged. The user can commit or revert these as they desire.
4683
Pending merges need to be committed or reverted before using switch.
4685
The path to the branch to switch to can be specified relative to the parent
4686
directory of the current branch. For example, if you are currently in a
4687
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4690
Bound branches use the nickname of its master branch unless it is set
4691
locally, in which case switching will update the the local nickname to be
4695
takes_args = ['to_location']
4696
takes_options = [Option('force',
4697
help='Switch even if local commits will be lost.')
4700
def run(self, to_location, force=False):
4701
from bzrlib import switch
4703
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4704
branch = control_dir.open_branch()
4706
to_branch = Branch.open(to_location)
4707
except errors.NotBranchError:
4708
this_branch = control_dir.open_branch()
4709
# This may be a heavy checkout, where we want the master branch
4710
this_url = this_branch.get_bound_location()
4711
# If not, use a local sibling
4712
if this_url is None:
4713
this_url = this_branch.base
4714
to_branch = Branch.open(
4715
urlutils.join(this_url, '..', to_location))
4716
switch.switch(control_dir, to_branch, force)
4717
if branch.get_config().has_explicit_nickname():
4718
branch = control_dir.open_branch() #get the new branch!
4719
branch.nick = to_branch.nick
4720
note('Switched to branch: %s',
4721
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4724
class cmd_hooks(Command):
4725
"""Show a branch's currently registered hooks.
4729
takes_args = ['path?']
4731
def run(self, path=None):
4734
branch_hooks = Branch.open(path).hooks
4735
for hook_type in branch_hooks:
4736
hooks = branch_hooks[hook_type]
4737
self.outf.write("%s:\n" % (hook_type,))
4740
self.outf.write(" %s\n" %
4741
(branch_hooks.get_hook_name(hook),))
4743
self.outf.write(" <no hooks installed>\n")
4746
class cmd_shelve(Command):
4747
"""Temporarily set aside some changes from the current tree.
4749
Shelve allows you to temporarily put changes you've made "on the shelf",
4750
ie. out of the way, until a later time when you can bring them back from
4751
the shelf with the 'unshelve' command.
4753
If shelve --list is specified, previously-shelved changes are listed.
4755
Shelve is intended to help separate several sets of changes that have
4756
been inappropriately mingled. If you just want to get rid of all changes
4757
and you don't need to restore them later, use revert. If you want to
4758
shelve all text changes at once, use shelve --all.
4760
If filenames are specified, only the changes to those files will be
4761
shelved. Other files will be left untouched.
4763
If a revision is specified, changes since that revision will be shelved.
4765
You can put multiple items on the shelf, and by default, 'unshelve' will
4766
restore the most recently shelved changes.
4769
takes_args = ['file*']
4773
Option('all', help='Shelve all changes.'),
4775
RegistryOption('writer', 'Method to use for writing diffs.',
4776
bzrlib.option.diff_writer_registry,
4777
value_switches=True, enum_switch=False),
4779
Option('list', help='List shelved changes.'),
4781
_see_also = ['unshelve']
4783
def run(self, revision=None, all=False, file_list=None, message=None,
4784
writer=None, list=False):
4786
return self.run_for_list()
4787
from bzrlib.shelf_ui import Shelver
4789
writer = bzrlib.option.diff_writer_registry.get()
4791
Shelver.from_args(writer(sys.stdout), revision, all, file_list,
4793
except errors.UserAbort:
4796
def run_for_list(self):
4797
tree = WorkingTree.open_containing('.')[0]
4800
manager = tree.get_shelf_manager()
4801
shelves = manager.active_shelves()
4802
if len(shelves) == 0:
4803
note('No shelved changes.')
4805
for shelf_id in reversed(shelves):
4806
message = manager.get_metadata(shelf_id).get('message')
4808
message = '<no message>'
4809
self.outf.write('%3d: %s\n' % (shelf_id, message))
4815
class cmd_unshelve(Command):
4816
"""Restore shelved changes.
4818
By default, the most recently shelved changes are restored. However if you
4819
specify a patch by name those changes will be restored instead. This
4820
works best when the changes don't depend on each other.
4823
takes_args = ['shelf_id?']
4825
RegistryOption.from_kwargs(
4826
'action', help="The action to perform.",
4827
enum_switch=False, value_switches=True,
4828
apply="Apply changes and remove from the shelf.",
4829
dry_run="Show changes, but do not apply or remove them.",
4830
delete_only="Delete changes without applying them."
4833
_see_also = ['shelve']
4835
def run(self, shelf_id=None, action='apply'):
4836
from bzrlib.shelf_ui import Unshelver
4837
Unshelver.from_args(shelf_id, action).run()
4840
def _create_prefix(cur_transport):
4841
needed = [cur_transport]
4842
# Recurse upwards until we can create a directory successfully
4844
new_transport = cur_transport.clone('..')
4845
if new_transport.base == cur_transport.base:
4846
raise errors.BzrCommandError(
4847
"Failed to create path prefix for %s."
4848
% cur_transport.base)
4850
new_transport.mkdir('.')
4851
except errors.NoSuchFile:
4852
needed.append(new_transport)
4853
cur_transport = new_transport
4856
# Now we only need to create child directories
4858
cur_transport = needed.pop()
4859
cur_transport.ensure_base()
4862
# these get imported and then picked up by the scan for cmd_*
4863
# TODO: Some more consistent way to split command definitions across files;
4864
# we do need to load at least some information about them to know of
4865
# aliases. ideally we would avoid loading the implementation until the
4866
# details were needed.
4867
from bzrlib.cmd_version_info import cmd_version_info
4868
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4869
from bzrlib.bundle.commands import (
4872
from bzrlib.sign_my_commits import cmd_sign_my_commits
4873
from bzrlib.weave_commands import cmd_versionedfile_list, \
4874
cmd_weave_plan_merge, cmd_weave_merge_text
added
removed
bzrlib/builtins.py
