← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Vincent Ladeuil
  • Date: 2012-02-14 17:22:37 UTC
  • mfrom: (6466 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6468.
  • Revision ID: v.ladeuil+lp@free.fr-20120214172237-7dv7er3n4uy8d5m4
Merge trunk

Show diffs side-by-side

added added

removed removed

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