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