~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-01-03 07:39:47 UTC
  • mfrom: (2215.5.1 bzr_man.rstx)
  • Revision ID: pqm@pqm.ubuntu.com-20070103073947-f9906c0b1f425aa9
(bialix) Fix generation of rstx man page

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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
 
16
 
 
17
import sys
 
18
 
 
19
from bzrlib.diff import _raise_if_nonexistent
 
20
import bzrlib.errors as errors
 
21
from bzrlib.log import line_log
 
22
from bzrlib.osutils import is_inside_any
 
23
from bzrlib.symbol_versioning import (deprecated_function,
 
24
        zero_eight,
 
25
        )
 
26
from bzrlib.trace import warning
 
27
 
 
28
# TODO: when showing single-line logs, truncate to the width of the terminal
 
29
# if known, but only if really going to the terminal (not into a file)
 
30
 
 
31
 
 
32
@deprecated_function(zero_eight)
 
33
def show_status(branch, show_unchanged=None,
 
34
                specific_files=None,
 
35
                show_ids=False,
 
36
                to_file=None,
 
37
                show_pending=True,
 
38
                revision=None):
 
39
    """Display summary of changes.
 
40
 
 
41
    Please use show_tree_status instead.
 
42
 
 
43
    By default this compares the working tree to a previous revision. 
 
44
    If the revision argument is given, summarizes changes between the 
 
45
    working tree and another, or between two revisions.
 
46
 
 
47
    The result is written out as Unicode and to_file should be able 
 
48
    to encode that.
 
49
 
 
50
    show_unchanged
 
51
        If set, includes unchanged files.
 
52
 
 
53
    specific_files
 
54
        If set, only show the status of files in this list.
 
55
 
 
56
    show_ids
 
57
        If set, includes each file's id.
 
58
 
 
59
    to_file
 
60
        If set, write to this file (default stdout.)
 
61
 
 
62
    show_pending
 
63
        If set, write pending merges.
 
64
 
 
65
    revision
 
66
        If None the compare latest revision with working tree
 
67
        If one revision show compared it with working tree.
 
68
        If two revisions show status between first and second.
 
69
    """
 
70
    show_tree_status(branch.bzrdir.open_workingtree(), show_unchanged, 
 
71
                     specific_files, show_ids, to_file, show_pending, revision)
 
72
 
 
73
 
 
74
def show_tree_status(wt, show_unchanged=None,
 
75
                     specific_files=None,
 
76
                     show_ids=False,
 
77
                     to_file=None,
 
78
                     show_pending=True,
 
79
                     revision=None,
 
80
                     short=False):
 
81
    """Display summary of changes.
 
82
 
 
83
    By default this compares the working tree to a previous revision. 
 
84
    If the revision argument is given, summarizes changes between the 
 
85
    working tree and another, or between two revisions.
 
86
 
 
87
    The result is written out as Unicode and to_file should be able 
 
88
    to encode that.
 
89
 
 
90
    If showing the status of a working tree, extra information is included
 
91
    about unknown files, conflicts, and pending merges.
 
92
 
 
93
    :param show_unchanged: Deprecated parameter. If set, includes unchanged 
 
94
        files.
 
95
    :param specific_files: If set, a list of filenames whose status should be
 
96
        shown.  It is an error to give a filename that is not in the working 
 
97
        tree, or in the working inventory or in the basis inventory.
 
98
    :param show_ids: If set, includes each file's id.
 
99
    :param to_file: If set, write to this file (default stdout.)
 
100
    :param show_pending: If set, write pending merges.
 
101
    :param revision: If None the compare latest revision with working tree
 
102
        If not None it must be a RevisionSpec list.
 
103
        If one revision show compared it with working tree.
 
104
        If two revisions show status between first and second.
 
105
    :param short: If True, gives short SVN-style status lines
 
106
    """
 
107
    if show_unchanged is not None:
 
108
        warn("show_status_trees with show_unchanged has been deprecated "
 
109
             "since bzrlib 0.9", DeprecationWarning, stacklevel=2)
 
110
 
 
111
    if to_file is None:
 
112
        to_file = sys.stdout
 
113
    
 
114
    wt.lock_read()
 
115
    try:
 
116
        new_is_working_tree = True
 
117
        if revision is None:
 
118
            if wt.last_revision() != wt.branch.last_revision():
 
119
                warning("working tree is out of date, run 'bzr update'")
 
120
            new = wt
 
121
            old = new.basis_tree()
 
122
        elif len(revision) > 0:
 
123
            try:
 
