1
# Copyright (C) 2005-2010 Canonical Ltd
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Commands for generating snapshot information about a bzr tree."""
19
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
31
from bzrlib.commands import Command
32
from bzrlib.option import Option, RegistryOption
35
def _parse_version_info_format(format):
36
"""Convert a string passed by the user into a VersionInfoFormat.
38
This looks in the version info format registry, and if the format
39
cannot be found, generates a useful error exception.
42
return version_info_formats.get_builder(format)
44
formats = version_info_formats.get_builder_formats()
45
raise errors.BzrCommandError('No known version info format %s.'
46
' Supported types are: %s'
50
class cmd_version_info(Command):
51
__doc__ = """Show version information about this tree.
53
You can use this command to add information about version into
54
source code of an application. The output can be in one of the
55
supported formats or in a custom format based on a template.
59
bzr version-info --custom \\
60
--template="#define VERSION_INFO \\"Project 1.2.3 (r{revno})\\"\\n"
62
will produce a C header file with formatted string containing the
63
current revision number. Other supported variables in templates are:
65
* {date} - date of the last revision
66
* {build_date} - current date
67
* {revno} - revision number
68
* {revision_id} - revision id
69
* {branch_nick} - branch nickname
70
* {clean} - 0 if the source tree contains uncommitted changes,
74
takes_options = [RegistryOption('format',
75
'Select the output format.',
77
lazy_registry=('bzrlib.version_info_formats',
79
Option('all', help='Include all possible information.'),
80
Option('check-clean', help='Check if tree is clean.'),
81
Option('include-history',
82
help='Include the revision-history.'),
83
Option('include-file-revisions',
84
help='Include the last revision for each file.'),
85
Option('template', type=str, help='Template for the output.'),
87
takes_args = ['location?']
89
encoding_type = 'exact'
91
def run(self, location=None, format=None,
92
all=False, check_clean=False, include_history=False,
93
include_file_revisions=False, template=None):
99
format = version_info_formats.format_registry.get()
103
wt = workingtree.WorkingTree.open_containing(location)[0]
104
except errors.NoWorkingTree:
105
b = branch.Branch.open(location)
110
include_history = True
112
include_file_revisions=True
114
builder = format(b, working_tree=wt,
115
check_for_clean=check_clean,
116
include_revision_history=include_history,
117
include_file_revisions=include_file_revisions,
119
builder.generate(self.outf)