« back to all changes in this revision
Viewing changes to bzrlib/builtins.py
- browse files at revision 2625.8.2
- compare with another revision
- download diff
- download tarball
- view history from revision 2625.8.2
- Committer: Robert Collins
- Date: 2007-07-25 00:52:21 UTC
- mfrom: (2650 +trunk)
- mto: This revision was merged to the branch mainline in revision 2651.
- Revision ID: robertc@robertcollins.net-20070725005221-0ysm6il5mqnme3wz
Merge bzr.dev.
- files added:
- BRANCH.TODO
- bzrlib/benchmarks
- bzrlib/benchmarks/tree_creator
- bzrlib/bundle
- bzrlib/bundle/serializer
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/plugins/launchpad
- bzrlib/repofmt
- bzrlib/smart
- bzrlib/store
- bzrlib/store/revision
- bzrlib/store/versioned
- bzrlib/tests/blackbox
- bzrlib/tests/branch_implementations
- bzrlib/tests/bzrdir_implementations
- bzrlib/tests/commands
- bzrlib/tests/interrepository_implementations
- bzrlib/tests/intertree_implementations
- bzrlib/tests/interversionedfile_implementations
- bzrlib/tests/per_lock
- bzrlib/tests/repository_implementations
- bzrlib/tests/revisionstore_implementations
- bzrlib/tests/test_patches_data
- bzrlib/tests/tree_implementations
- bzrlib/tests/workingtree_implementations
- bzrlib/transport
- bzrlib/transport/http
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/tests
- bzrlib/version_info_formats
- contrib/emacs
- doc/developers
- man1
- tools/doc_generate
- tools/win32
- files removed:
- build-api
- notes
- patches
- plugins/changeset
- urlgrabber
- files renamed:
- bzrlib/changeset.py => bzrlib/bundle/__init__.py
- plugins/ => bzrlib/plugins/
- bzrlib/store.py => bzrlib/store/__init__.py
- bzrlib/selftest/ => bzrlib/tests/
- bzrlib/selftest/teststatus.py => bzrlib/tests/blackbox/test_status.py
- bzrlib/selftest/blackbox.py => bzrlib/tests/blackbox/test_too_much.py
- bzrlib/selftest/versioning.py => bzrlib/tests/blackbox/test_versioning.py
- bzrlib/selftest/testbranch.py => bzrlib/tests/branch_implementations/test_branch.py
- bzrlib/selftest/testhashcache.py => bzrlib/tests/test_hashcache.py
- bzrlib/selftest/testinv.py => bzrlib/tests/test_inv.py
- bzrlib/selftest/testmerge3.py => bzrlib/tests/test_merge3.py
- bzrlib/selftest/plugins.py => bzrlib/tests/test_plugins.py
- bzrlib/selftest/testrevisionnamespaces.py => bzrlib/tests/test_revisionnamespaces.py
- tools/testweave.py => bzrlib/tests/test_weave.py
- bzrlib/selftest/whitebox.py => bzrlib/tests/test_whitebox.py
- effbot/ => bzrlib/util/effbot/
- elementtree/ => bzrlib/util/elementtree/
- bzrlib/xml.py => bzrlib/xml_serializer.py
- bzrlib/newinventory.py => contrib/newinventory.py
- bzr-man.py => tools/doc_generate/autodoc_man.py
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/builtins.py
1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
2
#
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.
7
#
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.
12
#
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
16
17
"""builtin bzr commands"""
18
19
import os
20
from StringIO import StringIO
21
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
24
import codecs
25
import errno
26
import sys
27
import tempfile
28
import time
29
30
import bzrlib
31
from bzrlib import (
32
branch,
33
bugtracker,
34
bundle,
35
bzrdir,
36
delta,
37
config,
38
errors,
39
globbing,
40
ignores,
41
log,
42
merge as _mod_merge,
43
merge_directive,
44
osutils,
45
registry,
46
repository,
47
revision as _mod_revision,
48
revisionspec,
49
symbol_versioning,
50
transport,
51
tree as _mod_tree,
52
ui,
53
urlutils,
54
)
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.revisionspec import RevisionSpec
58
from bzrlib.smtp_connection import SMTPConnection
59
from bzrlib.workingtree import WorkingTree
60
""")
61
62
from bzrlib.commands import Command, display_command
63
from bzrlib.option import ListOption, Option, RegistryOption
64
from bzrlib.progress import DummyProgress, ProgressPhase
65
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
66
67
68
def tree_files(file_list, default_branch=u'.'):
69
try:
70
return internal_tree_files(file_list, default_branch)
71
except errors.FileInWrongBranch, e:
72
raise errors.BzrCommandError("%s is not in the same branch as %s" %
73
(e.path, file_list[0]))
74
75
76
# XXX: Bad function name; should possibly also be a class method of
77
# WorkingTree rather than a function.
78
def internal_tree_files(file_list, default_branch=u'.'):
79
"""Convert command-line paths to a WorkingTree and relative paths.
80
81
This is typically used for command-line processors that take one or
82
more filenames, and infer the workingtree that contains them.
83
84
The filenames given are not required to exist.
85
86
:param file_list: Filenames to convert.
87
88
:param default_branch: Fallback tree path to use if file_list is empty or
89
None.
90
91
:return: workingtree, [relative_paths]
92
"""
93
if file_list is None or len(file_list) == 0:
94
return WorkingTree.open_containing(default_branch)[0], file_list
95
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
96
new_list = []
97
for filename in file_list:
98
try:
99
new_list.append(tree.relpath(osutils.dereference_path(filename)))
100
except errors.PathNotChild:
101
raise errors.FileInWrongBranch(tree.branch, filename)
102
return tree, new_list
103
104
105
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
106
def get_format_type(typestring):
107
"""Parse and return a format specifier."""
108
# Have to use BzrDirMetaFormat1 directly, so that
109
# RepositoryFormat.set_default_format works
110
if typestring == "default":
111
return bzrdir.BzrDirMetaFormat1()
112
try:
113
return bzrdir.format_registry.make_bzrdir(typestring)
114
except KeyError:
115
msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
116
raise errors.BzrCommandError(msg)
117
118
119
# TODO: Make sure no commands unconditionally use the working directory as a
120
# branch. If a filename argument is used, the first of them should be used to
121
# specify the branch. (Perhaps this can be factored out into some kind of
122
# Argument class, representing a file in a branch, where the first occurrence
123
# opens the branch?)
124
125
class cmd_status(Command):
126
"""Display status summary.
127
128
This reports on versioned and unknown files, reporting them
129
grouped by state. Possible states are:
130
131
added
132
Versioned in the working copy but not in the previous revision.
133
134
removed
135
Versioned in the previous revision but removed or deleted
136
in the working copy.
137
138
renamed
139
Path of this file changed from the previous revision;
140
the text may also have changed. This includes files whose
141
parent directory was renamed.
142
143
modified
144
Text has changed since the previous revision.
145
146
kind changed
147
File kind has been changed (e.g. from file to directory).
148
149
unknown
150
Not versioned and not matching an ignore pattern.
151
152
To see ignored files use 'bzr ignored'. For details on the
153
changes to file texts, use 'bzr diff'.
154
155
--short gives a status flags for each item, similar to the SVN's status
156
command.
157
158
If no arguments are specified, the status of the entire working
159
directory is shown. Otherwise, only the status of the specified
160
files or directories is reported. If a directory is given, status
161
is reported for everything inside that directory.
162
163
If a revision argument is given, the status is calculated against
164
that revision, or between two revisions if two are provided.
165
"""
166
167
# TODO: --no-recurse, --recurse options
168
169
takes_args = ['file*']
170
takes_options = ['show-ids', 'revision',
171
Option('short', help='Give short SVN-style status lines.'),
172
Option('versioned', help='Only show versioned files.')]
173
aliases = ['st', 'stat']
174
175
encoding_type = 'replace'
176
_see_also = ['diff', 'revert', 'status-flags']
177
178
@display_command
179
def run(self, show_ids=False, file_list=None, revision=None, short=False,
180
versioned=False):
181
from bzrlib.status import show_tree_status
182
183
tree, file_list = tree_files(file_list)
184
185
show_tree_status(tree, show_ids=show_ids,
186
specific_files=file_list, revision=revision,
187
to_file=self.outf, short=short, versioned=versioned)
188
189
190
class cmd_cat_revision(Command):
191
"""Write out metadata for a revision.
192
193
The revision to print can either be specified by a specific
194
revision identifier, or you can use --revision.
195
"""
196
197
hidden = True
198
takes_args = ['revision_id?']
199
takes_options = ['revision']
200
# cat-revision is more for frontends so should be exact
201
encoding = 'strict'
202
203
@display_command
204
def run(self, revision_id=None, revision=None):
205
206
revision_id = osutils.safe_revision_id(revision_id, warn=False)
207
if revision_id is not None and revision is not None:
208
raise errors.BzrCommandError('You can only supply one of'
209
' revision_id or --revision')
210
if revision_id is None and revision is None:
211
raise errors.BzrCommandError('You must supply either'
212
' --revision or a revision_id')
213
b = WorkingTree.open_containing(u'.')[0].branch
214
215
# TODO: jam 20060112 should cat-revision always output utf-8?
216
if revision_id is not None:
217
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
218
elif revision is not None:
219
for rev in revision:
220
if rev is None:
221
raise errors.BzrCommandError('You cannot specify a NULL'
222
' revision.')
223
revno, rev_id = rev.in_history(b)
224
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
225
226
227
class cmd_remove_tree(Command):
228
"""Remove the working tree from a given branch/checkout.
229
230
Since a lightweight checkout is little more than a working tree
231
this will refuse to run against one.
232
233
To re-create the working tree, use "bzr checkout".
234
"""
235
_see_also = ['checkout', 'working-trees']
236
237
takes_args = ['location?']
238
239
def run(self, location='.'):
240
d = bzrdir.BzrDir.open(location)
241
242
try:
243
working = d.open_workingtree()
244
except errors.NoWorkingTree:
245
raise errors.BzrCommandError("No working tree to remove")
246
except errors.NotLocalUrl:
247
raise errors.BzrCommandError("You cannot remove the working tree of a "
248
"remote path")
249
250
working_path = working.bzrdir.root_transport.base
251
branch_path = working.branch.bzrdir.root_transport.base
252
if working_path != branch_path:
253
raise errors.BzrCommandError("You cannot remove the working tree from "
254
"a lightweight checkout")
255
256
d.destroy_workingtree()
257
258
259
class cmd_revno(Command):
260
"""Show current revision number.
261
262
This is equal to the number of revisions on this branch.
263
"""
264
265
_see_also = ['info']
266
takes_args = ['location?']
267
268
@display_command
269
def run(self, location=u'.'):
270
self.outf.write(str(Branch.open_containing(location)[0].revno()))
271
self.outf.write('\n')
272
273
274
class cmd_revision_info(Command):
275
"""Show revision number and revision id for a given revision identifier.
276
"""
277
hidden = True
278
takes_args = ['revision_info*']
279
takes_options = ['revision']
280
281
@display_command
282
def run(self, revision=None, revision_info_list=[]):
283
284
revs = []
285
if revision is not None:
286
revs.extend(revision)
287
if revision_info_list is not None:
288
for rev in revision_info_list:
289
revs.append(RevisionSpec.from_string(rev))
290
291
b = Branch.open_containing(u'.')[0]
292
293
if len(revs) == 0:
294
revs.append(RevisionSpec.from_string('-1'))
295
296
for rev in revs:
297
revinfo = rev.in_history(b)
298
if revinfo.revno is None:
299
dotted_map = b.get_revision_id_to_revno_map()
300
revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
301
print '%s %s' % (revno, revinfo.rev_id)
302
else:
303
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
304
305
306
class cmd_add(Command):
307
"""Add specified files or directories.
308
309
In non-recursive mode, all the named items are added, regardless
310
of whether they were previously ignored. A warning is given if
311
any of the named files are already versioned.
312
313
In recursive mode (the default), files are treated the same way
314
but the behaviour for directories is different. Directories that
315
are already versioned do not give a warning. All directories,
316
whether already versioned or not, are searched for files or
317
subdirectories that are neither versioned or ignored, and these
318
are added. This search proceeds recursively into versioned
319
directories. If no names are given '.' is assumed.
320
321
Therefore simply saying 'bzr add' will version all files that
322
are currently unknown.
323
324
Adding a file whose parent directory is not versioned will
325
implicitly add the parent, and so on up to the root. This means
326
you should never need to explicitly add a directory, they'll just
327
get added when you add a file in the directory.
328
329
--dry-run will show which files would be added, but not actually
330
add them.
331
332
--file-ids-from will try to use the file ids from the supplied path.
333
It looks up ids trying to find a matching parent directory with the
334
same filename, and then by pure path. This option is rarely needed
335
but can be useful when adding the same logical file into two
336
branches that will be merged later (without showing the two different
337
adds as a conflict). It is also useful when merging another project
338
into a subdirectory of this one.
339
"""
340
takes_args = ['file*']
341
takes_options = [
342
Option('no-recurse',
343
help="Don't recursively add the contents of directories."),
344
Option('dry-run',
345
help="Show what would be done, but don't actually do anything."),
346
'verbose',
347
Option('file-ids-from',
348
type=unicode,
349
help='Lookup file ids from this tree.'),
350
]
351
encoding_type = 'replace'
352
_see_also = ['remove']
353
354
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
355
file_ids_from=None):
356
import bzrlib.add
357
358
base_tree = None
359
if file_ids_from is not None:
360
try:
361
base_tree, base_path = WorkingTree.open_containing(
362
file_ids_from)
363
except errors.NoWorkingTree:
364
base_branch, base_path = Branch.open_containing(
365
file_ids_from)
366
base_tree = base_branch.basis_tree()
367
368
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
369
to_file=self.outf, should_print=(not is_quiet()))
370
else:
371
action = bzrlib.add.AddAction(to_file=self.outf,
372
should_print=(not is_quiet()))
373
374
if base_tree:
375
base_tree.lock_read()
376
try:
377
file_list = self._maybe_expand_globs(file_list)
378
if file_list:
379
tree = WorkingTree.open_containing(file_list[0])[0]
380
else:
381
tree = WorkingTree.open_containing(u'.')[0]
382
added, ignored = tree.smart_add(file_list, not
383
no_recurse, action=action, save=not dry_run)
384
finally:
385
if base_tree is not None:
386
base_tree.unlock()
387
if len(ignored) > 0:
388
if verbose:
389
for glob in sorted(ignored.keys()):
390
for path in ignored[glob]:
391
self.outf.write("ignored %s matching \"%s\"\n"
392
% (path, glob))
393
else:
394
match_len = 0
395
for glob, paths in ignored.items():
396
match_len += len(paths)
397
self.outf.write("ignored %d file(s).\n" % match_len)
398
self.outf.write("If you wish to add some of these files,"
399
" please add them by name.\n")
400
401
402
class cmd_mkdir(Command):
403
"""Create a new versioned directory.
404
405
This is equivalent to creating the directory and then adding it.
406
"""
407
408
takes_args = ['dir+']
409
encoding_type = 'replace'
410
411
def run(self, dir_list):
412
for d in dir_list:
413
os.mkdir(d)
414
wt, dd = WorkingTree.open_containing(d)
415
wt.add([dd])
416
self.outf.write('added %s\n' % d)
417
418
419
class cmd_relpath(Command):
420
"""Show path of a file relative to root"""
421
422
takes_args = ['filename']
423
hidden = True
424
425
@display_command
426
def run(self, filename):
427
# TODO: jam 20050106 Can relpath return a munged path if
428
# sys.stdout encoding cannot represent it?
429
tree, relpath = WorkingTree.open_containing(filename)
430
self.outf.write(relpath)
431
self.outf.write('\n')
432
433
434
class cmd_inventory(Command):
435
"""Show inventory of the current working copy or a revision.
436
437
It is possible to limit the output to a particular entry
438
type using the --kind option. For example: --kind file.
439
440
It is also possible to restrict the list of files to a specific
441
set. For example: bzr inventory --show-ids this/file
442
"""
443
444
hidden = True
445
_see_also = ['ls']
446
takes_options = [
447
'revision',
448
'show-ids',
449
Option('kind',
450
help='List entries of a particular kind: file, directory, symlink.',
451
type=unicode),
452
]
453
takes_args = ['file*']
454
455
@display_command
456
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
457
if kind and kind not in ['file', 'directory', 'symlink']:
458
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
459
460
work_tree, file_list = tree_files(file_list)
461
work_tree.lock_read()
462
try:
463
if revision is not None:
464
if len(revision) > 1:
465
raise errors.BzrCommandError(
466
'bzr inventory --revision takes exactly one revision'
467
' identifier')
468
revision_id = revision[0].in_history(work_tree.branch).rev_id
469
tree = work_tree.branch.repository.revision_tree(revision_id)
470
471
extra_trees = [work_tree]
472
tree.lock_read()
473
else:
474
tree = work_tree
475
extra_trees = []
476
477
if file_list is not None:
478
file_ids = tree.paths2ids(file_list, trees=extra_trees,
479
require_versioned=True)
480
# find_ids_across_trees may include some paths that don't
481
# exist in 'tree'.
482
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
483
for file_id in file_ids if file_id in tree)
484
else:
485
entries = tree.inventory.entries()
486
finally:
487
tree.unlock()
488
if tree is not work_tree:
489
work_tree.unlock()
490
491
for path, entry in entries:
492
if kind and kind != entry.kind:
493
continue
494
if show_ids:
495
self.outf.write('%-50s %s\n' % (path, entry.file_id))
496
else:
497
self.outf.write(path)
498
self.outf.write('\n')
499
500
501
class cmd_mv(Command):
502
"""Move or rename a file.
503
504
usage:
505
bzr mv OLDNAME NEWNAME
506
bzr mv SOURCE... DESTINATION
507
508
If the last argument is a versioned directory, all the other names
509
are moved into it. Otherwise, there must be exactly two arguments
510
and the file is changed to a new name.
511
512
If OLDNAME does not exist on the filesystem but is versioned and
513
NEWNAME does exist on the filesystem but is not versioned, mv
514
assumes that the file has been manually moved and only updates
515
its internal inventory to reflect that change.
516
The same is valid when moving many SOURCE files to a DESTINATION.
517
518
Files cannot be moved between branches.
519
"""
520
521
takes_args = ['names*']
522
takes_options = [Option("after", help="Move only the bzr identifier"
523
" of the file, because the file has already been moved."),
524
]
525
aliases = ['move', 'rename']
526
encoding_type = 'replace'
527
528
def run(self, names_list, after=False):
529
if names_list is None:
530
names_list = []
531
532
if len(names_list) < 2:
533
raise errors.BzrCommandError("missing file argument")
534
tree, rel_names = tree_files(names_list)
535
536
if os.path.isdir(names_list[-1]):
537
# move into existing directory
538
for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
539
self.outf.write("%s => %s\n" % pair)
540
else:
541
if len(names_list) != 2:
542
raise errors.BzrCommandError('to mv multiple files the'
543
' destination must be a versioned'
544
' directory')
545
tree.rename_one(rel_names[0], rel_names[1], after=after)
546
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
547
548
549
class cmd_pull(Command):
550
"""Turn this branch into a mirror of another branch.
551
552
This command only works on branches that have not diverged. Branches are
553
considered diverged if the destination branch's most recent commit is one
554
that has not been merged (directly or indirectly) into the parent.
555
556
If branches have diverged, you can use 'bzr merge' to integrate the changes
557
from one into the other. Once one branch has merged, the other should
558
be able to pull it again.
559
560
If you want to forget your local changes and just update your branch to
561
match the remote one, use pull --overwrite.
562
563
If there is no default location set, the first pull will set it. After
564
that, you can omit the location to use the default. To change the
565
default, use --remember. The value will only be saved if the remote
566
location can be accessed.
567
"""
568
569
_see_also = ['push', 'update', 'status-flags']
570
takes_options = ['remember', 'overwrite', 'revision', 'verbose',
571
Option('directory',
572
help='Branch to pull into, '
573
'rather than the one containing the working directory.',
574
short_name='d',
575
type=unicode,
576
),
577
]
578
takes_args = ['location?']
579
encoding_type = 'replace'
580
581
def run(self, location=None, remember=False, overwrite=False,
582
revision=None, verbose=False,
583
directory=None):
584
from bzrlib.tag import _merge_tags_if_possible
585
# FIXME: too much stuff is in the command class
586
revision_id = None
587
mergeable = None
588
if directory is None:
589
directory = u'.'
590
try:
591
tree_to = WorkingTree.open_containing(directory)[0]
592
branch_to = tree_to.branch
593
except errors.NoWorkingTree:
594
tree_to = None
595
branch_to = Branch.open_containing(directory)[0]
596
597
if location is not None:
598
mergeable, location_transport = _get_bundle_helper(location)
599
600
stored_loc = branch_to.get_parent()
601
if location is None:
602
if stored_loc is None:
603
raise errors.BzrCommandError("No pull location known or"
604
" specified.")
605
else:
606
display_url = urlutils.unescape_for_display(stored_loc,
607
self.outf.encoding)
608
self.outf.write("Using saved location: %s\n" % display_url)
609
location = stored_loc
610
location_transport = transport.get_transport(location)
611
612
if mergeable is not None:
613
if revision is not None:
614
raise errors.BzrCommandError(
615
'Cannot use -r with merge directives or bundles')
616
mergeable.install_revisions(branch_to.repository)
617
base_revision_id, revision_id, verified = \
618
mergeable.get_merge_request(branch_to.repository)
619
branch_from = branch_to
620
else:
621
branch_from = Branch.open_from_transport(location_transport)
622
623
if branch_to.get_parent() is None or remember:
624
branch_to.set_parent(branch_from.base)
625
626
if revision is not None:
627
if len(revision) == 1:
628
revision_id = revision[0].in_history(branch_from).rev_id
629
else:
630
raise errors.BzrCommandError(
631
'bzr pull --revision takes one value.')
632
633
if verbose:
634
old_rh = branch_to.revision_history()
635
if tree_to is not None:
636
result = tree_to.pull(branch_from, overwrite, revision_id,
637
delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
638
else:
639
result = branch_to.pull(branch_from, overwrite, revision_id)
640
641
result.report(self.outf)
642
if verbose:
643
from bzrlib.log import show_changed_revisions
644
new_rh = branch_to.revision_history()
645
show_changed_revisions(branch_to, old_rh, new_rh,
646
to_file=self.outf)
647
648
649
class cmd_push(Command):
650
"""Update a mirror of this branch.
651
652
The target branch will not have its working tree populated because this
653
is both expensive, and is not supported on remote file systems.
654
655
Some smart servers or protocols *may* put the working tree in place in
656
the future.
657
658
This command only works on branches that have not diverged. Branches are
659
considered diverged if the destination branch's most recent commit is one
660
that has not been merged (directly or indirectly) by the source branch.
661
662
If branches have diverged, you can use 'bzr push --overwrite' to replace
663
the other branch completely, discarding its unmerged changes.
664
665
If you want to ensure you have the different changes in the other branch,
666
do a merge (see bzr help merge) from the other branch, and commit that.
667
After that you will be able to do a push without '--overwrite'.
668
669
If there is no default push location set, the first push will set it.
670
After that, you can omit the location to use the default. To change the
671
default, use --remember. The value will only be saved if the remote
672
location can be accessed.
673
"""
674
675
_see_also = ['pull', 'update', 'working-trees']
676
takes_options = ['remember', 'overwrite', 'verbose',
677
Option('create-prefix',
678
help='Create the path leading up to the branch '
679
'if it does not already exist.'),
680
Option('directory',
681
help='Branch to push from, '
682
'rather than the one containing the working directory.',
683
short_name='d',
684
type=unicode,
685
),
686
Option('use-existing-dir',
687
help='By default push will fail if the target'
688
' directory exists, but does not already'
689
' have a control directory. This flag will'
690
' allow push to proceed.'),
691
]
692
takes_args = ['location?']
693
encoding_type = 'replace'
694
695
def run(self, location=None, remember=False, overwrite=False,
696
create_prefix=False, verbose=False,
697
use_existing_dir=False,
698
directory=None):
699
# FIXME: Way too big! Put this into a function called from the
700
# command.
701
if directory is None:
702
directory = '.'
703
br_from = Branch.open_containing(directory)[0]
704
stored_loc = br_from.get_push_location()
705
if location is None:
706
if stored_loc is None:
707
raise errors.BzrCommandError("No push location known or specified.")
708
else:
709
display_url = urlutils.unescape_for_display(stored_loc,
710
self.outf.encoding)
711
self.outf.write("Using saved location: %s\n" % display_url)
712
location = stored_loc
713
714
to_transport = transport.get_transport(location)
715
716
br_to = repository_to = dir_to = None
717
try:
718
dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
719
except errors.NotBranchError:
720
pass # Didn't find anything
721
else:
722
# If we can open a branch, use its direct repository, otherwise see
723
# if there is a repository without a branch.
724
try:
725
br_to = dir_to.open_branch()
726
except errors.NotBranchError:
727
# Didn't find a branch, can we find a repository?
728
try:
729
repository_to = dir_to.find_repository()
730
except errors.NoRepositoryPresent:
731
pass
732
else:
733
# Found a branch, so we must have found a repository
734
repository_to = br_to.repository
735
push_result = None
736
if verbose:
737
old_rh = []
738
if dir_to is None:
739
# The destination doesn't exist; create it.
740
# XXX: Refactor the create_prefix/no_create_prefix code into a
741
# common helper function
742
try:
743
to_transport.mkdir('.')
744
except errors.FileExists:
745
if not use_existing_dir:
746
raise errors.BzrCommandError("Target directory %s"
747
" already exists, but does not have a valid .bzr"
748
" directory. Supply --use-existing-dir to push"
749
" there anyway." % location)
750
except errors.NoSuchFile:
751
if not create_prefix:
752
raise errors.BzrCommandError("Parent directory of %s"
753
" does not exist."
754
"\nYou may supply --create-prefix to create all"
755
" leading parent directories."
756
% location)
757
_create_prefix(to_transport)
758
759
# Now the target directory exists, but doesn't have a .bzr
760
# directory. So we need to create it, along with any work to create
761
# all of the dependent branches, etc.
762
dir_to = br_from.bzrdir.clone_on_transport(to_transport,
763
revision_id=br_from.last_revision())
764
br_to = dir_to.open_branch()
765
# TODO: Some more useful message about what was copied
766
note('Created new branch.')
767
# We successfully created the target, remember it
768
if br_from.get_push_location() is None or remember:
769
br_from.set_push_location(br_to.base)
770
elif repository_to is None:
771
# we have a bzrdir but no branch or repository
772
# XXX: Figure out what to do other than complain.
773
raise errors.BzrCommandError("At %s you have a valid .bzr control"
774
" directory, but not a branch or repository. This is an"
775
" unsupported configuration. Please move the target directory"
776
" out of the way and try again."
777
% location)
778
elif br_to is None:
779
# We have a repository but no branch, copy the revisions, and then
780
# create a branch.
781
last_revision_id = br_from.last_revision()
782
repository_to.fetch(br_from.repository,
783
revision_id=last_revision_id)
784
br_to = br_from.clone(dir_to, revision_id=last_revision_id)
785
note('Created new branch.')
786
if br_from.get_push_location() is None or remember:
787
br_from.set_push_location(br_to.base)
788
else: # We have a valid to branch
789
# We were able to connect to the remote location, so remember it
790
# we don't need to successfully push because of possible divergence.
791
if br_from.get_push_location() is None or remember:
792
br_from.set_push_location(br_to.base)
793
if verbose:
794
old_rh = br_to.revision_history()
795
try:
796
try:
797
tree_to = dir_to.open_workingtree()
798
except errors.NotLocalUrl:
799
warning("This transport does not update the working "
800
"tree of: %s. See 'bzr help working-trees' for "
801
"more information." % br_to.base)
802
push_result = br_from.push(br_to, overwrite)
803
except errors.NoWorkingTree:
804
push_result = br_from.push(br_to, overwrite)
805
else:
806
tree_to.lock_write()
807
try:
808
push_result = br_from.push(tree_to.branch, overwrite)
809
tree_to.update()
810
finally:
811
tree_to.unlock()
812
except errors.DivergedBranches:
813
raise errors.BzrCommandError('These branches have diverged.'
814
' Try using "merge" and then "push".')
815
if push_result is not None:
816
push_result.report(self.outf)
817
elif verbose:
818
new_rh = br_to.revision_history()
819
if old_rh != new_rh:
820
# Something changed
821
from bzrlib.log import show_changed_revisions
822
show_changed_revisions(br_to, old_rh, new_rh,
823
to_file=self.outf)
824
else:
825
# we probably did a clone rather than a push, so a message was
826
# emitted above
827
pass
828
829
830
class cmd_branch(Command):
831
"""Create a new copy of a branch.
832
833
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
834
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
835
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
836
is derived from the FROM_LOCATION by stripping a leading scheme or drive
837
identifier, if any. For example, "branch lp:foo-bar" will attempt to
838
create ./foo-bar.
839
840
To retrieve the branch as of a particular revision, supply the --revision
841
parameter, as in "branch foo/bar -r 5".
842
"""
843
844
_see_also = ['checkout']
845
takes_args = ['from_location', 'to_location?']
846
takes_options = ['revision']
847
aliases = ['get', 'clone']
848
849
def run(self, from_location, to_location=None, revision=None):
850
from bzrlib.tag import _merge_tags_if_possible
851
if revision is None:
852
revision = [None]
853
elif len(revision) > 1:
854
raise errors.BzrCommandError(
855
'bzr branch --revision takes exactly 1 revision value')
856
857
br_from = Branch.open(from_location)
858
br_from.lock_read()
859
try:
860
if len(revision) == 1 and revision[0] is not None:
861
revision_id = revision[0].in_history(br_from)[1]
862
else:
863
# FIXME - wt.last_revision, fallback to branch, fall back to
864
# None or perhaps NULL_REVISION to mean copy nothing
865
# RBC 20060209
866
revision_id = br_from.last_revision()
867
if to_location is None:
868
to_location = urlutils.derive_to_location(from_location)
869
name = None
870
else:
871
name = os.path.basename(to_location) + '\n'
872
873
to_transport = transport.get_transport(to_location)
874
try:
875
to_transport.mkdir('.')
876
except errors.FileExists:
877
raise errors.BzrCommandError('Target directory "%s" already'
878
' exists.' % to_location)
879
except errors.NoSuchFile:
880
raise errors.BzrCommandError('Parent of "%s" does not exist.'
881
% to_location)
882
try:
883
# preserve whatever source format we have.
884
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
885
possible_transports=[to_transport])
886
branch = dir.open_branch()
887
except errors.NoSuchRevision:
888
to_transport.delete_tree('.')
889
msg = "The branch %s has no revision %s." % (from_location, revision[0])
890
raise errors.BzrCommandError(msg)
891
if name:
892
branch.control_files.put_utf8('branch-name', name)
893
_merge_tags_if_possible(br_from, branch)
894
note('Branched %d revision(s).' % branch.revno())
895
finally:
896
br_from.unlock()
897
898
899
class cmd_checkout(Command):
900
"""Create a new checkout of an existing branch.
901
902
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
903
the branch found in '.'. This is useful if you have removed the working tree
904
or if it was never created - i.e. if you pushed the branch to its current
905
location using SFTP.
906
907
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
908
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
909
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
910
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
911
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
912
create ./foo-bar.
913
914
To retrieve the branch as of a particular revision, supply the --revision
915
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
916
out of date [so you cannot commit] but it may be useful (i.e. to examine old
917
code.)
918
"""
919
920
_see_also = ['checkouts', 'branch']
921
takes_args = ['branch_location?', 'to_location?']
922
takes_options = ['revision',
923
Option('lightweight',
924
help="Perform a lightweight checkout. Lightweight "
925
"checkouts depend on access to the branch for "
926
"every operation. Normal checkouts can perform "
927
"common operations like diff and status without "
928
"such access, and also support local commits."
929
),
930
]
931
aliases = ['co']
932
933
def run(self, branch_location=None, to_location=None, revision=None,
934
lightweight=False):
935
if revision is None:
936
revision = [None]
937
elif len(revision) > 1:
938
raise errors.BzrCommandError(
939
'bzr checkout --revision takes exactly 1 revision value')
940
if branch_location is None:
941
branch_location = osutils.getcwd()
942
to_location = branch_location
943
source = Branch.open(branch_location)
944
if len(revision) == 1 and revision[0] is not None:
945
revision_id = _mod_revision.ensure_null(
946
revision[0].in_history(source)[1])
947
else:
948
revision_id = None
949
if to_location is None:
950
to_location = urlutils.derive_to_location(branch_location)
951
# if the source and to_location are the same,
952
# and there is no working tree,
953
# then reconstitute a branch
954
if (osutils.abspath(to_location) ==
955
osutils.abspath(branch_location)):
956
try:
957
source.bzrdir.open_workingtree()
958
except errors.NoWorkingTree:
959
source.bzrdir.create_workingtree(revision_id)
960
return
961
try:
962
os.mkdir(to_location)
963
except OSError, e:
964
if e.errno == errno.EEXIST:
965
raise errors.BzrCommandError('Target directory "%s" already'
966
' exists.' % to_location)
967
if e.errno == errno.ENOENT:
968
raise errors.BzrCommandError('Parent of "%s" does not exist.'
969
% to_location)
970
else:
971
raise
972
source.create_checkout(to_location, revision_id, lightweight)
973
974
975
class cmd_renames(Command):
976
"""Show list of renamed files.
977
"""
978
# TODO: Option to show renames between two historical versions.
979
980
# TODO: Only show renames under dir, rather than in the whole branch.
981
_see_also = ['status']
982
takes_args = ['dir?']
983
984
@display_command
985
def run(self, dir=u'.'):
986
tree = WorkingTree.open_containing(dir)[0]
987
tree.lock_read()
988
try:
989
new_inv = tree.inventory
990
old_tree = tree.basis_tree()
991
old_tree.lock_read()
992
try:
993
old_inv = old_tree.inventory
994
renames = list(_mod_tree.find_renames(old_inv, new_inv))
995
renames.sort()
996
for old_name, new_name in renames:
997
self.outf.write("%s => %s\n" % (old_name, new_name))
998
finally:
999
old_tree.unlock()
1000
finally:
1001
tree.unlock()
1002
1003
1004
class cmd_update(Command):
1005
"""Update a tree to have the latest code committed to its branch.
1006
1007
This will perform a merge into the working tree, and may generate
1008
conflicts. If you have any local changes, you will still
1009
need to commit them after the update for the update to be complete.
1010
1011
If you want to discard your local changes, you can just do a
1012
'bzr revert' instead of 'bzr commit' after the update.
1013
"""
1014
1015
_see_also = ['pull', 'working-trees', 'status-flags']
1016
takes_args = ['dir?']
1017
aliases = ['up']
1018
1019
def run(self, dir='.'):
1020
tree = WorkingTree.open_containing(dir)[0]
1021
master = tree.branch.get_master_branch()
1022
if master is not None:
1023
tree.lock_write()
1024
else:
1025
tree.lock_tree_write()
1026
try:
1027
existing_pending_merges = tree.get_parent_ids()[1:]
1028
last_rev = _mod_revision.ensure_null(tree.last_revision())
1029
if last_rev == _mod_revision.ensure_null(
1030
tree.branch.last_revision()):
1031
# may be up to date, check master too.
1032
master = tree.branch.get_master_branch()
1033
if master is None or last_rev == _mod_revision.ensure_null(
1034
master.last_revision()):
1035
revno = tree.branch.revision_id_to_revno(last_rev)
1036
note("Tree is up to date at revision %d." % (revno,))
1037
return 0
1038
conflicts = tree.update(delta._ChangeReporter(
1039
unversioned_filter=tree.is_ignored))
1040
revno = tree.branch.revision_id_to_revno(
1041
_mod_revision.ensure_null(tree.last_revision()))
1042
note('Updated to revision %d.' % (revno,))
1043
if tree.get_parent_ids()[1:] != existing_pending_merges:
1044
note('Your local commits will now show as pending merges with '
1045
"'bzr status', and can be committed with 'bzr commit'.")
1046
if conflicts != 0:
1047
return 1
1048
else:
1049
return 0
1050
finally:
1051
tree.unlock()
1052
1053
1054
class cmd_info(Command):
1055
"""Show information about a working tree, branch or repository.
1056
1057
This command will show all known locations and formats associated to the
1058
tree, branch or repository. Statistical information is included with
1059
each report.
1060
1061
Branches and working trees will also report any missing revisions.
1062
"""
1063
_see_also = ['revno', 'working-trees', 'repositories']
1064
takes_args = ['location?']
1065
takes_options = ['verbose']
1066
1067
@display_command
1068
def run(self, location=None, verbose=0):
1069
from bzrlib.info import show_bzrdir_info
1070
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1071
verbose=verbose)
1072
1073
1074
class cmd_remove(Command):
1075
"""Remove files or directories.
1076
1077
This makes bzr stop tracking changes to the specified files and
1078
delete them if they can easily be recovered using revert.
1079
1080
You can specify one or more files, and/or --new. If you specify --new,
1081
only 'added' files will be removed. If you specify both, then new files
1082
in the specified directories will be removed. If the directories are
1083
also new, they will also be removed.
1084
"""
1085
takes_args = ['file*']
1086
takes_options = ['verbose',
1087
Option('new', help='Remove newly-added files.'),
1088
RegistryOption.from_kwargs('file-deletion-strategy',
1089
'The file deletion mode to be used',
1090
title='Deletion Strategy', value_switches=True, enum_switch=False,
1091
safe='Only delete files if they can be'
1092
' safely recovered (default).',
1093
keep="Don't delete any files.",
1094
force='Delete all the specified files, even if they can not be '
1095
'recovered and even if they are non-empty directories.')]
1096
aliases = ['rm']
1097
encoding_type = 'replace'
1098
1099
def run(self, file_list, verbose=False, new=False,
1100
file_deletion_strategy='safe'):
1101
tree, file_list = tree_files(file_list)
1102
1103
if file_list is not None:
1104
file_list = [f for f in file_list if f != '']
1105
elif not new:
1106
raise errors.BzrCommandError('Specify one or more files to'
1107
' remove, or use --new.')
1108
1109
if new:
1110
added = tree.changes_from(tree.basis_tree(),
1111
specific_files=file_list).added
1112
file_list = sorted([f[0] for f in added], reverse=True)
1113
if len(file_list) == 0:
1114
raise errors.BzrCommandError('No matching files.')
1115
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1116
keep_files=file_deletion_strategy=='keep',
1117
force=file_deletion_strategy=='force')
1118
1119
1120
class cmd_file_id(Command):
1121
"""Print file_id of a particular file or directory.
1122
1123
The file_id is assigned when the file is first added and remains the
1124
same through all revisions where the file exists, even when it is
1125
moved or renamed.
1126
"""
1127
1128
hidden = True
1129
_see_also = ['inventory', 'ls']
1130
takes_args = ['filename']
1131
1132
@display_command
1133
def run(self, filename):
1134
tree, relpath = WorkingTree.open_containing(filename)
1135
i = tree.path2id(relpath)
1136
if i is None:
1137
raise errors.NotVersionedError(filename)
1138
else:
1139
self.outf.write(i + '\n')
1140
1141
1142
class cmd_file_path(Command):
1143
"""Print path of file_ids to a file or directory.
1144
1145
This prints one line for each directory down to the target,
1146
starting at the branch root.
1147
"""
1148
1149
hidden = True
1150
takes_args = ['filename']
1151
1152
@display_command
1153
def run(self, filename):
1154
tree, relpath = WorkingTree.open_containing(filename)
1155
fid = tree.path2id(relpath)
1156
if fid is None:
1157
raise errors.NotVersionedError(filename)
1158
segments = osutils.splitpath(relpath)
1159
for pos in range(1, len(segments) + 1):
1160
path = osutils.joinpath(segments[:pos])
1161
self.outf.write("%s\n" % tree.path2id(path))
1162
1163
1164
class cmd_reconcile(Command):
1165
"""Reconcile bzr metadata in a branch.
1166
1167
This can correct data mismatches that may have been caused by
1168
previous ghost operations or bzr upgrades. You should only
1169
need to run this command if 'bzr check' or a bzr developer
1170
advises you to run it.
1171
1172
If a second branch is provided, cross-branch reconciliation is
1173
also attempted, which will check that data like the tree root
1174
id which was not present in very early bzr versions is represented
1175
correctly in both branches.
1176
1177
At the same time it is run it may recompress data resulting in
1178
a potential saving in disk space or performance gain.
1179
1180
The branch *MUST* be on a listable system such as local disk or sftp.
1181
"""
1182
1183
_see_also = ['check']
1184
takes_args = ['branch?']
1185
1186
def run(self, branch="."):
1187
from bzrlib.reconcile import reconcile
1188
dir = bzrdir.BzrDir.open(branch)
1189
reconcile(dir)
1190
1191
1192
class cmd_revision_history(Command):
1193
"""Display the list of revision ids on a branch."""
1194
1195
_see_also = ['log']
1196
takes_args = ['location?']
1197
1198
hidden = True
1199
1200
@display_command
1201
def run(self, location="."):
1202
branch = Branch.open_containing(location)[0]
1203
for revid in branch.revision_history():
1204
self.outf.write(revid)
1205
self.outf.write('\n')
1206
1207
1208
class cmd_ancestry(Command):
1209
"""List all revisions merged into this branch."""
1210
1211
_see_also = ['log', 'revision-history']
1212
takes_args = ['location?']
1213
1214
hidden = True
1215
1216
@display_command
1217
def run(self, location="."):
1218
try:
1219
wt = WorkingTree.open_containing(location)[0]
1220
except errors.NoWorkingTree:
1221
b = Branch.open(location)
1222
last_revision = b.last_revision()
1223
else:
1224
b = wt.branch
1225
last_revision = wt.last_revision()
1226
1227
revision_ids = b.repository.get_ancestry(last_revision)
1228
assert revision_ids[0] is None
1229
revision_ids.pop(0)
1230
for revision_id in revision_ids:
1231
self.outf.write(revision_id + '\n')
1232
1233
1234
class cmd_init(Command):
1235
"""Make a directory into a versioned branch.
1236
1237
Use this to create an empty branch, or before importing an
1238
existing project.
1239
1240
If there is a repository in a parent directory of the location, then
1241
the history of the branch will be stored in the repository. Otherwise
1242
init creates a standalone branch which carries its own history
1243
in the .bzr directory.
1244
1245
If there is already a branch at the location but it has no working tree,
1246
the tree can be populated with 'bzr checkout'.
1247
1248
Recipe for importing a tree of files:
1249
cd ~/project
1250
bzr init
1251
bzr add .
1252
bzr status
1253
bzr commit -m 'imported project'
1254
"""
1255
1256
_see_also = ['init-repo', 'branch', 'checkout']
1257
takes_args = ['location?']
1258
takes_options = [
1259
Option('create-prefix',
1260
help='Create the path leading up to the branch '
1261
'if it does not already exist.'),
1262
RegistryOption('format',
1263
help='Specify a format for this branch. '
1264
'See "help formats".',
1265
registry=bzrdir.format_registry,
1266
converter=bzrdir.format_registry.make_bzrdir,
1267
value_switches=True,
1268
title="Branch Format",
1269
),
1270
Option('append-revisions-only',
1271
help='Never change revnos or the existing log.'
1272
' Append revisions to it only.')
1273
]
1274
def run(self, location=None, format=None, append_revisions_only=False,
1275
create_prefix=False):
1276
if format is None:
1277
format = bzrdir.format_registry.make_bzrdir('default')
1278
if location is None:
1279
location = u'.'
1280
1281
to_transport = transport.get_transport(location)
1282
1283
# The path has to exist to initialize a
1284
# branch inside of it.
1285
# Just using os.mkdir, since I don't
1286
# believe that we want to create a bunch of
1287
# locations if the user supplies an extended path
1288
try:
1289
to_transport.ensure_base()
1290
except errors.NoSuchFile:
1291
if not create_prefix:
1292
raise errors.BzrCommandError("Parent directory of %s"
1293
" does not exist."
1294
"\nYou may supply --create-prefix to create all"
1295
" leading parent directories."
1296
% location)
1297
_create_prefix(to_transport)
1298
1299
try:
1300
existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1301
except errors.NotBranchError:
1302
# really a NotBzrDir error...
1303
create_branch = bzrdir.BzrDir.create_branch_convenience
1304
branch = create_branch(to_transport.base, format=format,
1305
possible_transports=[to_transport])
1306
else:
1307
from bzrlib.transport.local import LocalTransport
1308
if existing_bzrdir.has_branch():
1309
if (isinstance(to_transport, LocalTransport)
1310
and not existing_bzrdir.has_workingtree()):
1311
raise errors.BranchExistsWithoutWorkingTree(location)
1312
raise errors.AlreadyBranchError(location)
1313
else:
1314
branch = existing_bzrdir.create_branch()
1315
existing_bzrdir.create_workingtree()
1316
if append_revisions_only:
1317
try:
1318
branch.set_append_revisions_only(True)
1319
except errors.UpgradeRequired:
1320
raise errors.BzrCommandError('This branch format cannot be set'
1321
' to append-revisions-only. Try --experimental-branch6')
1322
1323
1324
class cmd_init_repository(Command):
1325
"""Create a shared repository to hold branches.
1326
1327
New branches created under the repository directory will store their
1328
revisions in the repository, not in the branch directory.
1329
1330
If the --no-trees option is used then the branches in the repository
1331
will not have working trees by default.
1332
1333
example:
1334
bzr init-repo --no-trees repo
1335
bzr init repo/trunk
1336
bzr checkout --lightweight repo/trunk trunk-checkout
1337
cd trunk-checkout
1338
(add files here)
1339
1340
See 'bzr help repositories' for more information.
1341
"""
1342
1343
_see_also = ['init', 'branch', 'checkout']
1344
takes_args = ["location"]
1345
takes_options = [RegistryOption('format',
1346
help='Specify a format for this repository. See'
1347
' "bzr help formats" for details.',
1348
registry=bzrdir.format_registry,
1349
converter=bzrdir.format_registry.make_bzrdir,
1350
value_switches=True, title='Repository format'),
1351
Option('no-trees',
1352
help='Branches in the repository will default to'
1353
' not having a working tree.'),
1354
]
1355
aliases = ["init-repo"]
1356
1357
def run(self, location, format=None, no_trees=False):
1358
if format is None:
1359
format = bzrdir.format_registry.make_bzrdir('default')
1360
1361
if location is None:
1362
location = '.'
1363
1364
to_transport = transport.get_transport(location)
1365
to_transport.ensure_base()
1366
1367
newdir = format.initialize_on_transport(to_transport)
1368
repo = newdir.create_repository(shared=True)
1369
repo.set_make_working_trees(not no_trees)
1370
1371
1372
class cmd_diff(Command):
1373
"""Show differences in the working tree or between revisions.
1374
1375
If files are listed, only the changes in those files are listed.
1376
Otherwise, all changes for the tree are listed.
1377
1378
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1379
produces patches suitable for "patch -p1".
1380
1381
examples:
1382
bzr diff
1383
Shows the difference in the working tree versus the last commit
1384
bzr diff -r1
1385
Difference between the working tree and revision 1
1386
bzr diff -r1..2
1387
Difference between revision 2 and revision 1
1388
bzr diff --prefix old/:new/
1389
Same as 'bzr diff' but prefix paths with old/ and new/
1390
bzr diff bzr.mine bzr.dev
1391
Show the differences between the two working trees
1392
bzr diff foo.c
1393
Show just the differences for 'foo.c'
1394
"""
1395
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1396
# or a graphical diff.
1397
1398
# TODO: Python difflib is not exactly the same as unidiff; should
1399
# either fix it up or prefer to use an external diff.
1400
1401
# TODO: Selected-file diff is inefficient and doesn't show you
1402
# deleted files.
1403
1404
# TODO: This probably handles non-Unix newlines poorly.
1405
1406
_see_also = ['status']
1407
takes_args = ['file*']
1408
takes_options = [
1409
Option('diff-options', type=str,
1410
help='Pass these options to the external diff program.'),
1411
Option('prefix', type=str,
1412
short_name='p',
1413
help='Set prefixes to added to old and new filenames, as '
1414
'two values separated by a colon. (eg "old/:new/").'),
1415
'revision',
1416
]
1417
aliases = ['di', 'dif']
1418
encoding_type = 'exact'
1419
1420
@display_command
1421
def run(self, revision=None, file_list=None, diff_options=None,
1422
prefix=None):
1423
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1424
1425
if (prefix is None) or (prefix == '0'):
1426
# diff -p0 format
1427
old_label = ''
1428
new_label = ''
1429
elif prefix == '1':
1430
old_label = 'old/'
1431
new_label = 'new/'
1432
elif ':' in prefix:
1433
old_label, new_label = prefix.split(":")
1434
else:
1435
raise errors.BzrCommandError(
1436
'--prefix expects two values separated by a colon'
1437
' (eg "old/:new/")')
1438
1439
if revision and len(revision) > 2:
1440
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1441
' one or two revision specifiers')
1442
1443
try:
1444
tree1, file_list = internal_tree_files(file_list)
1445
tree2 = None
1446
b = None
1447
b2 = None
1448
except errors.FileInWrongBranch:
1449
if len(file_list) != 2:
1450
raise errors.BzrCommandError("Files are in different branches")
1451
1452
tree1, file1 = WorkingTree.open_containing(file_list[0])
1453
tree2, file2 = WorkingTree.open_containing(file_list[1])
1454
if file1 != "" or file2 != "":
1455
# FIXME diff those two files. rbc 20051123
1456
raise errors.BzrCommandError("Files are in different branches")
1457
file_list = None
1458
except errors.NotBranchError:
1459
if (revision is not None and len(revision) == 2
1460
and not revision[0].needs_branch()
1461
and not revision[1].needs_branch()):
1462
# If both revision specs include a branch, we can
1463
# diff them without needing a local working tree
1464
tree1, tree2 = None, None
1465
else:
1466
raise
1467
1468
if tree2 is not None:
1469
if revision is not None:
1470
# FIXME: but there should be a clean way to diff between
1471
# non-default versions of two trees, it's not hard to do
1472
# internally...
1473
raise errors.BzrCommandError(
1474
"Sorry, diffing arbitrary revisions across branches "
1475
"is not implemented yet")
1476
return show_diff_trees(tree1, tree2, sys.stdout,
1477
specific_files=file_list,
1478
external_diff_options=diff_options,
1479
old_label=old_label, new_label=new_label)
1480
1481
return diff_cmd_helper(tree1, file_list, diff_options,
1482
revision_specs=revision,
1483
old_label=old_label, new_label=new_label)
1484
1485
1486
class cmd_deleted(Command):
1487
"""List files deleted in the working tree.
1488
"""
1489
# TODO: Show files deleted since a previous revision, or
1490
# between two revisions.
1491
# TODO: Much more efficient way to do this: read in new
1492
# directories with readdir, rather than stating each one. Same
1493
# level of effort but possibly much less IO. (Or possibly not,
1494
# if the directories are very large...)
1495
_see_also = ['status', 'ls']
1496
takes_options = ['show-ids']
1497
1498
@display_command
1499
def run(self, show_ids=False):
1500
tree = WorkingTree.open_containing(u'.')[0]
1501
tree.lock_read()
1502
try:
1503
old = tree.basis_tree()
1504
old.lock_read()
1505
try:
1506
for path, ie in old.inventory.iter_entries():
1507
if not tree.has_id(ie.file_id):
1508
self.outf.write(path)
1509
if show_ids:
1510
self.outf.write(' ')
1511
self.outf.write(ie.file_id)
1512
self.outf.write('\n')
1513
finally:
1514
old.unlock()
1515
finally:
1516
tree.unlock()
1517
1518
1519
class cmd_modified(Command):
1520
"""List files modified in working tree.
1521
"""
1522
1523
hidden = True
1524
_see_also = ['status', 'ls']
1525
1526
@display_command
1527
def run(self):
1528
tree = WorkingTree.open_containing(u'.')[0]
1529
td = tree.changes_from(tree.basis_tree())
1530
for path, id, kind, text_modified, meta_modified in td.modified:
1531
self.outf.write(path + '\n')
1532
1533
1534
class cmd_added(Command):
1535
"""List files added in working tree.
1536
"""
1537
1538
hidden = True
1539
_see_also = ['status', 'ls']
1540
1541
@display_command
1542
def run(self):
1543
wt = WorkingTree.open_containing(u'.')[0]
1544
wt.lock_read()
1545
try:
1546
basis = wt.basis_tree()
1547
basis.lock_read()
1548
try:
1549
basis_inv = basis.inventory
1550
inv = wt.inventory
1551
for file_id in inv:
1552
if file_id in basis_inv:
1553
continue
1554
if inv.is_root(file_id) and len(basis_inv) == 0:
1555
continue
1556
path = inv.id2path(file_id)
1557
if not os.access(osutils.abspath(path), os.F_OK):
1558
continue
1559
self.outf.write(path + '\n')
1560
finally:
1561
basis.unlock()
1562
finally:
1563
wt.unlock()
1564
1565
1566
class cmd_root(Command):
1567
"""Show the tree root directory.
1568
1569
The root is the nearest enclosing directory with a .bzr control
1570
directory."""
1571
1572
takes_args = ['filename?']
1573
@display_command
1574
def run(self, filename=None):
1575
"""Print the branch root."""
1576
tree = WorkingTree.open_containing(filename)[0]
1577
self.outf.write(tree.basedir + '\n')
1578
1579
1580
def _parse_limit(limitstring):
1581
try:
1582
return int(limitstring)
1583
except ValueError:
1584
msg = "The limit argument must be an integer."
1585
raise errors.BzrCommandError(msg)
1586
1587
1588
class cmd_log(Command):
1589
"""Show log of a branch, file, or directory.
1590
1591
By default show the log of the branch containing the working directory.
1592
1593
To request a range of logs, you can use the command -r begin..end
1594
-r revision requests a specific revision, -r ..end or -r begin.. are
1595
also valid.
1596
1597
examples:
1598
bzr log
1599
bzr log foo.c
1600
bzr log -r -10.. http://server/branch
1601
"""
1602
1603
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1604
1605
takes_args = ['location?']
1606
takes_options = [
1607
Option('forward',
1608
help='Show from oldest to newest.'),
1609
Option('timezone',
1610
type=str,
1611
help='Display timezone as local, original, or utc.'),
1612
Option('verbose',
1613
short_name='v',
1614
help='Show files changed in each revision.'),
1615
'show-ids',
1616
'revision',
1617
'log-format',
1618
Option('message',
1619
short_name='m',
1620
help='Show revisions whose message matches this '
1621
'regular expression.',
1622
type=str),
1623
Option('limit',
1624
help='Limit the output to the first N revisions.',
1625
argname='N',
1626
type=_parse_limit),
1627
]
1628
encoding_type = 'replace'
1629
1630
@display_command
1631
def run(self, location=None, timezone='original',
1632
verbose=False,
1633
show_ids=False,
1634
forward=False,
1635
revision=None,
1636
log_format=None,
1637
message=None,
1638
limit=None):
1639
from bzrlib.log import show_log
1640
assert message is None or isinstance(message, basestring), \
1641
"invalid message argument %r" % message
1642
direction = (forward and 'forward') or 'reverse'
1643
1644
# log everything
1645
file_id = None
1646
if location:
1647
# find the file id to log:
1648
1649
tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1650
location)
1651
if fp != '':
1652
if tree is None:
1653
tree = b.basis_tree()
1654
file_id = tree.path2id(fp)
1655
if file_id is None:
1656
raise errors.BzrCommandError(
1657
"Path does not have any revision history: %s" %
1658
location)
1659
else:
1660
# local dir only
1661
# FIXME ? log the current subdir only RBC 20060203
1662
if revision is not None \
1663
and len(revision) > 0 and revision[0].get_branch():
1664
location = revision[0].get_branch()
1665
else:
1666
location = '.'
1667
dir, relpath = bzrdir.BzrDir.open_containing(location)
1668
b = dir.open_branch()
1669
1670
b.lock_read()
1671
try:
1672
if revision is None:
1673
rev1 = None
1674
rev2 = None
1675
elif len(revision) == 1:
1676
rev1 = rev2 = revision[0].in_history(b)
1677
elif len(revision) == 2:
1678
if revision[1].get_branch() != revision[0].get_branch():
1679
# b is taken from revision[0].get_branch(), and
1680
# show_log will use its revision_history. Having
1681
# different branches will lead to weird behaviors.
1682
raise errors.BzrCommandError(
1683
"Log doesn't accept two revisions in different"
1684
" branches.")
1685
rev1 = revision[0].in_history(b)
1686
rev2 = revision[1].in_history(b)
1687
else:
1688
raise errors.BzrCommandError(
1689
'bzr log --revision takes one or two values.')
1690
1691
if log_format is None:
1692
log_format = log.log_formatter_registry.get_default(b)
1693
1694
lf = log_format(show_ids=show_ids, to_file=self.outf,
1695
show_timezone=timezone)
1696
1697
show_log(b,
1698
lf,
1699
file_id,
1700
verbose=verbose,
1701
direction=direction,
1702
start_revision=rev1,
1703
end_revision=rev2,
1704
search=message,
1705
limit=limit)
1706
finally:
1707
b.unlock()
1708
1709
1710
def get_log_format(long=False, short=False, line=False, default='long'):
1711
log_format = default
1712
if long:
1713
log_format = 'long'
1714
if short:
1715
log_format = 'short'
1716
if line:
1717
log_format = 'line'
1718
return log_format
1719
1720
1721
class cmd_touching_revisions(Command):
1722
"""Return revision-ids which affected a particular file.
1723
1724
A more user-friendly interface is "bzr log FILE".
1725
"""
1726
1727
hidden = True
1728
takes_args = ["filename"]
1729
1730
@display_command
1731
def run(self, filename):
1732
tree, relpath = WorkingTree.open_containing(filename)
1733
b = tree.branch
1734
file_id = tree.path2id(relpath)
1735
for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1736
self.outf.write("%6d %s\n" % (revno, what))
1737
1738
1739
class cmd_ls(Command):
1740
"""List files in a tree.
1741
"""
1742
1743
_see_also = ['status', 'cat']
1744
takes_args = ['path?']
1745
# TODO: Take a revision or remote path and list that tree instead.
1746
takes_options = [
1747
'verbose',
1748
'revision',
1749
Option('non-recursive',
1750
help='Don\'t recurse into subdirectories.'),
1751
Option('from-root',
1752
help='Print paths relative to the root of the branch.'),
1753
Option('unknown', help='Print unknown files.'),
1754
Option('versioned', help='Print versioned files.'),
1755
Option('ignored', help='Print ignored files.'),
1756
Option('null',
1757
help='Write an ascii NUL (\\0) separator '
1758
'between files rather than a newline.'),
1759
Option('kind',
1760
help='List entries of a particular kind: file, directory, symlink.',
1761
type=unicode),
1762
'show-ids',
1763
]
1764
@display_command
1765
def run(self, revision=None, verbose=False,
1766
non_recursive=False, from_root=False,
1767
unknown=False, versioned=False, ignored=False,
1768
null=False, kind=None, show_ids=False, path=None):
1769
1770
if kind and kind not in ('file', 'directory', 'symlink'):
1771
raise errors.BzrCommandError('invalid kind specified')
1772
1773
if verbose and null:
1774
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1775
all = not (unknown or versioned or ignored)
1776
1777
selection = {'I':ignored, '?':unknown, 'V':versioned}
1778
1779
if path is None:
1780
fs_path = '.'
1781
prefix = ''
1782
else:
1783
if from_root:
1784
raise errors.BzrCommandError('cannot specify both --from-root'
1785
' and PATH')
1786
fs_path = path
1787
prefix = path
1788
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1789
fs_path)
1790
if from_root:
1791
relpath = u''
1792
elif relpath:
1793
relpath += '/'
1794
if revision is not None:
1795
tree = branch.repository.revision_tree(
1796
revision[0].in_history(branch).rev_id)
1797
elif tree is None:
1798
tree = branch.basis_tree()
1799
1800
tree.lock_read()
1801
try:
1802
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1803
if fp.startswith(relpath):
1804
fp = osutils.pathjoin(prefix, fp[len(relpath):])
1805
if non_recursive and '/' in fp:
1806
continue
1807
if not all and not selection[fc]:
1808
continue
1809
if kind is not None and fkind != kind:
1810
continue
1811
if verbose:
1812
kindch = entry.kind_character()
1813
outstring = '%-8s %s%s' % (fc, fp, kindch)
1814
if show_ids and fid is not None:
1815
outstring = "%-50s %s" % (outstring, fid)
1816
self.outf.write(outstring + '\n')
1817
elif null:
1818
self.outf.write(fp + '\0')
1819
if show_ids:
1820
if fid is not None:
1821
self.outf.write(fid)
1822
self.outf.write('\0')
1823
self.outf.flush()
1824
else:
1825
if fid is not None:
1826
my_id = fid
1827
else:
1828
my_id = ''
1829
if show_ids:
1830
self.outf.write('%-50s %s\n' % (fp, my_id))
1831
else:
1832
self.outf.write(fp + '\n')
1833
finally:
1834
tree.unlock()
1835
1836
1837
class cmd_unknowns(Command):
1838
"""List unknown files.
1839
"""
1840
1841
hidden = True
1842
_see_also = ['ls']
1843
1844
@display_command
1845
def run(self):
1846
for f in WorkingTree.open_containing(u'.')[0].unknowns():
1847
self.outf.write(osutils.quotefn(f) + '\n')
1848
1849
1850
class cmd_ignore(Command):
1851
"""Ignore specified files or patterns.
1852
1853
To remove patterns from the ignore list, edit the .bzrignore file.
1854
1855
Trailing slashes on patterns are ignored.
1856
If the pattern contains a slash or is a regular expression, it is compared
1857
to the whole path from the branch root. Otherwise, it is compared to only
1858
the last component of the path. To match a file only in the root
1859
directory, prepend './'.
1860
1861
Ignore patterns specifying absolute paths are not allowed.
1862
1863
Ignore patterns may include globbing wildcards such as:
1864
? - Matches any single character except '/'
1865
* - Matches 0 or more characters except '/'
1866
/**/ - Matches 0 or more directories in a path
1867
[a-z] - Matches a single character from within a group of characters
1868
1869
Ignore patterns may also be Python regular expressions.
1870
Regular expression ignore patterns are identified by a 'RE:' prefix
1871
followed by the regular expression. Regular expression ignore patterns
1872
may not include named or numbered groups.
1873
1874
Note: ignore patterns containing shell wildcards must be quoted from
1875
the shell on Unix.
1876
1877
examples:
1878
bzr ignore ./Makefile
1879
bzr ignore '*.class'
1880
bzr ignore 'lib/**/*.o'
1881
bzr ignore 'RE:lib/.*\.o'
1882
"""
1883
1884
_see_also = ['status', 'ignored']
1885
takes_args = ['name_pattern*']
1886
takes_options = [
1887
Option('old-default-rules',
1888
help='Write out the ignore rules bzr < 0.9 always used.')
1889
]
1890
1891
def run(self, name_pattern_list=None, old_default_rules=None):
1892
from bzrlib.atomicfile import AtomicFile
1893
if old_default_rules is not None:
1894
# dump the rules and exit
1895
for pattern in ignores.OLD_DEFAULTS:
1896
print pattern
1897
return
1898
if not name_pattern_list:
1899
raise errors.BzrCommandError("ignore requires at least one "
1900
"NAME_PATTERN or --old-default-rules")
1901
name_pattern_list = [globbing.normalize_pattern(p)
1902
for p in name_pattern_list]
1903
for name_pattern in name_pattern_list:
1904
if (name_pattern[0] == '/' or
1905
(len(name_pattern) > 1 and name_pattern[1] == ':')):
1906
raise errors.BzrCommandError(
1907
"NAME_PATTERN should not be an absolute path")
1908
tree, relpath = WorkingTree.open_containing(u'.')
1909
ifn = tree.abspath('.bzrignore')
1910
if os.path.exists(ifn):
1911
f = open(ifn, 'rt')
1912
try:
1913
igns = f.read().decode('utf-8')
1914
finally:
1915
f.close()
1916
else:
1917
igns = ''
1918
1919
# TODO: If the file already uses crlf-style termination, maybe
1920
# we should use that for the newly added lines?
1921
1922
if igns and igns[-1] != '\n':
1923
igns += '\n'
1924
for name_pattern in name_pattern_list:
1925
igns += name_pattern + '\n'
1926
1927
f = AtomicFile(ifn, 'wb')
1928
try:
1929
f.write(igns.encode('utf-8'))
1930
f.commit()
1931
finally:
1932
f.close()
1933
1934
if not tree.path2id('.bzrignore'):
1935
tree.add(['.bzrignore'])
1936
1937
1938
class cmd_ignored(Command):
1939
"""List ignored files and the patterns that matched them.
1940
"""
1941
1942
_see_also = ['ignore']
1943
@display_command
1944
def run(self):
1945
tree = WorkingTree.open_containing(u'.')[0]
1946
tree.lock_read()
1947
try:
1948
for path, file_class, kind, file_id, entry in tree.list_files():
1949
if file_class != 'I':
1950
continue
1951
## XXX: Slightly inefficient since this was already calculated
1952
pat = tree.is_ignored(path)
1953
print '%-50s %s' % (path, pat)
1954
finally:
1955
tree.unlock()
1956
1957
1958
class cmd_lookup_revision(Command):
1959
"""Lookup the revision-id from a revision-number
1960
1961
example:
1962
bzr lookup-revision 33
1963
"""
1964
hidden = True
1965
takes_args = ['revno']
1966
1967
@display_command
1968
def run(self, revno):
1969
try:
1970
revno = int(revno)
1971
except ValueError:
1972
raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1973
1974
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1975
1976
1977
class cmd_export(Command):
1978
"""Export current or past revision to a destination directory or archive.
1979
1980
If no revision is specified this exports the last committed revision.
1981
1982
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1983
given, try to find the format with the extension. If no extension
1984
is found exports to a directory (equivalent to --format=dir).
1985
1986
If root is supplied, it will be used as the root directory inside
1987
container formats (tar, zip, etc). If it is not supplied it will default
1988
to the exported filename. The root option has no effect for 'dir' format.
1989
1990
If branch is omitted then the branch containing the current working
1991
directory will be used.
1992
1993
Note: Export of tree with non-ASCII filenames to zip is not supported.
1994
1995
Supported formats Autodetected by extension
1996
----------------- -------------------------
1997
dir -
1998
tar .tar
1999
tbz2 .tar.bz2, .tbz2
2000
tgz .tar.gz, .tgz
2001
zip .zip
2002
"""
2003
takes_args = ['dest', 'branch?']
2004
takes_options = [
2005
Option('format',
2006
help="Type of file to export to.",
2007
type=unicode),
2008
'revision',
2009
Option('root',
2010
type=str,
2011
help="Name of the root directory inside the exported file."),
2012
]
2013
def run(self, dest, branch=None, revision=None, format=None, root=None):
2014
from bzrlib.export import export
2015
2016
if branch is None:
2017
tree = WorkingTree.open_containing(u'.')[0]
2018
b = tree.branch
2019
else:
2020
b = Branch.open(branch)
2021
2022
if revision is None:
2023
# should be tree.last_revision FIXME
2024
rev_id = b.last_revision()
2025
else:
2026
if len(revision) != 1:
2027
raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2028
rev_id = revision[0].in_history(b).rev_id
2029
t = b.repository.revision_tree(rev_id)
2030
try:
2031
export(t, dest, format, root)
2032
except errors.NoSuchExportFormat, e:
2033
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2034
2035
2036
class cmd_cat(Command):
2037
"""Write the contents of a file as of a given revision to standard output.
2038
2039
If no revision is nominated, the last revision is used.
2040
2041
Note: Take care to redirect standard output when using this command on a
2042
binary file.
2043
"""
2044
2045
_see_also = ['ls']
2046
takes_options = [
2047
Option('name-from-revision', help='The path name in the old tree.'),
2048
'revision',
2049
]
2050
takes_args = ['filename']
2051
encoding_type = 'exact'
2052
2053
@display_command
2054
def run(self, filename, revision=None, name_from_revision=False):
2055
if revision is not None and len(revision) != 1:
2056
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2057
" one number")
2058
2059
tree = None
2060
try:
2061
tree, b, relpath = \
2062
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2063
except errors.NotBranchError:
2064
pass
2065
2066
if revision is not None and revision[0].get_branch() is not None:
2067
b = Branch.open(revision[0].get_branch())
2068
if tree is None:
2069
tree = b.basis_tree()
2070
if revision is None:
2071
revision_id = b.last_revision()
2072
else:
2073
revision_id = revision[0].in_history(b).rev_id
2074
2075
cur_file_id = tree.path2id(relpath)
2076
rev_tree = b.repository.revision_tree(revision_id)
2077
old_file_id = rev_tree.path2id(relpath)
2078
2079
if name_from_revision:
2080
if old_file_id is None:
2081
raise errors.BzrCommandError("%r is not present in revision %s"
2082
% (filename, revision_id))
2083
else:
2084
rev_tree.print_file(old_file_id)
2085
elif cur_file_id is not None:
2086
rev_tree.print_file(cur_file_id)
2087
elif old_file_id is not None:
2088
rev_tree.print_file(old_file_id)
2089
else:
2090
raise errors.BzrCommandError("%r is not present in revision %s" %
2091
(filename, revision_id))
2092
2093
2094
class cmd_local_time_offset(Command):
2095
"""Show the offset in seconds from GMT to local time."""
2096
hidden = True
2097
@display_command
2098
def run(self):
2099
print osutils.local_time_offset()
2100
2101
2102
2103
class cmd_commit(Command):
2104
"""Commit changes into a new revision.
2105
2106
If no arguments are given, the entire tree is committed.
2107
2108
If selected files are specified, only changes to those files are
2109
committed. If a directory is specified then the directory and everything
2110
within it is committed.
2111
2112
A selected-file commit may fail in some cases where the committed
2113
tree would be invalid. Consider::
2114
2115
bzr init foo
2116
mkdir foo/bar
2117
bzr add foo/bar
2118
bzr commit foo -m "committing foo"
2119
bzr mv foo/bar foo/baz
2120
mkdir foo/bar
2121
bzr add foo/bar
2122
bzr commit foo/bar -m "committing bar but not baz"
2123
2124
In the example above, the last commit will fail by design. This gives
2125
the user the opportunity to decide whether they want to commit the
2126
rename at the same time, separately first, or not at all. (As a general
2127
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2128
2129
Note: A selected-file commit after a merge is not yet supported.
2130
"""
2131
# TODO: Run hooks on tree to-be-committed, and after commit.
2132
2133
# TODO: Strict commit that fails if there are deleted files.
2134
# (what does "deleted files" mean ??)
2135
2136
# TODO: Give better message for -s, --summary, used by tla people
2137
2138
# XXX: verbose currently does nothing
2139
2140
_see_also = ['bugs', 'uncommit']
2141
takes_args = ['selected*']
2142
takes_options = [
2143
Option('message', type=unicode,
2144
short_name='m',
2145
help="Description of the new revision."),
2146
'verbose',
2147
Option('unchanged',
2148
help='Commit even if nothing has changed.'),
2149
Option('file', type=str,
2150
short_name='F',
2151
argname='msgfile',
2152
help='Take commit message from this file.'),
2153
Option('strict',
2154
help="Refuse to commit if there are unknown "
2155
"files in the working tree."),
2156
ListOption('fixes', type=str,
2157
help="Mark a bug as being fixed by this revision."),
2158
Option('local',
2159
help="Perform a local commit in a bound "
2160
"branch. Local commits are not pushed to "
2161
"the master branch until a normal commit "
2162
"is performed."
2163
),
2164
]
2165
aliases = ['ci', 'checkin']
2166
2167
def _get_bug_fix_properties(self, fixes, branch):
2168
properties = []
2169
# Configure the properties for bug fixing attributes.
2170
for fixed_bug in fixes:
2171
tokens = fixed_bug.split(':')
2172
if len(tokens) != 2:
2173
raise errors.BzrCommandError(
2174
"Invalid bug %s. Must be in the form of 'tag:id'. "
2175
"Commit refused." % fixed_bug)
2176
tag, bug_id = tokens
2177
try:
2178
bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
2179
except errors.UnknownBugTrackerAbbreviation:
2180
raise errors.BzrCommandError(
2181
'Unrecognized bug %s. Commit refused.' % fixed_bug)
2182
except errors.MalformedBugIdentifier:
2183
raise errors.BzrCommandError(
2184
"Invalid bug identifier for %s. Commit refused."
2185
% fixed_bug)
2186
properties.append('%s fixed' % bug_url)
2187
return '\n'.join(properties)
2188
2189
def run(self, message=None, file=None, verbose=True, selected_list=None,
2190
unchanged=False, strict=False, local=False, fixes=None):
2191
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
2192
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
2193
StrictCommitFailed)
2194
from bzrlib.msgeditor import edit_commit_message, \
2195
make_commit_message_template
2196
2197
# TODO: Need a blackbox test for invoking the external editor; may be
2198
# slightly problematic to run this cross-platform.
2199
2200
# TODO: do more checks that the commit will succeed before
2201
# spending the user's valuable time typing a commit message.
2202
2203
properties = {}
2204
2205
tree, selected_list = tree_files(selected_list)
2206
if selected_list == ['']:
2207
# workaround - commit of root of tree should be exactly the same
2208
# as just default commit in that tree, and succeed even though
2209
# selected-file merge commit is not done yet
2210
selected_list = []
2211
2212
bug_property = self._get_bug_fix_properties(fixes, tree.branch)
2213
if bug_property:
2214
properties['bugs'] = bug_property
2215
2216
if local and not tree.branch.get_bound_location():
2217
raise errors.LocalRequiresBoundBranch()
2218
2219
def get_message(commit_obj):
2220
"""Callback to get commit message"""
2221
my_message = message
2222
if my_message is None and not file:
2223
template = make_commit_message_template(tree, selected_list)
2224
my_message = edit_commit_message(template)
2225
if my_message is None:
2226
raise errors.BzrCommandError("please specify a commit"
2227
" message with either --message or --file")
2228
elif my_message and file:
2229
raise errors.BzrCommandError(
2230
"please specify either --message or --file")
2231
if file:
2232
my_message = codecs.open(file, 'rt',
2233
bzrlib.user_encoding).read()
2234
if my_message == "":
2235
raise errors.BzrCommandError("empty commit message specified")
2236
return my_message
2237
2238
if verbose:
2239
reporter = ReportCommitToLog()
2240
else:
2241
reporter = NullCommitReporter()
2242
2243
try:
2244
tree.commit(message_callback=get_message,
2245
specific_files=selected_list,
2246
allow_pointless=unchanged, strict=strict, local=local,
2247
reporter=reporter, revprops=properties)
2248
except PointlessCommit:
2249
# FIXME: This should really happen before the file is read in;
2250
# perhaps prepare the commit; get the message; then actually commit
2251
raise errors.BzrCommandError("no changes to commit."
2252
" use --unchanged to commit anyhow")
2253
except ConflictsInTree:
2254
raise errors.BzrCommandError('Conflicts detected in working '
2255
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
2256
' resolve.')
2257
except StrictCommitFailed:
2258
raise errors.BzrCommandError("Commit refused because there are"
2259
" unknown files in the working tree.")
2260
except errors.BoundBranchOutOfDate, e:
2261
raise errors.BzrCommandError(str(e) + "\n"
2262
'To commit to master branch, run update and then commit.\n'
2263
'You can also pass --local to commit to continue working '
2264
'disconnected.')
2265
2266
2267
class cmd_check(Command):
2268
"""Validate consistency of branch history.
2269
2270
This command checks various invariants about the branch storage to
2271
detect data corruption or bzr bugs.
2272
"""
2273
2274
_see_also = ['reconcile']
2275
takes_args = ['branch?']
2276
takes_options = ['verbose']
2277
2278
def run(self, branch=None, verbose=False):
2279
from bzrlib.check import check
2280
if branch is None:
2281
tree = WorkingTree.open_containing()[0]
2282
branch = tree.branch
2283
else:
2284
branch = Branch.open(branch)
2285
check(branch, verbose)
2286
2287
2288
class cmd_upgrade(Command):
2289
"""Upgrade branch storage to current format.
2290
2291
The check command or bzr developers may sometimes advise you to run
2292
this command. When the default format has changed you may also be warned
2293
during other operations to upgrade.
2294
"""
2295
2296
_see_also = ['check']
2297
takes_args = ['url?']
2298
takes_options = [
2299
RegistryOption('format',
2300
help='Upgrade to a specific format. See "bzr help'
2301
' formats" for details.',
2302
registry=bzrdir.format_registry,
2303
converter=bzrdir.format_registry.make_bzrdir,
2304
value_switches=True, title='Branch format'),
2305
]
2306
2307
def run(self, url='.', format=None):
2308
from bzrlib.upgrade import upgrade
2309
if format is None:
2310
format = bzrdir.format_registry.make_bzrdir('default')
2311
upgrade(url, format)
2312
2313
2314
class cmd_whoami(Command):
2315
"""Show or set bzr user id.
2316
2317
examples:
2318
bzr whoami --email
2319
bzr whoami 'Frank Chu <fchu@example.com>'
2320
"""
2321
takes_options = [ Option('email',
2322
help='Display email address only.'),
2323
Option('branch',
2324
help='Set identity for the current branch instead of '
2325
'globally.'),
2326
]
2327
takes_args = ['name?']
2328
encoding_type = 'replace'
2329
2330
@display_command
2331
def run(self, email=False, branch=False, name=None):
2332
if name is None:
2333
# use branch if we're inside one; otherwise global config
2334
try:
2335
c = Branch.open_containing('.')[0].get_config()
2336
except errors.NotBranchError:
2337
c = config.GlobalConfig()
2338
if email:
2339
self.outf.write(c.user_email() + '\n')
2340
else:
2341
self.outf.write(c.username() + '\n')
2342
return
2343
2344
# display a warning if an email address isn't included in the given name.
2345
try:
2346
config.extract_email_address(name)
2347
except errors.NoEmailInUsername, e:
2348
warning('"%s" does not seem to contain an email address. '
2349
'This is allowed, but not recommended.', name)
2350
2351
# use global config unless --branch given
2352
if branch:
2353
c = Branch.open_containing('.')[0].get_config()
2354
else:
2355
c = config.GlobalConfig()
2356
c.set_user_option('email', name)
2357
2358
2359
class cmd_nick(Command):
2360
"""Print or set the branch nickname.
2361
2362
If unset, the tree root directory name is used as the nickname
2363
To print the current nickname, execute with no argument.
2364
"""
2365
2366
_see_also = ['info']
2367
takes_args = ['nickname?']
2368
def run(self, nickname=None):
2369
branch = Branch.open_containing(u'.')[0]
2370
if nickname is None:
2371
self.printme(branch)
2372
else:
2373
branch.nick = nickname
2374
2375
@display_command
2376
def printme(self, branch):
2377
print branch.nick
2378
2379
2380
class cmd_selftest(Command):
2381
"""Run internal test suite.
2382
2383
If arguments are given, they are regular expressions that say which tests
2384
should run. Tests matching any expression are run, and other tests are
2385
not run.
2386
2387
Alternatively if --first is given, matching tests are run first and then
2388
all other tests are run. This is useful if you have been working in a
2389
particular area, but want to make sure nothing else was broken.
2390
2391
If --exclude is given, tests that match that regular expression are
2392
excluded, regardless of whether they match --first or not.
2393
2394
To help catch accidential dependencies between tests, the --randomize
2395
option is useful. In most cases, the argument used is the word 'now'.
2396
Note that the seed used for the random number generator is displayed
2397
when this option is used. The seed can be explicitly passed as the
2398
argument to this option if required. This enables reproduction of the
2399
actual ordering used if and when an order sensitive problem is encountered.
2400
2401
If --list-only is given, the tests that would be run are listed. This is
2402
useful when combined with --first, --exclude and/or --randomize to
2403
understand their impact. The test harness reports "Listed nn tests in ..."
2404
instead of "Ran nn tests in ..." when list mode is enabled.
2405
2406
If the global option '--no-plugins' is given, plugins are not loaded
2407
before running the selftests. This has two effects: features provided or
2408
modified by plugins will not be tested, and tests provided by plugins will
2409
not be run.
2410
2411
Tests that need working space on disk use a common temporary directory,
2412
typically inside $TMPDIR or /tmp.
2413
2414
examples::
2415
bzr selftest ignore
2416
run only tests relating to 'ignore'
2417
bzr --no-plugins selftest -v
2418
disable plugins and list tests as they're run
2419
"""
2420
# NB: this is used from the class without creating an instance, which is
2421
# why it does not have a self parameter.
2422
def get_transport_type(typestring):
2423
"""Parse and return a transport specifier."""
2424
if typestring == "sftp":
2425
from bzrlib.transport.sftp import SFTPAbsoluteServer
2426
return SFTPAbsoluteServer
2427
if typestring == "memory":
2428
from bzrlib.transport.memory import MemoryServer
2429
return MemoryServer
2430
if typestring == "fakenfs":
2431
from bzrlib.transport.fakenfs import FakeNFSServer
2432
return FakeNFSServer
2433
msg = "No known transport type %s. Supported types are: sftp\n" %\
2434
(typestring)
2435
raise errors.BzrCommandError(msg)
2436
2437
hidden = True
2438
takes_args = ['testspecs*']
2439
takes_options = ['verbose',
2440
Option('one',
2441
help='Stop when one test fails.',
2442
short_name='1',
2443
),
2444
Option('transport',
2445
help='Use a different transport by default '
2446
'throughout the test suite.',
2447
type=get_transport_type),
2448
Option('benchmark',
2449
help='Run the benchmarks rather than selftests.'),
2450
Option('lsprof-timed',
2451
help='Generate lsprof output for benchmarked'
2452
' sections of code.'),
2453
Option('cache-dir', type=str,
2454
help='Cache intermediate benchmark output in this '
2455
'directory.'),
2456
Option('first',
2457
help='Run all tests, but run specified tests first.',
2458
short_name='f',
2459
),
2460
Option('list-only',
2461
help='List the tests instead of running them.'),
2462
Option('randomize', type=str, argname="SEED",
2463
help='Randomize the order of tests using the given'
2464
' seed or "now" for the current time.'),
2465
Option('exclude', type=str, argname="PATTERN",
2466
short_name='x',
2467
help='Exclude tests that match this regular'
2468
' expression.'),
2469
]
2470
encoding_type = 'replace'
2471
2472
def run(self, testspecs_list=None, verbose=None, one=False,
2473
transport=None, benchmark=None,
2474
lsprof_timed=None, cache_dir=None,
2475
first=False, list_only=False,
2476
randomize=None, exclude=None):
2477
import bzrlib.ui
2478
from bzrlib.tests import selftest
2479
import bzrlib.benchmarks as benchmarks
2480
from bzrlib.benchmarks import tree_creator
2481
from bzrlib.version import show_version
2482
2483
if cache_dir is not None:
2484
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2485
if not list_only:
2486
show_version(show_config=False, show_copyright=False)
2487
print
2488
if testspecs_list is not None:
2489
pattern = '|'.join(testspecs_list)
2490
else:
2491
pattern = ".*"
2492
if benchmark:
2493
test_suite_factory = benchmarks.test_suite
2494
if verbose is None:
2495
verbose = True
2496
# TODO: should possibly lock the history file...
2497
benchfile = open(".perf_history", "at", buffering=1)
2498
else:
2499
test_suite_factory = None
2500
if verbose is None:
2501
verbose = False
2502
benchfile = None
2503
try:
2504
result = selftest(verbose=verbose,
2505
pattern=pattern,
2506
stop_on_failure=one,
2507
transport=transport,
2508
test_suite_factory=test_suite_factory,
2509
lsprof_timed=lsprof_timed,
2510
bench_history=benchfile,
2511
matching_tests_first=first,
2512
list_only=list_only,
2513
random_seed=randomize,
2514
exclude_pattern=exclude
2515
)
2516
finally:
2517
if benchfile is not None:
2518
benchfile.close()
2519
if result:
2520
info('tests passed')
2521
else:
2522
info('tests failed')
2523
return int(not result)
2524
2525
2526
class cmd_version(Command):
2527
"""Show version of bzr."""
2528
2529
@display_command
2530
def run(self):
2531
from bzrlib.version import show_version
2532
show_version()
2533
2534
2535
class cmd_rocks(Command):
2536
"""Statement of optimism."""
2537
2538
hidden = True
2539
2540
@display_command
2541
def run(self):
2542
print "It sure does!"
2543
2544
2545
class cmd_find_merge_base(Command):
2546
"""Find and print a base revision for merging two branches."""
2547
# TODO: Options to specify revisions on either side, as if
2548
# merging only part of the history.
2549
takes_args = ['branch', 'other']
2550
hidden = True
2551
2552
@display_command
2553
def run(self, branch, other):
2554
from bzrlib.revision import ensure_null, MultipleRevisionSources
2555
2556
branch1 = Branch.open_containing(branch)[0]
2557
branch2 = Branch.open_containing(other)[0]
2558
2559
last1 = ensure_null(branch1.last_revision())
2560
last2 = ensure_null(branch2.last_revision())
2561
2562
graph = branch1.repository.get_graph(branch2.repository)
2563
base_rev_id = graph.find_unique_lca(last1, last2)
2564
2565
print 'merge base is revision %s' % base_rev_id
2566
2567
2568
class cmd_merge(Command):
2569
"""Perform a three-way merge.
2570
2571
The branch is the branch you will merge from. By default, it will merge
2572
the latest revision. If you specify a revision, that revision will be
2573
merged. If you specify two revisions, the first will be used as a BASE,
2574
and the second one as OTHER. Revision numbers are always relative to the
2575
specified branch.
2576
2577
By default, bzr will try to merge in all new work from the other
2578
branch, automatically determining an appropriate base. If this
2579
fails, you may need to give an explicit base.
2580
2581
Merge will do its best to combine the changes in two branches, but there
2582
are some kinds of problems only a human can fix. When it encounters those,
2583
it will mark a conflict. A conflict means that you need to fix something,
2584
before you should commit.
2585
2586
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
2587
2588
If there is no default branch set, the first merge will set it. After
2589
that, you can omit the branch to use the default. To change the
2590
default, use --remember. The value will only be saved if the remote
2591
location can be accessed.
2592
2593
The results of the merge are placed into the destination working
2594
directory, where they can be reviewed (with bzr diff), tested, and then
2595
committed to record the result of the merge.
2596
2597
Examples:
2598
2599
To merge the latest revision from bzr.dev:
2600
bzr merge ../bzr.dev
2601
2602
To merge changes up to and including revision 82 from bzr.dev:
2603
bzr merge -r 82 ../bzr.dev
2604
2605
To merge the changes introduced by 82, without previous changes:
2606
bzr merge -r 81..82 ../bzr.dev
2607
2608
merge refuses to run if there are any uncommitted changes, unless
2609
--force is given.
2610
"""
2611
2612
_see_also = ['update', 'remerge', 'status-flags']
2613
takes_args = ['branch?']
2614
takes_options = [
2615
'revision',
2616
Option('force',
2617
help='Merge even if the destination tree has uncommitted changes.'),
2618
'merge-type',
2619
'reprocess',
2620
'remember',
2621
Option('show-base', help="Show base revision text in "
2622
"conflicts."),
2623
Option('uncommitted', help='Apply uncommitted changes'
2624
' from a working copy, instead of branch changes.'),
2625
Option('pull', help='If the destination is already'
2626
' completely merged into the source, pull from the'
2627
' source rather than merging. When this happens,'
2628
' you do not need to commit the result.'),
2629
Option('directory',
2630
help='Branch to merge into, '
2631
'rather than the one containing the working directory.',
2632
short_name='d',
2633
type=unicode,
2634
),
2635
]
2636
2637
def run(self, branch=None, revision=None, force=False, merge_type=None,
2638
show_base=False, reprocess=False, remember=False,
2639
uncommitted=False, pull=False,
2640
directory=None,
2641
):
2642
from bzrlib.tag import _merge_tags_if_possible
2643
if merge_type is None:
2644
merge_type = _mod_merge.Merge3Merger
2645
2646
if directory is None: directory = u'.'
2647
# XXX: jam 20070225 WorkingTree should be locked before you extract its
2648
# inventory. Because merge is a mutating operation, it really
2649
# should be a lock_write() for the whole cmd_merge operation.
2650
# However, cmd_merge open's its own tree in _merge_helper, which
2651
# means if we lock here, the later lock_write() will always block.
2652
# Either the merge helper code should be updated to take a tree,
2653
# (What about tree.merge_from_branch?)
2654
tree = WorkingTree.open_containing(directory)[0]
2655
change_reporter = delta._ChangeReporter(
2656
unversioned_filter=tree.is_ignored)
2657
2658
other_transport = None
2659
other_revision_id = None
2660
base_revision_id = None
2661
possible_transports = []
2662
2663
if branch is not None:
2664
mergeable, other_transport = _get_bundle_helper(branch)
2665
if mergeable:
2666
if revision is not None:
2667
raise errors.BzrCommandError(
2668
'Cannot use -r with merge directives or bundles')
2669
mergeable.install_revisions(tree.branch.repository)
2670
base_revision_id, other_revision_id, verified =\
2671
mergeable.get_merge_request(tree.branch.repository)
2672
if base_revision_id in tree.branch.repository.get_ancestry(
2673
tree.branch.last_revision(), topo_sorted=False):
2674
base_revision_id = None
2675
other_branch = None
2676
path = ''
2677
other = None
2678
base = None
2679
possible_transports.append(other_transport)
2680
2681
if other_revision_id is None:
2682
verified = 'inapplicable'
2683
if revision is None \
2684
or len(revision) < 1 or revision[0].needs_branch():
2685
branch = self._get_remembered_parent(tree, branch,
2686
'Merging from')
2687
2688
if revision is None or len(revision) < 1:
2689
if uncommitted:
2690
base = [branch, -1]
2691
other = [branch, None]
2692
else:
2693
base = [None, None]
2694
other = [branch, -1]
2695
other_branch, path = Branch.open_containing(branch,
2696
possible_transports)
2697
else:
2698
if uncommitted:
2699
raise errors.BzrCommandError('Cannot use --uncommitted and'
2700
' --revision at the same time.')
2701
branch = revision[0].get_branch() or branch
2702
if len(revision) == 1:
2703
base = [None, None]
2704
other_branch, path = Branch.open_containing(
2705
branch, possible_transports)
2706
revno = revision[0].in_history(other_branch).revno
2707
other = [branch, revno]
2708
else:
2709
assert len(revision) == 2
2710
if None in revision:
2711
raise errors.BzrCommandError(
2712
"Merge doesn't permit empty revision specifier.")
2713
base_branch, path = Branch.open_containing(
2714
branch, possible_transports)
2715
branch1 = revision[1].get_branch() or branch
2716
other_branch, path1 = Branch.open_containing(
2717
branch1, possible_transports)
2718
if revision[0].get_branch() is not None:
2719
# then path was obtained from it, and is None.
2720
path = path1
2721
2722
base = [branch, revision[0].in_history(base_branch).revno]
2723
other = [branch1,
2724
revision[1].in_history(other_branch).revno]
2725
2726
# Remember where we merge from
2727
if ((tree.branch.get_parent() is None or remember) and
2728
other_branch is not None):
2729
tree.branch.set_parent(other_branch.base)
2730
2731
# pull tags now... it's a bit inconsistent to do it ahead of copying
2732
# the history but that's done inside the merge code
2733
if other_branch is not None:
2734
_merge_tags_if_possible(other_branch, tree.branch)
2735
2736
if path != "":
2737
interesting_files = [path]
2738
else:
2739
interesting_files = None
2740
pb = ui.ui_factory.nested_progress_bar()
2741
try:
2742
try:
2743
conflict_count = _merge_helper(
2744
other, base, other_rev_id=other_revision_id,
2745
base_rev_id=base_revision_id,
2746
check_clean=(not force),
2747
merge_type=merge_type,
2748
reprocess=reprocess,
2749
show_base=show_base,
2750
pull=pull,
2751
this_dir=directory,
2752
pb=pb, file_list=interesting_files,
2753
change_reporter=change_reporter,
2754
possible_transports=possible_transports)
2755
finally:
2756
pb.finished()
2757
if verified == 'failed':
2758
warning('Preview patch does not match changes')
2759
if conflict_count != 0:
2760
return 1
2761
else:
2762
return 0
2763
except errors.AmbiguousBase, e:
2764
m = ("sorry, bzr can't determine the right merge base yet\n"
2765
"candidates are:\n "
2766
+ "\n ".join(e.bases)
2767
+ "\n"
2768
"please specify an explicit base with -r,\n"
2769
"and (if you want) report this to the bzr developers\n")
2770
log_error(m)
2771
2772
# TODO: move up to common parent; this isn't merge-specific anymore.
2773
def _get_remembered_parent(self, tree, supplied_location, verb_string):
2774
"""Use tree.branch's parent if none was supplied.
2775
2776
Report if the remembered location was used.
2777
"""
2778
if supplied_location is not None:
2779
return supplied_location
2780
stored_location = tree.branch.get_parent()
2781
mutter("%s", stored_location)
2782
if stored_location is None:
2783
raise errors.BzrCommandError("No location specified or remembered")
2784
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2785
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
2786
return stored_location
2787
2788
2789
class cmd_remerge(Command):
2790
"""Redo a merge.
2791
2792
Use this if you want to try a different merge technique while resolving
2793
conflicts. Some merge techniques are better than others, and remerge
2794
lets you try different ones on different files.
2795
2796
The options for remerge have the same meaning and defaults as the ones for
2797
merge. The difference is that remerge can (only) be run when there is a
2798
pending merge, and it lets you specify particular files.
2799
2800
Examples:
2801
2802
$ bzr remerge --show-base
2803
Re-do the merge of all conflicted files, and show the base text in
2804
conflict regions, in addition to the usual THIS and OTHER texts.
2805
2806
$ bzr remerge --merge-type weave --reprocess foobar
2807
Re-do the merge of "foobar", using the weave merge algorithm, with
2808
additional processing to reduce the size of conflict regions.
2809
"""
2810
takes_args = ['file*']
2811
takes_options = [
2812
'merge-type',
2813
'reprocess',
2814
Option('show-base',
2815
help="Show base revision text in conflicts."),
2816
]
2817
2818
def run(self, file_list=None, merge_type=None, show_base=False,
2819
reprocess=False):
2820
if merge_type is None:
2821
merge_type = _mod_merge.Merge3Merger
2822
tree, file_list = tree_files(file_list)
2823
tree.lock_write()
2824
try:
2825
parents = tree.get_parent_ids()
2826
if len(parents) != 2:
2827
raise errors.BzrCommandError("Sorry, remerge only works after normal"
2828
" merges. Not cherrypicking or"
2829
" multi-merges.")
2830
repository = tree.branch.repository
2831
graph = repository.get_graph()
2832
base_revision = graph.find_unique_lca(parents[0], parents[1])
2833
base_tree = repository.revision_tree(base_revision)
2834
other_tree = repository.revision_tree(parents[1])
2835
interesting_ids = None
2836
new_conflicts = []
2837
conflicts = tree.conflicts()
2838
if file_list is not None:
2839
interesting_ids = set()
2840
for filename in file_list:
2841
file_id = tree.path2id(filename)
2842
if file_id is None:
2843
raise errors.NotVersionedError(filename)
2844
interesting_ids.add(file_id)
2845
if tree.kind(file_id) != "directory":
2846
continue
2847
2848
for name, ie in tree.inventory.iter_entries(file_id):
2849
interesting_ids.add(ie.file_id)
2850
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2851
else:
2852
# Remerge only supports resolving contents conflicts
2853
allowed_conflicts = ('text conflict', 'contents conflict')
2854
restore_files = [c.path for c in conflicts
2855
if c.typestring in allowed_conflicts]
2856
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2857
tree.set_conflicts(ConflictList(new_conflicts))
2858
if file_list is not None:
2859
restore_files = file_list
2860
for filename in restore_files:
2861
try:
2862
restore(tree.abspath(filename))
2863
except errors.NotConflicted:
2864
pass
2865
# Disable pending merges, because the file texts we are remerging
2866
# have not had those merges performed. If we use the wrong parents
2867
# list, we imply that the working tree text has seen and rejected
2868
# all the changes from the other tree, when in fact those changes
2869
# have not yet been seen.
2870
tree.set_parent_ids(parents[:1])
2871
try:
2872
conflicts = _mod_merge.merge_inner(
2873
tree.branch, other_tree, base_tree,
2874
this_tree=tree,
2875
interesting_ids=interesting_ids,
2876
other_rev_id=parents[1],
2877
merge_type=merge_type,
2878
show_base=show_base,
2879
reprocess=reprocess)
2880
finally:
2881
tree.set_parent_ids(parents)
2882
finally:
2883
tree.unlock()
2884
if conflicts > 0:
2885
return 1
2886
else:
2887
return 0
2888
2889
2890
class cmd_revert(Command):
2891
"""Revert files to a previous revision.
2892
2893
Giving a list of files will revert only those files. Otherwise, all files
2894
will be reverted. If the revision is not specified with '--revision', the
2895
last committed revision is used.
2896
2897
To remove only some changes, without reverting to a prior version, use
2898
merge instead. For example, "merge . --r-2..-3" will remove the changes
2899
introduced by -2, without affecting the changes introduced by -1. Or
2900
to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
2901
2902
By default, any files that have been manually changed will be backed up
2903
first. (Files changed only by merge are not backed up.) Backup files have
2904
'.~#~' appended to their name, where # is a number.
2905
2906
When you provide files, you can use their current pathname or the pathname
2907
from the target revision. So you can use revert to "undelete" a file by
2908
name. If you name a directory, all the contents of that directory will be
2909
reverted.
2910
"""
2911
2912
_see_also = ['cat', 'export']
2913
takes_options = [
2914
'revision',
2915
Option('no-backup', "Do not save backups of reverted files."),
2916
]
2917
takes_args = ['file*']
2918
2919
def run(self, revision=None, no_backup=False, file_list=None):
2920
if file_list is not None:
2921
if len(file_list) == 0:
2922
raise errors.BzrCommandError("No files specified")
2923
else:
2924
file_list = []
2925
2926
tree, file_list = tree_files(file_list)
2927
if revision is None:
2928
# FIXME should be tree.last_revision
2929
rev_id = tree.last_revision()
2930
elif len(revision) != 1:
2931
raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
2932
else:
2933
rev_id = revision[0].in_history(tree.branch).rev_id
2934
pb = ui.ui_factory.nested_progress_bar()
2935
try:
2936
tree.revert(file_list,
2937
tree.branch.repository.revision_tree(rev_id),
2938
not no_backup, pb, report_changes=True)
2939
finally:
2940
pb.finished()
2941
2942
2943
class cmd_assert_fail(Command):
2944
"""Test reporting of assertion failures"""
2945
# intended just for use in testing
2946
2947
hidden = True
2948
2949
def run(self):
2950
raise AssertionError("always fails")
2951
2952
2953
class cmd_help(Command):
2954
"""Show help on a command or other topic.
2955
"""
2956
2957
_see_also = ['topics']
2958
takes_options = [
2959
Option('long', 'Show help on all commands.'),
2960
]
2961
takes_args = ['topic?']
2962
aliases = ['?', '--help', '-?', '-h']
2963
2964
@display_command
2965
def run(self, topic=None, long=False):
2966
import bzrlib.help
2967
if topic is None and long:
2968
topic = "commands"
2969
bzrlib.help.help(topic)
2970
2971
2972
class cmd_shell_complete(Command):
2973
"""Show appropriate completions for context.
2974
2975
For a list of all available commands, say 'bzr shell-complete'.
2976
"""
2977
takes_args = ['context?']
2978
aliases = ['s-c']
2979
hidden = True
2980
2981
@display_command
2982
def run(self, context=None):
2983
import shellcomplete
2984
shellcomplete.shellcomplete(context)
2985
2986
2987
class cmd_fetch(Command):
2988
"""Copy in history from another branch but don't merge it.
2989
2990
This is an internal method used for pull and merge.
2991
"""
2992
hidden = True
2993
takes_args = ['from_branch', 'to_branch']
2994
def run(self, from_branch, to_branch):
2995
from bzrlib.fetch import Fetcher
2996
from_b = Branch.open(from_branch)
2997
to_b = Branch.open(to_branch)
2998
Fetcher(to_b, from_b)
2999
3000
3001
class cmd_missing(Command):
3002
"""Show unmerged/unpulled revisions between two branches.
3003
3004
OTHER_BRANCH may be local or remote.
3005
"""
3006
3007
_see_also = ['merge', 'pull']
3008
takes_args = ['other_branch?']
3009
takes_options = [
3010
Option('reverse', 'Reverse the order of revisions.'),
3011
Option('mine-only',
3012
'Display changes in the local branch only.'),
3013
Option('this' , 'Same as --mine-only.'),
3014
Option('theirs-only',
3015
'Display changes in the remote branch only.'),
3016
Option('other', 'Same as --theirs-only.'),
3017
'log-format',
3018
'show-ids',
3019
'verbose'
3020
]
3021
encoding_type = 'replace'
3022
3023
@display_command
3024
def run(self, other_branch=None, reverse=False, mine_only=False,
3025
theirs_only=False, log_format=None, long=False, short=False, line=False,
3026
show_ids=False, verbose=False, this=False, other=False):
3027
from bzrlib.missing import find_unmerged, iter_log_revisions
3028
from bzrlib.log import log_formatter
3029
3030
if this:
3031
mine_only = this
3032
if other:
3033
theirs_only = other
3034
3035
local_branch = Branch.open_containing(u".")[0]
3036
parent = local_branch.get_parent()
3037
if other_branch is None:
3038
other_branch = parent
3039
if other_branch is None:
3040
raise errors.BzrCommandError("No peer location known"
3041
" or specified.")
3042
display_url = urlutils.unescape_for_display(parent,
3043
self.outf.encoding)
3044
self.outf.write("Using last location: " + display_url + "\n")
3045
3046
remote_branch = Branch.open(other_branch)
3047
if remote_branch.base == local_branch.base:
3048
remote_branch = local_branch
3049
local_branch.lock_read()
3050
try:
3051
remote_branch.lock_read()
3052
try:
3053
local_extra, remote_extra = find_unmerged(local_branch,
3054
remote_branch)
3055
if log_format is None:
3056
registry = log.log_formatter_registry
3057
log_format = registry.get_default(local_branch)
3058
lf = log_format(to_file=self.outf,
3059
show_ids=show_ids,
3060
show_timezone='original')
3061
if reverse is False:
3062
local_extra.reverse()
3063
remote_extra.reverse()
3064
if local_extra and not theirs_only:
3065
self.outf.write("You have %d extra revision(s):\n" %
3066
len(local_extra))
3067
for revision in iter_log_revisions(local_extra,
3068
local_branch.repository,
3069
verbose):
3070
lf.log_revision(revision)
3071
printed_local = True
3072
else:
3073
printed_local = False
3074
if remote_extra and not mine_only:
3075
if printed_local is True:
3076
self.outf.write("\n\n\n")
3077
self.outf.write("You are missing %d revision(s):\n" %
3078
len(remote_extra))
3079
for revision in iter_log_revisions(remote_extra,
3080
remote_branch.repository,
3081
verbose):
3082
lf.log_revision(revision)
3083
if not remote_extra and not local_extra:
3084
status_code = 0
3085
self.outf.write("Branches are up to date.\n")
3086
else:
3087
status_code = 1
3088
finally:
3089
remote_branch.unlock()
3090
finally:
3091
local_branch.unlock()
3092
if not status_code and parent is None and other_branch is not None:
3093
local_branch.lock_write()
3094
try:
3095
# handle race conditions - a parent might be set while we run.
3096
if local_branch.get_parent() is None:
3097
local_branch.set_parent(remote_branch.base)
3098
finally:
3099
local_branch.unlock()
3100
return status_code
3101
3102
3103
class cmd_pack(Command):
3104
"""Compress the data within a repository."""
3105
3106
_see_also = ['repositories']
3107
takes_args = ['branch_or_repo?']
3108
3109
def run(self, branch_or_repo='.'):
3110
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3111
try:
3112
branch = dir.open_branch()
3113
repository = branch.repository
3114
except errors.NotBranchError:
3115
repository = dir.open_repository()
3116
repository.pack()
3117
3118
3119
class cmd_plugins(Command):
3120
"""List the installed plugins.
3121
3122
This command displays the list of installed plugins including the
3123
path where each one is located and a short description of each.
3124
3125
A plugin is an external component for Bazaar that extends the
3126
revision control system, by adding or replacing code in Bazaar.
3127
Plugins can do a variety of things, including overriding commands,
3128
adding new commands, providing additional network transports and
3129
customizing log output.
3130
3131
See the Bazaar web site, http://bazaar-vcs.org, for further
3132
information on plugins including where to find them and how to
3133
install them. Instructions are also provided there on how to
3134
write new plugins using the Python programming language.
3135
"""
3136
3137
@display_command
3138
def run(self):
3139
import bzrlib.plugin
3140
from inspect import getdoc
3141
for name, plugin in bzrlib.plugin.all_plugins().items():
3142
if getattr(plugin, '__path__', None) is not None:
3143
print plugin.__path__[0]
3144
elif getattr(plugin, '__file__', None) is not None:
3145
print plugin.__file__
3146
else:
3147
print repr(plugin)
3148
3149
d = getdoc(plugin)
3150
if d:
3151
print '\t', d.split('\n')[0]
3152
3153
3154
class cmd_testament(Command):
3155
"""Show testament (signing-form) of a revision."""
3156
takes_options = [
3157
'revision',
3158
Option('long', help='Produce long-format testament.'),
3159
Option('strict',
3160
help='Produce a strict-format testament.')]
3161
takes_args = ['branch?']
3162
@display_command
3163
def run(self, branch=u'.', revision=None, long=False, strict=False):
3164
from bzrlib.testament import Testament, StrictTestament
3165
if strict is True:
3166
testament_class = StrictTestament
3167
else:
3168
testament_class = Testament
3169
b = WorkingTree.open_containing(branch)[0].branch
3170
b.lock_read()
3171
try:
3172
if revision is None:
3173
rev_id = b.last_revision()
3174
else:
3175
rev_id = revision[0].in_history(b).rev_id
3176
t = testament_class.from_revision(b.repository, rev_id)
3177
if long:
3178
sys.stdout.writelines(t.as_text_lines())
3179
else:
3180
sys.stdout.write(t.as_short_text())
3181
finally:
3182
b.unlock()
3183
3184
3185
class cmd_annotate(Command):
3186
"""Show the origin of each line in a file.
3187
3188
This prints out the given file with an annotation on the left side
3189
indicating which revision, author and date introduced the change.
3190
3191
If the origin is the same for a run of consecutive lines, it is
3192
shown only at the top, unless the --all option is given.
3193
"""
3194
# TODO: annotate directories; showing when each file was last changed
3195
# TODO: if the working copy is modified, show annotations on that
3196
# with new uncommitted lines marked
3197
aliases = ['ann', 'blame', 'praise']
3198
takes_args = ['filename']
3199
takes_options = [Option('all', help='Show annotations on all lines.'),
3200
Option('long', help='Show commit date in annotations.'),
3201
'revision',
3202
'show-ids',
3203
]
3204
encoding_type = 'exact'
3205
3206
@display_command
3207
def run(self, filename, all=False, long=False, revision=None,
3208
show_ids=False):
3209
from bzrlib.annotate import annotate_file
3210
tree, relpath = WorkingTree.open_containing(filename)
3211
branch = tree.branch
3212
branch.lock_read()
3213
try:
3214
if revision is None:
3215
revision_id = branch.last_revision()
3216
elif len(revision) != 1:
3217
raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3218
else:
3219
revision_id = revision[0].in_history(branch).rev_id
3220
file_id = tree.path2id(relpath)
3221
if file_id is None:
3222
raise errors.NotVersionedError(filename)
3223
tree = branch.repository.revision_tree(revision_id)
3224
file_version = tree.inventory[file_id].revision
3225
annotate_file(branch, file_version, file_id, long, all, self.outf,
3226
show_ids=show_ids)
3227
finally:
3228
branch.unlock()
3229
3230
3231
class cmd_re_sign(Command):
3232
"""Create a digital signature for an existing revision."""
3233
# TODO be able to replace existing ones.
3234
3235
hidden = True # is this right ?
3236
takes_args = ['revision_id*']
3237
takes_options = ['revision']
3238
3239
def run(self, revision_id_list=None, revision=None):
3240
import bzrlib.gpg as gpg
3241
if revision_id_list is not None and revision is not None:
3242
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3243
if revision_id_list is None and revision is None:
3244
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3245
b = WorkingTree.open_containing(u'.')[0].branch
3246
gpg_strategy = gpg.GPGStrategy(b.get_config())
3247
if revision_id_list is not None:
3248
for revision_id in revision_id_list:
3249
b.repository.sign_revision(revision_id, gpg_strategy)
3250
elif revision is not None:
3251
if len(revision) == 1:
3252
revno, rev_id = revision[0].in_history(b)
3253
b.repository.sign_revision(rev_id, gpg_strategy)
3254
elif len(revision) == 2:
3255
# are they both on rh- if so we can walk between them
3256
# might be nice to have a range helper for arbitrary
3257
# revision paths. hmm.
3258
from_revno, from_revid = revision[0].in_history(b)
3259
to_revno, to_revid = revision[1].in_history(b)
3260
if to_revid is None:
3261
to_revno = b.revno()
3262
if from_revno is None or to_revno is None:
3263
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3264
for revno in range(from_revno, to_revno + 1):
3265
b.repository.sign_revision(b.get_rev_id(revno),
3266
gpg_strategy)
3267
else:
3268
raise errors.BzrCommandError('Please supply either one revision, or a range.')
3269
3270
3271
class cmd_bind(Command):
3272
"""Convert the current branch into a checkout of the supplied branch.
3273
3274
Once converted into a checkout, commits must succeed on the master branch
3275
before they will be applied to the local branch.
3276
"""
3277
3278
_see_also = ['checkouts', 'unbind']
3279
takes_args = ['location?']
3280
takes_options = []
3281
3282
def run(self, location=None):
3283
b, relpath = Branch.open_containing(u'.')
3284
if location is None:
3285
try:
3286
location = b.get_old_bound_location()
3287
except errors.UpgradeRequired:
3288
raise errors.BzrCommandError('No location supplied. '
3289
'This format does not remember old locations.')
3290
else:
3291
if location is None:
3292
raise errors.BzrCommandError('No location supplied and no '
3293
'previous location known')
3294
b_other = Branch.open(location)
3295
try:
3296
b.bind(b_other)
3297
except errors.DivergedBranches:
3298
raise errors.BzrCommandError('These branches have diverged.'
3299
' Try merging, and then bind again.')
3300
3301
3302
class cmd_unbind(Command):
3303
"""Convert the current checkout into a regular branch.
3304
3305
After unbinding, the local branch is considered independent and subsequent
3306
commits will be local only.
3307
"""
3308
3309
_see_also = ['checkouts', 'bind']
3310
takes_args = []
3311
takes_options = []
3312
3313
def run(self):
3314
b, relpath = Branch.open_containing(u'.')
3315
if not b.unbind():
3316
raise errors.BzrCommandError('Local branch is not bound')
3317
3318
3319
class cmd_uncommit(Command):
3320
"""Remove the last committed revision.
3321
3322
--verbose will print out what is being removed.
3323
--dry-run will go through all the motions, but not actually
3324
remove anything.
3325
3326
In the future, uncommit will create a revision bundle, which can then
3327
be re-applied.
3328
"""
3329
3330
# TODO: jam 20060108 Add an option to allow uncommit to remove
3331
# unreferenced information in 'branch-as-repository' branches.
3332
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
3333
# information in shared branches as well.
3334
_see_also = ['commit']
3335
takes_options = ['verbose', 'revision',
3336
Option('dry-run', help='Don\'t actually make changes.'),
3337
Option('force', help='Say yes to all questions.')]
3338
takes_args = ['location?']
3339
aliases = []
3340
3341
def run(self, location=None,
3342
dry_run=False, verbose=False,
3343
revision=None, force=False):
3344
from bzrlib.log import log_formatter, show_log
3345
import sys
3346
from bzrlib.uncommit import uncommit
3347
3348
if location is None:
3349
location = u'.'
3350
control, relpath = bzrdir.BzrDir.open_containing(location)
3351
try:
3352
tree = control.open_workingtree()
3353
b = tree.branch
3354
except (errors.NoWorkingTree, errors.NotLocalUrl):
3355
tree = None
3356
b = control.open_branch()
3357
3358
rev_id = None
3359
if revision is None:
3360
revno = b.revno()
3361
else:
3362
# 'bzr uncommit -r 10' actually means uncommit
3363
# so that the final tree is at revno 10.
3364
# but bzrlib.uncommit.uncommit() actually uncommits
3365
# the revisions that are supplied.
3366
# So we need to offset it by one
3367
revno = revision[0].in_history(b).revno+1
3368
3369
if revno <= b.revno():
3370
rev_id = b.get_rev_id(revno)
3371
if rev_id is None:
3372
self.outf.write('No revisions to uncommit.\n')
3373
return 1
3374
3375
lf = log_formatter('short',
3376
to_file=self.outf,
3377
show_timezone='original')
3378
3379
show_log(b,
3380
lf,
3381
verbose=False,
3382
direction='forward',
3383
start_revision=revno,
3384
end_revision=b.revno())
3385
3386
if dry_run:
3387
print 'Dry-run, pretending to remove the above revisions.'
3388
if not force:
3389
val = raw_input('Press <enter> to continue')
3390
else:
3391
print 'The above revision(s) will be removed.'
3392
if not force:
3393
val = raw_input('Are you sure [y/N]? ')
3394
if val.lower() not in ('y', 'yes'):
3395
print 'Canceled'
3396
return 0
3397
3398
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3399
revno=revno)
3400
3401
3402
class cmd_break_lock(Command):
3403
"""Break a dead lock on a repository, branch or working directory.
3404
3405
CAUTION: Locks should only be broken when you are sure that the process
3406
holding the lock has been stopped.
3407
3408
You can get information on what locks are open via the 'bzr info' command.
3409
3410
example:
3411
bzr break-lock
3412
"""
3413
takes_args = ['location?']
3414
3415
def run(self, location=None, show=False):
3416
if location is None:
3417
location = u'.'
3418
control, relpath = bzrdir.BzrDir.open_containing(location)
3419
try:
3420
control.break_lock()
3421
except NotImplementedError:
3422
pass
3423
3424
3425
class cmd_wait_until_signalled(Command):
3426
"""Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3427
3428
This just prints a line to signal when it is ready, then blocks on stdin.
3429
"""
3430
3431
hidden = True
3432
3433
def run(self):
3434
sys.stdout.write("running\n")
3435
sys.stdout.flush()
3436
sys.stdin.readline()
3437
3438
3439
class cmd_serve(Command):
3440
"""Run the bzr server."""
3441
3442
aliases = ['server']
3443
3444
takes_options = [
3445
Option('inet',
3446
help='Serve on stdin/out for use from inetd or sshd.'),
3447
Option('port',
3448
help='Listen for connections on nominated port of the form '
3449
'[hostname:]portnumber. Passing 0 as the port number will '
3450
'result in a dynamically allocated port. The default port is '
3451
'4155.',
3452
type=str),
3453
Option('directory',
3454
help='Serve contents of this directory.',
3455
type=unicode),
3456
Option('allow-writes',
3457
help='By default the server is a readonly server. Supplying '
3458
'--allow-writes enables write access to the contents of '
3459
'the served directory and below.'
3460
),
3461
]
3462
3463
def run(self, port=None, inet=False, directory=None, allow_writes=False):
3464
from bzrlib.smart import medium, server
3465
from bzrlib.transport import get_transport
3466
from bzrlib.transport.chroot import ChrootServer
3467
from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
3468
if directory is None:
3469
directory = os.getcwd()
3470
url = urlutils.local_path_to_url(directory)
3471
if not allow_writes:
3472
url = 'readonly+' + url
3473
chroot_server = ChrootServer(get_transport(url))
3474
chroot_server.setUp()
3475
t = get_transport(chroot_server.get_url())
3476
if inet:
3477
smart_server = medium.SmartServerPipeStreamMedium(
3478
sys.stdin, sys.stdout, t)
3479
else:
3480
host = BZR_DEFAULT_INTERFACE
3481
if port is None:
3482
port = BZR_DEFAULT_PORT
3483
else:
3484
if ':' in port:
3485
host, port = port.split(':')
3486
port = int(port)
3487
smart_server = server.SmartTCPServer(t, host=host, port=port)
3488
print 'listening on port: ', smart_server.port
3489
sys.stdout.flush()
3490
# for the duration of this server, no UI output is permitted.
3491
# note that this may cause problems with blackbox tests. This should
3492
# be changed with care though, as we dont want to use bandwidth sending
3493
# progress over stderr to smart server clients!
3494
old_factory = ui.ui_factory
3495
try:
3496
ui.ui_factory = ui.SilentUIFactory()
3497
smart_server.serve()
3498
finally:
3499
ui.ui_factory = old_factory
3500
3501
3502
class cmd_join(Command):
3503
"""Combine a subtree into its containing tree.
3504
3505
This command is for experimental use only. It requires the target tree
3506
to be in dirstate-with-subtree format, which cannot be converted into
3507
earlier formats.
3508
3509
The TREE argument should be an independent tree, inside another tree, but
3510
not part of it. (Such trees can be produced by "bzr split", but also by
3511
running "bzr branch" with the target inside a tree.)
3512
3513
The result is a combined tree, with the subtree no longer an independant
3514
part. This is marked as a merge of the subtree into the containing tree,
3515
and all history is preserved.
3516
3517
If --reference is specified, the subtree retains its independence. It can
3518
be branched by itself, and can be part of multiple projects at the same
3519
time. But operations performed in the containing tree, such as commit
3520
and merge, will recurse into the subtree.
3521
"""
3522
3523
_see_also = ['split']
3524
takes_args = ['tree']
3525
takes_options = [
3526
Option('reference', help='Join by reference.'),
3527
]
3528
hidden = True
3529
3530
def run(self, tree, reference=False):
3531
sub_tree = WorkingTree.open(tree)
3532
parent_dir = osutils.dirname(sub_tree.basedir)
3533
containing_tree = WorkingTree.open_containing(parent_dir)[0]
3534
repo = containing_tree.branch.repository
3535
if not repo.supports_rich_root():
3536
raise errors.BzrCommandError(
3537
"Can't join trees because %s doesn't support rich root data.\n"
3538
"You can use bzr upgrade on the repository."
3539
% (repo,))
3540
if reference:
3541
try:
3542
containing_tree.add_reference(sub_tree)
3543
except errors.BadReferenceTarget, e:
3544
# XXX: Would be better to just raise a nicely printable
3545
# exception from the real origin. Also below. mbp 20070306
3546
raise errors.BzrCommandError("Cannot join %s. %s" %
3547
(tree, e.reason))
3548
else:
3549
try:
3550
containing_tree.subsume(sub_tree)
3551
except errors.BadSubsumeSource, e:
3552
raise errors.BzrCommandError("Cannot join %s. %s" %
3553
(tree, e.reason))
3554
3555
3556
class cmd_split(Command):
3557
"""Split a tree into two trees.
3558
3559
This command is for experimental use only. It requires the target tree
3560
to be in dirstate-with-subtree format, which cannot be converted into
3561
earlier formats.
3562
3563
The TREE argument should be a subdirectory of a working tree. That
3564
subdirectory will be converted into an independent tree, with its own
3565
branch. Commits in the top-level tree will not apply to the new subtree.
3566
If you want that behavior, do "bzr join --reference TREE".
3567
"""
3568
3569
_see_also = ['join']
3570
takes_args = ['tree']
3571
3572
hidden = True
3573
3574
def run(self, tree):
3575
containing_tree, subdir = WorkingTree.open_containing(tree)
3576
sub_id = containing_tree.path2id(subdir)
3577
if sub_id is None:
3578
raise errors.NotVersionedError(subdir)
3579
try:
3580
containing_tree.extract(sub_id)
3581
except errors.RootNotRich:
3582
raise errors.UpgradeRequired(containing_tree.branch.base)
3583
3584
3585
3586
class cmd_merge_directive(Command):
3587
"""Generate a merge directive for auto-merge tools.
3588
3589
A directive requests a merge to be performed, and also provides all the
3590
information necessary to do so. This means it must either include a
3591
revision bundle, or the location of a branch containing the desired
3592
revision.
3593
3594
A submit branch (the location to merge into) must be supplied the first
3595
time the command is issued. After it has been supplied once, it will
3596
be remembered as the default.
3597
3598
A public branch is optional if a revision bundle is supplied, but required
3599
if --diff or --plain is specified. It will be remembered as the default
3600
after the first use.
3601
"""
3602
3603
takes_args = ['submit_branch?', 'public_branch?']
3604
3605
hidden = True
3606
3607
_see_also = ['submit']
3608
3609
takes_options = [
3610
RegistryOption.from_kwargs('patch-type',
3611
'The type of patch to include in the directive',
3612
title='Patch type',
3613
value_switches=True,
3614
enum_switch=False,
3615
bundle='Bazaar revision bundle (default).',
3616
diff='Normal unified diff.',
3617
plain='No patch, just directive.'),
3618
Option('sign', help='GPG-sign the directive.'), 'revision',
3619
Option('mail-to', type=str,
3620
help='Instead of printing the directive, email to this address.'),
3621
Option('message', type=str, short_name='m',
3622
help='Message to use when committing this merge.')
3623
]
3624
3625
encoding_type = 'exact'
3626
3627
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
3628
sign=False, revision=None, mail_to=None, message=None):
3629
from bzrlib.revision import ensure_null, NULL_REVISION
3630
include_patch, include_bundle = {
3631
'plain': (False, False),
3632
'diff': (True, False),
3633
'bundle': (True, True),
3634
}[patch_type]
3635
branch = Branch.open('.')
3636
stored_submit_branch = branch.get_submit_branch()
3637
if submit_branch is None:
3638
submit_branch = stored_submit_branch
3639
else:
3640
if stored_submit_branch is None:
3641
branch.set_submit_branch(submit_branch)
3642
if submit_branch is None:
3643
submit_branch = branch.get_parent()
3644
if submit_branch is None:
3645
raise errors.BzrCommandError('No submit branch specified or known')
3646
3647
stored_public_branch = branch.get_public_branch()
3648
if public_branch is None:
3649
public_branch = stored_public_branch
3650
elif stored_public_branch is None:
3651
branch.set_public_branch(public_branch)
3652
if not include_bundle and public_branch is None:
3653
raise errors.BzrCommandError('No public branch specified or'
3654
' known')
3655
base_revision_id = None
3656
if revision is not None:
3657
if len(revision) > 2:
3658
raise errors.BzrCommandError('bzr merge-directive takes '
3659
'at most two one revision identifiers')
3660
revision_id = revision[-1].in_history(branch).rev_id
3661
if len(revision) == 2:
3662
base_revision_id = revision[0].in_history(branch).rev_id
3663
base_revision_id = ensure_null(base_revision_id)
3664
else:
3665
revision_id = branch.last_revision()
3666
revision_id = ensure_null(revision_id)
3667
if revision_id == NULL_REVISION:
3668
raise errors.BzrCommandError('No revisions to bundle.')
3669
directive = merge_directive.MergeDirective2.from_objects(
3670
branch.repository, revision_id, time.time(),
3671
osutils.local_time_offset(), submit_branch,
3672
public_branch=public_branch, include_patch=include_patch,
3673
include_bundle=include_bundle, message=message,
3674
base_revision_id=base_revision_id)
3675
if mail_to is None:
3676
if sign:
3677
self.outf.write(directive.to_signed(branch))
3678
else:
3679
self.outf.writelines(directive.to_lines())
3680
else:
3681
message = directive.to_email(mail_to, branch, sign)
3682
s = SMTPConnection(branch.get_config())
3683
s.send_email(message)
3684
3685
3686
class cmd_submit(Command):
3687
"""Create a merge-directive for submiting changes.
3688
3689
A merge directive provides many things needed for requesting merges:
3690
- A machine-readable description of the merge to perform
3691
- An optional patch that is a preview of the changes requested
3692
- An optional bundle of revision data, so that the changes can be applied
3693
directly from the merge directive, without retrieving data from a
3694
branch.
3695
3696
If --no-bundle is specified, then public_branch is needed (and must be
3697
up-to-date), so that the receiver can perform the merge using the
3698
public_branch. The public_branch is always included if known, so that
3699
people can check it later.
3700
3701
The submit branch defaults to the parent, but can be overridden. Both
3702
submit branch and public branch will be remembered if supplied.
3703
3704
If a public_branch is known for the submit_branch, that public submit
3705
branch is used in the merge instructions. This means that a local mirror
3706
can be used as your actual submit branch, once you have set public_branch
3707
for that mirror.
3708
"""
3709
3710
encoding_type = 'exact'
3711
3712
aliases = ['bundle', 'bundle-revisions']
3713
3714
_see_also = ['merge']
3715
3716
takes_args = ['submit_branch?', 'public_branch?']
3717
takes_options = [
3718
Option('no-bundle',
3719
help='Do not include a bundle in the merge directive.'),
3720
Option('no-patch', help='Do not include a preview patch in the merge'
3721
' directive.'),
3722
Option('remember',
3723
help='Remember submit and public branch.'),
3724
Option('from',
3725
help='Branch to generate the submission from, '
3726
'rather than the one containing the working directory.',
3727
short_name='f',
3728
type=unicode),
3729
Option('output', short_name='o', help='Write directive to this file.',
3730
type=unicode),
3731
'revision',
3732
]
3733
3734
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
3735
no_patch=False, revision=None, remember=False, output=None,
3736
**kwargs):
3737
from bzrlib.revision import ensure_null, NULL_REVISION
3738
if output is None:
3739
outfile = self.outf
3740
else:
3741
outfile = open(output, 'wb')
3742
try:
3743
from_ = kwargs.get('from', '.')
3744
branch = Branch.open_containing(from_)[0]
3745
if remember and submit_branch is None:
3746
raise errors.BzrCommandError(
3747
'--remember requires a branch to be specified.')
3748
stored_submit_branch = branch.get_submit_branch()
3749
remembered_submit_branch = False
3750
if submit_branch is None:
3751
submit_branch = stored_submit_branch
3752
remembered_submit_branch = True
3753
else:
3754
if stored_submit_branch is None or remember:
3755
branch.set_submit_branch(submit_branch)
3756
if submit_branch is None:
3757
submit_branch = branch.get_parent()
3758
remembered_submit_branch = True
3759
if submit_branch is None:
3760
raise errors.BzrCommandError('No submit branch known or'
3761
' specified')
3762
if remembered_submit_branch:
3763
note('Using saved location: %s', submit_branch)
3764
3765
stored_public_branch = branch.get_public_branch()
3766
if public_branch is None:
3767
public_branch = stored_public_branch
3768
elif stored_public_branch is None or remember:
3769
branch.set_public_branch(public_branch)
3770
if no_bundle and public_branch is None:
3771
raise errors.BzrCommandError('No public branch specified or'
3772
' known')
3773
base_revision_id = None
3774
if revision is not None:
3775
if len(revision) > 2:
3776
raise errors.BzrCommandError('bzr submit takes '
3777
'at most two one revision identifiers')
3778
revision_id = revision[-1].in_history(branch).rev_id
3779
if len(revision) == 2:
3780
base_revision_id = revision[0].in_history(branch).rev_id
3781
base_revision_id = ensure_null(base_revision_id)
3782
else:
3783
revision_id = branch.last_revision()
3784
revision_id = ensure_null(revision_id)
3785
if revision_id == NULL_REVISION:
3786
raise errors.BzrCommandError('No revisions to submit.')
3787
directive = merge_directive.MergeDirective2.from_objects(
3788
branch.repository, revision_id, time.time(),
3789
osutils.local_time_offset(), submit_branch,
3790
public_branch=public_branch, include_patch=not no_patch,
3791
include_bundle=not no_bundle, message=None,
3792
base_revision_id=base_revision_id)
3793
outfile.writelines(directive.to_lines())
3794
finally:
3795
if output is not None:
3796
outfile.close()
3797
3798
class cmd_tag(Command):
3799
"""Create a tag naming a revision.
3800
3801
Tags give human-meaningful names to revisions. Commands that take a -r
3802
(--revision) option can be given -rtag:X, where X is any previously
3803
created tag.
3804
3805
Tags are stored in the branch. Tags are copied from one branch to another
3806
along when you branch, push, pull or merge.
3807
3808
It is an error to give a tag name that already exists unless you pass
3809
--force, in which case the tag is moved to point to the new revision.
3810
"""
3811
3812
_see_also = ['commit', 'tags']
3813
takes_args = ['tag_name']
3814
takes_options = [
3815
Option('delete',
3816
help='Delete this tag rather than placing it.',
3817
),
3818
Option('directory',
3819
help='Branch in which to place the tag.',
3820
short_name='d',
3821
type=unicode,
3822
),
3823
Option('force',
3824
help='Replace existing tags.',
3825
),
3826
'revision',
3827
]
3828
3829
def run(self, tag_name,
3830
delete=None,
3831
directory='.',
3832
force=None,
3833
revision=None,
3834
):
3835
branch, relpath = Branch.open_containing(directory)
3836
branch.lock_write()
3837
try:
3838
if delete:
3839
branch.tags.delete_tag(tag_name)
3840
self.outf.write('Deleted tag %s.\n' % tag_name)
3841
else:
3842
if revision:
3843
if len(revision) != 1:
3844
raise errors.BzrCommandError(
3845
"Tags can only be placed on a single revision, "
3846
"not on a range")
3847
revision_id = revision[0].in_history(branch).rev_id
3848
else:
3849
revision_id = branch.last_revision()
3850
if (not force) and branch.tags.has_tag(tag_name):
3851
raise errors.TagAlreadyExists(tag_name)
3852
branch.tags.set_tag(tag_name, revision_id)
3853
self.outf.write('Created tag %s.\n' % tag_name)
3854
finally:
3855
branch.unlock()
3856
3857
3858
class cmd_tags(Command):
3859
"""List tags.
3860
3861
This tag shows a table of tag names and the revisions they reference.
3862
"""
3863
3864
_see_also = ['tag']
3865
takes_options = [
3866
Option('directory',
3867
help='Branch whose tags should be displayed.',
3868
short_name='d',
3869
type=unicode,
3870
),
3871
]
3872
3873
@display_command
3874
def run(self,
3875
directory='.',
3876
):
3877
branch, relpath = Branch.open_containing(directory)
3878
for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
3879
self.outf.write('%-20s %s\n' % (tag_name, target))
3880
3881
3882
# command-line interpretation helper for merge-related commands
3883
def _merge_helper(other_revision, base_revision,
3884
check_clean=True, ignore_zero=False,
3885
this_dir=None, backup_files=False,
3886
merge_type=None,
3887
file_list=None, show_base=False, reprocess=False,
3888
pull=False,
3889
pb=DummyProgress(),
3890
change_reporter=None,
3891
other_rev_id=None, base_rev_id=None,
3892
possible_transports=None):
3893
"""Merge changes into a tree.
3894
3895
base_revision
3896
list(path, revno) Base for three-way merge.
3897
If [None, None] then a base will be automatically determined.
3898
other_revision
3899
list(path, revno) Other revision for three-way merge.
3900
this_dir
3901
Directory to merge changes into; '.' by default.
3902
check_clean
3903
If true, this_dir must have no uncommitted changes before the
3904
merge begins.
3905
ignore_zero - If true, suppress the "zero conflicts" message when
3906
there are no conflicts; should be set when doing something we expect
3907
to complete perfectly.
3908
file_list - If supplied, merge only changes to selected files.
3909
3910
All available ancestors of other_revision and base_revision are
3911
automatically pulled into the branch.
3912
3913
The revno may be -1 to indicate the last revision on the branch, which is
3914
the typical case.
3915
3916
This function is intended for use from the command line; programmatic
3917
clients might prefer to call merge.merge_inner(), which has less magic
3918
behavior.
3919
"""
3920
# Loading it late, so that we don't always have to import bzrlib.merge
3921
if merge_type is None:
3922
merge_type = _mod_merge.Merge3Merger
3923
if this_dir is None:
3924
this_dir = u'.'
3925
this_tree = WorkingTree.open_containing(this_dir)[0]
3926
if show_base and not merge_type is _mod_merge.Merge3Merger:
3927
raise errors.BzrCommandError("Show-base is not supported for this merge"
3928
" type. %s" % merge_type)
3929
if reprocess and not merge_type.supports_reprocess:
3930
raise errors.BzrCommandError("Conflict reduction is not supported for merge"
3931
" type %s." % merge_type)
3932
if reprocess and show_base:
3933
raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
3934
# TODO: jam 20070226 We should really lock these trees earlier. However, we
3935
# only want to take out a lock_tree_write() if we don't have to pull
3936
# any ancestry. But merge might fetch ancestry in the middle, in
3937
# which case we would need a lock_write().
3938
# Because we cannot upgrade locks, for now we live with the fact that
3939
# the tree will be locked multiple times during a merge. (Maybe
3940
# read-only some of the time, but it means things will get read
3941
# multiple times.)
3942
try:
3943
merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
3944
pb=pb, change_reporter=change_reporter)
3945
merger.pp = ProgressPhase("Merge phase", 5, pb)
3946
merger.pp.next_phase()
3947
merger.check_basis(check_clean)
3948
if other_rev_id is not None:
3949
merger.set_other_revision(other_rev_id, this_tree.branch)
3950
else:
3951
merger.set_other(other_revision, possible_transports)
3952
merger.pp.next_phase()
3953
if base_rev_id is not None:
3954
merger.set_base_revision(base_rev_id, this_tree.branch)
3955
elif base_revision is not None:
3956
merger.set_base(base_revision)
3957
else:
3958
merger.find_base()
3959
if merger.base_rev_id == merger.other_rev_id:
3960
note('Nothing to do.')
3961
return 0
3962
if file_list is None:
3963
if pull and merger.base_rev_id == merger.this_rev_id:
3964
# FIXME: deduplicate with pull
3965
result = merger.this_tree.pull(merger.this_branch,
3966
False, merger.other_rev_id)
3967
if result.old_revid == result.new_revid:
3968
note('No revisions to pull.')
3969
else:
3970
note('Now on revision %d.' % result.new_revno)
3971
return 0
3972
merger.backup_files = backup_files
3973
merger.merge_type = merge_type
3974
merger.set_interesting_files(file_list)
3975
merger.show_base = show_base
3976
merger.reprocess = reprocess
3977
conflicts = merger.do_merge()
3978
if file_list is None:
3979
merger.set_pending()
3980
finally:
3981
pb.clear()
3982
return conflicts
3983
3984
3985
def _create_prefix(cur_transport):
3986
needed = [cur_transport]
3987
# Recurse upwards until we can create a directory successfully
3988
while True:
3989
new_transport = cur_transport.clone('..')
3990
if new_transport.base == cur_transport.base:
3991
raise errors.BzrCommandError(
3992
"Failed to create path prefix for %s."
3993
% cur_transport.base)
3994
try:
3995
new_transport.mkdir('.')
3996
except errors.NoSuchFile:
3997
needed.append(new_transport)
3998
cur_transport = new_transport
3999
else:
4000
break
4001
# Now we only need to create child directories
4002
while needed:
4003
cur_transport = needed.pop()
4004
cur_transport.ensure_base()
4005
4006
4007
def _get_bundle_helper(location):
4008
"""Get a bundle if 'location' points to one.
4009
4010
Try try to identify a bundle and returns its mergeable form. If it's not,
4011
we return the tried transport anyway so that it can reused to access the
4012
branch
4013
4014
:param location: can point to a bundle or a branch.
4015
4016
:return: mergeable, transport
4017
"""
4018
mergeable = None
4019
url = urlutils.normalize_url(location)
4020
url, filename = urlutils.split(url, exclude_trailing_slash=False)
4021
location_transport = transport.get_transport(url)
4022
if filename:
4023
try:
4024
# There may be redirections but we ignore the intermediate
4025
# and final transports used
4026
read = bundle.read_mergeable_from_transport
4027
mergeable, t = read(location_transport, filename)
4028
except errors.NotABundle:
4029
# Continue on considering this url a Branch but adjust the
4030
# location_transport
4031
location_transport = location_transport.clone(filename)
4032
return mergeable, location_transport
4033
4034
4035
# Compatibility
4036
merge = _merge_helper
4037
4038
4039
# these get imported and then picked up by the scan for cmd_*
4040
# TODO: Some more consistent way to split command definitions across files;
4041
# we do need to load at least some information about them to know of
4042
# aliases. ideally we would avoid loading the implementation until the
4043
# details were needed.
4044
from bzrlib.cmd_version_info import cmd_version_info
4045
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4046
from bzrlib.bundle.commands import (
4047
cmd_bundle_info,
4048
)
4049
from bzrlib.sign_my_commits import cmd_sign_my_commits
4050
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4051
cmd_weave_plan_merge, cmd_weave_merge_text
Loggerhead is a web-based interface for Breezy
Version: 2.0.1