~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Vincent Ladeuil
  • Date: 2010-07-20 10:50:44 UTC
  • mfrom: (5349.3.2 598701-no-internal-name)
  • mto: This revision was merged to the branch mainline in revision 5354.
  • Revision ID: v.ladeuil+lp@free.fr-20100720105044-2qcm9avezubw3dea
Dont print internal object names in invalid revision spec error

Show diffs side-by-side

added added

removed removed

Lines of Context:
75
75
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
76
76
 
77
77
 
 
78
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
78
79
def tree_files(file_list, default_branch=u'.', canonicalize=True,
79
80
    apply_view=True):
80
 
    try:
81
 
        return internal_tree_files(file_list, default_branch, canonicalize,
82
 
            apply_view)
83
 
    except errors.FileInWrongBranch, e:
84
 
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
85
 
                                     (e.path, file_list[0]))
 
81
    return internal_tree_files(file_list, default_branch, canonicalize,
 
82
        apply_view)
86
83
 
87
84
 
88
85
def tree_files_for_add(file_list):
152
149
 
153
150
# XXX: Bad function name; should possibly also be a class method of
154
151
# WorkingTree rather than a function.
 
152
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
155
153
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
156
154
    apply_view=True):
157
155
    """Convert command-line paths to a WorkingTree and relative paths.
158
156
 
 
157
    Deprecated: use WorkingTree.open_containing_paths instead.
 
158
 
159
159
    This is typically used for command-line processors that take one or
160
160
    more filenames, and infer the workingtree that contains them.
161
161
 
171
171
 
172
172
    :return: workingtree, [relative_paths]
173
173
    """
174
 
    if file_list is None or len(file_list) == 0:
175
 
        tree = WorkingTree.open_containing(default_branch)[0]
176
 
        if tree.supports_views() and apply_view:
177
 
            view_files = tree.views.lookup_view()
178
 
            if view_files:
179
 
                file_list = view_files
180
 
                view_str = views.view_display_str(view_files)
181
 
                note("Ignoring files outside view. View is %s" % view_str)
182
 
        return tree, file_list
183
 
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
184
 
    return tree, safe_relpath_files(tree, file_list, canonicalize,
185
 
        apply_view=apply_view)
186
 
 
187
 
 
188
 
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
189
 
    """Convert file_list into a list of relpaths in tree.
190
 
 
191
 
    :param tree: A tree to operate on.
192
 
    :param file_list: A list of user provided paths or None.
193
 
    :param apply_view: if True and a view is set, apply it or check that
194
 
        specified files are within it
195
 
    :return: A list of relative paths.
196
 
    :raises errors.PathNotChild: When a provided path is in a different tree
197
 
        than tree.
198
 
    """
199
 
    if file_list is None:
200
 
        return None
201
 
    if tree.supports_views() and apply_view:
202
 
        view_files = tree.views.lookup_view()
203
 
    else:
204
 
        view_files = []
205
 
    new_list = []
206
 
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
207
 
    # doesn't - fix that up here before we enter the loop.
208
 
    if canonicalize:
209
 
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
210
 
    else:
211
 
        fixer = tree.relpath
212
 
    for filename in file_list:
213
 
        try:
214
 
            relpath = fixer(osutils.dereference_path(filename))
215
 
            if  view_files and not osutils.is_inside_any(view_files, relpath):
216
 
                raise errors.FileOutsideView(filename, view_files)
217
 
            new_list.append(relpath)
218
 
        except errors.PathNotChild:
219
 
            raise errors.FileInWrongBranch(tree.branch, filename)
220
 
    return new_list
 
174
    return WorkingTree.open_containing_paths(
 
175
        file_list, default_directory='.',
 
176
        canonicalize=True,
 
177
        apply_view=True)
221
178
 
222
179
 
223
180
def _get_view_info_for_change_reporter(tree):
232
189
    return view_info
233
190
 
234
191
 
 
192
def _open_directory_or_containing_tree_or_branch(filename, directory):
 
193
    """Open the tree or branch containing the specified file, unless
 
194
    the --directory option is used to specify a different branch."""
 
195
    if directory is not None:
 
196
        return (None, Branch.open(directory), filename)
 
197
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
198
 
 
199
 
235
200
# TODO: Make sure no commands unconditionally use the working directory as a
236
201
# branch.  If a filename argument is used, the first of them should be used to
237
202
# specify the branch.  (Perhaps this can be factored out into some kind of
315
280
            raise errors.BzrCommandError('bzr status --revision takes exactly'
316
281
                                         ' one or two revision specifiers')
317
282
 
318
 
        tree, relfile_list = tree_files(file_list)
 
283
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
319
284
        # Avoid asking for specific files when that is not needed.
320
285
        if relfile_list == ['']:
321
286
            relfile_list = None
340
305
 
341
306
    hidden = True
342
307
    takes_args = ['revision_id?']
343
 
    takes_options = ['revision']
 
308
    takes_options = ['directory', 'revision']
344
309
    # cat-revision is more for frontends so should be exact
345
310
    encoding = 'strict'
346
311
 
353
318
        self.outf.write(revtext.decode('utf-8'))
354
319
 
355
320
    @display_command
356
 
    def run(self, revision_id=None, revision=None):
 
321
    def run(self, revision_id=None, revision=None, directory=u'.'):
357
322
        if revision_id is not None and revision is not None:
358
323
            raise errors.BzrCommandError('You can only supply one of'
359
324
                                         ' revision_id or --revision')
360
325
        if revision_id is None and revision is None:
361
326
            raise errors.BzrCommandError('You must supply either'
362
327
                                         ' --revision or a revision_id')
363
 
        b = WorkingTree.open_containing(u'.')[0].branch
 
328
        b = WorkingTree.open_containing(directory)[0].branch
364
329
 
365
330
        revisions = b.repository.revisions
366
331
        if revisions is None:
483
448
    takes_options = [
484
449
        Option('force',
485
450
               help='Remove the working tree even if it has '
486
 
                    'uncommitted changes.'),
 
451
                    'uncommitted or shelved changes.'),
487
452
        ]
488
453
 
489
454
    def run(self, location_list, force=False):
503
468
            if not force:
504
469
                if (working.has_changes()):
505
470
                    raise errors.UncommittedChanges(working)
 
471
                if working.get_shelf_manager().last_shelf() is not None:
 
472
                    raise errors.ShelvedChanges(working)
506
473
 
507
474
            if working.user_url != working.branch.user_url:
