~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Tim Penhey
  • Date: 2008-04-25 11:23:00 UTC
  • mto: (3473.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3474.
  • Revision ID: tim@penhey.net-20080425112300-sf5soa5dg2d37kvc
Added tests.

Show diffs side-by-side

added added

removed removed

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