124
                rev_id = revision[0].in_history(wt.branch).rev_id
 
125
                old = wt.branch.repository.revision_tree(rev_id)
 
126
            except errors.NoSuchRevision, e:
 
127
                raise errors.BzrCommandError(str(e))
 
128
            if (len(revision) > 1) and (revision[1].spec is not None):
 
129
                try:
 
130
                    rev_id = revision[1].in_history(wt.branch).rev_id
 
131
                    new = wt.branch.repository.revision_tree(rev_id)
 
132
                    new_is_working_tree = False
 
133
                except errors.NoSuchRevision, e:
 
134
                    raise errors.BzrCommandError(str(e))
 
135
            else:
 
136
                new = wt
 
137
        _raise_if_nonexistent(specific_files, old, new)
 
138
        delta = new.changes_from(old, want_unchanged=show_unchanged,
 
139
                              specific_files=specific_files)
 
140
        delta.show(to_file,
 
141
                   show_ids=show_ids,
 
142
                   show_unchanged=show_unchanged,
 
143
                   short_status=short)
 
144
        short_status_letter = '?'
 
145
        if not short:
 
146
            short_status_letter = ''
 
147
        list_paths('unknown', new.unknowns(), specific_files, to_file,
 
148
                   short_status_letter)
 
149
        conflict_title = False
 
150
        # show the new conflicts only for now. XXX: get them from the delta.
 
151
        for conflict in new.conflicts():
 
152
            if not short and conflict_title is False:
 
153
                print >> to_file, "conflicts:"
 
154
                conflict_title = True
 
155
            if short:
 
156
                prefix = 'C '
 
157
            else:
 
158
                prefix = ' '
 
159
            print >> to_file, "%s %s" % (prefix, conflict)
 
160
        if new_is_working_tree and show_pending:
 
161
            show_pending_merges(new, to_file, short)
 
162
    finally:
 
163
        wt.unlock()
 
164
 
 
165
def show_pending_merges(new, to_file, short=False):
 
166
    """Write out a display of pending merges in a working tree."""
 
167
    parents = new.get_parent_ids()
 
168
    if len(parents) < 2:
 
169
        return
 
170
    pending = parents[1:]
 
171
    branch = new.branch
 
172
    last_revision = parents[0]
 
173
    if not short:
 
174
        print >>to_file, 'pending merges:'
 
175
    if last_revision is not None:
 
176
        try:
 
177
            ignore = set(branch.repository.get_ancestry(last_revision))
 
178
        except errors.NoSuchRevision:
 
179
            # the last revision is a ghost : assume everything is new 
 
180
            # except for it
 
181
            ignore = set([None, last_revision])
 
182
    else:
 
183
        ignore = set([None])
 
184
    # TODO: this could be improved using merge_sorted - we'd get the same 
 
185
    # output rather than one level of indent.
 
186
    for merge in pending:
 
187
        ignore.add(merge)
 
188
        try:
 
189
            from bzrlib.osutils import terminal_width
 
190
            width = terminal_width()
 
191
            m_revision = branch.repository.get_revision(merge)
 
192
            if short:
 
193
                prefix = 'P '
 
194
            else:
 
195
                prefix = ' '
 
196
            print >> to_file, prefix, line_log(m_revision, width - 4)
 
197
            inner_merges = branch.repository.get_ancestry(merge)
 
198
            assert inner_merges[0] is None
 
199
            inner_merges.pop(0)
 
200
            inner_merges.reverse()
 
201
            for mmerge in inner_merges:
 
202
                if mmerge in ignore:
 
203
                    continue
 
204
                mm_revision = branch.repository.get_revision(mmerge)
 
205
                if short:
 
206
                    prefix = 'P. '
 
207
                else:
 
208
                    prefix = '   '
 
209
                print >> to_file, prefix, line_log(mm_revision, width - 5)
 
210
                ignore.add(mmerge)
 
211
        except errors.NoSuchRevision:
 
212
            if short:
 
213
                prefix = 'P '
 
214
            else:
 
215
                prefix = ' '
 
216
            print >> to_file, prefix, merge
 
217
        
 
218
def list_paths(header, paths, specific_files, to_file, short_status_letter=''):
 
219
    done_header = False
 
220
    for path in paths:
 
221
        if specific_files and not is_inside_any(specific_files, path):
 
222
            continue
 
223
        if not short_status_letter and not done_header:
 
224
            print >>to_file, '%s:' % header
 
225
            done_header = True
 
226
        print >>to_file, '%s  %s' % (short_status_letter, path)