/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: Marius Kruger
  • Date: 2008-12-14 03:22:01 UTC
  • mto: This revision was merged to the branch mainline in revision 3909.
  • Revision ID: amanic@gmail.com-20081214032201-lx059v3ts0pihvcf
add test_list_tags_revision_filtering

Show diffs side-by-side

added added

removed removed

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