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