← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/cmd_version_info.py

  • Committer: Martin Pool
  • Date: 2007-04-04 06:17:31 UTC
  • mto: This revision was merged to the branch mainline in revision 2397.
  • Revision ID: mbp@sourcefrog.net-20070404061731-tt2xrzllqhbodn83
Contents of TODO file moved into bug tracker

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/cmd_version_info.py
21
21
from bzrlib import (
22
22
    branch,
23
23
    errors,
 
24
    version_info_formats,
24
25
    workingtree,
25
 
    version_info_formats,
26
26
    )
27
27
""")
28
28
from bzrlib.commands import Command
29
 
from bzrlib.option import Option, RegistryOption
 
29
from bzrlib.option import Option
30
30
 
31
31
 
32
32
def _parse_version_info_format(format):
45
45
 
46
46
 
47
47
class cmd_version_info(Command):
48
 
    """Show version information about this tree.
49
 
 
50
 
    You can use this command to add information about version into
51
 
    source code of an application. The output can be in one of the
52
 
    supported formats or in a custom format based on a template.
53
 
 
54
 
    For example::
55
 
 
56
 
      bzr version-info --custom \\
57
 
        --template="#define VERSION_INFO \\"Project 1.2.3 (r{revno})\\"\\n"
58
 
 
59
 
    will produce a C header file with formatted string containing the
60
 
    current revision number. Other supported variables in templates are:
61
 
 
62
 
      * {date} - date of the last revision
63
 
      * {build_date} - current date
64
 
      * {revno} - revision number
65
 
      * {revision_id} - revision id
66
 
      * {branch_nick} - branch nickname
67
 
      * {clean} - 0 if the source tree contains uncommitted changes,
68
 
                  otherwise 1
69
 
    """
70
 
 
71
 
    takes_options = [RegistryOption('format',
72
 
                            'Select the output format.',
73
 
                            value_switches=True,
74
 
                            lazy_registry=('bzrlib.version_info_formats',
75
 
                                           'format_registry')),
76
 
                     Option('all', help='Include all possible information.'),
77
 
                     Option('check-clean', help='Check if tree is clean.'),
 
48
    """Show version information about this tree."""
 
49
 
 
50
    takes_options = [Option('format', type=_parse_version_info_format,
 
51
                            help='Select the output format'),
 
52
                     Option('all', help='include all possible information'),
 
53
                     Option('check-clean', help='check if tree is clean'),
78
54
                     Option('include-history',
79
 
                            help='Include the revision-history.'),
 
55
                            help='Include the revision-history'),
80
56
                     Option('include-file-revisions',
81
 
                            help='Include the last revision for each file.'),
82
 
                     Option('template', type=str, help='Template for the output.'),
 
57
                            help='Include the last revision for each file')
83
58
                     ]
84
59
    takes_args = ['location?']
85
60
 
87
62
 
88
63
    def run(self, location=None, format=None,
89
64
            all=False, check_clean=False, include_history=False,
90
 
            include_file_revisions=False, template=None):
 
65
            include_file_revisions=False):
91
66
 
92
67
        if location is None:
93
68
            location = '.'
94
69
 
95
70
        if format is None:
96
 
            format = version_info_formats.format_registry.get()
 
71
            format = version_info_formats.get_builder(None)
97
72
 
98
73
        wt = None
99
74
        try:
103
78
        else:
104
79
            b = wt.branch
105
80
 
106
 
        if all or template:
 
81
        if all:
107
82
            include_history = True
108
83
            check_clean = True
109
84
            include_file_revisions=True
111
86
        builder = format(b, working_tree=wt,
112
87
                check_for_clean=check_clean,
113
88
                include_revision_history=include_history,
114
 
                include_file_revisions=include_file_revisions,
115
 
                template=template)
 
89
                include_file_revisions=include_file_revisions)
116
90
        builder.generate(self.outf)