508
475
                raise errors.BzrCommandError("You cannot remove the working tree"
552
519
    takes_args = ['revision_info*']
553
520
    takes_options = [
554
521
        'revision',
555
 
        Option('directory',
 
522
        custom_help('directory',
556
523
            help='Branch to examine, '
557
 
                 'rather than the one containing the working directory.',
558
 
            short_name='d',
559
 
            type=unicode,
560
 
            ),
 
524
                 'rather than the one containing the working directory.'),
561
525
        Option('tree', help='Show revno of working tree'),
562
526
        ]
563
527
 
754
718
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
755
719
 
756
720
        revision = _get_one_revision('inventory', revision)
757
 
        work_tree, file_list = tree_files(file_list)
 
721
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
758
722
        self.add_cleanup(work_tree.lock_read().unlock)
759
723
        if revision is not None:
760
724
            tree = revision.as_tree(work_tree.branch)
825
789
            names_list = []
826
790
        if len(names_list) < 2:
827
791
            raise errors.BzrCommandError("missing file argument")
828
 
        tree, rel_names = tree_files(names_list, canonicalize=False)
 
792
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
829
793
        self.add_cleanup(tree.lock_tree_write().unlock)
830
794
        self._run(tree, names_list, rel_names, after)
831
795
 
836
800
        if after:
837
801
            raise errors.BzrCommandError('--after cannot be specified with'
838
802
                                         ' --auto.')
839
 
        work_tree, file_list = tree_files(names_list, default_branch='.')
 
803
        work_tree, file_list = WorkingTree.open_containing_paths(
 
804
            names_list, default_directory='.')
840
805
        self.add_cleanup(work_tree.lock_tree_write().unlock)
841
806
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
842
807
 
951
916
    takes_options = ['remember', 'overwrite', 'revision',
952
917
        custom_help('verbose',
953
918
            help='Show logs of pulled revisions.'),
954
 
        Option('directory',
 
919
        custom_help('directory',
955
920
            help='Branch to pull into, '
956
 
                 'rather than the one containing the working directory.',
957
 
            short_name='d',
958
 
            type=unicode,
959
 
            ),
 
921
                 'rather than the one containing the working directory.'),
960
922
        Option('local',
961
923
            help="Perform a local pull in a bound "
962
924
                 "branch.  Local pulls are not applied to "
1076
1038
        Option('create-prefix',
1077
1039
               help='Create the path leading up to the branch '
1078
1040
                    'if it does not already exist.'),
1079
 
        Option('directory',
 
1041
        custom_help('directory',
1080
1042
            help='Branch to push from, '
1081
 
                 'rather than the one containing the working directory.',
1082
 
            short_name='d',
1083
 
            type=unicode,
1084
 
            ),
 
1043
                 'rather than the one containing the working directory.'),
1085
1044
        Option('use-existing-dir',
1086
1045
               help='By default push will fail if the target'
1087
1046
                    ' directory exists, but does not already'
1525
1484
 
1526
1485
    def run(self, file_list, verbose=False, new=False,
1527
1486
        file_deletion_strategy='safe'):
1528
 
        tree, file_list = tree_files(file_list)
 
1487
        tree, file_list = WorkingTree.open_containing_paths(file_list)
1529
1488
 
1530
1489
        if file_list is not None:
1531
1490
            file_list = [f for f in file_list]
1910
1869
    takes_args = ['file*']
1911
1870
    takes_options = [
1912
1871
        Option('diff-options', type=str,
1913
 
               help='Pass these options to the external diff program.'),
 
1872
               help='Pass these options to the diff program.'),
1914
1873
        Option('prefix', type=str,
1915
1874
               short_name='p',
1916
1875
               help='Set prefixes added to old and new filenames, as '
1957
1916
                '--prefix expects two values separated by a colon'
1958
1917
                ' (eg "old/:new/")')
1959
1918
 
 
1919
        if using is not None and diff_options is not None:
 
1920
            raise errors.BzrCommandError(
 
1921
            '--diff-options and --using are mutually exclusive.')
 
1922
 
1960
1923
        if revision and len(revision) > 2:
1961
1924
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1962
1925
                                         ' one or two revision specifiers')
1969
1932
         old_branch, new_branch,
1970
1933
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1971
1934
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1935
        # GNU diff on Windows uses ANSI encoding for filenames
 
1936
        path_encoding = osutils.get_diff_header_encoding()
1972
1937
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1973
1938
                               specific_files=specific_files,
1974
1939
                               external_diff_options=diff_options,
1975
1940
                               old_label=old_label, new_label=new_label,
1976
 
                               extra_trees=extra_trees, using=using,
 
1941
                               extra_trees=extra_trees,
 
1942
                               path_encoding=path_encoding,
 
1943
                               using=using,
1977
1944
                               format_cls=format)
1978
1945
 
1979
1946
 
1987
1954
    # level of effort but possibly much less IO.  (Or possibly not,
1988
1955
    # if the directories are very large...)
1989
1956
    _see_also = ['status', 'ls']
1990
 
    takes_options = ['show-ids']
 
1957
    takes_options = ['directory', 'show-ids']
1991
1958
 
1992
1959
    @display_command
1993
 
    def run(self, show_ids=False):
1994
 
        tree = WorkingTree.open_containing(u'.')[0]
 
1960
    def run(self, show_ids=False, directory=u'.'):
 
1961
        tree = WorkingTree.open_containing(directory)[0]
1995
1962
        self.add_cleanup(tree.lock_read().unlock)
1996
1963
        old = tree.basis_tree()
1997
1964
        self.add_cleanup(old.lock_read().unlock)
2010
1977
 
2011
1978
    hidden = True
2012
1979
    _see_also = ['status', 'ls']
2013
 
    takes_options = [
2014
 
            Option('null',
2015
 
                   help='Write an ascii NUL (\\0) separator '
2016
 
                   'between files rather than a newline.')
2017
 
            ]
 
1980
    takes_options = ['directory', 'null']
2018
1981
 
2019
1982
    @display_command
2020
 
    def run(self, null=False):
2021
 
        tree = WorkingTree.open_containing(u'.')[0]
 
1983
    def run(self, null=False, directory=u'.'):
 
1984
        tree = WorkingTree.open_containing(directory)[0]
2022
1985
        td = tree.changes_from(tree.basis_tree())
2023
1986
        for path, id, kind, text_modified, meta_modified in td.modified:
2024
1987
            if null:
2033
1996
 
2034
1997
    hidden = True
2035
1998
    _see_also = ['status', 'ls']
2036
 
    takes_options = [
2037
 
            Option('null',
2038
 
                   help='Write an ascii NUL (\\0) separator '
2039
 
                   'between files rather than a newline.')
2040
 
            ]
 
1999
    takes_options = ['directory', 'null']
2041
2000
 
2042
2001
    @display_command
2043
 
    def run(self, null=False):
2044
 
        wt = WorkingTree.open_containing(u'.')[0]
 
2002
    def run(self, null=False, directory=u'.'):
 
2003
        wt = WorkingTree.open_containing(directory)[0]
2045
2004
        self.add_cleanup(wt.lock_read().unlock)
2046
2005
        basis = wt.basis_tree()
2047
2006
        self.add_cleanup(basis.lock_read().unlock)
2053
2012
            if inv.is_root(file_id) and len(basis_inv) == 0:
2054
2013
                continue
2055
2014
            path = inv.id2path(file_id)
2056
 
            if not os.access(osutils.abspath(path), os.F_OK):
 
2015
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2057
2016
                continue
2058
2017
            if null:
2059
2018
                self.outf.write(path + '\0')
2259
2218
                   help='Show just the specified revision.'
2260
2219
                   ' See also "help revisionspec".'),
2261
2220
            'log-format',
 
2221
            RegistryOption('authors',
 
2222
                'What names to list as authors - first, all or committer.',
 
2223
                title='Authors',
 
2224
                lazy_registry=('bzrlib.log', 'author_list_registry'),
 
2225
            ),
2262
2226
            Option('levels',
2263
2227
                   short_name='n',
2264
2228
                   help='Number of levels to display - 0 for all, 1 for flat.',
2299
2263
            limit=None,
2300
2264
            show_diff=False,
2301
2265
            include_merges=False,
 
2266
            authors=None,
2302
2267
            exclude_common_ancestry=False,
2303
2268
            ):
2304
2269
        from bzrlib.log import (
2382
2347
                        show_timezone=timezone,
2383
2348
                        delta_format=get_verbosity_level(),
2384
2349
                        levels=levels,
2385
 
                        show_advice=levels is None)
 
2350
                        show_advice=levels is None,
 
2351
                        author_list_handler=authors)
2386
2352
 
2387
2353
        # Choose the algorithm for doing the logging. It's annoying
2388
2354
        # having multiple code paths like this but necessary until
2505
2471
                   help='Recurse into subdirectories.'),
2506
2472
            Option('from-root',
2507
2473
                   help='Print paths relative to the root of the branch.'),
2508
 
            Option('unknown', help='Print unknown files.'),
 
2474
            Option('unknown', short_name='u',
 
2475
                help='Print unknown files.'),
2509
2476
            Option('versioned', help='Print versioned files.',
2510
2477
                   short_name='V'),
2511
 
            Option('ignored', help='Print ignored files.'),
2512
 
            Option('null',
2513
 
                   help='Write an ascii NUL (\\0) separator '
2514
 
                   'between files rather than a newline.'),
2515
 
            Option('kind',
 
2478
            Option('ignored', short_name='i',
 
2479
                help='Print ignored files.'),
 
2480
            Option('kind', short_name='k',
2516
2481
                   help='List entries of a particular kind: file, directory, symlink.',
2517
2482
                   type=unicode),
 
2483
            'null',
2518
2484
            'show-ids',
 
2485
            'directory',
2519
2486
            ]
2520
2487
    @display_command
2521
2488
    def run(self, revision=None, verbose=False,
2522
2489
            recursive=False, from_root=False,
2523
2490
            unknown=False, versioned=False, ignored=False,
2524
 
            null=False, kind=None, show_ids=False, path=None):
 
2491
            null=False, kind=None, show_ids=False, path=None, directory=None):
2525
2492
 
2526
2493
        if kind and kind not in ('file', 'directory', 'symlink'):
2527
2494
            raise errors.BzrCommandError('invalid kind specified')
2539
2506
                raise errors.BzrCommandError('cannot specify both --from-root'
2540
2507
                                             ' and PATH')
2541
2508
            fs_path = path
2542
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2543
 
            fs_path)
 
2509
        tree, branch, relpath = \
 
2510
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
2544
2511
 
2545
2512
        # Calculate the prefix to use
2546
2513
        prefix = None
2614
2581
 
2615
2582
    hidden = True
2616
2583
    _see_also = ['ls']
 
2584
    takes_options = ['directory']
2617
2585
 
2618
2586
    @display_command
2619
 
    def run(self):
2620
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2587
    def run(self, directory=u'.'):
 
2588
        for f in WorkingTree.open_containing(directory)[0].unknowns():
2621
2589
            self.outf.write(osutils.quotefn(f) + '\n')
2622
2590
 
2623
2591
 
2688
2656
 
2689
2657
    _see_also = ['status', 'ignored', 'patterns']
2690
2658
    takes_args = ['name_pattern*']
2691
 
    takes_options = [
 
2659
    takes_options = ['directory',
2692
2660
        Option('default-rules',
2693
2661
               help='Display the default ignore rules that bzr uses.')
2694
2662
        ]
2695
2663
 
2696
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2664
    def run(self, name_pattern_list=None, default_rules=None,
 
2665
            directory=u'.'):
2697
2666
        from bzrlib import ignores
2698
2667
        if default_rules is not None:
2699
2668
            # dump the default rules and exit
2710
2679
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2711
2680
                raise errors.BzrCommandError(
2712
2681
                    "NAME_PATTERN should not be an absolute path")
2713
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
2682
        tree, relpath = WorkingTree.open_containing(directory)
2714
2683
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2715
2684
        ignored = globbing.Globster(name_pattern_list)
2716
2685
        matches = []
2717
 
        tree.lock_read()
 
2686
        self.add_cleanup(tree.lock_read().unlock)
2718
2687
        for entry in tree.list_files():
2719
2688
            id = entry[3]
2720
2689
            if id is not None:
2721
2690
                filename = entry[0]
2722
2691
                if ignored.match(filename):
2723
2692
                    matches.append(filename)
2724
 
        tree.unlock()
2725
2693
        if len(matches) > 0:
2726
2694
            self.outf.write("Warning: the following files are version controlled and"
2727
2695
                  " match your ignore pattern:\n%s"
2742
2710
 
2743
2711
    encoding_type = 'replace'
2744
2712
    _see_also = ['ignore', 'ls']
 
2713
    takes_options = ['directory']
2745
2714
 
2746
2715
    @display_command
2747
 
    def run(self):
2748
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2716
    def run(self, directory=u'.'):
 
2717
        tree = WorkingTree.open_containing(directory)[0]
2749
2718
        self.add_cleanup(tree.lock_read().unlock)
2750
2719
        for path, file_class, kind, file_id, entry in tree.list_files():
2751
2720
            if file_class != 'I':
2763
2732
    """
2764
2733
    hidden = True
2765
2734
    takes_args = ['revno']
 
2735
    takes_options = ['directory']
2766
2736
 
2767
2737
    @display_command
2768
 
    def run(self, revno):
 
2738
    def run(self, revno, directory=u'.'):
2769
2739
        try:
2770
2740
            revno = int(revno)
2771
2741
        except ValueError:
2772
2742
            raise errors.BzrCommandError("not a valid revision-number: %r"
2773
2743
                                         % revno)
2774
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2744
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2775
2745
        self.outf.write("%s\n" % revid)
2776
2746
 
2777
2747
 
2804
2774
      =================       =========================
2805
2775
    """
2806
2776
    takes_args = ['dest', 'branch_or_subdir?']
2807
 
    takes_options = [
 
2777
    takes_options = ['directory',
2808
2778
        Option('format',
2809
2779
               help="Type of file to export to.",
2810
2780
               type=unicode),
2819
2789
                    'revision in which it was changed.'),
2820
2790
        ]
2821
2791
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2822
 
        root=None, filters=False, per_file_timestamps=False):
 
2792
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2823
2793
        from bzrlib.export import export
2824
2794
 
2825
2795
        if branch_or_subdir is None:
2826
 
            tree = WorkingTree.open_containing(u'.')[0]
 
2796
            tree = WorkingTree.open_containing(directory)[0]
2827
2797
            b = tree.branch
2828
2798
            subdir = None
2829
2799
        else:
2848
2818
    """
2849
2819
 
2850
2820
    _see_also = ['ls']
2851
 
    takes_options = [
 
2821
    takes_options = ['directory',
2852
2822
        Option('name-from-revision', help='The path name in the old tree.'),
2853
2823
        Option('filters', help='Apply content filters to display the '
2854
2824
                'convenience form.'),
2859
2829
 
2860
2830
    @display_command
2861
2831
    def run(self, filename, revision=None, name_from_revision=False,
2862
 
            filters=False):
 
2832
            filters=False, directory=None):
2863
2833
        if revision is not None and len(revision) != 1:
2864
2834
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2865
2835
                                         " one revision specifier")
2866
2836
        tree, branch, relpath = \
2867
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2837
            _open_directory_or_containing_tree_or_branch(filename, directory)
2868
2838
        self.add_cleanup(branch.lock_read().unlock)
2869
2839
        return self._run(tree, branch, relpath, filename, revision,
2870
2840
                         name_from_revision, filters)
3101
3071
 
3102
3072
        properties = {}
3103
3073
 
3104
 
        tree, selected_list = tree_files(selected_list)
 
3074
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3105
3075
        if selected_list == ['']:
3106
3076
            # workaround - commit of root of tree should be exactly the same
3107
3077
            # as just default commit in that tree, and succeed even though
3142
3112
        def get_message(commit_obj):
3143
3113
            """Callback to get commit message"""
3144
3114
            if file:
3145
 
                my_message = codecs.open(
3146
 
                    file, 'rt', osutils.get_user_encoding()).read()
 
3115
                f = codecs.open(file, 'rt', osutils.get_user_encoding())
 
3116
                try:
 
3117
                    my_message = f.read()
 
3118
                finally:
 
3119
                    f.close()
3147
3120
            elif message is not None:
3148
3121
                my_message = message
3149
3122
            else:
3178
3151
                        reporter=None, verbose=verbose, revprops=properties,
3179
3152
                        authors=author, timestamp=commit_stamp,
3180
3153
                        timezone=offset,
3181
 
                        exclude=safe_relpath_files(tree, exclude))
 
3154
                        exclude=tree.safe_relpath_files(exclude))
3182
3155
        except PointlessCommit:
3183
3156
            raise errors.BzrCommandError("No changes to commit."
3184
3157
                              " Use --unchanged to commit anyhow.")
3303
3276
 
3304
3277
            bzr whoami "Frank Chu <fchu@example.com>"
3305
3278
    """
3306
 
    takes_options = [ Option('email',
 
3279
    takes_options = [ 'directory',
 
3280
                      Option('email',
3307
3281
                             help='Display email address only.'),
3308
3282
                      Option('branch',
3309
3283
                             help='Set identity for the current branch instead of '
3313
3287
    encoding_type = 'replace'
3314
3288
 
3315
3289
    @display_command
3316
 
    def run(self, email=False, branch=False, name=None):
 
3290
    def run(self, email=False, branch=False, name=None, directory=None):
3317
3291
        if name is None:
3318
 
            # use branch if we're inside one; otherwise global config
3319
 
            try:
3320
 
                c = Branch.open_containing('.')[0].get_config()
3321
 
            except errors.NotBranchError:
3322
 
                c = config.GlobalConfig()
 
3292
            if directory is None:
 
3293
                # use branch if we're inside one; otherwise global config
 
3294
                try:
 
3295
                    c = Branch.open_containing(u'.')[0].get_config()
 
3296
                except errors.NotBranchError:
 
3297
                    c = config.GlobalConfig()
 
3298
            else:
 
3299
                c = Branch.open(directory).get_config()
3323
3300
            if email:
3324
3301
                self.outf.write(c.user_email() + '\n')
3325
3302
            else:
3335
3312
 
3336
3313
        # use global config unless --branch given
3337
3314
        if branch:
3338
 
            c = Branch.open_containing('.')[0].get_config()
 
3315
            if directory is None:
 
3316
                c = Branch.open_containing(u'.')[0].get_config()
 
3317
            else:
 
3318
                c = Branch.open(directory).get_config()
3339
3319
        else:
3340
3320
            c = config.GlobalConfig()
3341
3321
        c.set_user_option('email', name)
3353
3333
 
3354
3334
    _see_also = ['info']
3355
3335
    takes_args = ['nickname?']
3356
 
    def run(self, nickname=None):
3357
 
        branch = Branch.open_containing(u'.')[0]
 
3336
    takes_options = ['directory']
 
3337
    def run(self, nickname=None, directory=u'.'):
 
3338
        branch = Branch.open_containing(directory)[0]
3358
3339
        if nickname is None:
3359
3340
            self.printme(branch)
3360
3341
        else:
3585
3566
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3586
3567
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3587
3568
            # stdout, which would corrupt the subunit stream. 
3588
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
 
3569
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
3570
            # following code can be deleted when it's sufficiently deployed
 
3571
            # -- vila/mgz 20100514
 
3572
            if (sys.platform == "win32"
 
3573
                and getattr(sys.stdout, 'fileno', None) is not None):
3589
3574
                import msvcrt
3590
3575
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3591
3576
        if parallel:
3764
3749
                ' completely merged into the source, pull from the'
3765
3750
                ' source rather than merging.  When this happens,'
3766
3751
                ' you do not need to commit the result.'),
3767
 
        Option('directory',
 
3752
        custom_help('directory',
3768
3753
               help='Branch to merge into, '
3769
 
                    'rather than the one containing the working directory.',
3770
 
               short_name='d',
3771
 
               type=unicode,
3772
 
               ),
 
3754
                    'rather than the one containing the working directory.'),
3773
3755
        Option('preview', help='Instead of merging, show a diff of the'
3774
3756
               ' merge.'),
3775
3757
        Option('interactive', help='Select changes interactively.',
3875
3857
    def _do_preview(self, merger):
3876
3858
        from bzrlib.diff import show_diff_trees
3877
3859
        result_tree = self._get_preview(merger)
 
3860
        path_encoding = osutils.get_diff_header_encoding()
3878
3861
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3879
 
                        old_label='', new_label='')
 
3862
                        old_label='', new_label='',
 
3863
                        path_encoding=path_encoding)
3880
3864
 
3881
3865
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3882
3866
        merger.change_reporter = change_reporter
4069
4053
        from bzrlib.conflicts import restore
4070
4054
        if merge_type is None:
4071
4055
            merge_type = _mod_merge.Merge3Merger
4072
 
        tree, file_list = tree_files(file_list)
 
4056
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4073
4057
        self.add_cleanup(tree.lock_write().unlock)
4074
4058
        parents = tree.get_parent_ids()
4075
4059
        if len(parents) != 2:
4185
4169
 
4186
4170
    def run(self, revision=None, no_backup=False, file_list=None,
4187
4171
            forget_merges=None):
4188
 
        tree, file_list = tree_files(file_list)
 
4172
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4189
4173
        self.add_cleanup(tree.lock_tree_write().unlock)
4190
4174
        if forget_merges:
4191
4175
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4281
4265
    _see_also = ['merge', 'pull']
4282
4266
    takes_args = ['other_branch?']
4283
4267
    takes_options = [
 
4268
        'directory',
4284
4269
        Option('reverse', 'Reverse the order of revisions.'),
4285
4270
        Option('mine-only',
4286
4271
               'Display changes in the local branch only.'),
4308
4293
            theirs_only=False,
4309
4294
            log_format=None, long=False, short=False, line=False,
4310
4295
            show_ids=False, verbose=False, this=False, other=False,
4311
 
            include_merges=False, revision=None, my_revision=None):
 
4296
            include_merges=False, revision=None, my_revision=None,
 
4297
            directory=u'.'):
4312
4298
        from bzrlib.missing import find_unmerged, iter_log_revisions
4313
4299
        def message(s):
4314
4300
            if not is_quiet():
4327
4313
        elif theirs_only:
4328
4314
            restrict = 'remote'
4329
4315
 
4330
 
        local_branch = Branch.open_containing(u".")[0]
 
4316
        local_branch = Branch.open_containing(directory)[0]
4331
4317
        self.add_cleanup(local_branch.lock_read().unlock)
4332
4318
 
4333
4319
        parent = local_branch.get_parent()
4542
4528
                     Option('long', help='Show commit date in annotations.'),
4543
4529
                     'revision',
4544
4530
                     'show-ids',
 
4531
                     'directory',
4545
4532
                     ]
4546
4533
    encoding_type = 'exact'
4547
4534
 
4548
4535
    @display_command
4549
4536
    def run(self, filename, all=False, long=False, revision=None,
4550
 
            show_ids=False):
 
4537
            show_ids=False, directory=None):
