← 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: Canonical.com Patch Queue Manager
  • Date: 2008-10-31 04:39:04 UTC
  • mfrom: (3565.6.16 switch_nick)
  • Revision ID: pqm@pqm.ubuntu.com-20081031043904-52fnbfrloojemvcc
(mbp) branch nickname documentation

Show diffs side-by-side

added added

removed removed

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