/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-09-01 09:01:24 UTC
  • mfrom: (3668.3.2 trunk2)
  • Revision ID: pqm@pqm.ubuntu.com-20080901090124-w1cxlizdk4g3mstv
(vila) selftest --starting-with now accepts multiple values

Show diffs side-by-side

added added

removed removed

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