← 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: Andrew Bennetts
  • Date: 2010-10-08 08:15:14 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101008081514-dviqzrdfwyzsqbz2
Split NEWS into per-release doc/en/release-notes/bzr-*.txt

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/cmd_version_info.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Commands for generating snapshot information about a bzr tree."""
18
18
 
19
19
from bzrlib.lazy_import import lazy_import
 
20
 
20
21
lazy_import(globals(), """
21
22
from bzrlib import (
22
23
    branch,
23
24
    errors,
 
25
    ui,
24
26
    version_info_formats,
25
27
    workingtree,
26
28
    )
27
29
""")
 
30
 
28
31
from bzrlib.commands import Command
29
 
from bzrlib.option import Option
 
32
from bzrlib.option import Option, RegistryOption
30
33
 
31
34
 
32
35
def _parse_version_info_format(format):
45
48
 
46
49
 
47
50
class cmd_version_info(Command):
48
 
    """Show version information about this tree."""
49
 
 
50
 
    takes_options = [Option('format', type=_parse_version_info_format,
51
 
                            help='Select the output format.'),
 
51
    __doc__ = """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')),
52
79
                     Option('all', help='Include all possible information.'),
53
80
                     Option('check-clean', help='Check if tree is clean.'),
54
81
                     Option('include-history',
55
82
                            help='Include the revision-history.'),
56
83
                     Option('include-file-revisions',
57
 
                            help='Include the last revision for each file.')
 
84
                            help='Include the last revision for each file.'),
 
85
                     Option('template', type=str, help='Template for the output.'),
58
86
                     ]
59
87
    takes_args = ['location?']
60
88
 
62
90
 
63
91
    def run(self, location=None, format=None,
64
92
            all=False, check_clean=False, include_history=False,
65
 
            include_file_revisions=False):
 
93
            include_file_revisions=False, template=None):
66
94
 
67
95
        if location is None:
68
96
            location = '.'
69
97
 
70
98
        if format is None:
71
 
            format = version_info_formats.get_builder(None)
 
99
            format = version_info_formats.format_registry.get()
72
100
 
73
101
        wt = None
74
102
        try:
78
106
        else:
79
107
            b = wt.branch
80
108
 
81
 
        if all:
 
109
        if all or template:
82
110
            include_history = True
83
111
            check_clean = True
84
112
            include_file_revisions=True
86
114
        builder = format(b, working_tree=wt,
87
115
                check_for_clean=check_clean,
88
116
                include_revision_history=include_history,
89
 
                include_file_revisions=include_file_revisions)
 
117
                include_file_revisions=include_file_revisions,
 
118
                template=template)
90
119
        builder.generate(self.outf)