← 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: 2005-05-11 06:20:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050511062005-297af3451635dae0
- Don't lose first line of command help!

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/cmd_version_info.py
1
 
# Copyright (C) 2005, 2006, 2009 Canonical Ltd
2
 
#
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.
7
 
#
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.
12
 
#
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
16
 
 
17
 
"""Commands for generating snapshot information about a bzr tree."""
18
 
 
19
 
from bzrlib.lazy_import import lazy_import
20
 
 
21
 
lazy_import(globals(), """
22
 
from bzrlib import (
23
 
    branch,
24
 
    errors,
25
 
    ui,
26
 
    version_info_formats,
27
 
    workingtree,
28
 
    )
29
 
""")
30
 
 
31
 
from bzrlib.commands import Command
32
 
from bzrlib.option import Option, RegistryOption
33
 
 
34
 
 
35
 
def _parse_version_info_format(format):
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
 
    """
41
 
    try:
42
 
        return version_info_formats.get_builder(format)
43
 
    except KeyError:
44
 
        formats = version_info_formats.get_builder_formats()
45
 
        raise errors.BzrCommandError('No known version info format %s.'
46
 
                                     ' Supported types are: %s'
47
 
                                     % (format, formats))
48
 
 
49
 
 
50
 
class cmd_version_info(Command):
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 \\
60
 
        --template="#define VERSION_INFO \\"Project 1.2.3 (r{revno})\\"\\n"
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
70
 
      * {clean} - 0 if the source tree contains uncommitted changes,
71
 
                  otherwise 1
72
 
    """
73
 
 
74
 
    takes_options = [RegistryOption('format',
75
 
                            'Select the output format.',
76
 
                            value_switches=True,
77
 
                            lazy_registry=('bzrlib.version_info_formats',
78
 
                                           'format_registry')),
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.'),
86
 
                     ]
87
 
    takes_args = ['location?']
88
 
 
89
 
    encoding_type = 'exact'
90
 
 
91
 
    def run(self, location=None, format=None,
92
 
            all=False, check_clean=False, include_history=False,
93
 
            include_file_revisions=False, template=None):
94
 
 
95
 
        if location is None:
96
 
            location = '.'
97
 
 
98
 
        if format is None:
99
 
            format = version_info_formats.format_registry.get()
100
 
 
101
 
        wt = None
102
 
        try:
103
 
            wt = workingtree.WorkingTree.open_containing(location)[0]
104
 
        except errors.NoWorkingTree:
105
 
            b = branch.Branch.open(location)
106
 
        else:
107
 
            b = wt.branch
108
 
 
109
 
        if all or template:
110
 
            include_history = True
111
 
            check_clean = True
112
 
            include_file_revisions=True
113
 
 
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,
118
 
                template=template)
119
 
        builder.generate(ui.ui_factory.make_output_stream())