← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/cmd_version_info.py

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/cmd_version_info.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Commands for generating snapshot information about a bzr tree."""
18
18
 
19
 
from __future__ import absolute_import
20
 
 
21
19
from bzrlib.lazy_import import lazy_import
22
 
 
23
20
lazy_import(globals(), """
24
21
from bzrlib import (
25
22
    branch,
27
24
    version_info_formats,
28
25
    workingtree,
29
26
    )
30
 
from bzrlib.i18n import gettext
31
27
""")
32
 
 
33
28
from bzrlib.commands import Command
34
 
from bzrlib.option import Option, RegistryOption
 
29
from bzrlib.option import Option
35
30
 
36
31
 
37
32
def _parse_version_info_format(format):
44
39
        return version_info_formats.get_builder(format)
45
40
    except KeyError:
46
41
        formats = version_info_formats.get_builder_formats()
47
 
        raise errors.BzrCommandError(gettext('No known version info format {0}.'
48
 
                                     ' Supported types are: {1}').format(
49
 
                                     format, formats))
 
42
        raise errors.BzrCommandError('No known version info format %s.'
 
43
                                     ' Supported types are: %s'
 
44
                                     % (format, formats))
50
45
 
51
46
 
52
47
class cmd_version_info(Command):
53
 
    __doc__ = """Show version information about this tree.
54
 
 
55
 
    You can use this command to add information about version into
56
 
    source code of an application. The output can be in one of the
57
 
    supported formats or in a custom format based on a template.
58
 
 
59
 
    For example::
60
 
 
61
 
      bzr version-info --custom \\
62
 
        --template="#define VERSION_INFO \\"Project 1.2.3 (r{revno})\\"\\n"
63
 
 
64
 
    will produce a C header file with formatted string containing the
65
 
    current revision number. Other supported variables in templates are:
66
 
 
67
 
      * {date} - date of the last revision
68
 
      * {build_date} - current date
69
 
      * {revno} - revision number
70
 
      * {revision_id} - revision id
71
 
      * {branch_nick} - branch nickname
72
 
      * {clean} - 0 if the source tree contains uncommitted changes,
73
 
                  otherwise 1
74
 
    """
75
 
 
76
 
    takes_options = [RegistryOption('format',
77
 
                            'Select the output format.',
78
 
                            value_switches=True,
79
 
                            lazy_registry=('bzrlib.version_info_formats',
80
 
                                           'format_registry')),
 
48
    """Show version information about this tree."""
 
49
 
 
50
    takes_options = [Option('format', type=_parse_version_info_format,
 
51
                            help='Select the output format.'),
81
52
                     Option('all', help='Include all possible information.'),
82
53
                     Option('check-clean', help='Check if tree is clean.'),
83
54
                     Option('include-history',
84
55
                            help='Include the revision-history.'),
85
56
                     Option('include-file-revisions',
86
 
                            help='Include the last revision for each file.'),
87
 
                     Option('template', type=str, help='Template for the output.'),
88
 
                     'revision',
 
57
                            help='Include the last revision for each file.')
89
58
                     ]
90
59
    takes_args = ['location?']
91
60
 
93
62
 
94
63
    def run(self, location=None, format=None,
95
64
            all=False, check_clean=False, include_history=False,
96
 
            include_file_revisions=False, template=None,
97
 
            revision=None):
98
 
 
99
 
        if revision and len(revision) > 1:
100
 
            raise errors.BzrCommandError(
101
 
                gettext('bzr version-info --revision takes exactly'
102
 
                        ' one revision specifier'))
 
65
            include_file_revisions=False):
103
66
 
104
67
        if location is None:
105
68
            location = '.'
106
69
 
107
70
        if format is None:
108
 
            format = version_info_formats.format_registry.get()
 
71
            format = version_info_formats.get_builder(None)
109
72
 
 
73
        wt = None
110
74
        try:
111
75
            wt = workingtree.WorkingTree.open_containing(location)[0]
112
76
        except errors.NoWorkingTree:
113
77
            b = branch.Branch.open(location)
114
 
            wt = None
115
78
        else:
116
79
            b = wt.branch
117
80
 
118
81
        if all:
119
82
            include_history = True
120
83
            check_clean = True
121
 
            include_file_revisions = True
122
 
        if template:
123
 
            include_history = True
124
 
            include_file_revisions = True
125
 
            if '{clean}' in template:
126
 
                check_clean = True
127
 
 
128
 
        if revision is not None:
129
 
            revision_id = revision[0].as_revision_id(b)
130
 
        else:
131
 
            revision_id = None
 
84
            include_file_revisions=True
132
85
 
133
86
        builder = format(b, working_tree=wt,
134
87
                check_for_clean=check_clean,
135
88
                include_revision_history=include_history,
136
 
                include_file_revisions=include_file_revisions,
137
 
                template=template, revision_id=revision_id)
 
89
                include_file_revisions=include_file_revisions)
138
90
        builder.generate(self.outf)