← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-06-04 10:55:31 UTC
  • mfrom: (1728.2.4 bzr.mbp.integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060604105531-0071ce43b2156b7a
(mbp) several small fixes

Show diffs side-by-side

added added

removed removed

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