← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

Added more docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/status.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# (C) 2005 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
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
import sys
18
 
 
 
18
from bzrlib.osutils import is_inside_any
19
19
from bzrlib.delta import compare_trees
20
 
from bzrlib.diff import _raise_if_nonexistent
 
20
from bzrlib.log import line_log
21
21
from bzrlib.errors import NoSuchRevision
22
 
from bzrlib.log import line_log
23
 
from bzrlib.osutils import is_inside_any
24
 
from bzrlib.symbol_versioning import *
25
22
 
26
23
# TODO: when showing single-line logs, truncate to the width of the terminal
27
24
# if known, but only if really going to the terminal (not into a file)
28
25
 
29
26
 
30
 
@deprecated_function(zero_eight)
31
27
def show_status(branch, show_unchanged=False,
32
28
                specific_files=None,
33
29
                show_ids=False,
36
32
                revision=None):
37
33
    """Display summary of changes.
38
34
 
39
 
    Please use show_tree_status instead.
40
 
 
41
35
    By default this compares the working tree to a previous revision. 
42
36
    If the revision argument is given, summarizes changes between the 
43
37
    working tree and another, or between two revisions.
65
59
        If one revision show compared it with working tree.
66
60
        If two revisions show status between first and second.
67
61
    """
68
 
    show_tree_status(branch.bzrdir.open_workingtree(), show_unchanged, 
69
 
                     specific_files, show_ids, to_file, show_pending, revision)
70
 
 
71
 
 
72
 
def show_tree_status(wt, show_unchanged=False,
73
 
                     specific_files=None,
74
 
                     show_ids=False,
75
 
                     to_file=None,
76
 
                     show_pending=True,
77
 
                     revision=None):
78
 
    """Display summary of changes.
79
 
 
80
 
    By default this compares the working tree to a previous revision. 
81
 
    If the revision argument is given, summarizes changes between the 
82
 
    working tree and another, or between two revisions.
83
 
 
84
 
    The result is written out as Unicode and to_file should be able 
85
 
    to encode that.
86
 
 
87
 
    If showing the status of a working tree, extra information is included
88
 
    about unknown files, conflicts, and pending merges.
89
 
 
90
 
    show_unchanged
91
 
        If set, includes unchanged files.
92
 
 
93
 
    specific_files
94
 
        If set, a list of filenames whose status should be shown.
95
 
        It is an error to give a filename that is not in the working 
96
 
        tree, or in the working inventory or in the basis inventory.
97
 
 
98
 
    show_ids
99
 
        If set, includes each file's id.
100
 
 
101
 
    to_file
102
 
        If set, write to this file (default stdout.)
103
 
 
104
 
    show_pending
105
 
        If set, write pending merges.
106
 
 
107
 
    revision
108
 
        If None the compare latest revision with working tree
109
 
        If one revision show compared it with working tree.
110
 
        If two revisions show status between first and second.
111
 
    """
112
62
    if to_file == None:
113
63
        to_file = sys.stdout
114
64
    
115
 
    wt.lock_read()
 
65
    branch.lock_read()
116
66
    try:
117
67
        new_is_working_tree = True
118
68
        if revision is None:
119
 
            new = wt
120
 
            old = new.basis_tree()
 
69
            old = branch.basis_tree()
 
70
            new = branch.working_tree()
121
71
        elif len(revision) > 0:
122
72
            try:
123
 
                rev_id = revision[0].in_history(wt.branch).rev_id
124
 
                old = wt.branch.repository.revision_tree(rev_id)
 
73
                rev_id = revision[0].in_history(branch).rev_id
 
74
                old = branch.repository.revision_tree(rev_id)
125
75
            except NoSuchRevision, e:
126
76
                raise BzrCommandError(str(e))
127
 
            if (len(revision) > 1) and (revision[1].spec is not None):
 
77
            if len(revision) > 1:
128
78
                try:
129
 
                    rev_id = revision[1].in_history(wt.branch).rev_id
130
 
                    new = wt.branch.repository.revision_tree(rev_id)
 
79
                    rev_id = revision[1].in_history(branch).rev_id
 
80
                    new = branch.repository.revision_tree(rev_id)
131
81
                    new_is_working_tree = False
132
82
                except NoSuchRevision, e:
133
83
                    raise BzrCommandError(str(e))
134
84
            else:
135
 
                new = wt
136
 
        _raise_if_nonexistent(specific_files, old, new)
 
85
                new = branch.working_tree()
 
86
                
 
87
 
137
88
        delta = compare_trees(old, new, want_unchanged=show_unchanged,
138
89
                              specific_files=specific_files)
 
90
 
139
91
        delta.show(to_file,
140
92
                   show_ids=show_ids,
141
93
                   show_unchanged=show_unchanged)
142
94
 
143
95
        if new_is_working_tree:
144
96
            list_paths('unknown', new.unknowns(), specific_files, to_file)
145
 
            conflict_title = False
146
 
            for conflict in wt.conflicts():
147
 
                if conflict_title is False:
148
 
                    print >> to_file, "conflicts:"
149
 
                    conflict_title = True
150
 
                print >> to_file, "  %s" % conflict
 
97
            list_paths('conflicts', new.iter_conflicts(), specific_files, to_file)
151
98
        if new_is_working_tree and show_pending:
152
99
            show_pending_merges(new, to_file)
153
100
    finally:
154
 
        wt.unlock()
 
101
        branch.unlock()
155
102
 
156
103
def show_pending_merges(new, to_file):
157
104
    """Write out a display of pending merges in a working tree."""
164
111
    if last_revision is not None:
165
112
        ignore = set(branch.repository.get_ancestry(last_revision))
166
113
    else:
167
 
        ignore = set([None])
 
114
        ignore = set()
168
115
    for merge in new.pending_merges():
169
116
        ignore.add(merge)
170
117
        try:
171
118
            m_revision = branch.repository.get_revision(merge)
172
119
            print >> to_file, ' ', line_log(m_revision, 77)
173
120
            inner_merges = branch.repository.get_ancestry(merge)
174
 
            assert inner_merges[0] == None
175
 
            inner_merges.pop(0)
176
121
            inner_merges.reverse()
177
122
            for mmerge in inner_merges:
178
123
                if mmerge in ignore: