/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2005-08-04 22:04:40 UTC
  • Revision ID: mbp@sourcefrog.net-20050804220440-99562df8151d1ac5
- add pending merge from aaron

Show diffs side-by-side

added added

removed removed

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