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