4551
4538
        from bzrlib.annotate import annotate_file, annotate_file_tree
4552
4539
        wt, branch, relpath = \
4553
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4540
            _open_directory_or_containing_tree_or_branch(filename, directory)
4554
4541
        if wt is not None:
4555
4542
            self.add_cleanup(wt.lock_read().unlock)
4556
4543
        else:
4580
4567
 
4581
4568
    hidden = True # is this right ?
4582
4569
    takes_args = ['revision_id*']
4583
 
    takes_options = ['revision']
 
4570
    takes_options = ['directory', 'revision']
4584
4571
 
4585
 
    def run(self, revision_id_list=None, revision=None):
 
4572
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
4586
4573
        if revision_id_list is not None and revision is not None:
4587
4574
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4588
4575
        if revision_id_list is None and revision is None:
4589
4576
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4590
 
        b = WorkingTree.open_containing(u'.')[0].branch
 
4577
        b = WorkingTree.open_containing(directory)[0].branch
4591
4578
        self.add_cleanup(b.lock_write().unlock)
4592
4579
        return self._run(b, revision_id_list, revision)
4593
4580
 
4653
4640
 
4654
4641
    _see_also = ['checkouts', 'unbind']
4655
4642
    takes_args = ['location?']
4656
 
    takes_options = []
 
