← 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: Robert Collins
  • Date: 2006-06-09 07:45:35 UTC
  • mto: (1755.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 1756.
  • Revision ID: robertc@robertcollins.net-20060609074535-3002a0209179b35c
Fixup '== None' usage in inventory.py.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/cmd_version_info.py
1
 
# Copyright (C) 2005-2011 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
 
    version_info_formats,
26
 
    workingtree,
27
 
    )
28
 
""")
29
 
 
30
 
from bzrlib.commands import Command
31
 
from bzrlib.option import Option, RegistryOption
32
 
 
33
 
 
34
 
def _parse_version_info_format(format):
35
 
    """Convert a string passed by the user into a VersionInfoFormat.
36
 
 
37
 
    This looks in the version info format registry, and if the format
38
 
    cannot be found, generates a useful error exception.
39
 
    """
40
 
    try:
41
 
        return version_info_formats.get_builder(format)
42
 
    except KeyError:
43
 
        formats = version_info_formats.get_builder_formats()
44
 
        raise errors.BzrCommandError('No known version info format %s.'
45
 
                                     ' Supported types are: %s'
46
 
                                     % (format, formats))
47
 
 
48
 
 
49
 
class cmd_version_info(Command):
50
 
    __doc__ = """Show version information about this tree.
51
 
 
52
 
    You can use this command to add information about version into
53
 
    source code of an application. The output can be in one of the
54
 
    supported formats or in a custom format based on a template.
55
 
 
56
 
    For example::
57
 
 
58
 
      bzr version-info --custom \\
59
 
        --template="#define VERSION_INFO \\"Project 1.2.3 (r{revno})\\"\\n"
60
 
 
61
 
    will produce a C header file with formatted string containing the
62
 
    current revision number. Other supported variables in templates are:
63
 
 
64
 
      * {date} - date of the last revision
65
 
      * {build_date} - current date
66
 
      * {revno} - revision number
67
 
      * {revision_id} - revision id
68
 
      * {branch_nick} - branch nickname
69
 
      * {clean} - 0 if the source tree contains uncommitted changes,
70
 
                  otherwise 1
71
 
    """
72
 
 
73
 
    takes_options = [RegistryOption('format',
74
 
                            'Select the output format.',
75
 
                            value_switches=True,
76
 
                            lazy_registry=('bzrlib.version_info_formats',
77
 
                                           'format_registry')),
78
 
                     Option('all', help='Include all possible information.'),
79
 
                     Option('check-clean', help='Check if tree is clean.'),
80
 
                     Option('include-history',
81
 
                            help='Include the revision-history.'),
82
 
                     Option('include-file-revisions',
83
 
                            help='Include the last revision for each file.'),
84
 
                     Option('template', type=str, help='Template for the output.'),
85
 
                     ]
86
 
    takes_args = ['location?']
87
 
 
88
 
    encoding_type = 'exact'
89
 
 
90
 
    def run(self, location=None, format=None,
91
 
            all=False, check_clean=False, include_history=False,
92
 
            include_file_revisions=False, template=None):
93
 
 
94
 
        if location is None:
95
 
            location = '.'
96
 
 
97
 
        if format is None:
98
 
            format = version_info_formats.format_registry.get()
99
 
 
100
 
        wt = None
101
 
        try:
102
 
            wt = workingtree.WorkingTree.open_containing(location)[0]
103
 
        except errors.NoWorkingTree:
104
 
            b = branch.Branch.open(location)
105
 
        else:
106
 
            b = wt.branch
107
 
 
108
 
        if all or template:
109
 
            include_history = True
110
 
            check_clean = True
111
 
            include_file_revisions=True
112
 
 
113
 
        builder = format(b, working_tree=wt,
114
 
                check_for_clean=check_clean,
115
 
                include_revision_history=include_history,
116
 
                include_file_revisions=include_file_revisions,
117
 
                template=template)
118
 
        builder.generate(self.outf)