← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

(jam) Some python2.4 fixes for the StaticTuple code.

Show diffs side-by-side

added added

removed removed

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