4643
    takes_options = ['directory']
4657
4644
 
4658
 
    def run(self, location=None):
4659
 
        b, relpath = Branch.open_containing(u'.')
 
4645
    def run(self, location=None, directory=u'.'):
 
4646
        b, relpath = Branch.open_containing(directory)
4660
4647
        if location is None:
4661
4648
            try:
4662
4649
                location = b.get_old_bound_location()
4689
4676
 
4690
4677
    _see_also = ['checkouts', 'bind']
4691
4678
    takes_args = []
4692
 
    takes_options = []
 
4679
    takes_options = ['directory']
4693
4680
 
4694
 
    def run(self):
4695
 
        b, relpath = Branch.open_containing(u'.')
 
4681
    def run(self, directory=u'.'):
 
4682
        b, relpath = Branch.open_containing(directory)
4696
4683
        if not b.unbind():
4697
4684
            raise errors.BzrCommandError('Local branch is not bound')
4698
4685
 
4860
4847
                    'result in a dynamically allocated port.  The default port '
4861
4848
                    'depends on the protocol.',
4862
4849
               type=str),
4863
 
        Option('directory',
4864
 
               help='Serve contents of this directory.',
4865
 
               type=unicode),
 
4850
        custom_help('directory',
 
4851
               help='Serve contents of this directory.'),
4866
4852
        Option('allow-writes',
4867
4853
               help='By default the server is a readonly server.  Supplying '
4868
4854
                    '--allow-writes enables write access to the contents of '
4895
4881
 
4896
4882
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4897
4883
            protocol=None):
4898
 
        from bzrlib.transport import get_transport, transport_server_registry
 
4884
        from bzrlib import transport
4899
4885
        if directory is None:
4900
4886
            directory = os.getcwd()
4901
4887
        if protocol is None:
4902
 
            protocol = transport_server_registry.get()
 
4888
            protocol = transport.transport_server_registry.get()
4903
4889
        host, port = self.get_host_and_port(port)
4904
4890
        url = urlutils.local_path_to_url(directory)
4905
4891
        if not allow_writes:
4906
4892
            url = 'readonly+' + url
4907
 
        transport = get_transport(url)
4908
 
        protocol(transport, host, port, inet)
 
4893
        t = transport.get_transport(url)
 
4894
        protocol(t, host, port, inet)
4909
4895
 
4910
4896
 
4911
4897
class cmd_join(Command):
5004
4990
    _see_also = ['send']
5005
4991
 
5006
4992
    takes_options = [
 
4993
        'directory',
5007
4994
        RegistryOption.from_kwargs('patch-type',
5008
4995
            'The type of patch to include in the directive.',
5009
4996
            title='Patch type',
5022
5009
    encoding_type = 'exact'
5023
5010
 
5024
5011
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5025
 
            sign=False, revision=None, mail_to=None, message=None):
 
5012
            sign=False, revision=None, mail_to=None, message=None,
 
5013
            directory=u'.'):
5026
5014
        from bzrlib.revision import ensure_null, NULL_REVISION
5027
5015
        include_patch, include_bundle = {
5028
5016
            'plain': (False, False),
5029
5017
            'diff': (True, False),
5030
5018
            'bundle': (True, True),
5031
5019
            }[patch_type]
5032
 
        branch = Branch.open('.')
 
5020
        branch = Branch.open(directory)
5033
5021
        stored_submit_branch = branch.get_submit_branch()
5034
5022
        if submit_branch is None:
5035
5023
            submit_branch = stored_submit_branch
5120
5108
    given, in which case it is sent to a file.
5121
5109
 
5122
5110
    Mail is sent using your preferred mail program.  This should be transparent
5123
 
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
5111
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
5124
5112
    If the preferred client can't be found (or used), your editor will be used.
5125
5113
 
5126
5114
    To use a specific mail program, set the mail_client configuration option.
5297
5285
        Option('delete',
5298
5286
            help='Delete this tag rather than placing it.',
5299
5287
            ),
5300
 
        Option('directory',
5301
 
            help='Branch in which to place the tag.',
5302
 
            short_name='d',
5303
 
            type=unicode,
5304
 
            ),
 
