~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: Arnaud Jeansen
  • Date: 2010-03-20 00:07:45 UTC
  • mto: This revision was merged to the branch mainline in revision 5126.
  • Revision ID: arnaud.jeansen@gmail.com-20100320000745-0qz6ivuimj9f6waf
Add signature comments to report_changes in status.py

Show diffs side-by-side

added added

removed removed

Lines of Context:
38
38
                   show_short_reporter, show_long_callback, 
39
39
                   short=False, want_unchanged=False, 
40
40
                   want_unversioned=False, show_ids=False):
41
 
    #TODO document sig
 
41
    """Display summary of changes.
 
42
 
 
43
    This compares two trees with regards to a list of files, and delegates 
 
44
    the display to underlying elements.
 
45
 
 
46
    For short output, it creates an iterator on all changes, and lets a given
 
47
    reporter display these changes.
 
48
 
 
49
    For stantard output, it creates a delta of the changes, and forwards it
 
50
    to a callback
 
51
 
 
52
    :param to_file: If set, write to this file (default stdout.)
 
53
    :param old: Start tree for the comparison
 
54
    :param end: End tree for the comparison
 
55
    :param specific_files: If set, a list of filenames whose status should be
 
56
        shown.  It is an error to give a filename that is not in the working
 
57
        tree, or in the working inventory or in the basis inventory.
 
58
    :param show_short_reporter: Reporter in charge of display for short output
 
59
    :param show_long_callback: Callback in charge of display for normal output
 
60
    :param short: If True, gives short SVN-style status lines.
 
61
    :param want_unchanged: Deprecated parameter. If set, includes unchanged
 
62
        files.
 
63
    :param show_ids: If set, includes each file's id.
 
64
    :param want_unversioned: If False, only shows versioned files.
 
65
    """
42
66
 
43
67
    if short:
44
68
        changes = new.iter_changes(old, want_unchanged, specific_files,