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