~bzr-pqm/bzr/bzr.dev

4763.2.4 by John Arbash Meinel
merge bzr.2.1 in preparation for NEWS entry.
1
# Copyright (C) 2005-2010 Canonical Ltd
0.8.21 by John Arbash Meinel
Splitting up the version info code into a lazy factory style.
2
#
0.8.1 by John Arbash Meinel
Creating a plugin to ease generating version information from a tree.
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.
0.8.21 by John Arbash Meinel
Splitting up the version info code into a lazy factory style.
7
#
0.8.1 by John Arbash Meinel
Creating a plugin to ease generating version information from a tree.
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.
0.8.21 by John Arbash Meinel
Splitting up the version info code into a lazy factory style.
12
#
0.8.1 by John Arbash Meinel
Creating a plugin to ease generating version information from a tree.
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
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
0.8.1 by John Arbash Meinel
Creating a plugin to ease generating version information from a tree.
16
2022.1.1 by John Arbash Meinel
[merge] version-info plugin, and cleanup for layout in bzr
17
"""Commands for generating snapshot information about a bzr tree."""
0.8.1 by John Arbash Meinel
Creating a plugin to ease generating version information from a tree.
18
1996.3.26 by John Arbash Meinel
Make cmd_version_info.py lazy import most other modules
19
from bzrlib.lazy_import import lazy_import
4792.8.4 by Martin Pool
Convert version-info to use TextUIOutputStream
20
1996.3.26 by John Arbash Meinel
Make cmd_version_info.py lazy import most other modules
21
lazy_import(globals(), """
2022.1.1 by John Arbash Meinel
[merge] version-info plugin, and cleanup for layout in bzr
22
from bzrlib import (
2022.1.3 by John Arbash Meinel
Remove unused imports
23
    branch,
2030.1.4 by John Arbash Meinel
Add a test that we can find the version info when we only have a branch
24
    errors,
4792.8.4 by Martin Pool
Convert version-info to use TextUIOutputStream
25
    ui,
26
    version_info_formats,
2022.1.3 by John Arbash Meinel
Remove unused imports
27
    workingtree,
2022.1.1 by John Arbash Meinel
[merge] version-info plugin, and cleanup for layout in bzr
28
    )
1996.3.26 by John Arbash Meinel
Make cmd_version_info.py lazy import most other modules
29
""")
4792.8.4 by Martin Pool
Convert version-info to use TextUIOutputStream
30
2022.1.1 by John Arbash Meinel
[merge] version-info plugin, and cleanup for layout in bzr
31
from bzrlib.commands import Command
2948.4.2 by Lukáš Lalinský
Use registry for the list of formats. Documentation.
32
from bzrlib.option import Option, RegistryOption
0.8.2 by John Arbash Meinel
Have working rio output
33
34
35
def _parse_version_info_format(format):
2022.1.4 by John Arbash Meinel
test feedback from Robert.
36
    """Convert a string passed by the user into a VersionInfoFormat.
37
38
    This looks in the version info format registry, and if the format
39
    cannot be found, generates a useful error exception.
40
    """
0.8.2 by John Arbash Meinel
Have working rio output
41
    try:
0.8.21 by John Arbash Meinel
Splitting up the version info code into a lazy factory style.
42
        return version_info_formats.get_builder(format)
0.8.2 by John Arbash Meinel
Have working rio output
43
    except KeyError:
0.8.21 by John Arbash Meinel
Splitting up the version info code into a lazy factory style.
44
        formats = version_info_formats.get_builder_formats()
2030.1.4 by John Arbash Meinel
Add a test that we can find the version info when we only have a branch
45
        raise errors.BzrCommandError('No known version info format %s.'
46
                                     ' Supported types are: %s'
47
                                     % (format, formats))
0.8.2 by John Arbash Meinel
Have working rio output
48
49
50
class cmd_version_info(Command):
2948.4.2 by Lukáš Lalinský
Use registry for the list of formats. Documentation.
51
    """Show version information about this tree.
52
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.
56
57
    For example::
58
59
      bzr version-info --custom \\
2948.4.3 by Lukáš Lalinský
Fix problems from Alexander's review.
60
        --template="#define VERSION_INFO \\"Project 1.2.3 (r{revno})\\"\\n"
2948.4.2 by Lukáš Lalinský
Use registry for the list of formats. Documentation.
61
62
    will produce a C header file with formatted string containing the
63
    current revision number. Other supported variables in templates are:
64
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
2948.4.3 by Lukáš Lalinský
Fix problems from Alexander's review.
70
      * {clean} - 0 if the source tree contains uncommitted changes,
71
                  otherwise 1
2948.4.2 by Lukáš Lalinský
Use registry for the list of formats. Documentation.
72
    """
