← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

Show diffs side-by-side

added added

removed removed

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