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