/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: John Arbash Meinel
  • Date: 2009-01-08 19:15:20 UTC
  • mto: (3932.2.4 1.11)
  • mto: This revision was merged to the branch mainline in revision 3933.
  • Revision ID: john@arbash-meinel.com-20090108191520-ymp6abkgwvkz297o
Fix Branch.open() so that for stacked branches we don't open multiple connections.

Show diffs side-by-side

added added

removed removed

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