← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: John Arbash Meinel
  • Date: 2013-05-19 14:29:37 UTC
  • mfrom: (6437.63.9 2.5)
  • mto: (6437.63.10 2.5)
  • mto: This revision was merged to the branch mainline in revision 6575.
  • Revision ID: john@arbash-meinel.com-20130519142937-21ykz2n2y2f22za9
Merge in the actual 2.5 branch. It seems I failed before

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