~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

merge merge tweaks from aaron, which includes latest .dev

Show diffs side-by-side

added added

removed removed

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