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