~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Author(s): Jari Aalto
  • Date: 2008-12-24 03:14:16 UTC
  • mto: This revision was merged to the branch mainline in revision 3919.
  • Revision ID: mbp@sourcefrog.net-20081224031416-krocx1r3fyu52t0j
In user guide, use 'PROJECT' as a metavariable not 'X-repo'

Show diffs side-by-side

added added

removed removed

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