73
74
    takes_options = [RegistryOption('format',
75
                            'Select the output format.',
3224.5.1 by Andrew Bennetts
Lots of assorted hackery to reduce the number of imports for common operations. Improves 'rocks', 'st' and 'help' times by ~50ms on my laptop.
76
                            value_switches=True,
77
                            lazy_registry=('bzrlib.version_info_formats',
78
                                           'format_registry')),
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
79
                     Option('all', help='Include all possible information.'),
80
                     Option('check-clean', help='Check if tree is clean.'),
0.8.21 by John Arbash Meinel
Splitting up the version info code into a lazy factory style.
81
                     Option('include-history',
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
82
                            help='Include the revision-history.'),
0.8.13 by John Arbash Meinel
Including file-revisions fields, updated test suite.
83
                     Option('include-file-revisions',
2948.4.1 by Lukáš Lalinský
Custom template-based version info formatter.
84
                            help='Include the last revision for each file.'),
85
                     Option('template', type=str, help='Template for the output.'),
0.8.2 by John Arbash Meinel
Have working rio output
86
                     ]
87
    takes_args = ['location?']
88
0.8.20 by John Arbash Meinel
Updated version-info to the latest bzr.dev codebase. Changed to using VersionInfoBuilder, and made tests pass.
89
    encoding_type = 'exact'
90
0.8.2 by John Arbash Meinel
Have working rio output
91
    def run(self, location=None, format=None,
0.8.3 by John Arbash Meinel
Playing around with some formats
92
            all=False, check_clean=False, include_history=False,
2948.4.3 by Lukáš Lalinský
Fix problems from Alexander's review.
93
            include_file_revisions=False, template=None):
0.8.2 by John Arbash Meinel
Have working rio output
94
95
        if location is None:
2022.1.4 by John Arbash Meinel
test feedback from Robert.
96
            location = '.'
0.8.2 by John Arbash Meinel
Have working rio output
97
98
        if format is None:
2948.4.2 by Lukáš Lalinský
Use registry for the list of formats. Documentation.
99
            format = version_info_formats.format_registry.get()
0.8.2 by John Arbash Meinel
Have working rio output
100
0.8.20 by John Arbash Meinel
Updated version-info to the latest bzr.dev codebase. Changed to using VersionInfoBuilder, and made tests pass.
101
        wt = None
102
        try:
2022.1.3 by John Arbash Meinel
Remove unused imports
103
            wt = workingtree.WorkingTree.open_containing(location)[0]
2030.1.4 by John Arbash Meinel
Add a test that we can find the version info when we only have a branch
104
        except errors.NoWorkingTree:
2022.1.3 by John Arbash Meinel
Remove unused imports
105
            b = branch.Branch.open(location)
0.8.20 by John Arbash Meinel
Updated version-info to the latest bzr.dev codebase. Changed to using VersionInfoBuilder, and made tests pass.
106
        else:
107
            b = wt.branch
0.8.2 by John Arbash Meinel
Have working rio output
108
3231.2.1 by James Westby
Make version-info --custom imply --all.
109
        if all or template:
0.8.2 by John Arbash Meinel
Have working rio output
110
            include_history = True
111
            check_clean = True
0.8.13 by John Arbash Meinel
Including file-revisions fields, updated test suite.
112
            include_file_revisions=True
0.8.2 by John Arbash Meinel
Have working rio output
113
0.8.20 by John Arbash Meinel
Updated version-info to the latest bzr.dev codebase. Changed to using VersionInfoBuilder, and made tests pass.
114
        builder = format(b, working_tree=wt,
0.8.2 by John Arbash Meinel
Have working rio output
115
                check_for_clean=check_clean,
0.8.13 by John Arbash Meinel
Including file-revisions fields, updated test suite.
116
                include_revision_history=include_history,
2948.4.1 by Lukáš Lalinský
Custom template-based version info formatter.
117
                include_file_revisions=include_file_revisions,
118
                template=template)
4792.8.4 by Martin Pool
Convert version-info to use TextUIOutputStream
119
        builder.generate(ui.ui_factory.make_output_stream())