← 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: INADA Naoki
  • Date: 2011-05-05 13:03:12 UTC
  • mto: This revision was merged to the branch mainline in revision 5891.
  • Revision ID: songofacandy@gmail.com-20110505130312-ozvqmfjt7cuwi72k
Run build_mo when build is called.

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-2011 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,
25
26
    workingtree,
26
27
    )
27
28
""")
 
29
 
28
30
from bzrlib.commands import Command
29
 
from bzrlib.option import Option
 
31
from bzrlib.option import Option, RegistryOption
30
32
 
31
33
 
32
34
def _parse_version_info_format(format):
45
47
 
46
48
 
47
49
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'),
52
 
                     Option('all', help='include all possible information'),
53
 
                     Option('check-clean', help='check if tree is clean'),
 
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.'),
54
80
                     Option('include-history',
55
 
                            help='Include the revision-history'),
 
81
                            help='Include the revision-history.'),
56
82
                     Option('include-file-revisions',
57
 
                            help='Include the last revision for each file')
 
83
                            help='Include the last revision for each file.'),
 
84
                     Option('template', type=str, help='Template for the output.'),
58
85
                     ]
59
86
    takes_args = ['location?']
60
87
 
62
89
 
63
90
    def run(self, location=None, format=None,
64
91
            all=False, check_clean=False, include_history=False,
65
 
            include_file_revisions=False):
 
92
            include_file_revisions=False, template=None):
66
93
 
67
94
        if location is None:
68
95
            location = '.'
69
96
 
70
97
        if format is None:
71
 
            format = version_info_formats.get_builder(None)
 
98
            format = version_info_formats.format_registry.get()
72
99
 
73
100
        wt = None
74
101
        try:
78
105
        else:
79
106
            b = wt.branch
80
107
 
81
 
        if all:
 
108
        if all or template:
82
109
            include_history = True
83
110
            check_clean = True
84
111
            include_file_revisions=True
86
113
        builder = format(b, working_tree=wt,
87
114
                check_for_clean=check_clean,
88
115
                include_revision_history=include_history,
89
 
                include_file_revisions=include_file_revisions)
 
116
                include_file_revisions=include_file_revisions,
 
117
                template=template)
90
118
        builder.generate(self.outf)