5288
        custom_help('directory',
 
5289
            help='Branch in which to place the tag.'),
5305
5290
        Option('force',
5306
5291
            help='Replace existing tags.',
5307
5292
            ),
5349
5334
 
5350
5335
    _see_also = ['tag']
5351
5336
    takes_options = [
5352
 
        Option('directory',
5353
 
            help='Branch whose tags should be displayed.',
5354
 
            short_name='d',
5355
 
            type=unicode,
5356
 
            ),
 
5337
        custom_help('directory',
 
5338
            help='Branch whose tags should be displayed.'),
5357
5339
        RegistryOption.from_kwargs('sort',
5358
5340
            'Sort tags by different criteria.', title='Sorting',
5359
5341
            alpha='Sort tags lexicographically (default).',
5529
5511
    """
5530
5512
 
5531
5513
    takes_args = ['to_location?']
5532
 
    takes_options = [Option('force',
 
5514
    takes_options = ['directory',
 
5515
                     Option('force',
5533
5516
                        help='Switch even if local commits will be lost.'),
5534
5517
                     'revision',
5535
5518
                     Option('create-branch', short_name='b',
5538
5521
                    ]
5539
5522
 
5540
5523
    def run(self, to_location=None, force=False, create_branch=False,
5541
 
            revision=None):
 
5524
            revision=None, directory=u'.'):
5542
5525
        from bzrlib import switch
5543
 
        tree_location = '.'
 
5526
        tree_location = directory
5544
5527
        revision = _get_one_revision('switch', revision)
5545
5528
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5546
5529
        if to_location is None:
5547
5530
            if revision is None:
5548
5531
                raise errors.BzrCommandError('You must supply either a'
5549
5532
                                             ' revision or a location')
5550
 
            to_location = '.'
 
5533
            to_location = tree_location
5551
5534
        try:
5552
5535
            branch = control_dir.open_branch()
5553
5536
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5688
5671
            name=None,
5689
5672
            switch=None,
5690
5673
            ):
5691
 
        tree, file_list = tree_files(file_list, apply_view=False)
 
5674
        tree, file_list = WorkingTree.open_containing_paths(file_list,
 
5675
            apply_view=False)
5692
5676
        current_view, view_dict = tree.views.get_view_info()
5693
5677
        if name is None:
5694
5678
            name = current_view
5828
5812
    takes_args = ['file*']
5829
5813
 
5830
5814
    takes_options = [
 
5815
        'directory',
5831
5816
        'revision',
5832
5817
        Option('all', help='Shelve all changes.'),
5833
5818
        'message',
5842
5827
    _see_also = ['unshelve']
5843
5828
 
5844
5829
    def run(self, revision=None, all=False, file_list=None, message=None,
5845
 
            writer=None, list=False, destroy=False):
 
5830
            writer=None, list=False, destroy=False, directory=u'.'):
5846
5831
        if list:
5847
5832
            return self.run_for_list()
5848
5833
        from bzrlib.shelf_ui import Shelver
5850
5835
            writer = bzrlib.option.diff_writer_registry.get()
5851
5836
        try:
5852
5837
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5853
 
                file_list, message, destroy=destroy)
 
5838
                file_list, message, destroy=destroy, directory=directory)
5854
5839
            try:
5855
5840
                shelver.run()
5856
5841
            finally:
5884
5869
 
5885
5870
    takes_args = ['shelf_id?']
5886
5871
    takes_options = [
 
5872
        'directory',
5887
5873
        RegistryOption.from_kwargs(
5888
5874
            'action', help="The action to perform.",
5889
5875
            enum_switch=False, value_switches=True,
5897
5883
    ]
5898
5884
    _see_also = ['shelve']
5899
5885
 
5900
 
    def run(self, shelf_id=None, action='apply'):
 
5886
    def run(self, shelf_id=None, action='apply', directory=u'.'):
5901
5887
        from bzrlib.shelf_ui import Unshelver
5902
 
        unshelver = Unshelver.from_args(shelf_id, action)
 
5888
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5903
5889
        try:
5904
5890
            unshelver.run()
5905
5891
        finally:
5921
5907
 
5922
5908
    To check what clean-tree will do, use --dry-run.
5923
5909
    """
5924
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5910
    takes_options = ['directory',
 
5911
                     Option('ignored', help='Delete all ignored files.'),
5925
5912
                     Option('detritus', help='Delete conflict files, merge'
5926
5913
                            ' backups, and failed selftest dirs.'),
5927
5914
                     Option('unknown',
5930
5917
                            ' deleting them.'),
5931
5918
                     Option('force', help='Do not prompt before deleting.')]
5932
5919
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5933
 
            force=False):
 
5920
            force=False, directory=u'.'):
5934
5921
        from bzrlib.clean_tree import clean_tree
5935
5922
        if not (unknown or ignored or detritus):
5936
5923
            unknown = True
5937
5924
        if dry_run:
5938
5925
            force = True
5939
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5940
 
                   dry_run=dry_run, no_prompt=force)
 
5926
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
5927
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
5941
5928
 
5942
5929
 
5943
5930
class cmd_reference(Command):